grumlin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49bd6724ef81d1ac81e11d07d353b1f474ffaa60616dfab291d3f43ae81f95aa
+  data.tar.gz: 8023ce32bede0aadaed1c0495654b5d2bec8e244deb007b766561254b7c9b69e
+SHA512:
+  metadata.gz: 434d14086ce4814684de2f414ba9eb9e5dd24f5a96b4acb0861b526f1515ad13dff96d5460d871e8373335f38baae013c248815d08e0ff2616a6ace873e1316a
+  data.tar.gz: e5fd01d1b8743d263097449f1f17ae515073e6253c7d7cfc11e65e923870b695c5d0a482105a41c20cea2a401f4cd2ffab3282defa74d0e9ed739e60fd850ead

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+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
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at zhulik.gleb@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rspec"
+
+gem "solargraph"
+
+gem "async-rspec"
+gem "factory_bot"
+gem "rspec"
+gem "simplecov"

data/Gemfile.lock

@@ -0,0 +1,162 @@
+PATH
+  remote: .
+  specs:
+    grumlin (0.1.0)
+      async-websocket (~> 0.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    async (1.29.0)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-http (0.56.2)
+      async (~> 1.25)
+      async-io (~> 1.28)
+      async-pool (~> 0.2)
+      protocol-http (~> 0.22.0)
+      protocol-http1 (~> 0.14.0)
+      protocol-http2 (~> 0.14.0)
+    async-io (1.31.0)
+      async (~> 1.14)
+    async-pool (0.3.6)
+      async (~> 1.25)
+    async-rspec (1.16.0)
+      rspec (~> 3.0)
+      rspec-files (~> 1.0)
+      rspec-memory (~> 1.0)
+    async-websocket (0.18.0)
+      async-http (~> 0.54)
+      async-io (~> 1.23)
+      protocol-websocket (~> 0.7.0)
+    backport (1.1.2)
+    benchmark (0.1.1)
+    concurrent-ruby (1.1.8)
+    console (1.12.0)
+      fiber-local
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    e2mmap (0.1.0)
+    factory_bot (6.2.0)
+      activesupport (>= 5.0.0)
+    fiber-local (1.0.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.5-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    protocol-hpack (1.4.2)
+    protocol-http (0.22.0)
+    protocol-http1 (0.14.1)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.14.2)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
+    protocol-websocket (0.7.5)
+      protocol-http (~> 0.2)
+      protocol-http1 (~> 0.2)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    reverse_markdown (2.0.0)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-files (1.1.1)
+      rspec (~> 3.0)
+    rspec-memory (1.0.2)
+      rspec (~> 3.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.15.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    solargraph (0.40.4)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.1.0)
+    tilt (2.0.10)
+    timers (4.3.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  async-rspec
+  factory_bot
+  grumlin!
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  simplecov
+  solargraph
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Gleb Sinyavskiy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Grumlin
+
+[Gremlin](https://tinkerpop.apache.org/gremlin.html) query language DSL for Ruby
+
+**In development. Nothing to write here yet. If you are really interested, check out the source code and the specs.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grumlin'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install grumlin
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grumlin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/grumlin/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Grumlin project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/grumlin/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "grumlin"
+require "irb"
+
+Async do
+  client = Grumlin::Client.new("ws://localhost:8182/gremlin", mode: :bytecode)
+  g = Grumlin::Traversal.new(client)
+
+  IRB.setup(nil)
+  workspace = IRB::WorkSpace.new(binding)
+  irb = IRB::Irb.new(workspace)
+  irb.eval_input
+rescue StandardError
+  raise
+ensure
+  client.disconnect
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/stress

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "grumlin"
+require "irb"
+
+def queries(client, uuids)
+  total = 0
+  g = Grumlin::Traversal.new(client)
+
+  loop do
+    uuid = uuids.sample
+    result = g.V(uuid).toList[0]
+    raise "!!!" if result.id != uuid
+
+    total += 1
+  end
+rescue Async::Stop
+  total
+end
+
+def prepare_dataset(client)
+  uuids = Array.new(1000) { SecureRandom.uuid }
+
+  Grumlin::Traversal.new(client) do
+    g.V().drop
+
+    uuids.each do |uuid|
+      g.addV("test_vertex").property(id, uuid).toList
+    end
+  end
+
+  uuids
+end
+
+Async do |task|
+  client = Grumlin::Client.new("ws://localhost:8182/gremlin", mode: :bytecode)
+
+  uuids = prepare_dataset(client)
+  tasks = Array.new(20) { task.async { queries(client, uuids) } }
+
+  task.sleep(60)
+
+  tasks.each(&:stop)
+  total = tasks.sum(&:wait)
+
+  p("#{total} requests performed")
+ensure
+  client.disconnect
+end

data/grumlin.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/grumlin/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "grumlin"
+  spec.version       = Grumlin::VERSION
+  spec.authors       = ["Gleb Sinyavskiy"]
+  spec.email         = ["zhulik.gleb@gmail.com"]
+
+  spec.summary       = "A ruby client for Gremlin query language."
+  spec.description   = "A ruby client for Gremlin query language."
+  spec.homepage      = "https://github.com/zhulik/grumlin"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  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.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "async-websocket", "~> 0.18"
+end

data/lib/grumlin.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "json"
+
+require "async"
+require "async/queue"
+require "async/http/endpoint"
+require "async/websocket/client"
+
+require_relative "grumlin/version"
+require_relative "grumlin/exceptions"
+
+require_relative "grumlin/vertex"
+require_relative "grumlin/edge"
+require_relative "grumlin/typing"
+require_relative "grumlin/client"
+require_relative "grumlin/traversal"
+require_relative "grumlin/step"
+require_relative "grumlin/translator"
+require_relative "grumlin/traversing_context"
+
+module Grumlin
+end

data/lib/grumlin/client.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Client # rubocop:disable Metrics/ClassLength
+    SUCCESS_STATUS = 200
+    NO_CONTENT_STATUS = 204
+    PARTIAL_CONTENT_STATUS = 206
+
+    ERRORS = {
+      499 => InvalidRequestArgumentsError,
+      500 => ServerError,
+      597 => ScriptEvaluationError,
+      599 => ServerSerializationError,
+      598 => ServerTimeoutError,
+
+      401 => ClientSideError,
+      407 => ClientSideError,
+      498 => ClientSideError
+    }.freeze
+
+    def initialize(url, task: Async::Task.current, autoconnect: true, mode: :bytecode)
+      @task = task
+      @endpoint = Async::HTTP::Endpoint.parse(url)
+      @mode = mode
+
+      @requests = {}
+      @query_queue = Async::Queue.new
+
+      connect if autoconnect
+    end
+
+    def connect # rubocop:disable Metrics/MethodLength
+      raise AlreadyConnectedError unless @connection_task.nil?
+
+      @connection_task = @task.async do |subtask|
+        Async::WebSocket::Client.connect(@endpoint) do |connection|
+          subtask.async { query_task(connection) }
+          response_task(connection)
+        end
+      rescue StandardError => e
+        @requests.each_value do |queue|
+          queue << [:error, e]
+        end
+        disconnect
+      end
+    end
+
+    def disconnect
+      raise NotConnectedError if @connection_task.nil?
+
+      @connection_task&.stop
+      @connection_task&.wait
+      @connection_task = nil
+      @requests = {}
+    end
+
+    def query(*args) # rubocop:disable Metrics/MethodLength
+      response_queue, request_id = schedule_query(args)
+      result = []
+
+      response_queue.each do |status, response|
+        reraise_error!(response) if status == :error
+
+        status = response[:status]
+
+        if status[:code] == NO_CONTENT_STATUS
+          close_request(request_id)
+          return []
+        end
+
+        check_errors!(status, request_id)
+
+        page = Typing.cast(response.dig(:result, :data))
+
+        case status[:code]
+        when SUCCESS_STATUS
+          close_request(request_id)
+          return result + page
+        when PARTIAL_CONTENT_STATUS
+          result += page
+        else
+          raise UnknownResponseStatus, status
+        end
+      end
+    end
+
+    private
+
+    def schedule_query(args)
+      uuid = SecureRandom.uuid
+      queue = Async::Queue.new
+      @requests[uuid] = queue
+      @query_queue << to_query(uuid, args)
+
+      [queue, uuid]
+    end
+
+    def to_query(uuid, message)
+      case message.first
+      when String
+        string_query_message(uuid, *message)
+      when Grumlin::Step
+        build_query(uuid, message)
+      end
+    end
+
+    def check_errors!(status, request_id)
+      error = ERRORS[status[:code]]
+      close_request(request_id)
+      raise(error, status) if error
+    end
+
+    def close_request(request_id)
+      @requests.delete(request_id)
+    end
+
+    def reraise_error!(error)
+      raise error
+    rescue StandardError
+      raise ConnectionError
+    end
+
+    def query_task(connection)
+      loop do
+        connection.write @query_queue.dequeue
+        connection.flush
+      end
+    end
+
+    def response_task(connection)
+      loop do
+        response = connection.read
+        response_queue = @requests[response[:requestId]]
+        response_queue << [:response, response]
+      end
+    end
+
+    def string_query_message(uuid, query, bindings)
+      {
+        requestId: uuid,
+        op: "eval",
+        processor: "",
+        args: {
+          gremlin: query,
+          bindings: bindings,
+          language: "gremlin-groovy"
+        }
+      }
+    end
+
+    def bytecode_query_message(uuid, bytecode)
+      {
+        requestId: uuid,
+        op: "bytecode",
+        processor: "traversal",
+        args: {
+          gremlin: { "@type": "g:Bytecode", "@value": { step: bytecode } },
+          aliases: { g: :g }
+        }
+      }
+    end
+
+    def build_query(uuid, steps)
+      case @mode
+      when :string
+        string_query_message(uuid, *Translator.to_string_query(steps))
+      else
+        bytecode_query_message(uuid, Translator.to_bytecode_query(steps))
+      end
+    end
+  end
+end

data/lib/grumlin/edge.rb

@@ -0,0 +1,27 @@
+# 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
+      @label = label
+      @id = Typing.cast(id)
+      @inVLabel = inVLabel
+      @outVLabel = outVLabel
+      @inV = Typing.cast(inV)
+      @outV = Typing.cast(outV)
+    end
+
+    def ==(other)
+      @label == other.label && @id == other.id
+    end
+
+    def inspect
+      "<E #{@label}(#{@id})>"
+    end
+    alias to_s inspect
+  end
+end
+# rubocop:enable Naming/MethodParameterName,Naming/VariableName,Naming/MethodName

data/lib/grumlin/exceptions.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Error < StandardError; end
+
+  class ConnectionError < Error; end
+
+  class ConnectionStatusError < Error; end
+
+  class NotConnectedError < ConnectionStatusError; end
+
+  class AlreadyConnectedError < ConnectionStatusError; end
+
+  class ProtocolError < Error; end
+
+  class UnknownResponseStatus < ProtocolError
+    attr_reader :status
+
+    def initialize(status)
+      super("unknown response status code #{status[:code]}")
+      @status = status
+    end
+  end
+
+  class UnknownTypeError < ProtocolError; end
+
+  class ConnectionClosedError < Error; end
+
+  class StatusError < Error
+    attr_reader :status
+
+    def initialize(status)
+      super(status[:message])
+      @status = status
+    end
+  end
+
+  class ClientSideError < StatusError; end
+
+  class ServerSideError < StatusError; end
+
+  class ScriptEvaluationError < ServerSideError; end
+
+  class InvalidRequestArgumentsError < ServerSideError; end
+
+  class ServerError < ServerSideError; end
+
+  class ServerSerializationError < ServerSideError; end
+
+  class ServerTimeoutError < ServerSideError; end
+end

data/lib/grumlin/step.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Step
+    attr_reader :client, :name, :args
+
+    # TODO: add support for bytecode
+    def initialize(client, name, *args, previous_steps: [])
+      @client = client
+      @name = name
+      @previous_steps = previous_steps
+      @args = args
+    end
+
+    %w[addV addE V E limit count drop property valueMap select from to as].each do |step|
+      define_method step do |*args|
+        Step.new(@client, step, *args, previous_steps: steps)
+      end
+    end
+
+    alias addVertex addV
+    alias addEdge addE
+
+    # TODO: add support for next
+    # TODO: add support for iterate
+    # TODO: memoization
+    def toList # rubocop:disable Naming/MethodName
+      @client.query(*steps)
+    end
+
+    def inspect
+      "<Step #{self}>" # TODO: substitute bindings
+    end
+
+    # TODO: memoization
+    def to_s(*)
+      Translator.to_string(steps)
+    end
+
+    alias to_gremlin to_s
+
+    def steps
+      (@previous_steps + [self])
+    end
+  end
+end

data/lib/grumlin/translator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module Translator
+    class << self
+      def to_string_query(steps) # rubocop:disable Metrics/MethodLength
+        counter = 0
+        string_steps, bindings = steps.each_with_object([[], {}]) do |step, (acc_g, acc_b)|
+          args = step.args.map do |arg|
+            binding_name(counter).tap do |b|
+              acc_b[b] = arg
+              counter += 1
+            end
+          end.join(", ")
+
+          acc_g << "#{step.name}(#{args})"
+        end
+
+        ["g.#{string_steps.join(".")}", bindings]
+      end
+
+      def to_bytecode_query(steps)
+        steps.map do |step|
+          [step.name, *step.args.flatten]
+        end
+      end
+
+      def to_string(steps)
+        "g." + steps.map do |step| # rubocop:disable Style/StringConcatenation
+          "#{step.name}(#{step.args.map(&:inspect).join(", ")})"
+        end.join(".")
+      end
+
+      private
+
+      def binding_name(num)
+        "b_#{num.to_s(16)}"
+      end
+    end
+  end
+end

data/lib/grumlin/traversal.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Traversal
+    attr_reader :connection
+
+    def initialize(client_or_url, &block)
+      @client = if client_or_url.is_a?(String)
+                  Grumlin::Client.new(client_or_url)
+                else
+                  client_or_url
+                end
+
+      return if block.nil?
+
+      TraversingContext.new(self).instance_exec(&block)
+    end
+
+    %w[addV addE V E].each do |step|
+      define_method step do |*args|
+        Step.new(@client, step, *args)
+      end
+    end
+
+    alias addVertex addV
+    alias addEdge addE
+  end
+end

data/lib/grumlin/traversing_context.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class TraversingContext
+    ID = { :@type => "g:T", :@value => "id" }.freeze
+
+    attr_reader :g
+
+    def initialize(traversal)
+      @g = traversal
+    end
+
+    def id
+      ID
+    end
+  end
+end

data/lib/grumlin/typing.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Grumlin
+  module Typing
+    TYPES = {
+      "g:List" => ->(value) { value.map { |item| cast(item) } },
+      "g:Map" => ->(value) { cast_map(value) },
+      "g:Vertex" => ->(value) { cast_entity(Grumlin::Vertex, value) },
+      "g:Edge" => ->(value) { cast_entity(Grumlin::Edge, value) },
+      "g:Int64" => ->(value) { cast_int(value) },
+      "g:Int32" => ->(value) { cast_int(value) },
+      "g:Traverser" => ->(value) { cast(value[:value]) } # TODO: wtf is bulk?
+    }.freeze
+
+    CASTABLE_TYPES = [Hash, String, Integer].freeze
+
+    class << self
+      def cast(value)
+        verify_type!(value)
+
+        return value unless value.is_a?(Hash)
+
+        type = TYPES[value[:@type]]
+
+        verify_castable_hash!(value, type)
+
+        type.call(value[:@value])
+      end
+
+      private
+
+      def castable_type?(value); end
+
+      def verify_type!(value)
+        raise TypeError, "#{value.inspect} cannot be casted" unless CASTABLE_TYPES.any? { |t| value.is_a?(t) }
+      end
+
+      def verify_castable_hash!(value, type)
+        raise TypeError, "#{value} cannot be casted, @type is missing" if value[:@type].nil?
+        raise(UnknownTypeError, value[:@type]) if type.nil?
+        raise TypeError, "#{value} cannot be casted, @value is missing" if value[:@value].nil?
+      end
+
+      def cast_int(value)
+        raise TypeError, "#{value} is not an Integer" unless value.is_a?(Integer)
+
+        value
+      end
+
+      def cast_entity(entity, value)
+        entity.new(**value)
+      rescue ArgumentError, TypeError
+        raise TypeError, "#{value} cannot be casted to #{entity.name}"
+      end
+
+      def cast_map(value)
+        Hash[*value].transform_keys(&:to_sym).transform_values { |v| cast(v) }
+      rescue ArgumentError
+        raise TypeError, "#{value} cannot be casted to Hash"
+      end
+
+      def cast_traverser(value); end
+    end
+  end
+end

data/lib/grumlin/version.rb

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

data/lib/grumlin/vertex.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Grumlin
+  class Vertex
+    attr_reader :label, :id
+
+    def initialize(label:, id:)
+      @label = label
+      @id = Typing.cast(id)
+    end
+
+    def ==(other)
+      @label == other.label && @id == other.id
+    end
+
+    def inspect
+      "<V #{@label}(#{@id})>"
+    end
+    alias to_s inspect
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: grumlin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gleb Sinyavskiy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: A ruby client for Gremlin query language.
+email:
+- zhulik.gleb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/stress
+- grumlin.gemspec
+- lib/grumlin.rb
+- lib/grumlin/client.rb
+- lib/grumlin/edge.rb
+- lib/grumlin/exceptions.rb
+- lib/grumlin/step.rb
+- lib/grumlin/translator.rb
+- lib/grumlin/traversal.rb
+- lib/grumlin/traversing_context.rb
+- lib/grumlin/typing.rb
+- lib/grumlin/version.rb
+- lib/grumlin/vertex.rb
+homepage: https://github.com/zhulik/grumlin
+licenses:
+- MIT
+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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: A ruby client for Gremlin query language.
+test_files: []