grumlin 0.15.3 → 0.16.0

data/lib/grumlin/shortcuts_applyer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class ShortcutsApplyer
+    class << self
+      def call(steps)
+        new.call(steps)
+      end
+    end
+
+    def call(steps)
+      return steps unless steps.uses_shortcuts?
+
+      shortcuts = steps.shortcuts
+
+      configuration_steps = process_steps(steps.configuration_steps, shortcuts)
+      regular_steps = process_steps(steps.steps, shortcuts)
+
+      Steps.new(shortcuts).tap do |processed_steps|
+        (configuration_steps + regular_steps).each do |step|
+          processed_steps.add(step.name, step.arguments)
+        end
+      end
+    end
+
+    private
+
+    def process_steps(steps, shortcuts) # rubocop:disable Metrics/AbcSize
+      steps.each_with_object([]) do |step, result|
+        arguments = step.arguments.map do |arg|
+          arg.is_a?(Steps) ? ShortcutsApplyer.call(arg) : arg
+        end
+
+        if shortcuts.include?(step.name)
+          t = TraversalStart.new(shortcuts)
+          action = shortcuts[step.name].apply(t, *arguments)
+          next if action.nil? || action == t # Shortcut did not add any steps
+
+          new_steps = ShortcutsApplyer.call(Steps.from(action))
+          result.concat(new_steps.configuration_steps)
+          result.concat(new_steps.steps)
+        else
+          result << StepData.new(step.name, arguments)
+        end
+      end
+    end
+  end
+end

data/lib/grumlin/step_data.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class StepData
+    attr_reader :name, :arguments
+
+    def initialize(name, arguments)
+      @name = name
+      @arguments = arguments
+    end
+
+    def ==(other)
+      self.class == other.class &&
+        @name == other.name &&
+        @arguments == other.arguments
+    end
+  end
+end

data/lib/grumlin/steps.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Steps
+    CONFIGURATION_STEPS = Action::CONFIGURATION_STEPS
+    ALL_STEPS = Action::ALL_STEPS
+
+    def self.from(action)
+      raise ArgumentError, "expected: #{Action}, given: #{action.class}" unless action.is_a?(Action)
+
+      shortcuts = action.shortcuts
+      actions = []
+
+      until action.nil?
+        actions.unshift(action)
+        action = action.previous_step
+      end
+
+      new(shortcuts).tap do |chain|
+        actions.each do |act|
+          chain.add(act.name, act.arguments)
+        end
+      end
+    end
+
+    attr_reader :configuration_steps, :steps, :shortcuts
+
+    def initialize(shortcuts, configuration_steps: [], steps: [])
+      @shortcuts = shortcuts
+      @configuration_steps = configuration_steps
+      @steps = steps
+    end
+
+    def add(name, arguments)
+      return add_configuration_step(name, arguments) if CONFIGURATION_STEPS.include?(name)
+
+      StepData.new(name, cast_arguments(arguments)).tap do |step|
+        @steps << step
+      end
+    end
+
+    def uses_shortcuts?
+      shortcuts?(@configuration_steps) || shortcuts?(@steps)
+    end
+
+    def ==(other)
+      self.class == other.class &&
+        @shortcuts == other.shortcuts &&
+        @configuration_steps == other.configuration_steps &&
+        @steps == other.steps
+    end
+
+    # TODO: add #bytecode, to_s, inspect
+
+    private
+
+    def shortcuts?(steps_ary)
+      steps_ary.any? do |step|
+        @shortcuts.include?(step.name) || step.arguments.any? do |arg|
+          arg.is_a?(Steps) ? arg.uses_shortcuts? : false
+        end
+      end
+    end
+
+    def add_configuration_step(name, arguments)
+      raise ArgumentError, "cannot use configuration steps after start step was used" unless @steps.empty?
+
+      StepData.new(name, cast_arguments(arguments)).tap do |step|
+        @configuration_steps << step
+      end
+    end
+
+    def cast_arguments(arguments)
+      arguments.map { |arg| arg.is_a?(Action) ? Steps.from(arg) : arg }
+    end
+  end
+end

data/lib/grumlin/steps_serializers/bytecode.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module StepsSerializers
+    class Bytecode < Serializer
+      # constructor params: no_return: true|false, default false
+      # TODO: add pretty
+
+      NONE_STEP = StepData.new("none", [])
+
+      def serialize
+        steps = ShortcutsApplyer.call(@steps)
+        no_return = @params[:no_return] || false
+
+        {
+          step: (steps.steps + (no_return ? [NONE_STEP] : [])).map { |s| serialize_step(s) }
+        }.tap do |v|
+          v.merge!(source: steps.configuration_steps.map { |s| serialize_step(s) }) if steps.configuration_steps.any?
+        end
+      end
+
+      private
+
+      def serialize_step(step)
+        [step.name, *step.arguments.map { |arg| serialize_arg(arg) }]
+      end
+
+      def serialize_arg(arg)
+        return serialize_typed_value(arg) if arg.is_a?(TypedValue)
+        return serialize_predicate(arg) if arg.is_a?(Expressions::P::Predicate)
+        return arg.value if arg.is_a?(Expressions::WithOptions)
+
+        return arg unless arg.is_a?(Steps)
+
+        { :@type => "g:Bytecode", :@value => Bytecode.new(arg, **@params.merge(no_return: false)).serialize }
+      end
+
+      def serialize_typed_value(value)
+        return value.value if value.type.nil?
+
+        {
+          "@type": "g:#{value.type}",
+          "@value": value.value
+        }
+      end
+
+      def serialize_predicate(value)
+        {
+          "@type": "g:#{value.namespace}",
+          "@value": {
+            predicate: value.name,
+            value: if value.type.nil?
+                     value.value
+                   else
+                     {
+                       "@type": "g:#{value.type}",
+                       "@value": value.value
+                     }
+                   end
+          }
+        }
+      end
+    end
+  end
+end

data/lib/grumlin/steps_serializers/human_readable_bytecode.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module StepsSerializers
+    class HumanReadableBytecode < Serializer
+      def serialize
+        steps = ShortcutsApplyer.call(@steps)
+        [serialize_steps(steps.configuration_steps), serialize_steps(steps.steps)]
+      end
+
+      def serialize_steps(steps)
+        steps.map { |s| serialize_step(s) }
+      end
+
+      private
+
+      def serialize_step(step)
+        [step.name, *step.arguments.map { |arg| serialize_arg(arg) }]
+      end
+
+      def serialize_arg(arg)
+        return arg.to_s if arg.is_a?(TypedValue)
+        return serialize_predicate(arg) if arg.is_a?(Expressions::P::Predicate)
+        return arg.value if arg.is_a?(Expressions::WithOptions)
+
+        return arg unless arg.is_a?(Steps)
+
+        HumanReadableBytecode.new(arg, **@params.merge(no_return: false)).serialize[1]
+      end
+
+      def serialize_predicate(arg)
+        "#{arg.name}(#{arg.value})"
+      end
+    end
+  end
+end

data/lib/grumlin/steps_serializers/serializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module StepsSerializers
+    class Serializer
+      def initialize(steps, **params)
+        @steps = steps
+        @params = params
+      end
+
+      def serialize
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/grumlin/steps_serializers/string.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module StepsSerializers
+    class String < Serializer
+      # constructor params: apply_shortcuts: true|false, default: false
+      # constructor params: anonymous: true|false, default: false
+      # TODO: add pretty
+
+      def serialize
+        steps = @params[:apply_shortcuts] ? ShortcutsApplyer.call(@steps) : @steps
+
+        configuration_steps = serialize_steps(steps.configuration_steps)
+        regular_steps = serialize_steps(steps.steps)
+
+        "#{prefix}.#{(configuration_steps + regular_steps).join(".")}"
+      end
+
+      private
+
+      def prefix
+        @prefix ||= @params[:anonymous] ? "__" : "g"
+      end
+
+      def serialize_arg(arg)
+        return "\"#{arg}\"" if arg.is_a?(::String) || arg.is_a?(Symbol)
+        return "#{arg.type}.#{arg.value}" if arg.is_a?(Grumlin::TypedValue)
+        return arg.to_s if arg.is_a?(Grumlin::Expressions::WithOptions)
+
+        return arg unless arg.is_a?(Steps)
+
+        StepsSerializers::String.new(arg, anonymous: true, **@params).serialize
+      end
+
+      def serialize_steps(steps)
+        steps.map do |step|
+          "#{step.name}(#{step.arguments.map { |a| serialize_arg(a) }.join(", ")})"
+        end
+      end
+    end
+  end
+end

data/lib/grumlin/sugar.rb

@@ -6,12 +6,12 @@ module Grumlin
       base.include(Grumlin::Expressions)
     end
 
-    def __
-      Grumlin::Expressions::U
+    def __(shortcuts = {})
+      Grumlin::TraversalStart.new(shortcuts) # TODO: allow only regular and start steps
     end
 
-    def g
-      Grumlin::Traversal.new
+    def g(shortcuts = {})
+      Grumlin::TraversalStart.new(shortcuts)
     end
   end
 end

data/lib/grumlin/traversal_start.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class TraversalStart
+    START_STEPS = Grumlin.definitions.dig(:steps, :start).map(&:to_sym).freeze
+    REGULAR_STEPS = Grumlin.definitions.dig(:steps, :regular).map(&:to_sym).freeze
+    CONFIGURATION_STEPS = Grumlin.definitions.dig(:steps, :configuration).map(&:to_sym).freeze
+
+    ALL_STEPS = START_STEPS + CONFIGURATION_STEPS + REGULAR_STEPS
+
+    ALL_STEPS.each do |step|
+      define_method step do |*args, **params|
+        step(step, *args, **params)
+      end
+    end
+
+    attr_reader :shortcuts
+
+    def initialize(shortcuts)
+      @shortcuts = shortcuts
+    end
+
+    def step(name, *args, **params)
+      Action.new(name, args: args, params: params, shortcuts: @shortcuts)
+    end
+
+    def method_missing(name, *args, **params)
+      return step(name, *args, **params) if @shortcuts.key?(name)
+
+      super
+    end
+
+    def __
+      TraversalStart.new(@shortcuts) # TODO: allow only regular and start steps
+    end
+
+    def to_s(*)
+      self.class.to_s
+    end
+
+    def inspect
+      self.class.inspect
+    end
+
+    private
+
+    def respond_to_missing?(name, _include_private = false)
+      @shortcuts.key?(name)
+    end
+  end
+end

data/lib/grumlin/typed_value.rb

@@ -9,17 +9,6 @@ module Grumlin
       @value = value
     end
 
-    def to_bytecode
-      @to_bytecode ||= if type.nil?
-                         value
-                       else
-                         {
-                           "@type": "g:#{type}",
-                           "@value": value
-                         }
-                       end
-    end
-
     def inspect
       "<#{type}.#{value}>"
     end
@@ -27,9 +16,5 @@ module Grumlin
     def to_s
       inspect
     end
-
-    def to_readable_bytecode
-      inspect
-    end
   end
 end

data/lib/grumlin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Grumlin
-  VERSION = "0.15.3"
+  VERSION = "0.16.0"
 end

data/lib/grumlin.rb

@@ -2,7 +2,9 @@
 
 require "securerandom"
 require "oj"
+require "yaml"
 
+# TODO: use Oj directly
 Oj.mimic_JSON
 Oj.add_to_json
 
@@ -108,10 +110,6 @@ module Grumlin
     end
   end
 
-  def self.supported_steps
-    @supported_steps ||= (Grumlin::AnonymousStep::SUPPORTED_STEPS + Grumlin::Expressions::U::SUPPORTED_STEPS).sort.uniq
-  end
-
   @pool_mutex = Mutex.new
 
   class << self
@@ -145,6 +143,10 @@ module Grumlin
         Thread.current.thread_variable_set(:grumlin_default_pool, nil)
       end
     end
+
+    def definitions
+      @definitions ||= YAML.safe_load(File.read(File.join(__dir__, "definitions.yml")), symbolize_names: true)
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.16.0
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -96,9 +96,9 @@ files:
 - gremlin_server/tinkergraph-empty.properties
 - grumlin.gemspec
 - lib/async/channel.rb
+- lib/definitions.yml
 - lib/grumlin.rb
-- lib/grumlin/anonymous_step.rb
-- lib/grumlin/bytecode.rb
+- lib/grumlin/action.rb
 - lib/grumlin/client.rb
 - lib/grumlin/edge.rb
 - lib/grumlin/expressions/expression.rb
@@ -108,22 +108,28 @@ files:
 - lib/grumlin/expressions/pop.rb
 - lib/grumlin/expressions/scope.rb
 - lib/grumlin/expressions/t.rb
-- lib/grumlin/expressions/u.rb
+- lib/grumlin/expressions/text_p.rb
 - lib/grumlin/expressions/with_options.rb
 - lib/grumlin/path.rb
 - lib/grumlin/property.rb
 - lib/grumlin/repository.rb
 - lib/grumlin/request_dispatcher.rb
-- lib/grumlin/shortcut_proxy.rb
+- lib/grumlin/shortcut.rb
 - lib/grumlin/shortcuts.rb
 - lib/grumlin/shortcuts/properties.rb
-- lib/grumlin/step.rb
+- lib/grumlin/shortcuts_applyer.rb
+- lib/grumlin/step_data.rb
+- lib/grumlin/steps.rb
+- lib/grumlin/steps_serializers/bytecode.rb
+- lib/grumlin/steps_serializers/human_readable_bytecode.rb
+- lib/grumlin/steps_serializers/serializer.rb
+- lib/grumlin/steps_serializers/string.rb
 - lib/grumlin/sugar.rb
 - lib/grumlin/test/rspec.rb
 - lib/grumlin/test/rspec/db_cleaner_context.rb
 - lib/grumlin/test/rspec/gremlin_context.rb
 - lib/grumlin/transport.rb
-- lib/grumlin/traversal.rb
+- lib/grumlin/traversal_start.rb
 - lib/grumlin/traverser.rb
 - lib/grumlin/typed_value.rb
 - lib/grumlin/typing.rb

data/lib/grumlin/anonymous_step.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  class AnonymousStep
-    attr_reader :name, :previous_step, :configuration_steps
-
-    # TODO: add other steps
-    SUPPORTED_STEPS = %i[E V addE addV aggregate and as both bothE by choose coalesce count dedup drop elementMap emit
-                         fold from group groupCount has hasId hasLabel hasNot id identity in inE inV is label limit
-                         map not or order out outE path project properties property range repeat sack select sideEffect
-                         skip sum tail to unfold union until valueMap values where with].freeze
-
-    def initialize(name, *args, configuration_steps: [], previous_step: nil, **params)
-      @name = name
-      @previous_step = previous_step
-      @args = args
-      @params = params
-      @configuration_steps = configuration_steps
-    end
-
-    SUPPORTED_STEPS.each do |step|
-      define_method(step) do |*args, **params|
-        step(step, *args, **params)
-      end
-    end
-
-    def step(name, *args, **params)
-      self.class.new(name, *args, previous_step: self, configuration_steps: configuration_steps, **params)
-    end
-
-    def inspect
-      bytecode.inspect
-    end
-
-    def to_s
-      inspect
-    end
-
-    def bytecode(no_return: false)
-      @bytecode ||= Bytecode.new(self, no_return: no_return)
-    end
-
-    def args
-      [*@args].tap do |args|
-        args << @params if @params.any?
-      end
-    end
-  end
-end

data/lib/grumlin/bytecode.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  # Incapsulates logic of converting step chains and step arguments to queries that can be sent to the server
-  # and to human readable strings.
-  class Bytecode < TypedValue
-    class NoneStep
-      def to_bytecode
-        ["none"]
-      end
-    end
-
-    NONE_STEP = NoneStep.new
-
-    def initialize(step, no_return: false)
-      super(type: "Bytecode")
-      @step = step
-      @no_return = no_return
-    end
-
-    def inspect
-      configuration_steps = @step.configuration_steps.map do |s|
-        serialize_arg(s, serialization_method: :to_readable_bytecode)
-      end
-      "#{configuration_steps.any? ? configuration_steps : nil}#{to_readable_bytecode}"
-    end
-
-    def to_s
-      inspect
-    end
-
-    def to_readable_bytecode
-      @to_readable_bytecode ||= steps.map { |s| serialize_arg(s, serialization_method: :to_readable_bytecode) }
-    end
-
-    def value
-      @value ||= { step: (steps + (@no_return ? [NONE_STEP] : [])).map { |s| serialize_arg(s) } }.tap do |v|
-        v.merge!(source: @step.configuration_steps.map { |s| serialize_arg(s) }) if @step.configuration_steps.any?
-      end
-    end
-
-    private
-
-    # Serializes step or a step argument to either an executable query or a human readable string representation
-    # depending on the `serialization_method` parameter. It should be either `:to_readable_bytecode` for human readable
-    # representation or `:to_bytecode` for query.
-    def serialize_arg(arg, serialization_method: :to_bytecode)
-      return arg.public_send(serialization_method) if arg.respond_to?(serialization_method)
-      return arg unless arg.is_a?(AnonymousStep)
-
-      arg.args.each.with_object([arg.name.to_s]) do |a, res|
-        res << if a.respond_to?(:bytecode)
-                 a.bytecode.public_send(serialization_method)
-               else
-                 serialize_arg(a, serialization_method: serialization_method)
-               end
-      end
-    end
-
-    def steps
-      @steps ||= [].tap do |result|
-        step = @step
-        until step.nil?
-          result.unshift(step)
-          step = step.previous_step
-        end
-      end
-    end
-  end
-end

data/lib/grumlin/expressions/u.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  module Expressions
-    module U
-      # TODO: add other start steps
-      SUPPORTED_STEPS = %i[V addV coalesce constant count drop fold has hasLabel hasNot id identity in inE inV is label
-                           out outE outV project repeat select timeLimit unfold valueMap values].freeze
-
-      class << self
-        SUPPORTED_STEPS.each do |step|
-          define_method step do |*args, **params|
-            AnonymousStep.new(step, *args, **params)
-          end
-        end
-      end
-    end
-  end
-end