pursuit 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9584065901bd2b27fce1df13ee13586151c96be3e04f222b81c6ee93d8f078a4
-  data.tar.gz: 81f233b5d39526129b8bdf7c7bba997e9a5b964b9bd5024bc3e3351f1105c927
+  metadata.gz: c5d86e6be4355b96bdaf0d8c02ea680e5cf0f6c3c9f5fdcd3d8e9a20785aad8b
+  data.tar.gz: 310009d659879f97ae8bc9947594533fdb0c11f20702b2bf10e1003c072b4425
 SHA512:
-  metadata.gz: 83fcec1d5657de087a5a5fdf71b131e34632fc02328cd66d2a551c438201f9125fd8d0861d239a96a4b6b36c6ac3bde342efaa4b610a1689646540229fe456bd
-  data.tar.gz: 47d981997a463f5203b3316410d6f5e2395fc1aa448329a86a625a732c2751a3e281b4581973cb9893f3c76d68f6999f38a0fbe0020c56ecc608f99b968101b0
+  metadata.gz: 49991dd50ed278c76d9dbc7f0dd8f48a7f41fa7905f284964a27df9bc90a55ad6833a5911b86ed159d4d4c88fc2aac736ac5feb2c1b8469fb9adbf02abca3f49
+  data.tar.gz: 6663dc11f0f6e6adc08f87834d303ed59e0269415132d7c0fdb54d96ee7ca926be69097dd26dd58d0bc836b9a9bf7f8ccfc35fd3e8f9c6976340e52b0719c5b1

data/README.md

@@ -26,10 +26,15 @@ class Product < ActiveRecord::Base
     # 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.
+    # You can shorten the search keyword by passing the desired search term first, and then the real attribute name
+    # as the second argument.
+    #  => "desc*=foo"
+    o.attribute :desc, :description
+
+    # 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]

data/lib/pursuit/constants.rb

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

data/lib/pursuit/search_options.rb

@@ -54,7 +54,7 @@ module Pursuit
       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.
@@ -64,15 +64,22 @@ module Pursuit
       nil
     end
 
-    # Add a keyed attribute to search.
+    # Add an attribute to search.
     #
-    # @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.
+    # @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 attribute(name, keyed: true, unkeyed: true, &block)
-      attributes[name] = AttributeOptions.new(keyed, unkeyed, 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/spec/pursuit/search_options_spec.rb

@@ -104,11 +104,20 @@ RSpec.describe Pursuit::SearchOptions do
       expect(search_options.attributes[:description].unkeyed).to eq(true)
     end
 
-    it 'is expected to use the matching table column node builder by default' do
+    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) }
 
@@ -130,7 +139,7 @@ RSpec.describe Pursuit::SearchOptions do
     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
+      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

metadata

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