rql-parser 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '095b70c0d1deea29834083481ea144f6c4df2d146616bca56858209e81940193'
+  data.tar.gz: 96902b99b811b494924395da9201f006dd4b4c893126ac17a1f067c316799d9e
+SHA512:
+  metadata.gz: 26fc39f3faecd46265950cfdb0b1c3aab25061597e1b1bf4e96cc0a37f71eed5dc5b857c566fc8bf6b566b9c49fa4229d83df8504cab3f2d21e00b24cbdd63f4
+  data.tar.gz: a7598751cc016ad508cacddad4f4cf9f04e0b1d022066a26ad401e82e391041b4d52182d7bbd5b4fbda1f4ff453b631e297a74766a5c8d7f60807825490926fe

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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,52 @@
+# Changelog
+
+#### 1.1.1
+
+- Change name from `rql_parser` to 'rql-parser' for consistency
+
+---
+
+#### 1.1.0
+
+- Transfer ownership
+
+---
+
+#### 1.0.3
+
+- Fix typos
+
+---
+
+#### 1.0.2
+
+- Fix typos
+
+---
+
+#### 1.0.1
+
+- Fix critical bug
+
+---
+
+#### 1.0.0
+
+- Make function identifiers symbols instead of strings
+- Remove binary tree `group` node
+- Prettify parser code
+- Tweak grammar
+
+---
+
+#### 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/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at Aliaksei.Kharkou@itechart-group.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Aliaksei Kharkou
+
+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,81 @@
+# RqlParser
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rql-parser'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install rql-parser
+```
+
+## Usage
+
+See [ActiveInteraction](https://github.com/AaronLasseigne/active_interaction), as it is used as a base for the gem
+
+```ruby
+# In controller:
+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(rql)
+```
+
+`output.result` yields a binary tree representing the query:
+
+```ruby
+rql = 'eq(hello,world)&ruby=eq=awesome' # your RQL query here
+output = RqlParser.parse(rql)
+output.valid?
+#=> true
+output.result
+#=> { type: :function,
+#     identifier: :and,
+#     args: [{ type: :function,
+#              identifier: :eq,
+#              args: [{ arg: 'hello' },
+#                     { arg: 'world' }] },
+#            { type: :function,
+#              identifier: :eq,
+#              args: [{ arg: 'ruby' },
+#                     { arg: 'awesome' }] }] }
+```
+
+`output.errors` yields an `ActiveModel::Errors`-like object (if any):
+```ruby
+rql = 'i=have=errors' # your invalid RQL query here
+output = RqlParser.parse(rql)
+output.valid?
+#=> false
+output.errors.full_messages
+#=> 'Rql has invalid shorthands'
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/hacky-gems/rql-parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 RqlParser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hacky-gems/rql-parser/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

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/lib/rql_parser.rb

@@ -0,0 +1,26 @@
+require 'active_interaction'
+
+# Base module of the parser
+module RqlParser
+  def self.from_params(params)
+    Services::FromParams.run(params: params)
+  end
+
+  def self.from_params!(params)
+    Services::FromParams.run!(params: params)
+  end
+
+  def self.parse(rql)
+    Services::Parse.run(rql: rql)
+  end
+
+  def self.parse!(rql)
+    Services::Parse.run!(rql: 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/lib/rql_parser/_grammar.ebnf

@@ -0,0 +1,21 @@
+exp = group | or_exp ;
+
+group = '(', or_exp, ')' ;
+
+or_exp = and_exp, { or_delim, and_exp } ;
+
+or_delim = '|' | ';' ;
+
+and_exp = (function | group | and_strict), { ',', (function | group | and_strict) } ;
+
+function = identifier, '(', [arg, { ',', arg }], ')' ;
+
+and_strict = (function | group), { '&', (function | group) } ;
+
+identifier = /[a-z]+/
+
+arg = and_exp | arg_array | value ;
+
+value = /[_0-9a-zA-Z]+/ ;
+
+arg_array = '(', value, { ',', value }, ')' ;

data/lib/rql_parser/base_interaction.rb

@@ -0,0 +1,14 @@
+module RqlParser
+  # Parent class for all objects
+  class BaseInteraction < ActiveInteraction::Base
+    private
+
+    def perform(outcome)
+      if outcome.valid?
+        outcome.result
+      else
+        errors.merge!(outcome.errors)
+      end
+    end
+  end
+end

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,22 @@
+# frozen_string_literal: true
+
+module RqlParser
+  module Services
+    # Creates a RQL binary tree directly from params hash
+    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,113 @@
+module RqlParser
+  module Services
+    # Service that performs the parse operation
+    class Parse < BaseInteraction
+      string :rql
+
+      DELIMITERS = '&,;'.freeze
+      OR_DELIMITERS = /[;|]/.freeze
+      COMMA_DELIMITER = /,/.freeze
+      AND_STRICT_DELIMITERS = /&/.freeze
+      BRACES_REGEX = /\A\(.+\)\z/.freeze
+      FUNCTION_REGEX = /\A[a-z]+\(.+\)\z/.freeze
+      FUNCTION_IDENTIFIER = /\A([a-z]+)/.freeze
+      FUNCTION_ARGS = /\A[a-z]+\((.+)\)\z/.freeze
+      VALUE_REGEX = /\A[_0-9a-zA-Z]+\z/.freeze
+
+      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)
+        return false unless BRACES_REGEX.match?(str)
+
+        or_expression(str[1..-2]) || false
+      end
+
+      def or_expression(str)
+        result = repeat_pattern(str, OR_DELIMITERS) { |s| and_expression(s) }
+        return false unless result
+
+        result.size > 1 ? { type: :function, identifier: :or, args: result } : result.first
+      end
+
+      def and_expression(str)
+        result = repeat_pattern(str, COMMA_DELIMITER) { |s| function(s) || group(s) || and_strict(s) }
+        return false unless result
+
+        result.size > 1 ? { type: :function, identifier: :and, args: result } : result.first
+      end
+
+      def and_strict(str)
+        result = repeat_pattern(str, AND_STRICT_DELIMITERS) { |s| function(s) || group(s) }
+        return false unless result
+
+        result.size > 1 ? { type: :function, identifier: :and, args: result } : result.first
+      end
+
+      def function(str)
+        return false unless FUNCTION_REGEX.match?(str)
+
+        identifier = str.match(FUNCTION_IDENTIFIER)[1]
+        args = args(str.match(FUNCTION_ARGS)[1])
+
+        return false unless args
+
+        { type: :function, identifier: identifier.to_sym, args: args }
+      end
+
+      def args(str)
+        repeat_pattern(str, COMMA_DELIMITER) { |s| arg(s) }
+      end
+
+      def arg(str)
+        expression(str) || array_of_values(str) || value(str)
+      end
+
+      def array_of_values(str)
+        return false unless BRACES_REGEX.match?(str)
+
+        result = repeat_pattern(str[1..-2], COMMA_DELIMITER) { |s| value(s) }
+        return false unless result
+
+        { arg_array: result }
+      end
+
+      def value(str)
+        if str.match?(VALUE_REGEX)
+          { arg: str }
+        else
+          false
+        end
+      end
+
+      def repeat_pattern(str, split_regex)
+        split = str.split(split_regex)
+        result = []
+        expression = ''
+        while split.any?
+          expression += split.shift
+          bin_tree = yield(expression)
+          if bin_tree
+            result.push(bin_tree)
+            expression = ''
+          else
+            expression += compose_char(split_regex)
+          end
+        end
+        expression.blank? && result
+      end
+
+      def compose_char(regex)
+        DELIMITERS.match(regex)[0]
+      end
+    end
+  end
+end

data/lib/rql_parser/version.rb

@@ -0,0 +1,3 @@
+module RqlParser
+  VERSION = '1.1.1'.freeze
+end

data/rql_parser.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rql_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rql-parser'
+  spec.version       = RqlParser::VERSION
+  spec.authors       = ['Deorigosa']
+  spec.email         = ['Deorigosa@users.noreply.github.com']
+
+  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/hacky-gems/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.
+  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/hacky-gems/rql-parser'
+  spec.metadata['changelog_uri'] = 'https://github.com/hacky-gems/rql-parser/blob/master/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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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_development_dependency 'rspec', '~> 3.8.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rql-parser
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Deorigosa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_interaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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:
+- Deorigosa@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rql_parser.rb
+- lib/rql_parser/_grammar.ebnf
+- lib/rql_parser/base_interaction.rb
+- 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/hacky-gems/rql-parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hacky-gems/rql-parser
+  source_code_uri: https://github.com/hacky-gems/rql-parser
+  changelog_uri: https://github.com/hacky-gems/rql-parser/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: RqlParser is a gem for using RQL as valid params
+test_files: []