logical_query_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8005a57b1dd4e044f6755066a55bc40f1435e6a
+  data.tar.gz: 063e0c5f78b1ca4440203cce18769cfe90f6cde4
+SHA512:
+  metadata.gz: c5c6e4b62fc124139ada278d98e6a6fcd5cfb630d01d55a5bae29c578929e0628a704db17982e88173d52e59d91db1d4e0eaf7aeaa6d3563fd75315aa0d0737d
+  data.tar.gz: 37d9daf9cbbc43eb052b3e1574bd120102618cb376b851271f4ff5929573c891352473f391697857a31c977f75fa3f4a59fca7a022db277a43d2e95401ae3733

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/.project
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kaneta@sitebridge.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logical_query_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yoshikazu Kaneta
+
+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,124 @@
+# LogicalQueryParser
+
+A parser to generate a tree structure from a logical search query string using treetop.
+
+## Requirements
+
+* ruby 2.3 or lator
+* treetop 1.6 or lator
+* activerecord 4.2 or lator (optional)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logical_query_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logical_query_parser
+
+## Usage
+
+You can parse a logical query string as follows:
+
+```ruby
+parser = LogicalQueryParser.new
+parser.parse('a AND b')
+```
+
+Return value is a syntax tree of treetop:
+
+```ruby
+parser = LogicalQueryParser.new
+parser.parse('a AND b')
+
+=> SyntaxNode+Exp0+ExpNode offset=0, "a AND b" (any):
+  SyntaxNode+Cond0+CondNode offset=0, "a AND b" (lexp,logic,rexp):
+    SyntaxNode+Literal0+LiteralNode offset=0, "a" (word,negative):
+      SyntaxNode offset=0, ""
+      SyntaxNode+WordNode offset=0, "a":
+        SyntaxNode+Atom0 offset=0, "a":
+          SyntaxNode offset=0, ""
+          SyntaxNode offset=0, "a"
+    SyntaxNode offset=1, " ":
+      SyntaxNode offset=1, " "
+    SyntaxNode+AndNode offset=2, "AND"
+    SyntaxNode offset=5, " ":
+      SyntaxNode offset=5, " "
+    SyntaxNode+Exp0+ExpNode offset=6, "b" (any):
+      SyntaxNode+Literal0+LiteralNode offset=6, "b" (word,negative):
+        SyntaxNode offset=6, ""
+        SyntaxNode+WordNode offset=6, "b":
+          SyntaxNode+Atom0 offset=6, "b":
+            SyntaxNode offset=6, ""
+            SyntaxNode offset=6, "b"
+```
+
+You can parse quoted strings:
+
+```
+parser = LogicalQueryParser.new
+parser.parse('("a a" AND "b b") OR (c AND d)')
+```
+
+You can also parse negative conditions:
+
+```
+parser = LogicalQueryParser.new
+parser.parse('("a a" AND -"b b") OR (c AND -d)')
+```
+
+### Supported operators
+
+You can parse a query string with following operators:
+
+* AND / and: represents an AND logic.
+* OR / or: represents an OR logic.
+* \-: represents a NOT logic. This should precede to a word.
+* (: represents beginning of a nested expression.
+* ): represents end of a nested expression.
+* ": represents beginning or end of a quoted word.
+* Space: represents a boundary between two words.
+
+For more information, see [grammar definition](lib/logical_query.treetop).
+
+### Compile into SQL
+
+You can compile a syntax tree into a SQL statement by using activerecord model. For example, the code below
+
+```ruby
+class Table < ActiveRecord::Base
+  def build_sql(str = "a AND b")
+    parser = LogicalQueryParser.new
+    parser.parse(str).to_sql(model: self, columns: %w(c1 c2))
+  end
+end
+```
+
+builds a SQL statement as follows (this example shows a postgresql statement):
+
+```sql
+("tables"."c1" ILIKE '%a%' OR "tables"."c2" ILIKE '%a%') AND ("tables"."c1" ILIKE '%b%' OR "tables"."c2" ILIKE '%b%')
+```
+
+## 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 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/kanety/logical_query_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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logical_query_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

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