searchlight 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad62f9410f019b9c6bb09ce5e1e6b1e804ee152c
-  data.tar.gz: 154208ad780633fff9670fd0a174ae3d46ae228a
+  metadata.gz: be95aae20e317b4b6be6f0124ab80790405b62e5
+  data.tar.gz: 370872f18bf03156a833b49052fd034019b37bf1
 SHA512:
-  metadata.gz: 0aba3b57deac310d31274584c06ecd8075c2c709e99b8ca2190dd7fffadee25cd31a78b162ca750c5b3ea054d134b61e385b8d7f0eacd12da07f039c530dbcfd
-  data.tar.gz: dfb54abe4eadcb4a3657a37225315ed0e8c1c79d65e035b5655f306fb329b2e9190529f50e2ca6fd3c98dd9f4b23bc2fe4c0ab91316708e174f6e8c92e012a66
+  metadata.gz: fddc94f601422650e35d6626041b454adb226163dbd5d9685b6864415fc408ca8cd5d918cc52fe72a37e56fe4f12a57e771e73e24a957c0b74a6b286e0cf19b0
+  data.tar.gz: 397ac3fc0b5b8c249eff00f332c508fb23fef38c9576f21870a01864d91d8a79433d35e34389bd9f15dea928e786ecef88e33e0f2ce77a44ed5b5e365d189f0c

data/CHANGELOG.md

@@ -4,7 +4,9 @@ Searchlight does its best to use [semantic versioning](http://semver.org), for t
 
 ## Unreleased
 
-Nothing
+## v4.1.0 - 2015-10-29
+
+- Option readers now will find symbol keys as well as string keys
 
 ## v4.0.0 - 2015-10-28
 
@@ -18,6 +20,7 @@ Removed the DSL methods to simplify some things. This is a breaking change, but
   - `empty?` interprets empty arrays and hashes as empty, as well as empty or whitespace-only strings. It's used to filter the options that get passed to your search methods.
 - `explain` tells you exactly how searchlight interpreted the options a search was given. (Depending on your ORM, you might also want to call `.sql` or `.to_sql` on `search.results` for further debugging.)
 - `Searchlight::Adapters::ActionView` adapter must now be explicitly required and included.
+- Within your `search_` methods, the query you chain on is now called `query`, not `search`
 
 ## v3.1.1
 

data/README.md

@@ -11,7 +11,7 @@ Searchlight can work with **any** ORM or object that can build a query using **c
 
 ## 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.
+A [demo app](http://bookfinder-searchlight-demo.herokuapp.com) and [the code for that app](https://github.com/nathanl/searchlight_demo) are available to help you get started.
 
 ## Overview
 
@@ -55,15 +55,15 @@ class PersonSearch < Searchlight::Search
   # A search method.
   def search_first_name
     # If `"first_name"` was the first key in the options_hash,
-    # `search` here will be the base query, namely, `Person.all`.
-    search.where(first_name: options[:first_name])
+    # `query` here will be the base query, namely, `Person.all`.
+    query.where(first_name: options[:first_name])
   end
 
   # Another search method.
   def search_last_name
     # If `"last_name"` was the second key in the options_hash,
-    # `search` here will be whatever `search_first_name` returned.
-    search.where(last_name: last_name)
+    # `query` here will be whatever `search_first_name` returned.
+    query.where(last_name: last_name)
   end
 end
 ```
@@ -83,17 +83,17 @@ class CitySearch < Searchlight::Search
 
   # Reach into other tables
   def search_continent
-    search.where('`countries`.`continent` = ?', continent)
+    query.where('`countries`.`continent` = ?', continent)
   end
 
   # Other kinds of queries
   def search_country_name_like
-    search.where("`countries`.`name` LIKE ?", "%#{country_name_like}%")
+    query.where("`countries`.`name` LIKE ?", "%#{country_name_like}%")
   end
 
   # .checked? considers "false", 0 and "0" to be false
   def search_is_megacity
-    search.where("`cities`.`population` #{checked?(is_megacity) ? '>=' : '<'} ?", 10_000_000)
+    query.where("`cities`.`population` #{checked?(is_megacity) ? '>=' : '<'} ?", 10_000_000)
   end
 
 end
@@ -117,9 +117,9 @@ non_megas.results.each do |city|
 end
 ```
 
-### Accessors
+### Option Readers
 
-For each search method you define, Searchlight will define a corresponding accessor method. Eg, if you add `def search_first_name`, your search class will get a `.first_name` method that returns `options["first_name"]`. This is useful mainly when building forms.
+For each search method you define, Searchlight will define a corresponding option reader method. Eg, if you add `def search_first_name`, your search class will get a `.first_name` method that returns `options["first_name"]`. This is useful mainly when building forms.
 
 **Note that this checks for string keys** - you must either use them, or use something like `ActiveSupport::HashWithIndifferentAccess`.
 
@@ -287,6 +287,8 @@ Or install it yourself as:
 
 ## Contributing
 
+`rake` runs the tests; `rake mutant` runs mutation tests using [mutant](https://github.com/mbj/mutant).
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/Rakefile

@@ -13,3 +13,20 @@ task :console do
   ARGV.clear
   IRB.start
 end
+
+desc "Mutation test with mutant gem. Provide scope, eg: Searchlight::Search or Searchlight::Options#excluding_empties"
+task :mutant do
+  scope = ENV.fetch("SCOPE") {
+    puts "Must set SCOPE env variable, eg `SCOPE=Searchlight::Search`"
+    exit
+  }
+
+  ARGV.clear
+  command = "mutant --include lib --require searchlight --use rspec #{scope}"
+  begin
+    exec(command)
+  rescue Errno::ENOENT
+    puts "Could not find mutant executable - please install gem 'mutant-rspec'"
+    puts "(Not included as a test dependency because it breaks CI; mutant only works with Ruby > 2.1.0"
+  end
+end

data/lib/searchlight/options.rb

@@ -3,7 +3,7 @@ module Searchlight::Options
   def self.empty?(value)
     return true if value.nil?
     return true if value.respond_to?(:empty?) && value.empty?
-    return true if value.is_a?(String) && /\A[[:space:]]*\z/ === value
+    return true if /\A[[:space:]]*\z/ === value
     false
   end
 
@@ -14,14 +14,14 @@ module Searchlight::Options
   def self.excluding_empties(input)
     output = input.dup
     output.each do |key, value|
-      if value.is_a?(Array)
-        output[key] = value.reject { |v| empty?(v) }
-      end
       if value.is_a?(Hash)
-        output[key] = value.reject { |k, v| empty?(v) }
+        output[key] = value.reject { |_, v| empty?(v) }
+      end
+      if value.instance_of?(Array)
+        output[key] = value.reject { |v| empty?(v) }
       end
     end
-    output.reject { |key, value| empty?(value) }
+    output.reject { |_, value| empty?(value) }
   end
 
 end

data/lib/searchlight/search.rb

@@ -12,12 +12,17 @@ class Searchlight::Search
       option_name = match.captures.fetch(0)
       # accessor - eg, if method_name is #search_title, define #title
       define_method(option_name) do
-        options[option_name]
+        options.key?(option_name) ? options[option_name] : options[option_name.to_sym]
       end
     end
   end
 
   def initialize(raw_options = {})
+    string_keys, non_string_keys = raw_options.keys.partition {|k| k.is_a?(String) }
+    intersection = string_keys & non_string_keys.map(&:to_s)
+    if intersection.any?
+      fail ArgumentError, "more than one key converts to these string values: #{intersection}"
+    end
     @raw_options = raw_options
   end
 
@@ -49,7 +54,7 @@ class Searchlight::Search
 
   def options_with_search_methods
     {}.tap do |map|
-      options.each do |option_name, option_value|
+      options.each do |option_name, _|
         method_name = "search_#{option_name}" 
         map[option_name] = method_name if respond_to?(method_name)
       end

data/lib/searchlight/version.rb

@@ -1,3 +1,3 @@
 module Searchlight
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
 end

data/spec/searchlight/options_spec.rb

@@ -52,6 +52,11 @@ describe Searchlight::Options do
   describe "excluding empties" do
 
     it "removes empty values at the top level of the hash" do
+      # Simulate something like HashWithIndifferentAccess
+      relations = FancyHash.new
+      relations[:uncle] = "Jimmy"
+      relations[:aunt] = nil
+
       expect(
         mod.excluding_empties(
           name: "Bob",
@@ -59,8 +64,8 @@ describe Searchlight::Options do
           likes: ["pizza", "fish"],
           dislikes: [],
           elvish: false,
-          relations: {uncle: "Jimmy"},
-          eh: {},
+          relations: relations,
+          enemies: {},
         )
       ).to eq(
         name: "Bob",
@@ -75,10 +80,11 @@ describe Searchlight::Options do
     it "does not remove empty values from more deeply-nested elements" do
       expect(
         mod.excluding_empties(
-          tags: ["one", "two", "", nil, "three", ["a", "", nil, "b"], {a: ""}]
+          tags: ["one", "two", "", nil, "three", ["a", "", nil, "b"], {a: ""}],
+
         )
       ).to eq(
-        tags: ["one", "two", "three", ["a", "", nil, "b"], {a: ""}]
+        tags: ["one", "two", "three", ["a", "", nil, "b"], {a: ""}],
       )
     end
 

data/spec/searchlight/search_spec.rb

@@ -14,6 +14,22 @@ describe Searchlight::Search do
   }
   let(:search) { BookSearch.new(raw_options) }
 
+  describe "initialization" do
+
+    it "doesn't require options" do
+      expect(BookSearch.new.results).to eq(BookSearch.new({}).results)
+    end
+
+    it "blows up if there is a string/symbol key conflict" do
+      expect {
+        described_class.new(a: 1, "a" => 2)
+      }.to raise_error(
+        ArgumentError, %Q{more than one key converts to these string values: ["a"]}
+      )
+    end
+
+  end
+
   describe "parsing options" do
 
     it "makes the raw options available" do
@@ -39,6 +55,18 @@ describe Searchlight::Search do
     end
   end
 
+  describe "option readers" do
+
+    it "has an option reader method for each search method, which can read strings or symbols" do
+      expect(search.author_name_like).to eq("Lew")
+      expect(search.title_like).to eq("Mere Christianity")
+      expect(search.board_book).to eq(nil)
+      expect{search.book_thickness}.to raise_error(NoMethodError)
+      expect{search.not_an_option}.to raise_error(NoMethodError)
+    end
+
+  end
+
   describe "querying" do
 
     it "builds results by running all methods matching its options" do
@@ -55,7 +83,19 @@ describe Searchlight::Search do
   end
 
   it "has an 'explain' method to show how it builds its query" do
-    expect(search.explain).to be_a(String)
+    expect(search.explain).to eq(
+      %Q{
+Initialized with `raw_options`: [:title_like, "author_name_like", :category_in, :tags, :book_thickness, :parts_about_lolcats]
+
+Of those, the non-blank ones are available as `options`: [:title_like, "author_name_like", :tags, :book_thickness, :in_print]
+
+Of those, the following have corresponding `search_` methods: [:title_like, "author_name_like", :in_print]. These would be used to build the query.
+
+Blank options are: [:category_in, :parts_about_lolcats]
+
+Non-blank options with no corresponding `search_` method are: [:tags, :book_thickness]
+      }.strip
+    )
   end
 
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'searchlight'
 $LOAD_PATH << '.'
 require 'support/mock_model'
 require 'support/book_search'
+require 'support/fancy_hash'
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

data/spec/support/fancy_hash.rb

@@ -0,0 +1,3 @@
+# Eg, like Rails' HashWithIndifferentAccess
+class FancyHash < Hash
+end

data/spec/support/mock_model.rb

@@ -1,7 +1,7 @@
 class MockModel
 
   def self.method_missing(method, *args, &block)
-    MockRelation.new(method)
+    MockRelation.new([method])
   end
 
 end
@@ -9,20 +9,16 @@ end
 class MockRelation
   attr_reader :called_methods
 
-  def initialize(called_method)
-    @called_methods = [called_method]
+  def initialize(called_methods)
+    @called_methods = called_methods
   end
 
   def method_missing(method, *args, &block)
-    tap { called_methods << method }
+    self.class.new(called_methods + [method])
   end
-
-  def is_a?(thing)
-    thing == ::ActiveRecord::Relation ? true : super
-  end
-
-  def engine
-    MockActiveRecord
+  
+  def ==(other)
+    other.class == self.class && other.called_methods == called_methods
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchlight
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Nathan Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -129,6 +129,7 @@ files:
 - spec/searchlight_spec.rb
 - spec/spec_helper.rb
 - spec/support/book_search.rb
+- spec/support/fancy_hash.rb
 - spec/support/mock_model.rb
 homepage: https://github.com/nathanl/searchlight
 licenses:
@@ -161,4 +162,5 @@ test_files:
 - spec/searchlight_spec.rb
 - spec/spec_helper.rb
 - spec/support/book_search.rb
+- spec/support/fancy_hash.rb
 - spec/support/mock_model.rb