where_lower 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb05183f08ea309e144cdbcffaf26008e4dc7f45
+  data.tar.gz: 30367bed82e96ea4d079b9806b027a8f2bf031b1
+SHA512:
+  metadata.gz: b1f7bc135acc5a1a4833dfd510f0ac870cdc4b84fa63400fc000df6c7a462e08110574bbc7f159e358c1771fa9b00dea0d4eb35e6c788fafc77ef544370bbe50
+  data.tar.gz: 8f0ce99c9dd7ccb2ef814b9f000aeb31105a4f78f1ea51a6d7e9ee2fb1b015461dd5e23cdea63db23e9101fdf586681f192e0810bd4c63009ed333b051b1a9de

data/.gitignore

@@ -0,0 +1,2 @@
+gemfiles/*.gemfile.lock
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+script: "bundle exec rspec"
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - gemfiles/rails3_1.gemfile
+  - gemfiles/rails3_2.gemfile
+  - gemfiles/rails4_0.gemfile
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails4_0.gemfile
+

data/Appraisals

@@ -0,0 +1,15 @@
+
+appraise "rails3-1" do
+  version = "3.1.12"
+  gem 'activerecord', version
+end
+
+appraise "rails3-2" do
+  version = "3.2.13"
+  gem 'activerecord', version
+end
+
+appraise "rails4-0" do
+  version = "4.0.0.beta1"
+  gem 'activerecord', version
+end

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'activerecord'
+gem 'appraisal'
+gem 'rake'
+gem 'sqlite3'
+gem 'rspec'
+gem 'database_cleaner', '>= 1.0.0.RC1' # Need RC1 for Rails 4 support

data/README.md

@@ -0,0 +1,33 @@
+where_lower
+===========
+
+Provide an easy way to use case insensitive `where` in ActiveRecord.
+
+### Support
+===========
+Tested against:
+- Active Record of version `3.1`, `3.2` and `4.0`
+- Ruby `1.9.2`, `1.9.3`, `2.0.0` (except Rails 4 with `1.9.2`)
+
+[![Build Status](https://travis-ci.org/PikachuEXE/where_lower.png?branch=master)](https://travis-ci.org/PikachuEXE/where_lower)
+
+Install
+=======
+
+```ruby
+gem 'where_lower'
+```
+
+Usage
+=====
+Supports `String`, `Array`, `Range`  
+Values in `Array` and `Range` will be converted to `String` and then `downcase`  
+Other types will not be touched
+
+```ruby
+SomeActiveRecordClass.where_lower(attribute1: 'AbC', attribute2: ['stRing', 123, :symBol], attribute3: ('AA'..'AZ'))
+```
+
+Contributors
+============
+[Matthew Rudy Jacobs](https://github.com/matthewrudy) (Who wrote the first version of `where_lower` method)

data/Rakefile

@@ -0,0 +1,11 @@
+require 'appraisal'
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default do
+  sh "rake appraisal:install && rake appraisal spec"
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/gemfiles/rails3_1.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "sqlite3"
+gem "rspec"
+gem "database_cleaner", ">= 1.0.0.RC1"
+gem "activerecord", "3.1.12"
+
+gemspec :path=>"../"

data/gemfiles/rails3_2.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "sqlite3"
+gem "rspec"
+gem "database_cleaner", ">= 1.0.0.RC1"
+gem "activerecord", "3.2.13"
+
+gemspec :path=>"../"

data/gemfiles/rails4_0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "sqlite3"
+gem "rspec"
+gem "database_cleaner", ">= 1.0.0.RC1"
+gem "activerecord", "4.0.0.beta1"
+
+gemspec :path=>"../"

data/lib/where_lower/core.rb

@@ -0,0 +1,41 @@
+module WhereLower
+  module Core
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def where_lower(fields)
+        fields.is_a?(Hash) or raise AugumentError, 'fields is not a Hash'
+
+        scope = self
+        table = self.arel_table
+
+        fields.each do |field_name, value|
+          case value
+          when Range
+            value = Range.new(value.begin.to_s.downcase, value.end.to_s.downcase, value.exclude_end?)
+            scope = scope.where(
+              table[field_name].lower.in(value)
+            )
+          when Array # Assume the content to be string, or can be converted to string
+            value = value.to_a.map {|x| x.to_s.downcase}
+            scope = scope.where(
+              table[field_name].lower.in(value)
+            )
+          when String
+            scope = scope.where(
+              table[field_name].lower.eq(table.lower(value))
+            )
+          else # other single value classes
+            scope = scope.where(
+              table[field_name].eq(value)
+            )
+          end
+        end
+
+        scope
+      end
+    end
+  end
+end

data/lib/where_lower/version.rb

@@ -0,0 +1,3 @@
+module WhereLower
+  VERSION = '0.1.0'.freeze
+end

data/lib/where_lower.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+require 'where_lower/version'
+require 'where_lower/core'
+
+ActiveRecord::Base.send(:include, WhereLower::Core)

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require 'active_record'
+require 'where_lower'
+require 'database_cleaner'
+require 'logger'
+
+# ActiveRecord::Base.logger = Logger.new(STDOUT) # for easier debugging
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end
+
+# connect
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+# create tables
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :parents do |t|
+    t.string :name
+    t.text :description
+    t.integer :age, null: false, default: 21
+    t.boolean :is_minecraft_lover, default: true
+
+    t.timestamps
+  end
+
+  create_table :chirdren do |t|
+    t.string :name
+    t.text :description
+    t.integer :age, null: false, default: 0
+    t.boolean :is_minecraft_lover, default: true
+
+    t.integer :parent_id
+
+    t.timestamps
+  end
+end
+
+class ActiveRecord::Base
+  def self.silent_set_table_name(name)
+    self.table_name = name
+  end
+end
+
+# setup models
+
+class Parent < ActiveRecord::Base
+  has_many :children, inverse_of: :parent
+end
+
+class Child < ActiveRecord::Base
+  belongs_to :parent, inverse_of: :children, touch: true
+end

data/spec/where_lower_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe WhereLower do
+
+  let(:parent_name) { 'Parent #1' }
+  let(:parent_name2) { 'Parent #10' }
+  let(:parent_name3) { 'Parent #20' }
+  let(:parent_description) { 'I need a Medic!' }
+  let(:parent_description2) { 'I need a Pokemon!' }
+
+  let!(:parent) do
+    Parent.create!(name: parent_name, description: parent_description,
+        age: 40, is_minecraft_lover: false, created_at: 1.day.ago)
+  end
+
+  describe 'finding records with condition(s) for columns inside the model table' do
+    describe 'finding record using string column' do
+      describe 'with type string' do
+        before do
+          Parent.where(name: parent_name).should_not be_empty
+          Parent.where(name: parent_name2).should be_empty
+        end
+
+        it 'works like where' do
+          Parent.where_lower(name: parent_name).should_not be_empty
+          Parent.where_lower(name: parent_name2).should be_empty
+        end
+        it 'works like where case insensitively' do
+          Parent.where_lower(name: parent_name.swapcase).should_not be_empty
+          Parent.where_lower(name: parent_name2.swapcase).should be_empty
+        end
+      end
+
+      describe 'with type text' do
+        before do
+          Parent.where(description: parent_description).should_not be_empty
+          Parent.where(description: parent_description2).should be_empty
+        end
+
+        it 'works like where' do
+          Parent.where_lower(description: parent_description).should_not be_empty
+          Parent.where_lower(description: parent_description2).should be_empty
+        end
+        it 'works like where case insensitively' do
+          Parent.where_lower(description: parent_description.swapcase).should_not be_empty
+          Parent.where_lower(description: parent_description2.swapcase).should be_empty
+        end
+      end
+
+      describe 'with different types of values in conditions' do
+        describe 'with Range' do
+          before do
+            Parent.where(name: ('Parens'..'Parenu')).should_not be_empty
+            Parent.where(name: ('Parenu'..'Parenv')).should be_empty
+          end
+
+          it 'works like where' do
+            Parent.where_lower(name: ('Parens'..'Parenu')).should_not be_empty
+            Parent.where_lower(name: ('Parenu'..'Parenv')).should be_empty
+          end
+          it 'works like where case insensitively' do
+            Parent.where_lower(name: (('Parens'.downcase)..('Parenu'.downcase))).should_not be_empty
+            Parent.where_lower(name: (('Parenu'.downcase)..('Parenv'.downcase))).should be_empty
+          end
+        end
+
+        describe 'with Array' do
+          before do
+            Parent.where(name: [parent_name, parent_name2]).should_not be_empty
+            Parent.where(name: [parent_name2, parent_name3]).should be_empty
+          end
+
+          it 'works like where' do
+            Parent.where_lower(name: [parent_name, parent_name2]).should_not be_empty
+            Parent.where_lower(name: [parent_name2, parent_name3]).should be_empty
+          end
+          it 'works like where case insensitively' do
+            Parent.where_lower(name: [parent_name.swapcase, parent_name2.swapcase]).should_not be_empty
+            Parent.where_lower(name: [parent_name2.swapcase, parent_name3.swapcase]).should be_empty
+          end
+        end
+
+        describe 'with nil' do
+          context 'when record with nil value does not exist' do
+            before do
+              Parent.where(name: nil).should be_empty
+            end
+
+            it 'works like where' do
+              Parent.where_lower(name: nil).should be_empty
+            end
+          end
+          context 'when record with nil value does exist' do
+            before do
+              Parent.create!(name: nil)
+            end
+
+            before do
+              Parent.where(name: nil).should_not be_empty
+            end
+
+            it 'works like where' do
+              Parent.where_lower(name: nil).should_not be_empty
+            end
+          end
+        end
+
+        describe 'with query injection' do
+          it 'prevents injection' do
+            expect do
+              Parent.where_lower(name: "'); truncate table parents")
+            end.to_not change(Parent, :count)
+          end
+        end
+      end
+    end
+
+    describe 'finding record using non string columns' do
+      describe 'with type integer' do
+        before do
+          Parent.where(age: 40).should_not be_empty
+          Parent.where(age: 41).should be_empty
+        end
+
+        it 'works like where' do
+          Parent.where_lower(age: 40).should_not be_empty
+          Parent.where_lower(age: 41).should be_empty
+        end
+      end
+
+      describe 'with type boolean' do
+        before do
+          Parent.where(is_minecraft_lover: false).should_not be_empty
+          Parent.where(is_minecraft_lover: true).should be_empty
+        end
+
+        it 'works like where' do
+          Parent.where_lower(is_minecraft_lover: false).should_not be_empty
+          Parent.where_lower(is_minecraft_lover: true).should be_empty
+        end
+      end
+    end
+  end
+end

data/where_lower.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+author_name = 'PikachuEXE'
+gem_name = 'where_lower'
+
+require "#{gem_name}/version"
+
+Gem::Specification.new do |s|
+  s.platform      = Gem::Platform::RUBY
+  s.name          = gem_name
+  s.version       = WhereLower::VERSION
+  s.summary       = 'Provide an easy way to use case insensitive `where` in ActiveRecord.'
+  s.description   = 'ActiveRecord provides no method for case insensitive version of `where` method. So here is one. No longer need to use SQL fragment yeah!'
+
+  s.license       = 'MIT'
+
+  s.authors       = [author_name]
+  s.email         = ['pikachuexe@gmail.com']
+  s.homepage      = "http://github.com/#{author_name}/#{gem_name}"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activerecord', '>= 3.1.0', '< 5.0.0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'database_cleaner', '>= 1.0.0.RC1'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: where_lower
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PikachuEXE
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.RC1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.RC1
+description: ActiveRecord provides no method for case insensitive version of `where`
+  method. So here is one. No longer need to use SQL fragment yeah!
+email:
+- pikachuexe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Appraisals
+- Gemfile
+- README.md
+- Rakefile
+- gemfiles/rails3_1.gemfile
+- gemfiles/rails3_2.gemfile
+- gemfiles/rails4_0.gemfile
+- lib/where_lower.rb
+- lib/where_lower/core.rb
+- lib/where_lower/version.rb
+- spec/spec_helper.rb
+- spec/where_lower_spec.rb
+- where_lower.gemspec
+homepage: http://github.com/PikachuEXE/where_lower
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Provide an easy way to use case insensitive `where` in ActiveRecord.
+test_files:
+- spec/spec_helper.rb
+- spec/where_lower_spec.rb