searchlight 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebb954502f32317df1fe4fb490178e3c868a541c
-  data.tar.gz: b0d0283e388c84a917c1c0d627752ce0b625a10c
+  metadata.gz: a5654905b697feb05239ed5b783d46e6a282eaa4
+  data.tar.gz: 7b9622f4a6d5d9f7cdcc2429941fc08f36e6c491
 SHA512:
-  metadata.gz: 001d3bfe0e77b84ae6d256892310d18c63cb54ea416c2d3b7b794d5374c228d17423e32d3c82abdb59da8db6886b3a449c591b863a4ac9d578e9d34431d7b8ea
-  data.tar.gz: 72c116a81eb742c6d7ecf97c982d8ec99731c1321aee96d0246491c11c3725d8ab747d8eb36ca44b93c14751e24a4b275a465a28c6b77e7f254c28864c714b8a
+  metadata.gz: 64e8e55512aac81f5bed20ac97152a012211cdfdcb25906f62cb62b52e0a8970eb8111f991b85120f382e57771cea3f23e64edf4d4bcb0673b8983dc12a91f26
+  data.tar.gz: 491c812aa4973a4cfca1b2948f435a647ab1c59da69ea40414073bd93d780d4619afe5a5c10bebfee1a5509bf8915693abd7723b5e5080db29ef2c7bc5cde29b

data/.gitignore

@@ -18,3 +18,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+gemfiles/*.lock

data/.travis.yml

@@ -4,3 +4,7 @@ rvm:
   - jruby-19mode # JRuby in 1.9 mode
   - rbx-19mode # JRuby in 1.9 mode
   - 2.0.0
+gemfile:
+  - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.0.x
+env: JRUBY_OPTS="-Xcext.enabled=true"

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Searchlight does its best to use [semantic versioning](http://semver.org).
 
+## v1.3.0
+
+New Mongoid adapter, thanks to [iliabylich](https://github.com/iliabylich).
+
 ## v1.2.4
 
 - `options` method only returns those that map to search methods (not `attr_accessor` type values)

data/Gemfile

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

data/README.md

@@ -10,6 +10,10 @@ Searchlight can work with any ORM or object that can build a query using chained
 [![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)
 
+## Getting Started
+
+An [introductory video](https://vimeo.com/69179161), [the demo app it uses](http://bookfinder-searchlight-demo.herokuapp.com) and [the code for that app](https://github.com/nathanl/bookfinder) are available to help you get started.
+
 ## Overview
 
 The basic idea of Searchlight is to build a search by chaining method calls that you define. It calls **public** methods on the object you specify, based on the options you pass.
@@ -284,13 +288,13 @@ end
 ```
 ## Adapters
 
-Currently, Searchlight has adapters for ActiveRecord and ActionView. We'd love to get pull requests for others. :)
+Currently, Searchlight has adapters for ActiveRecord, ActionView, and Mongoid. We'd love to get pull requests for others. :)
 
-### ActiveRecord
+### ActiveRecord and Mongoid
 
-When you call `search_on` in your Searchlight class, Searchlight checks whether the search target comes from ActiveRecord, and, if so, mixes a module into your class.
+When you call `search_on` in your Searchlight class, Searchlight checks whether the search target comes from ActiveRecord or Mongoid, and, if so, mixes a module into your class.
 
-For each of your search options, the module will have the simplest possible search method defined. For example, if your class `searches :name`, the module will have this method:
+For each of your search options, the module will have the simplest possible search method defined. For example, if your class `searches :name`, the ActiveRecord module will have this method:
 
 ```ruby
   def search_name
@@ -300,8 +304,6 @@ 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/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec :path => ".."
+
+gem "rails",     "~> 3.2.13"
+gem 'mongoid',   "~> 3.1.4"
+gem 'coveralls', require: false

data/gemfiles/Gemfile.rails-4.0.x

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec :path => '..'
+
+gem "rails",     "~> 4.0.0"
+gem "mongoid"
+gem 'bson_ext'
+gem 'coveralls', require: false

data/lib/searchlight.rb

@@ -8,4 +8,5 @@ end
 require 'searchlight/dsl'
 require 'searchlight/search'
 require 'searchlight/adapters/active_record' if defined?(::ActiveRecord)
+require 'searchlight/adapters/mongoid'       if defined?(::Mongoid)
 require 'searchlight/adapters/action_view'   if defined?(::ActionView)

data/lib/searchlight/adapters/mongoid.rb

@@ -0,0 +1,60 @@
+module Searchlight
+  module Adapters
+    module Mongoid
+
+      def search_on(target)
+        super
+        extend Search if mongoid?(target)
+      end
+
+      module Search
+
+        def searches(*attributes_names)
+          super
+
+          attributes_names.map do |attribute_name|
+            method_name = "search_#{attribute_name}"
+            if field?(attribute_name)
+              define_method method_name do
+                search.where(attribute_name.to_s => public_send(attribute_name))
+              end
+            else
+              define_method method_name do
+                raise Searchlight::Adapters::Mongoid::UndefinedColumn,
+                "Class `#{self.class.model_class}` has no field `#{attribute_name}`; please define `search_#{attribute_name}` on `#{self.class}` to clarify what you intend to search for"
+              end
+            end
+          end
+        end
+
+        def field?(attributes_name)
+          model_class.fields.has_key? attributes_name.to_s
+        end
+
+        def model_class
+          search_target.is_a?(::Mongoid::Criteria) ? search_target.klass : search_target
+        end
+
+      end
+
+      protected
+
+      def mongoid?(target)
+        mongoid_document?(target) || mongoid_criteria?(target)
+      end
+
+      def mongoid_document?(target)
+        defined?(::Mongoid::Document) && target.include?(::Mongoid::Document)
+      end
+
+      def mongoid_criteria?(target)
+        defined?(::Mongoid::Criteria) && target.is_a?(::Mongoid::Criteria)
+      end
+
+      UndefinedColumn = Class.new(StandardError)
+
+    end
+  end
+end
+
+Searchlight::Search.extend(Searchlight::Adapters::Mongoid)

data/lib/searchlight/version.rb

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

data/searchlight.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec",     "~> 2.13"
   spec.add_development_dependency "bundler",   "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rails",     ">= 3"
   spec.add_development_dependency "capybara",  "~> 2.0"
   spec.add_development_dependency "simplecov", "~> 0.7"
 end

data/spec/searchlight/adapters/action_view_spec.rb

@@ -2,14 +2,16 @@ require 'spec_helper'
 
 describe 'Searchlight::Adapters::ActionView', type: :feature, adapter: true do
 
+  let(:view)   { ::ActionView::Base.new }
+  let(:search) { AccountSearch.new(paid_amount: 15) }
+
   before :all do
     require 'searchlight/adapters/action_view'
     require 'action_view'
+    require 'active_model'
+    require 'active_support/core_ext'
   end
 
-  let(:view)   { ::ActionView::Base.new }
-  let(:search) { AccountSearch.new(paid_amount: 15) }
-
   before :each do
     view.stub(:protect_against_forgery?).and_return(false)
   end

data/spec/searchlight/adapters/mongoid_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe 'Searchlight::Adapters::Mongoid', adapter: true do
+
+  before :all do
+    require 'mongoid'
+    require 'searchlight/adapters/mongoid'
+  end
+
+  after :all do
+    Object.send(:remove_const, :Mongoid)
+  end
+
+  let(:search_class)    {
+    Named::Class.new('SearchClass', Searchlight::Search).tap { |klass| klass.search_on target }
+  }
+
+  let(:search_instance) { search_class.new(elephants: 'yes, please') }
+
+  shared_examples "search classes with an Mongoid target" do
+
+    context "when the base model has a field matching the search term" do
+
+      before do
+        MockMongoid.stub(:fields).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
+
+    end
+
+    context "when the base model has no field matching the search term" do
+
+      before do
+        MockMongoid.stub(fields: {})
+        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::Mongoid::UndefinedColumn
+        )
+      end
+
+    end
+
+  end
+
+  context "when the search target is a class with Mongoid::Document module" do
+
+    let(:target)   { MockMongoid }
+
+    it_behaves_like "search classes with an Mongoid target"
+
+  end
+
+  context "when the search target is Mongoid::Criteria class" do
+
+    let(:target)   { MockMongoidCriteria.new([]) }
+
+    before do
+      target.stub(klass: MockMongoid)
+    end
+
+    it_behaves_like "search classes with an Mongoid target"
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,11 +1,16 @@
 require 'capybara/rspec'
-require 'simplecov'
-SimpleCov.start
-require 'coveralls'
-Coveralls.wear!
+if ENV["TRAVIS"]
+  require 'coveralls'
+  Coveralls.wear!
+else
+  require 'simplecov'
+  SimpleCov.start { add_filter "/spec" }
+end
 require 'searchlight'
 $LOAD_PATH << '.'
 require 'support/mock_model'
+require 'support/mock_models/active_record'
+require 'support/mock_models/mongoid'
 require 'support/account_search'
 require 'support/spiffy_account_search'
 

data/spec/support/mock_model.rb

@@ -3,18 +3,6 @@ class MockModel
   def self.method_missing(method, *args, &block)
     MockRelation.new(method)
   end
-  
-end
-
-class MockActiveRecord < MockModel
-
-  def self.ancestors
-    super + [::ActiveRecord::Base]
-  end
-
-  def self.is_a?(thing)
-    thing == ::ActiveRecord::Base ? true : super
-  end
 
 end
 

data/spec/support/mock_models/active_record.rb

@@ -0,0 +1,23 @@
+class MockActiveRecord < MockModel
+
+  def self.ancestors
+    super + [::ActiveRecord::Base]
+  end
+
+  def self.is_a?(thing)
+    thing == ::ActiveRecord::Base ? true : super
+  end
+
+end
+
+class MockActiveRecordRelation < MockRelation
+
+  def is_a?(thing)
+    thing == ::ActiveRecord::Relation ? true : super
+  end
+
+  def engine
+    MockActiveRecord
+  end
+
+end

data/spec/support/mock_models/mongoid.rb

@@ -0,0 +1,19 @@
+class MockMongoid < MockModel
+
+  def self.include?(thing)
+    thing == ::Mongoid::Document ? true : super
+  end
+
+end
+
+class MockMongoidCriteria < MockRelation
+
+  def is_a?(thing)
+    thing == ::Mongoid::Criteria ? true : super
+  end
+
+  def self.include?(thing)
+    thing == ::Mongoid::Document ? false : super
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchlight
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Nathan Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: named
@@ -67,20 +67,6 @@ dependencies:
     - - '>='
       - !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
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -129,20 +115,26 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- gemfiles/Gemfile.rails-3.2.x
+- gemfiles/Gemfile.rails-4.0.x
 - lib/searchlight.rb
 - lib/searchlight/adapters/action_view.rb
 - lib/searchlight/adapters/active_record.rb
+- lib/searchlight/adapters/mongoid.rb
 - lib/searchlight/dsl.rb
 - lib/searchlight/search.rb
 - lib/searchlight/version.rb
 - searchlight.gemspec
 - spec/searchlight/adapters/action_view_spec.rb
 - spec/searchlight/adapters/active_record_spec.rb
+- spec/searchlight/adapters/mongoid_spec.rb
 - spec/searchlight/search_spec.rb
 - spec/searchlight_spec.rb
 - spec/spec_helper.rb
 - spec/support/account_search.rb
 - spec/support/mock_model.rb
+- spec/support/mock_models/active_record.rb
+- spec/support/mock_models/mongoid.rb
 - spec/support/spiffy_account_search.rb
 homepage: https://github.com/nathanl/searchlight
 licenses:
@@ -172,9 +164,12 @@ summary: Searchlight helps you build searches from options via Ruby methods that
 test_files:
 - spec/searchlight/adapters/action_view_spec.rb
 - spec/searchlight/adapters/active_record_spec.rb
+- spec/searchlight/adapters/mongoid_spec.rb
 - spec/searchlight/search_spec.rb
 - spec/searchlight_spec.rb
 - spec/spec_helper.rb
 - spec/support/account_search.rb
 - spec/support/mock_model.rb
+- spec/support/mock_models/active_record.rb
+- spec/support/mock_models/mongoid.rb
 - spec/support/spiffy_account_search.rb