gauge-ruby 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86bb6e44e272971e83b2bef3c38dd92106cae506
-  data.tar.gz: cfdf3a81e93b61c3acc54da0a123630781043860
+  metadata.gz: 6ebee2ce6fc18711db236ce40d0d0020dfaad981
+  data.tar.gz: 84c36f79a8c0f8d34711e2838c4d1dcdfed1640b
 SHA512:
-  metadata.gz: 36640d7d7936fc4600b7dc1040b922f893bd72ff4e1a514251fefba70a16459009c508031c57e328c59b87da07e4845622409f5da1c4539a66426fa074660042
-  data.tar.gz: 220d4b472ee354d203bcbe35ab54f40f33be040d9eb8b664fc6e5001b0c5888f5000cd508fb4de196f6ed7a831641a2ee54f156247846a97af9846495016a341
+  metadata.gz: 81b059a9480123961f7deb12b3751a55c8be48441159dedd0b88e49fd7a8ebcf21d21b77f674bc8cbe208a4a2d92c5d8b3e74057dc6dea865163185d9576c95f
+  data.tar.gz: 4b5d87b25a69456bd2659cc0406afc58b12f2cdad7f89f699fee1c0b508ae1ac4c3420b3c20f8da5aadcb1fd5374b5e501d6a0d25ee123455a79c45b19a82593

data/lib/api_pb.rb

@@ -0,0 +1,182 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: api.proto
+
+require 'google/protobuf'
+
+require 'spec_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "gauge.messages.GetProjectRootRequest" do
+  end
+  add_message "gauge.messages.GetProjectRootResponse" do
+    optional :projectRoot, :string, 1
+  end
+  add_message "gauge.messages.GetInstallationRootRequest" do
+  end
+  add_message "gauge.messages.GetInstallationRootResponse" do
+    optional :installationRoot, :string, 1
+  end
+  add_message "gauge.messages.GetAllStepsRequest" do
+  end
+  add_message "gauge.messages.GetAllStepsResponse" do
+    repeated :allSteps, :message, 1, "gauge.messages.ProtoStepValue"
+  end
+  add_message "gauge.messages.SpecsRequest" do
+    repeated :specs, :string, 1
+  end
+  add_message "gauge.messages.SpecsResponse" do
+    repeated :details, :message, 1, "gauge.messages.SpecsResponse.SpecDetail"
+  end
+  add_message "gauge.messages.SpecsResponse.SpecDetail" do
+    optional :spec, :message, 1, "gauge.messages.ProtoSpec"
+    repeated :parseErrors, :message, 2, "gauge.messages.Error"
+  end
+  add_message "gauge.messages.GetAllConceptsRequest" do
+  end
+  add_message "gauge.messages.GetAllConceptsResponse" do
+    repeated :concepts, :message, 1, "gauge.messages.ConceptInfo"
+  end
+  add_message "gauge.messages.ConceptInfo" do
+    optional :stepValue, :message, 1, "gauge.messages.ProtoStepValue"
+    optional :filepath, :string, 2
+    optional :lineNumber, :int32, 3
+  end
+  add_message "gauge.messages.GetStepValueRequest" do
+    optional :stepText, :string, 1
+    optional :hasInlineTable, :bool, 2
+  end
+  add_message "gauge.messages.GetStepValueResponse" do
+    optional :stepValue, :message, 1, "gauge.messages.ProtoStepValue"
+  end
+  add_message "gauge.messages.GetLanguagePluginLibPathRequest" do
+    optional :language, :string, 1
+  end
+  add_message "gauge.messages.GetLanguagePluginLibPathResponse" do
+    optional :path, :string, 1
+  end
+  add_message "gauge.messages.ErrorResponse" do
+    optional :error, :string, 1
+  end
+  add_message "gauge.messages.PerformRefactoringRequest" do
+    optional :oldStep, :string, 1
+    optional :newStep, :string, 2
+  end
+  add_message "gauge.messages.PerformRefactoringResponse" do
+    optional :success, :bool, 1
+    repeated :errors, :string, 2
+    repeated :filesChanged, :string, 3
+  end
+  add_message "gauge.messages.ExtractConceptRequest" do
+    optional :conceptName, :message, 1, "gauge.messages.step"
+    repeated :steps, :message, 2, "gauge.messages.step"
+    optional :changeAcrossProject, :bool, 3
+    optional :conceptFileName, :string, 4
+    optional :selectedTextInfo, :message, 5, "gauge.messages.textInfo"
+  end
+  add_message "gauge.messages.textInfo" do
+    optional :fileName, :string, 1
+    optional :startingLineNo, :int32, 2
+    optional :endLineNo, :int32, 3
+  end
+  add_message "gauge.messages.step" do
+    optional :name, :string, 1
+    optional :table, :string, 2
+    optional :paramTableName, :string, 3
+  end
+  add_message "gauge.messages.ExtractConceptResponse" do
+    optional :isSuccess, :bool, 1
+    optional :error, :string, 2
+    repeated :filesChanged, :string, 3
+  end
+  add_message "gauge.messages.FormatSpecsRequest" do
+    repeated :specs, :string, 1
+  end
+  add_message "gauge.messages.FormatSpecsResponse" do
+    repeated :errors, :string, 1
+    repeated :warnings, :string, 2
+  end
+  add_message "gauge.messages.UnsupportedApiMessageResponse" do
+  end
+  add_message "gauge.messages.APIMessage" do
+    optional :messageType, :enum, 1, "gauge.messages.APIMessage.APIMessageType"
+    optional :messageId, :int64, 2
+    optional :projectRootRequest, :message, 3, "gauge.messages.GetProjectRootRequest"
+    optional :projectRootResponse, :message, 4, "gauge.messages.GetProjectRootResponse"
+    optional :installationRootRequest, :message, 5, "gauge.messages.GetInstallationRootRequest"
+    optional :installationRootResponse, :message, 6, "gauge.messages.GetInstallationRootResponse"
+    optional :allStepsRequest, :message, 7, "gauge.messages.GetAllStepsRequest"
+    optional :allStepsResponse, :message, 8, "gauge.messages.GetAllStepsResponse"
+    optional :specsRequest, :message, 9, "gauge.messages.SpecsRequest"
+    optional :specsResponse, :message, 10, "gauge.messages.SpecsResponse"
+    optional :stepValueRequest, :message, 11, "gauge.messages.GetStepValueRequest"
+    optional :stepValueResponse, :message, 12, "gauge.messages.GetStepValueResponse"
+    optional :libPathRequest, :message, 13, "gauge.messages.GetLanguagePluginLibPathRequest"
+    optional :libPathResponse, :message, 14, "gauge.messages.GetLanguagePluginLibPathResponse"
+    optional :error, :message, 15, "gauge.messages.ErrorResponse"
+    optional :allConceptsRequest, :message, 16, "gauge.messages.GetAllConceptsRequest"
+    optional :allConceptsResponse, :message, 17, "gauge.messages.GetAllConceptsResponse"
+    optional :performRefactoringRequest, :message, 18, "gauge.messages.PerformRefactoringRequest"
+    optional :performRefactoringResponse, :message, 19, "gauge.messages.PerformRefactoringResponse"
+    optional :extractConceptRequest, :message, 20, "gauge.messages.ExtractConceptRequest"
+    optional :extractConceptResponse, :message, 21, "gauge.messages.ExtractConceptResponse"
+    optional :formatSpecsRequest, :message, 22, "gauge.messages.FormatSpecsRequest"
+    optional :formatSpecsResponse, :message, 23, "gauge.messages.FormatSpecsResponse"
+    optional :unsupportedApiMessageResponse, :message, 24, "gauge.messages.UnsupportedApiMessageResponse"
+  end
+  add_enum "gauge.messages.APIMessage.APIMessageType" do
+    value :GetProjectRootRequest, 0
+    value :GetProjectRootResponse, 1
+    value :GetInstallationRootRequest, 2
+    value :GetInstallationRootResponse, 3
+    value :GetAllStepsRequest, 4
+    value :GetAllStepResponse, 5
+    value :SpecsRequest, 6
+    value :SpecsResponse, 7
+    value :GetStepValueRequest, 8
+    value :GetStepValueResponse, 9
+    value :GetLanguagePluginLibPathRequest, 10
+    value :GetLanguagePluginLibPathResponse, 11
+    value :ErrorResponse, 12
+    value :GetAllConceptsRequest, 13
+    value :GetAllConceptsResponse, 14
+    value :PerformRefactoringRequest, 15
+    value :PerformRefactoringResponse, 16
+    value :ExtractConceptRequest, 17
+    value :ExtractConceptResponse, 18
+    value :FormatSpecsRequest, 19
+    value :FormatSpecsResponse, 20
+    value :UnsupportedApiMessageResponse, 21
+  end
+end
+
+module Gauge
+  module Messages
+    GetProjectRootRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetProjectRootRequest").msgclass
+    GetProjectRootResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetProjectRootResponse").msgclass
+    GetInstallationRootRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetInstallationRootRequest").msgclass
+    GetInstallationRootResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetInstallationRootResponse").msgclass
+    GetAllStepsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetAllStepsRequest").msgclass
+    GetAllStepsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetAllStepsResponse").msgclass
+    SpecsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.SpecsRequest").msgclass
+    SpecsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.SpecsResponse").msgclass
+    SpecsResponse::SpecDetail = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.SpecsResponse.SpecDetail").msgclass
+    GetAllConceptsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetAllConceptsRequest").msgclass
+    GetAllConceptsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetAllConceptsResponse").msgclass
+    ConceptInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.ConceptInfo").msgclass
+    GetStepValueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetStepValueRequest").msgclass
+    GetStepValueResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetStepValueResponse").msgclass
+    GetLanguagePluginLibPathRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetLanguagePluginLibPathRequest").msgclass
+    GetLanguagePluginLibPathResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.GetLanguagePluginLibPathResponse").msgclass
+    ErrorResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.ErrorResponse").msgclass
+    PerformRefactoringRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.PerformRefactoringRequest").msgclass
+    PerformRefactoringResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.PerformRefactoringResponse").msgclass
+    ExtractConceptRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.ExtractConceptRequest").msgclass
+    TextInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.textInfo").msgclass
+    Step = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.step").msgclass
+    ExtractConceptResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.ExtractConceptResponse").msgclass
+    FormatSpecsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.FormatSpecsRequest").msgclass
+    FormatSpecsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.FormatSpecsResponse").msgclass
+    UnsupportedApiMessageResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.UnsupportedApiMessageResponse").msgclass
+    APIMessage = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.APIMessage").msgclass
+    APIMessage::APIMessageType = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.APIMessage.APIMessageType").enummodule
+  end
+end

data/lib/connector.rb

@@ -16,13 +16,13 @@
 # along with Gauge-Ruby.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'protocol_buffers'
-require_relative 'api.pb'
+require_relative 'api_pb'
 
 module Gauge
   # @api private
   module Connector
     GAUGE_PORT_ENV = "GAUGE_INTERNAL_PORT"
-    HOST_NAME = 'localhost'
+    HOST_NAME = '127.0.0.1'
     @@executionSocket = nil
 
 

data/lib/executor.rb

@@ -17,7 +17,7 @@
 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
@@ -42,7 +42,7 @@ 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
         Debugger.prepare_debugger(options)
@@ -59,22 +59,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_runtime.rb

@@ -17,15 +17,16 @@
 
 require 'socket'
 require 'protocol_buffers'
+require 'grpc'
 
-require_relative 'messages.pb'
+require_relative 'messages_pb'
 require_relative 'executor'
 require_relative 'static_loader'
 require_relative 'connector'
 require_relative 'message_processor'
 require_relative 'util'
 require_relative 'log'
-
+require_relative 'lsp_server'
 
 module Gauge
   # @api private
@@ -33,24 +34,23 @@ module Gauge
     DEFAULT_IMPLEMENTATIONS_DIR_PATH = Util.get_step_implementation_dir
 
     def self.dispatch_messages(socket)
-      while (!socket.eof?)
+      until socket.eof?
         len = Connector.message_length(socket)
         data = socket.read len
-        message = Messages::Message.parse(data)
+        message = Messages::Message.decode(data)
         handle_message(socket, message)
-        if message.messageType == Messages::Message::MessageType::KillProcessRequest || message.messageType == Messages::Message::MessageType::ExecutionEnding
+        if message.messageType == :KillProcessRequest || message.messageType == :ExecutionEnding
           socket.close
           return
         end
       end
     end
 
-
     def self.handle_message(socket, message)
       if !MessageProcessor.is_valid_message(message)
         Gauge::Log.error "Invalid message received : #{message}"
-        execution_status_response = Messages::ExecutionStatusResponse.new(:executionResult => Messages::ProtoExecutionResult.new(:failed => true, :executionTime => 0))
-        message = Messages::Message.new(:messageType => Messages::Message::MessageType::ExecutionStatusResponse, :messageId => message.messageId, :executionStatusResponse => execution_status_response)
+        execution_status_response = Messages::ExecutionStatusResponse.new(executionResult: Messages::ProtoExecutionResult.new(failed: true, executionTime: 0))
+        message = Messages::Message.new(messageType: :ExecutionStatusResponse, messageId: message.messageId, executionStatusResponse: execution_status_response)
         write_message(socket, message)
       else
         response = MessageProcessor.process_message message
@@ -59,7 +59,7 @@ module Gauge
     end
 
     def self.write_message(socket, message)
-      serialized_message = message.to_s
+      serialized_message = Messages::Message.encode(message)
       size = serialized_message.bytesize
       ProtocolBuffers::Varint.encode(socket, size)
       socket.write serialized_message
@@ -67,17 +67,23 @@ module Gauge
 
     def self.port_from_env_variable(env_variable)
       port = ENV[env_variable]
-      if port.nil?
-        raise RuntimeError, "Could not find Env variable :#{env_variable}"
-      end
-      return port
+      raise "Could not find Env variable :#{env_variable}" if port.nil?
+      port
     end
 
     STDOUT.sync = true
     GaugeLog.init
-    Connector.make_connection
     StaticLoader.load_files(DEFAULT_IMPLEMENTATIONS_DIR_PATH)
-    dispatch_messages(Connector.execution_socket)
+    if ENV.key? 'GAUGE_LSP_GRPC'
+      server = GRPC::RpcServer.new
+      p = server.add_http2_port('127.0.0.1:0', :this_port_is_insecure)
+      server.handle(Gauge::LSPServer.new(server))
+      puts "Listening on port:#{p}"
+      server.run_till_terminated
+    else
+      Connector.make_connection
+      dispatch_messages(Connector.execution_socket)
+    end
     exit(0)
   end
 end

data/lib/lsp_pb.rb

@@ -0,0 +1,16 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: lsp.proto
+
+require 'google/protobuf'
+
+require 'messages_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "gauge.messages.Empty" do
+  end
+end
+
+module Gauge
+  module Messages
+    Empty = Google::Protobuf::DescriptorPool.generated_pool.lookup("gauge.messages.Empty").msgclass
+  end
+end

data/lib/lsp_server.rb

@@ -0,0 +1,78 @@
+# 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 'lsp_services_pb'
+require_relative 'processors/step_positions_request_processor'
+require_relative 'processors/cache_file_processor'
+require_relative 'processors/step_names_request_processor'
+require_relative 'processors/stub_implementation_processor'
+require_relative 'processors/implementation_file_list_processor'
+require_relative 'processors/step_validation_request_processor'
+require_relative 'processors/refactor_step_request_processor'
+require_relative 'processors/step_name_request_processor'
+require_relative 'processors/implementation_glob_pattern_processor'
+
+module Gauge
+  class LSPServer < Gauge::Messages::LspService::Service
+    include Gauge::Processors
+
+    def initialize(server)
+      @server = server
+    end
+
+    def get_step_names(_request, _call)
+      step_names_response
+    end
+
+    def cache_file(request, _call)
+      cache_file_response(request)
+    end
+
+    def get_step_positions(request, _call)
+      step_positions(request)
+    end
+
+    def get_implementation_files(_request, _call)
+      implementation_files
+    end
+
+    def implement_stub(request, _call)
+      implement_stub_response(request)
+    end
+
+    def validate_step(request, _call)
+      step_validate_response(request)
+    end
+
+    def refactor(request, _call)
+      refactor_response(request)
+    end
+
+    def get_step_name(request, _call)
+      step_name_response(request)
+    end
+
+    def get_glob_patterns(_request, _call)
+      implementation_glob_pattern_response
+    end
+
+    def kill_process(_request, _call)
+      @server.stop
+      exit(0)
+    end
+  end
+end