simple_search 0.0.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 Ernie Miller
+
+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.rdoc

@@ -0,0 +1,17 @@
+= simple_search
+
+Description goes here.
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2010 Ernie Miller. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simple_search"
+    gem.summary = %Q{Add an easy-to-use search method to your ActiveRecord models}
+    gem.description = %Q{This gem allows your models to be searchable.}
+    gem.email = "ernie@metautonomo.us"
+    gem.homepage = "http://github.com/ernie/simple_search"
+    gem.authors = ["Ernie Miller"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 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(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_search #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/simple_search.rb

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

data/lib/simple_search/search.rb

@@ -0,0 +1,328 @@
+module SimpleSearch
+  class Search
+    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|
+        @model.reflect_on_association(a)
+      end
+      initialize_option_methods
+      # Need to make sure to keep multipart date stuff around
+      dates = dates_from_hash(Hash[*options.select {|k, v| k =~ /\(.*\)$/}.flatten])
+      @options = options.reject{|k, v| !respond_to?(k)}.merge dates
+    end
+
+    def conditions
+      conditions = []
+      parameters = []
+
+      return [] if options.empty?
+
+      @options.keys.select{|k| self.respond_to?("#{k}_conditions".to_sym)}.each do |opt|
+        next if self.send(opt.to_sym).blank?
+        condition = self.send("#{opt}_conditions".to_sym)
+        parameter = self.send("#{opt}_parameters".to_sym)
+        if condition.is_a?(Array)
+          concat = respond_to?("#{opt}_concat".to_sym) ? send("#{opt}_concat".to_sym) : 'OR'
+          condition = '(' + condition.join(" #{concat} ") + ')'
+        end
+        conditions << condition
+        parameters.concat [*parameter]
+      end
+    
+      conditions.blank? ? [] : [conditions.join(" AND "), *parameters]
+    end
+
+    private
+
+    def dates_from_hash(hash)
+      h = {}
+      hash.keys.collect{|k| k.gsub(/\(.*\)/,'')}.uniq.each do |which|
+        part = Proc.new { |n| hash["#{which}(#{n}i)"].to_i }
+        y,m,d = part[1], part[2], part[3]
+        y = Date.today.year if y.zero?
+        if d > Time::days_in_month(m, y)
+          d = Time::days_in_month(m, y)
+        end
+        h[which] = Date.new(y, m, d)
+      end
+      h
+    rescue ArgumentError => e
+      return nil
+    end
+  
+    def initialize_option_methods
+      @model.columns.each do |col|
+        add_methods_for(@model, col)
+      end
+    
+      @association_objects.each do |assoc|
+        assoc.class_name.constantize.columns.each do |col|
+          add_methods_for(assoc.class_name.constantize, col, assoc)
+        end
+      end
+    end
+  
+    def add_methods_for(model, col, association = nil)
+      if model.respond_to?(:lookup_for) && model.lookups.has_key?(col.name)
+        add_lookup_options(col.name, association)
+      else
+        case col.type
+        when :string
+          add_string_options(col.name, association)
+        when :decimal, :integer, :bigint, :float
+          add_numeric_options(col.name, association)
+        when :date, :datetime
+          add_date_options(col.name, association)
+        end
+      end
+    end
+  
+    def add_lookup_options(column_name, association = nil)
+      n = column_name
+      if association
+        model = association.class_name.constantize
+        meth = [association.name.to_s, n].join('_').to_sym
+      else
+        model = @model
+        meth = n.to_sym
+      end
+      l = model.lookup_for(n)
+      t = model.table_name
+      metaclass.instance_eval do
+        [meth, "#{meth}_not".to_sym].each do |m|      
+          define_method(m) do
+            options[m]
+          end
+
+          define_method("#{m}_parameters".to_sym) do
+            options[m]
+          end
+        
+          define_method("#{m}_concat".to_sym) do
+            options["#{m}_concat".to_sym] == 'AND' ? 'AND' : 'OR'
+          end
+        
+          define_method("#{m}_choices".to_sym) do |*filters|
+            filters.flatten!
+            opts = filters.last.is_a?(Hash) ? filters.pop : {}
+          
+            l.sort {|a,b| a[1] <=> b[1]}.map{|a| a[0]}.inject([]) do |ary, key|
+              if filters.blank? ||
+                filters.detect{|f|
+                  f.is_a?(Regexp) ? f.match(key.to_s) : key.to_s == f.to_s
+                }
+                ary << [l[key], key]
+              end
+              ary
+            end
+          end
+        end
+
+        define_method("#{meth}_conditions".to_sym) do
+          cond = []
+          [*options[meth]].each do
+            cond << "FIND_IN_SET(?, #{t}.#{n})"
+          end
+          cond
+        end
+      
+        define_method("#{meth}_not_conditions".to_sym) do
+          cond = []
+          [*options["#{meth}_not".to_sym]].each do
+            cond << "NOT FIND_IN_SET(?, #{t}.#{n})"
+          end
+          cond
+        end
+      end
+    end
+  
+    def add_string_options(column_name, association = nil)
+      n = column_name
+      if association
+        model = association.class_name.constantize
+        meth = [association.name.to_s, n].join('_').to_sym
+      else
+        model = @model
+        meth = n.to_sym
+      end
+      t = model.table_name
+      metaclass.instance_eval do
+        [meth, "#{meth}_exact".to_sym, "#{meth}_not".to_sym, "#{meth}_not_exact".to_sym,
+         "#{meth}_starts_with".to_sym, "#{meth}_not_starts_with".to_sym].each do |m|
+          define_method(m) do
+            options[m]
+          end
+        end
+      
+        [meth, "#{meth}_not".to_sym].each do |m|
+          define_method("#{m}_parameters".to_sym) do
+            '%' + options[m] + '%'
+          end
+        end
+      
+        ["#{meth}_starts_with", "#{meth}_not_starts_with".to_sym].each do |m|
+          define_method("#{m}_parameters".to_sym) do
+            options[m] + '%'
+          end
+        end
+      
+        ["#{meth}_exact".to_sym, "#{meth}_not_exact".to_sym].each do |m|
+          define_method("#{m}_parameters".to_sym) do
+            options[m]
+          end
+        end
+      
+        [meth, "#{meth}_starts_with"].each do |m|
+          define_method("#{m}_conditions".to_sym) do
+            "#{t}.#{n} LIKE ?"
+          end
+        end
+      
+        ["#{meth}_not", "#{meth}_not_starts_with"].each do |m|
+          define_method("#{m}_conditions".to_sym) do
+            "#{t}.#{n} NOT LIKE ?"
+          end
+        end
+
+        define_method("#{meth}_exact_conditions".to_sym) do
+          "#{t}.#{n} = ?"
+        end
+      
+        define_method("#{meth}_not_exact_conditions".to_sym) do
+          "#{t}.#{n} != ?"
+        end
+      end
+    end
+  
+    def add_numeric_options(column_name, association = nil)
+      n = column_name
+      if association
+        model = association.class_name.constantize
+        meth = [association.name.to_s, n].join('_').to_sym
+      else
+        model = @model
+        meth = n.to_sym
+      end
+      t = model.table_name
+      metaclass.instance_eval do
+        [meth, "#{meth}_not".to_sym, "#{meth}_min".to_sym, "#{meth}_max".to_sym].each do |m|
+          define_method(m) do
+            options[m].blank? ? nil : cast_to_numeric(model, n, options[m])
+          end
+        
+          define_method("#{m}_parameters".to_sym) do
+            options[m].blank? ? nil : cast_to_numeric(model, n, options[m])
+          end
+        end
+      
+        define_method("#{meth}_conditions".to_sym) do
+          "#{t}.#{n} = ?"
+        end
+      
+        define_method("#{meth}_not_conditions".to_sym) do
+          "#{t}.#{n} != ?"
+        end
+      
+        define_method("#{meth}_min_conditions".to_sym) do
+          "#{t}.#{n} >= ?"
+        end
+      
+        define_method("#{meth}_max_conditions".to_sym) do
+          "#{t}.#{n} <= ?"
+        end
+      end
+    end
+  
+    def add_date_options(column_name, association = nil)
+      n = column_name
+      if association
+        model = association.class_name.constantize
+        meth = [association.name.to_s, n].join('_').to_sym
+      else
+        model = @model
+        meth = n.to_sym
+      end
+      t = model.table_name
+      metaclass.instance_eval do
+        define_method(meth) do
+          options[meth]
+        end
+      
+        define_method("#{meth}_parameters".to_sym) do
+          case options[meth].class.to_s
+          when 'Date', 'Time'
+            [cast_to_date_or_time(model, n, options[meth], :from).to_s(:db),
+             cast_to_date_or_time(model, n, options[meth], :to).to_s(:db)]
+          when 'String'
+            date_str = options[meth]
+            return nil if date_str.blank?
+            from, to = date_str.split(/\s+to\s+/)
+            Rails.logger.info "from = #{from}, to = #{to}"
+            to ||= from
+            from = cast_to_date_or_time(model, n, from, :from).to_s(:db) rescue nil
+            to = cast_to_date_or_time(model, n, to, :to).to_s(:db) rescue nil
+            from && to ? [from, to] : nil
+          end
+        end
+      
+        define_method("#{meth}_conditions".to_sym) do
+          "#{t}.#{n} BETWEEN ? AND ?"
+        end
+      
+        ["#{meth}_from".to_sym, "#{meth}_to".to_sym].each do |m|
+          define_method(m) do
+            options[m.to_sym]
+          end
+        
+          define_method("#{m}_parameters".to_sym) do
+            m =~ /_from$/ ? 
+              cast_to_date_or_time(model, n, options[m], :from).to_s(:db) :
+              cast_to_date_or_time(model, n, options[m], :to).to_s(:db)
+          end
+        end
+      
+        define_method("#{meth}_from_conditions".to_sym) do
+          "#{t}.#{n} >= ?"
+        end
+      
+        define_method("#{meth}_to_conditions".to_sym) do
+          "#{t}.#{n} <= ?"
+        end
+      end
+    end
+  
+    def cast_to_numeric(model, column_name, num)
+      col = model.columns_hash[column_name.to_s]
+      case col.type
+      when :decimal, :integer, :bigint
+        if col.type != :decimal || col.precision.zero?
+          return num.to_i
+        else
+          return num.to_f
+        end
+      when :float
+        return num.to_f
+      end
+    end
+  
+    def cast_to_date_or_time(model, column_name, date_or_time, endpoint)
+      col = model.columns_hash[column_name.to_s]
+      case col.type
+      when :date
+        date_or_time = date_or_time.is_a?(String) ? Date.parse(date_or_time) : date_or_time.to_date
+      when :datetime
+        date_or_time = date_or_time.is_a?(String) ? Time.parse(date_or_time) : date_or_time.to_time
+        if endpoint == :to
+          date_or_time = date_or_time.end_of_day.in_time_zone
+        else
+          date_or_time.beginning_of_day.in_time_zone
+        end
+      end
+      date_or_time
+    end
+  end
+end

data/lib/simple_search/searchable.rb

@@ -0,0 +1,30 @@
+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

data/simple_search.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_search}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ernie Miller"]
+  s.date = %q{2010-02-24}
+  s.description = %q{This gem allows your models to be searchable.}
+  s.email = %q{ernie@metautonomo.us}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "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"
+  ]
+  s.homepage = %q{http://github.com/ernie/simple_search}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Add an easy-to-use search method to your ActiveRecord models}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_simple_search.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simple_search'
+
+class Test::Unit::TestCase
+end

data/test/test_simple_search.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSimpleSearch < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: simple_search
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Ernie Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-24 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: This gem allows your models to be searchable.
+email: ernie@metautonomo.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- 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
+has_rdoc: true
+homepage: http://github.com/ernie/simple_search
+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: Add an easy-to-use search method to your ActiveRecord models
+test_files: 
+- test/helper.rb
+- test/test_simple_search.rb