barely_searchable 0.0.1 → 1.0.0

data/README.md

@@ -10,7 +10,7 @@ It is a terrible and slow search engine....but it'll probably work for a handful
 
 Add this line to your application's Gemfile: `gem 'barely_searchable'`
 
-## Usage
+## Quickstart
 
 In your model:
 
@@ -29,6 +29,25 @@ Now elsewhere in your application:
   end
 ```
 
+## More details:
+
+In your models, you can specify conditions on the search parameters to exclude them from searches.  This is useful for search query optimization or selective searches.
+
+```
+class Order < ActiveRecord::Base
+  #search these columns always
+  searches_on :user_id, :shipping_city
+
+  # Will only search these columns when the type-casted value isn't zero
+  searches_on :subtotal, :tax, :total, unless: Proc.new{|value| value == 0}
+
+  # Only search this column if the query is longer thahn 3 characters
+  searches_on :email, if: Proc.new{|value| value.length > 3}
+end
+```
+
+Search content is cast to the column data type before calling if/unless blocks.
+
 ## Contributing
 
 1. Fork it

data/lib/barely_searchable/model_injections.rb

@@ -1,35 +1,56 @@
-require 'ruby-debug'
-
 module BarelySearchable
   module ModelInjections
 
     module ClassMethods
-      def searches_on *fields
+      def searches_on *fields, conditions
+        if conditions.kind_of? Symbol
+          fields.push conditions
+          conditions = {}
+        end
+
+        conditions = {} if conditions.nil?
+
         if @searches.nil?
           init_searches_on
         end
 
-        @searches << fields
-        @searches.flatten!
+        fields.map! {|field| [field, conditions]}
+        @searches.push *fields
       end
 
       def init_searches_on
         @searches = []
       end
 
+      def searches
+        @searches
+      end
+
       def search query, limit = nil
         where = '0'
-        like = '%' + query.to_s.gsub(' ','%') + '%'
 
-        @searches.each do |field|
-          field = field.to_s
+        @searches.each do |search_field|
+          field = search_field[0].to_s
+          hash = search_field[1]
+
+          #check to make sure the field actually exists on the table
           unless self.columns_hash.include? field
             raise NameError, "#{field} is not a valid column on #{self}"
           end
 
-          if [:integer, :decimal, :float].include? self.columns_hash[ field.to_s ].type
-            where += ' or ' + self.arel_table[field].eq( query ).to_sql
+          #cast the query to the right data type for this column
+          col_query = cast_to_column(query, field)
+
+          #check for an if-condition
+          next if ! hash[:if].nil? && ! hash[:if].call(col_query)
+
+          #check for an unless condition
+          next if ! hash[:unless].nil? && hash[:unless].call(col_query)
+
+          if equality_columns.include? column_to_type(field)
+            where += ' or ' + self.arel_table[field].eq( col_query ).to_sql
           else
+            like = '%' + col_query.to_s.gsub(' ','%') + '%'
             where += ' or ' + self.arel_table[field].matches( like ).to_sql
           end
         end
@@ -41,6 +62,32 @@ module BarelySearchable
         end
 
       end
+
+      private
+
+      def cast_to_column data, column
+        case column_to_type(column)
+        when :decimal, :float
+          data.to_f
+        when :integer
+          data.to_i
+        when :string, :text, :binary, :date, :datetime, :time, :timestamp
+          data.to_s
+        when :boolean
+          !!data
+        else
+          data
+        end
+      end
+
+      def column_to_type column
+        self.columns_hash[ column ].type
+      end
+
+      def equality_columns
+        [:integer, :decimal, :float, :boolean]
+      end
+
     end
 
     def self.included to

data/lib/barely_searchable/railtie.rb

@@ -1,5 +1,3 @@
-require 'ruby-debug'
-
 module BarelySearchable
   class Railtie < Rails::Railtie
     config.to_prepare do

data/lib/barely_searchable/version.rb

@@ -1,3 +1,3 @@
 module BarelySearchable
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,33 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: barely_searchable
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Robert L. Carpenter
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-10 00:00:00 -07:00
-default_executable: 
+date: 2012-09-25 00:00:00.000000000 Z
 dependencies: []
-
 description: Adds a very rudimentary .search() function to your activerecord models
-email: 
+email:
 - codemonkey@robacarp.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -38,35 +28,29 @@ files:
 - lib/barely_searchable/model_injections.rb
 - lib/barely_searchable/railtie.rb
 - lib/barely_searchable/version.rb
-has_rdoc: true
 homepage: https://github.com/robacarp/barely_searchable
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
-summary: Add quick and dirty search functionality to your model layer without any indexing service
+summary: Add quick and dirty search functionality to your model layer without any
+  indexing service
 test_files: []
-