aggregate_columns 0.9

data/README

@@ -0,0 +1,91 @@
+Introduction
+============
+
+This gem provides a nice API to create complicated SQL queries for associated
+and aggregated tables.
+
+Example
+=======
+
+Take a classic example:
+
+class Post
+	has_many :comments
+	has_many :tags
+end
+
+Now let's say you want to display a table with some posts' attributes including
+number of comments.  Normally you would use post.comments.count, but that
+generates separate query for each post. Alternatively you could use counter
+cache, but it can get out of sync plus it only works on this simple example,
+while you could also need the time of latest comment for each post.
+
+
+AggregateColumns solution would look like this:
+
+	Post.all( Post.aggregate_columns_options( :association => :comments ))
+
+This returns posts with additional column called "comment_count" containing (big
+surprise here) number of comments for each post. I'm taking advantage of the
+fact columns specified in :select option are reachable from fetched objects (but
+not type-casted, so comment_count will be a String).
+
+
+What if you did not want such a simple aggregation, but the one I already
+mentioned: time of latest comment for each post:
+
+	Post.all( Post.aggregate_columns_options( :association => :comments, :function => :max, :column => :created_at ))
+
+The name of aggregated column would be comments_created_at_max in this case, but
+it can be changed using :result_column option.
+
+
+Now something really complicated - sum of votes for comments whose authors are
+active. Here's where :conditions and :joins options come in handy:
+
+	Post.all( Post.aggregate_columns_options( 
+			:association => :comments, 
+			:function => :sum, 
+			:column => :votes, 
+			:joins => "INNER JOIN authors ON comments.author_id = authors.id",
+			:conditions => ["authors.active = ?", true],
+			:result_column => :comment_vote_count
+		)
+	)
+
+Important things to note here:
+* aggregate_column_options return :select, :joins and :order options, so those
+	cannot be used for other purposes
+* all options are used internally in aggregate subqueries, so they do not clash
+	with normal find options (other than aforementioned ones). This means you can
+	merge resulting options with eg. custom :conditions
+
+
+You may also define multiple aggregate columns in one call:
+
+	Post.aggregate_columns_options( 
+		{ :association => :comments, :function => :max, :column => :created_at },
+		{ :association => :tags, :result_column => :number_of_tags }
+	)
+
+
+Yet another method to combine aggregate columns with other find options is to use scopes:
+
+	Post.aggregate_columns_scope( :association => :comments ).scoped( ...
+
+Rails 3
+=======
+
+In Rails 3 you should use:
+	
+	Post.aggregate_colums( :association => :comments )
+
+which returns a full blown ActiveRecord::Relation object
+
+Thanks
+======
+
+Many thanks go to Stefan Nothegger and Sharewise project
+(http://www.sharewise.com), where the idea originates from.
+
+2010 Marek Janukowicz/Starware. Released under MIT license.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "aggregate_columns"
+  s.version = "0.9"
+  s.author = "Marek Janukowicz"
+  s.email = "marek@janukowicz.net"
+  s.homepage = "http://www.bitbucket.org/starware/aggregate_columns"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Create and use aggregate columns in Rails applications"
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README"]
+end
+
+desc 'Create gem'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc 'Run tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate RDoc documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AggregateColumns'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/aggregate_columns.rb

@@ -0,0 +1,104 @@
+module AggregateColumns
+
+  module MethodsRails2
+
+    def aggregate_columns_options( *aggregates )
+      all_joins = []
+      all_selects = ["#{table_name}.*"]
+      all_orders = []
+      aggregates.each do |options|
+        # Process options
+        options.assert_valid_keys( :association, :column, :function, :result_column, :join_type, :conditions, :joins, :order )
+        association = options[:association]
+        unless association
+          raise ArgumentError, "No association given" 
+        end
+        field = options[:column] || '*'
+        function = options[:function] || :count
+        result_column = options[:result_column]
+        unless result_column
+          # Defaults:
+          # count(*) on comments => comment_count
+          # sum(votes) on comment => comments_votes_sum
+          result_column ||= field == '*' ? "#{association.to_s.singularize}_#{function}" : "#{association}_#{field}_#{function}"
+        end
+        assoc_reflection = reflect_on_association( association )
+        foreign_key = assoc_reflection.primary_key_name # As stupid as it looks, this is actually correct
+        table_name = assoc_reflection.table_name
+        klass = assoc_reflection.klass
+        join_type = options[:join_type] || "LEFT" # TODO: check if in range of allowed values
+        order = options[:order] || "DESC"
+        conditions = options[:conditions]
+        joins = options[:joins]
+
+        # Now gather params for aggregate
+        all_joins << "#{join_type.to_s.upcase} JOIN (SELECT #{foreign_key}, #{function}(#{field}) AS #{result_column} FROM #{table_name} #{joins}#{" WHERE " + klass.sanitize_sql( conditions ) if conditions } GROUP BY #{foreign_key}) #{result_column}_join ON #{table_name}.id = #{result_column}_join.#{foreign_key}"
+        all_selects << result_column.to_s
+        all_orders << "#{result_column} #{order.to_s.upcase}"
+      end
+      return { :joins => all_joins.join( "\n" ), :select => all_selects.join( ', ' ), :order => all_orders.join( ', ' ) }
+    end
+
+    def aggregate_columns_scope( *aggregates )
+      scoped( aggregate_columns_options( *aggregates ))
+    end
+
+  end
+
+  module MethodsRails3
+
+    def aggregate_columns( *aggregates )
+      rel = self.select( "#{table_name}.*" )
+      aggregates.each do |options|
+        # Process options
+        options.assert_valid_keys( :association, :column, :function, :result_column, :join_type, :conditions, :joins, :order )
+        association = options[:association]
+        unless association
+          raise ArgumentError, "No association given" 
+        end
+        field = options[:column] || '*'
+        function = options[:function] || :count
+        result_column = options[:result_column]
+        unless result_column
+          # Defaults:
+          # count(*) on comments => comment_count
+          # sum(votes) on comment => comments_votes_sum
+          result_column ||= field == '*' ? "#{association.to_s.singularize}_#{function}" : "#{association}_#{field}_#{function}"
+        end
+        # TODO: this only works on ActiveRecord::Base classes - would be nice
+        # (and not that complicated) to make it work on ActiveRecord::Relation
+        # instances
+        assoc_reflection = reflect_on_association( association )
+        foreign_key = assoc_reflection.primary_key_name # As stupid as it looks, this is actually correct
+        aggregate_table_name = assoc_reflection.table_name
+        klass = assoc_reflection.klass
+        join_type = options[:join_type] || "LEFT" # TODO: check if in range of allowed values
+        order = options[:order] || "DESC"
+        conditions = options[:conditions]
+        joins = options[:joins]
+
+        # Now gather params for aggregate
+        rel = rel.
+          joins( "#{join_type.to_s.upcase} JOIN (SELECT #{foreign_key}, #{function}(#{field}) AS #{result_column} FROM #{aggregate_table_name} #{joins}#{" WHERE " + klass.sanitize_sql( conditions ) if conditions } GROUP BY #{foreign_key}) #{result_column}_join ON #{table_name}.id = #{result_column}_join.#{foreign_key}" ).
+          select( result_column.to_s ).
+          order( "#{result_column} #{order.to_s.upcase}" )
+      end
+      return rel
+    end
+  end
+
+end
+
+# All versions
+ActiveRecord::Base.send( :extend, AggregateColumns::MethodsRails2 )
+if defined?( ActiveRecord::Relation )
+  ActiveRecord::Base.send( :extend, AggregateColumns::MethodsRails3 )
+end
+
+## Rails 2
+#if defined?( ActiveRecord::NamedScope )
+#  ActiveRecord::Associations::AssociationCollection.send( :include, AggregateColumns::MethodsRails2 )
+#  ActiveRecord::NamedScope::Scope.send( :include, AggregateColumns::MethodsRails2 ) 
+## Rails 3
+#ActiveRecord::Associations::CollectionProxy.send( :include, AggregateColumns::Methods ) if defined?( ActiveRecord::Associations::CollectionProxy )
+#ActiveRecord::Relation.send( :include, AggregateColumns::Methods ) if defined?( ActiveRecord::Relation )

data/test/aggregate_columns_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+class AggregateColumnsTest < ActiveSupport::TestCase
+
+  class Post < FakeModel
+  end
+
+  class User < FakeModel
+    has_many :posts
+  end
+
+  def setup
+    @user = User.new
+  end
+
+  test "empty options" do
+    options = User.aggregate_columns_options
+    assert_equal "users.*", options[:select]
+    assert options[:order].blank?
+    assert options[:joins].blank?
+  end
+
+  test "empty hash as options should fail" do
+    assert_raise( ArgumentError ) do
+      options = User.aggregate_columns_options( {} )
+    end
+  end
+
+  test "only association" do
+    options = User.aggregate_columns_options( :association => :posts )
+    assert_equal "users.*, post_count", options[:select]
+    assert_equal "post_count DESC", options[:order]
+    assert_equal "LEFT JOIN (SELECT user_id, count(*) AS post_count FROM posts  GROUP BY user_id) post_count_join ON posts.id = post_count_join.user_id", options[:joins]
+  end
+
+  test "column function" do
+    options = User.aggregate_columns_options( :association => :posts, :column => :created_at, :function => :max )
+    assert_equal "users.*, posts_created_at_max", options[:select]
+    assert_equal "posts_created_at_max DESC", options[:order]
+    assert_equal "LEFT JOIN (SELECT user_id, max(created_at) AS posts_created_at_max FROM posts  GROUP BY user_id) posts_created_at_max_join ON posts.id = posts_created_at_max_join.user_id", options[:joins]
+  end
+
+  test "result_column" do
+    options = User.aggregate_columns_options( :association => :posts, :column => :created_at, :function => :max, :result_column => "last_post_time" )
+    assert_equal "users.*, last_post_time", options[:select]
+    assert_equal "last_post_time DESC", options[:order]
+    assert_equal "LEFT JOIN (SELECT user_id, max(created_at) AS last_post_time FROM posts  GROUP BY user_id) last_post_time_join ON posts.id = last_post_time_join.user_id", options[:joins]
+  end
+
+  test "join_type" do
+    options = User.aggregate_columns_options( :association => :posts, :column => :created_at, :function => :max, :join_type => "RIGHT" )
+    assert_equal "users.*, posts_created_at_max", options[:select]
+    assert_equal "posts_created_at_max DESC", options[:order]
+    assert_equal "RIGHT JOIN (SELECT user_id, max(created_at) AS posts_created_at_max FROM posts  GROUP BY user_id) posts_created_at_max_join ON posts.id = posts_created_at_max_join.user_id", options[:joins]
+  end
+
+  test "conditions" do
+    options = User.aggregate_columns_options( :association => :posts, :column => :created_at, :function => :max, :conditions => { :active => true } )
+    assert_equal "users.*, posts_created_at_max", options[:select]
+    assert_equal "posts_created_at_max DESC", options[:order]
+    assert_equal "LEFT JOIN (SELECT user_id, max(created_at) AS posts_created_at_max FROM posts  WHERE posts.active = true GROUP BY user_id) posts_created_at_max_join ON posts.id = posts_created_at_max_join.user_id", options[:joins]
+  end
+
+  test "joins" do
+    time = 2.days.ago
+    options = User.aggregate_columns_options( :association => :posts, :column => :created_at, :function => :max, :joins => "INNER JOIN comments ON comments.post_id = posts.id", :conditions => ["comments.updated_at > ?", time] )
+    assert_equal "users.*, posts_created_at_max", options[:select]
+    assert_equal "posts_created_at_max DESC", options[:order]
+    assert_equal "LEFT JOIN (SELECT user_id, max(created_at) AS posts_created_at_max FROM posts INNER JOIN comments ON comments.post_id = posts.id WHERE comments.updated_at > #{time} GROUP BY user_id) posts_created_at_max_join ON posts.id = posts_created_at_max_join.user_id", options[:joins]
+  end
+
+  test "order" do
+    options = User.aggregate_columns_options( :association => :posts, :order => :asc )
+    assert_equal "users.*, post_count", options[:select]
+    assert_equal "post_count ASC", options[:order]
+    assert_equal "LEFT JOIN (SELECT user_id, count(*) AS post_count FROM posts  GROUP BY user_id) post_count_join ON posts.id = post_count_join.user_id", options[:joins]
+  end
+
+  # TODO:
+  # test multiple aggregates
+  # test with real database
+end

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'test/unit'
+gem 'activesupport', "< 3.0.0"
+require 'active_support/test_case'
+require 'active_record'
+require 'active_record/base'
+require 'aggregate_columns'
+
+# Class faking AR model behavior - needed to test without the database
+class FakeModel < ActiveRecord::Base
+
+  class FakeConnection
+    
+    def quote_column_name( column )
+      column
+    end
+
+    def quote( str )
+      str
+    end
+  end
+
+  self.abstract_class = true
+
+  def self.columns
+    @columns ||= [];
+  end
+
+  def self.column(name, sql_type = nil, default = nil, null = true)
+    columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
+  end
+
+  def self.quoted_table_name
+    table_name
+  end
+
+  def self.connection
+    @@connection ||= FakeConnection.new
+  end
+
+end
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: aggregate_columns
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  version: "0.9"
+platform: ruby
+authors: 
+- Marek Janukowicz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-23 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: marek@janukowicz.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Rakefile
+- README
+- lib/aggregate_columns.rb
+- test/aggregate_columns_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://www.bitbucket.org/starware/aggregate_columns
+licenses: []
+
+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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Create and use aggregate columns in Rails applications
+test_files: []
+