grassgis 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 788c22870c881d792c8412e3f2ebbe44015c6e28
-  data.tar.gz: 2f4204831ac3bd07ffa8ee5f774777ba5faabae0
+  metadata.gz: 299ce1dcdebe07da42c2207549ab9fdeacc9cb2b
+  data.tar.gz: 206df84d976c27567c4a5fe7fc3dd1949d5f92d6
 SHA512:
-  metadata.gz: c17ad3bc200c2ac699e95d61ca32ab734b03f6bff74e1219ea3c18bd9dbab3fac9d07be77e44a0895efa3d33d8ee2f5acf2eff543c95de326f7b68e7c957adc1
-  data.tar.gz: 8e144e6a0de01b5ba6e875284094114164847c76e545527f3e1756572cbe2a4ce1478d26b81e0c7402f8347efead8ef38a0b3030cfd80f575204cb562df33a01
+  metadata.gz: be5e141c19ebc4880733387277d61a47fca4993ba1b74e57de8461c52b93965d83d3380864acc3aa37ac9886c53674d463b098ee0b193f2b7742c843c49a845d
+  data.tar.gz: f9d883babf14d38607cc7430c964cfd10d017a246256b135ef6a26a6ba65db142481c94700744d975c081047506305aca059050870bb164355e8fc744ece2b29

data/README.md

@@ -1,5 +1,8 @@
 # GrassGis
 
+[![Gem Version](https://badge.fury.io/rb/grassgis.svg)](http://badge.fury.io/rb/grassgis)
+[![Build Status](https://travis-ci.org/jgoizueta/grassgis.svg)](https://travis-ci.org/jgoizueta/grassgis)
+
 Support for scripting GRASS with Ruby.
 
 ## Installation
@@ -40,11 +43,13 @@ 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.
+* Write more documentation with examples.
+* Add some session helpers:
+  - Method to clean GRASS temporaries ($GISBASE/etc/clean_temp), or do
+    it automatically when disposing the session.
+  - Methods to check if maps exist
+  - Methods that return information as objects (arrays, hashes), e.g.
+    values returned by r.what, the current region, etc.
 
 ### GRASS cooking DSL
 

data/lib/grassgis/context.rb

@@ -17,13 +17,14 @@ module GrassGis
         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[:true_color] = true unless config.key?(:true_color)
+      config[:transparent] = true unless config.key?(:transparent)
+      config[:png_auto_write] = true unless config.key?(:png_auto_write)
       config[:gnuplot] ||= 'gnuplot -persist'
       config[:gui] ||= 'wxpython'
 
       config[:errors] ||= :raise
+      config[:echo] = :commands unless config.key?(:echo)
 
       @config = config
 
@@ -76,6 +77,10 @@ module GrassGis
       last.error_output
     end
 
+    def configuration
+      @config
+    end
+
     def allocate
       @gisrc = Tempfile.new('gisrc')
       @gisrc.puts "LOCATION_NAME: #{@config[:location]}"
@@ -112,7 +117,7 @@ module GrassGis
       end
       insert_path 'PATH', *paths
       insert_path 'MANPATH', File.join(@config[:gisbase], 'man')
-      @history = @config[:history] = []
+      @history = []
     end
 
     def dispose
@@ -129,7 +134,7 @@ module GrassGis
       define_method root_module.to_sym do
         var_name = "@#{root_module}"
         m = instance_variable_get(var_name)
-        m ||= Module.new(root_module, configuration: @config)
+        m ||= Module.new(root_module, context: self)
         instance_variable_set var_name, m
         m
       end
@@ -159,8 +164,57 @@ module GrassGis
       instance_eval(&blk)
     end
 
+    def dry?
+      @config[:dry]
+    end
+
+    def execute(cmd)
+      @history << cmd
+      if @config[:echo]
+        puts cmd.to_s(with_input: false)
+      end
+      log_file = @config[:log] || @config[:history]
+      if log_file
+        log_timestamp log_file
+        log log_file, cmd.to_s(with_input: true)
+      end
+      unless dry?
+        cmd.run error_output: :reparate
+      end
+      if cmd.output
+        puts cmd.output if @config[:echo] == :output
+      end
+      handle_errors cmd
+      cmd
+    end
+
   private
 
+    def log_timestamp(file)
+      log file, Time.now
+    end
+
+    def log(file, message)
+      if file && message
+        File.open(file, 'a') do |log_file|
+          log_file.puts message
+        end
+      end
+    end
+
+    def handle_errors(cmd)
+      GrassGis.error cmd, @config[:errors]
+      if @config[:echo] == :output || @config[:log] || @config[:errors] == :console
+        error_info = GrassGis.error_info(cmd)
+        if error_info
+          if @config[:errors] == :console || @config[:echo] == :output
+            STDERR.puts error_info
+          end
+          log @config[:log], error_info
+        end
+      end
+    end
+
     def bool_var(value)
       value ? 'TRUE' : 'FALSE'
     end
@@ -221,15 +275,27 @@ module GrassGis
   #
   # 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
+  # :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 :errors 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.
+  #
+  # :log is used to define a loggin file where executed commands
+  # and its output is written.
+  #
+  # :history is used to define a loggin file where only
+  # executed commands are written.
   #
-  #   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.
+  # :echo controls what is echoed to the standard output
+  # and can be one of the following options:
+  # * :commands show all executed commands (the default)
+  # * :output show the output of commands too
+  # * false don't echo anything
   #
   def self.session(config, &blk)
     context = Context.new(config)
@@ -246,10 +312,11 @@ module GrassGis
     command && (!!command.error || (command.status_value && command.status_value != 0))
   end
 
-  def error_info(command)
+  def self.error_info(command)
     if command
       if command.error
-        command.error.to_s
+        info = "Error (#{command.error.class}):\n"
+        info << 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

data/lib/grassgis/module.rb

@@ -14,9 +14,7 @@ module GrassGis
     def initialize(id, options = {})
       @id = id.to_s
       @parent = options[:parent]
-      @configuration = options[:configuration] || {}
-      @history = @configuration[:history] || []
-      @errors = @configuration[:errors] || :raise
+      @context = options[:context]
     end
 
     def name
@@ -54,22 +52,14 @@ module GrassGis
           end
         end
       end
-      @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
+      if @context
+        @context.execute cmd
       end
-      GrassGis.error cmd, @errors
       cmd
     end
 
     def method_missing(method, *args)
-      m = Module.new(method, parent: self, configuration: @configuration)
+      m = Module.new(method, parent: self, context: @context)
       if args.size > 0
         m.run *args
       else

data/lib/grassgis/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grassgis
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Javier Goizueta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys_cmd