activerecord_search 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18917659557593b82d50a5c0fe4eee591a5c8e73
+  data.tar.gz: ea6c900b5e0e77c27948ea2e900cd6a14e6230ce
+SHA512:
+  metadata.gz: e27dd93a4e7198b35965bcbd21e92eb40c9a3a616fdfc5863f153ad4d4b22aa68d09268715b10a4c1e1f65e8401720056ab36837183f19b1c91741ac3c9ebfcd
+  data.tar.gz: c6e1db99ba8ddd9305fb895a7aacb7cedc765b2931cee9f2c59d3ab8d53b3712c8b4136d8228feadb26afe9226d39801f274a63abeb89f4eaa25f70821ceae46

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Amitree
+
+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,29 @@
+activerecord\_search
+====================
+
+This gem extends the ActiveRecord predicate builder to allow writing LIKE/ILIKE queries without writing raw SQL.
+
+Usage
+=====
+
+Add to your Gemfile:
+
+```ruby
+gem 'activerecord_search'
+```
+
+Then you can write queries like this:
+
+```ruby
+users = User.where(name: Search('ji'))
+  # Returns users "Jim" and "Benji"
+users = User.where(name: Search(ends_with: 'ji'))
+  # Returns user "Benji"
+users = User.where(name: Search(starts_with: 'ji'))
+  # Find user "Jim"
+users = User.where(name: Search(like: 'b%i'))
+  # Find users "Benji" and "Banh Mi"
+```
+
+Internally, it uses the Arel `matches` node, which becomes `ILIKE` for Postgres
+and `LIKE` for other databases.  In general, this should be case insensitive.

data/lib/search.rb

@@ -0,0 +1,42 @@
+module Search
+  class Railtie < ::Rails::Railtie
+    initializer "PredicateBuilder" do
+      ActiveRecord::PredicateBuilder.register_handler(Search::Term, ->(attribute, search_term) { search_term.match(attribute) })
+    end
+  end
+
+  class Term
+    def initialize(condition)
+      @pattern = case condition
+      when nil
+        nil
+      when Hash
+        key, value = condition.first if condition.length == 1
+        case key.to_sym
+        when :starts_with
+          "#{value}%"
+        when :ends_with
+          "%#{value}"
+        when :like
+          "#{value}"
+        else
+          raise 'Expected hash to contain exactly one of these keys: "starts_with", "ends_with", or "like"' unless key.in? %i(starts_with ends_with like)
+        end
+      else
+        "%#{condition}%"
+      end
+    end
+
+    def match(attribute)
+      if @pattern.nil?
+        attribute.eq(nil)
+      else
+        attribute.matches(@pattern)
+      end
+    end
+  end
+end
+
+def Search(*args)
+  Search::Term.new(*args)
+end

data/spec/lib/activerecord_search_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+class User < ActiveRecord::Base
+end
+
+describe Search do
+  let(:relation) { ActiveRecord::Relation.new(User, Arel::Table.new('users')) }
+
+  shared_examples_for 'generates the correct query' do |condition, attribute, pattern, expected_arel_class = Arel::Nodes::Matches|
+    let(:arel_nodes) { relation.where(condition).where_values }
+    let(:arel_node) { arel_nodes.first }
+
+    it 'returns a Arel::Nodes::Matches node' do
+      expect(arel_nodes.length).to eq 1
+      expect(arel_node).to be_an expected_arel_class
+    end
+
+    it 'matches on the specified attribute' do
+      expect(arel_node.left.name).to eq attribute
+    end
+
+    it 'uses the right pattern' do
+      expect(arel_node.right).to eq pattern
+    end
+  end
+
+  describe 'searches for substrings' do
+    it_should_behave_like 'generates the correct query', { foo: Search('bar') }, 'foo', '%bar%'
+  end
+
+  describe 'ends_with' do
+    it_should_behave_like 'generates the correct query', { foo: Search(ends_with: 'bar') }, 'foo', '%bar'
+  end
+
+  describe 'starts_with' do
+    it_should_behave_like 'generates the correct query', { foo: Search(ends_with: 'bar') }, 'foo', '%bar'
+  end
+
+  describe 'like' do
+    it_should_behave_like 'generates the correct query', { foo: Search(like: '%foo%bar') }, 'foo', '%foo%bar'
+  end
+
+  describe 'nil values' do
+    it_should_behave_like 'generates the correct query', { foo: Search(nil) }, 'foo', nil, Arel::Nodes::Equality
+  end
+
+  describe 'exceptions' do
+    it 'should raise if an empty hash is passed' do
+      expect { Search({}) }.to raise_error
+    end
+    it 'should raise if multiple hash keys are passed' do
+      expect { Search({starts_with: 'a', ends_with: 'b'}) }.to raise_error
+    end
+    it 'should raise if an invalid hash key is passed' do
+      expect { Search({foo: 'bar'}) }.to raise_error
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rails/all'
+require 'search'
+
+Search::Railtie.run_initializers

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_search
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Tony Novak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta
+description: Extends the ActiveRecord predicate builder to allow writing LIKE/ILIKE
+  queries without writing raw SQL
+email: tony@amitree.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/search.rb
+- spec/lib/activerecord_search_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/activerecord_search
+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.2.1
+signing_key: 
+specification_version: 4
+summary: An easy way to write LIKE / ILIKE queries for Active Record models
+test_files: []