pursuit 1.0.1 → 1.1.1

data/spec/internal/app/searches/product_variation_search.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ProductVariationSearch
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Search for records matching the specified predicate.
+    #
+    # @param  query [String]                 The query with a predicate.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the predicate.
+    #
+    def predicate_search(query)
+      @predicate_search ||= Pursuit::PredicateSearch.new(default_table: arel_table) do
+        permit_attribute :title
+        permit_attribute :stock_status
+        permit_attribute :currency
+        permit_attribute :amount
+        permit_attribute :product, Product.arel_table[:id]
+        permit_attribute :product_title, Product.arel_table[:title]
+      end
+
+      @predicate_search.apply(query, left_outer_joins(:product).group(:id))
+    end
+
+    # Search for records matching the specified terms.
+    #
+    # @param  query [String]                 The query with one or more terms.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the terms.
+    #
+    def term_search(query)
+      @term_search ||= Pursuit::TermSearch.new(default_table: arel_table) do
+        search_attribute :title
+      end
+
+      # Note that we're using `all` here, but this still works when used in a chain:
+      # => ProductVariation.where(stock_status: :in_stock).search('Green')
+      @term_search.apply(query, all)
+    end
+
+    # Search for records matching the specified query.
+    #
+    # @param  query [String]                 The query.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the query.
+    #
+    def search(query)
+      return none if query.blank?
+
+      predicate_search(query)
+    rescue Parslet::ParseFailed
+      term_search(query)
+    end
+  end
+end

data/spec/lib/pursuit/predicate_search_spec.rb

@@ -2,27 +2,66 @@
 
 RSpec.describe Pursuit::PredicateSearch do
   subject(:predicate_search) do
-    described_class.new(
-      Product.left_outer_joins(:variations).group(:id),
-      permit_aggregate_modifiers: true
-    ) do
-      permit_attribute :title
-      permit_attribute :variation, ProductVariation.arel_table[:id]
-      permit_attribute :variation_title, ProductVariation.arel_table[:title]
-    end
+    described_class.new(default_table: Product.arel_table, permit_aggregate_modifiers: true)
   end
 
   describe '#initialize' do
-    it 'is expected to set #relation eq `relation`' do
-      expect(predicate_search).to have_attributes(relation: Product.left_outer_joins(:variations).group(:id))
+    it 'is expected to set #default_table eq `default_table`' do
+      expect(predicate_search).to have_attributes(default_table: Product.arel_table)
     end
 
     it 'is expected to set #permit_aggregate_modifiers eq `permit_aggregate_modifiers`' do
       expect(predicate_search).to have_attributes(permit_aggregate_modifiers: true)
     end
 
-    it 'is expected to evaluate the passed block' do
-      expect(predicate_search.permitted_attributes).to be_present
+    it 'is expected to invoke the passed block' do
+      expect { |block| described_class.new(&block) }.to yield_control
+    end
+  end
+
+  describe '#permit_attribute' do
+    subject(:permit_attribute) { predicate_search.permit_attribute(name, attribute) }
+
+    context 'when `attribute` is nil' do
+      let(:name)      { :title }
+      let(:attribute) { nil }
+
+      it 'is expected to add the attribute from #default_table to #permitted_attributes' do
+        permit_attribute
+        expect(predicate_search.permitted_attributes).to match(
+          hash_including(
+            title: Product.arel_table[:title]
+          )
+        )
+      end
+    end
+
+    context 'when `attribute` is a Symbol' do
+      let(:name)      { :name }
+      let(:attribute) { :title }
+
+      it 'is expected to add the attribute from #default_table to #permitted_attributes' do
+        permit_attribute
+        expect(predicate_search.permitted_attributes).to match(
+          hash_including(
+            name: Product.arel_table[:title]
+          )
+        )
+      end
+    end
+
+    context 'when `attribute` is an Arel::Attributes::Attribute' do
+      let(:name)      { :variation_currency }
+      let(:attribute) { ProductVariation.arel_table[:currency] }
+
+      it 'is expected to add the attribute to #permitted_attributes' do
+        permit_attribute
+        expect(predicate_search.permitted_attributes).to match(
+          hash_including(
+            variation_currency: ProductVariation.arel_table[:currency]
+          )
+        )
+      end
     end
   end
 
@@ -38,24 +77,15 @@ RSpec.describe Pursuit::PredicateSearch do
     it { is_expected.to be_a(Pursuit::PredicateTransform) }
   end
 
-  describe '#permit_attribute' do
-    subject(:permit_attribute) do
-      predicate_search.permit_attribute(:variation_currency, ProductVariation.arel_table[:currency])
-    end
-
-    it 'is expected to add the attribute to #permitted_attributes' do
-      permit_attribute
-      expect(predicate_search.permitted_attributes).to match(
-        hash_including(
-          variation_currency: ProductVariation.arel_table[:currency]
-        )
-      )
-    end
-  end
-
   describe '#parse' do
     subject(:parse) { predicate_search.parse('title ~ Shirt & #variation > 0') }
 
+    before do
+      predicate_search.permitted_attributes[:title] = Product.arel_table[:title]
+      predicate_search.permitted_attributes[:variation] = ProductVariation.arel_table[:id]
+      predicate_search.permitted_attributes[:variation_title] = ProductVariation.arel_table[:title]
+    end
+
     it 'is expected to equal a Hash containing the ARel nodes' do
       expect(parse).to eq(
         {
@@ -67,9 +97,15 @@ RSpec.describe Pursuit::PredicateSearch do
   end
 
   describe '#apply' do
-    subject(:apply) { predicate_search.apply('title ~ Shirt') }
+    subject(:apply) { predicate_search.apply('title ~ Shirt', Product.left_outer_joins(:variations).group(:id)) }
+
+    before do
+      predicate_search.permitted_attributes[:title] = Product.arel_table[:title]
+      predicate_search.permitted_attributes[:variation] = ProductVariation.arel_table[:id]
+      predicate_search.permitted_attributes[:variation_title] = ProductVariation.arel_table[:title]
+    end
 
-    it 'is expected to equal #relation with predicate clauses applied' do
+    it 'is expected to equal `relation` with predicate clauses applied' do
       expect(apply).to eq(
         Product.left_outer_joins(:variations).group(:id).where(
           Product.arel_table[:title].matches('%Shirt%')

data/spec/lib/pursuit/predicate_transform_spec.rb

@@ -20,7 +20,8 @@ RSpec.describe Pursuit::PredicateTransform do
         variations: ProductVariation.arel_table[Arel.star],
         variation_title: ProductVariation.arel_table[:title],
         variation_currency: ProductVariation.arel_table[:currency],
-        variation_amount: ProductVariation.arel_table[:amount]
+        variation_amount: ProductVariation.arel_table[:amount],
+        variation_count: ProductVariation.arel_table[Arel.star].count
       }.with_indifferent_access
     end
 
@@ -340,6 +341,20 @@ RSpec.describe Pursuit::PredicateTransform do
       it { expect { apply }.to raise_exception(Pursuit::AggregateModifierRequired) }
     end
 
+    context 'when passed a comparison with an attribute representing a custom node' do
+      let(:tree) do
+        {
+          attribute: { string_no_quotes: 'variation_count' },
+          comparator: '=',
+          value: { integer: '123' }
+        }
+      end
+
+      it 'is expected to equal the correct ARel node' do
+        expect(apply).to eq(ProductVariation.arel_table[Arel.star].count.eq(123))
+      end
+    end
+
     context 'when passed an aggregate comparison with the "=" comparator' do
       let(:tree) do
         {

data/spec/lib/pursuit/simple_search_spec.rb

@@ -1,39 +1,48 @@
 # frozen_string_literal: true
 
 RSpec.describe Pursuit::SimpleSearch do
-  subject(:simple_search) do
-    described_class.new(
-      Product.left_outer_joins(:variations).group(:id)
-    ) do
-      search_attribute :title
-      search_attribute ProductVariation.arel_table[:title]
-    end
-  end
+  subject(:simple_search) { described_class.new(default_table: Product.arel_table) }
 
   describe '#initialize' do
-    it 'is expected to set #relation eq `relation`' do
-      expect(simple_search).to have_attributes(relation: Product.left_outer_joins(:variations).group(:id))
+    it 'is expected to set #default_table eq `default_table`' do
+      expect(simple_search).to have_attributes(default_table: Product.arel_table)
     end
 
-    it 'is expected to evaluate the passed block' do
-      expect(simple_search.attributes).to be_present
+    it 'is expected to invoke the passed block' do
+      expect { |block| described_class.new(&block) }.to yield_control
     end
   end
 
   describe '#search_attribute' do
-    subject(:search_attribute) do
-      simple_search.search_attribute(ProductVariation.arel_table[:currency])
+    subject(:search_attribute) { simple_search.search_attribute(attribute) }
+
+    context 'when `attribute` is a Symbol' do
+      let(:attribute) { :title }
+
+      it 'is expected to add the attribute from #default_table to #attributes' do
+        search_attribute
+        expect(simple_search.attributes).to include(Product.arel_table[:title])
+      end
     end
 
-    it 'is expected to add the attribute to #attributes' do
-      search_attribute
-      expect(simple_search.attributes).to include(ProductVariation.arel_table[:currency])
+    context 'when `attribute` is an Arel::Attributes::Attribute' do
+      let(:attribute) { ProductVariation.arel_table[:currency] }
+
+      it 'is expected to add the attribute to #attributes' do
+        search_attribute
+        expect(simple_search.attributes).to include(ProductVariation.arel_table[:currency])
+      end
     end
   end
 
   describe '#parse' do
     subject(:parse) { simple_search.parse('Shirt') }
 
+    before do
+      simple_search.attributes << Product.arel_table[:title]
+      simple_search.attributes << ProductVariation.arel_table[:title]
+    end
+
     it 'is expected to equal the ARel node' do
       expect(parse).to eq(
         Product.arel_table[:title].matches('%Shirt%').or(
@@ -44,9 +53,14 @@ RSpec.describe Pursuit::SimpleSearch do
   end
 
   describe '#apply' do
-    subject(:apply) { simple_search.apply('Shirt') }
+    subject(:apply) { simple_search.apply('Shirt', Product.left_outer_joins(:variations).group(:id)) }
+
+    before do
+      simple_search.attributes << Product.arel_table[:title]
+      simple_search.attributes << ProductVariation.arel_table[:title]
+    end
 
-    it 'is expected to equal #relation with clauses applied' do
+    it 'is expected to equal `relation` with simple clauses applied' do
       expect(apply).to eq(
         Product.left_outer_joins(:variations).group(:id).where(
           Product.arel_table[:title].matches('%Shirt%').or(

data/spec/lib/pursuit/term_search_spec.rb

@@ -1,22 +1,15 @@
 # frozen_string_literal: true
 
 RSpec.describe Pursuit::TermSearch do
-  subject(:term_search) do
-    described_class.new(
-      Product.left_outer_joins(:variations).group(:id)
-    ) do
-      search_attribute :title
-      search_attribute ProductVariation.arel_table[:title]
-    end
-  end
+  subject(:term_search) { described_class.new(default_table: Product.arel_table) }
 
   describe '#initialize' do
-    it 'is expected to set #relation eq `relation`' do
-      expect(term_search).to have_attributes(relation: Product.left_outer_joins(:variations).group(:id))
+    it 'is expected to set #default_table eq `default_table`' do
+      expect(term_search).to have_attributes(default_table: Product.arel_table)
     end
 
-    it 'is expected to evaluate the passed block' do
-      expect(term_search.attributes).to be_present
+    it 'is expected to invoke the passed block' do
+      expect { |block| described_class.new(&block) }.to yield_control
     end
   end
 
@@ -33,19 +26,35 @@ RSpec.describe Pursuit::TermSearch do
   end
 
   describe '#search_attribute' do
-    subject(:search_attribute) do
-      term_search.search_attribute(ProductVariation.arel_table[:currency])
+    subject(:search_attribute) { term_search.search_attribute(attribute) }
+
+    context 'when `attribute` is a Symbol' do
+      let(:attribute) { :title }
+
+      it 'is expected to add the attribute from #default_table to #attributes' do
+        search_attribute
+        expect(term_search.attributes).to include(Product.arel_table[:title])
+      end
     end
 
-    it 'is expected to add the attribute to #attributes' do
-      search_attribute
-      expect(term_search.attributes).to include(ProductVariation.arel_table[:currency])
+    context 'when `attribute` is an Arel::Attributes::Attribute' do
+      let(:attribute) { ProductVariation.arel_table[:currency] }
+
+      it 'is expected to add the attribute to #attributes' do
+        search_attribute
+        expect(term_search.attributes).to include(ProductVariation.arel_table[:currency])
+      end
     end
   end
 
   describe '#parse' do
     subject(:parse) { term_search.parse('Shirt') }
 
+    before do
+      term_search.attributes << Product.arel_table[:title]
+      term_search.attributes << ProductVariation.arel_table[:title]
+    end
+
     it 'is expected to equal the ARel node' do
       expect(parse).to eq(
         Product.arel_table[:title].matches('%Shirt%').or(
@@ -56,9 +65,14 @@ RSpec.describe Pursuit::TermSearch do
   end
 
   describe '#apply' do
-    subject(:apply) { term_search.apply('Shirt') }
+    subject(:apply) { term_search.apply('Shirt', Product.left_outer_joins(:variations).group(:id)) }
+
+    before do
+      term_search.attributes << Product.arel_table[:title]
+      term_search.attributes << ProductVariation.arel_table[:title]
+    end
 
-    it 'is expected to equal #relation with term clauses applied' do
+    it 'is expected to equal `relation` with term clauses applied' do
       expect(apply).to eq(
         Product.left_outer_joins(:variations).group(:id).where(
           Product.arel_table[:title].matches('%Shirt%').or(

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pursuit
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Nialto Services
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2025-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -64,14 +63,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description:
 email:
 - support@nialtoservices.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/rubygem.yaml"
+- ".github/gemfiles/ruby-2.6.gemfile"
+- ".github/gemfiles/ruby-2.7.gemfile"
+- ".github/gemfiles/ruby-3.0.gemfile"
+- ".github/gemfiles/ruby-3.1.gemfile"
+- ".github/gemfiles/ruby-3.2.gemfile"
+- ".github/gemfiles/ruby-3.3.gemfile"
+- ".github/gemfiles/ruby-3.4.gemfile"
+- ".github/gemfiles/ruby-head.gemfile"
+- ".github/gemfiles/ruby-jruby-head.gemfile"
+- ".github/gemfiles/ruby-jruby.gemfile"
+- ".github/gemfiles/ruby-truffleruby-head.gemfile"
+- ".github/gemfiles/ruby-truffleruby.gemfile"
+- ".github/workflows/continuous-integration.yaml"
 - ".gitignore"
 - ".rbenv-gemsets"
 - ".rspec"
@@ -106,6 +116,9 @@ files:
 - spec/internal/app/models/product.rb
 - spec/internal/app/models/product_category.rb
 - spec/internal/app/models/product_variation.rb
+- spec/internal/app/searches/product_category_search.rb
+- spec/internal/app/searches/product_search.rb
+- spec/internal/app/searches/product_variation_search.rb
 - spec/internal/config/database.yml
 - spec/internal/db/schema.rb
 - spec/internal/log/.keep
@@ -118,14 +131,12 @@ files:
 - spec/lib/pursuit/term_transform_spec.rb
 - spec/lib/pursuit_spec.rb
 - spec/spec_helper.rb
-- travis/gemfiles/7.1.gemfile
 homepage: https://github.com/NialtoServices/pursuit
 licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
   yard.run: yri
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Advanced key-based searching for ActiveRecord objects.
 test_files: []

data/.github/workflows/rubygem.yaml

@@ -1,46 +0,0 @@
-name: RubyGem
-
-on:
-  workflow_dispatch:
-  push:
-
-jobs:
-  rubocop:
-    name: RuboCop
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Source Code
-        uses: actions/checkout@v3
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-      - name: Setup RubyGems
-        run: |
-          bundle install
-      - name: RuboCop
-        run: |
-          bundle exec rubocop --parallel --format progress --format html --out rubocop-report.html
-      - name: Upload Report
-        uses: actions/upload-artifact@v3
-        with:
-          name: RuboCop Report
-          path: rubocop-report.html
-
-  rspec:
-    name: RSpec
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Source Code
-        uses: actions/checkout@v3
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-      - name: Setup RubyGems
-        run: |
-          bundle install
-      - name: RSpec
-        run: |
-          bundle exec rspec --format progress --format html --out rspec-report.html
-      - name: Upload Report
-        uses: actions/upload-artifact@v3
-        with:
-          name: RSpec Report
-          path: rspec-report.html

data/travis/gemfiles/7.1.gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec path: '../../'
-
-gem 'activerecord',  '~> 7.1.0'
-gem 'activesupport', '~> 7.1.0'