grumlin 0.12.3 → 0.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00ef8073cd7041cc5387001f87b0df929061a08d04cd574557cdcad46e6691ea
-  data.tar.gz: e9a4489348809e9d4c04732c5e0b25e0596c24d6bda0a47bb1d702c2aa91ba9d
+  metadata.gz: d5ddac28eac1cb06e427f52d8639b8a75bdc9b4c867aa353199a05a51d847696
+  data.tar.gz: 3ac77adec54d09b74ab1b620de484205cfbee52249cfa6e4529a5b988b228537
 SHA512:
-  metadata.gz: 88f52ea660162bc3fde8694ab100da0f334272017199b16b5221bbe90a35901afec72e870338e7541e402f5af0f2b9a8db7c6e867aacd78fa6af9c57bdef04e2
-  data.tar.gz: a72ffa18448d460e48ce320c7952f42a3c7f774dc17624650f8094b2107cba1bdb8b129f783f0de6c89ea02e17700796842f6fc3d0cb10db9c86c93161ccb387
+  metadata.gz: f5ced6bb8aca8250daba19e059bcf36dc5fb3fe31ded7b552ca297f858edd82203b1b178196a1b448952819a112d44c40ab64e85aeb9f0f5469e44f728a5a539
+  data.tar.gz: 6258168a26d952f31bb2087fef044914efb6c51d81355611954c3999d65a7e62f38bae0654da7f4213a40513093240acf673156547033bbf83de37f17313552f

data/Gemfile.lock

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

data/README.md

@@ -73,6 +73,52 @@ class MyRepository
 end
 ```
 
+#### IRB
+
+An example of how to start an IRB session with support for executing gremlin queries:
+
+```ruby
+Async do
+  include Grumlin::Sugar
+
+  IRB.start
+ensure
+  Grumlin.close
+end
+```
+
+Please check out [bin/console](bin/console) for full source. A similar trick may be applied to PRY.
+
+#### Rails console
+
+In order to make it possible to execute gremlin queries from the rails console you need to define
+a custom console class. It should look somehow like
+
+```ruby
+class MyRailsConsole
+  def self.start
+    IRB::WorkSpace.prepend(Rails::Console::BacktraceCleaner)
+    IRB::ExtendCommandBundle.include(Rails::ConsoleMethods)
+
+    Async do
+      include Grumlin::Sugar
+
+      IRB.setup(binding.source_location[0], argv: [])
+      workspace = IRB::WorkSpace.new(binding)
+
+      IRB::Irb.new(workspace).run(IRB.conf)
+    ensure
+      Grumlin.close
+    end
+  end
+end
+```
+
+Then you need to reference it in your application.rb:
+```ruby
+config.console = MyRailsConsole
+```
+
 #### Testing
 
 Grumlin provides a couple of helpers to simplify testing code written with it.

data/bin/console

@@ -3,7 +3,9 @@
 
 require "bundler/setup"
 require "grumlin"
+
 require "irb"
+require "irb/completion"
 
 Grumlin.configure do |config|
   config.url = ENV["GREMLIN_URL"] || "ws://localhost:8182/gremlin"
@@ -12,12 +14,7 @@ end
 Async do
   include Grumlin::Sugar
 
-  IRB.setup(nil)
-  workspace = IRB::WorkSpace.new(binding)
-  irb = IRB::Irb.new(workspace)
-  irb.eval_input
-rescue StandardError
-  raise
+  IRB.start
 ensure
   Grumlin.close
 end

data/lib/grumlin/anonymous_step.rb

@@ -5,10 +5,10 @@ module Grumlin
     attr_reader :name, :args, :previous_step
 
     # TODO: add other steps
-    SUPPORTED_STEPS = %i[E V addE addV as both by coalesce count dedup drop elementMap emit fold from group groupCount
-                         has hasId hasLabel hasNot id in inE inV label limit not order out outE path project property
-                         range repeat select sideEffect skip tail to unfold union until valueMap values where
-                         with].freeze
+    SUPPORTED_STEPS = %i[E V addE addV 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 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)
       @name = name

data/lib/grumlin/sugar.rb

@@ -2,21 +2,8 @@
 
 module Grumlin
   module Sugar
-    HELPERS = [
-      Grumlin::Tools::Order,
-      Grumlin::Tools::P,
-      Grumlin::Tools::Pop,
-      Grumlin::Tools::Scope,
-      Grumlin::Tools::T,
-      Grumlin::Tools::U,
-      Grumlin::Tools::WithOptions
-    ].freeze
-
     def self.included(base)
-      HELPERS.each do |helper|
-        name = helper.name.split("::").last
-        base.const_set(name, helper)
-      end
+      base.include Grumlin::Tools
     end
 
     def __

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

@@ -11,9 +11,8 @@ module Grumlin
         include Grumlin::Sugar
 
         before do
-          Grumlin::Sugar::HELPERS.each do |helper|
-            name = helper.name.split("::").last
-            stub_const(name, helper)
+          Grumlin::Tools.constants.each do |tool|
+            stub_const(tool.to_s, Grumlin::Tools.const_get(tool))
           end
         end
 

data/lib/grumlin/tools/u.rb

@@ -4,9 +4,8 @@ module Grumlin
   module Tools
     module U
       # TODO: add other start steps
-      SUPPORTED_STEPS = %i[V addV count drop fold has id inE inV label out outE outV project repeat timeLimit unfold
-                           valueMap
-                           values].freeze
+      SUPPORTED_STEPS = %i[V addV count drop fold has id in inE inV label out outE outV project repeat timeLimit unfold
+                           valueMap values].freeze
 
       class << self
         SUPPORTED_STEPS.each do |step|

data/lib/grumlin/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.12.4
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool