grumlin 0.12.5 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa9540000384bf515945dcb4ca15731e8b71d0d0d162bdde304c9c653e36de1
-  data.tar.gz: 7078ea9b27f96f6384b9b9918a0b49fe325075790b98b4367b153312670bd7be
+  metadata.gz: 45c3b3317c8b96d763dd2de25de3744646994370dce29f2bc70f1b8c2725b119
+  data.tar.gz: a8dce9eb4e0c9dc55383ed62d35a18e3a67fd63baf5d6f36cdf45196d36e49ef
 SHA512:
-  metadata.gz: b32ac2a9ac09843ec5aa0ac8da79e9712bb98002df20689ea53c19f23b9209a58bd2850c203c67b7ed40c8b18059fa589243d5330cd5052f9637428043d0949b
-  data.tar.gz: ffdda90d2a81d59f4c8baa8d9cc0413d5caa2dbc418bbce3c64958202a22089122889ab41e67962d6de6e1bc5afff7824361a3c6265cd79328e4912fcada92cc
+  metadata.gz: cae50acbded8f08e2d48ecda7f002c4ec1312ae1b5aac09b803580061d06e0befe4c8480213f1702421c1580105fc599e61b0b67d929635e82d24f9a9f402fcc
+  data.tar.gz: 8feb97c5edd5e9327fdfbf8bb6539028c09981a330917717e0eeeb3b40a74d1c00eb214cc2ce0b9669d341f4b32d8971a3f715130e77c1395bf2f27301aa04bc

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## [Unreleased]
+## [0.13.0] - 2021-12-03
+
+- Add `Shortcuts` and `Repository`
+- Allow executing any gremlin steps by name using `Grumlin::AnonymousStep#step`
+- Rename `Grumlin::Tools` to `Grumlin::Expressions`
 
 ## [0.1.0] - 2021-05-25
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (0.12.5)
+    grumlin (0.13.0)
       async-pool (~> 0.3)
       async-websocket (~> 0.19)
       oj (~> 3.12)

data/README.md

@@ -14,7 +14,7 @@ and gremlin-server.
 [async-websocket](https://github.com/socketry/async-websocket). Code using grumlin must be executed in an async
 event loop.
 
-**Warning:** Grumlin is in development, but ready for simple use cases
+**Warning**: Grumlin is in development, but ready for simple use cases
 
 ## Table of contents
 - [Install](#install)
@@ -51,12 +51,12 @@ end
 
 ### Traversing graphs
 
-**Warning:** Not all steps and tools described in the standard are supported
+**Warning**: Not all steps and tools described in the standard are supported
 
 #### Sugar
 
 Grumlin provides an easy to use module called `Grumlin::Sugar`. Once included in your class it injects some useful
-constants and methods turning your class into an entrypoint for traversals.
+constants and methods turning your class into an entrypoint for traversals with pure gremlin experience.
 
 ```ruby
 class MyRepository
@@ -73,6 +73,109 @@ class MyRepository
 end
 ```
 
+#### Shortcuts
+
+**Shortcuts** is a way to share and organize gremlin code. They let developers define their own steps consisting of
+sequences of standard gremlin steps, other shortcuts and even add new initially unsupported by Grumlin steps.
+Remember ActiveRecord scopes? Shortcuts are very similar. `Grumlin::Shortcuts#with_shortcuts` wraps a given object into
+a proxy object that simply proxies all methods existing in the wrapped object to it and handles shortcuts.
+
+**Important**: if a shortcut's name matches a name of a method defined on the wrapped object, this shortcut will be
+be ignored because methods have higher priority. You cannot override supported by Grumlin steps with shortcuts, 
+`Grumlin::Shortcuts.shortcut` will raise an `ArgumentError`. Please carefully choose names for your shortcuts.
+
+Shortcuts are designed to be used with `Grumlin::Repository` but still can be used separately, with `Grumlin::Sugar`
+for example.
+
+**Defining**:
+```ruby
+
+# Defining shortcuts
+class ColorShortcut
+  extend Grumlin::Shortcuts
+
+  # Custom step
+  shortcut :hasColor do |color|
+    has(:color, color)
+  end
+end
+
+class ChooseShortcut
+  extend Grumlin::Shortcuts
+
+  # Standard Gremlin step
+  shortcut :choose do |*args|
+    step(:choose, *args)
+  end
+end
+
+class AllShortcuts
+  extend Grumlin::Shortcuts
+
+  # Adding shortcuts from other modules
+  shortcuts_from ColorShortcut
+  shortcuts_from ChooseShortcut
+end
+```
+
+**Using with Grumlin::Sugar**:
+```ruby
+class MyRepository
+  include Grumlin::Sugar
+  extend Grumlin::Shortcuts
+
+  shortcuts_from AllShortcuts
+
+  # Wrapping a traversal
+  def red_triangles
+    with_shortcuts(g).V.hasLabel(:triangle)
+                       .hasColor("red")
+                       .toList
+  end
+
+  # Wrapping _
+  def something_else
+    with_shortcuts(g).V.hasColor("red")
+                       .repeat(with_shortcuts(__)
+                       .out(:has)
+                       .hasColor("blue")).toList
+  end
+end
+```
+
+#### Grumlin::Repository
+`Grumlin::Repository` combines functionality of `Grumlin::Sugar` and `Grumlin::Shortcuts` as well as adds a few useful
+shortcuts to make gremlin code more rubyish. Can be used as a drop in replacement for `Grumlin::Sugar`. Remember that
+`Grumlin::Sugar` needs to be included, but `Grumlin::Repository` - extended. **Classes extending `Grumlin::Repository`
+or `Grumlin::Shortcuts` can be inherited**, successors don't need to extend them again and have access to shortcuts 
+defined in the ancestor.
+
+**Using**:
+
+```ruby
+class MyRepository
+  extend Grumlin::Repository
+
+  # Repository supports all Grumlin::Shortcut and Grumlin::Sugar features.
+  # It can add shortcuts from another repository or a shortcuts module
+  shortcuts_from ChooseShortcut
+  
+  shortcut :red_triangles do |color|
+    # hasAll unwraps a hash of properties into a chain of `has` steps:
+    # hasAll(name1: :value, name2: :value) == has(:name1, :value).has(:name2, :value)
+    # the `props` shortcut does exactly the same but with `property` steps.
+    hasAll(T.label => :triangle, color: color)
+  end
+
+  # g and __ are already aware of shortcuts 
+  def red_triangles
+    g.V.hasLabel(:triangle)
+       .hasColor("red")
+       .toList
+  end
+end
+```
+
 #### IRB
 
 An example of how to start an IRB session with support for executing gremlin queries:

data/lib/grumlin/anonymous_step.rb

@@ -18,10 +18,14 @@ module Grumlin
 
     SUPPORTED_STEPS.each do |step|
       define_method(step) do |*args|
-        add_step(step, args)
+        step(step, args)
       end
     end
 
+    def step(name, args)
+      self.class.new(name, *args, previous_step: self)
+    end
+
     def inspect
       bytecode.inspect
     end
@@ -31,11 +35,5 @@ module Grumlin
     def bytecode(no_return: false)
       @bytecode ||= Bytecode.new(self, no_return: no_return)
     end
-
-    private
-
-    def add_step(step_name, args)
-      self.class.new(step_name, *args, previous_step: self)
-    end
   end
 end

data/lib/grumlin/bytecode.rb

@@ -38,12 +38,12 @@ module Grumlin
     # depending on the `serialization_method` parameter. I 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.send(serialization_method) if arg.respond_to?(serialization_method)
+      return arg.public_send(serialization_method) if arg.respond_to?(serialization_method)
       return arg unless arg.is_a?(AnonymousStep)
 
       arg.args.flatten.each.with_object([arg.name.to_s]) do |a, res|
-        res << if a.instance_of?(AnonymousStep)
-                 a.bytecode.send(serialization_method)
+        res << if a.respond_to?(:bytecode)
+                 a.bytecode.public_send(serialization_method)
                else
                  serialize_arg(a, serialization_method: serialization_method)
                end

data/lib/grumlin/{tools → expressions}/order.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Grumlin
-  module Tools
+  module Expressions
     module Order
       extend Tool
 

data/lib/grumlin/{tools → expressions}/p.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Grumlin
-  module Tools
+  module Expressions
     module P
       class << self
         class Predicate < TypedValue

data/lib/grumlin/{tools → expressions}/pop.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Grumlin
-  module Tools
+  module Expressions
     module Pop
       extend Tool
 

data/lib/grumlin/{tools → expressions}/scope.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Grumlin
-  module Tools
+  module Expressions
     module Scope
       extend Tool
 

data/lib/grumlin/{tools → expressions}/t.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Grumlin
-  module Tools
+  module Expressions
     module T
       extend Tool
 

data/lib/grumlin/{tools → expressions}/tool.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Grumlin
-  module Tools
+  module Expressions
     module Tool
       def define_steps(steps, tool_name)
         steps.each do |step|

data/lib/grumlin/{tools → expressions}/u.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Grumlin
-  module Tools
+  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

data/lib/grumlin/{tools → expressions}/with_options.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Grumlin
-  module Tools
+  module Expressions
     module WithOptions
       WITH_OPTIONS = {
         tokens: "~tinkerpop.valueMap.tokens",

data/lib/grumlin/repository.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module Repository
+    module InstanceMethods
+      def __
+        with_shortcuts(Grumlin::Expressions::U)
+      end
+
+      def g
+        with_shortcuts(Grumlin::Traversal.new)
+      end
+    end
+
+    def self.extended(base)
+      base.extend(Grumlin::Shortcuts)
+      base.include(Grumlin::Expressions)
+      base.include(InstanceMethods)
+
+      base.shortcuts_from(Grumlin::Shortcuts::Properties)
+    end
+  end
+end

data/lib/grumlin/shortcut_proxy.rb

@@ -0,0 +1,51 @@
+# 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)
+      return @parent.public_send(name, *args) if %i[__ g].include?(name) && !@parent.nil?
+
+      return wrap_result(@object.public_send(name, *args)) if @object.respond_to?(name)
+
+      return wrap_result(instance_exec(*args, &@shortcuts[name])) 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)
+      return self.class.new(result, @shortcuts, parent: @parent) if result.is_a?(AnonymousStep)
+
+      result
+    end
+  end
+end

data/lib/grumlin/shortcuts/properties.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module Shortcuts
+    module Properties
+      extend Grumlin::Shortcuts
+
+      shortcut :props do |props = {}|
+        props.reduce(self) do |tt, (prop, value)|
+          tt.property(prop, value)
+        end
+      end
+
+      shortcut :hasAll do |props = {}|
+        props.reduce(self) do |tt, (prop, value)|
+          tt.has(prop, value)
+        end
+      end
+    end
+  end
+end

data/lib/grumlin/shortcuts.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+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)
+    end
+
+    def inherited(subclass)
+      super
+      subclass.shortcuts_from(self)
+    end
+
+    def shortcut(name, &block)
+      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)
+
+      raise ArgumentError, "shortcut '#{name}' already exists" if shortcuts.key?(name)
+
+      shortcuts[name] = block
+    end
+
+    def shortcuts_from(other_shortcuts)
+      other_shortcuts.shortcuts.each do |name, block|
+        shortcut(name, &block)
+      end
+    end
+
+    def shortcuts
+      @shortcuts ||= {}
+    end
+  end
+end

data/lib/grumlin/step.rb

@@ -36,9 +36,7 @@ module Grumlin
       end
     end
 
-    private
-
-    def add_step(step_name, args)
+    def step(step_name, args)
       self.class.new(@pool, step_name, *args, previous_step: self)
     end
   end

data/lib/grumlin/sugar.rb

@@ -3,11 +3,11 @@
 module Grumlin
   module Sugar
     def self.included(base)
-      base.include Grumlin::Tools
+      base.include(Grumlin::Expressions)
     end
 
     def __
-      Grumlin::Tools::U
+      Grumlin::Expressions::U
     end
 
     def g

data/lib/grumlin/test/rspec/gremlin_context.rb

@@ -11,8 +11,8 @@ module Grumlin
         include Grumlin::Sugar
 
         before do
-          Grumlin::Tools.constants.each do |tool|
-            stub_const(tool.to_s, Grumlin::Tools.const_get(tool))
+          Grumlin::Expressions.constants.each do |tool|
+            stub_const(tool.to_s, Grumlin::Expressions.const_get(tool))
           end
         end
 

data/lib/grumlin/version.rb

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

data/lib/grumlin.rb

@@ -106,6 +106,10 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.12.5
+  version: 0.13.0
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2021-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -101,21 +101,25 @@ files:
 - lib/grumlin/bytecode.rb
 - lib/grumlin/client.rb
 - lib/grumlin/edge.rb
+- lib/grumlin/expressions/order.rb
+- lib/grumlin/expressions/p.rb
+- lib/grumlin/expressions/pop.rb
+- lib/grumlin/expressions/scope.rb
+- lib/grumlin/expressions/t.rb
+- lib/grumlin/expressions/tool.rb
+- lib/grumlin/expressions/u.rb
+- lib/grumlin/expressions/with_options.rb
 - lib/grumlin/path.rb
+- lib/grumlin/repository.rb
 - lib/grumlin/request_dispatcher.rb
+- lib/grumlin/shortcut_proxy.rb
+- lib/grumlin/shortcuts.rb
+- lib/grumlin/shortcuts/properties.rb
 - lib/grumlin/step.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/tools/order.rb
-- lib/grumlin/tools/p.rb
-- lib/grumlin/tools/pop.rb
-- lib/grumlin/tools/scope.rb
-- lib/grumlin/tools/t.rb
-- lib/grumlin/tools/tool.rb
-- lib/grumlin/tools/u.rb
-- lib/grumlin/tools/with_options.rb
 - lib/grumlin/transport.rb
 - lib/grumlin/traversal.rb
 - lib/grumlin/typed_value.rb
@@ -144,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Gremlin graph traversal language DSL and client for Ruby.