rql_parser 0.0.1alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca4cc9992b3d422eb1a6036033ea2662ad0b84d7a9cb62684840c6da18aea7e5
+  data.tar.gz: f3f7d4c0710d05aa5ed811d81e0ee2a2a676fdf66caa0e6a06f109484a9f39de
+SHA512:
+  metadata.gz: a2092da64d7ccff15725dd25ce1df65cd028d820fd87af560bdbce900f638404806be31c4e68325c0e66779a76392ee397ddc257866cae7ead05ef58c326cdb6
+  data.tar.gz: e07ee60668d20e024ae694c0bfb9e09367cd662521eb353810a750592b9352bb306ee92d0a7de7040d1c7202ec7634b8e4446677ca8d8156b93a0016c5b3e6eb

data/.gitignore

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

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,43 @@
+# RqlParser
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rql_parser`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## 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
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/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/[USERNAME]/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/base_interaction.rb

@@ -0,0 +1,11 @@
+class BaseInteraction < ActiveInteraction::Base
+  private
+
+  def perform(interaction)
+    if interaction.valid?
+      interaction.result
+    else
+      errors.merge!(interaction.errors)
+    end
+  end
+end

data/lib/rql_parser/format.rb

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,153 @@
+# 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

data/lib/rql_parser/rules.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 | and_strict | group), { ',', (function | and_strict | group) } ;
+
+function = identifier, '(', [arg, { ',', arg }], ')' ;
+
+and_strict = (function | group), { '&', (function | group) } ;
+
+identifier = /[a-z]+/
+
+arg = and_exp | array_of_values | value ;
+
+value = /[_0-9a-zA-Z]+/ ;
+
+array_of_values = '(', value, { ',', value }, ')' ;

data/lib/rql_parser/version.rb

@@ -0,0 +1,3 @@
+module RqlParser
+  VERSION = "0.0.1alpha"
+end

data/lib/rql_parser.rb

@@ -0,0 +1,6 @@
+require "rql_parser/version"
+
+module RqlParser
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/rql_parser.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$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       = ["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"
+
+  # 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
+
+  # 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
+    `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"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rql_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1alpha
+platform: ruby
+authors:
+- Aliaksei Kharkou
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-24 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'
+description: RqlParser is a gem for using RQL as valid params
+email:
+- Aliaksei.Kharkou@itechart-group.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/base_interaction.rb
+- lib/rql_parser.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/version.rb
+- rql_parser.gemspec
+homepage: https://github.com/deorigosa-work/rql-parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/deorigosa-work/rql-parser
+  source_code_uri: https://github.com/deorigosa-work/rql-parser
+  changelog_uri: https://github.com/deorigosa-work/rql-parser/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: 1.3.1
+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: []