activerecord-like 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '>= 4.0.0'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 René van den Berg
+
+MIT License
+
+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,38 @@
+# ActiveRecord::Like
+
+An Active Record Plugin that allows chaining a more DSL-style 'like' or 'not-like' query to an ActiveRecord::Base#where. Requires Rails 4 beta or higher.
+
+This plugin has been salvaged from the stellar work done by @amatsuda and @claudiob. Most of the code was previously in Active Record master, but was subsequently removed due to, amongst other, scope creep.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-like'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-like
+
+## Usage
+
+Given a class Post and the WhereChain work in Active Record, this plugin allows code like:
+
+    Post.where.like(title: "%rails%")
+
+and
+
+    Post.where.not_like(title: "%rails%")
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Make sure the tests run. I will not merge commits that change code without testing the new code.
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ["test"]
+  t.pattern = "test/**/*_test.rb"
+
+  # also warn about bad practices and such
+  t.ruby_opts = ['-w']
+end
+
+task :default => :test

data/activerecord-like.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/active_record/like/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "activerecord-like"
+  gem.version       = ActiveRecord::Like::VERSION
+  gem.authors       = ["René van den Berg"]
+  gem.email         = ["rene.vandenberg@ogd.nl"]
+  gem.description   = %q{An ActiveRecord plugin providing a higher-level abstraction for SQL 'LIKE' queries}
+  gem.summary       = %q{ActiveRecord::Like provides ActiveRecord::Base with where.like(attribute: string)-style extensions. This functionality was, at one point, included in Rails-master, but subsequently removed. Since the feature seemed to be in some demand, I thought I'd try my hand at building an ActiveRecord plugin}
+  gem.homepage      = "http://github.com/ReneB/activerecord-like"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "minitest",     ">= 3"
+  gem.add_development_dependency "sqlite3",      "~> 1.3"
+
+  gem.add_dependency             "activerecord", ">= 4.0.0"
+end

data/lib/active_record/like.rb

@@ -0,0 +1,25 @@
+require "active_record"
+
+module ActiveRecord
+  module QueryMethods
+    module Like
+      def like(opts, *rest)
+        @scope.tap do |s|
+          s.where_values += s.send(:build_where, opts, *rest).map do |r|
+            Arel::Nodes::Matches.new(r.left, r.right)
+          end
+        end
+      end
+
+      def not_like(opts, *rest)
+        @scope.tap do |s|
+          s.where_values += s.send(:build_where, opts, *rest).map do |r|
+            Arel::Nodes::DoesNotMatch.new(r.left, r.right)
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::QueryMethods::WhereChain.send(:include, ActiveRecord::QueryMethods::Like)

data/lib/active_record/like/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Like
+    VERSION = "0.0.1"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'active_record/like'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define do
+  create_table :posts do |t|
+    t.string :title
+    t.string :category
+  end
+end
+
+class Post < ActiveRecord::Base
+end

data/test/integration/like_test.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../../helper', __FILE__)
+
+describe ActiveRecord::QueryMethods::WhereChain do
+  describe :like do
+    before do
+      Post.create(id: 1, title: 'We need some content to test with')
+      Post.create(id: 2, title: 'I really like DSLs - see what I did there?')
+    end
+
+    after do
+      Post.delete_all
+    end
+
+    it "finds records with attributes matching the criteria" do
+      Post.where.like(title: '%there?').map(&:id).must_include 2
+    end
+
+    it "is case-insensitive" do
+      search_term = "%dsls"
+
+      lowercase_posts = Post.where.like(title: search_term)
+      uppercase_posts = Post.where.like(title: search_term.upcase)
+
+      lowercase_posts.map(&:id).must_equal(uppercase_posts.map(&:id))
+    end
+
+    it "does not find records with attributes not matching the criteria" do
+      Post.where.like(title: '%this title is not used anywhere%').map(&:id).wont_include 2
+    end
+
+    describe "security-related behavior"  do
+      before do
+        @user_input = "unused%' OR 1=1); --"
+      end
+
+      # This test is only here to provide the contrast for the test below
+      # Interpolating input strings into LIKE queries is an all-too-common
+      # mistake that is prevented by the syntax this plugin provides
+      it "is possible to inject SQL into literal query strings" do
+        Post.where("title LIKE '%#{@user_input}%'").count.must_equal(2)
+      end
+
+      it "prevents SQL injection" do
+        Post.where.like(title: @user_input).count.must_equal(0)
+      end
+    end
+  end
+end

data/test/integration/not_like_test.rb

@@ -0,0 +1,49 @@
+require File.expand_path('../../helper', __FILE__)
+
+describe ActiveRecord::QueryMethods::WhereChain do
+  describe :not_like do
+    before do
+      Post.create(id: 1, title: 'We need some content to test with')
+      Post.create(id: 2, title: 'I really like DSLs - see what I did there?')
+    end
+
+    after do
+      Post.delete_all
+    end
+
+    it "finds records with attributes not matching the criteria" do
+      Post.where.not_like(title: '%there?').map(&:id).wont_include 2
+    end
+
+    it "is case-insensitive" do
+      search_term = "%dsls"
+
+      lowercase_posts = Post.where.not_like(title: search_term)
+      uppercase_posts = Post.where.not_like(title: search_term.upcase)
+
+      lowercase_posts.map(&:id).must_equal(uppercase_posts.map(&:id))
+    end
+
+    it "does not find records with attributes matching the criteria" do
+      Post.where.not_like(title: '%this title is not used anywhere%').map(&:id).must_include 2
+    end
+
+    describe "security-related behavior"  do
+      before do
+        @user_input = "unused%' OR 1=1); --"
+      end
+
+      # This test is only here to provide the contrast for the test below
+      # Interpolating input strings into LIKE queries is an all-too-common
+      # mistake that is prevented by the syntax this plugin provides
+      it "is possible to inject SQL into literal query strings" do
+        Post.where("title NOT LIKE '%#{@user_input}%'").count.must_equal(2)
+      end
+
+      it "prevents SQL injection" do
+        Post.where.not_like(title: @user_input).count.must_equal(2)
+      end
+    end
+  end
+end
+

data/test/unit/like_test.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../../helper', __FILE__)
+
+describe ActiveRecord::QueryMethods::WhereChain do
+  describe :like do
+    it "creates an Arel Matches node in the relation" do
+      relation = Post.where.like(title: '')
+
+      relation.where_values.first.must_be_instance_of(Arel::Nodes::Matches)
+    end
+
+    describe "the Arel Node" do
+      before do
+        @attribute = "title"
+        @value = '%value%'
+
+        @relation_specifier = Post.where.like(@attribute => @value).where_values.first
+      end
+
+      it "has the attribute as the left operand" do
+        @relation_specifier.left.name.must_equal @attribute
+      end
+
+      it "has the value as the right operand" do
+        @relation_specifier.right.must_equal @value
+      end
+    end
+  end
+end

data/test/unit/not_like_test.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../../helper', __FILE__)
+
+describe ActiveRecord::QueryMethods::WhereChain do
+  describe :not_like do
+    it "creates an Arel DoesNotMatch node in the relation" do
+      relation = Post.where.not_like(title: '')
+
+      relation.where_values.first.must_be_instance_of(Arel::Nodes::DoesNotMatch)
+    end
+
+    describe "the Arel Node" do
+      before do
+        @attribute = "title"
+        @value = '%value%'
+
+        @relation_specifier = Post.where.not_like(@attribute => @value).where_values.first
+      end
+
+      it "has the attribute as the left operand" do
+        @relation_specifier.left.name.must_equal @attribute
+      end
+
+      it "has the value as the right operand" do
+        @relation_specifier.right.must_equal @value
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-like
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- René van den Berg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: An ActiveRecord plugin providing a higher-level abstraction for SQL 'LIKE'
+  queries
+email:
+- rene.vandenberg@ogd.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-like.gemspec
+- lib/active_record/like.rb
+- lib/active_record/like/version.rb
+- test/helper.rb
+- test/integration/like_test.rb
+- test/integration/not_like_test.rb
+- test/unit/like_test.rb
+- test/unit/not_like_test.rb
+homepage: http://github.com/ReneB/activerecord-like
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'ActiveRecord::Like provides ActiveRecord::Base with where.like(attribute:
+  string)-style extensions. This functionality was, at one point, included in Rails-master,
+  but subsequently removed. Since the feature seemed to be in some demand, I thought
+  I''d try my hand at building an ActiveRecord plugin'
+test_files:
+- test/helper.rb
+- test/integration/like_test.rb
+- test/integration/not_like_test.rb
+- test/unit/like_test.rb
+- test/unit/not_like_test.rb