grumlin 0.15.6 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 195f614a2cbebbe43f6dd2aedb3aeb54891c4377f50f85f21f44ee3325c87f58
-  data.tar.gz: 0f0a3c0b5aa8f03fb4d613c406b08497685ee9fb4cbea2e8a0b99385f749ebf3
+  metadata.gz: 2d63d3923f895d20e89fd1647495d99bb3a97888689c8f25c34973355d7c80e1
+  data.tar.gz: 878546a65736522f3c1f00f42741b6b207e992a1983321205d05406e0a74ed6b
 SHA512:
-  metadata.gz: 21a7d91e9ce0a9e143f4bba9bb15d4bd31f6337f72500038bf09cd471ab05535d9d3ade4cfba6d6b6d779e09600b6352ed83b3e4bd70aeadd1417e51ba663937
-  data.tar.gz: 9cd14a8f18b856eca87d3b51b48c3f3c0d8d454b76fae92466bd7aee370019bbbb0b398236187acfcfed2322520aa4a3aa68a0e6bfb8b02a073e27f0db3cf525
+  metadata.gz: 60bf726b74019b36bb0437c78b97ea1ba78703058ba2a619805e0081d49158f30bb67cc7918b959cf0375c37a5600632a1df805563edccb0266b71c9ab70f1de
+  data.tar.gz: cc7dc9ecfd45c67b28301593d3ba60e471e7a9993460ce39dcb912bbed5fb0aa01ed25bcf52f49634f704d6732ba563d849fb8d492276f19fe83e5e8531a8181

data/.rubocop.yml

@@ -80,3 +80,10 @@ Style/Documentation:
 
 Style/MultilineBlockChain:
   Enabled: false
+
+
+# TODO:
+# Style/SymbolArray:
+#   EnforcedStyle: brackets
+# Style/WordArray:
+#   EnforcedStyle: brackets

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.16.0] - 2022-03-11
+
+- Query building is rewritten from scratch. No public APIs were changed. [Details](https://github.com/babbel/grumlin/pull/64)
+- Add support for [TextP](https://tinkerpop.apache.org/javadocs/current/core/org/apache/tinkerpop/gremlin/process/traversal/TextP.html)
+
 ## [0.15.4] - 2022-01-20
 
 - Move step and expression definitions to a yaml file for better diffs

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (0.15.6)
+    grumlin (0.17.0)
       async-pool (~> 0.3)
       async-websocket (~> 0.19)
       oj (~> 3.12)
@@ -44,7 +44,7 @@ GEM
     benchmark (0.1.1)
     childprocess (4.0.0)
     concurrent-ruby (1.1.8)
-    console (1.14.0)
+    console (1.15.0)
       fiber-local
     diff-lcs (1.4.4)
     docile (1.4.0)

data/README.md

@@ -150,7 +150,7 @@ shortcuts to make gremlin code more rubyish. Can be used as a drop in replacemen
 or `Grumlin::Shortcuts` can be inherited**, successors don't need to extend them again and have access to shortcuts 
 defined in the ancestor.
 
-**Using**:
+**Definition**
 
 ```ruby
 class MyRepository
@@ -167,15 +167,45 @@ class MyRepository
     hasAll(T.label => :triangle, color: color)
   end
 
-  # g and __ are already aware of shortcuts 
-  def red_triangles
+  # g and __ are already aware of shortcuts
+  query(:triangles_with_color, return_mode: :list) do |color| # :list is the default return mode, also possible: :none, :single, :traversal
     g.V.hasLabel(:triangle)
-       .hasColor("red")
-       .toList
+       .hasColor(color)
   end
+  # Note that when using the `query` one does not need to call a termination step like `next` or `toList`,
+  # repository does it automatically in according to the `return_mode` parameter. 
 end
 ```
 
+Each `return_mode` is mapped to a particular termination step:
+- `:list` - `toList`
+- `:single` - `next`
+- `:none` - `iterate`
+- `:traversal` - do not execute the query and return the traversal as is
+
+**Usage**
+
+To execute the query defined in a query block one simply needs to call a method with the same name:
+
+`MyRepository.new.triangles_with_color(:red)`
+
+One can also override the `return_mode`:
+
+`MyRepository.new.triangles_with_color(:red, query_params: { return_mode: :single })`
+
+or even pass a block to the method and a raw traversal will be yielded:
+```ruby
+MyRepository.new.triangles_with_color(:red) do |t|
+  t.has(:other_property, :some_value).toList
+end
+```
+it may be useful for debugging. Note that one needs to call a termination step manually in this case.
+
+`query` also provides a helper for profiling requests:
+`MyRepository.new.triangles_with_color(:red, query_params: { profile: true })`
+
+method will return profiling data of the results.
+
 #### IRB
 
 An example of how to start an IRB session with support for executing gremlin queries:

data/lib/definitions.yml

@@ -46,6 +46,7 @@ steps:
   - outE
   - outV
   - path
+  - profile
   - project
   - properties
   - property

data/lib/grumlin/action.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Action
+    START_STEPS = Grumlin.definitions.dig(:steps, :start).map(&:to_sym).freeze
+    CONFIGURATION_STEPS = Grumlin.definitions.dig(:steps, :configuration).map(&:to_sym).freeze
+    REGULAR_STEPS = Grumlin.definitions.dig(:steps, :regular).map(&:to_sym).freeze
+
+    ALL_STEPS = START_STEPS + CONFIGURATION_STEPS + REGULAR_STEPS
+
+    attr_reader :name, :args, :params, :shortcuts, :next_step, :configuration_steps, :previous_step
+
+    def initialize(name, args: [], params: {}, previous_step: nil, shortcuts: {}, pool: Grumlin.default_pool)
+      @name = name.to_sym
+      @args = args # TODO: add recursive validation: only json types or Action
+      @params = params # TODO: add recursive validation: only json types
+      @previous_step = previous_step
+      @shortcuts = shortcuts
+      @pool = pool
+    end
+
+    ALL_STEPS.each do |step|
+      define_method step do |*args, **params|
+        step(step, *args, **params)
+      end
+    end
+
+    def step(name, *args, **params)
+      Action.new(name, args: args, params: params, previous_step: self, shortcuts: @shortcuts, pool: @pool)
+    end
+
+    def configuration_step?
+      CONFIGURATION_STEPS.include?(@name)
+    end
+
+    def start_step?
+      START_STEPS.include?(@name)
+    end
+
+    def regular_step?
+      REGULAR_STEPS.include?(@name)
+    end
+
+    def supported_step?
+      ALL_STEPS.include?(@name)
+    end
+
+    def shortcut?
+      @shortcuts.key?(@name)
+    end
+
+    def arguments
+      @arguments ||= [*@args].tap do |args|
+        args << @params if @params.any?
+      end
+    end
+
+    def method_missing(name, *args, **params)
+      return step(name, *args, **params) if @shortcuts.key?(name)
+
+      super
+    end
+
+    def ==(other)
+      self.class == other.class &&
+        @name == other.name &&
+        @args == other.args &&
+        @params == other.params &&
+        @previous_step == other.previous_step &&
+        @shortcuts == other.shortcuts
+    end
+
+    def steps
+      @steps ||= Steps.from(self)
+    end
+
+    def to_s(**params)
+      StepsSerializers::String.new(steps, **params).serialize
+    end
+
+    # TODO: add human readable mode
+    def inspect
+      conf_steps, regular_steps = StepsSerializers::HumanReadableBytecode.new(steps).serialize
+      "#{conf_steps.any? ? conf_steps : nil}#{regular_steps}"
+    end
+
+    def bytecode(no_return: false)
+      StepsSerializers::Bytecode.new(steps, no_return: no_return)
+    end
+
+    def next
+      to_enum.next
+    end
+
+    def hasNext # rubocop:disable Naming/MethodName
+      to_enum.peek
+      true
+    rescue StopIteration
+      false
+    end
+
+    def to_enum
+      @to_enum ||= toList.to_enum
+    end
+
+    def toList
+      @pool.acquire do |client|
+        client.write(bytecode)
+      end
+    end
+
+    def iterate
+      @pool.acquire do |client|
+        client.write(bytecode(no_return: true))
+      end
+    end
+
+    private
+
+    def respond_to_missing?(name, _include_private = false)
+      @shortcuts.key?(name)
+    end
+  end
+end

data/lib/grumlin/client.rb

@@ -97,7 +97,7 @@ module Grumlin
     def write(bytecode)
       raise NotConnectedError unless connected?
 
-      request = to_query(bytecode.to_bytecode)
+      request = to_query(bytecode)
       channel = @request_dispatcher.add_request(request)
       @transport.write(request)
 
@@ -130,7 +130,7 @@ module Grumlin
         op: "bytecode",
         processor: "traversal",
         args: {
-          gremlin: bytecode,
+          gremlin: { :@type => "g:Bytecode", :@value => bytecode.serialize },
           aliases: { g: :g }
         }
       }

data/lib/grumlin/expressions/p.rb

@@ -2,28 +2,23 @@
 
 module Grumlin
   module Expressions
-    module P
-      class << self
-        class Predicate < TypedValue
-          def initialize(name, args:, arg_type: nil)
-            super(type: "P")
-            @name = name
-            @args = args
-            @arg_type = arg_type
-          end
+    class P
+      class Predicate
+        attr_reader :namespace, :name, :value, :type
 
-          def value
-            @value ||= {
-              predicate: @name,
-              value: TypedValue.new(type: @arg_type, value: @args).to_bytecode
-            }
-          end
+        def initialize(namespace, name, value:, type: nil)
+          @namespace = namespace
+          @name = name
+          @value = value
+          @type = type
         end
+      end
 
+      class << self
         # TODO: support more predicates
         %i[eq neq].each do |predicate|
           define_method predicate do |*args|
-            Predicate.new(predicate, args: args[0])
+            Predicate.new("P", predicate, value: args[0])
           end
         end
 
@@ -36,7 +31,7 @@ module Grumlin
                    else
                      args.to_a
                    end
-            Predicate.new(predicate, args: args, arg_type: "List")
+            Predicate.new("P", predicate, value: args, type: "List")
           end
         end
       end

data/lib/grumlin/expressions/text_p.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module Expressions
+    class TextP < P
+      class << self
+        %i[containing endingWith notContaining notEndingWith notStartingWith startingWith].each do |predicate|
+          define_method predicate do |*args|
+            P::Predicate.new("TextP", predicate, value: args[0])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grumlin/expressions/with_options.rb

@@ -2,16 +2,30 @@
 
 module Grumlin
   module Expressions
-    module WithOptions
+    class WithOptions
       WITH_OPTIONS = Grumlin.definitions.dig(:expressions, :with_options).freeze
 
       class << self
         WITH_OPTIONS.each do |k, v|
           define_method k do
-            v
+            name = "@#{k}"
+            return instance_variable_get(name) if instance_variable_defined?(name)
+
+            instance_variable_set(name, WithOptions.new(k, v))
           end
         end
       end
+
+      attr_reader :name, :value
+
+      def initialize(name, value)
+        @name = name
+        @value = value
+      end
+
+      def to_s
+        "WithOptions.#{@name}"
+      end
     end
   end
 end

data/lib/grumlin/repository.rb

@@ -2,13 +2,20 @@
 
 module Grumlin
   module Repository
+    RETURN_MODES = {
+      list: :toList,
+      none: :iterate,
+      single: :next,
+      traversal: :nil
+    }.freeze
+
     module InstanceMethods
       def __
-        with_shortcuts(Grumlin::Expressions::U)
+        TraversalStart.new(self.class.shortcuts)
       end
 
       def g
-        with_shortcuts(Grumlin::Traversal.new)
+        TraversalStart.new(self.class.shortcuts)
       end
     end
 
@@ -19,5 +26,53 @@ module Grumlin
 
       base.shortcuts_from(Grumlin::Shortcuts::Properties)
     end
+
+    def query(name, return_mode: :list, postprocess_with: nil, &query_block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      return_mode = validate_return_mode!(return_mode)
+      postprocess_with = validate_postprocess_with!(postprocess_with)
+
+      define_method name do |*args, query_params: {}, **params, &block|
+        t = instance_exec(*args, **params, &query_block)
+        return t if self.class.empty_result?(t)
+
+        unless t.is_a?(Grumlin::Action)
+          raise WrongQueryResult,
+                "queries must return #{Grumlin::Action}, nil or an empty collection. Given: #{t.class}"
+        end
+
+        return block.call(t) unless block.nil?
+
+        return t.profile.next if query_params[:profile] == true
+
+        return_mode = self.class.validate_return_mode!(query_params[:return_mode] || return_mode)
+
+        return t if return_mode == :traversal
+
+        t.public_send(RETURN_MODES[return_mode]).tap do |result|
+          return postprocess_with.call(result) if postprocess_with.respond_to?(:call)
+          return send(postprocess_with, result) unless postprocess_with.nil?
+        end
+      end
+    end
+
+    def validate_return_mode!(return_mode)
+      return return_mode if RETURN_MODES.key?(return_mode)
+
+      raise ArgumentError, "unsupported return mode #{return_mode}. Supported modes: #{RETURN_MODES.keys}"
+    end
+
+    def validate_postprocess_with!(postprocess_with)
+      if postprocess_with.nil? || postprocess_with.is_a?(Symbol) ||
+         postprocess_with.is_a?(String) || postprocess_with.respond_to?(:call)
+        return postprocess_with
+      end
+
+      raise ArgumentError,
+            "postprocess_with must be a String, Symbol or a callable object, given: #{postprocess_with.class}"
+    end
+
+    def empty_result?(result)
+      result.nil? || (result.respond_to?(:empty?) && result.empty?)
+    end
   end
 end

data/lib/grumlin/shortcuts/properties.rb

@@ -5,13 +5,17 @@ module Grumlin
     module Properties
       extend Grumlin::Shortcuts
 
-      shortcut :props do |*_args, **props|
+      shortcut :props do |props|
+        next if props.nil? # TODO: fixme, add proper support for **params
+
         props.reduce(self) do |tt, (prop, value)|
           tt.property(prop, value)
         end
       end
 
-      shortcut :hasAll do |*, **props|
+      shortcut :hasAll do |props|
+        next if props.nil? # TODO: fixme, add proper support for **params
+
         props.reduce(self) do |tt, (prop, value)|
           tt.has(prop, value)
         end

data/lib/grumlin/shortcuts.rb

@@ -2,14 +2,7 @@
 
 module Grumlin
   module Shortcuts
-    module InstanceMethods
-      def with_shortcuts(obj)
-        ShortcutProxy.new(obj, self.class.shortcuts, parent: self)
-      end
-    end
-
     def self.extended(base)
-      base.include(InstanceMethods)
       base.include(Grumlin::Expressions)
     end
 
@@ -21,7 +14,7 @@ module Grumlin
     def shortcut(name, shortcut = nil, &block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       name = name.to_sym
       # TODO: blocklist of names to avoid conflicts with standard methods?
-      if Grumlin::AnonymousStep::SUPPORTED_STEPS.include?(name)
+      if Grumlin::Action::REGULAR_STEPS.include?(name)
         raise ArgumentError,
               "cannot use names of standard gremlin steps"
       end

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/typing.rb

@@ -16,6 +16,8 @@ module Grumlin
       "g:Double" => ->(value) { cast_double(value) },
       "g:Direction" => ->(value) { value },
       # "g:VertexProperty"=> ->(value) { value }, # TODO: implement me
+      "g:TraversalMetrics" => ->(value) { cast_map(value[:@value]) },
+      "g:Metrics" => ->(value) { cast_map(value[:@value]) },
       "g:T" => ->(value) { value.to_sym }
     }.freeze
 
@@ -67,7 +69,7 @@ module Grumlin
       def cast_map(value)
         Hash[*value].transform_keys do |key|
           next key.to_sym if key.respond_to?(:to_sym)
-          next cast(key) if key[:@type]
+          next cast(key) if key[:@type] # TODO: g.V.group.by(:none_existing_property).next
 
           raise UnknownMapKey, key, value
         end.transform_values { |v| cast(v) }

data/lib/grumlin/version.rb

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

data/lib/grumlin.rb

@@ -100,6 +100,10 @@ module Grumlin
     end
   end
 
+  class RepositoryError < Error; end
+
+  class WrongQueryResult < RepositoryError; end
+
   class Config
     attr_accessor :url, :pool_size, :client_concurrency, :client_factory
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.15.6
+  version: 0.17.0
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-09 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -98,8 +98,7 @@ files:
 - 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
@@ -109,23 +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.rb
-- lib/grumlin/shortcut_proxy.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,45 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  class AnonymousStep
-    attr_reader :name, :previous_step, :configuration_steps
-
-    SUPPORTED_STEPS = Grumlin.definitions.dig(:steps, :regular).map(&:to_sym).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,16 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  module Expressions
-    # The module is called U because Underscore and implements __
-    module U
-      class << self
-        Grumlin::AnonymousStep::SUPPORTED_STEPS.each do |step|
-          define_method step do |*args, **params|
-            AnonymousStep.new(step, *args, **params)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/grumlin/shortcut_proxy.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  class ShortcutProxy
-    extend Forwardable
-
-    attr_reader :object, :shortcuts
-
-    # shortcuts: {"name": ->(arg) {}}
-    def initialize(object, shortcuts, parent: nil)
-      @object = object
-      @shortcuts = shortcuts
-      @parent = parent
-    end
-
-    def method_missing(name, *args, **params)
-      return @parent.public_send(name, *args, **params) if %i[__ g].include?(name) && !@parent.nil?
-
-      return wrap_result(@object.public_send(name, *args, **params)) if @object.respond_to?(name)
-
-      return wrap_result(@shortcuts[name].apply(self, *args, **params)) if @shortcuts.key?(name)
-
-      super
-    end
-
-    # For some reason the interpreter thinks it's private
-    public def respond_to_missing?(name, include_private = false) # rubocop:disable Style/AccessModifierDeclarations
-      name = name.to_sym
-
-      (%i[__ g].include?(name) &&
-      @parent.respond_to?(name)) ||
-      @object.respond_to?(name) ||
-      @shortcuts.key?(name) ||
-      super
-    end
-
-    def_delegator :@object, :to_s
-
-    def inspect
-      @object.inspect
-    end
-
-    private
-
-    def wrap_result(result)
-      if result.is_a?(AnonymousStep) || result.is_a?(Traversal)
-        return self.class.new(result, @shortcuts, parent: @parent)
-      end
-
-      result
-    end
-  end
-end

data/lib/grumlin/step.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  class Step < AnonymousStep
-    attr_reader :client
-
-    def initialize(pool, name, *args, configuration_steps: [], previous_step: nil, **params)
-      super(name, *args, previous_step: previous_step, configuration_steps: configuration_steps, **params)
-      @pool = pool
-    end
-
-    def next
-      to_enum.next
-    end
-
-    def hasNext # rubocop:disable Naming/MethodName
-      to_enum.peek
-      true
-    rescue StopIteration
-      false
-    end
-
-    def to_enum
-      @to_enum ||= toList.to_enum
-    end
-
-    def toList
-      @pool.acquire do |client|
-        client.write(bytecode)
-      end
-    end
-
-    def iterate
-      @pool.acquire do |client|
-        client.write(bytecode(no_return: true))
-      end
-    end
-
-    def step(step_name, *args, **params)
-      self.class.new(@pool, step_name, *args, previous_step: self, configuration_steps: @configuration_steps, **params)
-    end
-  end
-end

data/lib/grumlin/traversal.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Grumlin
-  class Traversal
-    SUPPORTED_STEPS = Grumlin.definitions.dig(:steps, :start).map(&:to_sym).freeze
-
-    CONFIGURATION_STEPS = Grumlin.definitions.dig(:steps, :configuration).map(&:to_sym).freeze
-
-    attr_reader :configuration_steps
-
-    def initialize(pool = Grumlin.default_pool, configuration_steps: [])
-      @pool = pool
-      @configuration_steps = configuration_steps
-    end
-
-    def inspect
-      "#<#{self.class}>"
-    end
-
-    def to_s
-      inspect
-    end
-
-    CONFIGURATION_STEPS.each do |step|
-      define_method step do |*args, **params|
-        self.class.new(@pool, configuration_steps: @configuration_steps + [AnonymousStep.new(step, *args, **params)])
-      end
-    end
-
-    SUPPORTED_STEPS.each do |step|
-      define_method step do |*args, **params|
-        Step.new(@pool, step, *args, configuration_steps: @configuration_steps, **params)
-      end
-    end
-  end
-end