logical_query_parser 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22d02f1282d55df340c385cd13c61186f4230f22f8282c7fd67b781dacd2fbd0
-  data.tar.gz: b952657d8f60d182c037c308005b5e6fca626b2a607fbc6d8892b93b48e74daa
+  metadata.gz: 50d9e7d0d793b457dd2561160c3fc0e2a0611d7425c671a624c19c5e7395fd92
+  data.tar.gz: cc8b9d94d8c13c5764e82b64be14d6b68e050f8d7fe9a3b53c624aa973dbb949
 SHA512:
-  metadata.gz: 4eba4f1502637981543337180b179dbd03ee0cb7eabc4215cf256a3f1654bb3bbd2db9b4690e4dc9c1f81f4a3fa2a7bdae3da3b9c75700bcd693f6b9c877ebaa
-  data.tar.gz: 256ad90335de5fe846cd6b38620b7dbca8f480c1a3783141adcb53691f28cd6172df75774c51eabca395562b340c493992c2935504b00cc32a7886b8dac5013f
+  metadata.gz: fd0590d955cba3c8b10d2441e62d720131bffb46ecbfbbf5df3ed49fc1e27aeb1a81a28e2ae18d3cdd50e553a0802a24b66b3c5d77b15395391bae7a18e095e4
+  data.tar.gz: 678c2067c0dae4587dde4158d251ccb7643479af9ff0c894be7c3410a02c2970a0e83ea8275a300d0ed2b89f08aaa98ddabd0332dca40e62033d00d65c76f208

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
       matrix:
@@ -28,7 +28,7 @@ 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 }}

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # 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.

data/README.md

@@ -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/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.5.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

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
 
   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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logical_query_parser
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
@@ -23,6 +23,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.8
+- !ruby/object:Gem::Dependency
+  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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +147,7 @@ files:
 - 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

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