grumlin 1.0.3.beta1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0847a31473aed3069f3be335c5d0c3ac6a141ddda2d9aacfece3fc33c978b11
-  data.tar.gz: 23fed7d1dd57280837eb3eee0bd2d0f1486d1c67de333318f8f8407bc1d856d3
+  metadata.gz: d316bc1f39fbcec938151fb11d7e43f1043c0951062856bfe489651d41732f59
+  data.tar.gz: 7c3e294d9f38d1045a7ff991f07a27142ec92bbeee4a2b805c59dadcfb609dcf
 SHA512:
-  metadata.gz: ef438dddc2ffdf9115878158d8b46292a037443150a22fa4bf1742d237ffdaac70d16d03ad701d7e56ac0898aeccb6781fa1bb272f4cc27374d400c805005358
-  data.tar.gz: 8ce183413c705cf2254d37357e250da77bd257dd1c57ce2cd526e9b28cfedb9aa2450d5b1625bcef559c6533d7ee550a6b3c4358831e0fb06f64ae2745496bf2
+  metadata.gz: 57987319c44b8f6a344b8a33d29c0380865857fdcec6c7fc536de7cd7282cd6804b846d9410a4e90d9eb0f22d8ac98ab9c06cd21b065fa7dce3e8e6e3b70d054
+  data.tar.gz: b4349848f8647a56ac01ed542743d16196526612ef2755781a47e7c0da70119ead2a67ac5123d02a8f563aec0215ec1c6af46896739aa83050c35921935e014f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (1.0.3.beta1)
+    grumlin (1.0.3)
       async-pool (~> 0.3.0)
       async-websocket (~> 0.22.0)
       ibsciss-middleware (~> 0.4.0)

data/README.md

@@ -262,7 +262,7 @@ Middlewares can be used to perform certain actions before and after every query
 measuring query execution time or performing some modification or validation to the query before it reaches the server or
 modify the response before client gets it.
 
-See [doc/middlewares.md](doc/middlewares.md) for more info and examples.
+See [docs/middlewares.md](docs/middlewares.md) for more info and examples.
 
 #### Transactions
 
@@ -379,7 +379,7 @@ See [docs/neptune.md](./docs/neptune.md)
 
 #### Sidekiq
 
-See [docs/neptune.md](./docs/sidekiq.md)
+See [docs/sidekiq.md](./docs/sidekiq.md)
 
 ## Development
 

data/lib/grumlin/dummy_transaction.rb

@@ -14,11 +14,9 @@ class Grumlin::DummyTransaction < Grumlin::Transaction
     end
   end
 
-  def commit
-    nil
-  end
+  private
 
-  def rollback
-    nil
+  def finalize(*)
+    @pool.close
   end
 end

data/lib/grumlin/repository/instance_methods.rb

@@ -6,7 +6,7 @@ module Grumlin::Repository::InstanceMethods # rubocop:disable Metrics/ModuleLeng
   extend Forwardable
 
   def_delegator "self.class", :shortcuts
-  def_delegator :self, :__, :g
+  def_delegator :shortcuts, :__
 
   UPSERT_RETRY_PARAMS = {
     on: [Grumlin::AlreadyExistsError, Grumlin::ConcurrentModificationError],
@@ -17,8 +17,8 @@ module Grumlin::Repository::InstanceMethods # rubocop:disable Metrics/ModuleLeng
 
   DEFAULT_ERROR_HANDLING_STRATEGY = Grumlin::Repository::ErrorHandlingStrategy.new(mode: :retry, **UPSERT_RETRY_PARAMS)
 
-  def __
-    shortcuts.traversal_start_class.new(pool: Grumlin.default_pool, middlewares: self.class.middlewares)
+  def g
+    shortcuts.g(middlewares: self.class.middlewares)
   end
 
   def drop_vertex(id, start: g)

data/lib/grumlin/shortcuts/storage.rb

@@ -35,7 +35,7 @@ class Grumlin::Shortcuts::Storage
     sc = step_class
 
     shortcut_methods_module.define_method(name) do |*args, **params|
-      next sc.new(name, args: args, params: params, previous_step: self, pool: Grumlin.default_pool)
+      next sc.new(name, args: args, params: params, previous_step: self, pool: pool)
     end
     extend_traversal_classes(shortcut) unless shortcut.lazy?
   end
@@ -46,8 +46,12 @@ class Grumlin::Shortcuts::Storage
     end
   end
 
+  def g(middlewares: Grumlin.default_middlewares)
+    traversal_start_class.new(pool: Grumlin.default_pool, middlewares: middlewares)
+  end
+
   def __
-    traversal_start_class.new(pool: Grumlin.default_pool)
+    traversal_start_class.new
   end
 
   def traversal_start_class

data/lib/grumlin/steppable.rb

@@ -3,7 +3,7 @@
 class Grumlin::Steppable
   extend Forwardable
 
-  attr_reader :session_id
+  attr_reader :session_id, :pool
 
   START_STEPS = Grumlin.definitions.dig(:steps, :start).map(&:to_sym).freeze
   REGULAR_STEPS = Grumlin.definitions.dig(:steps, :regular).map(&:to_sym).freeze

data/lib/grumlin/transaction.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Grumlin::Transaction
-  attr_reader :session_id
+  attr_reader :session_id, :pool
 
   include Console
 
@@ -34,5 +34,7 @@ class Grumlin::Transaction
                       need_results: false,
                       session_id: @session_id,
                       pool: @pool)
+  ensure
+    @pool.close
   end
 end

data/lib/grumlin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Grumlin
-  VERSION = "1.0.3.beta1"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 1.0.3.beta1
+  version: 1.0.3
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-19 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -118,7 +118,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- doc/middlewares.md
 - docker-compose.yml
 - docs/neptune.md
 - docs/sidekiq.md
@@ -217,9 +216,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.33
 signing_key: 

data/doc/middlewares.md

@@ -1,97 +0,0 @@
-# Middlewares
-
-Every single query performed by `Grumlin` goes through a stack of middlewares just like every single request in Rails 
-or many other web frameworks. `Grumlin` ships with a set of middlewares, each one performs some part of the query
-execution process:
-
-- `Middlewares::SerializeToSteps` - converts a `Step` into `Steps`
-- `Middlewares::ApplyShortcuts` - applies shortcuts to `Steps`
-- `Middlewares::SerializeToBytecode` - converts `Steps` into bytecode
-- `Middlewares::BuildQuery` - builds an actual message that will be send to server
-- `Middlewares::CastResults` - casts server response into ruby objects
-- `Middlewares::RunQuery` - actually sends the message to the server
-
-Normally these middlewares must never be rearranged or removed from the stack. Middlewares added after
-`Middlewares::RunQuery` will not be executed.
-
-## Writing a middleware for Grumlin
-
-This entire feature is built on top of [ibsciss-middleware](https://github.com/Ibsciss/ruby-middleware) but uses a
-slightly modified `Builder` which caches the chain for better performance.
-Please refer to ibsciss-middleware docs if you want to implement a middleware.
-
-
-A minimal middleware that measures query execution time and puts it back to `env`:
-
-```ruby
-class MeasureExecutionTime < Grumlin::Middlewares::Middleware # Middleware provides only an initializer with one argument for `app`
-  def call(env)
-    started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    result = @app.call(env)
-    env[:execution_time] = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started
-    result
-  end
-end
-```
-
-When placed right before `Grumlin::Middlewares::CastResults` your middleware will have access to every intermediate result
-of the query execution process:
-- `env[:traversal]` - contains the original traversal
-- `env[:steps]` - contains the `Steps` representing the traversal
-- `env[:steps_without_shortcuts]` - contains the `Steps` representing the traversal, but with all shortcuts applied
-- `env[:bytecode]` - raw bytecode of the traversal
-- `env[:query]` - raw message that will be sent to the server. `requestId` can be found here: `env[:query][:requestId]`
-
-After the query is performed (after `@app.call(env)`), these keys become available:
-- `env[:results]` - raw results received from the server
-- `env[:parsed_results]` - server results mapped to ruby types, basically the query results as the client gets it
-
-Other useful parts of `env`:
-- `env[:session_id]` - id of the session when executed inside a transaction, otherwise `nil`
-- `env[:pool]` - connection pool that will be used to interact with the server
-- `env[:need_results]` - flag stating whether the client needs the query execution results(`toList`, `next`) or not(`iterate`)
-
-## Adding your middleware to the stack
-
-There are two ways of adding middlewares to your queries:
-- `global` - add the middleware to every single query from every single repository
-- `per repository` - add the middleware to queries performed by particular repositories
-
-Grumlin has one global middleware stack and every repository defines it's which is by default is a
-copy of the global stack. This means one can easily modify repository's stack without worrying about the global one.
-
-When inherited a class extending `Grumlin::Repository` will copy it's middlewares to the subclass, they can also be
-modified independently from the parent's middlewares.
-
-### Adding a middleware globally
-```ruby
-Grumlin.configure do |cfg|
-  cfg.url = ENV.fetch("GREMLIN_URL", "ws://localhost:8182/gremlin")
-  cfg.provider = :tinkergraph
-
-  cfg.middlewares do |b|
-    b.insert_before Grumlin::Middlewares::CastResults, MeasureExecutionTime
-  end
-end
-```
-
-### Adding a middleware to a repository
-```ruby
-class MyRepository
-  # MyRepository inherits a copy of global middlewares
-  extend Grumlin::Repository
-
-  # SomeOtherMiddleware will be added to MyRepository's middlewares only
-  middlewares do |b|
-    b.insert_before Grumlin::Middlewares::CastResults, MeasureExecutionTime
-  end
-end
-
-class AnotherRepository < MyRepository
-  # AnotherRepository inherits parent's middlewares
-  middlewares do |b|
-    # SomeOtherMiddleware will be added to AnotherRepository's middlewares only 
-    b.insert_before Grumlin::Middlewares::CastResults, SomeOtherMiddleware
-  end
-end
-```