logical_query_parser 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f62acc3ca3efe725b46798c405985136dcd0702
-  data.tar.gz: 56e9d416089645c652649782a1c3d320a6bedc05
+SHA256:
+  metadata.gz: c2a48abdb3c711d5984f63d4ff56d8d492e5c674a306833472435c64e2180d41
+  data.tar.gz: 85f5476c26e88e6f0cc5465eb46bbf62a7ac0b2a9bfa84183fd2a93cee0aef9b
 SHA512:
-  metadata.gz: 83df4ab258dce60d775a4d0548b4f20e25ac26d0f424fc734ea70cc579a9664ecaeaefcb3c593901629428d8954ce7ac60a3682bc32c523232c0c5de0f804ac1
-  data.tar.gz: 1ac865f2c09148e70e0da1ba31c964b53ebdf6fc31dbedb5cd602c1b5dceb74f46177ee6bb9442511ffe6679696035e9ffb287e9cf354685c873be1a6b93f69c
+  metadata.gz: 95909ee34ce7e60993844d69a96c6ef683a470b44113cd49c4045ceb7f6cfb0d6081731c2e13e7a699c7584f2d4efbfd368cff549291481b8471bb6d594b09ff
+  data.tar.gz: 1319eab5cf8dd32f8760cacb5ac0211b8c3d2330e95dc3426325e9bc7f0767b9d477c0c4b75e82061e5126117bf70ffe729252dae3de06dc04e0041b051215d3

data/.gitignore

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

data/.travis.yml

@@ -1,12 +1,21 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.4
-  - 2.4.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
 gemfile:
   - gemfiles/rails42.gemfile
   - gemfiles/rails50.gemfile
   - gemfiles/rails51.gemfile
-before_install:
-  - gem install bundler -v 1.15.3
-script: bundle exec rspec
+  - gemfiles/rails52.gemfile
+  - gemfiles/rails60.gemfile
+matrix:
+  exclude:
+  - rvm: 2.3
+    gemfile: gemfiles/rails60.gemfile
+  - rvm: 2.4
+    gemfile: gemfiles/rails60.gemfile
+script:
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# CHANGELOG
+
+## 0.3.0
+
+* Support searching with associations.
+* Change module name.
+
+## 0.2.0
+
+* Support operators: "NOT", "&", "|".
+
+## 0.1.0
+
+* First release.

data/Gemfile

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

data/README.md

@@ -79,36 +79,41 @@ parser.parse('("a a" AND NOT "b b") OR (c AND -d)')
 * ": 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).
+For more information, see [grammar definition](lib/logical_query_parser.treetop).
 
-### Compile into SQL
+### Use with ActiveRecord
 
-You can compile a syntax tree into a SQL statement by using activerecord model. For example, the code below
+You can use a syntax tree to compile a SQL statement for activerecord. For example:
 
 ```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
+class Doc < ActiveRecord::Base
 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%')
+LogicalQueryParser.search("a AND b", Doc.all, :c1, :c2).to_sql
+# SELECT "docs".* FROM "docs"
+#  WHERE (("docs"."c1" LIKE '%a%' OR "docs"."c2" LIKE '%a%') AND ("docs"."c1" LIKE '%b%' OR "docs"."c2" LIKE '%b%'))
 ```
 
-## Development
+Use with associations:
 
-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.
+```ruby
+class Doc < ActiveRecord::Base
+  has_many :tags
+end
 
-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).
+class Tag < ActiveRecord::Base
+end
+
+LogicalQueryParser.search("a AND b", Doc.all, :c1, :c2, tags: [:c3]).to_sql
+# SELECT "docs".* FROM "docs"
+#  INNER JOIN "tags" ON "tags"."doc_id" = "docs"."id"
+#  WHERE ((("docs"."c1" LIKE '%a%' OR "docs"."c2" LIKE '%a%') OR "tags"."c3" LIKE '%a%') AND
+#        (("docs"."c1" LIKE '%b%' OR "docs"."c2" LIKE '%b%') OR "tags"."c3" LIKE '%b%'))
+```
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kanety/logical_query_parser.
 
 ## License
 

data/gemfiles/rails42.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
 gem "activerecord", "~> 4.2.9"
+gem "sqlite3", "~> 1.3.6"
 
-# Specify your gem's dependencies in params_keeper_rails.gemspec
 gemspec path: "../"

data/gemfiles/rails50.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
 gem "activerecord", "~> 5.0.5"
+gem "sqlite3", "~> 1.3.6"
 
-# Specify your gem's dependencies in params_keeper_rails.gemspec
 gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
 gem "activerecord", "~> 5.1.3"
+gem "sqlite3", "~> 1.3.6"
 
-# Specify your gem's dependencies in params_keeper_rails.gemspec
 gemspec path: "../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~> 5.2.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/rails60.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~> 6.0.0"
+
+gemspec path: "../"

data/lib/logical_query_parser.rb

@@ -1,12 +1,28 @@
 require 'treetop'
+Treetop.load File.expand_path("../logical_query_parser.treetop", __FILE__)
+
 require 'logical_query_parser/version'
+require 'logical_query_parser/assoc_resolver'
 require 'logical_query_parser/nodes/base'
-require 'logical_query_parser/nodes/active_record' if defined? ActiveRecord::Base
-
-Treetop.load File.expand_path("../logical_query.treetop", __FILE__)
+require 'logical_query_parser/nodes/active_record' if defined? ::ActiveRecord::Base
 
-class LogicalQueryParser < Treetop::Runtime::CompiledParser
+module LogicalQueryParser
   class << self
+    def new
+      LogicalQueryParserParser.new
+    end
+
+    def search(query, relations, *options)
+      relations = relations.all if relations.respond_to?(:all)
+      assoc = resolve_assocs(relations.klass, options)
+      sql = new.parse(query).to_sql(model: relations.klass, columns: assoc.column_mapping)
+      relations.joins(assoc.structure).where(sql)
+    end
+
+    def resolve_assocs(klass, options)
+      AssocResolver.new(klass).run(options)
+    end
+
     def walk_tree(node, &block)
       yield node
       unless node.elements.nil?

data/lib/{logical_query.treetop → logical_query_parser.treetop}

@@ -1,4 +1,4 @@
-grammar LogicalQuery
+grammar LogicalQueryParser
   rule exp
     sp* exp:(logic_exp / paren_exp / literal_exp / literal) sp* <ExpNode>
   end

data/lib/logical_query_parser/assoc.rb

@@ -0,0 +1,11 @@
+module LogicalQueryParser
+  class Assoc
+    attr_accessor :column_mapping, :structure
+    attr_accessor :current
+
+    def initialize(attrs = {})
+      @column_mapping = {}
+      @structure = {}
+    end
+  end
+end

data/lib/logical_query_parser/assoc_resolver.rb

@@ -0,0 +1,48 @@
+require_relative 'assoc'
+
+module LogicalQueryParser
+  class AssocResolver
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def run(*args)
+      Assoc.new.tap do |assoc|
+        assoc.current = assoc.structure
+        resolve_assocs(@klass, args, assoc)
+      end
+    end
+
+    private
+
+    def wrap_array(options)
+      if options.is_a?(Array)
+        options.flatten(1)
+      else
+        [options]
+      end
+    end
+
+    def resolve_assocs(klass, options, assoc)
+      options = wrap_array(options)
+      options.each do |option|
+        if option.is_a?(Hash)
+          resolve_assocs_for_hash(klass, option, assoc)
+        else
+          assoc.column_mapping[klass] ||= []
+          assoc.column_mapping[klass] << option
+        end
+      end
+    end
+
+    def resolve_assocs_for_hash(klass, hash, assoc)
+      hash.each do |assoc_name, options|
+        if (reflection = klass.reflect_on_association(assoc_name))
+          assoc.current[assoc_name] = {}
+          assoc.current = assoc.current[assoc_name]
+          resolve_assocs(reflection.klass, options, assoc)
+        end
+      end
+    end
+  end
+end

data/lib/logical_query_parser/nodes/active_record.rb

@@ -1,81 +1,109 @@
-module LogicalQuery
+module LogicalQueryParser
   module ExpNode
-    def to_sql(opts = {}, sql = '')
-      exp.to_sql(opts, sql)
+    def to_sql(params = {})
+      params[:sql] ||= ''
+      exp.to_sql(params)
     end
   end
 
   module ParenExpNode
-    def to_sql(opts, sql = '')
+    def to_sql(params)
       if negative.elements.size > 0
-        negative.elements[0].to_sql(opts, sql)
+        negative.elements[0].to_sql(params)
       end
-      lparen.to_sql(opts, sql)
-      exp.to_sql(opts, sql)
-      rparen.to_sql(opts, sql)
+      lparen.to_sql(params)
+      exp.to_sql(params)
+      rparen.to_sql(params)
       if rexp.elements.size > 0
-        sql += ' AND '
-        rexp.elements[0].to_sql(opts, sql)
+        params[:sql] += ' AND '
+        rexp.elements[0].to_sql(params)
       end
-      sql
+      params[:sql]
     end
   end
 
   module LogicExpNode
-    def to_sql(opts, sql = '')
-      lexp.to_sql(opts, sql)
-      logic.to_sql(opts, sql)
-      rexp.to_sql(opts, sql)
+    def to_sql(params)
+      lexp.to_sql(params)
+      logic.to_sql(params)
+      rexp.to_sql(params)
     end
   end
 
   module LiteralExpNode
-    def to_sql(opts, sql = '')
-      literal.to_sql(opts, sql)
-      sql << ' AND '
-      exp.to_sql(opts, sql)
+    def to_sql(params)
+      literal.to_sql(params)
+      params[:sql] << ' AND '
+      exp.to_sql(params)
     end
   end
 
   module LParenNode
-    def to_sql(opts, sql = '')
-      sql << '('
+    def to_sql(params)
+      params[:sql] << '('
     end
   end
 
   module RParenNode
-    def to_sql(opts, sql = '')
-      sql << ')'
+    def to_sql(params)
+      params[:sql] << ')'
     end
   end
 
   module AndNode
-    def to_sql(opts, sql = '')
-      sql << ' AND '
+    def to_sql(params)
+      params[:sql] << ' AND '
     end
   end
 
   module OrNode
-    def to_sql(opts, sql = '')
-      sql << ' OR '
+    def to_sql(params)
+      params[:sql] << ' OR '
     end
   end
 
   module NotNode
-    def to_sql(opts, sql = '')
-      sql << 'NOT '
+    def to_sql(params)
+      params[:sql] << 'NOT '
     end
   end
 
   module LiteralNode
-    def to_sql(opts, sql = '')
-      operator, logic = negative.elements.size > 0 ? [:does_not_match, :and] : [:matches, :or]
-      unquoted = LogicalQuery.unquote(word.text_value)
+    def to_sql(params)
+      operator, logic = operator_and_logic
+      text = LogicalQueryParser.unquote(word.text_value)
+      
+      sql = build_arel(params, operator, text).reduce(logic).to_sql
+      sql = "(#{sql})" if sql[0] != '(' && sql[-1] != ')'
+      params[:sql] << sql
+    end
+
+    private
+
+    def operator_and_logic
+      if negative.elements.size > 0
+        return :does_not_match, :and
+      else
+        return :matches, :or
+      end
+    end
 
-      arel = opts[:model].arel_table
-      ss = opts[:columns].map { |c| arel[c].send(operator, "%#{unquoted}%") }.reduce(logic).to_sql
-      ss = "(#{ss})" if ss[0] != '(' && ss[-1] != ')'
-      sql << ss
+    def build_arel(params, operator, text)
+      if params[:columns].is_a?(Hash)
+        build_arel_from_hash(params[:model], params[:columns], operator, text)
+      else
+        build_arel_from_columns(params[:model], params[:columns], operator, text)
+      end
+    end
+    
+    def build_arel_from_columns(klass, columns, operator, text)
+      columns.map { |column| klass.arel_table[column].send(operator, "%#{text}%") }
+    end
+
+    def build_arel_from_hash(klass, hash, operator, text)
+      hash.flat_map do |klass, columns|
+        build_arel_from_columns(klass, columns, operator, text)
+      end
     end
   end
 

data/lib/logical_query_parser/nodes/base.rb

@@ -1,4 +1,4 @@
-module LogicalQuery
+module LogicalQueryParser
   module ExpNode
   end
 

data/lib/logical_query_parser/version.rb

@@ -1,3 +1,3 @@
-module LogicalQuery
-  VERSION = "0.2.0"
+module LogicalQueryParser
+  VERSION = "0.3.0"
 end

data/logical_query_parser.gemspec

@@ -5,7 +5,7 @@ require 'logical_query_parser/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "logical_query_parser"
-  spec.version       = LogicalQuery::VERSION
+  spec.version       = LogicalQueryParser::VERSION
   spec.authors       = ["Yoshikazu Kaneta"]
   spec.email         = ["kaneta@sitebridge.co.jp"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logical_query_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-07 00:00:00.000000000 Z
+date: 2019-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -119,6 +119,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -129,8 +130,12 @@ files:
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
-- lib/logical_query.treetop
+- gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
 - lib/logical_query_parser.rb
+- lib/logical_query_parser.treetop
+- lib/logical_query_parser/assoc.rb
+- lib/logical_query_parser/assoc_resolver.rb
 - lib/logical_query_parser/nodes/active_record.rb
 - lib/logical_query_parser/nodes/base.rb
 - lib/logical_query_parser/version.rb
@@ -154,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A parser for a logical query string.