grumlin 0.15.2 → 0.15.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7027bddd19689f2886286b1bcd099c7c8dbf764502f77b5469434cd243387e5
-  data.tar.gz: b5a3e1e1db75e2a7378f77246c9b3bbbc066d5b32c575d15c88d38917d4658be
+  metadata.gz: 195f614a2cbebbe43f6dd2aedb3aeb54891c4377f50f85f21f44ee3325c87f58
+  data.tar.gz: 0f0a3c0b5aa8f03fb4d613c406b08497685ee9fb4cbea2e8a0b99385f749ebf3
 SHA512:
-  metadata.gz: b116b30db9eeaf3255793843caa191b6942de7c16a5765b00aa0b803c5e7ae7a1e35d4da4372fd9e2ebe485555f9b895b0fb527cbb37ff89636824197e3a9821
-  data.tar.gz: 11647d93fe2b33814a5356607bca81f2d30edf3992cbae4c52a2191cc34db8632e65bd672ac61030ed27a3c7a7387316d0522188b53e83cef63af2171d5a8494
+  metadata.gz: 21a7d91e9ce0a9e143f4bba9bb15d4bd31f6337f72500038bf09cd471ab05535d9d3ade4cfba6d6b6d779e09600b6352ed83b3e4bd70aeadd1417e51ba663937
+  data.tar.gz: 9cd14a8f18b856eca87d3b51b48c3f3c0d8d454b76fae92466bd7aee370019bbbb0b398236187acfcfed2322520aa4a3aa68a0e6bfb8b02a073e27f0db3cf525

data/.rubocop.yml

@@ -60,6 +60,9 @@ RSpec/MultipleExpectations:
 RSpec/DescribeClass:
   Enabled: false
 
+RSpec/MultipleMemoizedHelpers:
+  Max: 7
+
 Style/WordArray:
   Exclude:
     - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.15.4] - 2022-01-20
+
+- Move step and expression definitions to a yaml file for better diffs
+- Add `definitions:format` rake task
+
+## [0.15.3] - 2022-01-18
+
+- Fix passing nils as step arguments. Even if they are not supported by the server, they should not be omitted.
+
 ## [0.15.2] - 2022-01-17
 
 - New steps: `map` and `identity`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (0.15.2)
+    grumlin (0.15.6)
       async-pool (~> 0.3)
       async-websocket (~> 0.19)
       oj (~> 3.12)
@@ -28,7 +28,7 @@ GEM
       protocol-http (~> 0.22.0)
       protocol-http1 (~> 0.14.0)
       protocol-http2 (~> 0.14.0)
-    async-io (1.32.2)
+    async-io (1.33.0)
       async
     async-pool (0.3.9)
       async (>= 1.25)

data/README.md

@@ -258,6 +258,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, 
 push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Adding new steps and expressions
+To add a new step or an expression simple put it to the corresponding list in [definitions.yml](lib/definitions.yml)
+and run `rake definitions:format`. You don't need to properly sort the lists manually, the rake task will do it for you.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/zhulik/grumlin. This project is intended to 

data/Rakefile

@@ -1,12 +1,30 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-require "rubocop/rake_task"
+task default: %i[rubocop spec]
 
-RuboCop::RakeTask.new
+namespace :definitions do
+  desc "Format definitions.yml"
+  task :format do
+    path = File.join(__dir__, "lib", "definitions.yml")
+    definitions = YAML.safe_load(File.read(path))
+
+    definitions.each_value do |kind|
+      kind.each do |name, list|
+        next if name == "with_options"
+
+        list.sort!
+      end
+    end
 
-task default: %i[spec rubocop]
+    File.write(path, YAML.dump(definitions))
+  end
+end

data/lib/definitions.yml

@@ -0,0 +1,114 @@
+---
+steps:
+  regular:
+  - E
+  - V
+  - addE
+  - addV
+  - aggregate
+  - and
+  - as
+  - both
+  - bothE
+  - by
+  - choose
+  - coalesce
+  - constant
+  - count
+  - dedup
+  - drop
+  - elementMap
+  - emit
+  - fold
+  - from
+  - group
+  - groupCount
+  - has
+  - hasId
+  - hasLabel
+  - hasNot
+  - id
+  - identity
+  - in
+  - inE
+  - inV
+  - inject
+  - is
+  - label
+  - limit
+  - map
+  - none
+  - not
+  - option
+  - or
+  - order
+  - out
+  - outE
+  - outV
+  - path
+  - project
+  - properties
+  - property
+  - range
+  - repeat
+  - sack
+  - select
+  - sideEffect
+  - skip
+  - sum
+  - tail
+  - timeLimit
+  - to
+  - unfold
+  - union
+  - until
+  - valueMap
+  - values
+  - where
+  - with
+  start:
+  - E
+  - V
+  - addE
+  - addV
+  - inject
+  configuration:
+  - withSack
+  - withSideEffect
+expressions:
+  operator:
+  - addAll
+  - and
+  - assign
+  - div
+  - max
+  - min
+  - minus
+  - mult
+  - or
+  - sum
+  order:
+  - asc
+  - desc
+  - shuffle
+  pop:
+  - all
+  - first
+  - last
+  - mixed
+  scope:
+  - local
+  t:
+  - id
+  - label
+  with_options:
+    tokens: "~tinkerpop.valueMap.tokens"
+    none: 0
+    ids: 1
+    labels: 2
+    keys: 4
+    values: 8
+    all: 15
+    indexer: "~tinkerpop.index.indexer"
+    list: 0
+    map: 1

data/lib/grumlin/anonymous_step.rb

@@ -4,11 +4,7 @@ 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
+    SUPPORTED_STEPS = Grumlin.definitions.dig(:steps, :regular).map(&:to_sym).freeze
 
     def initialize(name, *args, configuration_steps: [], previous_step: nil, **params)
       @name = name
@@ -41,7 +37,9 @@ module Grumlin
     end
 
     def args
-      [*@args, @params.any? ? @params : nil].compact
+      [*@args].tap do |args|
+        args << @params if @params.any?
+      end
     end
   end
 end

data/lib/grumlin/expressions/operator.rb

@@ -3,7 +3,7 @@
 module Grumlin
   module Expressions
     module Operator
-      SUPPORTED_STEPS = %i[addAll and assign div max min minus mult or sum].freeze
+      SUPPORTED_STEPS = Grumlin.definitions.dig(:expressions, :operator).map(&:to_sym).freeze
 
       class << self
         extend Expression

data/lib/grumlin/expressions/order.rb

@@ -3,7 +3,7 @@
 module Grumlin
   module Expressions
     module Order
-      SUPPORTED_STEPS = %i[asc desc shuffle].freeze
+      SUPPORTED_STEPS = Grumlin.definitions.dig(:expressions, :order).map(&:to_sym).freeze
 
       class << self
         extend Expression

data/lib/grumlin/expressions/pop.rb

@@ -3,7 +3,7 @@
 module Grumlin
   module Expressions
     module Pop
-      SUPPORTED_STEPS = %i[all first last mixed].freeze
+      SUPPORTED_STEPS = Grumlin.definitions.dig(:expressions, :pop).map(&:to_sym).freeze
 
       class << self
         extend Expression

data/lib/grumlin/expressions/scope.rb

@@ -3,7 +3,7 @@
 module Grumlin
   module Expressions
     module Scope
-      SUPPORTED_STEPS = %i[local].freeze
+      SUPPORTED_STEPS = Grumlin.definitions.dig(:expressions, :scope).map(&:to_sym).freeze
 
       class << self
         extend Expression

data/lib/grumlin/expressions/t.rb

@@ -3,7 +3,7 @@
 module Grumlin
   module Expressions
     module T
-      SUPPORTED_STEPS = %i[id label].freeze
+      SUPPORTED_STEPS = Grumlin.definitions.dig(:expressions, :t).map(&:to_sym).freeze
 
       class << self
         extend Expression

data/lib/grumlin/expressions/u.rb

@@ -2,13 +2,10 @@
 
 module Grumlin
   module Expressions
+    # The module is called U because Underscore and implements __
     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|
+        Grumlin::AnonymousStep::SUPPORTED_STEPS.each do |step|
           define_method step do |*args, **params|
             AnonymousStep.new(step, *args, **params)
           end

data/lib/grumlin/expressions/with_options.rb

@@ -3,18 +3,7 @@
 module Grumlin
   module Expressions
     module WithOptions
-      WITH_OPTIONS = {
-        tokens: "~tinkerpop.valueMap.tokens",
-        none: 0,
-        ids: 1,
-        labels: 2,
-        keys: 4,
-        values: 8,
-        all: 15,
-        indexer: "~tinkerpop.index.indexer",
-        list: 0,
-        map: 1
-      }.freeze
+      WITH_OPTIONS = Grumlin.definitions.dig(:expressions, :with_options).freeze
 
       class << self
         WITH_OPTIONS.each do |k, v|

data/lib/grumlin/shortcut.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Shortcut
+    extend Forwardable
+
+    attr_reader :name, :block
+
+    def_delegator :@block, :arity
+    def_delegator :@block, :source_location
+
+    def initialize(name, &block)
+      @name = name
+      @block = block
+    end
+
+    def ==(other)
+      @name == other.name && @block == other.block
+    end
+
+    # TODO: to_s, inspect, preview
+
+    def apply(object, *args, **params)
+      object.instance_exec(*args, **params, &@block)
+    end
+  end
+end

data/lib/grumlin/shortcut_proxy.rb

@@ -18,7 +18,7 @@ module Grumlin
 
       return wrap_result(@object.public_send(name, *args, **params)) if @object.respond_to?(name)
 
-      return wrap_result(instance_exec(*args, **params, &@shortcuts[name])) if @shortcuts.key?(name)
+      return wrap_result(@shortcuts[name].apply(self, *args, **params)) if @shortcuts.key?(name)
 
       super
     end

data/lib/grumlin/shortcuts.rb

@@ -18,19 +18,28 @@ module Grumlin
       subclass.shortcuts_from(self)
     end
 
-    def shortcut(name, &block)
+    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?
-      raise ArgumentError, "cannot use names of standard gremlin steps" if Grumlin.supported_steps.include?(name)
+      if Grumlin::AnonymousStep::SUPPORTED_STEPS.include?(name)
+        raise ArgumentError,
+              "cannot use names of standard gremlin steps"
+      end
+
+      if (shortcut.nil? && block.nil?) || (shortcut && block)
+        raise ArgumentError, "either shortcut or block must be passed"
+      end
+
+      shortcut ||= Shortcut.new(name, &block)
 
-      raise ArgumentError, "shortcut '#{name}' already exists" if shortcuts.key?(name) && shortcuts[name] != block
+      raise ArgumentError, "shortcut '#{name}' already exists" if shortcuts.key?(name) && shortcuts[name] != shortcut
 
-      shortcuts[name] = block
+      shortcuts[name] = shortcut
     end
 
     def shortcuts_from(other_shortcuts)
-      other_shortcuts.shortcuts.each do |name, block|
-        shortcut(name, &block)
+      other_shortcuts.shortcuts.each do |name, shortcut|
+        shortcut(name, shortcut)
       end
     end
 

data/lib/grumlin/traversal.rb

@@ -2,10 +2,9 @@
 
 module Grumlin
   class Traversal
-    # TODO: add other start steps
-    SUPPORTED_STEPS = %i[E V addE addV].freeze
+    SUPPORTED_STEPS = Grumlin.definitions.dig(:steps, :start).map(&:to_sym).freeze
 
-    CONFIGURATION_STEPS = %i[withSack withSideEffect].freeze
+    CONFIGURATION_STEPS = Grumlin.definitions.dig(:steps, :configuration).map(&:to_sym).freeze
 
     attr_reader :configuration_steps
 

data/lib/grumlin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Grumlin
-  VERSION = "0.15.2"
+  VERSION = "0.15.6"
 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.2
+  version: 0.15.6
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -96,6 +96,7 @@ 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
@@ -114,6 +115,7 @@ files:
 - 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