gauge-ruby 0.4.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 86bb6e44e272971e83b2bef3c38dd92106cae506
-  data.tar.gz: cfdf3a81e93b61c3acc54da0a123630781043860
+SHA256:
+  metadata.gz: a3bcf9ae0d69a23863f652540236e9684432da817c26b989d0c7c07c6e147662
+  data.tar.gz: 6e56286778ec606b7ccd20035e7b58192b6c72c8a398c7ba0619b613cc8fb6b3
 SHA512:
-  metadata.gz: 36640d7d7936fc4600b7dc1040b922f893bd72ff4e1a514251fefba70a16459009c508031c57e328c59b87da07e4845622409f5da1c4539a66426fa074660042
-  data.tar.gz: 220d4b472ee354d203bcbe35ab54f40f33be040d9eb8b664fc6e5001b0c5888f5000cd508fb4de196f6ed7a831641a2ee54f156247846a97af9846495016a341
+  metadata.gz: 11c74029d398ba60279ae148bd7e5b53a1bec7202ae6730ca19d9e0f48d1bc1108c7f66add8828ed2571e9152616f6421cd571d2f86e82ea373a494474e4f309
+  data.tar.gz: ef8d048a3af560c04777f683c0cd61032e809c1afde5f9acee97171abf435297e54065d11c3f8cbf4900bcff304b0ef5b97df7813005d6f3e0c8f1bd1f9f168e

data/lib/code_parser.rb

@@ -1,26 +1,15 @@
-# Copyright 2018 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/>.
-
+=begin
+ *  Copyright (c) ThoughtWorks, Inc.
+ *  Licensed under the Apache License, Version 2.0
+ *  See LICENSE.txt in the project root for license information.
+=end
 require 'parser/current'
 require 'unparser'
 require 'method_source'
 require 'fileutils'
 require 'tempfile'
 require 'util'
+require 'messages_pb'
 
 module Gauge
   # @api private
@@ -30,21 +19,18 @@ module Gauge
       arg_node.children
     end
 
-    def self.process_node(node, param_positions, new_param_values, new_step_text)
+    def self.process_node(node, param_positions, _new_param_values, new_step_text)
       new_params = []
       args = step_args_from_code node
-      param_positions.sort_by!(&:newPosition).each.with_index {|e, i|
+      old_params = args.map { |arg| Unparser.unparse arg }
+      param_positions.sort_by!(&:newPosition).each.with_index do |e, i|
         if e.oldPosition == -1
-          param = Util.remove_special_chars new_param_values[e.newPosition].downcase.split.join('_')
-          if param == ''
-            param = i
-          end
-          new_params[e.newPosition] = "arg_#{param}"
+          new_params[e.newPosition] = Util.get_param_name(old_params, i)
         else
           new_params[e.newPosition] = args[e.oldPosition].children[0]
         end
-      }
-      args = new_params.map {|v| Parser::AST::Node.new(:arg, [v])}
+      end
+      args = new_params.map { |v| Parser::AST::Node.new(:arg, [v]) }
       step = [node.children[0].children[0], node.children[0].children[1], Parser::AST::Node.new(:str, [new_step_text])]
       c1 = Parser::AST::Node.new(:send, step)
       c2 = Parser::AST::Node.new(:args, args)
@@ -56,9 +42,9 @@ module Gauge
       if ast && step_node?(ast)
         visitor.call(ast)
       else
-        children = ast.children.map {|node|
+        children = ast.children.map do |node|
           replace(node, &visitor)
-        }
+        end
         return ast.updated(nil, children, nil)
       end
     end
@@ -67,37 +53,62 @@ module Gauge
       node.type == :block && node.children[0].children.size > 2 && node.children[0].children[1] == :step
     end
 
+    def self.create_params_diff(old_node, new_node)
+      params_loc = old_node.children[1].loc
+      text = Unparser.unparse new_node.children[1]
+      if old_node.children[1].children.size > 1
+        span = Messages::Span.new(start: params_loc.begin.line, startChar: params_loc.begin.column + 1,
+                                  end: params_loc.end.line, endChar: params_loc.end.column)
+      else
+        span = Messages::Span.new(start: old_node.loc.begin.line, startChar: old_node.loc.begin.column,
+                                  end: old_node.children[2].loc.line, endChar: old_node.children[2].loc.column)
+        text = "do#{text.empty? ? text : " |#{text}|"}\n\t"
+      end
+      Messages::TextDiff.new(content: text, span: span)
+    end
+
+    def self.create_diffs(old_node, new_node)
+      step_loc = old_node.children[0].children[2].loc
+      step_text = new_node.children[0].children[2].children[0]
+      span = Messages::Span.new(start: step_loc.begin.line,
+                                end: step_loc.end.line,
+                                startChar: step_loc.begin.column + 1,
+                                endChar: step_loc.end.column)
+      [Messages::TextDiff.new(content: step_text, span: span), create_params_diff(old_node, new_node)]
+    end
+
     def self.refactor_args(step_text, ast, param_positions, new_param_values, new_step_text)
+      diffs = nil
       new_ast = replace ast do |node|
         if node.children[0].children[2].children[0] == step_text
-          process_node(node, param_positions, new_param_values, new_step_text)
-        else
+          old_node = node.clone
+          node = process_node(node, param_positions, new_param_values, new_step_text)
+          diffs = create_diffs(old_node, node)
+        end
           node
         end
+      code = Unparser.unparse new_ast
+      { content: code, diffs: diffs }
       end
-      Unparser.unparse new_ast
-    end
 
     def self.refactor(step_info, param_positions, new_step)
       ast = code_to_ast File.read(step_info[:locations][0][:file])
-      refactor_args(step_info[:step_text], ast, param_positions, new_step.parameters, new_step.parameterizedStepValue)
+      refactor_args(step_info[:step_text], ast, param_positions,
+                    new_step.parameters,
+                    new_step.parameterizedStepValue)
     end
 
-    private
+    private_class_method
 
     def self.code_to_ast(code)
       begin
         buffer = Parser::Source::Buffer.new '(string)'
         buffer.source = code
         parser = Parser::CurrentRuby.new
-        return parser.parse(buffer)
+      parser.parse(buffer)
       rescue Exception => e
-        Gauge::Log.error e.message
+        GaugeLog.error e
       end
     end
-
-    def self.include_args(code_string, params)
-      code_string.gsub("do", "do #{params}")
-    end
   end
-end
+end

data/lib/configuration.rb

@@ -1,22 +1,8 @@
-# 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/>.
-
-# Gauge runtime for Ruby language. Read more about Gauge: http://getgauge.io
-
+=begin
+ *  Copyright (c) ThoughtWorks, Inc.
+ *  Licensed under the Apache License, Version 2.0
+ *  See LICENSE.txt in the project root for license information.
+=end
 # @api public
 module Gauge
   class << self
@@ -53,12 +39,12 @@ module Gauge
   class Configuration
     def initialize
       @includes=[]
+      @screenshot_writer = true
+      @custom_screengrabber = false
       @screengrabber = -> {
-          file = File.open("#{Dir.tmpdir}/screenshot.png", "w+")
-          `gauge_screenshot #{file.path}`
-          file_content = File.binread(file.path)
-          File.delete file
-          return file_content
+        file_name = Util.unique_screenshot_file
+        `gauge_screenshot #{file_name}`
+        return File.basename(file_name)
       }
     end
 
@@ -79,7 +65,26 @@ module Gauge
     end
 
     def screengrabber=(block)
-      @screengrabber=block
+      GaugeLog.warning("[DEPRECATED] Use custom_screenshot_writer instead.")
+      @screenshot_writer = false
+      set_screengrabber(block)
+    end
+
+    def custom_screenshot_writer=(block)
+      @screenshot_writer = true
+      set_screengrabber(block)
+    end
+
+    def screenshot_writer?
+      @screenshot_writer
+    end
+
+    def custom_screengrabber?
+      @custom_screengrabber
+    end
+
+    def screenshot_dir
+      ENV['gauge_screenshots_dir']
     end
 
     def self.include_configured_modules
@@ -88,5 +93,11 @@ module Gauge
       main=TOPLEVEL_BINDING.eval('self')
       self.instance.includes.each &main.method(:include)
     end
+
+    private
+    def set_screengrabber(block)
+      @custom_screengrabber = true
+      @screengrabber=block
+    end
   end
-end
+end

data/lib/datastore.rb

@@ -1,20 +1,8 @@
-# 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/>.
-
+=begin
+ *  Copyright (c) ThoughtWorks, Inc.
+ *  Licensed under the Apache License, Version 2.0
+ *  See LICENSE.txt in the project root for license information.
+=end
 module Gauge
   # @api public
   class DataStore
@@ -81,4 +69,4 @@ module Gauge
     @@spec_datastore = DataStore.new
     @@scenario_datastore = DataStore.new
   end
-end
+end

data/lib/executor.rb

@@ -1,27 +1,16 @@
-# Copyright 2018 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/>.
+=begin
+ *  Copyright (c) ThoughtWorks, Inc.
+ *  Licensed under the Apache License, Version 2.0
+ *  See LICENSE.txt in the project root for license information.
+=end
 require 'ruby-debug-ide'
 require_relative 'gauge'
 
-ATTACH_DEBUGGER_EVENT = "Runner Ready for Debugging"
+ATTACH_DEBUGGER_EVENT = 'Runner Ready for Debugging'
 
 module Gauge
   class DebugOptions
-    attr_accessor :host, :port, :notify_dispatcher
+    attr_accessor :host, :port, :notify_dispatcher, :socket_path, :skip_wait_for_start
   end
 
   # @api private
@@ -30,10 +19,11 @@ module Gauge
       start_debugger
       Dir["#{dir}/**/*.rb"].each do |x|
         begin
+          GaugeLog.debug "Loading step implemetations from #{x} dirs"
           ENV['GAUGE_STEP_FILE'] = x
           require x
         rescue Exception => e
-          Gauge::Log.error "[ERROR] Cannot import #{x}. Reason: #{e.message}"
+          GaugeLog.error "Cannot import #{x}. Reason: #{e.message}"
         end
       end
     end
@@ -42,9 +32,10 @@ module Gauge
       if ENV['DEBUGGING']
         options = DebugOptions.new
         options.host = '127.0.0.1'
-        options.port = ENV["DEBUG_PORT"].to_i
+        options.port = ENV['DEBUG_PORT'].to_i
         options.notify_dispatcher = false
-        Gauge::Log.info ATTACH_DEBUGGER_EVENT
+        options.skip_wait_for_start = false
+        GaugeLog.info ATTACH_DEBUGGER_EVENT
         Debugger.prepare_debugger(options)
       end
     end
@@ -59,22 +50,24 @@ module Gauge
     end
 
     def self.execute_hooks(hooks, currentExecutionInfo, should_filter)
-      begin
-        hooks.each do |hook|
-          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
+      hooks.each do |hook|
+        if !should_filter || hook[:options][:tags].empty?
+          next hook[:block].call(currentExecutionInfo)
+        end
+        tags = currentExecutionInfo.currentSpec.tags + get_scenario_tags(currentExecutionInfo)
+        intersection = (tags & hook[:options][:tags])
+        if (hook[:options][:operator] == 'OR' && !intersection.empty?) ||
+           (hook[:options][:operator] == 'AND' && intersection.length == hook[:options][:tags].length)
+          hook[:block].call(currentExecutionInfo)
         end
-        return nil
-      rescue Exception => e
-        return e
       end
+      nil
+    rescue Exception => e
+      e
+    end
+
+    def self.get_scenario_tags(info)
+      !info.currentScenario.nil? ? info.currentScenario.tags : []
     end
   end
-end
+end

data/lib/gauge.rb

@@ -1,21 +1,8 @@
-# Copyright 2018 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/>.
-
-require_relative 'connector'
+=begin
+ *  Copyright (c) ThoughtWorks, Inc.
+ *  Licensed under the Apache License, Version 2.0
+ *  See LICENSE.txt in the project root for license information.
+=end
 require_relative 'method_cache'
 require_relative 'configuration'
 
@@ -107,7 +94,7 @@ module Kernel
     step_texts = args - opts
     opts = { continue_on_failure: false }.merge opts.reduce({}, :merge)
     step_texts.each do |text|
-      step_value = Gauge::Connector.step_value(text)
+      step_value = Gauge::Util.step_value(text)
       si = { location: { file: ENV['GAUGE_STEP_FILE'], span: {} },
              block: block, step_text: text,
              recoverable: opts[:continue_on_failure] }

data/lib/gauge_messages.rb

@@ -1,20 +1,8 @@
-# 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/>.
-
+=begin
+ *  Copyright (c) ThoughtWorks, Inc.
+ *  Licensed under the Apache License, Version 2.0
+ *  See LICENSE.txt in the project root for license information.
+=end
 # @api public
 module Gauge
   class << self
@@ -39,12 +27,18 @@ module Gauge
       @gauge_messages ||= GaugeMessages.new
     end
 
+    def pending_messages()
+        pending_messages = @messages.select { |m| m != nil}
+        @messages = []
+        pending_messages
+    end
+
     def write(message)
       @messages.push(message)
     end
 
     def get
-      @messages
+      @messages.select { |m| m != nil}
     end
 
     def clear