searchlight 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6535dc6c570b01a67e7a25a51819bd57c155abb5
-  data.tar.gz: 6741f5d2dd6a1bc93641263848b926662df22307
+  metadata.gz: 432e9a94536f38173152799da14d74ba3adb8e23
+  data.tar.gz: 649e95855e50d9663f831b8e639e97d7c9bbb64c
 SHA512:
-  metadata.gz: 06768634ad235bb9b45fe93ceaf2f5d1a07fcfc016f396d1fa70b727721ac802ac8956869bcc2715539b413f6b22126e614a9042277b2bfe04c80af213d2fe9f
-  data.tar.gz: 4350283762d804a7c1747b49815598f5b17eddd28ca8ee591ad0857ace1f578099d57d8e1f517d03cacbaf18cda126ab04e1a6d37eeb2eb5d7636cfa028f74a6
+  metadata.gz: 545f658dcc895609270b655f20d6dc14e3ffcdbb26567b4a2051d86372872c540e58b03264fd9e6a68f68a8b4860d5f5eb0ba68c9d60590dab71025523203798
+  data.tar.gz: 926a6a17de716ce11200f0c3182238338d57aaaa4aab19662a50df4021344f16affe998504db9f8e5219e9911bdc06616f63a2f100635cffacb042f937d69d58

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Searchlight does its best to use [semantic versioning](http://semver.org).
 
+## v3.1.0
+
+Allow callable search targets, thanks to [Adam Nowak](https://github.com/lubieniebieski).
+
 ## v3.0.0
 
 Two major releases in two days!? Well, I thought of another good, but breaking, change. To the major version bump, Robin!

data/README.md

@@ -22,7 +22,7 @@ For example, if you have a Searchlight search class called `YetiSearch`, and you
 
 ```ruby
   search = YetiSearch.new(
-    active: true, name: 'Jimmy', location_in: %w[NY LA] # or params[:search]
+    active: true, name: 'Jimmy', location_in: %w[NY LA] # or params[:yeti_search]
   )
 ```
 
@@ -233,6 +233,24 @@ SmallTownSearch.new(country_name_like: 'Norfolk').results.to_sql
   => "SELECT `cities`.* FROM `cities`  WHERE (`cities`.`population` < 1000) AND (`countries`.`name` LIKE '%Norfolk%')"
 ```
 
+### Delayed scope evaluation
+
+If your search target has a time-sensitive condition, you can wrap it in a callable object to prevent it from being evaluated when the class is defined. For example:
+
+```ruby
+class RecentOrdersSearch < Searchlight::Search
+  search_on proc { Orders.since(Time.now - 3.hours) }
+end
+```
+
+This does make subclassing a bit more complex:
+
+```ruby
+class ExpensiveRecentOrdersSearch < RecentOrderSearch
+  search_on proc { superclass.search_target.call.expensive }
+end
+```
+
 ### Dependent Options
 
 To allow search options that don't trigger searches directly, just use `attr_accessor`.
@@ -286,7 +304,7 @@ class OrdersController < ApplicationController
   
   def search_params
     # Ensure the user can only browse or search their own orders
-    (params[:search]) || {}).merge(user_id: current_user.id)
+    (params[:order_search] || {}).merge(user_id: current_user.id)
   end
 end
 ```

data/lib/searchlight/search.rb

@@ -13,7 +13,14 @@ module Searchlight
     end
 
     def search
-      @search ||= self.class.search_target
+      @search ||= begin
+                    target = self.class.search_target
+                    if target.respond_to?(:call)
+                      target.call
+                    else
+                      target
+                    end
+                  end
     end
 
     def results

data/lib/searchlight/version.rb

@@ -1,3 +1,3 @@
 module Searchlight
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/spec/searchlight/search_spec.rb

@@ -186,16 +186,16 @@ describe Searchlight::Search do
 
   describe "search_on" do
 
-    context "when an explicit search target was provided" do
+    context "when an explicit, non-callable search target was provided" do
 
-      let(:search_target) { "Bobby Fischer" }
+      let(:example_search_target) { "Bobby Fischer" }
 
       before :each do
-        search_class.search_on search_target
+        search_class.search_on example_search_target
       end
 
       it "makes the object accessible via `search_target`" do
-        expect(search_class.search_target).to eq(search_target)
+        expect(search_class.search_target).to eq(example_search_target)
       end
 
       it "makes the search target available to its children" do
@@ -210,6 +210,24 @@ describe Searchlight::Search do
 
     end
 
+    context "when an explicit, callable search target was provided" do
+
+      it "calls it in the process of producing search results" do
+        search = ProcSearch.new(first_name: "Jimmy")
+        results = search.results
+        expect(results).to be_a(MockRelation)
+        expect(results.called_methods).to eq([:some_scope, :where])
+      end
+
+      it "allows it to refer to a parent class's callable search target" do
+        search = ChildProcSearch.new(first_name: "Carlos")
+        results = search.results
+        expect(results).to be_a(MockRelation)
+        expect(results.called_methods).to eq([:some_scope, :other_scope, :where])
+      end
+
+    end
+
     context "when no explicit search target was provided" do
 
       let(:search_class) { Named::Class.new('Namespaced::ExampleSearch', described_class) }

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ $LOAD_PATH << '.'
 require 'support/mock_model'
 require 'support/account_search'
 require 'support/spiffy_account_search'
+require 'support/proc_search'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/support/proc_search.rb

@@ -0,0 +1,17 @@
+class ProcSearch < Searchlight::Search
+
+  searches :first_name
+
+  search_on proc { MockModel.some_scope }
+
+  def search_first_name
+    search.where(first_name: first_name)
+  end
+
+end
+
+class ChildProcSearch < ProcSearch
+
+  search_on proc { superclass.search_target.call.other_scope }
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchlight
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Nathan Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: named
@@ -170,6 +170,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/account_search.rb
 - spec/support/mock_model.rb
+- spec/support/proc_search.rb
 - spec/support/spiffy_account_search.rb
 homepage: https://github.com/nathanl/searchlight
 licenses:
@@ -191,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Searchlight is a low-magic way to build database searches using an ORM.
@@ -202,4 +203,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/account_search.rb
 - spec/support/mock_model.rb
+- spec/support/proc_search.rb
 - spec/support/spiffy_account_search.rb