rql_parser 0.0.1alpha3 → 0.0.1alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d59c753d26bd53b0ad5a268acb1ce5b4bcb40f1d4f0682f2834e5dab4bafa968
-  data.tar.gz: 37c54da788af245b197765af41ec6069cc16b829bf47bed9f3bdc6d8c85a1d21
+  metadata.gz: 75d3efb4c2d93963bc05ad192108c57e964d3224b11d5bf0291bd69a2f652ffe
+  data.tar.gz: 99270a824bf63557ce93e29b1db68491f971c5189119b8431356b0cb2444cafc
 SHA512:
-  metadata.gz: 067bca6a134e1c4e93d4db0bd75a87ad709f25c1d5bc6dbc398d8040a09e4bd6a0396285e8e963add7d828903b65b3303118c64f7224025dfc07fddafc2be490
-  data.tar.gz: 4fd670220b3f9694d70d5bc42c30a957b2e740ce17f1d648bee1349a274863de6c9eb0c09fbed016c7863e64316b252a3394793e9fdff3da6c41d9be5f5b6ab2
+  metadata.gz: 7598c3cd3007ac838fce30b144f0a3c181313a95855496697d538efbb608b9096779d8a06f6ea2d2fbece42128c65ac4a70aec9b39e6d6cfb8fe3603b079500b
+  data.tar.gz: acc40e93395fcbd2012fa7961c291d46bee87eaa75969155f0cfa8797cca99f94fe9a0c1a25e4d5955148acfba0bcd591dbf86a47222bd8bc78201290da38643

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+  Max: 40
+Metrics/LineLength:
+  Max: 120
+Metrics/AbcSize:
+  Max: 20

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+#### 0.0.1alpha4
+
+- Restructure gem files
+- Fix some code style issues
+- Rework gem endpoints
+
+---
+
+#### 0.0.1alpha3
+
+- Release a first working version of a gem

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in rql_parser.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rql_parser (0.0.1alpha1)
+    rql_parser (0.0.1alpha3)
       active_interaction (~> 3.6.0)
 
 GEM
@@ -17,10 +17,24 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
     i18n (1.3.0)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -32,6 +46,7 @@ DEPENDENCIES
   bundler (~> 1.17)
   rake (~> 10.0)
   rql_parser!
+  rspec (~> 3.8.0)
 
 BUNDLED WITH
    1.17.1

data/README.md

@@ -18,14 +18,19 @@ Or install it yourself as:
 
 ## Usage
 
-See [ActiveInteraction](https://github.com/AaronLasseigne/active_interaction)
+See [ActiveInteraction](https://github.com/AaronLasseigne/active_interaction), as it is used as a base for the gem
 
 ```ruby
-# in controller
-output = RqlParser::FromParams.run(params.to_unsafe_hash)
-# or
+# In controller:
+output = RqlParser.from_params(params.to_unsafe_hash)
+# To raise an error instead of returning an object:
+output = RqlParser.from_params!(params.to_unsafe_hash)
+
+# Parse RQL instead of params: 
 rql = 'eq(hello,world)&ruby=eq=awesome' # your RQL query here
-output = RqlParser::Parse.run(rql)
+output = RqlParser.parse(rql)
+# To raise an error instead of returning an object:
+output = RqlParser.parse!(rql)
 ```
 
 `output.result` yields a binary tree representing the query.

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "rql_parser"
+require 'bundler/setup'
+require 'rql_parser'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "rql_parser"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/rql_parser/base_interaction.rb

@@ -1,4 +1,5 @@
 module RqlParser
+  # Parent class for all objects
   class BaseInteraction < ActiveInteraction::Base
     private
 

data/lib/rql_parser/services/format.rb

@@ -0,0 +1,46 @@
+module RqlParser
+  module Services
+    # Formats input into parser-understandable string
+    class Format < BaseInteraction
+      string :rql
+
+      RQL_FORMAT = /\A[0-9A-Za-z_()|;&,+\-!=<> ]+\z/.freeze
+
+      validates :rql, format: { with: RQL_FORMAT, message: 'has invalid format' }
+
+      def execute
+        res = remove_whitespace(rql)
+        replace_shorthands(res) unless errors.any?
+      end
+
+      private
+
+      def remove_whitespace(rql)
+        if /[0-9a-zA-Z] [0-9a-zA-Z(]/.match?(rql)
+          errors.add(:rql, 'has invalid whitespace')
+        else
+          rql.delete(' ')
+        end
+      end
+
+      def replace_shorthands(rql)
+        res = without_shorthands(rql)
+        if /[!<>=]/.match?(res)
+          errors.add(:rql, 'has invalid shorthands')
+        else
+          res
+        end
+      end
+
+      def without_shorthands(rql)
+        rql.gsub(/([0-9A-Za-z_]+)=(eq|ne|lt|le|gt|ge)=([0-9A-Za-z_]+)/, '\2(\1,\3)')
+           .gsub(/([0-9A-Za-z_]+)!=([0-9A-Za-z_]+)/, 'ne(\1,\2)')
+           .gsub(/([0-9A-Za-z_]+)<([0-9A-Za-z_]+)/, 'lt(\1,\2)')
+           .gsub(/([0-9A-Za-z_]+)<=([0-9A-Za-z_]+)/, 'le(\1,\2)')
+           .gsub(/([0-9A-Za-z_]+)>([0-9A-Za-z_]+)/, 'gt(\1,\2)')
+           .gsub(/([0-9A-Za-z_]+)>=([0-9A-Za-z_]+)/, 'ge(\1,\2)')
+           .gsub(/([0-9A-Za-z_]+)=([0-9A-Za-z_]+)/, 'eq(\1,\2)')
+      end
+    end
+  end
+end

data/lib/rql_parser/services/from_params.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RqlParser
+  module Services
+    class FromParams < BaseInteraction
+      hash :params, strip: false
+
+      def execute
+        perform(Parse.run(rql: rql))
+      end
+
+      private
+
+      def rql
+        params.except(:controller, :action).map do |k, v|
+          [k, v].compact.join('=')
+        end.join('&')
+      end
+    end
+  end
+end

data/lib/rql_parser/services/parse.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module RqlParser
+  module Services
+    class Parse < BaseInteraction
+      string :rql
+
+      def execute
+        formatted = perform(Format.run(inputs))
+        expression(formatted) || errors.add(:rql) unless errors.any?
+      end
+
+      private
+
+      def expression(str)
+        group(str) || or_expression(str)
+      end
+
+      def group(str)
+        res = false
+        if /\A\(.+\)\z/.match?(str)
+          res = or_expression(str[1..-2])
+          if res
+            res = { type: :group, args: res } if res[:args].size > 1
+          end
+        end
+        res
+      end
+
+      def or_expression(str)
+        res = []
+        split = str.split(/[;|]/)
+        temp = ''
+        while split.any?
+          temp += split.shift
+          temp_and_exp = and_expression(temp)
+          if temp_and_exp
+            res.push(temp_and_exp)
+            temp = ''
+          else
+            temp += '|'
+          end
+        end
+        return false if temp.present?
+
+        res.size > 1 ? { type: :function, identifier: 'or', args: res } : res.first
+      end
+
+      def and_expression(str)
+        res = []
+        split = str.split(/,/)
+        temp = ''
+        while split.any?
+          temp += split.shift
+          temp_and_exp = function(temp) || group(temp) || and_strict(temp)
+          if temp_and_exp
+            res.push(temp_and_exp)
+            temp = ''
+          else
+            temp += ','
+          end
+        end
+        return false if temp.present?
+
+        res.size > 1 ? { type: :function, identifier: 'and', args: res } : res.first
+      end
+
+      def and_strict(str)
+        res = []
+        split = str.split(/&/)
+        temp = ''
+        while split.any?
+          temp += split.shift
+          temp_and_exp = function(temp) || group(temp)
+          if temp_and_exp
+            res.push(temp_and_exp)
+            temp = ''
+          else
+            temp += ','
+          end
+        end
+        return false if temp.present?
+
+        res.size > 1 ? { type: :function, identifier: 'and', args: res } : res.first
+      end
+
+      def function(str)
+        res = false
+        if /\A[a-z]+\(.+\)\z/.match?(str)
+          identifier = str.match(/\A([a-z]+)/)[1]
+          args = str.match(/\A[a-z]+\((.+)\)\z/)[1]
+          temp_args = args(args)
+          res = { type: :function, identifier: identifier, args: temp_args } if temp_args
+        end
+        res
+      end
+
+      def args(str)
+        res = []
+        split = str.split(',')
+        temp = ''
+        while split.any?
+          temp += split.shift
+          temp_arg = arg(temp)
+          if temp_arg
+            res.push(temp_arg)
+            temp = ''
+          else
+            temp += ','
+          end
+        end
+        return false if temp.present?
+
+        res
+      end
+
+      def arg(str)
+        expression(str) || array_of_values(str) || value(str)
+      end
+
+      def array_of_values(str)
+        return false unless /\A\(.+\)\z/.match?(str)
+
+        res = []
+        split = str[1..-2].split(',')
+        temp = ''
+        while split.any?
+          temp += split.shift
+          temp_arg = value(temp)
+          if temp_arg
+            res.push(temp_arg)
+            temp = ''
+          else
+            temp += ','
+          end
+        end
+        return false if temp.present?
+
+        { arg_array: res }
+      end
+
+      def value(str)
+        if str.match?(/\A[_0-9a-zA-Z]+\z/)
+          { arg: str }
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rql_parser/version.rb

@@ -1,3 +1,3 @@
 module RqlParser
-  VERSION = '0.0.1alpha3'.freeze
+  VERSION = '0.0.1alpha4'.freeze
 end

data/lib/rql_parser.rb

@@ -1,5 +1,26 @@
 require 'active_interaction'
 
-module RqlParser; end
+# Base module of the parser
+module RqlParser
+  def self.from_params(params)
+    Services::FromParams.run(params)
+  end
 
-require "rql_parser/version"
+  def self.from_params!(params)
+    Services::FromParams.run!(params)
+  end
+
+  def self.parse(rql)
+    Services::Parse.run(rql)
+  end
+
+  def self.parse!(rql)
+    Services::Parse.run!(rql)
+  end
+end
+
+require 'rql_parser/version'
+require 'rql_parser/base_interaction'
+require 'rql_parser/services/from_params'
+require 'rql_parser/services/format'
+require 'rql_parser/services/parse'

data/rql_parser.gemspec

@@ -1,40 +1,37 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rql_parser/version"
+require 'rql_parser/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rql_parser"
+  spec.name          = 'rql_parser'
   spec.version       = RqlParser::VERSION
-  spec.authors       = ["Aliaksei Kharkou"]
-  spec.email         = ["Aliaksei.Kharkou@itechart-group.com"]
+  spec.authors       = ['Aliaksei Kharkou']
+  spec.email         = ['Aliaksei.Kharkou@itechart-group.com']
 
-  spec.summary       = %q{RqlParser is a gem for using RQL as valid params}
-  spec.description   = %q{RqlParser is a gem for using RQL as valid params}
-  spec.homepage      = "https://github.com/deorigosa-work/rql-parser"
-  spec.license       = "MIT"
+  spec.summary       = 'RqlParser is a gem for using RQL as valid params'
+  spec.description   = 'RqlParser is a gem for using RQL as valid params'
+  spec.homepage      = 'https://github.com/deorigosa-work/rql-parser'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/deorigosa-work/rql-parser"
-    spec.metadata["changelog_uri"] = "https://github.com/deorigosa-work/rql-parser/CHANGELOG.md"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/deorigosa-work/rql-parser'
+  spec.metadata['changelog_uri'] = 'https://github.com/deorigosa-work/rql-parser/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency             "active_interaction", "~> 3.6.0"
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency             'active_interaction', '~> 3.6.0'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rql_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.1alpha3
+  version: 0.0.1alpha4
 platform: ruby
 authors:
 - Aliaksei Kharkou
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2018-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_interaction
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 description: RqlParser is a gem for using RQL as valid params
 email:
 - Aliaksei.Kharkou@itechart-group.com
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -70,11 +85,11 @@ files:
 - bin/console
 - bin/setup
 - lib/rql_parser.rb
+- lib/rql_parser/_grammar.ebnf
 - lib/rql_parser/base_interaction.rb
-- lib/rql_parser/format.rb
-- lib/rql_parser/from_params.rb
-- lib/rql_parser/parse.rb
-- lib/rql_parser/rules.ebnf
+- lib/rql_parser/services/format.rb
+- lib/rql_parser/services/from_params.rb
+- lib/rql_parser/services/parse.rb
 - lib/rql_parser/version.rb
 - rql_parser.gemspec
 homepage: https://github.com/deorigosa-work/rql-parser

data/lib/rql_parser/format.rb

@@ -1,44 +0,0 @@
-module RqlParser
-  class Format < BaseInteraction
-    string :rql
-
-    RQL_FORMAT = /\A[0-9A-Za-z_()|&,+\-!=<> ]+\z/.freeze
-
-    validates :rql, format: { with: RQL_FORMAT }
-
-    def execute
-      res = remove_whitespace(rql)
-      replace_shorthands(res)
-    end
-
-    private
-
-    def remove_whitespace(rql)
-      if /[0-9a-zA-Z] [0-9a-zA-Z(]/.match?(rql)
-        errors.add(:rql_parser, 'has invalid whitespace')
-      else
-        rql.delete(' ')
-      end
-    end
-
-    def replace_shorthands(rql)
-      res = without_shorthands(rql)
-      if /[!<>=]/.match?(res)
-        errors.add(:rql_parser, 'has invalid shorthands')
-      else
-        res
-      end
-    end
-
-    def without_shorthands(rql)
-      rql.gsub(/([0-9A-Za-z_]+)=(eq|ne|lt|le|gt|ge)=([0-9A-Za-z_]+)/,
-               '\2(\1,\3)')
-         .gsub(/([0-9A-Za-z_]+)!=([0-9A-Za-z_]+)/, 'ne(\1,\2)')
-         .gsub(/([0-9A-Za-z_]+)<([0-9A-Za-z_]+)/, 'lt(\1,\2)')
-         .gsub(/([0-9A-Za-z_]+)<=([0-9A-Za-z_]+)/, 'le(\1,\2)')
-         .gsub(/([0-9A-Za-z_]+)>([0-9A-Za-z_]+)/, 'gt(\1,\2)')
-         .gsub(/([0-9A-Za-z_]+)>=([0-9A-Za-z_]+)/, 'ge(\1,\2)')
-         .gsub(/([0-9A-Za-z_]+)=([0-9A-Za-z_]+)/, 'eq(\1,\2)')
-    end
-  end
-end

data/lib/rql_parser/from_params.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module RqlParser
-  #
-  # some doc
-  class FromParams < BaseInteraction
-    hash :params, strip: false
-
-    def execute
-      perform RqlParser::Parse.run(rql: to_rql(params))
-    end
-
-    private
-
-    def to_rql(params)
-      params.except(:controller, :action).map do |k, v|
-        [k, v].compact.join('=')
-      end.join('&')
-    end
-  end
-end

data/lib/rql_parser/parse.rb

@@ -1,153 +0,0 @@
-# frozen_string_literal: true
-
-module RqlParser
-  class Parse < BaseInteraction
-    string :rql
-
-    def execute
-      formatted = perform(Format.run(inputs))
-      expression(formatted) || errors.add(:rql) unless errors.any?
-    end
-
-    private
-
-    def expression(str)
-      group(str) || or_expression(str)
-    end
-
-    def group(str)
-      res = false
-      if /\A\(.+\)\z/.match?(str)
-        res = or_expression(str[1..-2])
-        if res
-          res = { type: :group, args: res } if res[:args].size > 1
-        end
-      end
-      res
-    end
-
-    def or_expression(str)
-      res = []
-      split = str.split(/[|;]/)
-      temp = ''
-      while split.any?
-        temp += split.shift
-        temp_and_exp = and_expression(temp)
-        if temp_and_exp
-          res.push(temp_and_exp)
-          temp = ''
-        else
-          temp += ';'
-        end
-      end
-      return false if temp.present?
-
-      res.size > 1 ? { type: :function, identifier: 'or', args: res } : res.first
-    end
-
-    def and_expression(str)
-      res = []
-      split = str.split(/,/)
-      temp = ''
-      while split.any?
-        temp += split.shift
-        temp_and_exp = function(temp) || group(temp) || and_strict(temp)
-        if temp_and_exp
-          res.push(temp_and_exp)
-          temp = ''
-        else
-          temp += ','
-        end
-      end
-      return false if temp.present?
-
-      res.size > 1 ? { type: :function, identifier: 'and', args: res } : res.first
-    end
-
-    def and_strict(str)
-      res = []
-      split = str.split(/&/)
-      temp = ''
-      while split.any?
-        temp += split.shift
-        temp_and_exp = function(temp) || group(temp)
-        if temp_and_exp
-          res.push(temp_and_exp)
-          temp = ''
-        else
-          temp += ','
-        end
-      end
-      return false if temp.present?
-
-      res.size > 1 ? { type: :function, identifier: 'and', args: res } : res.first
-    end
-
-    def function(str)
-      res = false
-      if /\A[a-z]+\(.+\)\z/.match?(str)
-        identifier = str.match(/\A([a-z]+)/)[1]
-        args = str.match(/\A[a-z]+\((.+)\)\z/)[1]
-        temp_args = args(args)
-        if temp_args
-          res = { type: :function, identifier: identifier, args: temp_args }
-        else
-          false
-        end
-      end
-      res
-    end
-
-    def args(str)
-      res = []
-      split = str.split(',')
-      temp = ''
-      while split.any?
-        temp += split.shift
-        temp_arg = arg(temp)
-        if temp_arg
-          res.push(temp_arg)
-          temp = ''
-        else
-          temp += ','
-        end
-      end
-      return false if temp.present?
-
-      res
-    end
-
-    def arg(str)
-      expression(str) || array_of_values(str) || value(str)
-    end
-
-    def array_of_values(str)
-      return false unless /\A\(.+\)\z/.match?(str)
-
-      res = []
-      split = str[1..-2].split(',')
-      temp = ''
-      while split.any?
-        temp += split.shift
-        temp_arg = value(temp)
-        if temp_arg
-          res.push(temp_arg)
-          temp = ''
-        else
-          temp += ','
-        end
-      end
-      return false if temp.present?
-
-      { arg_array: res }
-    end
-
-    def value(str)
-      if str.match?(/\A[_0-9a-zA-Z]+\z/)
-        { arg: str }
-      else
-        false
-      end
-    end
-  end
-end