grassgis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eca4b61ff65ed5f6bb173f1502e27b2f17ccbdfa
+  data.tar.gz: 65794615e3eb17457e67b055c2f056e43d6b32da
+SHA512:
+  metadata.gz: af06a15d577d6ebcc835f75cf03a1b42fbdb71229a7b820213ba6c1a62257572981a88fd635197b6a917ebbe9766173aca1fb7f108673eec7c2ae65811a6e986
+  data.tar.gz: 31def098f90ef421d0e99f47b3dcb62be72bc62d085021632c496c360037de2b0d8839dd3f7d7ea9f3e3f64376de0a6d09fa724afd780b023065f4caa4fc8176

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.6
+  - 1.9.3
+before_install:
+  - gem update bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grassgis.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Javier Goizueta
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# GrassGis
+
+Support for scripting GRASS with Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grassgis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grassgis
+
+## Usage
+
+This library can prepare environments to execute GRASS commands
+from Ruby scripts.
+
+Example:
+
+```ruby
+require 'grassgis'
+
+configuration = {
+  gisbase: '/usr/local/Cellar/grass-70/7.0.0/grass-7.0.0',
+  location: 'world'
+}
+
+GrassGis.session configuration do
+  r.resamp.stats '-n', input: "map1@mapset1", output: "map2"
+  puts g.list('vect').output
+end
+```
+
+## Roadmap
+
+Create a DSL to define GRASS processing recipes.
+
+It should handle errors gracefully during recipe execution,
+take care of logging, parsing command output, temporary files, etc.
+
+A recipe could have requirements such as which other recipes it depends
+upon (so must be executed first), which map layers must exist, etc.
+
+It could also define what map layers or other files are generated by the
+recipe.
+
+Example of intended recipe syntax:
+
+```ruby
+recipe :resamp_average do |options = {}|
+  input_raster = options[:input]
+  input_res = options[:input_res] # TODO: extract from input_rater info
+  output_raster = options[:output]
+  output_res = options[:output_res] # TODO: extract from output_raster info
+  if options[:direction]
+    unless raster_exists?("#{input_raster}_sin")
+      g.region res: input_res
+      r.mapcalc "#{input_raster}_sin = sin(#{input_raster})"
+    end
+    unless raster_exists?("#{input_raster}_cos")
+      g.region res: input_res
+      r.mapcalc "#{input_raster}_cos = cos(#{input_raster})"
+    end
+    g.region res: output_res
+    r.resamp.stats input: "#{input_raster}_cos", output: "#{output_raster}_cos"
+    r.resamp.stats input: "#{input_raster}_sin", output: "#{output_raster}_sin"
+    r.mapcalc "#{output_raster} = atan(#{output_raster}_cos,#{output_raster}_sin)"
+    g.remove rast: ["#{output_raster}_cos", "#{output_raster}_sin"]
+  else
+    g.region res: output_res
+    r.resamp.stats input: input_raster, output: output_raster
+  end
+end
+
+recipe :generate_working_dem do |...|
+  define :working_dem, 'dem'
+  define :working_slope, 'slope'
+  define :working_aspect, 'aspect'
+  g.region res: working_res
+  apply :resamp_average, input: base_dem, output: working_dem, input_res: base_dem_res, output_res: working_res
+  apply :resamp_average, input: base_slope, output: working_slope, input_res: base_dem_res, output_res: working_res
+  apply :resamp_average, input: base_aspect, output: working_aspect, input_res: base_dem_res, output_res: working_res, direction: true
+  describe working_slope, "Pendiente en grados a #{working_res} #{region_units}"
+  # ...
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/grassgis/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = GrassGis::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "GrassGis #{version}"
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.markup = 'markdown' if rdoc.respond_to?(:markup)
+end
+
+task :default => :test

data/grassgis.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grassgis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grassgis"
+  spec.version       = GrassGis::VERSION
+  spec.authors       = ["Javier Goizueta"]
+  spec.email         = ["jgoizueta@gmail.com"]
+  spec.summary       = %q{Support for scripting GRASS GIS in Ruby}
+  spec.description   = %q{Support for scripting GRASS GIS in Ruby.}
+  spec.homepage      = "https://github.com/jgoizueta/grassgis"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sys_cmd", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.4"
+
+  spec.required_ruby_version = '>= 1.9.3'
+end

data/lib/grassgis.rb

@@ -0,0 +1,4 @@
+require 'sys_cmd'
+require 'grassgis/version'
+require 'grassgis/module'
+require 'grassgis/context'

data/lib/grassgis/context.rb

@@ -0,0 +1,138 @@
+require 'tempfile'
+
+module GrassGis
+
+  class Context
+    ROOT_MODULES = %w(d g i r v s m p)
+    REQUIRED_CONFIG = [:gisbase, :location]
+
+    def initialize(config)
+      # apply configuration defaults
+      config[:gisdbase] ||= File.join(ENV['HOME'], 'grassdata')
+      config[:mapset]  ||= ENV['USER']
+      config[:version] ||= File.read(File.join(config[:gisbase], 'etc', 'VERSIONNUMBER')).split.first
+      config[:message_format] ||= 'plain'
+      config[:true_color] = true unless config.has_key?(:true_color)
+      config[:transparent] = true unless config.has_key?(:transparent)
+      config[:png_auto_write] = true unless config.has_key?(:png_auto_write)
+      config[:gnuplot] ||= 'gnuplot -persist'
+      @config = config
+
+      locals = config[:locals] || {}
+      locals.each do |var_name, value|
+        define_singleton_method(var_name){ value }
+      end
+    end
+
+   def allocate
+     @gisrc = Tempfile.new('gisrc')
+     @gisrc.puts "LOCATION_NAME: #{@config[:location]}"
+     @gisrc.puts "GISDBASE: #{@config[:gisdbase]}"
+     @gisrc.puts "MAPSET: #{@config[:mapset]}"
+     @gisrc.close
+     ENV['GISRC'] = @gisrc.path
+     ENV['GISBASE'] = @config[:gisbase]
+     ENV['GRASS_VERSION'] = @config[:version]
+     ENV['GRASS_MESSAGE_FORMAT'] = @config[:message_format].to_s
+     ENV['GRASS_TRUECOLOR'] = bool_var(@config[:true_color])
+     ENV['GRASS_TRANSPARENT'] = bool_var(@config[:transparent])
+     ENV['GRASS_PNG_AUTO_WRITE'] = bool_var(@config[:png_auto_write])
+     ENV['GRASS_GNUPLOT'] = @config[:gnuplot]
+     @path = ENV['PATH']
+     paths = []
+     paths << File.join(@config[:gisbase], 'bin')
+     paths << File.join(@config[:gisbase], 'scripts')
+     paths << @path
+     ENV['PATH'] = paths.join(File::PATH_SEPARATOR)
+     @ld_path = ENV['LD_LIBRARY_PATH']
+     ld_path = File.join(@config[:gisbase], 'lib')
+     if @ld_path
+       ENV['LD_LIBRARY_PATH'] = [ld_path, @ld_path].join(File::PATH_SEPARATOR)
+     else
+       ENV['LD_LIBRARY_PATH'] = ld_path
+     end
+     ENV['GRASS_LD_LIBRARY_PATH'] = ENV['LD_LIBRARY_PATH']
+     @man_path = ENV['MANPATH']
+     man_path = File.join(@config[:gisbase], 'man')
+     if @man_path
+       ENV['MANPATH'] = [man_path, @man_path].join(File::PATH_SEPARATOR)
+     else
+       ENV['MANPATH'] = man_path
+     end
+   end
+
+    def dispose
+      @gisrc.unlink if @gisrc
+      @gisrc = nil
+      ENV['PATH'] = @path if @path
+      @path = nil
+      ENV['LD_LIBRARY_PATH'] = @ld_path
+      ENV['MANPATH'] = @man_path
+    end
+
+    # setup access to the root modules in the context
+    ROOT_MODULES.each do |root_module|
+      define_method root_module.to_sym do
+        var_name = "@#{root_module}"
+        m = instance_variable_get(var_name)
+        m ||= Module.new(root_module, configuration: @config)
+        instance_variable_set var_name, m
+        m
+      end
+    end
+
+    private
+
+    def bool_var(value)
+      value ? 'TRUE' : 'FALSE'
+    end
+
+  end
+
+  # Evaluate a block in a GRASS session environment
+  # The configuration must include at leaast:
+  #
+  # * :gibase The base GRASS instalation directory
+  # * :location The location to work with
+  #
+  # Optional parameters:
+  #
+  # * :gisdbase The base GRASS data directory
+  # * :mapset The default mapset
+  # * :version The GRASS version
+  #
+  # Example:
+  #
+  #     configuration = {
+  #       gisbase: '/usr/local/Cellar/grass-70/7.0.0/grass-7.0.0',
+  #       location: 'world'
+  #     }
+  #
+  #     GrassGis.session configuration do
+  #       r.resamp.stats '-n', input: "map1@mapset1", output: "map2"
+  #       cmd = g.list 'vect'
+  #       puts cmd.output
+  #     end
+  #
+  # Note that block is evaluated in a spacial context, so
+  # that the lexical scope's self and instance variables
+  # are not directly available inside it.
+  # Local variables in the scope can be used to access self-related
+  # information. Also, local values can be injected in the block
+  # with the +:locals+ option:
+  #
+  #     this = self # make self available a local variable
+  #     locals = { context: self } # inject locals
+  #     GrassGis.session configuration.merge(locals:) do
+  #          r.resamp.stats '-n', input: this.input, output: context.output
+  #     end
+  #
+  def self.session(config, &blk)
+    context = Context.new(config)
+    context.allocate
+    context.instance_eval(&blk)
+  ensure
+    context.dispose
+  end
+
+end

data/lib/grassgis/module.rb

@@ -0,0 +1,70 @@
+module GrassGis
+
+  # Generate and execute GRASS commands
+  #
+  #     r = GrassGis::Module.new('r')
+  #     r.resamp.stats '-n', input: "map1@mapset1", output: "map2"
+  #
+  # To execute a command without arguments, +run+ must be invoked explicitly:
+  #
+  #     g = GrassGis::Module.new('g')
+  #     g.region.run
+  #
+  class Module
+    def initialize(id, options = {})
+      @id = id.to_s
+      @parent = options[:parent]
+      @configuration = options[:configuration] || {}
+    end
+
+    def name
+      if @parent
+        "#{@parent.name}.#{@id}"
+      else
+        @id
+      end
+    end
+
+    # Executes the command (with given arguments)
+    # returns a SysCmd object (with status, status_value, output, error_output methods)
+    def run(*args)
+      stdin = nil
+      cmd = SysCmd.command name do
+        args.each do |arg|
+          case arg
+          when Hash
+            arg.each do |key, value|
+              case value
+              when Array
+                value = value*","
+              when String
+                if value.include?("\n")
+                  raise "Cannot pass multiple options through STDIN" if stdin
+                  stdin = value
+                  value = "-"
+                  input stdin
+                end
+              end
+              option key.to_s, equal_value: value
+            end
+          else
+            option arg
+          end
+        end
+      end
+      cmd.run unless @configuration[:dry]
+      cmd
+    end
+
+    def method_missing(method, *args)
+      m = Module.new(method, parent: self, configuration: @configuration)
+      if args.size > 0
+        m.run *args
+      else
+        m
+      end
+    end
+
+  end
+
+end

data/lib/grassgis/version.rb

@@ -0,0 +1,3 @@
+module GrassGis
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: grassgis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Javier Goizueta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys_cmd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+description: Support for scripting GRASS GIS in Ruby.
+email:
+- jgoizueta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grassgis.gemspec
+- lib/grassgis.rb
+- lib/grassgis/context.rb
+- lib/grassgis/module.rb
+- lib/grassgis/version.rb
+homepage: https://github.com/jgoizueta/grassgis
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Support for scripting GRASS GIS in Ruby
+test_files: []