rails-simple-search 0.9.0

data/README

@@ -0,0 +1,67 @@
+SimpleSearch
+============
+
+SimpleSearch is a Ruby on Rails plugin. 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
+
+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 SimpleSearch 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
+=======
+
+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 find 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
+
+The following is how we implement this searching function with SimpleSearch :
+
+Code in model (app/model/search.rb):
+
+      class Search < SimpleSearch::Base
+      end
+
+Code in controller:
+
+      @search = Search.new(User, params[:search])
+      @users = @search.run(:order => 'email')
+
+Code in views:
+
+     <% form_for @search do |f| %>
+
+       <%=f.label :email %>
+       <%=f.text_field :email %>
+
+       <%=f.label :state%>
+       <%=f.select "address.state_id", [['AL', 1], ...] %>  <!-- address is an association of model User -->
+
+       <%=f.label :post%>
+       <%=f.text_field "posts.comments.author" %>           <!-- the associations could go even deeper, isn't it POWERFUL? -->
+
+       <%=f.submit %>
+     <% end %>
+
+     <% @users.each do |user| %>
+      <%= # show the attributes of user %>
+     <% end %>
+
+
+Copyright (c) 2012 [Yi Zhang], released under the MIT license

data/lib/rails-simple-search.rb

@@ -0,0 +1,178 @@
+module RailsSimpleSearch
+  DEFAULT_CONFIG = { :exact_match => [], 
+                     :paginate => true, 
+                     :page_name => 'page', 
+                     :offset => 0,
+                     :limit => 1000, 
+                     :per_page => 20
+                   }
+  class Base
+    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
+      sanitize_criteria
+      @config = DEFAULT_CONFIG.merge(config)
+      @joins = {}
+    end
+  
+    def count
+      @count || 0
+    end
+
+    def pages
+      (count == 0)? 0 : (count / @config[:per_page].to_i + 1) 
+    end
+
+    def pages_for_select
+      (1..pages).to_a
+    end
+
+    def add_conditions(h={})
+      @criteria.merge!(h)
+    end
+  
+    def conditions
+      run_criteria
+      @conditions
+    end
+
+    def joins
+      run_criteria
+      @joins_str
+    end
+
+    def run(option={})
+      run_criteria
+      if @config[:paginate]
+        @count = @model_class.count({:select => "distinct #{@model_class.table_name}.#{@model_class.primary_key}", 
+                                     :conditions => @conditions,
+                                     :joins => @joins_str }
+                 )
+        offset = [((@page || 0) - 1) * @config[:per_page], 0].max
+        limit = @config[:per_page]
+      else
+        offset = @config[:offset]
+        limit = @config[:limit]
+      end
+
+      @model_class.all({:select => "distinct #{@model_class.table_name}.*", 
+                        :conditions => @conditions,
+                        :joins => @joins_str, 
+                        :offset => @config[:offset],
+                        :limit => @config[:limit] }.merge(option)
+      )
+    end
+
+    private
+  
+    def method_missing(method, *args)
+      method_str = method.to_s
+      if method_str =~ /^([^=]+)=$/
+        @criteria[$1.to_s] = args[0]
+      else 
+        @criteria[method_str]
+      end
+    end
+  
+    def make_joins
+      @joins_str = ''
+      @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}" 
+      end
+    end
+  
+    def run_criteria
+      return @conditions unless @conditions.nil? 
+      @criteria.each do |key, value|
+        if @config[:page_name].to_s == key.to_s
+          @page = value.to_i
+          @criteria[key] = @page
+        else
+          parse_attribute(key, value)
+        end
+      end
+
+      make_joins
+    end
+
+    def insert_condition(base_class, attribute, field, value)
+      table = base_class.table_name
+      key = "#{table}.#{field}"
+  
+      @conditions ||= []
+      column = base_class.columns_hash[field.to_s]
+
+      if !column.text? && value.is_a?(String)
+        value = column.type_cast(value)
+        @criteria[attribute] = value 
+      end
+
+      if value.nil?
+        verb = 'is'
+      elsif column.text? && ! @config[:exact_match].include?((@table_name == table)? field : key)
+        verb = 'like'
+        value = "%#{value}%"
+      else
+        verb = '='
+      end
+
+      if @conditions.size < 1
+        @conditions[0] = "#{key} #{verb} ?"
+        @conditions[1] = value
+      else
+        @conditions[0] += " and #{key} #{verb} ?"
+        @conditions << value
+      end
+    end     
+  
+    def insert_join(base_class, asso_ref)
+      base_table = base_class.table_name
+      asso_table = asso_ref.klass.table_name
+      
+      @join_count ||= 0
+      unless base_table == asso_table
+        if @joins[asso_table].nil?
+          @join_count += 1
+          if asso_ref.belongs_to?
+            @joins[asso_table] =[@join_count, asso_table, "#{base_table}.#{asso_ref.primary_key_name} = #{asso_table}.#{asso_ref.klass.primary_key}"]
+          else
+            @joins[asso_table] = [@join_count, asso_table, "#{base_table}.#{base_class.primary_key} = #{asso_table}.#{asso_ref.primary_key_name}"]
+          end
+        end
+      end
+    end
+  
+    def parse_attribute(attribute, value)
+      unless attribute =~ /\./
+        field = attribute
+        insert_condition(@model_class, attribute, field, value)
+        return
+      end 
+
+      association_fields = attribute.split(/\./)
+      field = association_fields.pop
+
+      base_class = @model_class
+      while (association_fields.size > 0) 
+        association_fields[0] = base_class.reflect_on_association(association_fields[0].to_sym)
+        insert_join(base_class, association_fields[0])
+        base_class = association_fields.shift.klass
+      end
+
+      insert_condition(base_class, attribute, field, value)
+    end
+  
+    def sanitize_criteria
+      @criteria.keys.each do |key|
+        if @criteria[key].nil? || @criteria[key].blank?
+          @criteria.delete(key)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: rails-simple-search
+version: !ruby/object:Gem::Version 
+  hash: 59
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Yi Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A very simple and light get to quick build search function in rails
+email: yzhang.wa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/rails-simple-search.rb
+has_rdoc: true
+homepage: http://github.com/yzhanginwa/rails-simple-search
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: rails-simple-search is awesome!
+test_files: []
+