find_as_hashes 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - ruby-head
+  - rbx-2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in find_as_hashes.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,47 @@
+Adds methods to return attribute hashes rather than instantiated
+ActiveRecord objects. This is useful when working with large sets of
+records and you need the performance more than you need the convenience
+of your ActiveRecord methods.
+
+## Methods
+
+Both methods assume that you've constructed some sort of ARel-style
+query (e.g., regular queries like `Customer.where("balance" > 5000)` or
+scopes like `User.active`).
+
+The hashes that return are similar to the hash that returns with
+[`ActiveRecord::Base#attributes`][attrs_method], except values are not
+coerced (e.g., a tinyint column containing `1` will not be coerced into
+`true`). Strings, dates, and numbers will return as their appropriate
+Ruby object. Booleans will return the underlying representation and
+serialized objects will return as strings.
+
+* `all_as_hashes` performs the search that you've set up and returns the
+  results as an array of hashes.
+* `first_as_hash` performs the search that you've set up and returns a
+  hash of the first matching record.
+
+[attrs_method]:http://api.rubyonrails.org/classes/ActiveRecord/Base.html#method-i-attributes
+
+## Examples
+
+    > User.where(:email => nil).all_as_hashes
+    => [
+      {:id => 123, :name => "Joe User", :email => nil},
+      {:id => 456, :name => "Jane User", :email => nil}
+    ]
+
+    > User.where(:email => nil).first_as_hash
+    => {:id => 123, :name => "Joe User", :email => nil}
+
+## Effects
+
+These methods are not for everyday use, but for when speed of execution
+is more important than convenience, like heavy-duty reporting or
+processing lots of existing records.
+
+In one example, looping through 36,400 User records and accessing an
+attribute used 32% less memory and performed 17% quicker using
+`all_as_hashes` over `all`.
+
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.test_files = FileList["test/*_test.rb"]
+  test.verbose = true
+  # test.warning = true
+end
+
+task :default => :test

data/find_as_hashes.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "find_as_hashes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "find_as_hashes"
+  s.version     = FindAsHashes::VERSION
+  s.authors     = ["Patrick Byrne"]
+  s.email       = ["patrick.byrne@tstmedia.com"]
+  s.homepage    = "https://github.com/pbyrne/find_as_hashes"
+  s.summary     = %q{Provides ActiveRecord methods to return results as attribute hashes rather than instantiated ActiveRecord objects.}
+  s.description = %q{Provides ActiveRecord methods to return results as attribute hashes rather than instantiated ActiveRecord objects. Useful when working with very large sets of results to improve performance.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activerecord"
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "turn"
+  s.add_development_dependency "shoulda"
+  s.add_development_dependency "activesupport"
+  s.add_development_dependency "sqlite3"
+end

data/lib/find_as_hashes.rb

@@ -0,0 +1,13 @@
+require "find_as_hashes/version"
+
+module ActiveRecord
+  module FinderMethods
+    def all_as_hashes
+      connection.select_all(to_sql)
+    end
+
+    def first_as_hash
+      connection.select_one(limit(1).to_sql)
+    end
+  end
+end

data/lib/find_as_hashes/version.rb

@@ -0,0 +1,3 @@
+module FindAsHashes
+  VERSION = "0.1.0"
+end

data/test/find_as_hashes_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+class FindAsHashesTest < ActiveRecord::TestCase
+  context "#all_as_hashes" do
+    setup do
+      relation = User.where(:active => true)
+      @records = relation.all
+      @hashes = relation.all_as_hashes
+    end
+
+    should "return an array of attribute hashes" do
+      assert_equal Array, @hashes.class
+      assert @hashes.all? { |hash| hash.class == Hash }
+    end
+
+    should "return the same number of results as `all`" do
+      assert_equal @records.size, @hashes.size
+    end
+
+    should "return the same results as `all`" do
+      assert_equal @records.first.name_before_type_cast, @hashes.first["name"]
+      assert_equal @records.first.birthday_before_type_cast, @hashes.first["birthday"]
+      assert_equal @records.first.active_before_type_cast, @hashes.first["active"]
+    end
+  end
+
+  context "#first_as_hash" do
+    setup do
+      relation = User.where(:active => false)
+      @record = relation.first
+      @hash = relation.first_as_hash
+    end
+
+    should "return a hash of attributes" do
+      assert_equal Hash, @hash.class
+    end
+
+    should "return the same result as `first`" do
+      assert_equal @record.name_before_type_cast, @hash["name"]
+      assert_equal @record.birthday_before_type_cast, @hash["birthday"]
+      assert_equal @record.active_before_type_cast, @hash["active"]
+    end
+  end
+end

data/test/fixtures/users.yml

@@ -0,0 +1,6 @@
+<% (1..100).each do |n| %>
+user<%= n %>:
+  name: Example User <%= n %>
+  birthday: <%= n.weeks.ago %>
+  active: <%= n.even? %>
+<% end %>

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+require 'turn'
+require 'shoulda'
+require 'active_record'
+require 'active_record/fixtures'
+require 'sqlite3'
+require 'find_as_hashes'
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+ActiveRecord::Schema.define do
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.date :birthday
+    t.boolean :active
+  end
+end
+
+class User < ActiveRecord::Base
+end
+
+Fixtures.create_fixtures "test/fixtures", :users

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: find_as_hashes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Patrick Byrne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2153703340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153703340
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153702700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153702700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153702120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153702120
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &2153701380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153701380
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2153700760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153700760
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2153699800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153699800
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2153699080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153699080
+description: Provides ActiveRecord methods to return results as attribute hashes rather
+  than instantiated ActiveRecord objects. Useful when working with very large sets
+  of results to improve performance.
+email:
+- patrick.byrne@tstmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.markdown
+- Rakefile
+- find_as_hashes.gemspec
+- lib/find_as_hashes.rb
+- lib/find_as_hashes/version.rb
+- test/find_as_hashes_test.rb
+- test/fixtures/users.yml
+- test/test_helper.rb
+homepage: https://github.com/pbyrne/find_as_hashes
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2470055047066117578
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2470055047066117578
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Provides ActiveRecord methods to return results as attribute hashes rather
+  than instantiated ActiveRecord objects.
+test_files:
+- test/find_as_hashes_test.rb
+- test/fixtures/users.yml
+- test/test_helper.rb