searchlight 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 65909cc6d8f99929aa4c76ba6a52e23dd8b85f59
-  data.tar.gz: 8ed82b1eab66fe78fcfc2b7b1630a8cbd2e2dcf3
-SHA512:
-  metadata.gz: fd26998a2330f3b034cdad89efe07ab3a52e0125db072da03533aa0038e091240baf0af3428ddc84de5b7e7e558b9a0c5fe6b095cf9a30acee503dbd359cb27e
-  data.tar.gz: 62a9b2a4ae2e8e5d8b28b996199b500c210f63ef53805e1c5ce491b7273832a5aed11155ff86a83dc7c4f4d5f6d66aa8a88b1db7d524dd2ca24d622c769fa0ea
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjNmMzE5OWE2YzM4N2ZjMDU4YWNmNGZmZTk5NzM2NGQxNWRjYzNjYw==
+  data.tar.gz: !binary |-
+    Y2IzNWVmNzUyOTU4NjYxYjU2YmRiNWIzZDBjZmE0YTgyMzZlMTgyNw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjE2ZTMxMDM4OTQ0NDlmNjk5MWY4ODBlMmJkNDAwZDMzZjg4Njc1NDJmZWIz
+    Y2UzNTIxMzg2M2E1Mzk4OGM1MzdhNmYwOGFlOGM1MDg1ZmU0MWJjNDRmYWY5
+    Y2IxOTM2YzU1OTRjZWU4MjhkM2FlZjQxZGU3YTU1YTcwMjc0MjI=
+  data.tar.gz: !binary |-
+    MGQ0ZDg1YmMyZmJjYjcxNmY0ODU3MGNkNDY5YmY4NzkyOGJjMDExZThjNzk0
+    YjRlZDc0ODRiNTI4ZDgyNjFjNzEzOWU4ZTNjOGVlZjY5M2Y3YmI1NGYzM2My
+    ZGIwNTBlNzg4ZDM3ZWY4NTZmNDU0NjJiNWQ2ZTY3ODNiN2RkNmU=

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Searchlight does its best to use [semantic versioning](http://semver.org).
 
+## v1.1.0
+
+ActiveRecord adapter ensures that searches return a relation, even if no options are given
+
 ## v1.0.0
 
 - If no search target is given, search class attempts to guess based on its own name

data/README.md

@@ -14,7 +14,7 @@ The basic idea of Searchlight is to build a search by chaining method calls that
 For example, if you have a Searchlight search class called `YetiSearch`, and you instantiate it like this:
 
 ```ruby
-  yeti_search = YetiSearch(active: true, name: 'Jimmy', location_in: %w[NY LA]) # or params[:search]
+  search = YetiSearch.new(active: true, name: 'Jimmy', location_in: %w[NY LA]) # or params[:search]
 ```
 
 ... calling `results` on the instance will build a search by chaining calls to `search_active`, `search_name`, and `search_location`.
@@ -108,7 +108,7 @@ For each search option, Searchlight defines two accessors: one for a value, and
 For example, if your class `searches :awesomeness` and gets instantiated like:
 
 ```ruby
-search = MySearchClass(awesomeness: 'Xtreme')
+search = MySearchClass.new(awesomeness: 'Xtreme')
 ```
 
 ... your search methods can use:
@@ -292,6 +292,8 @@ For each of your search options, the module will have the simplest possible sear
 
 Since that method is in a parent module, you can easily override it by defining your own method. You can also call `super` in the method you define.
 
+The adapter also ensures that searches return a relation, even if no options are given.
+
 ### ActionView
 
 Similarly, Searchlight adds ActionView-friendly methods to your classes if it sees that `ActionView` is a defined constant. See the code for details, but the upshot is that you can use a search with `form_for`.

data/lib/searchlight/adapters/active_record.rb

@@ -4,10 +4,8 @@ module Searchlight
 
       def search_on(target)
         super
-        if target.is_a?(Class) && target.ancestors.include?(::ActiveRecord::Base) ||
-          target.is_a?(::ActiveRecord::Relation)
-          extend Search
-        end
+        extend Search       if is_active_record?(target)
+        convert_to_relation if is_active_record_class?(target)
       end
 
       module Search
@@ -32,6 +30,29 @@ module Searchlight
         end
       end
 
+      protected
+
+      def is_active_record?(target)
+         is_active_record_class?(target) || is_active_record_relation?(target)
+      end
+
+      def is_active_record_class?(target)
+        target.is_a?(Class) && target.ancestors.include?(::ActiveRecord::Base)
+      end
+
+      def is_active_record_relation?(target)
+        target.is_a?(::ActiveRecord::Relation)
+      end
+
+      # Ensure that searches without options still return enumerable results
+      def convert_to_relation
+        self.search_target = (active_record_version >= 4) ? search_target.all : search_target.scoped
+      end
+
+      def active_record_version
+        ::ActiveRecord::VERSION::MAJOR.to_i
+      end
+
     end
   end
 end

data/lib/searchlight/search.rb

@@ -41,6 +41,10 @@ module Searchlight
       raise e
     end
 
+    def self.search_target=(value)
+      @search_target = value
+    end
+
     def search_methods
       public_methods.map(&:to_s).select { |m| m.start_with?('search_') }
     end

data/lib/searchlight/version.rb

@@ -1,3 +1,3 @@
 module Searchlight
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/searchlight/adapters/active_record_spec.rb

@@ -7,15 +7,21 @@ describe 'Searchlight::Adapters::ActiveRecord', adapter: true do
     require 'active_record'
   end
 
-  let(:search_class)    { Named::Class.new('SearchClass', Searchlight::Search).tap { |klass| klass.search_on target } }
+  let(:search_class)    {
+    Named::Class.new('SearchClass', Searchlight::Search).tap { |klass|
+      klass.instance_eval(&ar_version_faker)
+      klass.search_on target
+    }
+  }
+  let(:ar_version_faker) { lambda {|klass| nil } } # no-op
   let(:search_instance) { search_class.new(elephants: 'yes, please') }
 
-  before :each do
-    search_class.searches :elephants
-  end
-
   shared_examples "search classes with an ActiveRecord target" do
 
+    before :each do
+      search_class.searches :elephants
+    end
+
     it "adds search methods to the search class" do
       expect(search_class.new).to respond_to(:search_elephants)
     end
@@ -26,7 +32,7 @@ describe 'Searchlight::Adapters::ActiveRecord', adapter: true do
 
     it "defines search methods that call where on the search target" do
       search_instance.results
-      expect(search_instance.search.called_methods).to eq([:where])
+      expect(search_instance.search.called_methods).to include(:where)
     end
 
     it "sets arguments properly in the defined method" do
@@ -40,11 +46,37 @@ describe 'Searchlight::Adapters::ActiveRecord', adapter: true do
 
     let(:target)   { MockActiveRecord }
 
+    describe "converting to an ActiveRecord::Relation" do
+
+      context "for ActiveRecord <= 3" do
+
+        let(:ar_version_faker) { lambda { |klass| klass.stub(:active_record_version).and_return(3) } }
+
+        it "calls 'scoped'" do
+          target.should_receive(:scoped)
+          search_class
+        end
+
+      end
+
+      context "for ActiveRecord >= 4" do
+
+        let(:ar_version_faker) { lambda { |klass| klass.stub(:active_record_version).and_return(4) } }
+
+        it "calls 'all'" do
+          target.should_receive(:all)
+          search_class
+        end
+
+      end
+
+    end
+
     it_behaves_like "search classes with an ActiveRecord target"
 
   end
 
-  context "when the search target is an ActiveRecord class" do
+  context "when the search target is an ActiveRecord relation" do
 
     let(:target)   { MockActiveRecord.joins(:dudes_named_milford).tap { |r| r.called_methods.clear } }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchlight
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nathan Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: named
@@ -57,28 +57,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
@@ -154,12 +154,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []