pursuit 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b49ae3ec2734b8b67fef2fb0686b85af3a694745db4654de863942d4a598d53
-  data.tar.gz: 8d8a6e71f23b31d0ebf33a1c2554a9875c0c189786954574c3d5f58ced5fe304
+  metadata.gz: e692c274eaa14b0f1311c56917447a1526285274722fd420fccf3892ac1fcb37
+  data.tar.gz: e7133d0015ea96a8930340e458fb427a2ebf81f4e15c95662b4b9f9a0ed5be81
 SHA512:
-  metadata.gz: faebb7031e643b0fe4011cee2fda71a916dd12aa2819845a26bf79ef6ca0f0411bcd3e8b5ea1f092624909933639d97d0e59cc2b80ba38ea10f2dcbf0254c154
-  data.tar.gz: 0c06093eb83369d20f5e64a843483e98a019a5facb594f75b845949cfdcc0b7027da78ccb8be92d6a739cc76720e1d28165019aaaf7220718deb550c2816440a
+  metadata.gz: b3b007b9d56efdaa21fc7cb1d7d2d7a8bd9c7988269f614aee7db9cd3e620a92317ede365528aff8f61dcb2fb531c95ded3b29a5a4730fce6b9c3e400ea4c807
+  data.tar.gz: 7340594ab1b4dc75dcc6722304b46b7535591968d5bf65d3f8544a559000162bde3d8d808374e951aa564d8a67e752ef89590b41f23f77e2868b12930d2fa4e6

data/.ruby-version

@@ -1 +1 @@
-3.0.2
+3.1.0

data/Gemfile.lock

@@ -1,50 +1,49 @@
 PATH
   remote: .
   specs:
-    pursuit (0.2.0)
-      activerecord (>= 5.2.0, < 6.2.0)
-      activesupport (>= 5.2.0, < 6.2.0)
+    pursuit (0.4.0)
+      activerecord (>= 5.2.0, < 7.1.0)
+      activesupport (>= 5.2.0, < 7.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.4.1)
-      actionview (= 6.0.4.1)
-      activesupport (= 6.0.4.1)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (7.0.1)
+      actionview (= 7.0.1)
+      activesupport (= 7.0.1)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.4.1)
-      activesupport (= 6.0.4.1)
+    actionview (7.0.1)
+      activesupport (= 7.0.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.4.1)
-      activesupport (= 6.0.4.1)
-    activerecord (6.0.4.1)
-      activemodel (= 6.0.4.1)
-      activesupport (= 6.0.4.1)
-    activesupport (6.0.4.1)
+    activemodel (7.0.1)
+      activesupport (= 7.0.1)
+    activerecord (7.0.1)
+      activemodel (= 7.0.1)
+      activesupport (= 7.0.1)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
-    combustion (1.3.3)
+    combustion (1.3.5)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
     concurrent-ruby (1.1.9)
     crass (1.0.6)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     erubi (1.10.0)
-    ffi (1.15.4)
-    formatador (0.3.0)
+    ffi (1.15.5)
+    formatador (1.0.0)
     guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -61,24 +60,23 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    listen (3.7.0)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.12.0)
+    loofah (2.13.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     nenv (0.3.0)
-    nokogiri (1.12.5-x86_64-darwin)
+    nokogiri (1.13.1-x86_64-darwin)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -92,70 +90,78 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.4.1)
-      actionpack (= 6.0.4.1)
-      activesupport (= 6.0.4.1)
+    railties (7.0.1)
+      actionpack (= 7.0.1)
+      activesupport (= 7.0.1)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rainbow (3.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.4)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (3.9.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    rubocop (0.77.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.3)
+    rubocop (1.25.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     shellany (0.0.1)
     sqlite3 (1.4.2)
-    thor (1.1.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    yard (0.9.26)
-    zeitwerk (2.5.1)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    zeitwerk (2.5.3)
 
 PLATFORMS
   x86_64-darwin-21
 
 DEPENDENCIES
   bundler (~> 2.0)
-  combustion (~> 1.1)
+  combustion (~> 1.3)
   guard-rspec (~> 4.7)
   pursuit!
   rake (~> 13.0)
-  rspec (~> 3.8)
-  rspec-rails (~> 3.8)
-  rubocop (~> 0.77.0)
+  rspec (~> 3.10)
+  rspec-rails (~> 5.0)
+  rubocop (~> 1.25)
   sqlite3 (~> 1.4)
-  yard (~> 0.9.20)
+  yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.22
+   2.3.3

data/README.md

@@ -23,19 +23,24 @@ class Product < ActiveRecord::Base
   searchable do |o|
     o.relation :variations, :title, :stock_status
 
-    o.keyed :title
-    o.keyed :description
-    o.keyed :rating
-
-    # You can also create virtual attributes to search by passing in a block that returns an arel node.
-    o.keyed :title_length do
+    # Attributes can be used for both keyed and unkeyed searching by default, but you can pass either `keyed: false` or
+    # `unkeyed: false` to restrict when the attribute is searched.
+    o.attribute :title
+    o.attribute :description
+    o.attribute :rating, unkeyed: false
+
+    # You can shorten the search keyword by passing the desired search term first, and then the real attribute name
+    # as the second argument.
+    #  => "category*=shirts"
+    o.attribute :category, :category_id
+
+    # It's also possible to query entirely custom Arel nodes by passing a block which returns the Arel node to query.
+    # You could use this to query a person's full name by concatenating their first and last name columns, for example.
+    o.attribute :title_length, unkeyed: false do
       Arel::Nodes::NamedFunction.new('LENGTH', [
         arel_table[:title]
       ])
     end
-
-    o.unkeyed :title
-    o.unkeyed :description
   end
 end
 ```

data/lib/pursuit/constants.rb

@@ -3,5 +3,5 @@
 module Pursuit
   # @return [String] The gem's semantic version number.
   #
-  VERSION = '0.2.0'
+  VERSION = '0.4.0'
 end

data/lib/pursuit/search.rb

@@ -51,12 +51,13 @@ module Pursuit
       return nil if terms.blank?
 
       terms.reduce(nil) do |chain, term|
-        reflection = options.record_class.reflections[term.key]
+        attribute_name = term.key.to_sym
+        reflection = options.relations.key?(attribute_name) ? options.record_class.reflections[term.key] : nil
         node = if reflection.present?
-                 attribute_names = options.relations[term.key.to_sym]
+                 attribute_names = options.relations[attribute_name]
                  build_arel_for_reflection(reflection, attribute_names, term.operator, term.value)
                else
-                 node_builder = options.keyed_attributes[term.key.to_sym]
+                 node_builder = options.keyed_attributes[attribute_name]
                  build_arel_for_node(node_builder.call, term.operator, term.value)
                end
 

data/lib/pursuit/search_options.rb

@@ -2,44 +2,59 @@
 
 module Pursuit
   class SearchOptions
+    # @return [Struct] The structure which holds the search options for a single attribute.
+    #
+    AttributeOptions = Struct.new(:keyed, :unkeyed, :block)
+
     # @return [Class<ActiveRecord::Base>] The `ActiveRecord::Base` child class to search.
     #
     attr_reader :record_class
 
-    # @return [Hash<Symbol, Array<Symbol>>] The record's relatives and the attribute names that can be searched.
+    # @return [Hash<Symbol, Array<Symbol>>] The attribute names of the record's relatives which can be searched.
     #
     attr_reader :relations
 
-    # @return [Hash<Symbol, Proc>] The attribute names which can be searched with a keyed term (e.g. 'last_name:*herb').
-    #
-    attr_reader :keyed_attributes
-
-    # @return [Hash<Symbol, Proc>] The attribute names which can be searched with an unkeyed term (e.g. 'herb').
+    # @return [Hash<Symbol, AttributeOptions>] The attributes which can be searched.
     #
-    attr_reader :unkeyed_attributes
+    attr_reader :attributes
 
-    # Create a new `SearchOptions` ready for adding options.
+    # Create a new `SearchOptions` and call the passed block to setup the options.
     #
     # @params record_class [Class<ActiveRecord::Base>]
-    # @params block [Proc]
+    # @params block        [Proc]
     #
     def initialize(record_class, &block)
       @record_class = record_class
       @relations = {}
-      @keyed_attributes = {}
-      @unkeyed_attributes = {}
+      @attributes = {}
 
       block.call(self) if block
     end
 
+    # @return [Hash<Symbol, Proc>] The attributes which can be queried using a keyed term.
+    #
+    def keyed_attributes
+      attributes.each_with_object({}) do |(name, options), keyed_attributes|
+        keyed_attributes[name] = options.block if options.keyed
+      end
+    end
+
+    # @return [Hash<Symbol, Proc>] The attributes which can be queried using an unkeyed term.
+    #
+    def unkeyed_attributes
+      attributes.each_with_object({}) do |(name, options), unkeyed_attributes|
+        unkeyed_attributes[name] = options.block if options.unkeyed
+      end
+    end
+
     # @return [Array<String>] The collection of all possible attributes which can be used as a keyed term.
     #
     def keys
-      keys = relations.keys + keyed_attributes.keys
+      keys = relations.keys + attributes.select { |_, a| a.keyed }.keys
       keys.map(&:to_s).uniq
     end
 
-    # Add a relation to the search options.
+    # Add a relation to search.
     #
     # @param name            [Symbol] The name of the relationship attribute.
     # @param attribute_names [Splat]  The name of the attributes within the relationship to search.
@@ -49,23 +64,22 @@ module Pursuit
       nil
     end
 
-    # Add a keyed attribute to search.
-    #
-    # @param name  [Symbol] The name of the attribute.
-    # @param block [Proc]   A block which returns an arel node to query against instead of a real attribute.
-    #
-    def keyed(name, &block)
-      keyed_attributes[name] = block || -> { record_class.arel_table[name] }
-      nil
-    end
-
-    # Add an unkeyed attribute to search.
+    # Add an attribute to search.
     #
-    # @param name  [Symbol] The name of the attribute.
-    # @param block [Proc]   A block which returns an arel node to query against instead of a real attribute.
+    # @param term_name      [Symbol]  The keyed search term (can be an existing attribute, or a custom value when
+    #                                 passing either the `attribute_name` or a block returning an Arel node).
+    # @param attribute_name [Symbol]  The attribute name to search (defaults to the keyword, when left blank and no
+    #                                 block is passed).
+    # @param keyed          [Boolean] `true` when the attribute should be searchable using a keyed term,
+    #                                 `false` otherwise.
+    # @param unkeyed        [Boolean] `true` when the attribute should be searchable using an unkeyed term,
+    #                                 `false` otherwise.
+    # @param block          [Proc]    A block which returns the Arel node to query against. When left blank, the
+    #                                 matching attribute from `.arel_table` is queried instead.
     #
-    def unkeyed(name, &block)
-      unkeyed_attributes[name] = block || -> { record_class.arel_table[name] }
+    def attribute(term_name, attribute_name = nil, keyed: true, unkeyed: true, &block)
+      block ||= -> { record_class.arel_table[attribute_name || term_name] }
+      attributes[term_name] = AttributeOptions.new(keyed, unkeyed, block)
       nil
     end
   end

data/pursuit.gemspec

@@ -21,16 +21,16 @@ Gem::Specification.new do |spec|
 
   spec.metadata['yard.run'] = 'yri'
 
-  spec.add_runtime_dependency 'activerecord',  '>= 5.2.0', '< 6.2.0'
-  spec.add_runtime_dependency 'activesupport', '>= 5.2.0', '< 6.2.0'
+  spec.add_runtime_dependency 'activerecord',  '>= 5.2.0', '< 7.1.0'
+  spec.add_runtime_dependency 'activesupport', '>= 5.2.0', '< 7.1.0'
 
   spec.add_development_dependency 'bundler',     '~> 2.0'
-  spec.add_development_dependency 'combustion',  '~> 1.1'
+  spec.add_development_dependency 'combustion',  '~> 1.3'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'rake',        '~> 13.0'
-  spec.add_development_dependency 'rspec',       '~> 3.8'
-  spec.add_development_dependency 'rspec-rails', '~> 3.8'
-  spec.add_development_dependency 'rubocop',     '~> 0.77.0'
-  spec.add_development_dependency 'yard',        '~> 0.9.20'
+  spec.add_development_dependency 'rspec',       '~> 3.10'
+  spec.add_development_dependency 'rspec-rails', '~> 5.0'
+  spec.add_development_dependency 'rubocop',     '~> 1.25'
+  spec.add_development_dependency 'yard',        '~> 0.9'
   spec.add_development_dependency 'sqlite3',     '~> 1.4'
 end

data/spec/internal/app/models/product.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class Product < ActiveRecord::Base
+  belongs_to :category, class_name: 'ProductCategory', inverse_of: :products, optional: true
+
   has_many :variations, class_name: 'ProductVariation', inverse_of: :product
 
   validates :title, presence: true
@@ -8,17 +10,15 @@ class Product < ActiveRecord::Base
   searchable do |o|
     o.relation :variations, :title, :stock_status
 
-    o.keyed :title
-    o.keyed :description
-    o.keyed :rating
-
-    o.keyed :title_length do
+    o.attribute :title
+    o.attribute :description
+    o.attribute :rating, unkeyed: false
+    o.attribute :title_length, unkeyed: false do
       Arel::Nodes::NamedFunction.new('LENGTH', [
         arel_table[:title]
       ])
     end
 
-    o.unkeyed :title
-    o.unkeyed :description
+    o.attribute :category, :category_id
   end
 end

data/spec/internal/app/models/product_category.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ProductCategory < ActiveRecord::Base
+  has_many :products, class_name: 'Product', foreign_key: :category_id, inverse_of: :category, dependent: :nullify
+
+  validates :name, presence: true
+end

data/spec/internal/db/schema.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
 ActiveRecord::Schema.define do
+  create_table :product_categories, id: :string, force: true do |t|
+    t.string :name, null: false
+
+    t.timestamps null: false
+  end
+
   create_table :products, force: true do |t|
+    t.belongs_to :category, type: :string, foreign_key: { to_table: 'product_categories' }
+
     t.string :title, null: false
 
     t.text :description

data/spec/pursuit/search_options_spec.rb

@@ -11,19 +11,6 @@ RSpec.describe Pursuit::SearchOptions do
     end
   end
 
-  before do
-    search_options.relation :variations, :title, :stock_status
-
-    search_options.keyed :title
-    search_options.keyed :title_length, &title_length_node_builder
-    search_options.keyed :description
-    search_options.keyed :rating
-
-    search_options.unkeyed :title
-    search_options.unkeyed :title_length, &title_length_node_builder
-    search_options.unkeyed :description
-  end
-
   describe '#record_class' do
     subject(:record_class) { search_options.record_class }
 
@@ -35,6 +22,10 @@ RSpec.describe Pursuit::SearchOptions do
   describe '#relations' do
     subject(:relations) { search_options.relations }
 
+    before do
+      search_options.relation :variations, :title, :stock_status
+    end
+
     it 'is expected to contain the correct relations' do
       expect(relations).to eq(variations: %i[title stock_status])
     end
@@ -43,12 +34,19 @@ RSpec.describe Pursuit::SearchOptions do
   describe '#keyed_attributes' do
     subject(:keyed_attributes) { search_options.keyed_attributes }
 
+    before do
+      search_options.attribute :title, keyed: false
+      search_options.attribute :title_length, &title_length_node_builder
+      search_options.attribute :description
+      search_options.attribute :rating, unkeyed: false
+    end
+
     it 'is expected to contain the correct keyed attributes' do
-      expect(keyed_attributes.keys).to contain_exactly(:title, :title_length, :description, :rating)
+      expect(keyed_attributes.keys).to contain_exactly(:title_length, :description, :rating)
     end
 
     it 'is expected to set a default node builder for attributes declared without a block' do
-      expect(keyed_attributes[:title].call).to eq(Product.arel_table[:title])
+      expect(keyed_attributes[:description].call).to eq(Product.arel_table[:description])
     end
 
     it 'is expected to set a custom node builder for attributes declared with a block' do
@@ -59,6 +57,13 @@ RSpec.describe Pursuit::SearchOptions do
   describe '#unkeyed_attributes' do
     subject(:unkeyed_attributes) { search_options.unkeyed_attributes }
 
+    before do
+      search_options.attribute :title, keyed: false
+      search_options.attribute :title_length, &title_length_node_builder
+      search_options.attribute :description
+      search_options.attribute :rating, unkeyed: false
+    end
+
     it 'is expected to contain the correct unkeyed attributes' do
       expect(unkeyed_attributes.keys).to contain_exactly(:title, :title_length, :description)
     end
@@ -71,4 +76,73 @@ RSpec.describe Pursuit::SearchOptions do
       expect(unkeyed_attributes[:title_length]).to eq(title_length_node_builder)
     end
   end
+
+  describe '#relation' do
+    subject(:relation) { search_options.relation(:variations, :title, :stock_status) }
+
+    it 'is expected to add the relation to #relations' do
+      expect { relation }.to change(search_options, :relations).from({}).to(variations: %i[title stock_status])
+    end
+  end
+
+  describe '#attribute' do
+    subject(:attribute) { search_options.attribute(:description) }
+
+    it { is_expected.to eq(nil) }
+
+    it 'is expected to add the attribute to #attributes' do
+      expect { attribute }.to change(search_options.attributes, :keys).from([]).to(%i[description])
+    end
+
+    it 'is expected to allow keyed searching by default' do
+      attribute
+      expect(search_options.attributes[:description].keyed).to eq(true)
+    end
+
+    it 'is expected to allow unkeyed searching by default' do
+      attribute
+      expect(search_options.attributes[:description].unkeyed).to eq(true)
+    end
+
+    it 'is expected to query the #term_name attribute' do
+      attribute
+      expect(search_options.attributes[:description].block.call).to eq(Product.arel_table[:description])
+    end
+
+    context 'when passing the attribute name to search' do
+      subject(:attribute) { search_options.attribute(:desc, :description) }
+
+      it 'is expected to query the #attribute_name attribute' do
+        attribute
+        expect(search_options.attributes[:desc].block.call).to eq(Product.arel_table[:description])
+      end
+    end
+
+    context 'when passing :keyed eq false' do
+      subject(:attribute) { search_options.attribute(:description, keyed: false) }
+
+      it 'is expected to disallow keyed searching' do
+        attribute
+        expect(search_options.attributes[:description].keyed).to eq(false)
+      end
+    end
+
+    context 'when passing :unkeyed eq false' do
+      subject(:attribute) { search_options.attribute(:description, unkeyed: false) }
+
+      it 'is expected to disallow unkeyed searching' do
+        attribute
+        expect(search_options.attributes[:description].unkeyed).to eq(false)
+      end
+    end
+
+    context 'when passing a block' do
+      subject(:attribute) { search_options.attribute(:description, &title_length_node_builder) }
+
+      it 'is expected to query the result of the passed block' do
+        attribute
+        expect(search_options.attributes[:description].block).to eq(title_length_node_builder)
+      end
+    end
+  end
 end

data/spec/pursuit/search_spec.rb

@@ -7,18 +7,16 @@ RSpec.describe Pursuit::Search do
     Pursuit::SearchOptions.new(Product) do |o|
       o.relation :variations, :title, :stock_status
 
-      o.keyed :title
-      o.keyed :description
-      o.keyed :rating
-
-      o.keyed :title_length do
+      o.attribute :title
+      o.attribute :description
+      o.attribute :rating, unkeyed: false
+      o.attribute :title_length, unkeyed: false do
         Arel::Nodes::NamedFunction.new('LENGTH', [
           Product.arel_table[:title]
         ])
       end
 
-      o.unkeyed :title
-      o.unkeyed :description
+      o.attribute :category, :category_id
     end
   end
 
@@ -466,5 +464,26 @@ RSpec.describe Pursuit::Search do
         expect(perform).to contain_exactly(product_a)
       end
     end
+
+    context 'when querying a custom attribute whose name matches a reflection' do
+      let(:query) { 'category==shirts' }
+
+      let(:shirts_category) { ProductCategory.create!(id: 'shirts', name: 'The Shirt Collection') }
+      let(:socks_category)  { ProductCategory.create!(id: 'socks', name: 'The Sock Collection') }
+
+      let(:product_a) { Product.create!(title: 'Plain Shirt', category: shirts_category) }
+      let(:product_b) { Product.create!(title: 'Funky Shirt', category: shirts_category) }
+      let(:product_c) { Product.create!(title: 'Socks - Pack of 4', category: socks_category) }
+
+      before do
+        product_a
+        product_b
+        product_c
+      end
+
+      it 'is expected to contain the matching records' do
+        expect(perform).to contain_exactly(product_a, product_b)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pursuit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nialto Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.2.0
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.2.0
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.2.0
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.2.0
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -112,56 +112,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: '1.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: '1.25'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.20
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.20
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +207,7 @@ files:
 - lib/pursuit/search_term_parser.rb
 - pursuit.gemspec
 - spec/internal/app/models/product.rb
+- spec/internal/app/models/product_category.rb
 - spec/internal/app/models/product_variation.rb
 - spec/internal/config/database.yml
 - spec/internal/db/schema.rb
@@ -240,12 +241,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Advanced key-based searching for ActiveRecord objects.
 test_files:
 - spec/internal/app/models/product.rb
+- spec/internal/app/models/product_category.rb
 - spec/internal/app/models/product_variation.rb
 - spec/internal/config/database.yml
 - spec/internal/db/schema.rb