wherex 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# ignore Gemfile.lock because it is rewritten by the tests
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,28 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem 'arel', '~> 2.0'
+gem 'activerecord', '~> 3.0'
+
+case ENV["RAILS_DB"]
+when "postgres"
+  gem 'pg'
+when "mysql"
+  gem 'mysql2'
+else
+  gem 'sqlite3'
+end
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem 'redgreen'
+  gem 'turn'
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jason King
+
+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,106 @@
+# wherex
+
+Regexp support to ActiveRecord finders.
+
+## Howto?
+
+In your Gemfile
+
+    gem 'wherex'
+
+Then run `bundle install`
+
+## What the?
+
+    # find users in 93, 94 and 95 (5 digit) zipcodes (new style finder)
+    User.where :zipcode => /^9[345][0-9]{3}$/
+
+    # find students with invalid characters in their names (old style finder)
+    Student.all :conditions => { :name => /[^a-zA-Z ]/ }
+
+    # find products with a complex code structure (dynamic finders)
+    Product.find_by_code /^[NRW][^-]+-[456]/
+
+## Limitations?
+
+### POSIX Only (mostly)
+
+Most DBs only support POSIX regexps!
+
+Let me repeat?  POSIX only!  So, some examples of things to know:
+
+ * `^` and `$` have their POSIX meanings, so beginning and end of the whole string, not of each line within the string.  Also `\A` and `\Z` have no special meaning.
+ * Convenience character classes like `\w \W \d \D \s \S` 
+ * Capturing parens won't break the RE, but there's no capturing (so you can't use what you captured)
+ * No extended patterns, so `(?i:foo)` won't work, nor will `(?:bar)` and nor will `(?i)foo`
+ * No look-around assertions work, so no `foo(?!bar)`
+
+### SQLite is very slow
+
+SQLite's implementation of REGEXP is actually a callback to a user defined
+function, which this gem provides in Ruby.  This is **really cool™** because
+SQLite users get to use full Ruby regexps (ie. **none** of the limitations above
+apply) but it comes at a cost.
+
+On a relatively small data set (say 1000 rows) my MySQL testing ran through all
+records in 2.3ms whereas SQLite took 84.6ms (because it has to call out to Ruby
+for each row tested).
+
+So, don't be surprised if SQLite falls in a heap, and I'd recommend just
+abandoning this idea for any production usage.
+
+### Only SQLite, MySQL and PostgreSQL supported out of the box
+
+You can add your own support for any other DB that supports regexp.  I know that
+Oracle has a regexp function, and I believe that MSSQL has a regexp XP (a Perl
+RE one actually).
+
+Here's how I'd add in Oracle support:
+
+    # config/initializers/wherex.rb
+    module Wherex
+      module OracleEnhancedAdapter
+        def regexp left, right
+          "REGEXP_LIKE( #{left}, #{right} )"
+        end
+
+        def regexp_not left, right
+          "NOT #{regexp left, right}"
+        end
+      end
+    end
+
+That's it (and the 'NOT' is only necessary if you use meta_where or something
+that enables negative Arel statements to be generated).  You just have to make
+sure it is named correctly (needs to be the same as your actual adapter, so if
+you're using `SomeOtherOracleAdapter` then you need to name your module that
+too).
+
+Wherex will pick this module up, and add it into the right place.  Just see
+`lib/wherex/adapters.rb` for more examples.
+
+## Testing
+
+There are test suites for all three database engines that ship with Rails, the
+default is SQLite and requires no preconfiguration.  So you can just clone the
+repo and run `rake` and it will run the tests against SQLite
+
+If you want to run the tests against MySQL or PostgreSQL then you will first
+need to create a `wherex_test` database in your local machine.  Then you will
+need to provide the `RAILS_DB` environment variable to rake, eg:
+
+    RAILS_DB=mysql rake
+
+…or…
+
+    RAILS_DB=postgres rake
+
+These will use a default user of `root` for MySQL and `postgres` for PostgreSQL.
+If you want to use different usernames or passwords then take a look in the
+`config/database.yml` file and either provide the appropriate environment
+variables, or edit the file itself.
+
+## Copyright
+
+Copyright © 2011 Jason King. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+spec = Gem::Specification.load( File.join( File.dirname(__FILE__), 'wherex.gemspec' ) )
+
+$:.push File.expand_path("../lib", __FILE__)
+require "wherex/version"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/wherex/adapters.rb

@@ -0,0 +1,35 @@
+module Wherex
+  module AbstractAdapter
+
+    def regexp_operator
+      "REGEXP"
+    end
+
+    def regexp_not_operator
+      "NOT #{regexp_operator}"
+    end
+
+    def regexp left, right
+      "#{left} #{regexp_operator} #{right}"
+    end
+
+    def regexp_not left, right
+      "#{left} #{regexp_not_operator} #{right}"
+    end
+
+    def regexp_quote str
+      quote str
+    end
+  end
+
+  module PostgreSQLAdapter
+
+    def regexp_operator
+      "~"
+    end
+
+    def regexp_not_operator
+      "!~"
+    end
+  end
+end

data/lib/wherex/connection.rb

@@ -0,0 +1,35 @@
+module Wherex
+  module ActiveRecord
+    def self.extended base
+      base.class_eval do
+        class << self
+          alias_method_chain :establish_connection, :wherex
+        end
+      end
+    end
+
+    def establish_connection_with_wherex spec = nil
+      establish_connection_without_wherex spec
+
+      require 'wherex/adapters'
+      ::ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, AbstractAdapter
+
+      adapter = ::ActiveRecord::Base.connection.class
+      my_adapter_name = adapter.to_s.demodulize
+
+      begin
+        my_adapter = "Wherex::#{my_adapter_name}".constantize
+        adapter.send :include, my_adapter
+      rescue NameError => e
+      end
+
+      if defined? ::ActiveRecord::ConnectionAdapters::SQLiteAdapter
+        ::ActiveRecord::Base.connection.raw_connection.create_function( "regexp", 2 ) do |context, pattern, string|
+          if string.present?
+            context.result = 1 if string.match pattern
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wherex/version.rb

@@ -0,0 +1,3 @@
+module Wherex
+  VERSION = "1.0.0"
+end

data/lib/wherex/visitor.rb

@@ -0,0 +1,33 @@
+module Wherex
+  module Visitor
+
+    def self.included base
+      base.class_eval do
+        alias_method_chain :visit_Arel_Nodes_Equality, :wherex
+        alias_method_chain :visit_Arel_Nodes_NotEqual, :wherex
+      end
+    end
+
+    def visit_Arel_Nodes_Equality_with_wherex o
+      right = o.right
+      if right.present? and right.is_a? Regexp
+        @connection.regexp visit(o.left), visit(right)
+      else
+        visit_Arel_Nodes_Equality_without_wherex o
+      end
+    end
+
+    def visit_Arel_Nodes_NotEqual_with_wherex o
+      right = o.right
+      if right.present? and right.is_a? Regexp
+        @connection.regexp_not visit(o.left), visit(right)
+      else
+        visit_Arel_Nodes_NotEqual_without_wherex o
+      end
+    end
+
+    def visit_Regexp o; @connection.regexp_quote(o.source) end
+
+  end
+end
+

data/lib/wherex.rb

@@ -0,0 +1,10 @@
+require 'arel'
+require 'active_record'
+require 'active_support/core_ext'
+
+require 'wherex/visitor'
+require 'wherex/connection'
+module Wherex
+  ::Arel::Visitors::ToSql.send :include, Visitor
+  ::ActiveRecord::Base.send :extend, ActiveRecord
+end

data/test/app/models/product.rb

@@ -0,0 +1,2 @@
+class Product < ActiveRecord::Base
+end

data/test/app/models/student.rb

@@ -0,0 +1,2 @@
+class Student < ActiveRecord::Base
+end

data/test/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/test/config/database.yml

@@ -0,0 +1,22 @@
+test:
+  postgres:
+    adapter: postgresql
+    encoding: unicode
+    database: wherex_test
+    pool: 5
+    username: <%= ENV['POSTGRESQL_USERNAME'] || 'postgres' %>
+    password: <%= ENV['POSTGRESQL_PASSWORD'] || '' %>
+  mysql:
+    adapter: mysql2
+    encoding: utf8
+    reconnect: false
+    database: wherex_test
+    pool: 5
+    username: <%= ENV['MYSQL_USERNAME'] || 'root' %>
+    password: <%= ENV['MYSQL_PASSWORD'] || '' %>
+    socket: <%= ENV['MYSQL_SOCKET'] || '/tmp/mysql.sock' %>
+  sqlite:
+    adapter: sqlite3
+    database: test/db/test.sqlite3
+    pool: 5
+    timeout: 5000

data/test/fixtures/products.yml

@@ -0,0 +1,15 @@
+---
+one:
+  code: N123-4394-2344
+
+two:
+  code: P123-4394-2234
+
+three:
+  code: N343-899434-32434
+
+four:
+  code: 1N34-4543-3434
+
+five:
+  code: N2343-32343-4444

data/test/fixtures/schema.rb

@@ -0,0 +1,19 @@
+ActiveRecord::Schema.define do
+
+  create_table "users", :force => true do |t|
+    t.string   "zipcode"
+    t.timestamps
+  end
+
+  create_table "students", :force => true do |t|
+    t.string "name"
+    t.timestamps
+  end
+
+  create_table "products", :force => true do |t|
+    t.string "code"
+    t.timestamps
+  end
+end
+
+

data/test/fixtures/students.yml

@@ -0,0 +1,12 @@
+---
+one:
+  name: Jimbo Jones
+
+two:
+  name: Jóse Guervo
+
+three:
+  name: Henri D'Havelan
+
+four:
+  name: foo_bar

data/test/fixtures/users.yml

@@ -0,0 +1,27 @@
+---
+one:
+  zipcode: 92345
+
+two:
+  zipcode: 93456
+
+three:
+  zipcode: 94567
+
+four:
+  zipcode: 95678
+
+five:
+  zipcode: 95abc
+
+six:
+  zipcode: 9512
+
+seven:
+  zipcode: 96789
+
+eight:
+  zipcode: 194123
+
+nine:
+  zipcode: 12345

data/test/helper.rb

@@ -0,0 +1,44 @@
+ENV['RAILS_DB'] = ( ENV['RAILS_DB'] || 'sqlite' ).downcase
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'test/unit'
+begin; require 'redgreen'; rescue LoadError; end
+begin; require 'turn'; rescue LoadError; end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'wherex'
+require 'active_record/fixtures'
+
+ROOT_PATH = File.expand_path( File.join( File.dirname(__FILE__) ))
+FIXTURES_PATH = File.join(File.dirname(__FILE__), 'fixtures')
+
+config = YAML::load(ERB.new(IO.read(File.join( ROOT_PATH, 'config', 'database.yml'))).result)['test'][ENV['RAILS_DB']]
+
+ActiveRecord::Base.establish_connection config
+
+dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
+dep.autoload_paths.unshift File.join( ROOT_PATH, 'app/models' )
+
+dep.autoload_paths.unshift FIXTURES_PATH
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  load File.join(FIXTURES_PATH, 'schema.rb')
+end
+
+Fixtures.create_fixtures(FIXTURES_PATH, ActiveRecord::Base.connection.tables)
+
+class Test::Unit::TestCase
+  def method_missing method, *args
+    candidate = method.to_s.classify
+    begin
+      candidate.constantize.find( Fixtures.identify args[0] )
+    rescue NameError
+      raise NameError.new "undefined local variable or method `#{method}`"
+    end
+  end
+end

data/test/test_wherex.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestWherex < Test::Unit::TestCase
+  def test_user_example
+    assert u = User.where( :zipcode => /^9[345][0-9]{3}$/ )
+    assert_equal 3, u.count 
+    [:two, :three, :four ].each do |id|
+      assert u.include?( users(id) )
+    end
+  end
+
+  def test_product_example
+    assert p = Product.find_by_code( /^[NRW][^-]+-[456]/ )
+    assert_equal products(:one), p
+
+    assert p = Product.find_all_by_code( /^[NRW][^-]+-[456]/ )
+    assert_equal 1, p.count
+    assert_equal products(:one), p.first
+  end
+
+  def test_student_example
+    assert s = Student.all( :conditions => { :name => /[^a-zA-Z ]/ } )
+    assert_equal 3, s.count
+    [ :two, :three, :four ].each do |id| 
+      assert s.include?( students(id) )
+    end
+  end
+end

data/wherex.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "wherex/version"
+
+Gem::Specification.new do |s|
+  s.name        = "wherex"
+  s.version     = Wherex::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jason King"]
+  s.email       = ["jk@handle.it"]
+  s.homepage    = "http://github.com/smathy/wherex"
+  s.license     = "MIT"
+  s.summary     = %q{Regexp for ActiveRecord finders}
+  s.description = %q{This gem allows you to pass a Regexp as the value for any finder in ActiveRecord - Rails3 only}
+
+  s.rubyforge_project = "wherex"
+
+  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 'arel', '~> 2.0'
+  s.add_dependency 'activerecord', '~> 3.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: wherex
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jason King
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: arel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+description: This gem allows you to pass a Regexp as the value for any finder in ActiveRecord - Rails3 only
+email: 
+- jk@handle.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wherex.rb
+- lib/wherex/adapters.rb
+- lib/wherex/connection.rb
+- lib/wherex/version.rb
+- lib/wherex/visitor.rb
+- test/app/models/product.rb
+- test/app/models/student.rb
+- test/app/models/user.rb
+- test/config/database.yml
+- test/db/test.sqlite3
+- test/fixtures/products.yml
+- test/fixtures/schema.rb
+- test/fixtures/students.yml
+- test/fixtures/users.yml
+- test/helper.rb
+- test/test_wherex.rb
+- wherex.gemspec
+homepage: http://github.com/smathy/wherex
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: wherex
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Regexp for ActiveRecord finders
+test_files: 
+- test/app/models/product.rb
+- test/app/models/student.rb
+- test/app/models/user.rb
+- test/config/database.yml
+- test/db/test.sqlite3
+- test/fixtures/products.yml
+- test/fixtures/schema.rb
+- test/fixtures/students.yml
+- test/fixtures/users.yml
+- test/helper.rb
+- test/test_wherex.rb