logical_query_parser 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21e876f1e9e4496b81a09656f8f9667817b79cc961fd72557dafd56ee20f7f37
-  data.tar.gz: b44d2f653f33c10de26fa2f80010836291abe78804354b84bb9aa1c54f5210ac
+  metadata.gz: 50d9e7d0d793b457dd2561160c3fc0e2a0611d7425c671a624c19c5e7395fd92
+  data.tar.gz: cc8b9d94d8c13c5764e82b64be14d6b68e050f8d7fe9a3b53c624aa973dbb949
 SHA512:
-  metadata.gz: 0b1337963075eb702293de0b3f9fb01880db2e2b7ed15b265858806fd5a75c25c0dd253c309060c7fa6982a8eda8e1b42d1ed82a3d978ac94a58f6169b9959e3
-  data.tar.gz: 02a3028859413314aee0284ac1beda1355dd633101ed449c2029447277a5e3c8fd552afc683313f276e8bdd25f9a868f6fc8b1cbd443603c9f6ce422947f3104
+  metadata.gz: fd0590d955cba3c8b10d2441e62d720131bffb46ecbfbbf5df3ed49fc1e27aeb1a81a28e2ae18d3cdd50e553a0802a24b66b3c5d77b15395391bae7a18e095e4
+  data.tar.gz: 678c2067c0dae4587dde4158d251ccb7643479af9ff0c894be7c3410a02c2970a0e83ea8275a300d0ed2b89f08aaa98ddabd0332dca40e62033d00d65c76f208

data/.github/workflows/ci.yml

@@ -4,71 +4,23 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2, 3.3]
-        gemfile: ['rails42', 'rails50', 'rails51', 'rails52', 'rails60', 'rails61', 'rails70', 'rails71']
+        ruby: ['3.0', 3.1, 3.2, 3.3, 3.4, '4.0']
+        gemfile: ['rails70', 'rails71', 'rails72', 'rails80', 'rails81']
         exclude:
-          - ruby: 2.3
-            gemfile: rails60
-          - ruby: 2.3
-            gemfile: rails61
-          - ruby: 2.3
-            gemfile: rails70
-          - ruby: 2.3
-            gemfile: rails71
-          - ruby: 2.4
-            gemfile: rails60
-          - ruby: 2.4
-            gemfile: rails61
-          - ruby: 2.4
-            gemfile: rails70
-          - ruby: 2.4
-            gemfile: rails71
-          - ruby: 2.5
-            gemfile: rails70
-          - ruby: 2.5
-            gemfile: rails71
-          - ruby: 2.6
-            gemfile: rails70
-          - ruby: 2.6
-            gemfile: rails71
-          - ruby: 2.7
-            gemfile: rails42
           - ruby: 3.0
-            gemfile: rails42
+            gemfile: rails72
           - ruby: 3.0
-            gemfile: rails50
+            gemfile: rails80
           - ruby: 3.0
-            gemfile: rails51
-          - ruby: 3.0
-            gemfile: rails52
-          - ruby: 3.1
-            gemfile: rails42
+            gemfile: rails81
           - ruby: 3.1
-            gemfile: rails50
+            gemfile: rails80
           - ruby: 3.1
-            gemfile: rails51
-          - ruby: 3.1
-            gemfile: rails52
-          - ruby: 3.2
-            gemfile: rails42
-          - ruby: 3.2
-            gemfile: rails50
-          - ruby: 3.2
-            gemfile: rails51
-          - ruby: 3.2
-            gemfile: rails52
-          - ruby: 3.3
-            gemfile: rails42
-          - ruby: 3.3
-            gemfile: rails50
-          - ruby: 3.3
-            gemfile: rails51
-          - ruby: 3.3
-            gemfile: rails52
+            gemfile: rails81
 
     name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}
 
@@ -76,11 +28,14 @@ jobs:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
+    - name: Bundle list
+      run: |
+        bundle list
     - name: Run test
       run: |
         bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.6.0
+
+* Support multiple associations and alias table names for `search` method.
+* Change join method from `joins` to `left_joins` for `search` method.
+
+## 0.5.0
+
+* Drop support for ruby <= 2.7, rails <= 6.1.
+
 ## 0.4.0
 
 * Add `frozen_string_literal: true`.

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem "activerecord", ">= 7.0.0"
+gem "sqlite3"

data/README.md

@@ -4,9 +4,9 @@ A parser to generate a tree structure from a logical search query string using t
 
 ## Dependencies
 
-* ruby 2.3+
+* ruby 3.0+
 * treetop 1.6+
-* activerecord 4.2+ (optional)
+* activerecord 7.0+ (optional)
 
 ## Installation
 
@@ -99,16 +99,36 @@ Use with associations:
 ```ruby
 class Doc < ActiveRecord::Base
   has_many :tags
+  has_many :flags
 end
 
 class Tag < ActiveRecord::Base
+  belongs_to :doc
+end
+
+class Flag < ActiveRecord::Base
+  belongs_to :doc
 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"
+#  LEFT OUTER 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%'))
+
+LogicalQueryParser.search("a AND b", Doc.all, :c1, :c2, tags: [:c3], flags: [:c4]).to_sql
+# SELECT "docs".* FROM "docs"
+#  LEFT OUTER JOIN "tags" ON "tags"."doc_id" = "docs"."id"
+#  LEFT OUTER JOIN "flags" ON "flags"."doc_id" = "docs"."id"
+#  WHERE (((("docs"."c1" LIKE '%a%' OR "docs"."c2" LIKE '%a%') OR "tags"."c3" LIKE '%a%') OR "flags"."c4" LIKE '%a%') AND 
+#        ((("docs"."c1" LIKE '%b%' OR "docs"."c2" LIKE '%b%') OR "tags"."c3" LIKE '%b%') OR "flags"."c4" LIKE '%b%'))
+
+LogicalQueryParser.search("a AND b", Doc.all, :c1, tags: [:c2, doc: [:c3]]).to_sql
+# SELECT "docs".* FROM "docs"
+#  LEFT OUTER JOIN "tags" ON "tags"."doc_id" = "docs"."id"
+#  LEFT OUTER JOIN "docs" AS "docs_tags" ON "docs_tags"."id" = "tags"."doc_id"
+#  WHERE ((("docs"."c1" LIKE '%a%' OR "tags"."c2" LIKE '%a%') OR "docs_tags"."c3" LIKE '%a%') AND
+#        (("docs"."c1" LIKE '%b%' OR "tags"."c2" LIKE '%b%') OR "docs_tags"."c3" LIKE '%b%'))
 ```
 
 ## Contributing

data/gemfiles/rails70.gemfile

@@ -1,6 +1,13 @@
 source 'https://rubygems.org'
 
-gem "rails", "~> 7.0.1"
+gem "activerecord", "~> 7.0.1"
 gem "sqlite3", "~> 1.4.0"
 
+gem "concurrent-ruby", "<= 1.3.4"
+
+if RUBY_VERSION >= "3.4"
+  gem "bigdecimal"
+  gem "mutex_m"
+end
+
 gemspec path: "../"

data/gemfiles/rails71.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem "rails", "~> 7.1.0"
+gem "activerecord", "~> 7.1.0"
 gem "sqlite3", "~> 1.6.6"
 
 gemspec path: "../"

data/gemfiles/{rails61.gemfile → rails72.gemfile}

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem "rails", "~> 6.1.0"
-gem "sqlite3", "~> 1.4.0"
+gem "activerecord", "~> 7.2.0"
+gem "sqlite3"
 
 gemspec path: "../"

data/gemfiles/rails80.gemfile

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

data/gemfiles/rails81.gemfile

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

data/lib/logical_query_parser/assoc_node.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module LogicalQueryParser
+  class AssocNode
+    attr_accessor :klass, :assoc_name, :table_name, :columns, :parent, :children
+
+    def initialize(options = {})
+      options.each do |key, value|
+        send("#{key}=", value)
+      end
+      @columns ||= []
+      @children ||= []
+    end
+
+    def model=(model)
+      @klass = model
+      @table_name = model.table_name
+    end
+
+    def descendants
+      children.flat_map do |child|
+        [child] + child.descendants
+      end
+    end
+
+    def arel_table
+      Arel::Table.new(table_name, as: table_name)
+    end
+
+    def join_structure
+      if children.empty?
+        {}
+      else
+        children.each_with_object({}) do |child, hash|
+          hash[child.assoc_name] = child.join_structure
+        end
+      end
+    end
+  end
+end

data/lib/logical_query_parser/assoc_resolver.rb

@@ -1,18 +1,25 @@
 # frozen_string_literal: true
 
-require_relative 'assoc'
+require_relative 'assoc_node'
 
 module LogicalQueryParser
   class AssocResolver
-    def initialize(klass)
-      @klass = klass
+    def initialize(relation, *options)
+      @relation = relation
+      @options = options.flatten(1)
     end
 
-    def run(*args)
-      Assoc.new.tap do |assoc|
-        assoc.current = assoc.structure
-        resolve_assocs(@klass, args, assoc)
+    def call
+      root_node = AssocNode.new(klass: @relation.klass, table_name: @relation.table_name)
+      resolve_assocs(@relation.klass, root_node, @options)
+
+      join_relation = @relation.klass.unscoped.left_joins(root_node.join_structure)
+      root_node.descendants.each_with_index do |node, i|
+        join_source = join_relation.arel.join_sources[i]
+        node.table_name = join_source&.left&.name || node.klass.table_name
       end
+
+      root_node
     end
 
     private
@@ -25,24 +32,20 @@ module LogicalQueryParser
       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)
+    def resolve_assocs(current_klass, node, options)
+      wrap_array(options).each do |column_or_assoc_hash|
+        if column_or_assoc_hash.is_a?(Hash)
+          column_or_assoc_hash.each do |assoc_name, nested_column_or_assoc_hash|
+            if (reflection = current_klass.reflect_on_association(assoc_name))
+              child = AssocNode.new(klass: reflection.klass, assoc_name: assoc_name, parent: node)
+              node.children ||= []
+              node.children << child
+              resolve_assocs(reflection.klass, child, nested_column_or_assoc_hash)
+            end
+          end
         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)
+          node.columns ||= []
+          node.columns << column_or_assoc_hash
         end
       end
     end

data/lib/logical_query_parser/nodes/active_record.rb

@@ -75,7 +75,7 @@ module LogicalQueryParser
       operator, logic = operator_and_logic
       text = LogicalQueryParser.unquote(word.text_value)
       
-      sql = build_arel(params, operator, text).reduce(logic).to_sql
+      sql = build_arel(params[:root], operator, text).reduce(logic).to_sql
       sql = "(#{sql})" if sql[0] != '(' && sql[-1] != ')'
       params[:_sql] << sql
     end
@@ -90,21 +90,12 @@ module LogicalQueryParser
       end
     end
 
-    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, Arel.sql(klass.connection.quote("%#{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)
+    def build_arel(root, operator, text)
+      assocs = [root] + root.descendants
+      assocs.flat_map do |assoc|
+        assoc.columns.map do |column|
+          assoc.arel_table[column].send(operator, Arel.sql(assoc.klass.connection.quote("%#{text}%")))
+        end
       end
     end
   end

data/lib/logical_query_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LogicalQueryParser
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/lib/logical_query_parser.rb

@@ -16,13 +16,14 @@ module LogicalQueryParser
 
     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)
+      root = resolve_assocs(relations, *options)
+      sql = new.parse(query).to_sql(root: root)
+      relations = relations.left_joins(root.join_structure) unless root.join_structure.empty?
+      relations.where(sql)
     end
 
-    def resolve_assocs(klass, *options)
-      AssocResolver.new(klass).run(*options)
+    def resolve_assocs(relation, *options)
+      AssocResolver.new(relation, *options).call
     end
 
     def walk_tree(node, &block)

data/logical_query_parser.gemspec

@@ -19,12 +19,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 3.0"
+
   spec.add_dependency "treetop", "~> 1.6.8"
 
+  spec.add_development_dependency "activerecord", ">= 7.0"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "irb"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "sqlite3"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: logical_query_parser
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -25,7 +24,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.8
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +94,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -127,17 +140,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/rails42.gemfile
-- gemfiles/rails50.gemfile
-- gemfiles/rails51.gemfile
-- gemfiles/rails52.gemfile
-- gemfiles/rails60.gemfile
-- gemfiles/rails61.gemfile
 - gemfiles/rails70.gemfile
 - gemfiles/rails71.gemfile
+- gemfiles/rails72.gemfile
+- gemfiles/rails80.gemfile
+- gemfiles/rails81.gemfile
 - lib/logical_query_parser.rb
 - lib/logical_query_parser.treetop
-- lib/logical_query_parser/assoc.rb
+- lib/logical_query_parser/assoc_node.rb
 - lib/logical_query_parser/assoc_resolver.rb
 - lib/logical_query_parser/nodes/active_record.rb
 - lib/logical_query_parser/nodes/base.rb
@@ -147,7 +157,6 @@ homepage: https://github.com/kanety/logical_query_parser
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,15 +164,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A parser for a logical query string.
 test_files: []

data/gemfiles/rails42.gemfile

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

data/gemfiles/rails50.gemfile

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

data/gemfiles/rails51.gemfile

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

data/gemfiles/rails52.gemfile

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

data/gemfiles/rails60.gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem "activerecord", "~> 6.0.0"
-gem "sqlite3", "~> 1.4.0"
-gem "psych", "~> 3.3.0"
-
-gemspec path: "../"

data/lib/logical_query_parser/assoc.rb

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