grassgis 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eca4b61ff65ed5f6bb173f1502e27b2f17ccbdfa
-  data.tar.gz: 65794615e3eb17457e67b055c2f056e43d6b32da
+  metadata.gz: 788c22870c881d792c8412e3f2ebbe44015c6e28
+  data.tar.gz: 2f4204831ac3bd07ffa8ee5f774777ba5faabae0
 SHA512:
-  metadata.gz: af06a15d577d6ebcc835f75cf03a1b42fbdb71229a7b820213ba6c1a62257572981a88fd635197b6a917ebbe9766173aca1fb7f108673eec7c2ae65811a6e986
-  data.tar.gz: 31def098f90ef421d0e99f47b3dcb62be72bc62d085021632c496c360037de2b0d8839dd3f7d7ea9f3e3f64376de0a6d09fa724afd780b023065f4caa4fc8176
+  metadata.gz: c17ad3bc200c2ac699e95d61ca32ab734b03f6bff74e1219ea3c18bd9dbab3fac9d07be77e44a0895efa3d33d8ee2f5acf2eff543c95de326f7b68e7c957adc1
+  data.tar.gz: 8e144e6a0de01b5ba6e875284094114164847c76e545527f3e1756572cbe2a4ce1478d26b81e0c7402f8347efead8ef38a0b3030cfd80f575204cb562df33a01

data/README.md

@@ -33,12 +33,21 @@ configuration = {
 
 GrassGis.session configuration do
   r.resamp.stats '-n', input: "map1@mapset1", output: "map2"
-  puts g.list('vect').output
+  g.list 'vect'
+  puts output # output of last command
 end
 ```
 
 ## Roadmap
 
+* Write the executed command history to the location's +.bash_history+
+  or to another file specified in the session configuration.
+* Log GRASS command output / error output
+* Method to clean GRASS temporaries ($GISBASE/etc/clean_temp), or do
+  it automatically when disposing the session.
+
+### GRASS cooking DSL
+
 Create a DSL to define GRASS processing recipes.
 
 It should handle errors gracefully during recipe execution,

data/lib/grassgis/context.rb

@@ -10,12 +10,21 @@ module GrassGis
       # 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
+      unless config[:version]
+        version_file = File.join(config[:gisbase], 'etc', 'VERSIONNUMBER')
+        if File.exists?(version_file)
+          config[:version] = File.read(version_file).split.first
+        end
+      end
       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[:gui] ||= 'wxpython'
+
+      config[:errors] ||= :raise
+
       @config = config
 
       locals = config[:locals] || {}
@@ -24,50 +33,95 @@ module GrassGis
       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
+    # Commands executed in the session are kept in the +history+ array
+    #
+    #    GrassGis.session config do
+    #       g.region res: 10
+    #       g.region res: 20
+    #       g.region res: 30
+    #       puts history[-3] # => "g.region res=10"
+    #       puts history[-2] # => "g.region res=20"
+    #       puts history[-1] # => "g.region res=30"
+    #       puts history[-2].output
+    #    end
+    #
+    attr_reader :history
+
+    # Last command executed in the session (history[-1])
+    def last
+      history.last
+    end
+
+    # Array of commands that resulted in error in the session
+    def errors
+      history.select { |cmd| GrassGis.error?(cmd) }
+    end
+
+    # Did last command exit with error status
+    def error?
+      GrassGis.error? last
+    end
+
+    def error_info
+      GrassGis.error_info last
+    end
+
+    # Output of the last command executed
+    def output
+      last.output
+    end
+
+    # Standar error output of last command executed
+    def error_output
+      last.error_output
+    end
+
+    def allocate
+      @gisrc = Tempfile.new('gisrc')
+      @gisrc.puts "LOCATION_NAME: #{@config[:location]}"
+      @gisrc.puts "GISDBASE: #{@config[:gisdbase]}"
+      @gisrc.puts "MAPSET: #{@config[:mapset]}"
+      @gisrc.puts "GUI: #{@config[:gui]}"
+      @gisrc.close
+
+      @original_env = {}
+
+      replace_var 'GISRC', @gisrc.path
+      replace_var 'GISBASE', @config[:gisbase]
+      replace_var 'GRASS_VERSION', @config[:version]
+      replace_var 'GRASS_MESSAGE_FORMAT', @config[:message_format].to_s
+      replace_var 'GRASS_TRUECOLOR', bool_var(@config[:true_color])
+      replace_var 'GRASS_TRANSPARENT', bool_var(@config[:transparent])
+      replace_var 'GRASS_PNG_AUTO_WRITE', bool_var(@config[:png_auto_write])
+      replace_var 'GRASS_GNUPLOT', @config[:gnuplot]
+
+      paths = ['bin', 'scripts']
+      if OS.windows?
+        # paths << 'lib'
+        paths.unshift 'lib'
+      else
+        insert_path 'LD_LIBRARY_PATH', File.join(@config[:gisbase], 'lib')
+        ENV['GRASS_LD_LIBRARY_PATH'] = ENV['LD_LIBRARY_PATH']
+      end
+      paths = paths.map { |path| File.join(@config[:gisbase], path) }
+      if OS.windows?
+        osgeo4w_dir = ENV['OSGEO4W_ROOT'] || "C:\\OSGeo4W"
+        if File.directory?(osgeo4w_dir)
+          paths << File.join(osgeo4w_dir, 'bin')
+        end
+      end
+      insert_path 'PATH', *paths
+      insert_path 'MANPATH', File.join(@config[:gisbase], 'man')
+      @history = @config[:history] = []
+    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
+      @original_env.each do |var, value|
+        ENV[var] = value
+      end
+      @original_env = {}
     end
 
     # setup access to the root modules in the context
@@ -81,12 +135,50 @@ module GrassGis
       end
     end
 
-    private
+    # Evaluate a block of code in the context of a GRASS session
+    #
+    # Useful to pass a GRASS context around and use it to execute
+    # GRASS commands, e.g.:
+    #
+    #     def helper(grass, ...)
+    #        # can invoke GRASS commands using grass:
+    #        grass.g.region res: 10
+    #        # Or use a session block to abbreviate typing:
+    #        grass.session do
+    #          g.region res: 10
+    #          ...
+    #        end
+    #     end
+    #
+    #     GrassGis.session ... do
+    #       helper seld, ...
+    #       ...
+    #     end
+    #
+    def session(&blk)
+      instance_eval(&blk)
+    end
+
+  private
 
     def bool_var(value)
       value ? 'TRUE' : 'FALSE'
     end
 
+    def insert_path(var, *paths)
+      @original_env[var] = ENV[var]
+      if File::ALT_SEPARATOR
+        paths = paths.map { |path| path.gsub(File::SEPARATOR, File::ALT_SEPARATOR) }
+      end
+      paths << ENV[var] if ENV[var]
+      ENV[var] = paths.join(File::PATH_SEPARATOR)
+    end
+
+    def replace_var(var, value)
+      @original_env[var] = ENV[var]
+      ENV[var] = value
+    end
+
   end
 
   # Evaluate a block in a GRASS session environment
@@ -127,12 +219,54 @@ module GrassGis
   #          r.resamp.stats '-n', input: this.input, output: context.output
   #     end
   #
+  # Other pararameters:
+  #
+  #   :errors to define the behaviour when a GRASS command fails:
+  #   * :raise is the default and raises on errors
+  #   * :console shows standar error output of commands
+  #   * :quiet error output is retained but not shown
+  #
+  #   If :error is anything other than :raise, it is up to the user
+  #   to check each command for errors. With the :console option
+  #   the standar error output of commands is sent to the console
+  #   and is not accessible through the command's error_output method.
+  #
   def self.session(config, &blk)
     context = Context.new(config)
     context.allocate
-    context.instance_eval(&blk)
+    context.session &blk
   ensure
-    context.dispose
+    context.dispose if context
+  end
+
+  class Error < StandardError
+  end
+
+  def self.error?(command)
+    command && (!!command.error || (command.status_value && command.status_value != 0))
+  end
+
+  def error_info(command)
+    if command
+      if command.error
+        command.error.to_s
+      elsif (command.status_value && command.status_value != 0)
+        info = "Exit code #{command.status_value}\n"
+        info << command.error_output if command.error_output
+      end
+    end
+  end
+
+  def self.error(command, error_mode = :raise)
+    if command
+      if error_mode == :raise
+        if command.error
+          raise command.error
+        elsif (command.status_value && command.status_value != 0)
+          raise Error.new, error_info(command)
+        end
+      end
+    end
   end
 
 end

data/lib/grassgis/module.rb

@@ -15,6 +15,8 @@ module GrassGis
       @id = id.to_s
       @parent = options[:parent]
       @configuration = options[:configuration] || {}
+      @history = @configuration[:history] || []
+      @errors = @configuration[:errors] || :raise
     end
 
     def name
@@ -40,7 +42,7 @@ module GrassGis
               when String
                 if value.include?("\n")
                   raise "Cannot pass multiple options through STDIN" if stdin
-                  stdin = value
+                  stdin = Support.unindent(value)
                   value = "-"
                   input stdin
                 end
@@ -52,7 +54,17 @@ module GrassGis
           end
         end
       end
-      cmd.run unless @configuration[:dry]
+      @history << cmd
+      unless @configuration[:dry]
+        run_options = {}
+        if @errors == :console
+          run_options[:error_output] = :console
+        else
+          run_options[:error_output] = :separate
+        end
+        cmd.run run_options
+      end
+      GrassGis.error cmd, @errors
       cmd
     end
 

data/lib/grassgis/support.rb

@@ -0,0 +1,26 @@
+module GrassGis
+  module Support
+    module_function
+
+    def unindent(text, indent = nil)
+      text = text.gsub(/\t/, ' '*8)
+      mx = text.scan(/^ *[^\n\r]/)
+               .flatten
+               .map{ |s| s[-1,1]==' ' ? nil : (s.size-1) }
+               .compact.min
+      if mx && mx>0
+        text.gsub!(/^ {1,#{mx}}/, "")
+      end
+      lines = text.split(/\r?\n/)
+      if lines.first.strip.empty? || lines.last.strip.empty?
+        lines.shift while lines.first.strip.empty?
+        lines.pop while lines.last.strip.empty?
+      end
+      if indent
+        indent = ' ' * indent if indent.kind_of?(Numeric)
+        lines = lines.map { |line| "#{indent}#{line}" }
+      end
+      lines.join("\n")
+    end
+  end
+end

data/lib/grassgis/version.rb

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

data/lib/grassgis.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grassgis
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Javier Goizueta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys_cmd
@@ -83,6 +83,7 @@ files:
 - lib/grassgis.rb
 - lib/grassgis/context.rb
 - lib/grassgis/module.rb
+- lib/grassgis/support.rb
 - lib/grassgis/version.rb
 homepage: https://github.com/jgoizueta/grassgis
 licenses: