simple_search_like 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nate Wiger
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+Simple Search - Easy ActiveRecord searching with hashes
+=======================================================
+
+There is a newer project, scoped_search, which I would recommend instead.  This exists for backwards compatibility.
+See: [Scoped Search](http://techblog.floorplanner.com/2008/07/26/easy-search-with-activerecord/)
+
+This gem is incompatible with the "simple_search" gem.
+
+Example
+-------
+
+    require 'simple_search'
+    
+    class User < ActiveRecord::Base
+    end
+
+    User.simple_search(:name => 'bob')
+    User.simple_search_like('bob', [:name, :description])
+
+Author
+------
+Copyright (c) 2010 [Nate Wiger](http://nateware.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simple_search_like"
+    gem.summary = %Q{Simple hash-based search for ActiveRecord}
+    gem.description = %Q{Simple hash-based search for ActiveRecord.  Also see Scoped Search.}
+    gem.email = "nate@wiger.org"
+    gem.homepage = "http://github.com/nateware/simple_search_like"
+    gem.authors = ["Nate Wiger"]
+    gem.add_dependency 'will_paginate'
+    gem.add_development_dependency "bacon", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |spec|
+    spec.libs << 'spec'
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_search_like #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/simple_search.rb

@@ -0,0 +1,167 @@
+module SimpleSearch
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    # Player.simple_search(:filters => {:name => "nwiger"}, :order => 'id')
+    # Player.simple_search(params, :order => 'id')
+    def simple_search(options={}, extras=nil)
+      options.merge!(extras) if extras
+      paginate_args = simple_search_conditions(options)
+
+      # retrieve total_count to pass total_entries to paginate
+      use_table_name = options[:from] ? options[:from] : table_name
+      if paginate_args[:conditions].nil?
+        total_count = count(:select => "#{use_table_name}.id",
+                            :from => use_table_name)
+      else
+        total_count = count(:select => "#{use_table_name}.id",
+                            :from => use_table_name,
+                            :conditions => paginate_args[:conditions], 
+                            :joins => paginate_args[:joins], 
+                            :include => paginate_args[:include])
+      end
+
+      unless paginate_args[:total_entries]
+        paginate_args[:per_page] = options[:per_page]
+        paginate_args[:total_entries] = total_count
+      end
+
+      # bounds check total_entries
+      if paginate_args[:total_entries] > total_count
+        paginate_args[:total_entries] = total_count
+      end
+    
+      if options[:use_index]
+        paginate_args[:from] = "#{use_table_name} USE INDEX (#{options[:use_index]})"
+      end
+    
+      paginate(paginate_args)
+    end
+
+    # clean params to prevent SQL injection
+    # added default sort_column (id) since if this parameter is not present in the options hash
+    # it will generate invalid SQL. If the ORDER BY does not specify a column in the SQL the db will generate:
+    # ORA-00936: missing expression:
+    def simple_search_conditions(options={}, extras=nil)
+      options.merge!(extras) if extras
+      paginate_args = {}
+
+      # figure out what table name to use to prefix column names with
+      # WOW, ActiveRecord does not properly figure out the table name to use properly in two different cases.
+      # 1. Count from a db view counts from the original table name set in 'table_name' when using :from option
+      # 2. Find does not prefix the column names correctly when selecting from a db view using the :from option.
+      #    Example: SELECT * FROM v_my_table where id = 10 
+      #             will actually result in
+      #             SELECT * FROM v_my_table where my_table.id = 10    
+      # So appears ActiveRecord does not properly prefix the table_name for columns in where conditions when using the :from option properly in all cases    
+      use_table_name = options[:from] ? options[:from] : table_name
+
+      if !options[:sort_column].nil?
+        paginate_args[:order] = options[:sort_column].to_s.gsub(/\W+/,'')
+      else
+        paginate_args[:order] = options[:order].nil? ? "#{use_table_name}.id" : options[:order]   # allow :order to be passed explicitly
+      end
+
+      if !options[:sort_order].nil?
+        paginate_args[:order] += ' ' + options[:sort_order].to_s.gsub(/\W+/,'')
+      end
+
+      # extreme sanity checking
+      paginate_args[:page] = (options[:page] || 1).to_i
+      if paginate_args[:page].nil? or paginate_args[:page] == '' or paginate_args[:page] < 1
+        raise "Invalid page '#{paginate_args[:page]}' for #{self.name}.search"
+      end
+
+      # default per_page to something sane if unset
+      options[:per_page] = (options[:per_page] || 10).to_i
+    
+      # delete filter options that are blank or nil
+      if !options[:filters].nil?
+        options[:filters] = options[:filters].delete_if {|k,v| v.nil? || v == ''}
+
+        if options[:conditions].is_a? Array
+          conditions = options[:conditions].shift
+          bind_vals  = options[:conditions]
+        else
+          conditions = ''
+          bind_vals  = []
+        end
+              
+        options[:filters].each do |filter, value|
+          conditions += ' AND ' unless bind_vals.empty?
+
+          # append the proper table name to the column name in where conditions 
+          # for handling db views when using the :from option
+          if value.is_a? Array # if value passed in an Array using IN instead of = (equal)
+            conditions += "#{use_table_name}.#{filter} IN (?)"
+          # Need a way to do greater than or less than with dates, so going to follow the convention
+          # assume if the name follows the _at ('created_at') it is a date and you want to do a diff conditional check
+          elsif /_at$/ =~ filter
+            conditions += "#{use_table_name}.#{filter} > ?"
+          else
+            conditions += "#{use_table_name}.#{filter} = ?"
+          end        
+
+          bind_vals << value
+        end
+                  
+         paginate_args[:conditions] = [conditions, *bind_vals]      
+      elsif !options[:conditions].nil?
+        paginate_args[:conditions] = options[:conditions]
+      end
+
+      if !options[:joins].nil?
+        paginate_args[:joins] = options[:joins]
+      end
+
+      if !options[:include].nil?
+        paginate_args[:include] = options[:include]
+      end
+
+      if !options[:from].nil?
+        paginate_args[:from] = options[:from]
+      end
+
+      if !options[:select].nil?
+        paginate_args[:select] = options[:select]
+      end
+    
+      # :limit is two places due to a will_paginate workaround - see also simple_search itself
+      if !options[:limit].nil?
+        if options[:limit] < options[:per_page]
+          paginate_args[:per_page] = options[:limit]
+          paginate_args[:total_entries] = options[:limit]
+        else
+          paginate_args[:per_page] = options[:per_page]
+          paginate_args[:total_entries] = options[:limit]
+        end
+      end
+
+      paginate_args
+    end
+
+    def simple_search_like(options={}, search_columns_in=%w(name))
+      # Accept single column name as a string, or an array of strings with multiple column names
+      search_columns = search_columns_in.is_a?(String) ? [ search_columns_in ] : search_columns_in
+      # Make sure the programmer got his act together
+      if look = options[:search] and look != ''
+        look = '' if look =~ /^\s*search\s*/i
+        text = '%'+ look.downcase.gsub(/[\'\;]/,'') +'%'
+
+        stmt, bind = [], []
+        search_columns.each do |el|
+          stmt << "lower(#{el}) like ?"
+          bind << text
+        end
+        simple_search(options.merge(:conditions => ['(' + stmt.join(' OR ') + ')', *bind]))
+      else
+        # passthru
+        simple_search(options)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend SimpleSearch::ClassMethods if defined?(ActiveRecord::Base)

data/spec/simple_search_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path 'spec_helper', File.dirname(__FILE__)
+
+class User < ActiveRecord::Base
+end
+
+describe "SimpleSearch" do
+  it "should add search methods to ActiveRecord::Base" do
+    User.respond_to?(:simple_search).should.be.true
+    User.respond_to?(:simple_search_like).should.be.true
+    User.respond_to?(:simple_search_conditions).should.be.true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bacon'
+
+$LOAD_PATH.unshift(File.expand_path File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.expand_path File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'active_record'
+require 'simple_search'
+
+Bacon.summary_on_exit

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: simple_search_like
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nate Wiger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: will_paginate
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Simple hash-based search for ActiveRecord.  Also see Scoped Search.
+email: nate@wiger.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/simple_search.rb
+- spec/simple_search_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nateware/simple_search_like
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple hash-based search for ActiveRecord
+test_files: 
+- spec/simple_search_spec.rb
+- spec/spec_helper.rb