gauge-ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 514aa253e16a9b0b2119820b3f5afa0bb0277d1f
-  data.tar.gz: 6a060abc1853aa62afaeb3ed1626fcc14b5b2f90
+  metadata.gz: c12089561835ca4f98c3832d2507b37d9f0ba03f
+  data.tar.gz: 852373f669d336e8f828fbcb0f59d19fac3d251a
 SHA512:
-  metadata.gz: c6663fcf99dad1adc3ca8ed6c2332296d8d3a923a002726d3ed4fbf1b435afbccbdb6ee6c30a7fa7527d4f4320526c20b581c4ef0f6eb4e2f45ce877675a6e33
-  data.tar.gz: 0a5744c577558d3c45ceeef89a851d6fd3dac9b693295778dd64ce6490cc26dcecc037b6cf7951c1121575a1ea4100ec8dcf70cd215e9723181a68085b68a5b7
+  metadata.gz: f6aa6d61e8fa9f9904f49f646971efac4aa4f34a0f72f620f08fb95d4b47450f326d11242fc6e434339aa45bb0a21678bfcb7806d6d8e76e98224be7c93f849d
+  data.tar.gz: af4914cf14c84260a9c97a66e14ed124a9ae3ca9e29d31dc1fe2c7b8be1fb531c0b8c5c12e74ce233f59d869e0200d3c1a3d8f283216dfe0785ed52b55b5633d

data/lib/code_parser.rb

@@ -34,7 +34,7 @@ module Gauge
       args = step_args_from_code code
       param_positions.sort_by!(&:newPosition).each { |e|
         if e.oldPosition == -1
-          new_params[e.newPosition] = new_param_values[e.newPosition]
+          new_params[e.newPosition] = "arg_#{new_param_values[e.newPosition].downcase.split.join('_')}"
         else
           new_params[e.newPosition] = args[e.oldPosition].children[0]
         end

data/lib/executor.rb

@@ -33,10 +33,18 @@ module Gauge
       end
     end
 
-    def self.execute_hooks(hooks, currentExecutionInfo)
+    def self.execute_hooks(hooks, currentExecutionInfo, should_filter)
       begin
         hooks.each do |hook|
-          hook.call(currentExecutionInfo)
+          if !should_filter || hook[:options][:tags].length == 0
+            next hook[:block].call(currentExecutionInfo)
+          end
+          tags = currentExecutionInfo.currentSpec.tags + currentExecutionInfo.currentScenario.tags
+          intersection = (tags & hook[:options][:tags])
+          if (hook[:options][:operator] == 'OR' && intersection.length > 0) ||
+              (hook[:options][:operator] == 'AND' && intersection.length == hook[:options][:tags].length)
+            hook[:block].call(currentExecutionInfo)
+          end
         end
         return nil
       rescue Exception => e

data/lib/gauge.rb

@@ -26,16 +26,30 @@ module Kernel
     # @!macro [attach] self.hook
     #   @method $1(&block)
     #   @api public
-    #   @param block [block], this block is called while executing the $1 hook
+    #   @param block [block] this block is called while executing the $1 hook
     #   @example
     #      $1 do
     #         puts "I am the $1 hook"
     #      end
     def hook(hook)
-      define_method hook do |&block|
-        Gauge::MethodCache.send("add_#{hook}_hook".to_sym, &block)
+      define_method hook do |options={}, &block|
+        Gauge::MethodCache.send("add_#{hook}_hook".to_sym, options, &block)
       end
     end
+
+    # @!macro [attach] self.tagged_hook
+    #   @method $1(options, &block)
+    #   @api public
+    #   @param block [block] this block is called while executing the $1 hook
+    #   @param {{tags: ['list', 'of', 'tags'], operator: 'OR' | 'AND'}} options specify tags and operator for which this $1 execution hook should run.
+    #   @example
+    #      $1({tags: ['tag2', 'tag1'], operator: 'OR'}) do
+    #         puts "I am the $1 hook"
+    #      end
+    def tagged_hook(hook)
+      hook(hook)
+    end
+
   end
 
   # Specify implementation for a given step
@@ -69,7 +83,7 @@ module Kernel
   #   #        |Mingle |Agile project management     |
   #   #        |Snap   |Hosted continuous integration|
   #   #        |Gocd   |Continuous delivery platform |
-  #   
+  #
   #   step 'Step that takes a table <table>' do |table|
   #     # note the extra <table> that is added to the description
   #       puts x.columns.join("|")
@@ -87,19 +101,19 @@ module Kernel
   end
 
   # Invoked before execution of every step.
-  hook "before_step"
+  tagged_hook "before_step"
   # Invoked after execution of every step.
-  hook "after_step"
+  tagged_hook "after_step"
   # Invoked before execution of every specification.
-  hook "before_spec"
+  tagged_hook "before_spec"
   # Invoked after execution of every specification.
-  hook "after_spec"
+  tagged_hook "after_spec"
   # Invoked before execution of every scenario.
-  hook "before_scenario"
+  tagged_hook "before_scenario"
   # Invoked after execution of every scenario.
-  hook "after_scenario"
+  tagged_hook "after_scenario"
   # Invoked before execution of the entire suite.
   hook "before_suite"
   # Invoked after execution of the entire suite.
   hook "after_suite"
-end
+end

data/lib/gauge_messages.rb

@@ -0,0 +1,54 @@
+# Copyright 2015 ThoughtWorks, Inc.
+
+# This file is part of Gauge-Ruby.
+
+# Gauge-Ruby is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Gauge-Ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Gauge-Ruby.  If not, see <http://www.gnu.org/licenses/>.
+
+# @api public
+module Gauge
+  class << self
+    # @api public
+    # Custom Messages for Gauge
+    # Lets you send custom execution messages to Gauge which are printed in reports.
+    #
+    # @example
+    #   Gauge.write_message 'The answer is 42.'
+    def write_message(message)
+      GaugeMessages.instance.write(message)
+    end
+  end
+
+  # @api private
+  class GaugeMessages
+    def initialize
+      @messages = []
+    end
+
+    def self.instance
+      @gauge_messages ||= GaugeMessages.new
+    end
+
+    def write(message)
+      @messages.push(message)
+    end
+
+    def get
+      @messages
+    end
+
+    def clear
+      @messages = []
+    end
+  end
+end

data/lib/method_cache.rb

@@ -20,14 +20,19 @@ module Gauge
   # @api private
   class MethodCache
     ["before_step", "after_step", "before_spec", "after_spec", "before_scenario", "after_scenario", "before_suite", "after_suite"].each { |hook|
-      define_singleton_method "add_#{hook}_hook" do |&block|
-        self.class_variable_get("@@#{hook}_hooks").push block
+      define_singleton_method "add_#{hook}_hook" do |options={}, &block|
+        options = {operator: "AND", tags: []}.merge options
+        self.class_variable_get("@@#{hook}_hooks").push :block=>  block, :options=> options
       end
       define_singleton_method "get_#{hook}_hooks" do
         self.class_variable_get("@@#{hook}_hooks")
       end
     }
-    
+
+    def self.clear_hooks(hook)
+      self.class_variable_get("@@#{hook}_hooks").clear
+    end
+
     def self.add_step(parameterized_step_text, &block)
       @@steps_map[parameterized_step_text] = block
     end
@@ -77,4 +82,4 @@ module Gauge
   # hack : get the 'main' object and include the configured includes there.
   # can be removed once we have scoped execution.
   MethodCache.add_before_suite_hook { Configuration.include_configured_modules }
-end
+end

data/lib/processors/execution_handler.rb

@@ -21,9 +21,9 @@ module Gauge
   module Processors
     # @api private
     module ExecutionHandler
-      def handle_hooks_execution(hooks, message, currentExecutionInfo)
+      def handle_hooks_execution(hooks, message, currentExecutionInfo, should_filter=true)
         start_time= Time.now
-        execution_error = Executor.execute_hooks(hooks, currentExecutionInfo)
+        execution_error = Executor.execute_hooks(hooks, currentExecutionInfo, should_filter)
         if execution_error == nil
           return handle_pass message, time_elapsed_since(start_time)
         else

data/lib/processors/execution_hook_processors.rb

@@ -16,17 +16,18 @@
 # along with Gauge-Ruby.  If not, see <http://www.gnu.org/licenses/>.
 
 require_relative "execution_handler"
+require_relative "../gauge_messages"
 
 module Gauge
   module Processors
     include ExecutionHandler
 
     def process_execution_start_request(message)
-      handle_hooks_execution(MethodCache.get_before_suite_hooks, message, message.executionStartingRequest.currentExecutionInfo)
+      handle_hooks_execution(MethodCache.get_before_suite_hooks, message, message.executionStartingRequest.currentExecutionInfo,false)
     end
 
     def process_execution_end_request(message)
-      handle_hooks_execution(MethodCache.get_after_suite_hooks, message, message.executionEndingRequest.currentExecutionInfo)
+      handle_hooks_execution(MethodCache.get_after_suite_hooks, message, message.executionEndingRequest.currentExecutionInfo, false)
     end
 
     def process_spec_execution_start_request(message)
@@ -46,11 +47,14 @@ module Gauge
     end
 
     def process_step_execution_start_request(message)
+      Gauge::GaugeMessages.instance.clear
       handle_hooks_execution(MethodCache.get_before_step_hooks, message, message.stepExecutionStartingRequest.currentExecutionInfo)
     end
 
     def process_step_execution_end_request(message)
-      handle_hooks_execution(MethodCache.get_after_step_hooks, message, message.stepExecutionEndingRequest.currentExecutionInfo)
+      response = handle_hooks_execution(MethodCache.get_after_step_hooks, message, message.stepExecutionEndingRequest.currentExecutionInfo)
+      response.executionStatusResponse.executionResult.message = Gauge::GaugeMessages.instance.get
+      return response
     end
   end
-end
+end

data/lib/table.rb

@@ -30,14 +30,41 @@ module Gauge
 
     # Gets the column headers of the table
     # @return [string[]]
+    # @deprecated Use [] accessor instead
     def columns
       @columns
     end
 
     # Gets the rows of the table. The rows are two dimensional arrays.
     # @return [string[][]]
+    # @deprecated Use {#[]} accessor instead
     def rows
       @rows
     end
+
+    # Gets the table data.
+    # @param index Either row index, or Column name.
+    # @return [Hash] When an integer index is passed. Values correspond to a the row in the table with the index.
+    # @example
+    #   table[0] => {"Col1" => "Row1.Cell1", "Col2" => "Row2.Col1", ...}
+    #   table[i] => nil # when index is out of range
+    # @return [string[]] When a string key is passed. Values correspond to the respective cells in a row, matching the index of value in Column headers.
+    # @example
+    #   table["Col1"] => ["Row1.Cell1", "Row1.Cell1", ...]
+    #   table["Invalid_Col_Name"] => nil
+    def [](index)
+      return row_values_as_hash(@rows[index]) if index.is_a?(Integer)
+      column_values_as_array(index)
+    end
+
+    private
+    def row_values_as_hash(row)
+      row.nil? ? nil : Hash[@columns.zip(row)]
+    end
+
+    def column_values_as_array(col_name)
+      i = @columns.index col_name
+      i.nil? ? nil : @rows.map { |r| r[i] }
+    end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gauge-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Gauge Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-protocol-buffers
@@ -42,28 +42,28 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: method_source
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.2
 description: Adds Ruby support into Gauge tests
@@ -80,6 +80,7 @@ files:
 - lib/datastore.rb
 - lib/executor.rb
 - lib/gauge.rb
+- lib/gauge_messages.rb
 - lib/gauge_runtime.rb
 - lib/message_processor.rb
 - lib/messages.pb.rb
@@ -97,7 +98,7 @@ files:
 - lib/table.rb
 homepage: http://www.getgauge.io
 licenses:
-- GPLv3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -105,17 +106,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby support for Gauge