grumlin 0.13.0 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45c3b3317c8b96d763dd2de25de3744646994370dce29f2bc70f1b8c2725b119
-  data.tar.gz: a8dce9eb4e0c9dc55383ed62d35a18e3a67fd63baf5d6f36cdf45196d36e49ef
+  metadata.gz: 2d54992de5df5f10f004557bc7a7d86ec5558c104663bf36904838e843d38b4d
+  data.tar.gz: e2e5cca5ad4cc034b991760db13c9a41d780609895ea38e236ef384bfa9df8f4
 SHA512:
-  metadata.gz: cae50acbded8f08e2d48ecda7f002c4ec1312ae1b5aac09b803580061d06e0befe4c8480213f1702421c1580105fc599e61b0b67d929635e82d24f9a9f402fcc
-  data.tar.gz: 8feb97c5edd5e9327fdfbf8bb6539028c09981a330917717e0eeeb3b40a74d1c00eb214cc2ce0b9669d341f4b32d8971a3f715130e77c1395bf2f27301aa04bc
+  metadata.gz: 9a1f23141609f072193fa4a624ae63263200daebb72b4f2c0759e738325409546365f962117d36dbb8baf1c6df5ebd9a60f5c53453f7827cfd8cc90d450afa0e
+  data.tar.gz: c6bd3b5f1f0b02173931f8189c0dca7fdcb5c11bfc6c4f8fdb34065a8d90a55ecb4118cf50f080c3c490ed1e2afda9035716fafc4679c6f606ad74ccc955d5f3

data/.github/workflows/main.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6, 2.7, 3.0]
+        ruby: [2.7, 3.0]
     steps:
       - uses: actions/checkout@v2
 

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   NewCops: enable
   SuggestExtensions: false
 

data/.tool-versions

@@ -1 +1 @@
-ruby 2.6.6
+ruby 2.7.5

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [0.14.2] - 2021-12-12
+
+- Better exceptions
+- Add `choose` step
+- Add `__.hasNot`, `__.is`, `__.select`
+
+## [0.14.0] - 2021-12-07
+
+- Add initial support for [configuration steps](https://tinkerpop.apache.org/docs/current/reference/#configuration-steps)
+- Add the `withSideEffect` configuration step
+- Fix passing keyword arguments to regular steps
+- *Drop support for ruby 2.6*
+
 ## [0.13.0] - 2021-12-03
 
 - Add `Shortcuts` and `Repository`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (0.13.0)
+    grumlin (0.14.2)
       async-pool (~> 0.3)
       async-websocket (~> 0.19)
       oj (~> 3.12)
@@ -60,16 +60,20 @@ GEM
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
+    mini_portile2 (2.5.3)
     minitest (5.14.4)
     nio4r (2.5.8)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     nokogiri (1.11.7-x86_64-linux)
       racc (~> 1.4)
     oj (3.13.9)
     overcommit (0.57.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.21.0)
+    parser (3.0.3.2)
       ast (~> 2.4.1)
     protocol-hpack (1.4.2)
     protocol-http (0.22.5)
@@ -84,7 +88,7 @@ GEM
     racc (1.5.2)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     reverse_markdown (2.0.0)
       nokogiri
     rexml (3.2.5)
@@ -105,23 +109,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.16.1)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
+    rubocop-ast (1.14.0)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.11.3)
+    rubocop-performance (1.12.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.3.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -149,11 +152,12 @@ GEM
     timers (4.3.3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     yard (0.9.26)
     zeitwerk (2.4.2)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -241,7 +241,8 @@ config.include_context(Grumlin::Test::RSpec::DBCleanerContext) # Cleans the data
 ...
 ```
 
-It is highly recommended to use `Grumlin::Sugar` and not trying to use lower level APIs as they are subject to change. 
+It is highly recommended to use `Grumlin::Sugar` or `Grumlin::Repository` and not trying to use lower level APIs
+as they are subject to change.
 
 ## Development
 

data/grumlin.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.homepage      = "https://github.com/zhulik/grumlin"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/zhulik/grumlin"
@@ -31,4 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "async-websocket", "~> 0.19"
   spec.add_dependency "oj", "~> 3.12"
   spec.add_dependency "zeitwerk", "~> 2.4"
+  spec.metadata = {
+    "rubygems_mfa_required" => "true"
+  }
 end

data/lib/grumlin/anonymous_step.rb

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

data/lib/grumlin/bytecode.rb

@@ -20,22 +20,30 @@ module Grumlin
     end
 
     def inspect
-      to_readable_bytecode.to_s
+      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
-    alias to_s inspect
 
     def to_readable_bytecode
       @to_readable_bytecode ||= steps.map { |s| serialize_arg(s, serialization_method: :to_readable_bytecode) }
     end
 
     def value
-      { step: (steps + (@no_return ? [NONE_STEP] : [])).map { |s| serialize_arg(s) } }
+      @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. I should be either `:to_readable_bytecode` for human readable
+    # 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)

data/lib/grumlin/client.rb

@@ -51,7 +51,7 @@ module Grumlin
     end
 
     def connect
-      raise "ClientClosed" if @closed
+      raise ClientClosedError if @closed
 
       @transport = build_transport
       response_channel = @transport.connect
@@ -113,10 +113,13 @@ module Grumlin
       "<#{self.class} url=#{@url} connected=#{connected?}>"
     end
 
-    alias to_s inspect
+    def to_s
+      inspect
+    end
 
     private
 
+    # This might be overridden in successors
     def build_transport
       Transport.new(@url, parent: @parent, **@client_options)
     end

data/lib/grumlin/edge.rb

@@ -20,6 +20,9 @@ module Grumlin
     def inspect
       "e[#{@id}][#{@outV}-#{@label}->#{@inV}]"
     end
-    alias to_s inspect
+
+    def to_s
+      inspect
+    end
   end
 end

data/lib/grumlin/expressions/u.rb

@@ -4,13 +4,13 @@ module Grumlin
   module Expressions
     module U
       # TODO: add other start steps
-      SUPPORTED_STEPS = %i[V addV count drop fold has hasLabel id in inE inV label out outE outV project repeat
-                           timeLimit unfold valueMap values].freeze
+      SUPPORTED_STEPS = %i[V addV count drop fold has hasLabel hasNot id 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|
-            AnonymousStep.new(step, *args)
+          define_method step do |*args, **params|
+            AnonymousStep.new(step, *args, **params)
           end
         end
       end

data/lib/grumlin/path.rb

@@ -12,6 +12,9 @@ module Grumlin
     def inspect
       "p[#{@objects}]"
     end
-    alias to_s inspect
+
+    def to_s
+      inspect
+    end
   end
 end

data/lib/grumlin/request_dispatcher.rb

@@ -22,14 +22,18 @@ module Grumlin
       498 => ClientSideError
     }.freeze
 
-    include Console
+    class DispatcherError < Grumlin::Error; end
+
+    class RequestAlreadyAddedError < DispatcherError; end
+
+    class UnknownRequestError < DispatcherError; end
 
     def initialize
       @requests = {}
     end
 
     def add_request(request)
-      raise "ERROR" if @requests.key?(request[:requestId])
+      raise RequestAlreadyAddedError if @requests.key?(request[:requestId])
 
       Async::Channel.new.tap do |channel|
         @requests[request[:requestId]] = { request: request, result: [], channel: channel }
@@ -40,7 +44,7 @@ module Grumlin
     # TODO: sometimes response does not include requestID, no idea how to handle it so far.
     def add_response(response) # rubocop:disable Metrics/AbcSize
       request_id = response[:requestId]
-      raise "ERROR" unless ongoing_request?(request_id)
+      raise UnknownRequestError unless ongoing_request?(request_id)
 
       request = @requests[request_id]
 
@@ -61,7 +65,7 @@ module Grumlin
     end
 
     def close_request(request_id)
-      raise "ERROR" unless ongoing_request?(request_id)
+      raise UnknownRequestError unless ongoing_request?(request_id)
 
       request = @requests.delete(request_id)
       request[:channel].close

data/lib/grumlin/shortcut_proxy.rb

@@ -13,12 +13,12 @@ module Grumlin
       @parent = parent
     end
 
-    def method_missing(name, *args)
-      return @parent.public_send(name, *args) if %i[__ g].include?(name) && !@parent.nil?
+    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)) if @object.respond_to?(name)
+      return wrap_result(@object.public_send(name, *args, **params)) if @object.respond_to?(name)
 
-      return wrap_result(instance_exec(*args, &@shortcuts[name])) if @shortcuts.key?(name)
+      return wrap_result(instance_exec(*args, **params, &@shortcuts[name])) if @shortcuts.key?(name)
 
       super
     end
@@ -43,7 +43,9 @@ module Grumlin
     private
 
     def wrap_result(result)
-      return self.class.new(result, @shortcuts, parent: @parent) if result.is_a?(AnonymousStep)
+      if result.is_a?(AnonymousStep) || result.is_a?(Traversal)
+        return self.class.new(result, @shortcuts, parent: @parent)
+      end
 
       result
     end

data/lib/grumlin/shortcuts/properties.rb

@@ -5,13 +5,13 @@ module Grumlin
     module Properties
       extend Grumlin::Shortcuts
 
-      shortcut :props do |props = {}|
+      shortcut :props do |*_args, **props|
         props.reduce(self) do |tt, (prop, value)|
           tt.property(prop, value)
         end
       end
 
-      shortcut :hasAll do |props = {}|
+      shortcut :hasAll do |*, **props|
         props.reduce(self) do |tt, (prop, value)|
           tt.has(prop, value)
         end

data/lib/grumlin/shortcuts.rb

@@ -10,6 +10,7 @@ module Grumlin
 
     def self.extended(base)
       base.include(InstanceMethods)
+      base.include(Grumlin::Expressions)
     end
 
     def inherited(subclass)

data/lib/grumlin/step.rb

@@ -4,8 +4,8 @@ module Grumlin
   class Step < AnonymousStep
     attr_reader :client
 
-    def initialize(pool, name, *args, previous_step: nil)
-      super(name, *args, previous_step: previous_step)
+    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
 
@@ -36,8 +36,8 @@ module Grumlin
       end
     end
 
-    def step(step_name, args)
-      self.class.new(@pool, step_name, *args, previous_step: self)
+    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/transport.rb

@@ -23,7 +23,7 @@ module Grumlin
     end
 
     def connect
-      raise "ClientClosed" if @closed
+      raise ClientClosedError if @closed
       raise AlreadyConnectedError if connected?
 
       @connection = Async::WebSocket::Client.connect(Async::HTTP::Endpoint.parse(@url), **@client_options)

data/lib/grumlin/traversal.rb

@@ -5,13 +5,32 @@ module Grumlin
     # TODO: add other start steps
     SUPPORTED_STEPS = %i[E V addE addV].freeze
 
-    def initialize(pool = Grumlin.default_pool)
+    CONFIGURATION_STEPS = %i[withSideEffect].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|
-        Step.new(@pool, step, *args)
+      define_method step do |*args, **params|
+        Step.new(@pool, step, *args, configuration_steps: @configuration_steps, **params)
       end
     end
   end

data/lib/grumlin/typed_value.rb

@@ -23,7 +23,13 @@ module Grumlin
     def inspect
       "<#{type}.#{value}>"
     end
-    alias to_s inspect
-    alias to_readable_bytecode inspect
+
+    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.13.0"
+  VERSION = "0.14.2"
 end

data/lib/grumlin/vertex.rb

@@ -16,6 +16,9 @@ module Grumlin
     def inspect
       "v[#{@id}]"
     end
-    alias to_s inspect
+
+    def to_s
+      inspect
+    end
   end
 end

data/lib/grumlin.rb

@@ -43,6 +43,8 @@ module Grumlin
 
   class AlreadyConnectedError < ConnectionStatusError; end
 
+  class ClientClosedError < ConnectionStatusError; end
+
   class ProtocolError < Error; end
 
   class UnknownResponseStatus < ProtocolError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.2
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-05 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -130,9 +130,7 @@ homepage: https://github.com/zhulik/grumlin
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/zhulik/grumlin
-  source_code_uri: https://github.com/zhulik/grumlin
-  changelog_uri: https://github.com/zhulik/grumlin/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -141,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="