pursuit 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b49ae3ec2734b8b67fef2fb0686b85af3a694745db4654de863942d4a598d53
-  data.tar.gz: 8d8a6e71f23b31d0ebf33a1c2554a9875c0c189786954574c3d5f58ced5fe304
+  metadata.gz: 9584065901bd2b27fce1df13ee13586151c96be3e04f222b81c6ee93d8f078a4
+  data.tar.gz: 81f233b5d39526129b8bdf7c7bba997e9a5b964b9bd5024bc3e3351f1105c927
 SHA512:
-  metadata.gz: faebb7031e643b0fe4011cee2fda71a916dd12aa2819845a26bf79ef6ca0f0411bcd3e8b5ea1f092624909933639d97d0e59cc2b80ba38ea10f2dcbf0254c154
-  data.tar.gz: 0c06093eb83369d20f5e64a843483e98a019a5facb594f75b845949cfdcc0b7027da78ccb8be92d6a739cc76720e1d28165019aaaf7220718deb550c2816440a
+  metadata.gz: 83fcec1d5657de087a5a5fdf71b131e34632fc02328cd66d2a551c438201f9125fd8d0861d239a96a4b6b36c6ac3bde342efaa4b610a1689646540229fe456bd
+  data.tar.gz: 47d981997a463f5203b3316410d6f5e2395fc1aa448329a86a625a732c2751a3e281b4581973cb9893f3c76d68f6999f38a0fbe0020c56ecc608f99b968101b0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pursuit (0.2.0)
+    pursuit (0.3.0)
       activerecord (>= 5.2.0, < 6.2.0)
       activesupport (>= 5.2.0, < 6.2.0)
 

data/README.md

@@ -23,19 +23,18 @@ class Product < ActiveRecord::Base
   searchable do |o|
     o.relation :variations, :title, :stock_status
 
-    o.keyed :title
-    o.keyed :description
-    o.keyed :rating
+    # 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 also create virtual attributes to search by passing in a block that returns an arel node.
-    o.keyed :title_length do
+    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.3.0'
 end

data/lib/pursuit/search_options.rb

@@ -2,40 +2,55 @@
 
 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
 
@@ -51,21 +66,13 @@ module Pursuit
 
     # 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.
-    #
-    # @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 name    [Symbol]  The name of the attribute.
+    # @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 an Arel node to query, instead of the matching table column.
     #
-    def unkeyed(name, &block)
-      unkeyed_attributes[name] = block || -> { record_class.arel_table[name] }
+    def attribute(name, keyed: true, unkeyed: true, &block)
+      attributes[name] = AttributeOptions.new(keyed, unkeyed, block || -> { record_class.arel_table[name] })
       nil
     end
   end

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

@@ -8,17 +8,13 @@ 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
   end
 end

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,64 @@ 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 use the matching table column node builder by default' do
+      attribute
+      expect(search_options.attributes[:description].block.call).to eq(Product.arel_table[:description])
+    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 use the custom node builder' 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,14 @@ 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
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pursuit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nialto Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord