gauge-ruby 0.0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e2188a5e620b9ea6f96412402b3da4ea7dd152a
+  data.tar.gz: eda8692a31244882c0a50a8395124270ae689216
+SHA512:
+  metadata.gz: dcca9d23502d72a8a98071255853ac8ee9b213bfdd58506351c1df3cca4d47eb064b058e5c053cf40ea66cd2aa89ba231523f9d4c545b295a125c1ace3dcf558
+  data.tar.gz: cc7dcd0093d0c10357839a5a16d68591659ba3a8e0ad0d5720e1dbf1b55d89f43f3efbcfae62ff1cdae00646b10c75058fb07641dec5158967a2ffdd5ee6b38d

data/lib/api.pb.rb

@@ -0,0 +1,211 @@
+#!/usr/bin/env ruby
+
+# 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/>.
+
+# Generated by the protocol buffer compiler. DO NOT EDIT!
+
+require 'protocol_buffers'
+
+begin; require 'spec.pb'; rescue LoadError; end
+
+module Gauge
+  # @api private
+  module Messages
+    # forward declarations
+    class GetProjectRootRequest < ::ProtocolBuffers::Message; end
+    class GetProjectRootResponse < ::ProtocolBuffers::Message; end
+    class GetInstallationRootRequest < ::ProtocolBuffers::Message; end
+    class GetInstallationRootResponse < ::ProtocolBuffers::Message; end
+    class GetAllStepsRequest < ::ProtocolBuffers::Message; end
+    class GetAllStepsResponse < ::ProtocolBuffers::Message; end
+    class GetAllSpecsRequest < ::ProtocolBuffers::Message; end
+    class GetAllSpecsResponse < ::ProtocolBuffers::Message; end
+    class GetAllConceptsRequest < ::ProtocolBuffers::Message; end
+    class GetAllConceptsResponse < ::ProtocolBuffers::Message; end
+    class ConceptInfo < ::ProtocolBuffers::Message; end
+    class GetStepValueRequest < ::ProtocolBuffers::Message; end
+    class GetStepValueResponse < ::ProtocolBuffers::Message; end
+    class GetLanguagePluginLibPathRequest < ::ProtocolBuffers::Message; end
+    class GetLanguagePluginLibPathResponse < ::ProtocolBuffers::Message; end
+    class ErrorResponse < ::ProtocolBuffers::Message; end
+    class PerformRefactoringRequest < ::ProtocolBuffers::Message; end
+    class PerformRefactoringResponse < ::ProtocolBuffers::Message; end
+    class APIMessage < ::ProtocolBuffers::Message; end
+
+    class GetProjectRootRequest < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetProjectRootRequest"
+
+    end
+
+    class GetProjectRootResponse < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetProjectRootResponse"
+
+      required :string, :projectRoot, 1
+    end
+
+    class GetInstallationRootRequest < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetInstallationRootRequest"
+
+    end
+
+    class GetInstallationRootResponse < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetInstallationRootResponse"
+
+      required :string, :installationRoot, 1
+    end
+
+    class GetAllStepsRequest < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetAllStepsRequest"
+
+    end
+
+    class GetAllStepsResponse < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetAllStepsResponse"
+
+      repeated ::Gauge::Messages::ProtoStepValue, :allSteps, 1
+    end
+
+    class GetAllSpecsRequest < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetAllSpecsRequest"
+
+    end
+
+    class GetAllSpecsResponse < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetAllSpecsResponse"
+
+      repeated ::Gauge::Messages::ProtoSpec, :specs, 1
+    end
+
+    class GetAllConceptsRequest < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetAllConceptsRequest"
+
+    end
+
+    class GetAllConceptsResponse < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetAllConceptsResponse"
+
+      repeated ::Gauge::Messages::ConceptInfo, :concepts, 1
+    end
+
+    class ConceptInfo < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.ConceptInfo"
+
+      required ::Gauge::Messages::ProtoStepValue, :stepValue, 1
+      required :string, :filepath, 2
+      required :int32, :lineNumber, 3
+    end
+
+    class GetStepValueRequest < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetStepValueRequest"
+
+      required :string, :stepText, 1
+      optional :bool, :hasInlineTable, 2
+    end
+
+    class GetStepValueResponse < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetStepValueResponse"
+
+      required ::Gauge::Messages::ProtoStepValue, :stepValue, 1
+    end
+
+    class GetLanguagePluginLibPathRequest < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetLanguagePluginLibPathRequest"
+
+      required :string, :language, 1
+    end
+
+    class GetLanguagePluginLibPathResponse < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.GetLanguagePluginLibPathResponse"
+
+      required :string, :path, 1
+    end
+
+    class ErrorResponse < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.ErrorResponse"
+
+      required :string, :error, 1
+    end
+
+    class PerformRefactoringRequest < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.PerformRefactoringRequest"
+
+      required :string, :oldStep, 1
+      required :string, :newStep, 2
+    end
+
+    class PerformRefactoringResponse < ::ProtocolBuffers::Message
+      set_fully_qualified_name "gauge.messages.PerformRefactoringResponse"
+
+      required :bool, :success, 1
+      repeated :string, :errors, 2
+      repeated :string, :filesChanged, 3
+    end
+
+    class APIMessage < ::ProtocolBuffers::Message
+      # forward declarations
+
+      # enums
+      module APIMessageType
+        include ::ProtocolBuffers::Enum
+
+        set_fully_qualified_name "gauge.messages.APIMessage.APIMessageType"
+
+        GetProjectRootRequest = 1
+        GetProjectRootResponse = 2
+        GetInstallationRootRequest = 3
+        GetInstallationRootResponse = 4
+        GetAllStepsRequest = 5
+        GetAllStepResponse = 6
+        GetAllSpecsRequest = 7
+        GetAllSpecsResponse = 8
+        GetStepValueRequest = 9
+        GetStepValueResponse = 10
+        GetLanguagePluginLibPathRequest = 11
+        GetLanguagePluginLibPathResponse = 12
+        ErrorResponse = 13
+        GetAllConceptsRequest = 14
+        GetAllConceptsResponse = 15
+        PerformRefactoringRequest = 16
+        PerformRefactoringResponse = 17
+      end
+
+      set_fully_qualified_name "gauge.messages.APIMessage"
+
+      required ::Gauge::Messages::APIMessage::APIMessageType, :messageType, 1
+      required :int64, :messageId, 2
+      optional ::Gauge::Messages::GetProjectRootRequest, :projectRootRequest, 3
+      optional ::Gauge::Messages::GetProjectRootResponse, :projectRootResponse, 4
+      optional ::Gauge::Messages::GetInstallationRootRequest, :installationRootRequest, 5
+      optional ::Gauge::Messages::GetInstallationRootResponse, :installationRootResponse, 6
+      optional ::Gauge::Messages::GetAllStepsRequest, :allStepsRequest, 7
+      optional ::Gauge::Messages::GetAllStepsResponse, :allStepsResponse, 8
+      optional ::Gauge::Messages::GetAllSpecsRequest, :allSpecsRequest, 9
+      optional ::Gauge::Messages::GetAllSpecsResponse, :allSpecsResponse, 10
+      optional ::Gauge::Messages::GetStepValueRequest, :stepValueRequest, 11
+      optional ::Gauge::Messages::GetStepValueResponse, :stepValueResponse, 12
+      optional ::Gauge::Messages::GetLanguagePluginLibPathRequest, :libPathRequest, 13
+      optional ::Gauge::Messages::GetLanguagePluginLibPathResponse, :libPathResponse, 14
+      optional ::Gauge::Messages::ErrorResponse, :error, 15
+      optional ::Gauge::Messages::GetAllConceptsRequest, :allConceptsRequest, 16
+      optional ::Gauge::Messages::GetAllConceptsResponse, :allConceptsResponse, 17
+      optional ::Gauge::Messages::PerformRefactoringRequest, :performRefactoringRequest, 18
+      optional ::Gauge::Messages::PerformRefactoringResponse, :performRefactoringResponse, 19
+    end
+
+  end
+end

data/lib/code_parser.rb

@@ -0,0 +1,84 @@
+# 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/>.
+
+require 'parser/current'
+require 'method_source'
+require 'fileutils'
+require 'tempfile'
+
+module Gauge
+  # @api private
+  class CodeParser
+    def self.step_args_from_code(code)
+      ast=code_to_ast(code)
+      arg_node = ast.children[1]
+      arg_node.children
+    end
+
+    def self.refactor_args(code, param_positions, new_param_values, new_step_text)
+      new_params = []
+      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]
+        else
+          new_params[e.newPosition] = args[e.oldPosition].children[0]
+        end
+      }
+      buffer = Parser::Source::Buffer.new '(rewriter)'
+      buffer.source=code
+      
+      ast = code_to_ast(code)
+      new_params_string = "|#{new_params.join(', ')}|".gsub("||", "") # no params = empty string
+      
+      rewriter = Parser::Source::Rewriter.new(buffer)
+        .replace(ast.children[0].location.expression, "step '#{new_step_text}'")
+      
+      # hack, could not find an easy way to manipulate the ast to include arguments, when none existed originally.
+      # it's just easy to add arguments via string substitution.
+      return include_args(rewriter.process, new_params_string) if ast.children[1].location.expression.nil?
+      
+      #insert new arguments
+      rewriter.replace(ast.children[1].location.expression, new_params_string).process
+    end
+
+    def self.refactor(code, param_positions, new_param_values, new_step_text)
+      source_code=code.source
+      ast = code_to_ast source_code
+      file, line = code.source_location
+      refactored_code=refactor_args(source_code, param_positions, new_param_values, new_step_text)
+      tmp_file = Tempfile.new File.basename(file, ".rb")
+      tmp_file.write(File.open(file, "r") { |f| f.read.gsub(source_code, refactored_code)})
+      tmp_file.close
+      FileUtils.mv tmp_file.path, file
+    end
+
+    private
+
+    def self.code_to_ast(code)
+      buffer = Parser::Source::Buffer.new '(string)'
+      buffer.source = code
+
+      parser = Parser::CurrentRuby.new
+      parser.parse(buffer)
+    end
+
+    def self.include_args(code_string, params)
+      code_string.gsub("do", "do #{params}")
+    end
+  end
+end

data/lib/configuration.rb

@@ -0,0 +1,71 @@
+# 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
+  # @api public
+  class << self
+    # @!macro [attach] self.configure
+    #   @method configure(&block)
+    #   @api public
+    #   Custom configuration for Gauge
+    #   Lets you configure modules that need to be included at runtime.
+    # 
+    #   @example
+    #     # Given there are two modules defined
+    #     module Foo 
+    #     end
+    #
+    #     module Bar
+    #     end
+    #
+    #     # Gauge can be configured to include these modules at runtime.
+    #
+    #     Gauge.configure do |config|
+    #       config.include Foo, Bar
+    #     end
+    def configure(&block)
+      Configuration.instance.instance_eval &block
+    end
+  end
+
+  # @api private
+  class Configuration
+    def initialize
+      @includes=[]
+    end
+
+    def self.instance
+      @configuration ||= Configuration.new
+    end
+
+    def include(*includes)
+      @includes.push *includes
+    end
+
+    def includes
+      @includes
+    end
+
+    def self.include_configured_modules
+      # include all modules that have been configured
+      # TODO: move this feature to something more specific, ex look at supporting Sandboxed execution.
+      main=TOPLEVEL_BINDING.eval('self')
+      self.instance.includes.each &main.method(:include)
+    end
+  end
+end

data/lib/connector.rb

@@ -0,0 +1,73 @@
+# 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/>.
+
+require 'protocol_buffers'
+require_relative 'api.pb'
+
+module Gauge
+  # @api private
+  module Connector
+    GAUGE_PORT_ENV = "GAUGE_INTERNAL_PORT"
+    API_PORT_ENV = "GAUGE_API_PORT"
+    HOST_NAME = 'localhost'
+    @@executionSocket
+    @@apiSocket
+
+    def self.apiSocket
+      @@apiSocket
+    end
+
+    def self.executionSocket
+      @@executionSocket
+    end
+
+    def self.make_connections
+      @@executionSocket = TCPSocket.open(HOST_NAME, Runtime.portFromEnvVariable(GAUGE_PORT_ENV))
+      @@apiSocket = TCPSocket.open(HOST_NAME, Runtime.portFromEnvVariable(API_PORT_ENV))
+    end
+
+    def self.message_length(socket)
+      ProtocolBuffers::Varint.decode socket
+    end
+
+    def self.step_value text
+      stepValueRequest = Gauge::Messages::GetStepValueRequest.new(:stepText => text)
+      apiMessage = Gauge::Messages::APIMessage.new(:messageType => Gauge::Messages::APIMessage::APIMessageType::GetStepValueRequest, :stepValueRequest => stepValueRequest)
+      response = get_api_response(apiMessage)
+      if (response.messageType == Gauge::Messages::APIMessage::APIMessageType::ErrorResponse)
+        puts "[Error] Failed to load step implementation. #{response.error.error}:  \"#{text}\""
+        return ''
+      end
+      return response.stepValueResponse.stepValue.stepValue
+    end
+
+    def self.get_api_response(apiMessage)
+      apiMessage.messageId = get_unique_id
+      dataLen = apiMessage.serialize_to_string.bytesize
+      ProtocolBuffers::Varint.encode @@apiSocket, dataLen
+      apiMessage.serialize(@@apiSocket)
+
+      responseLen = message_length(@@apiSocket)
+      data = @@apiSocket.read responseLen
+      message = Gauge::Messages::APIMessage.parse(data)
+    end
+
+    def self.get_unique_id
+      rand(2**63-1)
+    end
+  end
+end