mundane-search 0.0.2 → 0.0.3

data/README.md

@@ -12,9 +12,7 @@ You know the deal:
 
 ## Usage
 
-Still in the process of figuring this out! But much of it works like I want, so hopefully no brutal changes.
-
-### Typical use
+*Still in the process of figuring this out! But much of it works like I want, so hopefully no brutal changes.*
 
 Build a search, then run that search on a specific collection and params.
 
@@ -30,25 +28,130 @@ Create a search:
 Add filters to it:
 
     class BookSearch < MundaneSearch::Result
-      use MundaneSearch::Filters::AttributeMatch, param_key: "title"
+      use :attribute_match, param_key: "title"
     end
 
 Then use that search in your controllers:
 
-    # params = { "title" => "A Tale of Two Cities" }
-    @result = BookSearch.results_for(Book.scoped, params)
+    # params = { "book_search" => { "title" => "A Tale of Two Cities" } }
+    @result = BookSearch.results_for(Book.scoped, params["book_search"])
 
 The returned result is enumerable:
 
     @result.each {|book| ... }
     @result.first
 
-And has some Rails form compatibility:
+And has some Rails-style form compatibility:
 
     <%= search_form_for(@result) do |f| %>
       <%= f.input :title %>
     <% end %>
 
+As well as url-ability:
+
+    search_url_for(@result)
+
+## Filters
+
+There are built in filters and you can make your own filters.
+
+Three ways to notate filters:
+
+    class ExampleSearch < MundaneSearch::Result
+      use FilterClass
+      use :filter_class
+      employ :shortcut
+    end
+
+1.  use FilterClass, options
+    The most straightforward. Under the hood, this establishes that a searched collection will be
+    passed through this filter.
+2.  use :filter_class, options
+    This is the same as specifying FilterClass, except MundaneSearch will look for filter_class
+    in MundaneSearch::Filters if it isn't found in the Object namespace.
+3.  employ :shortcut, options
+    This is the avenue for shortcuts, such as when you might want several filters to be created
+    by one designation.
+    I haven't spent much thought on this, it may change in the future.
+
+
+## Built in filters
+
+### Common options
+
+First some options that are common to many filters.
+
+* param_key: The key in params to examine for a matching value.
+* target: The attribute to match against. By default, uses param_key.
+* match_value: Usually nil. When nil, the value of params[param_key] is used.
+* required: Default false. When true, will run a filter even if (for example) the match_value is nil.
+* type: Gives form helpers et al a hint as to what type the match_value should be. Overrides class method param_key_type in a filter.
+  Available types:
+  1. :string
+  2. :integer
+  3. :float
+  4. :date
+  5. :time
+
+All those suckers in action:
+
+    class BookSearch < MundaneSearch::Result
+      # book.publisher == params["publisher"] even if the match_value (params["publisher"]) is nil
+      # (in below examples, the filter is skipped if the match_value is nil)
+      use :attribute_match, param_key: "publisher", required: true
+
+      # book.title == params["title"]
+      use :attribute_match, param_key: "title"
+
+      # book.author == params["writer"]
+      use :attribute_match, param_key: "writer", target: "author"
+
+      # book.publication_date > Date.parse("1900-01-01") (disregards params)
+      use :operator, param_key: "publication_date", operator: :>, match_value: Date.parse("1900-01-01")
+
+      # simple_form displays filter as designated type
+      use :attribute_match, param_key: "first_purchased_at", type: :time
+    end
+
+### AttributeMatch
+
+Returns objects that exactly match an attribute, ex: book.title == "A Tale of Two Cities"
+
+    use :attribute_match, param_key: "title"
+
+### AttributeSubstring
+
+Returns objects that match a portion of an attribute, ex: book.title =~ /Tale of/
+
+    use :attribute_substring, param_key: title
+
+### Operator
+
+Returns objects that match an attribute + operator, ex: book.publication_date > Date.parse("1900-01-01")
+
+Requires a param_key and a symbol of an operator (:>, :<, :>=, :<=)
+
+    use :operator, param_key: "publication_date", operator: :>
+
+### Order
+
+Sorts a collection.
+
+    use :order, param_key: "sort", direction: "asc"
+
+
+#### ExactMatch
+
+MundaneSearch can also work with objects that aren't "attribute-y".
+
+Return objects that are equal to the match_value. Used in a lot of examples below.
+
+### BlankParamsAreNil
+
+The params can be manipulated.
+
+Changes values of "", [], or {} to nil in params.
+
 ## Sans sugar
 
 MundaneSearch can be used outside of Rails on whatever sort of object you want:

data/lib/mundane-search/filters/order.rb

@@ -0,0 +1,35 @@
+module MundaneSearch::Filters
+  class Order < Typical
+    class ActiveRecord < self
+      def filtered_collection
+        collection.order("#{match_value} #{active_record_direction}")
+      end
+
+      def active_record_direction
+        direction || "ASC"
+      end
+    end
+
+    def filtered_collection
+      collection.sort_by(&:"#{match_value}")
+      backwards? ? collection.reverse : collection
+    end
+
+    protected
+    def backwards?
+      descending_terms.include?(direction)
+    end
+
+    def direction
+      params["direction"] || options[:direction]
+    end
+
+    def ascending_terms
+      %w(asc ascending <)
+    end
+
+    def descending_terms
+      %w(desc descending >)
+    end
+  end
+end

data/lib/mundane-search/filters/typical.rb

@@ -21,11 +21,12 @@ module MundaneSearch::Filters
     end
 
     def match_value
-      params[param_key]
+      options[:match_value] || params[param_key]
     end
 
+    # This is a duplicate of the class method?
     def param_key_type
-      options[:type] || :string
+      options[:type] || self.class.param_key_type
     end
   end
 end

data/lib/mundane-search/result_model.rb

@@ -22,6 +22,12 @@ module MundaneSearch
       end
     end
 
+    # Added this for the benefit of search_url_for
+    # If it stays, it should replace stack.params in the method above.
+    def params
+      send(:result).stack.params
+    end
+
     def self.model_name
       name = 'GenericSearch' unless self.name
       namespace = nil

data/lib/mundane-search/version.rb

@@ -1,3 +1,3 @@
 module MundaneSearch
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/mundane-search/view_helpers.rb

@@ -1,5 +1,11 @@
 module MundaneSearch
   module ViewHelpers
+    def search_url_for(search, change_params = {})
+      search_model = search.to_model
+      new_parms = search_model.params.merge(change_params).reject {|k,v| v.nil? }
+      polymorphic_url search_model, new_parms
+    end
+
     def search_form_for(record, options = {}, &block)
       # Later!
       # if block_given?

data/spec/filters/order_integration_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../minitest_helper'
+require_relative '../active_record_setup'
+
+describe MundaneSearch::Filters::Order do
+  before do
+    DatabaseCleaner.clean
+    populate_books!
+  end
+
+  let(:all_books) { Book.scoped }
+  let(:a_tale_of_two_cities) { Book.first }
+
+  it "should match based on param_key" do
+    built = MundaneSearch::Builder.new do
+      use MundaneSearch::Filters::Order, param_key: "sort"
+    end
+
+    dates = built.call(all_books, {"sort" => "publication_date"})
+    dates.inject do |last, current|
+      last.publication_date.must_be :<, current.publication_date if last
+      current
+    end
+  end
+end

data/spec/filters/order_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../minitest_helper'
+require_relative '../demo_data'
+
+describe MundaneSearch::Filters::Order do
+  let(:books)  { open_struct_books }
+  let(:a_tale) { books.first }
+  let(:order)  { MundaneSearch::Filters::Order }
+  it "should order by title" do
+    books.reverse!
+    filter = order.new(books, {'sort' => "title"}, {param_key: 'sort'})
+
+    filter.filtered_collection.first.must_equal(a_tale)
+  end
+
+  describe MundaneSearch::Filters::Order::ActiveRecord do
+    let(:order) { MundaneSearch::Filters::Order::ActiveRecord }
+    it "should filter with 'where'" do
+      collection = Minitest::Mock.new
+      params = { 'sort' => "title" }
+      result = Object.new
+
+      filter = order.new(collection, params, param_key: 'sort')
+      collection.expect(:order, result, ["title ASC"])
+      filter.filtered_collection.must_equal(result)
+      collection.verify
+    end
+  end
+end

data/spec/filters/typical_spec.rb

@@ -53,6 +53,10 @@ describe MundaneSearch::Filters::Typical do
     it "should return param value matching param_key" do
       typical(param_key: "foo").match_value.must_equal "bar"
     end
+
+    it "should use explicit match value when supplied" do
+      typical(match_value: "foo").match_value.must_equal "foo"
+    end
   end
 
   describe "#param_key_type" do

data/spec/minitest_helper.rb

@@ -70,6 +70,20 @@ def params
   { 'foo' => 'bar' }
 end
 
+def requirements_for_search_url_for_tests!
+  require 'action_dispatch/routing/polymorphic_routes'
+  def view_with_url_class
+    Class.new do
+      include ActionDispatch::Routing::PolymorphicRoutes
+      %w(generic_search_url).each do  |path|
+        define_method path do |a=nil,b=nil|
+          "/#{path}"
+        end
+      end
+    end
+  end
+end
+
 def requirements_for_form_for_tests!
   require_relative 'demo_data'
   require 'active_support/concern'

data/spec/search_url_for_integration_spec.rb

@@ -0,0 +1,20 @@
+require_relative 'minitest_helper'
+
+requirements_for_search_url_for_tests!
+
+describe "integration search_url_for" do
+  let(:result_class) { Class.new(MundaneSearch::Result) }
+  let(:result) { result_class.new(open_struct_books, params) }
+  let(:result_model) { result.to_model }
+  let(:search_url_viewed_class) do
+    Class.new(view_with_url_class) do
+      include MundaneSearch::ViewHelpers
+    end
+  end
+  let(:search_url_view) { search_url_viewed_class.new }
+
+  it "should generate url" do
+    form = search_url_view.search_url_for(result_model) { }
+    form.must_match %r{\A/}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mundane-search
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000 Z
+date: 2013-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -230,6 +230,7 @@ files:
 - lib/mundane-search/filters/blank_params_are_nil.rb
 - lib/mundane-search/filters/exact_match.rb
 - lib/mundane-search/filters/operator.rb
+- lib/mundane-search/filters/order.rb
 - lib/mundane-search/filters/shortcuts.rb
 - lib/mundane-search/filters/typical.rb
 - lib/mundane-search/initial_stack.rb
@@ -257,6 +258,8 @@ files:
 - spec/filters/exact_match_spec.rb
 - spec/filters/operator_integration_spec.rb
 - spec/filters/operator_spec.rb
+- spec/filters/order_integration_spec.rb
+- spec/filters/order_spec.rb
 - spec/filters/shortcuts_integration_spec.rb
 - spec/filters/shortcuts_spec.rb
 - spec/filters/typical_spec.rb
@@ -268,6 +271,7 @@ files:
 - spec/result_model_spec.rb
 - spec/result_spec.rb
 - spec/search_form_for_integration_spec.rb
+- spec/search_url_for_integration_spec.rb
 - spec/simple_form_integration_spec.rb
 - spec/simple_search_form_for_integration_spec.rb
 - spec/stack_spec.rb
@@ -285,7 +289,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4254395737755402307
+      hash: -2671507479759182852
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -294,10 +298,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4254395737755402307
+      hash: -2671507479759182852
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Makes everyday search easy-ish.
@@ -318,6 +322,8 @@ test_files:
 - spec/filters/exact_match_spec.rb
 - spec/filters/operator_integration_spec.rb
 - spec/filters/operator_spec.rb
+- spec/filters/order_integration_spec.rb
+- spec/filters/order_spec.rb
 - spec/filters/shortcuts_integration_spec.rb
 - spec/filters/shortcuts_spec.rb
 - spec/filters/typical_spec.rb
@@ -329,6 +335,7 @@ test_files:
 - spec/result_model_spec.rb
 - spec/result_spec.rb
 - spec/search_form_for_integration_spec.rb
+- spec/search_url_for_integration_spec.rb
 - spec/simple_form_integration_spec.rb
 - spec/simple_search_form_for_integration_spec.rb
 - spec/stack_spec.rb