better_ar 0.0.3

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+doc/*
+.yardoc/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create default@better_ar > /dev/null

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in better_ar.gemspec
+gemspec

data/HISTORY.txt

@@ -0,0 +1,2 @@
+## 0.0.3
+  Supports legacy calls to .all, .first, .count if the :conditions key is present

data/MIT-LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Brian Cardarella
+
+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.markdown

@@ -0,0 +1,18 @@
+# BetterAr
+
+BetterAr adds replaces the .all, .first and .count methods for ActiveRecord.
+
+Now a single hash can be passed to ActiveRecord::Base.all that contains not only the where values but also other scopes like 'limit' and 'order'
+
+    User.all(:age => 10, :limit => 5, :offset => 10, :order => :name)
+
+is the same as
+
+    User.where(:age => 10).limit(5).offset(10).order(:name)
+
+While this may seem less concise the advantage is being able to dynamically construct the query with a single hash in code.
+
+This library completely removes the old .all, .first and .count class methods on ActiveRecord::Base. As these methods were just delegated to the ActiveRecord::Base.scoped they can still be called.
+
+Brian Cardarella - 2011
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/better_ar.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "better_ar/version"
+
+Gem::Specification.new do |s|
+  s.name        = "better_ar"
+  s.version     = BetterAr::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brian Cardarella"]
+  s.email       = ["bcardarella@gmail.com"]
+  s.homepage    = "https://github.com/bcardarella/better_ar"
+  s.summary     = %q{Better Active Record finders}
+  s.description = %q{Better Active Record finders}
+
+  s.rubyforge_project = "better_ar"
+
+  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_development_dependency 'activerecord', ['>= 3.0.3']
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'yard'
+end

data/lib/better_ar.rb

@@ -0,0 +1,88 @@
+module BetterAr
+  module ClassMethods
+
+    # Breaks down the hash to do a ActiveRecord::Relation query
+    #
+    # example: User.all(:age => 10, :limit => 2, :offset => 3, :order => :name)
+    #
+    # is the same as: User.where(:age => 10).limit(2).offset(3).order(:name)
+    #
+    # if the key :conditions is present it will fall back to legacy
+    #
+    # @param [Hash]
+    #   Optional
+    # @return [ActiveRecord::Relation]
+    def all(opts = {})
+      relation = scoped.clone
+
+      unless opts.key?(:conditions)
+        unless opts.empty?
+          [:order, :limit, :offset].each do |predicate|
+            if value = opts.delete(predicate)
+              relation = relation.send(predicate, value)
+            end
+          end
+          relation.where(opts)
+        end
+
+        if opts.empty?
+          relation
+        else
+          relation.where(opts)
+        end
+      else
+        relation.all(opts)
+      end
+      
+    end
+
+    # Forces a limit of 1 on the collection
+    #
+    # example: User.first(:age => 10, :name => 'Brian')
+    #
+    # is the same as: User.where(:age => 10, :name => 'Brian').limit(1).first
+    #
+    # if the key :conditions is present it will fall back to legacy
+    #
+    # @param [Hash]
+    #   Optional
+    # @return [ActiveRecord::Base]
+    def first(opts = {})
+      unless opts.key?(:conditions)
+        all(opts.merge(:limit => 1)).first
+      else
+        scoped.first(opts)
+      end
+    end
+
+    # Does a count on the query
+    #
+    # example: User.count(:age => 20)
+    #
+    # is the same as: User.where(:age => 20).count
+    #
+    # if the key :conditions is present it will fall back to legacy
+    #
+    # @param [Hash]
+    #   Optional
+    # @return [Integer]
+    def count(opts = {})
+      unless opts.key?(:conditions)
+        all(opts).count
+      else
+        scoped.count(opts)
+      end
+    end
+  end
+
+end
+
+ActiveRecord::Base.class_eval do
+  class << self
+    remove_method :all
+    remove_method :first
+    remove_method :count
+  end
+end
+
+ActiveRecord::Base.send(:extend, BetterAr::ClassMethods)

data/lib/better_ar/version.rb

@@ -0,0 +1,3 @@
+module BetterAr
+  VERSION = "0.0.3"
+end

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'ruby-debug'
+require 'minitest/autorun'
+require 'mocha'
+require 'active_record'
+require 'better_ar'
+
+class Object
+  def must_be_like other
+    self.gsub(/\s+/, ' ').strip.must_equal other.gsub(/\s+/, ' ').strip
+  end
+end
+
+ActiveRecord::Base.establish_connection(
+  :adapter => defined?(JRUBY_VERSION) ? 'jdbcsqlite3' : 'sqlite3',
+  :database => ':memory:'
+)
+
+users_table = %{CREATE TABLE users (id INTEGER PRIMARY KEY, age INTEGER, name TEXT);}
+ActiveRecord::Base.connection.execute(users_table)
+
+class User < ActiveRecord::Base; end
+

data/test/test_finder_methods.rb

@@ -0,0 +1,58 @@
+require 'helper'
+
+describe 'Enhanced Finder Methods' do
+  after do
+    User.destroy_all
+  end
+
+  describe '.all' do
+    it 'should return all records when no params' do
+      User.all.to_sql.must_be_like %{
+        SELECT "users".* FROM "users"
+      }
+    end
+
+    it 'extracts the non-where scopes and applies' do
+      test_sql = User.all(:limit => 1, :offset => 2, :order => :name, :age => 10).to_sql
+      expected_sql = User.where(:age => 10).limit(1).offset(2).order(:name).to_sql
+      test_sql.must_be_like expected_sql
+    end
+  end
+
+  describe '.first' do
+    it 'calls #first on .all' do
+      expected = User.create(:age => 10)
+      User.create(:age => 11)
+      User.first(:age => 10).must_equal expected
+    end
+  end
+
+  describe '.count' do
+    it 'calls #count on .all' do
+      User.create(:age => 10)
+      User.create(:age => 11)
+      User.count(:age => 10).must_equal 1
+    end
+  end
+
+  describe 'hash contains :conditions' do
+    before do
+      @expected = User.create(:name => 'test')
+      User.create(:name => 'no test')
+    end
+
+    it 'falls back for .all' do
+      User.all(:conditions => "name = 'test'").must_equal [@expected]
+    end
+
+    it 'falls back for .first' do
+      User.first(:conditions => "name = 'test'").must_equal @expected
+    end
+
+    it 'falls back for .count' do
+      User.count(:conditions => "name = 'test'").must_equal 1
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: better_ar
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Brian Cardarella
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-27 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Better Active Record finders
+email: 
+- bcardarella@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- HISTORY.txt
+- MIT-LICENSE.txt
+- README.markdown
+- Rakefile
+- better_ar.gemspec
+- lib/better_ar.rb
+- lib/better_ar/version.rb
+- test/helper.rb
+- test/test_finder_methods.rb
+has_rdoc: true
+homepage: https://github.com/bcardarella/better_ar
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: better_ar
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Better Active Record finders
+test_files: 
+- test/helper.rb
+- test/test_finder_methods.rb