select_extra_columns 0.0.5 → 0.0.6

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+2010-04-11
+==========
+* Added support for sharing `extra_columns` definition across finders
+
 2010-04-09
 ==========
 * Changed cloning to inheritance. 

data/README.markdown

@@ -7,9 +7,11 @@ Installation
 ============
 Use either the plugin or the gem installation method depending on your preference. If you're not sure, the plugin method is simpler. 
 
+## As a Plugin
+
     ./script/plugin install git://github.com/kandadaboggu/select_extra_column.git 
 
-### Via gem
+## As a Gem
 Add the following to your application's environment.rb:
     config.gem "select_extra_column", :source => "http://gemcutter.org"
 
@@ -17,12 +19,10 @@ Install the gem:
     rake gems:install
 
 
-Usage
-=====
-
-## Getting Started
+Getting Started
+===============
 
-### Enable select_extra_column in your ActiveRecord model.
+## Enable select_extra_column in your ActiveRecord model.
 
 
     class User < ActiveRecord::Base
@@ -40,7 +40,7 @@ Usage
     end
 
 
-### Now return the extra columns in your finders.
+## Use the extra columns in your finders.
 
     user = User.first(:joins => :address, :select => "*, addresses.street as street",
                     :extra_columns => :street)
@@ -78,7 +78,7 @@ Dynamically added column fields are read only. Any value set to these fields are
 	
 ### Input format for `:extra_columns` 
 
-Option accepts String/Symbol/Array/Hash as input.
+This option accepts `String`/`Symbol`/`Array`/`Hash` as input.
 
 
 #### String,Symbol format
@@ -113,7 +113,42 @@ Option accepts String/Symbol/Array/Hash as input.
 						[:has_flag,   :boolean]
 						]
 
-### Valid data types for column fields in `:extra_columns`   
+### Sharing `extra_columns` definition across finders
+You can declare the extra columns in your model and use them across finders
+    class User < ActiveRecord::Base
+ 	  select_extra_columns
+ 	  
+ 	  extra_columns :address_info, :street, :city
+ 	  extra_columns :post_info, [:post_count, :integer], :last_post_at => :datetime
+ 	  
+ 	  has_many :posts 
+ 	  has_one :address
+    end
+
+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 )
+
+## 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.
+ 
+    class User < ActiveRecord::Base
+ 	  select_extra_columns
+ 	  
+ 	  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",
+                    :extra_columns => :post_count)
+
+
+## Valid data types for column fields in `:extra_columns`   
 	:binary
 	:boolean
 	:date

data/lib/select_extra_columns.rb

@@ -28,11 +28,14 @@ module SelectExtraColumns
         
     def klass_with_extra_columns extra_columns
       # look for the class in the cache.
-      self.klasses_with_extra_columns.find{|k| k.extra_columns == extra_columns} or
-        prepare_extra_column_klass(extra_columns)
+      (
+        [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)
     end
     
-    def prepare_extra_column_klass extra_columns
+    def extra_columns_class extra_columns, extra_columns_key=nil
       extra_column_definitions = prepare_extra_column_definitions(extra_columns)
       return self if extra_column_definitions.empty?      
       read_only_attrs = extra_column_definitions.collect{|cd| ":#{cd.name}" }.join(",")
@@ -41,11 +44,12 @@ module SelectExtraColumns
         class ::#{klass_name} < #{self.name}
           set_table_name :#{self.table_name}
           attr_readonly #{read_only_attrs}
-          class_inheritable_accessor :extra_columns 
+          class_inheritable_accessor :extra_columns, :extra_columns_key 
         end
       RUBY
       klass_name.constantize.tap do |klass|
         klass.extra_columns = extra_columns.is_a?(Symbol) ? extra_columns : extra_columns.clone
+        klass.extra_columns_key = (extra_columns_key || klass_name).to_s
         extra_column_definitions.each do |ecd|
           klass.columns << (klass.columns_hash[ecd.name] = ecd)
         end
@@ -53,6 +57,10 @@ 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
       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)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Kandada Boggu
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-09 00:00:00 -08:00
+date: 2010-03-10 00:00:00 -08:00
 default_executable: 
 dependencies: []