searchlight 1.2.2 → 1.2.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjE1ZDkyNDA3ZDMyY2JjOGUzMzgzNGZkYTkxNzBmOGUxMzQ1MTE4NA==
-  data.tar.gz: !binary |-
-    ZGJmMTc5N2YyNTBjM2RkNTAyOGZiYTExOGIwMTE1ODc0YTYwNTkxYw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NGRkZDEzZjhkOTJjYTUyZWY3ZDQ4ZGFiNDc2NzE1ZTRhNDNjZjgxNTdiYTdi
-    NDM1ZGRjYjJjMmMwNGM4MjcyNjQ3YjQ3N2IwYzdiZTljZTE5NTM5OTcwNTU0
-    ZDY2YThkYjAyZjEwYzU4ZjM1NGNkNDc4ZDc0Y2JjNjZkZjJjMjU=
-  data.tar.gz: !binary |-
-    ODM4NGQ4MjI4M2M3NjU3NTA2N2FlYTcwZWIxYmE3ODZmODkzNDdmY2E5ZGI2
-    NTlmMDJkZDgyNzdiNGEyZGFmMWMzOWY4NDg5ZmU5YzBhYWE1NTViYWNmMGIz
-    ZWRhNzMxZDQzNWZjODcwZmZiYzc5MTc0ZmZmMTFlNjU1YTQ4N2I=
+SHA1:
+  metadata.gz: 436f93fd15d48ee73339833c09e679d856210c44
+  data.tar.gz: 0234dd6c0dbed8789a3214c10bc05750aa2a7917
+SHA512:
+  metadata.gz: 985d773a7359d271f74b437dcbcd81a031fc79e3177650236f69d06c4e300100b8e88ecd786b3b955fc64d2eed820fae72310f4cb6c9478fc9ba4ce34ad2f4cd
+  data.tar.gz: e72a800936177e5eea6372c02093f04a36bea9daa532e0390e8a5d308c2e03ca774359a78fa0351f2f70c61d132093875002d9e8749a7f063c62e8345f9736dc

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Searchlight does its best to use [semantic versioning](http://semver.org).
 
+## 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.
+
 ## v1.2.2
 
 Gracefully handle being given explicit `nil` in initialization instead of options hash or empty arguments

data/lib/searchlight/dsl.rb

@@ -19,9 +19,17 @@ module Searchlight
         include @accessors_module
       end
 
-      eval_string = "attr_accessor *#{attribute_names}\n"
-      eval_string << attribute_names.map { |attribute_name|
+      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

@@ -35,10 +35,8 @@ module Searchlight
         raise MissingSearchTarget, "No search target provided via `search_on` and Searchlight can't guess one."
       end
     rescue NameError => e
-      if /uninitialized constant/.match(e.message)
-        raise MissingSearchTarget, "No search target provided via `search_on` and Searchlight's guess was wrong. Error: #{e.message}"
-      end
-      raise e
+      raise e unless /uninitialized constant/.match(e.message)
+      raise MissingSearchTarget, "No search target provided via `search_on` and Searchlight's guess was wrong. Error: #{e.message}"
     end
 
     def self.search_target=(value)

data/lib/searchlight/version.rb

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

data/spec/searchlight/search_spec.rb

@@ -7,67 +7,114 @@ describe Searchlight::Search do
   let(:provided_options) { Hash.new }
   let(:search)           { search_class.new(provided_options) }
 
-  describe "initializing" do
+  describe "options" do
 
-    describe "mass-assigning provided options" do
+    context "when given valid options" do
 
-      let(:allowed_options)  { [:beak_color] }
-      let(:provided_options) { {beak_color: 'mauve'} }
+      context "when the search class has no defaults" do
 
-      it "mass-assigns provided options" do
-        search_class.searches :beak_color
-        expect(search.beak_color).to eq('mauve')
-      end
+        describe "screening options" do
 
-    end
+          let(:allowed_options) { [:name, :description, :categories, :nicknames] }
 
-    describe "screening options" do
+          context "when all options are usable" do
 
-      let(:allowed_options) { [:name, :description, :categories, :nicknames] }
+            let(:provided_options) { {name: 'Roy', description: 'Ornry', categories: %w[mammal moonshiner], nicknames: %w[Slim Bubba]} }
 
-      context "when all options are usable" do
+            it "adds them to the options accessor" do
+              expect(search.options).to eq(provided_options)
+            end
 
-        let(:provided_options) { {name: 'Roy', description: 'Ornry', categories: %w[mammal moonshiner], nicknames: %w[Slim Bubba]} }
+          end
 
-        it "adds them to the options accessor" do
-          expect(search.options).to eq(provided_options)
-        end
+          context "when some provided options are empty" do
 
-      end
+            let(:provided_options) { {name: 'Roy', description: '', categories: ['', ''], nicknames: []} }
 
-      context "when some provided options are empty" do
+            it "does not add them to the options accessor" do
+              expect(search.options).to eq(name: 'Roy')
+            end
 
-        let(:provided_options) { {name: 'Roy', description: '', categories: ['', ''], nicknames: []} }
+          end
 
-        it "does not add them to the options accessor" do
-          expect(search.options).to eq(name: 'Roy')
-        end
+          context "when an empty options hash is given" do
 
-      end
+            let(:provided_options) { {} }
+
+            it "has empty options" do
+              expect(search.options).to eq({})
+            end
 
-      context "when an empty options hash is given" do
+          end
 
-        let(:provided_options) { {} }
+          context "when the options are explicitly nil" do
+
+            let(:provided_options) { nil }
+
+            it "has empty options" do
+              expect(search.options).to eq({})
+            end
+
+          end
 
-        it "has empty options" do
-          expect(search.options).to eq({})
         end
 
       end
 
-      context "when the options are explicitly nil" do
+      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
+
+              def initialize(options)
+                super
+                self.name ||= 'Dennis'
+                self.age  ||= 37
+              end
+
+            end.tap { |klass| klass.searches *allowed_options }
+          }
 
-        let(:provided_options) { nil }
+          context "and there were no values given" do
+
+            let(:provided_options) { Hash.new }
+
+            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
+
+          end
+
+          context "and values are given" do
+
+            let(:provided_options) { {name: 'Treebeard', age: 'A few thousand'} }
+
+            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
 
-        it "has empty options" do
-          expect(search.options).to eq({})
         end
 
       end
 
     end
 
-    describe "handling invalid options" do
+    context "when given invalid options" do
 
       let(:provided_options) { {genus: 'Mellivora'} }
 
@@ -75,6 +122,11 @@ describe Searchlight::Search do
         expect { search }.to raise_error( Searchlight::Search::UndefinedOption, /ExampleSearch.*genus/)
       end
 
+      it "gives the error a readable string representation" do
+        error   = Searchlight::Search::UndefinedOption.new(:badger_height, Array)
+        expect(error.to_s).to eq(error.message)
+      end
+
       context "if the provided option starts with 'search_'" do
 
         let(:allowed_options)  { [:genus] }
@@ -173,9 +225,9 @@ describe Searchlight::Search do
 
   end
 
-  describe "search options" do
+  describe "individual option accessors" do
 
-    describe "accessors" do
+    describe "the accessors module" do
 
       before :each do
         search_class.searches :foo
@@ -188,49 +240,54 @@ describe Searchlight::Search do
         expect(accessors_modules.length).to eq(1)
         expect(accessors_modules.first).to be_a(Named::Module)
       end
+    end
 
-      it "adds a getter" do
-        expect(search).to respond_to(:foo)
-      end
+    describe "value accessors" do
 
-      it "adds a setter" do
-        expect(search).to respond_to(:foo=)
+      let(:allowed_options)  { [:beak_color] }
+      let(:provided_options) { {beak_color: 'mauve'} }
+
+      it "provides an getter for the value" do
+        search_class.searches :beak_color
+        expect(search.beak_color).to eq('mauve')
       end
 
-      it "adds a boolean accessor" do
-        expect(search).to respond_to(:foo?)
+      it "provides an setter for the value" do
+        search_class.searches :beak_color
+        search.beak_color = 'turquoise'
+        expect(search.beak_color).to eq('turquoise')
       end
 
     end
 
-    describe "accessing search options as booleans" do
+    describe "boolean accessors" do
 
-      let(:provided_options) { {fishies: fishies} }
+      let(:provided_options) { {has_beak: has_beak} }
 
       before :each do
-        search_class.searches :fishies
+        search_class.searches :has_beak
       end
 
       {
-        0       => false,
-        '0'     => false,
-        ''      => false,
-        ' '     => false,
-        nil     => false,
-        'false' => false,
-        1       => true,
-        '1'     => true,
-        15      => true,
-        'true'  => true,
-        'pie'   => true
+        'yeppers' => true,
+        1         => true,
+        '1'       => true,
+        15        => true,
+        'true'    => true,
+        0         => false,
+        '0'       => false,
+        ''        => false,
+        ' '       => false,
+        nil       => false,
+        'false'   => false
       }.each do |input, output|
 
         describe input.inspect do
 
-          let(:fishies) { input }
+          let(:has_beak) { input }
 
           it "becomes boolean #{output}" do
-            expect(search.fishies?).to eq(output)
+            expect(search.has_beak?).to eq(output)
           end
 
         end

data/spec/support/account_search.rb

@@ -13,12 +13,4 @@ class AccountSearch < Searchlight::Search
     search.where(business_name: business_name)
   end
 
-  def search_balance
-    search.where("owed - amount > ?", balance)
-  end
-
-  def search_active
-    search.where(active: active?)
-  end
-
 end

data/spec/support/spiffy_account_search.rb

@@ -1,9 +1,2 @@
 class SpiffyAccountSearch < AccountSearch
-
-  searches :spiffiness
-
-  def search_spiffiness
-    search.where(spiffiness: spiffiness)
-  end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchlight
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Nathan Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-11 00:00:00.000000000 Z
+date: 2013-06-19 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: []