class GrassCookbook::RecipeDsl

DSL to define recipes

Public Class Methods

new(id) click to toggle source
# File lib/grassgis/cookbook.rb, line 276
def initialize(id)
  @id = id.to_sym
  @required_raster_maps = []
  @required_vector_maps = []
  @required_files = []
  @generated_raster_maps = []
  @generated_vector_maps = []
  @generated_files = []
  @generated_parameters = []
  @description = nil
end

Public Instance Methods

description(text) click to toggle source
# File lib/grassgis/cookbook.rb, line 288
def description(text)
  @description = GrassGis::Support.unindent(text)
end
generated_files(*files) click to toggle source
# File lib/grassgis/cookbook.rb, line 312
def generated_files(*files)
  @generated_files += files
end
generated_parameters(*parameters) click to toggle source
# File lib/grassgis/cookbook.rb, line 316
def generated_parameters(*parameters)
  @generated_parameters += parameters
end
generated_raster_maps(*maps) click to toggle source
# File lib/grassgis/cookbook.rb, line 308
def generated_raster_maps(*maps)
  @generated_raster_maps += maps
end
generated_vector_maps(*maps) click to toggle source
# File lib/grassgis/cookbook.rb, line 304
def generated_vector_maps(*maps)
  @generated_vector_maps += maps
end
process(&blk) click to toggle source
# File lib/grassgis/cookbook.rb, line 320
def process(&blk)
  @process = blk
end
recipe() click to toggle source
# File lib/grassgis/cookbook.rb, line 324
def recipe
  Recipe.new(
    id: @id,
    required_maps: @required_maps,
    required_files: @required_files,
    generated_raster_maps: @generated_raster_maps,
    generated_vector_maps: @generated_vector_maps,
    generated_files: @generated_files,
    generated_parameters: @generated_parameters,
    &@process
  )
end
required_files(*files) click to toggle source
# File lib/grassgis/cookbook.rb, line 300
def required_files(*files)
  @required_files += files
end
required_raster_maps(*maps) click to toggle source
# File lib/grassgis/cookbook.rb, line 292
def required_raster_maps(*maps)
  @required_raster_maps += maps
end
required_vector_maps(*maps) click to toggle source
# File lib/grassgis/cookbook.rb, line 296
def required_vector_maps(*maps)
  @required_vector_maps += maps
end