active_record_helpers 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+spec/debug.log
+spec/db/active_record_helpers.sqlite3.db

data/README.rdoc

@@ -0,0 +1,72 @@
+active_record_helpers plugin provides a bunch of helpful methods.
+
+== Class Methods
+
+=== ids(field = "id")
+
+Returns an array of the values of field converted to Integer
+
+  >> Deathmatch.finished.recent.ids
+  => [505, 501, 500]
+  >> Deathmatch.finished.recent.ids(:map_id)
+  => [4, 4, 6]
+
+=== attribute(field)
+
+Returns an array of the field's raw values
+
+  >> Player.scoped(:limit => 3, :order => 'rating desc').attribute(:name)
+  => ["boffy", "pitibo", "macovsky"]
+
+=== attributes(fields)
+
+Returns an array of record hashes with the column names as keys and column raw values as values
+
+  >> Deathmatch.finished.last.players.scoped(:limit => 3, :order => 'frags desc').attributes(:name, :frags)
+  => [{"name" => "boffy", :frags => "35"}, {"name" => "pitibo", "frags" => "34"}, {"name" => "macovsky", "frags" => "33"}]
+  
+All of these methods work fast because they don't instantiate ActiveRecord objects.
+  
+They were originally made by Max Lapshin — http://github.com/maxlapshin
+
+=== update_all_counters
+
+Works as update_counters, but accepts the same arguments as update_all method. Consider examples:
+
+  Flow.update_all_counters({:rating => 1}, {:id => 3})
+  Flow.update_all_counters({:rating => 1, :votes_left => -1}, ["user_id=?", 3])
+  Post.update_all_counters({:rating => 1}, :order => "created_at", :limit => 100)
+
+=== select_fields
+
+Returns SQL-text for passing to :select option in finder
+
+  >> Player.select_fields(%w{id name frags})
+  => "players.id, players.title, players.permalink" 
+  >> Deathmatch.select_fields('id', 'players.name as winner_name')
+  => "deathmatches.id, players.name as winner_name"
+
+== Instance Methods
+
+=== to_poly_params
+
+Returns a hash for polymorphic conditions
+
+   >> User.first.to_poly_params
+   => {:resource_type=>"User", :resource_id=>3}
+   >> User.first.to_poly_params('post')
+   => {:post_id=>3, :post_type=>"User"}
+  
+=== Object#get_id
+
+It also adds a get_id method to Object useful in methods which can receive either an ActiveRecord instance or its id.
+
+  >> User.last.get_id
+  => 5
+  >> 5.get_id
+  => 5
+  
+== Installation
+
+  script/plugin install git://github.com/robotector/active_record_helpers.git
+  

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'  
+require 'rake'
+
+begin  
+  require 'jeweler'  
+  Jeweler::Tasks.new do |gemspec|  
+    gemspec.name = "active_record_helpers"  
+    gemspec.summary = "A bunch of helpful methods for ActiveRecord"  
+    gemspec.description = "A bunch of helpful methods for ActiveRecord"  
+    gemspec.email = "robotector@gmail.com"  
+    gemspec.homepage = "http://github.com/macovsky/active_record_helpers"  
+    gemspec.authors = ["Macovsky"]
+  end  
+  Jeweler::GemcutterTasks.new  
+rescue LoadError  
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"  
+end
+
+# require 'rake'
+# require 'spec/rake/spectask'
+# 
+# desc 'Default: run specs.'
+# task :default => :spec
+# 
+# desc 'Run the specs'
+# Spec::Rake::SpecTask.new(:spec) do |t|
+#   t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+#   t.spec_files = FileList['spec/**/*_spec.rb']
+# end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/active_record_helpers.rb

@@ -0,0 +1,68 @@
+module ActiveRecordHelpers
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+
+    # Returns an array of the values of field converted to Integer
+    # Works fast because it doesn't instantiate records and it goes well with scopes
+    # >> Deathmatch.finished.recent.ids
+    # => [505, 501, 500]
+    # >> Deathmatch.finished.recent.ids(:map_id)
+    # => [4, 4, 6]
+    def ids(field = "id")
+      attribute(field).map(&:to_i)
+    end
+    
+    # Returns an array of the field's raw values
+    # Works fast because it doesn't instantiate records and it goes well with scopes
+    # >> Player.scoped(:limit => 3, :order => 'rating desc').attribute(:name)
+    # => ["boffy", "pitibo", "macovsky"]
+    def attribute(field)
+      connection.select_values(send(:construct_finder_sql, :select => field))
+    end
+    
+    # Returns an array of record hashes with the column names as keys and column raw values as values
+    # Works fast because it doesn't instantiate records and it goes well with scopes
+    # >> Deathmatch.finished.last.players.scoped(:limit => 3, :order => 'frags desc').attributes(:name, :frags)
+    # => [{"name" => "boffy", "frags" => "35"}, {"name" => "pitibo", "frags" => "34"}, {"name" => "macovsky", "frags" => "33"}]
+    def attributes(*fields)
+      connection.send(:select_all, send(:construct_finder_sql, :select => select_fields(fields)))
+    end
+    
+    # Returns SQL-text for passing to :select option in finder
+    # >> Player.select_fields(%w{id name frags})
+    # => "players.id, players.title, players.permalink" 
+    # >> Deathmatch.select_fields('id', 'players.name as winner_name')
+    # => "deathmatches.id, players.name as winner_name"
+    def select_fields(*fields)
+      Array(fields).flatten.map{|field| column_names.include?(field.to_s) ? "#{table_name}.#{field}" : field }.join(', ')
+    end
+    
+    # Updates counters but accepts the same arguments as update_all method
+    # Flow.update_all_counters({:rating => 1}, {:id => 3})
+    # Flow.update_all_counters({:rating => 1, :votes_left => -1}, ["user_id=?", 3])
+    # Post.update_all_counters({:rating => 1}, :order => "created_at", :limit => 100)
+    def update_all_counters(counters, conditions = nil, options = {})
+      raise(ArgumentError, "counters should be provided in Hash") unless counters.is_a?(Hash)
+
+      updates = counters.inject([]) { |list, (counter_name, increment)|
+        sign = increment < 0 ? "-" : "+"
+        list << "#{connection.quote_column_name(counter_name)} = COALESCE(#{connection.quote_column_name(counter_name)}, 0) #{sign} #{increment.abs}"
+      }.join(", ")
+
+      update_all(updates, conditions, options)
+    end      
+    
+  end
+  
+  # returns a hash for polymorphic conditions
+  # >> User.first.to_poly_params
+  # => {:resource_type=>"User", :resource_id=>3}
+  # >> User.first.to_poly_params('post')
+  # => {:post_id=>3, :post_type=>"User"}
+  def to_poly_params(prefix = 'resource')
+    eval("{:#{prefix}_id => #{self.id}, :#{prefix}_type => '#{self.class.base_class}'}")
+  end
+end

data/lib/object_helpers.rb

@@ -0,0 +1,12 @@
+module ObjectHelpers
+  # using this method you can pass either an ActiveRecord object or it's id
+  # >> User.last.get_id
+  # => 5
+  # >> 5.get_id
+  # => 5
+  # >> nil.get_id
+  # => nil
+  def get_id(field="id")
+    is_a?(ActiveRecord::Base) ? send(field) : (self ? self.to_i : self)
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+ActiveRecord::Base.send(:include, ActiveRecordHelpers)
+Object.send(:include, ObjectHelpers)

data/spec/active_record_helpers_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Player < ActiveRecord::Base
+end
+
+describe ActiveRecordHelpers do
+  
+  context "with db" do
+  
+    before do
+      ['boffy', 30, 'pitibo', 29, 'macovsky', 21].in_groups_of(2) do |group|
+        Player.create(:name => group[0], :rating => group[1])
+      end
+    end
+  
+    it "ids should return players' ids" do
+      Player.ids.should == Player.all.map(&:id)
+    end
+    
+    it "ids(:rating) should return players' ratings as integers" do
+      Player.ids(:rating).should == Player.all.map(&:rating)
+    end
+  
+    it "attribute should return an array of players' attributes" do
+      Player.attribute(:name).should == Player.all.map(&:name)
+    end
+  
+    it "attributes should return an array of players' attributes in hashes" do
+      Player.attributes(:name, :rating).should == Player.all.map{|p| p.attributes_before_type_cast.slice("name", "rating")}
+    end  
+  
+    context "update_all_counters" do
+      it "should update a rating of one player" do
+        lambda {
+          Player.update_all_counters({:rating => 1}, {:name => 'boffy'})
+        }.should change{Player.find_by_name('boffy').rating}.by(1)
+      end
+      
+      it "should update ratings of all players" do
+        lambda {
+          Player.update_all_counters(:rating => 1)
+        }.should change{Player.ids(:rating)}.to([31, 30, 22])
+      end
+    end
+    
+    context "to_poly_params" do
+      before do
+        @player = Player.first
+      end
+      it "should return a hash of polymorphic conditions" do
+        @player.to_poly_params.should == {:resource_type => 'Player', :resource_id => @player.id}
+      end
+      
+      it "should return a hash of polymorphic conditions with defined prefix" do
+        @player.to_poly_params(:commentable).should == {:commentable_type => 'Player', :commentable_id => @player.id}
+      end
+    end
+    
+    context "get_id" do
+      it "should return an id of ActiveRecord object" do
+        @player = Player.first
+        
+        @player.get_id.should == @player.id
+      end
+      
+      it "should return a to_i" do
+        "5".get_id.should == 5
+        5.get_id.should == 5
+      end
+      
+      it "should return nil" do
+        nil.get_id.should == nil
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/db/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  :adapter: sqlite3
+  :database: vendor/plugins/active_record_helpers/spec/db/active_record_helpers.sqlite3.db

data/spec/db/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :players, :force => true do |t|
+    t.column :name, :string
+    t.column :rating, :integer, :default => 0
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+
+databases = YAML::load(IO.read(plugin_spec_dir + "/db/database.yml"))
+ActiveRecord::Base.establish_connection(databases[ENV["db"] || "sqlite3"])
+load(File.join(plugin_spec_dir, "db", "schema.rb"))

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: active_record_helpers
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Macovsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: A bunch of helpful methods for ActiveRecord
+email: robotector@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/active_record_helpers.rb
+- lib/object_helpers.rb
+- rails/init.rb
+- spec/active_record_helpers_spec.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/macovsky/active_record_helpers
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A bunch of helpful methods for ActiveRecord
+test_files: 
+- spec/active_record_helpers_spec.rb
+- spec/db/schema.rb
+- spec/spec_helper.rb