inequal_opportunity 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.swp
+*.swo
+database.yml
+pkg/

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Angilly
+
+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

@@ -0,0 +1,68 @@
+= Inequal Opportunity
+
+inequal_opportunity exists because this does not work in ActiveRecord:
+
+  Doctor.all(:joins => :patients, :conditions => {:patients => ['age > ?', 20]})
+
+You will get an unknown column exception looking for `doctors`.`age`.
+Instead, you need to write:
+
+  Doctor.all(:joins => :pateints, :conditions => ['`patients`.`age` > ?', 20])
+
+Putting the string table name in the query annoyed me.  On top of that,
+I always wanted a way to eliminate strings from my named scopes and queries.
+So now with inequal_opportunity you can write:
+
+  Doctor.all(:joins => :patients, :conditions => {:patients => {:age => gt(20)}})
+
+Not only is it prettier (hashed), but ActiveRecord will keep track of
+table names for you.
+
+ActiveRecord looks for Array and Range types to decide whether to use
+'IN' or 'BETWEEN' instead of the normal '=' as the comparison operator
+when generating SQL. inequal_opportunity extends that pattern by
+wrapping the value in a series of ActiveRecord::Inequality::Base classes.
+Just wrap the value with one of the following helper functions:
+
+  gte()     =>      >= 
+  gt()      =>      >
+  lte()     =>      <=
+  le()      =>      <
+  ne()      =>      <>
+  ne(nil)   =>      IS NOT
+
+and the appropriate SQL will be generated.  This works in finds, as shown
+above, in counts:
+
+  People.count(:age => gt(20))
+
+in named scopes:
+
+  class People < AR::B
+    named_scope :underage, :conditions => {:age => lte(18)}
+  end
+
+in default scopes:
+
+  class Feedback < AR::B
+    default_scope :conditions => {:type => ne('spam')}
+  end
+
+and pretty much everywhere else I've tested manually.
+
+Test coverage is kind of sparse right now, and it's only been tested
+on MySQL.  But it has been rock solid in every situation I've thrown it in,
+so I figured the best way to improve it was to release the hounds (YOU).
+
+Note that I am not completely satisfied with the way I alias
+ActiveRecord::Base.expand_range_bind_variables.  It smells, but it works.
+Suggestions welcome.
+
+== License
+
+inequal_opportunity is released under the MIT license.
+
+
+== Support
+
+Just email me at ryan@angilly.com with questions, bugs, or patches.

data/Rakefile

@@ -0,0 +1,12 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "inequal_opportunity"
+    gemspec.summary = "Adds mergable, stackable inequality statements to ActiveRecord conditions"
+    gemspec.email = "ryan@angilly.com"
+    gemspec.homepage = "http://github.com/ryana/inequal_opportunity"
+    gemspec.description = "Adds mergable, stackable inequality statements to ActiveRecord conditions"
+    gemspec.authors = ["Ryan Angilly"]
+  end
+  Jeweler::GemcutterTasks.new
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 0

data/inequal_opportunity.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{inequal_opportunity}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Angilly"]
+  s.date = %q{2010-05-18}
+  s.description = %q{Adds mergable, stackable inequality statements to ActiveRecord conditions}
+  s.email = %q{ryan@angilly.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION.yml",
+     "inequal_opportunity.gemspec",
+     "init.rb",
+     "lib/inequal_opportunity.rb",
+     "test/database.example.yml",
+     "test/db_setup.rb",
+     "test/inequal_opportunity_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ryana/inequal_opportunity}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Adds mergable, stackable inequality statements to ActiveRecord conditions}
+  s.test_files = [
+    "test/db_setup.rb",
+     "test/inequal_opportunity_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1,4 @@
+$: << File.dirname(__FILE__) + "/lib/"
+
+require 'active_record'
+require 'inequal_opportunity'

data/lib/inequal_opportunity.rb

@@ -0,0 +1,154 @@
+module ActiveRecord
+  module Inequality
+
+    class InequalError < Exception
+    end
+
+    class Base
+      attr_accessor :value
+  
+      def initialize(val)
+        self.value = val
+      end
+
+      def operator
+        raise('Nope')
+      end
+
+      def ==(val)
+        self.operator == val.operator && self.value == val.value
+      end
+    
+      def string_value
+        value ? "'#{value}'" : 'nil'
+      end
+
+      def inspect
+        " #{operator} #{self.string_value}"
+      end
+
+    end
+
+    class GreaterThanEqual < Base
+      def operator
+        '>='
+      end
+    end
+
+    class GreaterThan < Base
+      def operator
+        '>'
+      end
+    end
+
+    class LessThanEqual < Base
+      def operator
+        '<='
+      end
+    end
+
+    class LessThan < Base
+      def operator
+        '<'
+      end
+    end
+
+    class NotEqual < Base
+      def operator
+        case value
+        when NilClass, TrueClass, FalseClass
+         'IS NOT'
+        when Array
+         'NOT IN'
+        else
+          '<>'
+        end
+      end
+    end
+
+    class Like < Base
+      def operator
+        'LIKE'
+      end
+ 
+      # This method is why I love Ruby
+      def value(override = false)
+        v = super(*[])
+
+        if !override && !v.is_a?(Numeric) && !v.is_a?(String)
+          raise InequalError, "Passing #{v.class} to Like.  You can't possibly want to do this"
+        end
+
+        "%#{v}%"
+      end
+    end
+
+    module WrapperMethods
+
+      def lte(val)
+        ActiveRecord::Inequality::LessThanEqual.new(val)
+      end
+
+      def lt(val)
+        ActiveRecord::Inequality::LessThan.new(val)
+      end
+
+      def gte(val)
+        ActiveRecord::Inequality::GreaterThanEqual.new(val)
+      end
+
+      def gt(val)
+        ActiveRecord::Inequality::GreaterThan.new(val)
+      end
+
+      def ne(val)
+        ActiveRecord::Inequality::NotEqual.new(val)
+      end
+
+      def like(val)
+        ActiveRecord::Inequality::Like.new(val)
+      end
+
+    end
+
+  end
+
+  class Base
+    class << self
+      alias attribute_condition_orig attribute_condition
+      def attribute_condition(quoted_column_name, argument)
+        if argument.is_a? ActiveRecord::Inequality::Base
+          question = argument.value.is_a?(Array) ? '(?)' : '?'
+          "#{quoted_column_name} #{argument.operator} #{question}"
+        else
+          attribute_condition_orig(quoted_column_name, argument)
+        end
+      end
+
+      alias expand_range_bind_variables_orig expand_range_bind_variables
+      def expand_range_bind_variables(bind_vars)
+        expanded = []
+
+        bind_vars.each do |var|
+          next if var.is_a?(Hash)
+
+          if var.is_a?(Range)
+            expanded << var.first
+            expanded << var.last
+          elsif var.is_a?(ActiveRecord::Inequality::Base)
+            expanded << var.value
+          else
+            expanded << var
+          end
+        end
+
+        expanded
+      end
+
+    end
+  end
+
+end
+
+include ActiveRecord::Inequality::WrapperMethods
+

data/test/database.example.yml

@@ -0,0 +1,8 @@
+source:
+  adapter: mysql
+  database: 
+  host: localhost
+  port: 3306
+  username: 
+  password:  
+

data/test/db_setup.rb

@@ -0,0 +1,13 @@
+DB = YAML::load(File.open(File.join(File.dirname(__FILE__), 'database.yml'))).symbolize_keys!
+ActiveRecord::Base.establish_connection(DB[:source])
+
+TABLES = %w(mains seconds)
+
+TABLES.each do |t|
+  ActiveRecord::Base.connection.execute("drop table if exists #{t};")
+end
+
+TABLES.each do |t|
+  ActiveRecord::Base.connection.execute("create table #{t} (id integer, val integer, seconds_id integer, mains_id integer, created_at datetime default null);")
+end
+

data/test/inequal_opportunity_test.rb

@@ -0,0 +1,175 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require File.join(File.dirname(__FILE__), 'db_setup')
+
+METHOD_SYMBOLS = [:gt, :gte, :lt, :lte, :ne, :like]
+
+class Main < ActiveRecord::Base
+  belongs_to :seconds
+  named_scope :newer_than, lambda {|time| {:conditions => {:created_at => gte(time) }} }
+
+  METHOD_SYMBOLS.each do |s|
+    named_scope :"try_#{s}", lambda {|i| {:conditions => {:id => send(s, i)}} }
+  end
+
+end
+
+class Second < ActiveRecord::Base
+  has_many :mains
+end
+
+class InequalOpportunityTest < Test::Unit::TestCase
+
+  def setup
+    TABLES.each do |t|
+      ActiveRecord::Base.connection.execute("DELETE FROM #{t};")
+    end
+ end
+
+  context "a model" do
+    setup do
+      @model = Main
+    end
+
+    should "respond to gte" do
+      assert @model.respond_to?(:gte)
+    end
+
+    should "should work with a named_scope" do
+      assert_equal Main.newer_than(2.days.ago).all, []
+    end
+
+    should "generate proper sql for array" do
+      METHOD_SYMBOLS.each do |s|
+
+        if s == :ne
+          assert_equal Main.try_ne([1,2,3]).first, nil
+        elsif s == :like
+          assert_raises ActiveRecord::Inequality::InequalError do
+            assert_equal Main.try_like([1,2,3]).first, nil
+          end
+        else
+          assert_raises ActiveRecord::StatementInvalid do
+            assert_equal Main.send(:"try_#{s}", [1,2,3]).first, nil
+          end
+        end
+      end
+
+      assert_equal Main.try_ne([1,2,3]).first, nil
+      assert_equal Main.try_ne([1,2,3]).count, 0
+    end
+
+    should "generate proper sql for nil and not nil" do
+      METHOD_SYMBOLS.each do |s|
+        assert_equal Main.send(:"try_#{s}", 1).first, nil
+        assert_equal Main.send(:"try_#{s}", nil).first, nil unless s == :like
+      end
+
+      assert_raises ActiveRecord::Inequality::InequalError do
+        Main.try_like(nil).first
+      end
+    end
+
+    should "properly scope based on gte" do
+      time = 2.days.ago
+      num = 3
+      num.times { Main.create(:val => 3) }
+      num.times { Main.create(:val => 1) }
+
+      assert_equal Main.count(:conditions => {:val => gte(2)}), num
+    end
+
+  end
+
+  context "an instance" do
+    setup do
+      @main = Main.new
+    end
+
+    should "respond to gte" do
+      assert @main.respond_to?(:gte)
+    end
+
+  end
+
+  context "a parent" do
+    setup do
+      @second = Second.new
+    end
+
+    should "see through assocaitions" do
+      assert @second.mains.respond_to?(:gte)
+    end
+  end
+
+  context "Object" do
+    should "have gte" do
+      wrapped = gte(5)
+      assert_equal wrapped.operator, '>='
+      assert_equal wrapped, ActiveRecord::Inequality::GreaterThanEqual.new(5)
+    end
+
+    should "have gt" do
+      wrapped = gt(5)
+      assert_equal wrapped.operator, '>'
+      assert_equal wrapped, ActiveRecord::Inequality::GreaterThan.new(5)
+    end
+
+    should "have lte" do
+      wrapped = lte(5)
+      assert_equal wrapped.operator, '<='
+      assert_equal wrapped, ActiveRecord::Inequality::LessThanEqual.new(5)
+    end
+
+    should "have lt" do
+      wrapped = lt(5)
+      assert_equal wrapped.operator, '<'
+      assert_equal wrapped, ActiveRecord::Inequality::LessThan.new(5)
+    end
+
+    should "have ne" do
+      wrapped = ne(5)
+      assert_equal wrapped.operator, '<>'
+      assert_equal wrapped, ActiveRecord::Inequality::NotEqual.new(5)
+    end
+
+    should "have a different operator when calling ne w/ nil" do
+      wrapped = ne(nil)
+      assert_equal wrapped.operator, 'IS NOT'
+      assert_equal wrapped, ActiveRecord::Inequality::NotEqual.new(nil)
+    end
+
+    should "have a different operator when calling ne w/ true" do
+      wrapped = ne(true)
+      assert_equal wrapped.operator, 'IS NOT'
+      assert_equal wrapped, ActiveRecord::Inequality::NotEqual.new(true)
+    end
+
+    should "have a different operator when calling ne w/ false" do
+      wrapped = ne(false)
+      assert_equal wrapped.operator, 'IS NOT'
+      assert_equal wrapped, ActiveRecord::Inequality::NotEqual.new(false)
+    end
+
+
+
+    should "have like" do
+      wrapped = like('ryan')
+      assert_equal wrapped.operator, 'LIKE'
+      assert_equal wrapped, ActiveRecord::Inequality::Like.new('ryan')
+    end
+
+  end
+
+  context "expand_range_bind_variables_orig" do
+    should "return a proper array" do
+      range_start = 1
+      range_end = 9
+
+      input = [{:a => 1}, (range_start..range_end), "Yo", {:c => 'd'}, 23, [1,2,3]]
+      res = ActiveRecord::Base.send :expand_range_bind_variables_orig, input
+
+      assert_equal res, [range_start, range_end, "Yo", 23, [1,2,3]]
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require File.dirname(__FILE__) + '/../init'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: inequal_opportunity
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Ryan Angilly
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-18 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Adds mergable, stackable inequality statements to ActiveRecord conditions
+email: ryan@angilly.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION.yml
+- inequal_opportunity.gemspec
+- init.rb
+- lib/inequal_opportunity.rb
+- test/database.example.yml
+- test/db_setup.rb
+- test/inequal_opportunity_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ryana/inequal_opportunity
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Adds mergable, stackable inequality statements to ActiveRecord conditions
+test_files: 
+- test/db_setup.rb
+- test/inequal_opportunity_test.rb
+- test/test_helper.rb