rails-simple-search 0.9.4 → 0.9.5

data/{README → README.rdoc}

@@ -1,49 +1,58 @@
-rails-simple-search
-===================
+= rails-simple-search
 
 rails-simple-search is a Ruby gem. It helps you quickly implement searching/filtering function for your web site. This plugin has paginating feature built in. If you're not looking for a full-text searching solution, this plugin will most probably satisfy all your searching requirement.
 
 From time to time, I need to build pages to show a list of narrowed down records from a database table by giving some searching criteria on some columns of the table and/or of some referencing tables. Before I implemented this plugin, I usually do the searching in the following way:
 
-    1) Use <%= form_tag %> to build a form in the view
-    2) Get the searching criteria from the params hash individually in the controller and put them into instance variable to be used in view
-    3) Build the SQL WHERE clause and sometimes the JOIN clause according to the values from the form
-    4) Run the find(:all, :conditions => [xxxxxx], :joins => "yyyyyy") with the WHERE and JOIN clauses
+1. Use <%= form_tag %> to build a form in the view
+2. Get the searching criteria from the params hash individually in the controller and put them into instance variable to be used in view
+3. Build the SQL WHERE clause and sometimes the JOIN clause according to the values from the form
+4. Run the find(:all, :conditions => [xxxxxx], :joins => "yyyyyy") with the WHERE and JOIN clauses
 
 After having used this pattern a few times, I realized I could DRY it to make future coding of this kind of searching much simpler. That's where the rails-simple-search plugin comes in. 
 
 Now implementing the searching/filter page is a lot easier for me. You're see how easy it is by taking a look at the following example. I may give more examples in the future when I have some spare time. 
 
 
-Example
-=======
+== Example
 
 Let's suppose we have models of User, Address, Post and Comment. User model has_one address and has_many posts; Post model has_many comments. We'd like to search for users according to any combination of the following criteria:
 
-    1) part of the user's email addrsss
-    2) state of the user's address
-    3) part of the name of any authors who commented the user's any posts
+* part of the user's email addrsss
+* range of the user's birth date
+* state of the user's address
+* part of the name of any authors who commented the user's any posts
 
 The following is how we implement this searching function with rails-simple-search:
 
-Code in model (app/model/search.rb):
+1. Include gem into Gemfile
+  
+    gem 'rails-simple-search'
+
+2. Code in model (app/model/search.rb):
 
     class Search < RailsSimpleSearch::Base
     end
 
-Code in controller:
+3. Code in controller: 
 
     @search = Search.new(User, params[:search])
     @search.order = 'email'  # optional
     @users = @search.run
 
-Code in views:
+4. Code in views:
 
-    <% form_for @search do |f| %>
+    <% form_for @search, url => "/xxxxxx" do |f| %>
 
       <%=f.label :email %>
       <%=f.text_field :email %>
 
+      <%=f.label :from_birth_date %>
+      <%=f.text_field :birth_date_greater_than_or_equal_to %>
+
+      <%=f.label :to_age %>
+      <%=f.text_field :birth_date_less_than_or_equal_to %>
+
       <%=f.label :state%>
       <%=f.select "address.state_id", [['AL', 1], ...] %>  <!-- address is an association of model User -->
 
@@ -57,11 +66,15 @@ Code in views:
      <%= # show the attributes of user %>
     <% end %>
 
-Note
-====
+5. Add route for the post to url "/xxxxxx" (config/route.rb)
+    match "/xxxxxx" => "yyyyyyy#zzzzzz"
+
+== Note
+
 For rails 2.x.x applications, you might want to use the version 0.9.0. Since version 0.9.1, this gem started to support rails 3 now. The latest version 0.9.4 is tested under rails 3.2.6.
 
 There is a real demo application which you can download and run immediately: https://github.com/yzhanginwa/demo_app_for_rails_simple_search
 
+== License
 
 Copyright (c) 2012 [Yi Zhang], released under the MIT license

data/lib/rails-simple-search.rb

@@ -16,7 +16,7 @@ module RailsSimpleSearch
       end
     end
  
-    def initialize(model_class, criteria, config={})
+    def initialize(model_class, criteria={}, config={})
       @model_class = (model_class.is_a?(Symbol) || model_class.is_a?(String))? model_class.to_s.camelize.constantize : model_class
       @table_name = @model_class.table_name
       @criteria = criteria.nil? ? {} : criteria
@@ -92,9 +92,9 @@ module RailsSimpleSearch
   
     def make_joins
       @joins_str = ''
-      @joins = @joins.values
-      @joins.sort! {|a,b| a[0] <=> b[0]}
-      @joins.each do |j|
+      joins = @joins.values
+      joins.sort! {|a,b| a[0] <=> b[0]}
+      joins.each do |j|
         table = j[1]
         constrain = j[2]
         @joins_str << " inner join  #{table} on #{constrain}" 
@@ -102,7 +102,7 @@ module RailsSimpleSearch
     end
   
     def run_criteria
-      return @conditions unless @conditions.nil? 
+      return unless @conditions.nil? 
       @criteria.each do |key, value|
         if @config[:page_name].to_s == key.to_s
           @page = value.to_i
@@ -115,7 +115,30 @@ module RailsSimpleSearch
       make_joins
     end
 
+    def parse_field_name(name)
+      result = {}
+      if name =~ /^(.*)?((_(greater|less)_than)(_or_equal_to)?)$/
+        result[:field_name] = $1
+        if $4 == 'greater'
+          result[:operator] = ">"
+        else
+          result[:operator] = "<"
+        end
+        if $5
+          result[:operator] << "="
+        end
+      else
+        result[:filed_name] = name
+      end
+      result
+    end
+
+
     def insert_condition(base_class, attribute, field, value)
+      name_hash = parse_field_name(field)
+      field = name_hash[:field_name]
+      operator = name_hash[:operator]
+
       table = base_class.table_name
       key = "#{table}.#{field}"
   
@@ -129,6 +152,8 @@ module RailsSimpleSearch
 
       if value.nil?
         verb = 'is'
+      elsif operator
+        verb = operator
       elsif column.text? && ! @config[:exact_match].include?((@table_name == table)? field : key)
         verb = 'like'
         value = "%#{value}%"

metadata

@@ -1,68 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rails-simple-search
-version: !ruby/object:Gem::Version 
-  hash: 51
+version: !ruby/object:Gem::Version
+  version: 0.9.5
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 4
-  version: 0.9.4
 platform: ruby
-authors: 
+authors:
 - Yi Zhang
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-20 00:00:00 -08:00
-default_executable: 
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies: []
-
-description: rails-simple-search is a light and easy to use gem. It could help developers quickly build a search page.
+description: rails-simple-search is a light and easy to use gem. It could help developers
+  quickly build a search page.
 email: yzhang.wa@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- README
+files:
+- README.rdoc
 - lib/rails-simple-search.rb
-has_rdoc: true
 homepage: http://github.com/yzhanginwa/rails-simple-search
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A very simple and light get to quick build search function in rails
 test_files: []
-