simple_search 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,17 +1,64 @@
-= simple_search
+= SimpleSearch
 
-Description goes here.
+A rather unimaginatively named gem designed to provide simple search functionality to ActiveRecord-backed
+models and, more usefully, views.
 
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+Given a model Widget that belongs_to a WidgetType, shouldn't you be able to do something like this ...
+
+  <% form_for :search, @search, :html => {:method => :get} do |f| %>
+    <%= f.label :name %>
+    <%= f.text_field :name %>
+    <%= f.label :widget_type_name_starts_with %>
+    <%= f.text_field :widget_type_name_starts_with %>
+    <%= f.submit %>
+  <% end %>
+
+... to create a search form?
+
+Yes. Yes, you should.  
+
+== Example
+
+Let's say you're going to add a search form to your index page like the one above.
+
+In your controller:
+
+Grab the search params or set a default.
+
+  search = params[:search] || {}
+
+Merge in any additional criteria, or add an association to the search. Here,
+I only want to find Widgets that are less than a week old, and I want to be able
+to search on attributes of the Widget's WidgetType as well.
+
+  @search = SimpleSearch::Search.new(
+    Widget,
+    search.merge(:created_at_from => 1.week.ago, :search_associations => :widget_type)
+  )
+  
+This will do a full search, and use pagination. All options are passed through to find or
+paginate (will_paginate), as required.
+  @widgets = @search.search(:page => params[:page])
+
+Or if you just want to count the records that would be matched.
+
+  @count = @search.count
+
+Then in your view:
+
+  <% form_for :search, @search, :html => {:method => :get} do |f| %>
+    <%= f.label :name %>
+    <%= f.text_field :name %>
+    <%= f.label :widget_type_name_starts_with %>
+    <%= f.text_field :widget_type_name_starts_with %>
+    <%= f.submit %>
+  <% end %>
+
+Remember, searches are idempotent so to appease the HTTP gods (and make it easy to bookmark
+search results) they should be executed with GET.
+  
+That should get you started, for now.
 
 == Copyright
 
-Copyright (c) 2010 Ernie Miller. See LICENSE for details.
+Copyright (c) 2010 {Ernie Miller}[http://metautonomo.us]. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/simple_search/search.rb

@@ -3,7 +3,6 @@ module SimpleSearch
     attr_reader :options, :associations
 
     def initialize(model, options = {})
-      raise StandardError, "#{model.to_s} is not searchable" unless model.metaclass.method_defined?(:search)
       @model = model
       @associations = [*options.delete(:search_associations)].compact
       @association_objects = @associations.map do |a|
@@ -35,6 +34,26 @@ module SimpleSearch
     
       conditions.blank? ? [] : [conditions.join(" AND "), *parameters]
     end
+    
+    def search(args = {})
+      args.merge!(
+        :conditions => self.conditions,
+        :include => (self.associations + [*args[:include]]).compact.uniq
+      )
+      if @model.respond_to?(:paginate) && args.has_key?(:page)
+        @model.paginate(:all, args)
+      else
+        @model.find(:all, args)
+      end
+    end
+  
+    def count(args = {})
+      args.merge!(
+        :conditions => self.conditions,
+        :include => (self.associations + [*args[:include]]).compact.uniq
+      )
+      @model.count(args)
+    end
 
     private
 

data/lib/simple_search.rb

@@ -1,2 +1 @@
-require 'simple_search/search'
-require 'simple_search/searchable'
+require 'simple_search/search'

data/simple_search.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple_search}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ernie Miller"]
@@ -25,7 +25,6 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/simple_search.rb",
      "lib/simple_search/search.rb",
-     "lib/simple_search/searchable.rb",
      "simple_search.gemspec",
      "test/helper.rb",
      "test/test_simple_search.rb"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ernie Miller
@@ -47,7 +47,6 @@ files:
 - VERSION
 - lib/simple_search.rb
 - lib/simple_search/search.rb
-- lib/simple_search/searchable.rb
 - simple_search.gemspec
 - test/helper.rb
 - test/test_simple_search.rb

data/lib/simple_search/searchable.rb

@@ -1,30 +0,0 @@
-module SimpleSearch
-  module Searchable
-    module ClassMethods
-      # The "s" parameter is an instance of Search, instantiated from form input. 
-      def search(s, args = {})
-        args.merge!(
-          :conditions => s.conditions,
-          :include => (s.associations + [*args[:include]]).compact.uniq
-        )
-        if self.respond_to?(:paginate) && args.has_key?(:page)
-          self.paginate(:all, args)
-        else
-          self.find(:all, args)
-        end
-      end
-    
-      def search_count(s, args = {})
-        args.merge!(
-          :conditions => s.conditions,
-          :include => (s.associations + [*args[:include]]).compact.uniq
-        )
-        self.count(args)
-      end
-    end
-  
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-  end
-end