grumlin 0.4.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11e434ab0f5cd463d357e69dd3cbf5083f85a1bdd32e4d2c96023ce262704020
-  data.tar.gz: f24dd70f8b0abe9b370f77587d590802b32aa3e7b8a20380b9518004868cc6c7
+  metadata.gz: f6fc993f0e67d4bb4d7a97b3e2d64d692b334f862cb16c73349d222fdb21b95f
+  data.tar.gz: fb14fae220786a9f8b5654b271d344a24e09dcbaf565e998716e6465f6cc62f9
 SHA512:
-  metadata.gz: 5bfbd0d4db9ef46d35839b8ca5654cdc1f5038ee2c4ca004b678471380095d1fb587fa89a8df0c5a4769e3943ceb4e0b88734b701593ccf1047a05ab85baaaf5
-  data.tar.gz: a7d87e630e6b2076bedd079365e709018b3fc61f1577564c504593ffdeb4deab88f56d8785c30877489171b6c9d7fd245982475a75f4c639647c923e2ca296ef
+  metadata.gz: 14d22f47279dce78ccc70442ecaee502c8cf26547fa4a4ea679fb212699877e3bdda45af3fd957261bd4b77a2a410c5be20be9b80a6f239a3acb90d57e1daf40
+  data.tar.gz: 9b5fd78c4c8826e2459ed652b11bf611df64604086488a543687e8a8edb34913958df74dccd2bc0d08dc1eb2f1d0c608e0639c54aac956f5a164a66f8d1f2adb

data/.github/workflows/main.yml

@@ -1,6 +1,6 @@
 name: Ruby
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   lint:

data/.overcommit.yml

@@ -3,6 +3,3 @@ PreCommit:
     enabled: true
     on_warn: fail # Treat all warnings as failures
 
-PrePush:
-  RSpec:
-    enabled: true

data/.rubocop.yml

@@ -7,24 +7,44 @@ require:
   - rubocop-performance
   - rubocop-rspec
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/Documentation:
-  Enabled: false
-
 Layout/LineLength:
   Max: 120
+  Exclude:
+    - spec/**/*_spec.rb
 
 Metrics/BlockLength:
   Exclude:
     - spec/**/*_spec.rb
 
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ParameterLists:
+  Max: 6
+
+Naming/MethodName:
+  IgnoredPatterns:
+    - toList
+    - inVLabel
+    - outVLabel
+    - inV
+    - outV
+
+Naming/VariableName:
+  AllowedIdentifiers:
+    - inV
+    - outV
+    - inVLabel
+    - outVLabel
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - id
+    - inV
+    - outV
+    - inVLabel
+    - outVLabel
+
 RSpec/NamedSubject:
   Enabled: false
 
@@ -34,5 +54,26 @@ RSpec/NestedGroups:
 RSpec/ExampleLength:
   Enabled: false
 
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+Style/WordArray:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
 Style/MultilineBlockChain:
-  Enabled: false
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (0.4.0)
+    grumlin (0.6.1)
       async-pool (~> 0.3)
       async-websocket (~> 0.19)
 
@@ -70,7 +70,7 @@ GEM
       ast (~> 2.4.1)
     protocol-hpack (1.4.2)
     protocol-http (0.22.5)
-    protocol-http1 (0.14.1)
+    protocol-http1 (0.14.2)
       protocol-http (~> 0.22)
     protocol-http2 (0.14.2)
       protocol-hpack (~> 1.4)
@@ -166,4 +166,4 @@ DEPENDENCIES
   solargraph
 
 BUNDLED WITH
-   2.2.15
+   2.2.26

data/bin/console

@@ -10,7 +10,7 @@ Grumlin.configure do |config|
 end
 
 Async do
-  g = Grumlin::Traversal.new
+  include Grumlin::Sugar
 
   IRB.setup(nil)
   workspace = IRB::WorkSpace.new(binding)

data/lib/async/channel.rb

@@ -45,7 +45,7 @@ module Async
       end
     end
 
-    def each # rubocop:disable Metrics/MethodLength
+    def each
       raise(ChannelClosedError, "Cannot receive from a closed channel") if closed?
 
       @queue.each do |type, payload|

data/lib/grumlin/anonymous_step.rb

@@ -4,23 +4,23 @@ module Grumlin
   class AnonymousStep
     attr_reader :name, :args
 
+    # TODO: add other steps
+    SUPPORTED_STEPS = %w[E V addE addV as by coalesce count dedup drop elementMap emit fold from group groupCount has
+                         hasLabel hasNot in inV label limit not order out outE path project property repeat select to
+                         unfold valueMap values where].freeze
+
     def initialize(name, *args, previous_steps: [])
       @name = name
       @previous_steps = previous_steps
       @args = args
     end
 
-    %w[addV addE V E limit count drop property valueMap select from to as order by has hasLabel values hasNot
-       not outE groupCount label group in out fold unfold inV path dedup project coalesce repeat emit
-       elementMap where].each do |step|
+    SUPPORTED_STEPS.each do |step|
       define_method step do |*args|
         add_step(step, args, previous_steps: steps)
       end
     end
 
-    alias addVertex addV
-    alias addEdge addE
-
     def inspect
       @inspect ||= to_bytecode.to_s
     end

data/lib/grumlin/client.rb

@@ -49,8 +49,10 @@ module Grumlin
     end
 
     def close
-      @transport.close
-      raise ResourceLeakError, "Request list is not empty: #{requests}" if @request_dispatcher.requests.any?
+      @transport&.close
+      if @request_dispatcher&.requests&.any?
+        raise ResourceLeakError, "Request list is not empty: #{@request_dispatcher.requests}"
+      end
 
       reset!
     end
@@ -60,7 +62,7 @@ module Grumlin
     end
 
     # TODO: support yielding
-    def write(*args) # rubocop:disable Metrics/MethodLength
+    def write(*args)
       raise NotConnectedError unless connected?
 
       request_id = SecureRandom.uuid

data/lib/grumlin/edge.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-# rubocop:disable Naming/VariableName,Naming/MethodParameterName,Naming/MethodName
 module Grumlin
   class Edge
     attr_reader :label, :id, :inVLabel, :outVLabel, :inV, :outV
 
-    def initialize(label:, id:, inVLabel:, outVLabel:, inV:, outV:) # rubocop:disable Metrics/ParameterLists
+    def initialize(label:, id:, inVLabel:, outVLabel:, inV:, outV:)
       @label = label
       @id = Typing.cast(id)
       @inVLabel = inVLabel
@@ -24,4 +23,3 @@ module Grumlin
     alias to_s inspect
   end
 end
-# rubocop:enable Naming/MethodParameterName,Naming/VariableName,Naming/MethodName

data/lib/grumlin/order.rb

@@ -2,21 +2,16 @@
 
 module Grumlin
   module Order
-    module Order
-      DESC = { "@type": "g:Order", "@value": "desc" }.freeze
-      ASC = { "@type": "g:Order", "@value": "desc" }.freeze
+    # TODO: share the code?
+    class << self
+      %i[asc desc].each do |step|
+        define_method step do
+          name = "@#{step}"
+          return instance_variable_get(name) if instance_variable_defined?(name)
 
-      extend self # rubocop:disable Style/ModuleFunction
-
-      def asc
-        ASC
-      end
-
-      def desc
-        DESC
+          instance_variable_set(name, TypedValue.new("Order", step))
+        end
       end
     end
-
-    extend Order
   end
 end

data/lib/grumlin/p.rb

@@ -5,7 +5,7 @@ module Grumlin
     module P
       %w[within].each do |step|
         define_method step do |*args|
-          { # TODO: replace with a class?
+          { # TODO: replace with a TypedValue?
             "@type": "g:P",
             "@value": { predicate: "within", value: { "@type": "g:List", "@value": args } }
           }

data/lib/grumlin/pop.rb

@@ -2,31 +2,16 @@
 
 module Grumlin
   module Pop
-    module Pop
-      extend self # rubocop:disable Style/ModuleFunction
+    # TODO: share the code?
+    class << self
+      %i[first last all mixed].each do |step|
+        define_method step do
+          name = "@#{step}"
+          return instance_variable_get(name) if instance_variable_defined?(name)
 
-      FIRST = { "@type": "g:Pop", "@value": "first" }.freeze
-      LAST = { "@type": "g:Pop", "@value": "last" }.freeze
-      ALL = { "@type": "g:Pop", "@value": "all" }.freeze
-      MIXED = { "@type": "g:Pop", "@value": "mixed" }.freeze
-
-      def first
-        FIRST
-      end
-
-      def last
-        LAST
-      end
-
-      def all
-        ALL
-      end
-
-      def mixed
-        MIXED
+          instance_variable_set(name, TypedValue.new("Pop", step))
+        end
       end
     end
-
-    extend Pop
   end
 end

data/lib/grumlin/request_dispatcher.rb

@@ -36,7 +36,7 @@ module Grumlin
 
     # builds a response object, when it's ready sends it to the client via a channel
     # TODO: sometimes response does not include requestID, no idea how to handle it so far.
-    def add_response(response) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def add_response(response) # rubocop:disable Metrics/AbcSize
       request_id = response[:requestId]
       raise "ERROR" unless ongoing_request?(request_id)
 

data/lib/grumlin/step.rb

@@ -14,7 +14,7 @@ module Grumlin
       @enum.next
     end
 
-    def toList # rubocop:disable Naming/MethodName
+    def toList
       @pool.acquire do |client|
         client.write(*steps)
       end

data/lib/grumlin/sugar.rb

@@ -2,7 +2,6 @@
 
 module Grumlin
   module Sugar
-    # TODO: how to use it in specs?
     HELPERS = [
       Grumlin::U,
       Grumlin::T,
@@ -12,25 +11,12 @@ module Grumlin
     ].freeze
 
     def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def const_missing(name)
-        helper = HELPERS.find { |h| h.const_defined?(name) }
-        super if helper.nil?
-
-        const_set(name, helper)
+      HELPERS.each do |helper|
+        name = helper.name.split("::").last
+        base.const_set(name, helper)
       end
     end
 
-    def const_missing(name)
-      helper = HELPERS.find { |h| h.const_defined?(name) }
-      super if helper.nil?
-
-      const_set(name, helper)
-    end
-
     def __
       Grumlin::U
     end

data/lib/grumlin/t.rb

@@ -2,21 +2,16 @@
 
 module Grumlin
   module T
-    module T
-      T_ID = { :@type => "g:T", :@value => "id" }.freeze # TODO: replace with a class?
-      T_LABEL = { :@type => "g:T", :@value => "label" }.freeze # TODO: replace with a class?
+    # TODO: share the code?
+    class << self
+      %i[id label].each do |step|
+        define_method step do
+          name = "@#{step}"
+          return instance_variable_get(name) if instance_variable_defined?(name)
 
-      extend self # rubocop:disable Style/ModuleFunction
-
-      def id
-        T_ID
-      end
-
-      def label
-        T_LABEL
+          instance_variable_set(name, TypedValue.new("T", step))
+        end
       end
     end
-
-    extend T
   end
 end

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

@@ -8,8 +8,14 @@ module Grumlin
 
       ::RSpec.shared_context GremlinContext do
         include GremlinContext
+        include Grumlin::Sugar
 
-        let(:g) { Grumlin::Traversal.new }
+        before do
+          Grumlin::Sugar::HELPERS.each do |helper|
+            name = helper.name.split("::").last
+            stub_const(name, helper)
+          end
+        end
 
         after do
           Grumlin.config.default_pool.close

data/lib/grumlin/translator.rb

@@ -20,6 +20,7 @@ module Grumlin
       private
 
       def arg_to_bytecode(arg)
+        return arg.to_bytecode if arg.is_a?(TypedValue)
         return arg unless arg.is_a?(AnonymousStep)
 
         args = arg.args.flatten.map do |a|
@@ -30,8 +31,11 @@ module Grumlin
 
       def arg_to_query_bytecode(arg)
         return ["none"] if arg.nil?
+        return arg.to_bytecode if arg.is_a?(TypedValue)
         return arg unless arg.is_a?(AnonymousStep)
 
+        # return arg.to_bytecode if arg.is_a?(TypedValue)
+
         args = arg.args.flatten.map do |a|
           a.instance_of?(AnonymousStep) ? Typing.to_bytecode(to_bytecode(a.steps)) : arg_to_query_bytecode(a)
         end

data/lib/grumlin/transport.rb

@@ -20,7 +20,7 @@ module Grumlin
       @connected
     end
 
-    def connect # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def connect # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       raise AlreadyConnectedError if connected?
 
       @connection = Async::WebSocket::Client.connect(Async::HTTP::Endpoint.parse(@url), **@client_options)
@@ -56,7 +56,7 @@ module Grumlin
       @request_channel << message
     end
 
-    def close # rubocop:disable Metrics/MethodLength
+    def close
       return unless connected?
 
       @request_channel.close

data/lib/grumlin/traversal.rb

@@ -4,18 +4,17 @@ module Grumlin
   class Traversal
     attr_reader :connection
 
+    # TODO: add other start steps
+    SUPPORTED_START_STEPS = %w[E V addE addV].freeze
+
     def initialize(pool = Grumlin.config.default_pool)
       @pool = pool
     end
 
-    # TODO: add other start steps
-    %w[addV addE V E].each do |step|
+    SUPPORTED_START_STEPS.each do |step|
       define_method step do |*args|
         Step.new(@pool, step, *args)
       end
     end
-
-    alias addVertex addV
-    alias addEdge addE
   end
 end

data/lib/grumlin/typed_value.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Grumlin
+  # TODO: find a better name
+  class TypedValue
+    def initialize(type, value)
+      @type = type
+      @value = value
+    end
+
+    def inspect(*)
+      "#{@type}.#{@value}"
+    end
+
+    def to_bytecode
+      @to_bytecode ||= { "@type": "g:#{@type}", "@value": @value }
+    end
+  end
+end

data/lib/grumlin/u.rb

@@ -2,17 +2,15 @@
 
 module Grumlin
   module U
-    module U
-      extend self # rubocop:disable Style/ModuleFunction
+    # TODO: add other start steps
+    SUPPORTED_START_STEPS = %w[V addV count has out unfold values].freeze
 
-      %w[addV V has count out values unfold].each do |step|
+    class << self
+      SUPPORTED_START_STEPS.each do |step|
         define_method step do |*args|
           AnonymousStep.new(step, *args)
         end
       end
     end
-
-    # TODO: add alias __
-    extend U
   end
 end

data/lib/grumlin/version.rb

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

data/lib/grumlin.rb

@@ -19,6 +19,7 @@ require_relative "grumlin/exceptions"
 
 require_relative "grumlin/transport"
 require_relative "grumlin/client"
+require_relative "grumlin/typed_value"
 
 require_relative "grumlin/vertex"
 require_relative "grumlin/edge"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -50,6 +50,7 @@ files:
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -82,6 +83,7 @@ files:
 - lib/grumlin/translator.rb
 - lib/grumlin/transport.rb
 - lib/grumlin/traversal.rb
+- lib/grumlin/typed_value.rb
 - lib/grumlin/typing.rb
 - lib/grumlin/u.rb
 - lib/grumlin/version.rb