select_extra_columns 0.0.6 → 0.0.7

data/CHANGELOG.markdown

@@ -1,12 +1,17 @@
-2010-04-11
+2010-03-11
+==========
+* Added support for `find_by_sql`.
+* Exposed `find_extra_columns_class` method.
+
+2010-03-10
 ==========
 * Added support for sharing `extra_columns` definition across finders
 
-2010-04-09
+2010-03-09
 ==========
 * Changed cloning to inheritance. 
 
-2010-04-09
+2010-03-09
 ==========
 * Added stricter validation for :extra_columns input.
 

data/README.markdown

@@ -60,7 +60,16 @@ Getting Started
     users.first.street 		# returns the street
     users.first.active 		# returns true/false
 
-
+	users = User.find_by_sql("SELECT A.*, count(B.id) as post_count 
+								FROM   users A, posts B 
+								WHERE  A.id = B.user_id AND B.ptype = 'public'
+								GROUP BY A.id
+									UNION 
+								SELECT A.*, count(B.id) as post_count 
+								FROM   users A, customer_posts B 
+								WHERE  A.id = B.user_id AND B.ptype = 'private'
+								GROUP BY A.id", 
+							:extra_columns => :post_count)
 Dynamically added column fields are read only. Any value set to these fields are ignored during save.
 
     user = User.first(:joins => :address, :select => "*, addresses.street as street",
@@ -127,12 +136,12 @@ You can declare the extra columns in your model and use them across finders
 
 Now `:user_info` and `:post_info` can be used in finders.
 
-    users = User.find(:all, :joins => :posts, :select => "users.*, count(posts.id) as post_count, max(posts.created_at) as last_post_at",
-                    :extra_columns => :post_info)
-
-    user = User.first(:joins => :address, :select => "users.*, addresses.street as street, addresses.city as city",
-                    :extra_columns => :address_info )
+    users = User.all(:joins => :posts, :extra_columns => :post_info 
+    				:select => "users.*, count(posts.id) as post_count, max(posts.created_at) as last_post_at")
 
+    user = User.first(:joins => :address, :extra_columns => :address_info, 
+    				:select => "users.*, addresses.street as street, addresses.city as city")
+	
 ## Naming conflicts
 When a symbol/string is passed as input to `:extra_columns` option, the finder uses cached `extra_columns` definition by the given name.
 If no definition is found, then finder creates a new `extra_columns` definition with the input as a column.
@@ -143,10 +152,13 @@ If no definition is found, then finder creates a new `extra_columns` definition
  	  extra_columns :post_count, [:post_count, :integer], :last_post_at => :datetime
  	end
 
-The finder call below,  `post_count` maps on to a column in the select list and a `extra_columns` definition. Finder chooses the `extra_columns` definition. 
-    users = User.find(:all, :joins => :posts, :select => "users.*, count(posts.id) as post_count, max(posts.created_at) as last_post_at",
+In the `finder` call below,  `post_count` maps on to a column name and a `extra_columns` definition name. Finder chooses the `extra_columns` definition. 
+    users = User.all(:joins => :posts, :select => "users.*, count(posts.id) as post_count, max(posts.created_at) as last_post_at",
                     :extra_columns => :post_count)
 
+## Accessing the extra column model
+The gem creates and caches a model for every unique `extra_column` configuration. This model can be accessed using the `find_extra_columns_class` method.
+	User.find_extra_columns_class(:post_count).find_by_sql("")
 
 ## Valid data types for column fields in `:extra_columns`   
 	:binary

data/lib/select_extra_columns.rb

@@ -5,38 +5,71 @@ module SelectExtraColumns
   end
 
   module ClassMethods    
-    def self.extended(active_record_class)
+    def self.extended(active_record_class) #:nodoc:
       class << active_record_class
         alias_method_chain :find_every, :extra_columns
+        alias_method_chain :find_by_sql,:extra_columns
       end
       active_record_class.class_inheritable_array(:klasses_with_extra_columns)
       active_record_class.klasses_with_extra_columns ||= []
     end
     
-    def find_every_with_extra_columns options
+    def find_every_with_extra_columns options #:nodoc:
       extra_columns = options.delete(:extra_columns)
-      return find_every_without_extra_columns options if extra_columns.nil? 
-      klass_with_extra_columns(extra_columns).send(:find_every, options)   
+      return find_every_without_extra_columns(options) if extra_columns.nil? 
+      find_or_create_extra_columns_class(extra_columns).send(:find_every, options)   
     end
     
-    def validate_find_options(options)
+    def find_by_sql_with_extra_columns sql, options={}
+      extra_columns = options.delete(:extra_columns)
+      return find_by_sql_without_extra_columns(sql) if extra_columns.nil? 
+      find_or_create_extra_columns_class(extra_columns).send(:find_by_sql, sql)         
+    end
+    
+    def validate_find_options(options) #:nodoc:
       extra_columns = options.delete(:extra_columns)
       super
     ensure
       options[:extra_columns]= extra_columns  if extra_columns
     end
         
-    def klass_with_extra_columns extra_columns
+    def find_or_create_extra_columns_class extra_columns #:nodoc:
       # look for the class in the cache.
-      (
-        [String, Symbol].include?(extra_columns.class) ? 
-          self.klasses_with_extra_columns.find{|k| k.extra_columns_key == extra_columns.to_s} :
-          self.klasses_with_extra_columns.find{|k| k.extra_columns == extra_columns}
-      ) or extra_columns_class(extra_columns)
+      find_extra_columns_class(extra_columns) || create_extra_columns_class(extra_columns)
     end
     
-    def extra_columns_class extra_columns, extra_columns_key=nil
-      extra_column_definitions = prepare_extra_column_definitions(extra_columns)
+    # Returns cached extra_column model. The argument can take two forms:
+    #
+    # * extra_column key - Key used to register the model using the call to extra_columns
+    # * extra_column key - Definition used in a prior query.
+    #
+    # ==== Examples
+    #   class Person < ActiveRecord::Base
+    #      select_extra_column
+    #      extra_column :address_info, :street, :city, :zip 
+    #   end
+    #   klass = Person.find_extra_columns_class(:address_info)
+    #   Person.find(:joins => :address, :select => "people.*, addresses.street, addresses.city, addresses.zip",
+    #                    :extra_columns = [:street, :city, :zip])
+    #   ...
+    #   ...
+    #   klass = Person.find_extra_columns_class([:street, :city, :zip])
+    #   klass.find_by_sql("..")
+    def find_extra_columns_class extra_columns
+      # look for the class in the cache.
+      [String, Symbol].include?(extra_columns.class) ? 
+        self.klasses_with_extra_columns.find{|k| k.extra_columns_key == extra_columns.to_s} :
+        self.klasses_with_extra_columns.find{|k| k.extra_columns == extra_columns}
+    end
+
+    # Creates and caches an extra_column model.
+    #
+    def extra_columns extra_columns_key, *args
+      create_extra_columns_class args.concat(args.extract_options!.to_a), extra_columns_key 
+    end    
+        
+    def create_extra_columns_class extra_columns, extra_columns_key=nil #:nodoc:
+      extra_column_definitions = create_extra_columns(extra_columns)
       return self if extra_column_definitions.empty?      
       read_only_attrs = extra_column_definitions.collect{|cd| ":#{cd.name}" }.join(",")
       klass_name      = "#{self.name}#{Time.now.to_i}#{extra_columns.hash.abs}"
@@ -57,11 +90,7 @@ module SelectExtraColumns
       end
     end
     
-    def extra_columns extra_columns_key, *args
-      extra_columns_class args.concat(args.extract_options!.to_a), extra_columns_key 
-    end
-
-    def prepare_extra_column_definitions extra_columns
+    def create_extra_columns extra_columns #:nodoc:
       extra_columns = [extra_columns] if extra_columns.is_a?(Symbol) or extra_columns.is_a?(String) 
       extra_columns = extra_columns.to_a if extra_columns.is_a?(Hash)
       return [] unless extra_columns.is_a?(Array)

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: 
 - Kandada Boggu
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-10 00:00:00 -08:00
+date: 2010-03-11 00:00:00 -08:00
 default_executable: 
 dependencies: []