select_extra_columns 0.0.1

data/CHANGELOG.markdown

@@ -0,0 +1,3 @@
+2010-03-07
+==========
+* First release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Kandada Boggu (KandadaBoggu.com)
+
+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,57 @@
+select_extra_columns
+====================
+
+Enhances the ActiveRecord finders to return join/aggregate/calculated columns along with standard table columns.  
+
+Installation
+============
+Use either the plugin or the gem installation method depending on your preference. If you're not sure, the plugin method is simpler. 
+
+    ./script/plugin install git://github.com/kandadaboggu/select_extra_column.git 
+
+### Via gem
+Add the following to your application's environment.rb:
+    config.gem "select_extra_column", :source => "http://gemcutter.org"
+
+Install the gem:
+    rake gems:install
+
+
+Usage
+=====
+
+## Getting Started
+
+### Enable select_extra_column in your ActiveRecord model.
+
+
+    class User < ActiveRecord::Base
+ 	  select_extra_columns
+ 	  has_many :posts 
+ 	  has_one :address
+    end
+
+    class Address < ActiveRecord::Base
+ 	  belongs_to :user 
+    end
+
+    class Post < ActiveRecord::Base
+ 	  belongs_to :user 
+    end
+
+
+### Now return the extra columns in your finders.
+
+    users = User.find(:all, :joins => :posts, :select => "users.*, count(posts.id) as post_count",
+                    :extra_columns => {:post_count => :integer} )
+    users.first.post_count # returns the post count
+
+    users = User.find(:all, :joins => :address, :select => "users.*, addresses.street as street, addresses.city as city",
+                    :extra_columns => {:street => :string, :city => :string } )
+    users.first.street # returns the street
+    users.first.city # returns the city
+
+
+
+Copyright (c) 2010 Kandada Boggu, released under the MIT license
+

data/init.rb

@@ -0,0 +1,3 @@
+require File.dirname( __FILE__ ) + "/lib/select_extra_columns"
+
+ActiveRecord::Base.send(:extend, SelectExtraColumns) unless ActiveRecord::Base.respond_to?(:select_extra_columns) 

data/lib/select_extra_columns.rb

@@ -0,0 +1,45 @@
+module SelectExtraColumns
+  def select_extra_columns
+    return if self.respond_to?(:find_every_with_extra_columns)
+    self.extend ClassMethods
+  end
+
+  module ClassMethods    
+    def self.extended(active_record_class)
+      class << active_record_class
+        class_inheritable_array(:klasses_with_extra_columns)
+        alias_method_chain :find_every, :extra_columns
+      end
+    end
+    
+    def find_every_with_extra_columns options
+      extra_columns = options.delete(:extra_columns)
+      return super if extra_columns.empty? 
+      klass_with_extra_columns(extra_columns).find_every(options)   
+    end
+    
+    def validate_find_options(options)
+      extra_columns = options.delete(:extra_columns)
+      super
+    ensure
+      options[:extra_columns]= extra_columns  if extra_columns
+    end
+        
+    def klass_with_extra_columns extra_columns
+      # look for the class in the cache.
+      p "1.0"
+      self.klasses_with_extra_columns.select do | class_details |
+        return class_details[1] if class_details[0] == extra_columns 
+      end
+      p "1.1"
+      self.columns # load the column definition
+      self.clone.tap do |klass|
+        extra_columns.each do |col_name, col_type|
+          # add the new column to `columns` list and `columns_hash` hash.
+          klass.columns << (klass.columns_hash[col_name.to_s] = ActiveRecord::ConnectionAdapters::Column.new(col_name.to_s, nil, col_type.to_s))
+        end
+        self.klasses_with_extra_columns = [[extra_columns, klass]] # add the class to the cache
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: select_extra_columns
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kandada Boggu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-07 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Enhances the ActiveRecord finders to return join/aggregate/calculated columns along with standard table columns.
+email: kandadaboggu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG.markdown
+- MIT-LICENSE
+- README.markdown
+- init.rb
+- lib/select_extra_columns.rb
+has_rdoc: true
+homepage: http://github.com/kandadaboggu/select_extra_columns
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Enhances the ActiveRecord finders to return join/aggregate/calculated columns along with standard table columns.
+test_files: []
+