searchlight 0.9.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NGM3YWIxODBiNTM5MmM4NDJkNjk4Mzk3MmU5MGIwMzg4M2JlM2E2ZA==
-  data.tar.gz: !binary |-
-    Njc0ZDYxZjFkZWZmNDE2ZTJjNzY2Y2QzNjJjMTJiYjkwODZmODhiZA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    OGM2NjZmNTc2OTI3MjdkMmNlNTcwNzE2Mjk5Mzk3YmIzMzVmMjNjYTVmMGFi
-    ODhkYjQ2ZmNiNzJlNDNlYzhlOTVjMDIxN2M5ZGE4NDU5ZGI4NmYyN2JjMzI2
-    NWFmYWI0NDYwOTg4YjI1ZjhkOTJiNmQyNzkzNDRkMzc2ZjM2MjM=
-  data.tar.gz: !binary |-
-    M2JiOGE2ODJiNjhlOTM0NDBiNGVkZDBlZDE5MDNiMDRjMGRjOTQ5MzViZmM4
-    YWZiOTVkNDFmZTdiZmRkMTM1ZjE3MGM2ZjBlMzFlMGE2ODM3NGM0OTBiN2I0
-    NDFlOTE0NzM3MjJkOGFiYmY5ZDFkMzBmNTdkNzcyZmE5M2U5YTE=
+SHA1:
+  metadata.gz: 65909cc6d8f99929aa4c76ba6a52e23dd8b85f59
+  data.tar.gz: 8ed82b1eab66fe78fcfc2b7b1630a8cbd2e2dcf3
+SHA512:
+  metadata.gz: fd26998a2330f3b034cdad89efe07ab3a52e0125db072da03533aa0038e091240baf0af3428ddc84de5b7e7e558b9a0c5fe6b095cf9a30acee503dbd359cb27e
+  data.tar.gz: 62a9b2a4ae2e8e5d8b28b996199b500c210f63ef53805e1c5ce491b7273832a5aed11155ff86a83dc7c4f4d5f6d66aa8a88b1db7d524dd2ca24d622c769fa0ea

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 Searchlight does its best to use [semantic versioning](http://semver.org).
 
+## v1.0.0
+
+- If no search target is given, search class attempts to guess based on its own name
+- All errors that can be raise extend `Searchlight::Error`
+- Better testing
+- Still more documentation!
+
 ## v0.9.1
 
 Bugfix for ActiveRecord adapter

data/README.md

@@ -2,7 +2,7 @@
 
 Searchlight helps you build searches from options via Ruby methods that you write.
 
-Searchlight can work with any ORM or object that allows chaining search methods. It comes with modules for integrating with ActiveRecord and ActionView, but can easily be used in any Ruby program.
+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)
 [![Code Climate](https://codeclimate.com/github/nathanl/searchlight.png)](https://codeclimate.com/github/nathanl/searchlight)
@@ -145,6 +145,9 @@ end
 
 ### 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
@@ -152,7 +155,7 @@ class CitySearch < Searchlight::Search
   #...
 
   def initialize(options = {})
-    super
+    super    
     self.continent ||= 'Asia'
   end
 
@@ -165,6 +168,38 @@ CitySearch.new(continent: 'Europe').results.to_sql
   => "SELECT `cities`.* FROM `cities`  WHERE (`countries`.`continent` = 'Europe')"
 ```
 
+You can define defaults for boolean attributes if you treat them as "yes/no/either" choices.
+
+```ruby
+class AnimalSearch < Searchlight::Search
+
+  search_on Animal
+  
+  searches :is_fictional
+  
+  def initialize(*args)
+    super
+    self.is_fictional = :either if is_fictional.blank?
+  end
+  
+  def search_is_fictional
+    case is_fictional.to_s
+    when 'true'   then search.where(fictional: true)
+    when 'false'  then search.where(fictional: false)
+    when 'either' then search # unmodified
+    end
+  end
+end
+
+
+AnimalSearch.new(fictional: true).results.to_sql
+  => "SELECT `animals`.* FROM `animals` WHERE (`fictional` = true)"
+AnimalSearch.new(fictional: false).results.to_sql
+  => "SELECT `animals`.* FROM `animals` WHERE (`fictional` = false)"
+AnimalSearch.new.results.to_sql
+  => "SELECT `animals`.* FROM `animals`"
+```
+
 ### Subclassing
 
 You can subclass an existing search class and support all the same options with a different search target. This may be useful for single table inheritance, for example. 
@@ -186,9 +221,15 @@ SmallTownSearch.new(country_name_like: 'Norfolk').results.to_sql
   => "SELECT `cities`.* FROM `cities`  WHERE (`cities`.`population` < 1000) AND (`countries`.`name` LIKE '%Norfolk%')"
 ```
 
+### Dependent Options
+
+To allow search options that don't trigger searches directly, just use `attr_accessor`.
+
 ## Usage in Rails
 
-Searchlight plays nicely with Rails views.
+### Forms
+
+Searchlight plays nicely with Rails forms. All search options and any `attr_accessor`s you define can be hooked up to form fields.
 
 ```ruby
 # app/views/cities/index.html.haml
@@ -213,13 +254,23 @@ Searchlight plays nicely with Rails views.
   = f.submit "Search"
 ```
 
+### Controllers
+
 As long as your form submits options your search understands, you can easily hook it up in your controller:
 
 ```ruby
-# app/controllers/cities_controller.rb
-class CitiesController < ApplicationController
-  def search
-    @search = CitySearch.new(params[:search])
+# app/controllers/orders_controller.rb
+class OrdersController < ApplicationController
+
+  def index
+    @orders = OrderSearch.new(search_params)
+  end
+  
+  protected
+  
+  def search_params
+    # Ensure the user can only browse or search their own orders
+    (params[:search]) || {}).merge(user_id: current_user.id)
   end
 end
 ```

data/lib/searchlight/search.rb

@@ -3,7 +3,9 @@ module Searchlight
     extend DSL
 
     def self.search_target
-      defined?(@search_target) ? @search_target : superclass.search_target
+      return @search_target           if defined?(@search_target)
+      return superclass.search_target if superclass.respond_to?(:search_target) && superclass != Searchlight::Search
+      guess_search_class!
     end
 
     def initialize(options = {})
@@ -26,6 +28,19 @@ module Searchlight
 
     private
 
+    def self.guess_search_class!
+      if self.name.end_with?('Search')
+        @search_target = name.sub(/Search\z/, '').split('::').inject(Kernel, &:const_get)
+      else
+        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
+    end
+
     def search_methods
       public_methods.map(&:to_s).select { |m| m.start_with?('search_') }
     end
@@ -49,8 +64,12 @@ module Searchlight
       (value.respond_to?(:empty?) && value.empty?) || value.nil? || value.to_s.strip == ''
     end
 
-    class UndefinedOption < StandardError
+    MissingSearchTarget = Class.new(Searchlight::Error)
+
+    class UndefinedOption < Searchlight::Error
+
       attr_accessor :message
+
       def initialize(option_name, search_class)
         option_name = option_name.to_s.sub(/=\Z/, '')
         self.message = "#{search_class} doesn't search '#{option_name}'."
@@ -63,6 +82,7 @@ module Searchlight
       def to_s
         message
       end
+
     end
 
   end

data/lib/searchlight/version.rb

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

data/spec/searchlight/search_spec.rb

@@ -3,8 +3,8 @@ 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(:options)      { Hash.new }
+  let(:search)       { search_class.new(options) }
 
   describe "initializing" do
 
@@ -23,30 +23,80 @@ describe Searchlight::Search do
         expect { search }.to raise_error( Searchlight::Search::UndefinedOption, /ExampleSearch.*genus/)
       end
 
+      context "if the option starts with 'search_'" do
+
+        let(: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
+
     end
 
   end
 
   describe "search_on" do
 
-    let(:search_target) { "Bobby Fischer" }
+    context "when an explicit search target was provided" do
 
-    before :each do
-      search_class.search_on search_target
-    end
+      let(:search_target) { "Bobby Fischer" }
 
-    it "makes the object accessible via `search_target`" do
-      expect(search_class.search_target).to eq(search_target)
-    end
+      before :each do
+        search_class.search_on search_target
+      end
+
+      it "makes the object accessible via `search_target`" do
+        expect(search_class.search_target).to eq(search_target)
+      end
+
+      it "makes the search target available to its children" do
+        expect(SpiffyAccountSearch.search_target).to be(MockModel)
+      end
+
+      it "allows the children to set their own search target" do
+        klass = Class.new(SpiffyAccountSearch) { search_on Array }
+        expect(klass.search_target).to be(Array)
+        expect(SpiffyAccountSearch.search_target).to be(MockModel)
+      end
 
-    it "makes the search target available to its children" do
-      expect(SpiffyAccountSearch.search_target).to be(MockModel)
     end
 
-    it "allows the children to set their own search target" do
-      klass = Class.new(SpiffyAccountSearch) { search_on Array }
-      expect(klass.search_target).to be(Array)
-      expect(SpiffyAccountSearch.search_target).to be(MockModel)
+    context "when no explicit search target was provided" do
+
+      let(:search_class) { Named::Class.new('Namespaced::ExampleSearch', described_class) }
+
+      it "guesses the search class based on its own namespaced class name" do
+        expect(search_class.search_target).to eq(Namespaced::Example)
+      end
+
+      context "when it can't make a guess as to the search class" do
+
+        let(:search_class) { Named::Class.new('Somekinda::Searchthingy', described_class) }
+
+        it "raises an exception" do
+          expect{search_class.search_target}.to raise_error(
+            Searchlight::Search::MissingSearchTarget, 
+            /No search target/
+          )
+        end
+
+      end
+
+      context "when it tries to guess the search class but fails" do
+        
+        let(:search_class) { Named::Class.new('NonExistentObjectSearch', described_class) }
+
+        it "raises an exception" do
+          expect{search_class.search_target}.to raise_error(
+            Searchlight::Search::MissingSearchTarget, 
+            /No search target.*uninitialized constant.*NonExistentObject/
+          )
+        end
+
+      end
+
     end
 
   end

data/spec/support/mock_model.rb

@@ -35,3 +35,7 @@ class MockRelation
 
 end
 
+module Namespaced
+  class Example
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchlight
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Nathan Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-30 00:00:00.000000000 Z
+date: 2013-05-17 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: []