searchlight 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 436f93fd15d48ee73339833c09e679d856210c44
-  data.tar.gz: 0234dd6c0dbed8789a3214c10bc05750aa2a7917
+  metadata.gz: ebb954502f32317df1fe4fb490178e3c868a541c
+  data.tar.gz: b0d0283e388c84a917c1c0d627752ce0b625a10c
 SHA512:
-  metadata.gz: 985d773a7359d271f74b437dcbcd81a031fc79e3177650236f69d06c4e300100b8e88ecd786b3b955fc64d2eed820fae72310f4cb6c9478fc9ba4ce34ad2f4cd
-  data.tar.gz: e72a800936177e5eea6372c02093f04a36bea9daa532e0390e8a5d308c2e03ca774359a78fa0351f2f70c61d132093875002d9e8749a7f063c62e8345f9736dc
+  metadata.gz: 001d3bfe0e77b84ae6d256892310d18c63cb54ea416c2d3b7b794d5374c228d17423e32d3c82abdb59da8db6886b3a449c591b863a4ac9d578e9d34431d7b8ea
+  data.tar.gz: 72c116a81eb742c6d7ecf97c982d8ec99731c1321aee96d0246491c11c3725d8ab747d8eb36ca44b93c14751e24a4b275a465a28c6b77e7f254c28864c714b8a

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Searchlight does its best to use [semantic versioning](http://semver.org).
 
+## v1.2.4
+
+- `options` method only returns those that map to search methods (not `attr_accessor` type values)
+- Previously, `searches :name` in a class with an `ActiveRecord` target would always trigger the `ActiveRecord` adapter to define `searches_name` as `search.where(name: name)`. Now it first checks whether `name` is a column on the model, and if not, defines the method to raise an error.
+
 ## v1.2.3
 
 Fix bug introduced in v1.2: setting defaults in `initialize` did not add them to the options hash, which meant they weren't used in searches.

data/TODO.md

@@ -1,5 +1,6 @@
 # TODO
 
+- Only have `options` method return values that map to search methods; it doesn't track any `attr_accessor` you may have. This guarantees consistent contents.
 - Run rcov and mutant
 - Make nice Github page
 - Test with ActiveRecord 4

data/lib/searchlight/adapters/active_record.rb

@@ -19,11 +19,23 @@ module Searchlight
           end
 
           eval_string = attribute_names.map { |attribute_name|
-            <<-UNICORN_BILE
-            def search_#{attribute_name}
-              search.where('#{attribute_name}' => public_send("#{attribute_name}"))
+            model_class = model_class_for(search_target)
+            if model_class_for(search_target).columns_hash.keys.include?(attribute_name.to_s)
+
+              <<-UNICORN_BILE
+              def search_#{attribute_name}
+                search.where('#{attribute_name}' => public_send("#{attribute_name}"))
+              end
+              UNICORN_BILE
+            else
+              <<-MERMAID_TEARS
+              def search_#{attribute_name}
+                raise Searchlight::Adapters::ActiveRecord::UndefinedColumn,
+                "Class `#{model_class}` has no column `#{attribute_name}`; please define `search_#{attribute_name}` on `\#{self.class}` to clarify what you intend to search for"
+              end
+              MERMAID_TEARS
             end
-            UNICORN_BILE
+
           }.join
 
           @ar_searches_module.module_eval(eval_string, __FILE__, __LINE__)
@@ -49,10 +61,15 @@ module Searchlight
         self.search_target = (active_record_version >= 4) ? search_target.all : search_target.scoped
       end
 
+      def model_class_for(target)
+        is_active_record_class?(target) ? target : target.engine
+      end
+
       def active_record_version
         ::ActiveRecord::VERSION::MAJOR.to_i
       end
 
+      UndefinedColumn = Class.new(StandardError)
     end
   end
 end

data/lib/searchlight/dsl.rb

@@ -19,17 +19,9 @@ module Searchlight
         include @accessors_module
       end
 
-      eval_string = attribute_names.map { |attribute_name|
+      eval_string = "attr_accessor *#{attribute_names}\n"
+      eval_string << attribute_names.map { |attribute_name|
         <<-LEPRECHAUN_JUICE
-          def #{attribute_name}=(val)
-            self.options ||= {}
-            self.options[:#{attribute_name}] = val
-          end
-
-          def #{attribute_name}
-            self.options[:#{attribute_name}]
-          end
-
           def #{attribute_name}?
             truthy?(public_send("#{attribute_name}"))
           end

data/lib/searchlight/search.rb

@@ -2,8 +2,6 @@ module Searchlight
   class Search
     extend DSL
 
-    attr_accessor :options
-
     def self.search_target
       return @search_target           if defined?(@search_target)
       return superclass.search_target if superclass.respond_to?(:search_target) && superclass != Searchlight::Search
@@ -22,12 +20,23 @@ module Searchlight
       @results ||= run
     end
 
+    def options
+      search_attributes.reduce({}) { |hash, option_name|
+        option_val = send(option_name)
+        hash.tap { |hash| hash[option_name.to_sym] = option_val unless is_blank?(option_val) }
+      }
+    end
+
     protected
 
     attr_writer :search
 
     private
 
+    def search_attributes
+      public_methods.map(&:to_s).select { |m| m.start_with?('search_') }.map { |m| m.sub(/\Asearch_/, '') }
+    end
+
     def self.guess_search_class!
       if self.name.end_with?('Search')
         @search_target = name.sub(/Search\z/, '').split('::').inject(Kernel, &:const_get)
@@ -44,8 +53,7 @@ module Searchlight
     end
 
     def filter_and_mass_assign(provided_options = {})
-      provided_options = {} if provided_options.nil?
-      self.options = provided_options.reject { |key, value| is_blank?(value) }
+      options = (provided_options || {}).reject { |key, value| is_blank?(value) }
       begin
         options.each { |key, value| public_send("#{key}=", value) } if options && options.any?
       rescue NoMethodError => e
@@ -55,7 +63,7 @@ module Searchlight
 
     def run
       options.each do |option_name, value|
-        new_search  = public_send("search_#{option_name}") if respond_to?("search_#{option_name}")
+        new_search  = public_send("search_#{option_name}")
         self.search = new_search unless new_search.nil?
       end
       search

data/lib/searchlight/version.rb

@@ -1,3 +1,3 @@
 module Searchlight
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/spec/searchlight/adapters/active_record_spec.rb

@@ -18,22 +18,46 @@ describe 'Searchlight::Adapters::ActiveRecord', adapter: true do
 
   shared_examples "search classes with an ActiveRecord target" do
 
-    before :each do
-      search_class.searches :elephants
-    end
+    context "when the base model has a column matching the search term" do
 
-    it "adds search methods to the search class" do
-      expect(search_class.new).to respond_to(:search_elephants)
-    end
+      before :each do
+        MockActiveRecord.stub(:columns_hash).and_return({'elephants' => 'column info...'})
+        search_class.searches :elephants
+      end
+
+      it "adds search methods to the search class" do
+        expect(search_class.new).to respond_to(:search_elephants)
+      end
+
+      it "defines search methods that call `where` on the search target" do
+        search_instance.results
+        expect(search_instance.search.called_methods).to include(:where)
+      end
+
+      it "sets arguments properly in the defined method" do
+        search_instance.search.should_receive(:where).with('elephants' => 'yes, please')
+        search_instance.search_elephants
+      end
 
-    it "defines search methods that call where on the search target" do
-      search_instance.results
-      expect(search_instance.search.called_methods).to include(:where)
     end
 
-    it "sets arguments properly in the defined method" do
-      search_instance.search.should_receive(:where).with('elephants' => 'yes, please')
-      search_instance.search_elephants
+    context "when the base model has no column matching the search term" do
+
+      before :each do
+        MockActiveRecord.stub(:columns_hash).and_return({})
+        search_class.searches :elephants
+      end
+
+      it "adds search methods to the search class" do
+        expect(search_class.new).to respond_to(:search_elephants)
+      end
+
+      it "defines search methods to raise an exception" do
+        expect { search_instance.results }.to raise_error(
+          Searchlight::Adapters::ActiveRecord::UndefinedColumn
+        )
+      end
+
     end
 
   end

data/spec/searchlight/search_spec.rb

@@ -2,7 +2,11 @@ require 'spec_helper'
 
 describe Searchlight::Search do
 
-  let(:search_class)     { Named::Class.new('ExampleSearch', described_class).tap { |klass| klass.searches *allowed_options } }
+  let(:search_class)     { Named::Class.new('ExampleSearch', described_class).tap {|klass|
+    klass.searches *allowed_options
+    allowed_options.each { |name| klass.send(:define_method, "search_#{name}") {} }
+    }
+  }
   let(:allowed_options)  { Hash.new }
   let(:provided_options) { Hash.new }
   let(:search)           { search_class.new(provided_options) }
@@ -57,55 +61,74 @@ describe Searchlight::Search do
 
           end
 
+          context "when some options are do not map to search methods (eg, attr_accessor)" do
+            let(:search_class) {
+              Named::Class.new('ExampleSearch', described_class) do
+                attr_accessor :krazy_mode
+                def search_name; end
+              end.tap { |klass| klass.searches *allowed_options }
+            }
+            let(:provided_options) { {name: 'Reese Roper', krazy_mode: true} }
+
+            it "sets all the provided values" do
+              expect(search.name).to       eq('Reese Roper')
+              expect(search.krazy_mode).to eq(true)
+            end
+
+            it "only lists options for the values corresponding to search methods" do
+              expect(search.options).to eq({name: 'Reese Roper'})
+            end
+
+          end
+
         end
 
       end
 
       context "when the search class has defaults" do
 
-        context "when they're set during initialization" do
-
-          let(:allowed_options) { [:name, :age] }
-          let(:search_class) {
-            Named::Class.new('ExampleSearch', described_class) do
+        let(:allowed_options) { [:name, :age] }
+        let(:search_class) {
+          Named::Class.new('ExampleSearch', described_class) do
 
-              def initialize(options)
-                super
-                self.name ||= 'Dennis'
-                self.age  ||= 37
-              end
+            def initialize(options)
+              super
+              self.name ||= 'Dennis'
+              self.age  ||= 37
+            end
 
-            end.tap { |klass| klass.searches *allowed_options }
-          }
+            def search_name; end
+            def search_age;  end
 
-          context "and there were no values given" do
+          end.tap { |klass| klass.searches *allowed_options }
+        }
 
-            let(:provided_options) { Hash.new }
+        context "and there were no values given" do
 
-            it "uses the defaults for its accessors" do
-              expect(search.name).to eq('Dennis')
-              expect(search.age).to eq(37)
-            end
+          let(:provided_options) { Hash.new }
 
-            it "uses the defaults for its options hash" do
-              expect(search.options).to eq({name: 'Dennis', age: 37})
-            end
+          it "uses the defaults for its accessors" do
+            expect(search.name).to eq('Dennis')
+            expect(search.age).to eq(37)
+          end
 
+          it "uses the defaults for its options hash" do
+            expect(search.options).to eq({name: 'Dennis', age: 37})
           end
 
-          context "and values are given" do
+        end
 
-            let(:provided_options) { {name: 'Treebeard', age: 'A few thousand'} }
+        context "and values are given" do
 
-            it "uses the provided values" do
-              expect(search.name).to eq('Treebeard')
-              expect(search.age).to eq('A few thousand')
-            end
+          let(:provided_options) { {name: 'Treebeard', age: 'A few thousand'} }
 
-            it "uses the provided values for its options hash" do
-              expect(search.options).to eq({name: 'Treebeard', age: 'A few thousand'})
-            end
+          it "uses the provided values" do
+            expect(search.name).to eq('Treebeard')
+            expect(search.age).to eq('A few thousand')
+          end
 
+          it "uses the provided values for its options hash" do
+            expect(search.options).to eq({name: 'Treebeard', age: 'A few thousand'})
           end
 
         end
@@ -345,13 +368,13 @@ describe Searchlight::Search do
       end
     }
 
-    let(:search_instance) { search_class.new(bits: ' ', bats: nil, bots: false) }
+    let(:provided_options) { {bits: ' ', bats: nil, bots: false} }
 
     it "only runs search methods that have real values to search on" do
-      search_instance.should_not_receive(:search_bits)
-      search_instance.should_not_receive(:search_bats)
-      search_instance.should_receive(:search_bots)
-      search_instance.send(:run)
+      search.should_not_receive(:search_bits)
+      search.should_not_receive(:search_bats)
+      search.should_receive(:search_bots)
+      search.send(:run)
     end
 
   end

data/spec/support/mock_model.rb

@@ -33,6 +33,10 @@ class MockRelation
     thing == ::ActiveRecord::Relation ? true : super
   end
 
+  def engine
+    MockActiveRecord
+  end
+
 end
 
 module Namespaced

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchlight
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Nathan Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2013-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: named