ruby_simple_search 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59d86037e8eb49bbae2c3be8a4b0f55176ba87d4
+  data.tar.gz: 408a98859b92881a23bd375d118006929a905adf
+SHA512:
+  metadata.gz: bd03396c4c5b6cbd0f90ad3e0edd9ec9c5c99f34cce9653e8396c3efc03631ab3a000c82e4746f03c9245b0428502c268a7fe5fabc747ad52172addfcb69f408
+  data.tar.gz: 7fbc374a919f6141f3186da99d1083faa3c4749365bcf65ce94a487537719d3c20dd6a256bbc33811a4a883b1dde39fda020dc925c0664f921b724f94b2f7a45

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+tags
+

data/README.md

@@ -3,8 +3,8 @@
 RubySimpleSearch allows you to search on the table fields (string and text fields)
 very easily.
 
-Mostly on the admin side, we do have a common text field to search the table
-column's data.
+Mostly on the admin side, we do have a common text field to search the data on the
+table.
 
 Sometimes we want to do a search on the title, content and ratings on the post model or
 email, username and description on the user model. For those searches we use MySQL's
@@ -13,27 +13,33 @@ on the different models you actually add lots of duplication in your code.
 
 To avoid duplicating the same code, use RubySimpleSearch :)
 
+#### Version 0.0.3 changes:
+- 'LIKE' pattern is more flexible now. Now you can pass pattern on ```simple_search```
+  method directly. Pattern support on the ```simple_search_attributes``` method has been removed
+- Fixed column ambiguous error when used with the joins
+
+
 #### RubySimpleSearch Features:
-- Added like pattern support ('beginning', 'ending', 'containing', 'underscore', 'plain').
+- Added 'LIKE' pattern support ('beginning', 'ending', 'containing', 'underscore', 'plain').
   By default pattern is 'containing'
 
 ```Ruby
-    simple_search_attributes :name, :address, :pattern => :ending
+    Post.simple_search('york', :pattern => :ending)
     # It will search like '%york'
 
-    simple_search_attributes :name, :address, :pattern => :begining
+    Post.simple_search('york', :pattern => :begining)
     # It will search like 'york%'
 
-    simple_search_attributes :name, :address, :pattern => :containing
+    Post.simple_search('york', :pattern => :containing)
     # It will search like '%york%'
 
-    simple_search_attributes :name, :address, :pattern => :underscore
+    Post.simple_search('o', :pattern => :underscore)
     # It will search like '_o_'
 
-    simple_search_attributes :name, :address, :pattern => :plain
+    Post.simple_search('yourk', :pattern => :plain)
     # It will search like 'york'
 ```
-- Added **block** support to simple_search method, so user can extend the query as per
+- Added **block** support to ```simple_search``` method, so user can extend the query as per
   his/her requirements (Now you can operate on the integer/decimal values also)
 
 - Added specs
@@ -62,7 +68,7 @@ Define attributes that you want to search through RubySimpleSearch
 class Post < ActiveActiveRecord::Base
   include RubySimpleSearch
 
-  simple_search_attributes :title, :description, :pattern => :begining
+  simple_search_attributes :title, :description
 end
 ```
 ```Ruby
@@ -72,11 +78,11 @@ class User < ActiveActiveRecord::Base
   simple_search_attributes :email, :username, :address
 end
 ```
-While defining simple_search_attributes, don't add integer/decimal data
+While defining ```simple_search_attributes```, don't add integer/decimal data
 attributes to it, instead of this you can do integer/decimal operation
-by passing block to simple search method
+by passing block to ```simple_search``` method
 ```Ruby
-Post.simple_search('tuto')
+Post.simple_search('tuto', :pattern => :begining)
 # => posts which have 'tuto%' text in the title or in the description fields
 ```
 ```Ruby

data/lib/ruby_simple_search/errors.rb

@@ -1,10 +1,11 @@
 require "ruby_simple_search/errors"
 
 module RubySimpleSearch
-  module Error
+  module Errors
     ATTRIBUTES_MISSING     = "Simple search attributes are missing"
     INVALID_TYPE           = "Extended query is not an array type"
     INVALID_CONDITION      = "Extended query's array conditions are wrong"
     INVALID_PATTERN        = "Pattern is wrong. it should be in the list #{RubySimpleSearch::LIKE_PATTERNS.keys}"
+    WROG_ATTRIBUTES        = "simple_search_arguments method's arguments should be in symbol format"
   end
 end

data/lib/ruby_simple_search/version.rb

@@ -1,3 +1,3 @@
 module RubySimpleSearch
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/ruby_simple_search.rb

@@ -10,23 +10,19 @@ module RubySimpleSearch
     class_eval do
       def self.simple_search_attributes(*args)
         @simple_search_attributes = []
-        # default pattern is '%q%'
-        @simple_search_pattern = RubySimpleSearch::LIKE_PATTERNS[:containing]
         args.each do |arg|
-          if !arg.is_a?(Hash)
-            @simple_search_attributes << arg
-          else
-           set_pattern(arg[:pattern]) if arg[:pattern].present?
-          end
+          raise ArgumentError, RubySimpleSearch::Errors::WROG_ATTRIBUTES unless arg.is_a? Symbol
+          @simple_search_attributes << arg
         end
       end
     end
   end
 
   module ClassMethods
-    def simple_search(search_term, &block)
-      raise RubySimpleSearch::Error::ATTRIBUTES_MISSING if @simple_search_attributes.blank?
+    def simple_search(search_term, options={}, &block)
+      raise RubySimpleSearch::Errors::ATTRIBUTES_MISSING if @simple_search_attributes.blank?
       raise ArgumentError, "Argument is not string" unless search_term.is_a? String
+      set_pattern(options[:pattern])
 
       sql_query = nil
       extended_query = nil
@@ -52,24 +48,29 @@ module RubySimpleSearch
       end
       sql_query = [sql_query_condition, sql_query_values]
 
-      where(sql_query.try(:flatten))
+      where(sql_query.flatten)
     end
 
     private
 
     def set_pattern(pattern)
-      pattern = RubySimpleSearch::LIKE_PATTERNS[pattern.to_sym] rescue nil
-      raise RubySimpleSearch::Error::INVALID_PATTERN if pattern.nil?
-      @simple_search_pattern = pattern
+      if pattern.nil?
+        # default pattern is '%q%'
+        @simple_search_pattern = RubySimpleSearch::LIKE_PATTERNS[:containing]
+      else
+        pattern = RubySimpleSearch::LIKE_PATTERNS[pattern.to_sym]
+        raise RubySimpleSearch::Errors::INVALID_PATTERN if pattern.nil?
+        @simple_search_pattern = pattern
+      end
     end
 
     def extend_simple_search(extended_query, sql_query_condition, sql_query_values)
-      raise RubySimpleSearch::Error::INVALID_TYPE unless extended_query.is_a?(Array)
+      raise RubySimpleSearch::Errors::INVALID_TYPE unless extended_query.is_a?(Array)
       extended_query_condition = extended_query[0]
       extended_query_values = extended_query - [extended_query[0]]
 
       if extended_query_condition.count('?') != (extended_query_values.size)
-        raise RubySimpleSearch::Error::INVALID_CONDITION
+        raise RubySimpleSearch::Errors::INVALID_CONDITION
       end
 
       sql_query_condition = [sql_query_condition, extended_query_condition].join(' ')
@@ -79,8 +80,8 @@ module RubySimpleSearch
     end
 
     def set_sql_query_condition(attr, sql_query_condition)
-      return "LOWER(#{attr.to_s}) LIKE ?" if sql_query_condition.blank?
-      " OR LOWER(#{attr.to_s}) LIKE ?"
+      return "LOWER(#{self.table_name}.#{attr.to_s}) LIKE ?" if sql_query_condition.blank?
+      " OR LOWER(#{self.table_name}.#{attr.to_s}) LIKE ?"
     end
 
   end

data/ruby_simple_search.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "activerecord",  ">= 3.0.0"
   gem.add_dependency "sqlite3"
   gem.add_development_dependency "rspec"
+  gem.required_ruby_version = ">= 1.9.2"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/user_spec.rb

@@ -2,56 +2,59 @@ require 'spec_helper'
 require_relative "../spec/lib/user.rb"
 require_relative "../spec/lib/user2.rb"
 
-describe User do
-
+describe 'User'  do
   describe ".simple_search_attributes" do
-
-    it "returns an exception if simple_search_attributes is not called while loading the model" do
-      expect { User2.simple_search('usa') }.to raise_error(RubySimpleSearch::Error::ATTRIBUTES_MISSING)
-    end
-
-    it "sets simple_search_attributes" do
-      User2.simple_search_attributes :name, :contact
-      expect(User2.instance_variable_get("@simple_search_attributes")).to eq([:name, :contact])
-    end
-
-    it "has default pattern" do
-      User2.simple_search_attributes :name, :contact
-      expect(User2.instance_variable_get("@simple_search_pattern")).to eq('%q%')
-    end
-
-    it "can have patterns like plain, beginning, ending, containing and underscore" do
-      User2.simple_search_attributes :name, :contact, :pattern => :plain
-      expect(User2.instance_variable_get("@simple_search_pattern")).to eq('q')
-      User2.simple_search_attributes :name, :contact, :pattern => :beginning
-      expect(User2.instance_variable_get("@simple_search_pattern")).to eq('q%')
-      User2.simple_search_attributes :name, :contact, :pattern => :ending
-      expect(User2.instance_variable_get("@simple_search_pattern")).to eq('%q')
-      User2.simple_search_attributes :name, :contact, :pattern => :containing
-      expect(User2.instance_variable_get("@simple_search_pattern")).to eq('%q%')
-      User2.simple_search_attributes :name, :contact, :pattern => :underscore
-      expect(User2.instance_variable_get("@simple_search_pattern")).to eq('_q_')
+    it "sets attributes" do
+      expect(User.instance_variable_get("@simple_search_attributes")).to eq([:name, :email, :contact, :address])
     end
 
-    it "should raise an exception if pattern is wrong" do
-      expect{ User2.simple_search_attributes :name, :pattern => 'wrong' }.to raise_error(RubySimpleSearch::Error::INVALID_PATTERN)
+    it "does not return an exception if simple_search_attributes is not called while loading the model" do
+      expect { User.simple_search('usa') }.to_not raise_error(RubySimpleSearch::Errors::ATTRIBUTES_MISSING)
     end
   end
 
   describe ".simple_search" do
-    context "Simple" do
-      it "searches users whose name are 'alice'" do
+    context "without block" do
+      it "searches users whose names are 'alice'" do
         user = User.find_by_name('alice')
         users = User.simple_search('alice')
         users.should include(user)
       end
 
+      it "has default 'LIKE' pattern" do
+        User.find_by_name('alice')
+        expect(User.instance_variable_get("@simple_search_pattern")).to eq('%q%')
+      end
+
+      it "can have 'LIKE' patterns like plain, beginning, ending, containing and underscore" do
+        User.simple_search('alice', pattern: :plain)
+        expect(User.instance_variable_get("@simple_search_pattern")).to eq('q')
+        User.simple_search('al', pattern: :beginning)
+        expect(User.instance_variable_get("@simple_search_pattern")).to eq('q%')
+        User.simple_search('alice', pattern: :ending)
+        expect(User.instance_variable_get("@simple_search_pattern")).to eq('%q')
+        User.simple_search('alice', pattern: :containing)
+        expect(User.instance_variable_get("@simple_search_pattern")).to eq('%q%')
+        User.simple_search('alice', pattern: :underscore)
+        expect(User.instance_variable_get("@simple_search_pattern")).to eq('_q_')
+      end
+
+      it "raises an exception if pattern is wrong" do
+        expect{ User.simple_search('alice', pattern: 'wrong') }.to raise_error(RubySimpleSearch::Errors::INVALID_PATTERN)
+      end
+
+      it "searches users whose names are 'alice' with beginning pattern" do
+        user = User.find_by_name('alice')
+        users = User.simple_search('al', { pattern: :beginning })
+        users.should include(user)
+      end
+
       it "returns empty records if contact number does not exist" do
         users = User.simple_search('343434')
         users.should be_empty
       end
 
-      it "searches user records if user belongs to 'USA'" do
+      it "searches user records if users belong to 'USA'" do
         users = User.where(:address => 'usa')
         searched_users = User.simple_search('usa')
         expect(users.to_a).to eq(searched_users.to_a)
@@ -59,54 +62,71 @@ describe User do
 
       it "searches the records with beginning pattern" do
         users = User.where("name like ?", 'bo%')
-        User.simple_search_attributes :name, :contact, :address, :pattern => :beginning
-        searched_users = User.simple_search('bo')
+        User.simple_search_attributes :name, :contact, :address
+        searched_users = User.simple_search('bo', pattern: :beginning)
         expect(users.count).to eq(searched_users.count)
       end
 
       it "searches the records with ending pattern" do
         users = User.where("name like ?", '%ce')
-        User.simple_search_attributes :name, :contact, :address, :pattern => :ending
-        searched_users = User.simple_search('ce')
+        User.simple_search_attributes :name, :contact, :address
+        searched_users = User.simple_search('ce', pattern: :ending)
         expect(users.count).to eq(searched_users.count)
       end
 
       it "searches the records with underscore pattern" do
         users = User.where("name like ?", 'ce')
-        User.simple_search_attributes :name, :contact, :address, :pattern => :underscore
-        searched_users = User.simple_search('ce')
+        User.simple_search_attributes :name, :contact, :address
+        searched_users = User.simple_search('ce', pattern: :underscore)
         expect(users.count).to eq(searched_users.count)
       end
 
       it "searches the records with plain pattern" do
         users = User.where("name like ?", 'bob')
-        User.simple_search_attributes :name, :contact, :address, :pattern => :plain
-        searched_users = User.simple_search('bob')
+        User.simple_search_attributes :name, :contact, :address
+        searched_users = User.simple_search('bob', pattern: :plain)
         expect(users.count).to eq(searched_users.count)
       end
     end
 
-    context "Extendable" do
-      it "returns users who live in usa and their age shoule be greater than 50" do
-        User.simple_search_attributes :name, :contact, :address, :pattern => :plain
+    context "with block" do
+      it "returns users who live in usa and their age should be greater than 50" do
+        User.simple_search_attributes :name, :contact, :address
         users = User.where(:age => 60)
-        searched_users = User.simple_search('usa') do |search_term|
+        searched_users = User.simple_search('usa', pattern: :plain) do |search_term|
           ['AND age > ?', 50]
         end
         expect(users.to_a).to eq(searched_users.to_a)
       end
 
-      it "returns exception if array condition is wrong in simple_search block" do
+      it "returns an exception if array condition is wrong in simple_search block" do
         expect{ User.simple_search('usa') do |search_term|
           ['AND age > ?', 50, 60]
-        end }.to raise_error(RubySimpleSearch::Error::INVALID_CONDITION)
+        end }.to raise_error(RubySimpleSearch::Errors::INVALID_CONDITION)
       end
 
-      it "returns exception if return value is not an array type" do
+      it "returns an exception if return value is not an array type" do
         expect{ User.simple_search('usa') do |search_term|
           "Wrong return"
-        end }.to raise_error(RubySimpleSearch::Error::INVALID_TYPE)
+        end }.to raise_error(RubySimpleSearch::Errors::INVALID_TYPE)
       end
     end
   end
 end
+
+describe User2 do
+  describe ".simple_search_attributes" do
+    it "returns an exception if simple_search_attributes method is not called while loading the model" do
+      expect { User2.simple_search('usa') }.to raise_error(RubySimpleSearch::Errors::ATTRIBUTES_MISSING)
+    end
+
+    it "returns an exception if simple_search_attributes method has wrong attribute type" do
+      expect { User2.simple_search_attributes :name, '24' }.to raise_error(RubySimpleSearch::Errors::WROG_ATTRIBUTES)
+    end
+
+    it "sets attributes if simple_search_attributes method is called on the model" do
+      User2.simple_search_attributes :name, :contact
+      expect(User2.instance_variable_get("@simple_search_attributes")).to eq([:name, :contact])
+    end
+  end
+end

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: ruby_simple_search
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Santosh Wadghule
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: It will search on the attributes that you provided to simple_search_attributes
@@ -83,8 +74,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -100,27 +91,26 @@ files:
 - spec/user_spec.rb
 homepage: https://github.com/mechanicles/ruby_simple_search
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby simple search for ActiveRecord
 test_files:
 - spec/lib/user.rb