grumlin 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ab9e228cb2cd8ecc761136dab0e92a42aae268708aecf5784aac670a4404ecb
-  data.tar.gz: 984d2323e97056291370c37dadc2cf90d694f27caa753053a110165985dc067b
+  metadata.gz: bb67bbe2eff3a7fd02cce19c6052fa70e3f54f3ec2cb06102667f69e43d07e8d
+  data.tar.gz: 1ecf0285f60fab6fd93bd0b36bfe58c39b94eebf0ead055f6f3cc4f2e9f8b19d
 SHA512:
-  metadata.gz: 27a73c8e77850b99e030c129f8df2e30fc6933ad4da29e5a205b7812c64c88f24d7aceb2128af6687fc4bf35056509421989d2cae5a51c5db6f53c18f735fe97
-  data.tar.gz: adf371f27c60f2c0e70feaafcfede32dc64beef09b098bf35f01270b37049ee5ce76a68c184bf80abe33c7069ca8b947bbd54ecdcab42fd461a8bb09c270b1b1
+  metadata.gz: '05263993fc271810fd493ae3d5fdd8d84b6b698a8d9a4e4a4c336b09858571b156971b6f3def4bdb2d9c3743b07bebeb40eb1c426e4c316a8aa4a87b264f15b5'
+  data.tar.gz: 78fc706c4694146ff2b5fedc75b1d0186dca152fc9f2731c1b6936ea906e6410077c95871fba8b4c302f375cc8b28afffa37ccb59097a88470e266c4f26e6c51

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (0.20.0)
+    grumlin (0.21.0)
       async-pool (~> 0.3)
       async-websocket (~> 0.19)
       oj (~> 3.13)
@@ -72,7 +72,7 @@ GEM
       racc (~> 1.4)
     nokogiri (1.13.6-x86_64-linux)
       racc (~> 1.4)
-    oj (3.13.16)
+    oj (3.13.18)
     overcommit (0.59.1)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)

data/README.md

@@ -80,8 +80,7 @@ sequences of standard gremlin steps, other shortcuts and even add new initially
 Remember ActiveRecord scopes? Shortcuts are very similar.
 
 **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.
+be ignored because methods have higher priority.
 
 Shortcuts are designed to be used with `Grumlin::Repository` but still can be used separately, with `Grumlin::Sugar`
 for example.
@@ -143,7 +142,7 @@ class MyRepository
 end
 ```
 
-##### Overriding standard steps
+##### Overriding standard steps and shortcuts
 
 Sometimes it may be useful to override standard steps. Grumlin does not allow it by default, but one
 is still able to override standard steps if they know what they are doing:
@@ -157,6 +156,8 @@ end
 This will create a new shortcut that overrides the standard step `addV` and adds default properties to all vertices
 created by the repository that uses this shortcut.
 
+Shortcuts also can be overridden, but super() is not available.
+
 #### 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
@@ -230,6 +231,10 @@ All of them support 3 different modes for error handling: `:retry`, `:ignore` an
 with [retryable](https://github.com/nfedyashev/retryable). **params will be merged to the default config for upserts 
 and passed to `Retryable.retryable`. In case if you want to modify retryable behaviour you are to do so.
 
+If you don't want to define you own repository, simply use
+
+`Grumlin::Repository.new` returns an instance of an anonymous class extending `Grumlin::Repository`. 
+
 **Usage**
 
 To execute the query defined in a query block one simply needs to call a method with the same name:

data/gremlin_server/Dockerfile

@@ -1,4 +1,4 @@
-FROM tinkerpop/gremlin-server
+FROM tinkerpop/gremlin-server:3.5.3
 
 RUN rm -rf /opt/gremlin-server/ext/tinkergraph-gremlin
 

data/grumlin.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/zhulik/grumlin"
-  spec.metadata["changelog_uri"] = "https://github.com/zhulik/grumlin/blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/babbel/grumlin/releases"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do

data/lib/definitions.yml

@@ -82,6 +82,7 @@ steps:
   configuration:
   - withSack
   - withSideEffect
+  - withStrategies
 expressions:
   cardinality:
   - list

data/lib/grumlin/repository/instance_methods.rb

@@ -56,7 +56,7 @@ module Grumlin
         with_upsert_error_handling(on_failure, params) do
           create_properties, update_properties = cleanup_properties(create_properties, update_properties)
 
-          g.upsertV(label, id, create_properties, update_properties).next
+          g.upsertV(label, id, create_properties, update_properties).id.next
         end
       end
 
@@ -70,7 +70,7 @@ module Grumlin
               create_properties, update_properties = cleanup_properties(create_properties, update_properties)
 
               t.upsertV(label, id, create_properties, update_properties)
-            end.iterate
+            end.id.iterate
           end
         end
       end
@@ -80,12 +80,12 @@ module Grumlin
       def upsert_edge(label, from:, to:, create_properties: {}, update_properties: {}, on_failure: :retry, **params) # rubocop:disable Metrics/ParameterLists
         with_upsert_error_handling(on_failure, params) do
           create_properties, update_properties = cleanup_properties(create_properties, update_properties, T.label)
-          g.upsertE(label, from, to, create_properties, update_properties).next
+          g.upsertE(label, from, to, create_properties, update_properties).id.next
         end
       end
 
       # edges:
-      # [["label", "id", {create: :properties}, {update: properties}]]
+      # [["label", "from", "to", {create: :properties}, {update: properties}]]
       # params can override Retryable config from UPSERT_RETRY_PARAMS
       def upsert_edges(edges, batch_size: 100, on_failure: :retry, **params)
         edges.each_slice(batch_size) do |slice|
@@ -94,7 +94,7 @@ module Grumlin
               create_properties, update_properties = cleanup_properties(create_properties, update_properties, T.label)
 
               t.upsertE(label, from, to, create_properties, update_properties)
-            end.iterate
+            end.id.iterate
           end
         end
       end

data/lib/grumlin/repository.rb

@@ -10,6 +10,7 @@ module Grumlin
     }.freeze
 
     def self.extended(base)
+      super
       base.extend(Grumlin::Shortcuts)
       base.include(Repository::InstanceMethods)
 
@@ -17,6 +18,12 @@ module Grumlin
       base.shortcuts_from(Grumlin::Shortcuts::Upserts)
     end
 
+    def self.new
+      @repository ||= Class.new do # rubocop:disable Naming/MemoizedInstanceVariableName
+        extend Grumlin::Repository
+      end.new
+    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)

data/lib/grumlin/shortcuts/properties.rb

@@ -5,11 +5,12 @@ module Grumlin
     module Properties
       extend Grumlin::Shortcuts
 
-      shortcut :props do |**props|
-        props.reduce(self) do |tt, (prop, value)| # rubocop:disable Style/EachWithObject
-          next tt.property(prop, value) unless value.nil? # nils are not supported
+      shortcut :props do |cardinality = nil, **props|
+        props.reduce(self) do |tt, (prop, value)|
+          next tt if value.nil? # nils are not supported
+          next tt.property(prop, value) if cardinality.nil?
 
-          tt
+          tt.property(cardinality, prop, value)
         end
       end
 

data/lib/grumlin/shortcuts/storage.rb

@@ -31,12 +31,6 @@ module Grumlin
       end
 
       def add(name, shortcut)
-        # not lazy shortcuts are allowed to be overridden
-        if known?(name) && @storage[name] != shortcut && shortcut.lazy?
-          raise ArgumentError,
-                "shortcut '#{name}' already exists"
-        end
-
         @storage[name] = shortcut
 
         ac = action_class

data/lib/grumlin/shortcuts/upserts.rb

@@ -10,8 +10,8 @@ module Grumlin
             .fold
             .coalesce(
               __.unfold,
-              __.addV(label).props(**create_properties.merge(T.id => id))
-            ).props(**update_properties)
+              __.addV(label).props(Cardinality.single, **create_properties.merge(T.id => id))
+            ).props(Cardinality.single, **update_properties)
       end
 
       shortcut :upsertE do |label, from, to, create_properties = {}, update_properties = {}|

data/lib/grumlin/steppable.rb

@@ -13,8 +13,7 @@ module Grumlin
     def initialize
       return if respond_to?(:shortcuts)
 
-      raise RuntimerError,
-            "steppable must not be initialized directly, use Grumlin::Shortcuts::Storage#g or #__ instead"
+      raise "steppable must not be initialized directly, use Grumlin::Shortcuts::Storage#g or #__ instead"
     end
 
     ALL_STEPS.each do |step|

data/lib/grumlin/traversal_start.rb

@@ -2,6 +2,8 @@
 
 module Grumlin
   class TraversalStart < Steppable
+    include WithExtension
+
     def to_s(*)
       self.class.to_s
     end

data/lib/grumlin/traversal_strategies/options_strategy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module TraversalStrategies
+    class OptionsStrategy < TypedValue
+      def initialize(value)
+        super(type: "OptionsStrategy", value: value)
+      end
+    end
+  end
+end

data/lib/grumlin/version.rb

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

data/lib/grumlin/with_extension.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module WithExtension
+    def with(name, value)
+      prev = self
+      strategy = if is_a?(with_action_class)
+                   prev = previous_step
+                   TraversalStrategies::OptionsStrategy.new(args.first.value.merge(name => value))
+                 else
+                   TraversalStrategies::OptionsStrategy.new({ name => value })
+                 end
+      with_action_class.new(:withStrategies, args: [strategy], previous_step: prev)
+    end
+
+    private
+
+    def with_action_class
+      @with_action_class ||= Class.new(shortcuts.action_class) do
+        include WithExtension
+
+        def with_action_class
+          self.class
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -96,7 +96,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -154,11 +153,13 @@ files:
 - lib/grumlin/test/rspec/gremlin_context.rb
 - lib/grumlin/transport.rb
 - lib/grumlin/traversal_start.rb
+- lib/grumlin/traversal_strategies/options_strategy.rb
 - lib/grumlin/traverser.rb
 - lib/grumlin/typed_value.rb
 - lib/grumlin/typing.rb
 - lib/grumlin/version.rb
 - lib/grumlin/vertex.rb
+- lib/grumlin/with_extension.rb
 - lib/tasks/benchmark.rake
 homepage: https://github.com/zhulik/grumlin
 licenses:
@@ -166,7 +167,7 @@ licenses:
 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
+  changelog_uri: https://github.com/babbel/grumlin/releases
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []

data/CHANGELOG.md

@@ -1,71 +0,0 @@
-## [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
-- 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`
-
-## [0.15.1] - 2022-01-17
-
-- Fix passing arrays as step arguments
-
-## [0.15.0] - 2022-01-11
-
-- Add `properties` step
-- Add proper support for bulked results
-- Add support for `Property` objects
-
-## [0.14.5] - 2021-12-27
-
-- Fix params handling
-- Add `aggregate` step
-- Add `Order.shuffle`
-
-## [0.14.4] - 2021-12-17
-
-- `Grumlin::Repository.shorcuts_from` do not raise `ArgumentError` when importing an already existing shortcut
-  pointing to the same block. This fixes importing shortcuts from another repository.
-
-## [0.14.2] - 2021-12-13
-
-- Fix `Module` bloating
-- Add `Operator` expressions
-- Add `__.coalesce` and `__.constant`
-- Add steps: `sum`, `sack`
-- Add configuration steps: `withSack`
-- Rename `Grumlin::Expressions::Tool` to `Grumlin::Expressions::Expression`
-
-
-## [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`
-- Allow executing any gremlin steps by name using `Grumlin::AnonymousStep#step`
-- Rename `Grumlin::Tools` to `Grumlin::Expressions`
-
-## [0.1.0] - 2021-05-25
-
-- Initial release