ar_query 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/ar_query.rb

@@ -0,0 +1,38 @@
+require 'delegate'
+
+class ARQuery < Hash
+  attr_accessor :bind_vars, :boolean_join
+  attr_reader   :condition_sqls
+  
+  def initialize(initial_values={})
+    super nil
+    initial_values.each do |k,v| self[k] = v; end
+    @bind_vars = []
+    @condition_sqls = ConditionSQLs.new
+    @boolean_join = :and
+  end
+    
+  def []( key )
+    if (key == :conditions) && !@condition_sqls.empty?
+      join_str = @boolean_join == :and ? ' AND ' : ' OR '
+      condition_sql =
+          @condition_sqls.map { |c_sql| "(#{c_sql})" }.join(join_str)
+      @bind_vars.empty? ? condition_sql : [ condition_sql, *@bind_vars ]
+    else
+      super
+    end
+  end
+  
+  class ConditionSQLs < Array
+    def <<(elt)
+      if elt.is_a?(String)
+        super
+      else
+        raise(
+          ArgumentError,
+          "Tried appending #{elt.inspect} to ARQuery#condition_sqls: Only strings are allowed"
+        )
+      end
+    end
+  end
+end

data/spec/ar_query_spec.rb

@@ -0,0 +1,108 @@
+require File.dirname(__FILE__) + '/../lib/ar_query'
+
+describe ARQuery do
+  it 'should be a kind of Hash' do
+    @ar_query = ARQuery.new
+    # This is required because ActiveRecord.find uses args.extract_options!
+    @ar_query.is_a?(::Hash).should be_true
+  end
+  
+  describe '#initialize with no values' do
+    before :all do
+      @ar_query = ARQuery.new
+    end
+    
+    it 'should not have conditions' do
+      @ar_query[:conditions].should be_nil
+    end
+  end
+  
+  describe '#initialize with values' do
+    before :all do
+      @ar_query = ARQuery.new(:order => 'id desc', :limit => 25)
+    end
+    
+    it 'should have those values in the hash' do
+      @ar_query[:order].should == 'id desc'
+      @ar_query[:limit].should == 25
+    end
+    
+    it 'should not have other values in the hash' do
+      @ar_query[:conditions].should be_nil
+    end
+  end
+  
+  describe "#condition_sqls <<" do
+    before :all do
+      @ar_query = ARQuery.new
+      @ar_query.condition_sqls << "fname is not null"
+      @ar_query.condition_sqls << "lname is not null"
+    end
+    
+    it 'should join the conditions with an AND' do
+      @ar_query[:conditions].should ==
+          "(fname is not null) AND (lname is not null)"
+    end
+    
+    it "should prevent you from appending nil" do
+      lambda { @ar_query.condition_sqls << nil }.should raise_error(
+        ArgumentError,
+        "Tried appending nil to ARQuery#condition_sqls: Only strings are allowed"
+      )
+    end
+    
+    it "should prevent you from appending a value besides a string" do
+      lambda { @ar_query.condition_sqls << 55 }.should raise_error(
+        ArgumentError,
+        "Tried appending 55 to ARQuery#condition_sqls: Only strings are allowed"
+      )
+    end
+  end
+  
+  describe '#condition_sqls << with OR as the boolean join' do
+    before :all do
+      @ar_query = ARQuery.new
+      @ar_query.boolean_join = :or
+      @ar_query.condition_sqls << "fname is not null"
+      @ar_query.condition_sqls << "lname is not null"
+    end
+    
+    it 'should join the conditions with an OR' do
+      @ar_query[:conditions].should ==
+          "(fname is not null) OR (lname is not null)"
+    end
+  end
+    
+  describe '[:conditions]' do
+    describe 'with bind vars' do
+      before :all do
+        @ar_query = ARQuery.new
+        @ar_query.condition_sqls << "fname = ?"
+        @ar_query.condition_sqls << "lname = ?"
+      end
+      
+      describe 'using appends' do
+        before :all do
+          @ar_query.bind_vars << 'Francis'
+          @ar_query.bind_vars << 'Hwang'
+        end
+        
+        it 'should put the bind_vars at the end of the conditions array' do
+          @ar_query[:conditions].should ==
+            [ "(fname = ?) AND (lname = ?)", 'Francis', 'Hwang' ]
+        end
+      end
+      
+      describe 'using assignment' do
+        before :all do
+          @ar_query.bind_vars = %w( Francis Hwang )
+        end
+        
+        it 'should put the bind_vars at the end of the conditions array' do
+          @ar_query[:conditions].should ==
+            [ "(fname = ?) AND (lname = ?)", 'Francis', 'Hwang' ]
+        end
+      end
+    end
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: ar_query
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Francis Hwang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-19 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A utility class for building options for ActiveRecord.find.
+email: sera@fhwang.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ar_query.rb
+- MIT-LICENSE
+- README
+- init.rb
+- install.rb
+- uninstall.rb
+- spec/ar_query_spec.rb
+- tasks/ar_query_tasks.rake
+has_rdoc: false
+homepage: http://github.com/fhwang/ar_query
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A utility class for building options for ActiveRecord.find.
+test_files: []
+