searchlight 1.1.0 → 1.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjNmMzE5OWE2YzM4N2ZjMDU4YWNmNGZmZTk5NzM2NGQxNWRjYzNjYw==
+    MmFhNGNkYmJmZDdmMjc5NjJjODI3NzZmN2Q0ODY5NjkyNzYwZjhiZQ==
   data.tar.gz: !binary |-
-    Y2IzNWVmNzUyOTU4NjYxYjU2YmRiNWIzZDBjZmE0YTgyMzZlMTgyNw==
+    YzRlZTAyZTZiN2UzOTM3NWU1YTAyZGRkNDM1YjUwMTA0NTAxMGU4ZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjE2ZTMxMDM4OTQ0NDlmNjk5MWY4ODBlMmJkNDAwZDMzZjg4Njc1NDJmZWIz
-    Y2UzNTIxMzg2M2E1Mzk4OGM1MzdhNmYwOGFlOGM1MDg1ZmU0MWJjNDRmYWY5
-    Y2IxOTM2YzU1OTRjZWU4MjhkM2FlZjQxZGU3YTU1YTcwMjc0MjI=
+    ZTY3MjgyOGI3Y2FjYTFhMzlhZGVhMGQyYmNiYTRmZDI1Nzc3MzY2YjU1Mzcw
+    M2Y4YjFmNDg3YmEzZmUyNWM0ZGYwOTNkZTYyODkyZGNmZTU4NTUyMWQwNmQ3
+    M2U3NDBkOTM4OTRhZGFiNTNhMDQxOTdlYmFiZTEwMTQ1MzlmYjI=
   data.tar.gz: !binary |-
-    MGQ0ZDg1YmMyZmJjYjcxNmY0ODU3MGNkNDY5YmY4NzkyOGJjMDExZThjNzk0
-    YjRlZDc0ODRiNTI4ZDgyNjFjNzEzOWU4ZTNjOGVlZjY5M2Y3YmI1NGYzM2My
-    ZGIwNTBlNzg4ZDM3ZWY4NTZmNDU0NjJiNWQ2ZTY3ODNiN2RkNmU=
+    MDRkNDY3N2Y4Mzc4Mjc2NGZjOGYxYWZlMjc3MjZmYzM4ZmFlYTE0NzMyYWIy
+    YTQwZjhiNjQwM2I3OTI3Zjk3NTA4MzQ1ZTM1NTE3Mzk4NTliMDc1NWVkODRm
+    YzZmZTg0YmUzZDgzMDI3YjYzN2RmZjFiYTBiM2EwMmIyNTUyNzc=

data/.gitignore

@@ -3,6 +3,8 @@
 .bundle
 .config
 .rvmrc
+.ruby-version
+.ruby-gemset
 .yardoc
 Gemfile.lock
 InstalledFiles

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Searchlight does its best to use [semantic versioning](http://semver.org).
 
+## v1.2.0
+
+- Provide `options` accessor that returns all options considered non-blank
+- Slightly nicer errors when passing invalid options
+
 ## v1.1.0
 
 ActiveRecord adapter ensures that searches return a relation, even if no options are given

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in searchlight.gemspec
 gemspec
+gem 'coveralls', require: false

data/README.md

@@ -4,8 +4,11 @@ Searchlight helps you build searches from options via Ruby methods that you writ
 
 Searchlight can work with any ORM or object that can build a query using chained methods (eg, ActiveRecord's `.where(...).where(...).limit(...)`). It comes with modules for integrating with ActiveRecord and ActionView, but can easily be used in any Ruby program.
 
-[![Build Status](https://api.travis-ci.org/nathanl/searchlight.png?branch=master)](https://travis-ci.org/nathanl/searchlight)
+[![Gem Version](https://badge.fury.io/rb/searchlight.png)](https://rubygems.org/gems/searchlight)
 [![Code Climate](https://codeclimate.com/github/nathanl/searchlight.png)](https://codeclimate.com/github/nathanl/searchlight)
+[![Build Status](https://api.travis-ci.org/nathanl/searchlight.png?branch=master)](https://travis-ci.org/nathanl/searchlight)
+[![Coverage Status](https://coveralls.io/repos/nathanl/searchlight/badge.png?branch=master)](https://coveralls.io/r/nathanl/searchlight?branch=master)
+[![Dependency Status](https://gemnasium.com/nathanl/searchlight.png)](https://gemnasium.com/nathanl/searchlight)
 
 ## Overview
 
@@ -103,7 +106,7 @@ end
 
 ### Accessors
 
-For each search option, Searchlight defines two accessors: one for a value, and one for a boolean.
+For each search option you allow, Searchlight defines two accessors: one for a value, and one for a boolean.
 
 For example, if your class `searches :awesomeness` and gets instantiated like:
 
@@ -143,11 +146,12 @@ class PersonSearch < Searchlight::Search
 end
 ```
 
+Additionally, each search instance has an `options` accessor, which will have all the usable options with which it was instantiated. This excludes empty collections, blank strings, `nil`, etc. These usable options will be used in determining which search methods to run.
+
 ### Defining Defaults
 
 Set defaults using plain Ruby. These can be used to prefill a form or to assume what the user didn't specify.
 
-
 ```ruby
 
 class CitySearch < Searchlight::Search
@@ -252,6 +256,9 @@ Searchlight plays nicely with Rails forms. All search options and any `attr_acce
     = f.select :continent, ['Africa', 'Asia', 'Europe'], include_blank: true
 
   = f.submit "Search"
+  
+- @results.each do |city|
+  = render 'city'
 ```
 
 ### Controllers
@@ -263,7 +270,8 @@ As long as your form submits options your search understands, you can easily hoo
 class OrdersController < ApplicationController
 
   def index
-    @orders = OrderSearch.new(search_params)
+    @search  = OrderSearch.new(search_params) # For use in a form
+    @results = @search.results                # For display along with form
   end
   
   protected

data/lib/searchlight/search.rb

@@ -2,6 +2,8 @@ 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
@@ -9,9 +11,7 @@ module Searchlight
     end
 
     def initialize(options = {})
-      options.each { |key, value| public_send("#{key}=", value) } if options && options.any?
-    rescue NoMethodError => e
-      raise UndefinedOption.new(e.name, self.class.name)
+      filter_and_mass_assign(options)
     end
 
     def search
@@ -45,26 +45,25 @@ module Searchlight
       @search_target = value
     end
 
-    def search_methods
-      public_methods.map(&:to_s).select { |m| m.start_with?('search_') }
+    def filter_and_mass_assign(provided_options)
+      self.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
+        raise UndefinedOption.new(e.name, self)
+      end
     end
 
     def run
-      search_methods.each do |method|
-        new_search  = run_search_method(method)
+      options.each do |option_name, value|
+        new_search  = public_send("search_#{option_name}") if respond_to?("search_#{option_name}")
         self.search = new_search unless new_search.nil?
       end
       search
     end
 
-    def run_search_method(method_name)
-      option_value = instance_variable_get("@#{method_name.sub(/\Asearch_/, '')}")
-      option_value = option_value.reject { |item| blank_value?(item) } if option_value.respond_to?(:reject)
-      public_send(method_name) unless blank_value?(option_value)
-    end
-
     # Note that false is not blank
-    def blank_value?(value)
+    def is_blank?(value)
       (value.respond_to?(:empty?) && value.empty?) || value.nil? || value.to_s.strip == ''
     end
 
@@ -74,12 +73,13 @@ module Searchlight
 
       attr_accessor :message
 
-      def initialize(option_name, search_class)
+      def initialize(option_name, search)
         option_name = option_name.to_s.sub(/=\Z/, '')
-        self.message = "#{search_class} doesn't search '#{option_name}'."
+        self.message = "#{search.class.name} doesn't search '#{option_name}' or have an accessor for that property."
         if option_name.start_with?('search_')
+          method_maybe_intended = option_name.sub(/\Asearch_/, '')
           # Gee golly, I'm so helpful!
-          self.message << " Did you just mean '#{option_name.sub(/\Asearch_/, '')}'?"
+          self.message << " Did you just mean '#{method_maybe_intended}'?" if search.respond_to?("#{method_maybe_intended}=")
         end
       end
 

data/lib/searchlight/version.rb

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

data/spec/searchlight/adapters/active_record_spec.rb

@@ -26,10 +26,6 @@ describe 'Searchlight::Adapters::ActiveRecord', adapter: true do
       expect(search_class.new).to respond_to(:search_elephants)
     end
 
-    it "adds search_elephants to the search_methods array" do
-      expect(search_instance.send(:search_methods)).to include('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)

data/spec/searchlight/search_spec.rb

@@ -2,33 +2,86 @@ require 'spec_helper'
 
 describe Searchlight::Search do
 
-  let(:search_class) { Named::Class.new('ExampleSearch', described_class) }
-  let(:options)      { Hash.new }
-  let(:search)       { search_class.new(options) }
+  let(:search_class)     { Named::Class.new('ExampleSearch', described_class).tap { |klass| klass.searches *allowed_options } }
+  let(:allowed_options)  { Hash.new }
+  let(:provided_options) { Hash.new }
+  let(:search)           { search_class.new(provided_options) }
 
   describe "initializing" do
 
-    let(:options) { {beak_color: 'mauve'} }
+    describe "mass-assigning provided options" do
+
+      let(:allowed_options)  { [:beak_color] }
+      let(:provided_options) { {beak_color: 'mauve'} }
+
+      it "mass-assigns provided options" do
+        search_class.searches :beak_color
+        expect(search.beak_color).to eq('mauve')
+      end
+
+    end
+
+    describe "screening options" do
+
+      let(:allowed_options) { [:name, :description, :categories, :nicknames] }
+
+      context "when non-empty options are provided" do
+
+        let(:provided_options) { {name: 'Roy', description: 'Ornry', categories: %w[mammal moonshiner], nicknames: %w[Slim Bubba]} }
+
+        it "adds them to the options accessor" do
+          expect(search.options).to eq(provided_options)
+        end
+
+      end
+
+      context "when some provided options are empty" do
+
+        let(:provided_options) { {name: 'Roy', description: '', categories: %w[mammal moonshiner], nicknames: []} }
+
+        it "does not add them to the options accessor" do
+          expect(search.options).to eq(name: 'Roy', categories: %w[mammal moonshiner])
+
+        end
+
+      end
 
-    it "mass-assigns provided options" do
-      search_class.searches :beak_color
-      expect(search.beak_color).to eq('mauve')
     end
 
     describe "handling invalid options" do
 
-      let(:options) { {genus: 'Mellivora'} }
+      let(:provided_options) { {genus: 'Mellivora'} }
 
       it "raises an error explaining that this search class doesn't search the given property" do
         expect { search }.to raise_error( Searchlight::Search::UndefinedOption, /ExampleSearch.*genus/)
       end
 
-      context "if the option starts with 'search_'" do
+      context "if the provided option starts with 'search_'" do
+
+        let(:allowed_options)  { [:genus] }
+
+        context "and it looks like a valid search option" do
 
-        let(:options) { {search_genus: 'Mellivora'} }
+          let(:provided_options) { {search_genus: 'Mellivora'} }
+
+          it "suggests the option name the user may have meant to provide" do
+            expect { search }.to raise_error( Searchlight::Search::UndefinedOption, /ExampleSearch.*genus.*Did you just mean/)
+          end
+
+        end
+
+        context "but doesn't look like a valid search option" do
+
+          let(:provided_options) { {search_girth: 'Wee'} }
+
+          it "doesn't suggest an option name" do
+            begin
+              search
+            rescue Searchlight::Search::UndefinedOption => exception
+              expect(exception.message.match(/Did you just mean/)).to be_nil
+            end
+          end
 
-        it "suggests the option name the user may have meant to provide" do
-          expect { search }.to raise_error( Searchlight::Search::UndefinedOption, /ExampleSearch.*genus.*Did you just mean/)
         end
 
       end
@@ -101,27 +154,6 @@ describe Searchlight::Search do
 
   end
 
-  describe "search_methods" do
-
-    let(:search_class) {
-      Named::Class.new('ExampleSearch', described_class) do
-        def search_bees
-        end
-
-        def search_bats
-        end
-
-        def search_bees
-        end
-      end
-    }
-
-    it "keeps a unique list of the search methods" do
-      expect(search.send(:search_methods).map(&:to_s).sort).to eq(['search_bats', 'search_bees'])
-    end
-
-  end
-
   describe "search options" do
 
     describe "accessors" do
@@ -154,7 +186,7 @@ describe Searchlight::Search do
 
     describe "accessing search options as booleans" do
 
-      let(:options) { {fishies: fishies} }
+      let(:provided_options) { {fishies: fishies} }
 
       before :each do
         search_class.searches :fishies
@@ -202,9 +234,12 @@ describe Searchlight::Search do
 
   describe "results" do
 
-    let(:search) { AccountSearch.new(paid_amount: 50, business_name: "Rod's Meat Shack") }
+    let(:search) { AccountSearch.new(paid_amount: 50, business_name: "Rod's Meat Shack", other_attribute: 'whatevs') }
 
-    it "builds a search by calling all of the methods that had values to search" do
+    it "builds a search by calling each search method that corresponds to a provided option" do
+      search.should_receive(:search_paid_amount).and_call_original
+      search.should_receive(:search_business_name).and_call_original
+      # Can't do `.should_not_receive(:search_other_attribute)` because the expectation defines a method which would get called.
       search.results
       expect(search.search.called_methods).to eq(2.times.map { :where })
     end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'capybara/rspec'
 require 'simplecov'
 SimpleCov.start
+require 'coveralls'
+Coveralls.wear!
 require 'searchlight'
 $LOAD_PATH << '.'
 require 'support/mock_model'

data/spec/support/account_search.rb

@@ -3,6 +3,7 @@ class AccountSearch < Searchlight::Search
   search_on MockModel
 
   searches :paid_amount, :business_name, :balance, :active
+  attr_accessor :other_attribute
 
   def search_paid_amount
     search.where('amount > ?', paid_amount)

metadata

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