find_as_hashes 0.1.1 → 0.2.0

data/.gitignore

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

data/.travis.yml

@@ -4,3 +4,8 @@ rvm:
   - ree
   - ruby-head
   - rbx-2.0
+notifications:
+  # overriding this so that TST Media's email account doesn't get spammed
+  # feel free to add yourselves if you want in on this action
+  email:
+    - patrick.byrne@tstmedia.com

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    find_as_hashes (0.2.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    ansi (1.3.0)
+    arel (2.2.1)
+    bcrypt-ruby (3.0.1)
+    builder (3.0.0)
+    i18n (0.6.0)
+    multi_json (1.0.3)
+    rake (0.9.2)
+    shoulda (2.11.3)
+    sqlite3 (1.3.4)
+    turn (0.8.2)
+      ansi (>= 1.2.2)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler
+  find_as_hashes!
+  rake
+  shoulda
+  sqlite3
+  turn

data/README.markdown

@@ -5,10 +5,6 @@ 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
@@ -16,10 +12,10 @@ coerced (e.g., a tinyint column containing `1` will not be coerced into
 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.
+* `all_as_hashes` works similarly to `all`, but returns the results as
+  an array of hashes.
+* `first_as_hash` works similarly to `first`, but returns a hash of the
+  first matching record.
 
 [attrs_method]:http://api.rubyonrails.org/classes/ActiveRecord/Base.html#method-i-attributes
 
@@ -44,4 +40,7 @@ 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`.
 
+## Tests
 
+Run tests with `bundle exec rake test` (or just `rake test` if you're
+daring).

data/lib/find_as_hashes.rb

@@ -1,13 +1,17 @@
 require "find_as_hashes/version"
+require 'active_record'
 
-module ActiveRecord
-  module FinderMethods
-    def all_as_hashes
-      connection.select_all(to_sql)
-    end
+module FindAsHashes
+  def all_as_hashes
+    # TODO figure out a less hacky way than where(nil) of retrieveing existing relation stack without modifying it
+    relation_stack = where(nil)
+    connection.select_all(relation_stack.joins(relation_stack.includes_values).to_sql)
+  end
 
-    def first_as_hash
-      connection.select_one(limit(1).to_sql)
-    end
+  def first_as_hash
+    relation_stack = limit(1)
+    connection.select_one(relation_stack.joins(relation_stack.includes_values).to_sql)
   end
 end
+
+ActiveRecord::Base.extend FindAsHashes

data/lib/find_as_hashes/version.rb

@@ -1,3 +1,3 @@
 module FindAsHashes
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/find_as_hashes_test.rb

@@ -2,43 +2,97 @@ 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
+    context "on a relation" 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 an array of attribute hashes" do
-      assert_equal Array, @hashes.class
-      assert @hashes.all? { |hash| hash.class == Hash }
+      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
 
-    should "return the same number of results as `all`" do
-      assert_equal @records.size, @hashes.size
+    context "on a model" do
+      setup do
+        @records = User.all
+        @hashes = User.all_as_hashes
+      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
 
-    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"]
+    context "using `includes`" do
+      setup do
+      end
+
+      should "use the included relation in the query" do
+        assert_nothing_raised do
+          @hashes = User.includes(:role).where("roles.admin" => true).all_as_hashes
+          assert Role.where(@hashes.first["role_id"]).first.admin?
+        end
+      end
     end
   end
 
   context "#first_as_hash" do
-    setup do
-      relation = User.where(:active => false)
-      @record = relation.first
-      @hash = relation.first_as_hash
+    context "on a relation" 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
 
-    should "return a hash of attributes" do
-      assert_equal Hash, @hash.class
+    context "on a model" do
+      setup do
+        @record = User.first
+        @hash = User.first_as_hash
+      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
 
-    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"]
+    context "using `includes`" do
+      setup do
+      end
+
+      should "use the included relation in the query" do
+        assert_nothing_raised do
+          @hash = User.includes(:role).where("roles.admin" => true).first_as_hash
+          assert Role.where(@hash["role_id"]).first.admin?
+        end
+      end
     end
   end
 end

data/test/fixtures/roles.yml

@@ -0,0 +1,12 @@
+admin:
+  name: "Admin"
+  admin: true
+guest:
+  name: "Guest"
+  admin: false
+user:
+  name: "User"
+  admin: false
+staff:
+  name: "Corporate Staff"
+  admin: true

data/test/fixtures/users.yml

@@ -3,4 +3,5 @@ user<%= n %>:
   name: Example User <%= n %>
   birthday: <%= n.weeks.ago %>
   active: <%= n.even? %>
+  role_id: <%= Role.all.map(&:id)[n % 4] %>
 <% end %>

data/test/test_helper.rb

@@ -1,10 +1,9 @@
+require 'find_as_hashes'
 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
@@ -12,10 +11,26 @@ ActiveRecord::Schema.define do
     t.string :name
     t.date :birthday
     t.boolean :active
+    t.integer :role_id
+  end
+end
+
+ActiveRecord::Schema.define do
+  create_table :roles, :force => true do |t|
+    t.string :name
+    t.boolean :admin
   end
 end
 
 class User < ActiveRecord::Base
+  belongs_to :role
+end
+
+class Role < ActiveRecord::Base
+  has_many :user
 end
 
-Fixtures.create_fixtures "test/fixtures", :users
+# Rails 3.0 has Fixtures, Rails 3.1 has ActiveRecord::Fixtures
+fixtures_class = defined?(ActiveRecord::Fixtures) ? ActiveRecord::Fixtures : Fixtures
+fixtures_class.create_fixtures "test/fixtures", :roles
+fixtures_class.create_fixtures "test/fixtures", :users

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: find_as_hashes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-14 00:00:00.000000000Z
+date: 2011-09-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2153703280 !ruby/object:Gem::Requirement
+  requirement: &2151839880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153703280
+  version_requirements: *2151839880
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153702640 !ruby/object:Gem::Requirement
+  requirement: &2151839240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153702640
+  version_requirements: *2151839240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153702080 !ruby/object:Gem::Requirement
+  requirement: &2151838320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153702080
+  version_requirements: *2151838320
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &2153701320 !ruby/object:Gem::Requirement
+  requirement: &2151837220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153701320
+  version_requirements: *2151837220
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2153700720 !ruby/object:Gem::Requirement
+  requirement: &2151836140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153700720
+  version_requirements: *2151836140
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2153699760 !ruby/object:Gem::Requirement
+  requirement: &2151834680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153699760
+  version_requirements: *2151834680
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2153699080 !ruby/object:Gem::Requirement
+  requirement: &2151833560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153699080
+  version_requirements: *2151833560
 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.
@@ -100,12 +100,14 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- Gemfile.lock
 - 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/roles.yml
 - test/fixtures/users.yml
 - test/test_helper.rb
 homepage: https://github.com/tstmedia/find_as_hashes
@@ -122,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2685435975965919057
+      hash: -1576352960134467685
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -131,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2685435975965919057
+      hash: -1576352960134467685
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.6
@@ -141,5 +143,6 @@ summary: Provides ActiveRecord methods to return results as attribute hashes rat
   than instantiated ActiveRecord objects.
 test_files:
 - test/find_as_hashes_test.rb
+- test/fixtures/roles.yml
 - test/fixtures/users.yml
 - test/test_helper.rb