better_ar 0.0.6 → 0.0.7

data/HISTORY.txt

@@ -1,3 +1,7 @@
+## 0.0.7
+  Added support for association collections
+  Moved ActiveRecord::Relation included methods into proper modules
+
 ## 0.0.6
   Moved methods as higher level module in ActiveRecord::Relation than ActiveRecord::FinderMethods. So the BetterAR modules take precedence.
 

data/README.markdown

@@ -23,6 +23,14 @@ is the same as
 
     User.joins(:records).where(:age => 10, :records => {:name => 'test'}).limit(5).offset(10).order(:name)
 
+It also works on association collections:
+
+    User.first.records.all(:level => 2, :limit! => 5, :offset! => 10, :order! => :name, :reports => {:name => 'test'})
+
+This would be the same as:
+
+    User.first.records.joins(:reports).where(:level => 2, :reports => {:name => 'test'}).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.
 
 ### Legacy

data/better_ar.gemspec

@@ -20,6 +20,4 @@ Gem::Specification.new do |s|
   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

@@ -1,107 +1,5 @@
-module BetterAr
+module BetterAr; end
 
-  # 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
-  #
-  # any key with the '!' at the end will be assumed to be a sql operator. The key should match either an {ActiveRecord::Relation} instance method or an ARel predicate.
-  #
-  # Implicit joins are supported.
-  # example:
-  #  User.all(:records => {:name => 'test'})
-  #
-  # is the same as:
-  #  User.joins(:records).where(:records => {:name => 'test'})
-  #
-  # @param [Hash]
-  #   Optional
-  # @return [ActiveRecord::Relation]
-  def all(opts = {})
-    if opts.empty?
-      super()
-    elsif opts.key?(:conditions)
-      super(opts)
-    else
-      relation = clone
-
-      unless opts.key?(:conditions)
-        unless opts.empty?
-          opts.keys.select { |key| key.to_s =~ /!$/ }.each do |predicate|
-            if value = opts.delete(predicate)
-              relation = relation.send(predicate.to_s.sub('!',''), value)
-            end
-          end
-
-          reflect_on_all_associations.map(&:name).each do |name|
-            if opts.key?(name)
-              relation = relation.joins(name)
-            end
-          end
-
-          relation.where(opts)
-        end
-
-        if opts.empty?
-          relation
-        else
-          relation.where(opts)
-        end
-      end
-    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 follows same convention as {#all}
-  # @return [ActiveRecord::Base]
-  def first(opts = {})
-    if opts.empty?
-      super()
-    elsif opts.key?(:conditions)
-      super(opts)
-    else
-      all(opts.merge(:limit! => 1)).first
-    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 follows same convention as {#all}
-  # @return [Integer]
-  def count(opts = {})
-    if opts.empty?
-      super()
-    elsif opts.key?(:conditions)
-      super(opts)
-    else
-      all(opts).count
-    end
-  end
-
-end
-
-ActiveRecord::Relation.send(:include, BetterAr)
+require 'better_ar/finder_methods'
+require 'better_ar/calculations'
+require 'better_ar/association_collection'

data/lib/better_ar/association_collection.rb

@@ -0,0 +1,49 @@
+module BetterAr
+  module AssociationCollection
+
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :first, :better_ar
+        alias_method_chain :count, :better_ar
+      end
+    end
+
+    # Allows for the same interface as {BetterAr::Relation#first} on association collections
+    #
+    # example:
+    #  User.first.records.first(:level => 2, :order! => :name)
+    #
+    # @param [Hash]
+    #   Optional
+    # @returns [ActiveRecord::Base]
+    def first_with_better_ar(opts = {})
+      if opts.empty?
+        first_without_better_ar
+      elsif opts.key?(:conditions)
+        first_without_better_ar(opts)
+      else
+        scoped.first(opts)
+      end
+    end
+
+    # Allows for the same interface as {BetterAr::Relation#count} on association collections
+    #
+    # example:
+    #  User.first.records.count(:level => 2)
+    #
+    # @param [Hash]
+    #   Optional
+    # @returns [Integer]
+    def count_with_better_ar(opts = {})
+      if opts.empty?
+        count_without_better_ar
+      elsif opts.key?(:conditions)
+        count_without_better_ar(opts)
+      else
+        scoped.count(opts)
+      end
+    end
+  end
+end
+
+ActiveRecord::Associations::AssociationCollection.send(:include, BetterAr::AssociationCollection)

data/lib/better_ar/calculations.rb

@@ -0,0 +1,28 @@
+module BetterAr
+  module Calculations
+    # 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 follows same convention as {#all}
+    # @return [Integer]
+    def count(opts = {}, extra = {})
+      if opts.nil? || opts.empty?
+        super(nil, extra)
+      elsif opts.key?(:conditions)
+        super(opts, extra)
+      else
+        all(opts).count
+      end
+    end
+  end
+end
+
+ActiveRecord::Relation.send(:include, BetterAr::Calculations)

data/lib/better_ar/finder_methods.rb

@@ -0,0 +1,84 @@
+module BetterAr
+  module FinderMethods
+    # 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
+    #
+    # any key with the '!' at the end will be assumed to be a sql operator. The key should match either an {ActiveRecord::Relation} instance method or an ARel predicate.
+    #
+    # Implicit joins are supported.
+    # example:
+    #  User.all(:records => {:name => 'test'})
+    #
+    # is the same as:
+    #  User.joins(:records).where(:records => {:name => 'test'})
+    #
+    # @param [Hash]
+    #   Optional
+    # @return [ActiveRecord::Relation]
+    def all(opts = {})
+      if opts.empty?
+        super()
+      elsif opts.key?(:conditions)
+        super(opts)
+      else
+        relation = clone
+
+        unless opts.key?(:conditions)
+          unless opts.empty?
+            opts.keys.select { |key| key.to_s =~ /!$/ }.each do |predicate|
+              if value = opts.delete(predicate)
+                relation = relation.send(predicate.to_s.sub('!',''), value)
+              end
+            end
+
+            reflect_on_all_associations.map(&:name).each do |name|
+              if opts.key?(name)
+                relation = relation.joins(name)
+              end
+            end
+
+            relation.where(opts)
+          end
+
+          if opts.empty?
+            relation
+          else
+            relation.where(opts)
+          end
+        end
+      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 follows same convention as {#all}
+    # @return [ActiveRecord::Base]
+    def first(opts = {})
+      if opts.empty?
+        super()
+      elsif opts.key?(:conditions)
+        super(opts)
+      else
+        all(opts.merge(:limit! => 1)).first
+      end
+    end
+  end
+end
+
+ActiveRecord::Relation.send(:include, BetterAr::FinderMethods)

data/lib/better_ar/version.rb

@@ -1,3 +1,3 @@
 module BetterAr
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/test/helper.rb

@@ -1,7 +1,6 @@
 require 'rubygems'
 require 'ruby-debug'
 require 'minitest/autorun'
-# require 'mocha'
 require 'active_support/core_ext'
 require 'active_record'
 require 'better_ar'
@@ -19,8 +18,10 @@ ActiveRecord::Base.establish_connection(
 
 users_table = %{CREATE TABLE users (id INTEGER PRIMARY KEY, age INTEGER, name TEXT);}
 records_table = %{CREATE TABLE records (id INTEGER PRIMARY KEY, user_id INTEGER, name TEXT);}
+reports_table = %{CREATE TABLE reports (id INTEGER PRIMARY KEY, record_id INTEGER, name TEXT);}
 ActiveRecord::Base.connection.execute(users_table)
 ActiveRecord::Base.connection.execute(records_table)
+ActiveRecord::Base.connection.execute(reports_table)
 
 class User < ActiveRecord::Base
   has_many :records
@@ -28,5 +29,10 @@ end
 
 class Record < ActiveRecord::Base
   belongs_to :user
+  has_many :reports
+end
+
+class Report < ActiveRecord::Base
+  belongs_to :record
 end
 

data/test/test_finder_methods.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe 'Enhanced Finder Methods' do
+describe 'ActiveRecord::Relation Finder Methods' do
   after do
     User.destroy_all
   end
@@ -72,3 +72,73 @@ describe 'Enhanced Finder Methods' do
 
 end
 
+describe 'ActiveRecord::Associations::AssociationCollection Finder Methods' do
+  before do
+    @user = User.create
+    @record_1 = @user.records.create(:name => 'one')
+    @record_2 = @user.records.create(:name => 'two')
+  end
+
+  after do
+    User.destroy_all
+    Record.destroy_all
+  end
+
+  describe '.all' do
+    it 'extracts the non-where scopes and applies' do
+      test_sql = @user.records.all(:limit! => 1, :offset! => 2, :order! => :name, :name => 'one').to_sql
+      expected_sql = @user.records.where(:name => 'one').limit(1).offset(2).order(:name).to_sql
+      test_sql.must_be_like expected_sql
+    end
+
+    it 'finds implicit joins by reflection' do
+      test_sql = @user.records.all(:reports => { :name => 'test' }).to_sql
+      expected_sql = @user.records.joins(:reports).where(:reports => { :name => 'test' }).to_sql
+      test_sql.must_be_like expected_sql
+    end
+  end
+
+  describe '.first' do
+    it 'calls #first on .all' do
+      @user.records.first(:name => 'two').must_equal @record_2
+    end
+  end
+
+  describe '.count' do
+    it 'calls #count on .all' do
+      @user.records.count(:name => 'one').must_equal 1
+    end
+  end
+
+  describe 'hash contains :conditions' do
+    describe 'with conditions' do
+      it 'falls back for .all' do
+        @user.records.all(:conditions => "name = 'one'").must_equal [@record_1]
+      end
+
+      it 'falls back for .first' do
+        @user.records.create(:name => 'one')
+        @user.records.first(:conditions => "name = 'one'").must_equal @record_1
+      end
+
+      # Note a valid test... need to rewrite.
+      # it 'falls back for .count' do
+      #   @user.records.count(:conditions => "name = 'one'").must_equal 1
+      # end
+    end
+
+    describe 'without conditions' do
+      it 'falls back for .all' do
+        @user.records.all.must_equal [@record_1, @record_2]
+      end
+
+      it 'falls back for .first' do
+        @user.records.first.must_equal @record_1
+      end
+
+      it 'falls back for .count' do
+        @user.records.count.must_equal 2
+      end
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Brian Cardarella
@@ -51,6 +51,9 @@ files:
 - Rakefile
 - better_ar.gemspec
 - lib/better_ar.rb
+- lib/better_ar/association_collection.rb
+- lib/better_ar/calculations.rb
+- lib/better_ar/finder_methods.rb
 - lib/better_ar/version.rb
 - test/helper.rb
 - test/test_finder_methods.rb