arel-helpers 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea16c7f7e25c5cfbfffefce34a8c9533b0843476
-  data.tar.gz: 1166b9bbb46d3752cd1dfbbbdca2af9722a1dd71
+  metadata.gz: 2f4827c570f384201da3e8d5b4cb4ba128647338
+  data.tar.gz: 41862cd346409a675ce805be9be7b9bf870f1fad
 SHA512:
-  metadata.gz: d84deff5d029af7d5309206e2ad6d085b606cdf4e8f71f75339ccd1dad828f03fdf625021110fcbf20768fb7d77122877a649d9eaea533fc043acdd9f683d28f
-  data.tar.gz: e3fa334933b5792e55d222696401c53bda1ace66ec973da7c27b5fe738f8506269434265cceda4aefb38b71c1bc771288520ebebbdd391004bd0ee088d26deef
+  metadata.gz: 74e3d838e06893f725de391c378367693fb1b6215124eeae4ae0f9357347b044fd35d53eafc38673f0fab9c60c05b340c33d543496eec7be259d6230f20b8f80
+  data.tar.gz: 7aac06ec8e7433ed527cb81ab85aa269affb9bbc760b144565c35f36386d5bfee44264bc7c1e48bb015ca9ff6b36c037c594d06b7b54e84e336caab1f483b1b1

data/History.txt

@@ -18,3 +18,6 @@
 
 * Define ArelHelpers.join_association so people can use join_association functionality without relying on autoloading. (@peeja, github issue #8)
 
+== 2.0.2
+
+* Fix issue causing CollectionProxy#[] to return Arel::Attribute objects instead of model instances. See https://github.com/camertron/arel-helpers/pull/11

data/README.md

@@ -65,7 +65,7 @@ Things start to get messy however if you want to do an outer join instead of the
 Post
   .joins(
     Post.arel_table.join(Comments.arel_table, Arel::OuterJoin)
-      .on(Post[:id].eq(Coments[:post_id]))
+      .on(Post[:id].eq(Comments[:post_id]))
       .join_sources
   )
 ```

data/lib/arel-helpers.rb

@@ -2,6 +2,20 @@
 
 require 'active_record'
 
+begin
+  ar_version = if ActiveRecord::VERSION.const_defined?(:STRING)
+    ActiveRecord::VERSION::STRING
+  else
+    ActiveRecord.version.version
+  end
+
+  if ar_version >= '4.0.0'
+    require 'arel-helpers/ext/collection_proxy'
+  end
+rescue
+  puts 'ArelHelpers was unable to determine the version of ActiveRecord. You may encounter unexpected behavior.'
+end
+
 module ArelHelpers
   autoload :JoinAssociation, "arel-helpers/join_association"
   autoload :ArelTable,       "arel-helpers/arel_table"

data/lib/arel-helpers/ext/collection_proxy.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+
+# ActiveRecord as of version 4.0 defines a CollectionProxy class that
+# lazily fetches records from the database. If posts has many comments,
+# then post.comments returns a CollectionProxy that can be iterated over.
+# A query to fetch the pertinent records isn't fired until the iteration
+# starts, so post.comments itself isn't enough to cause a trip to the
+# database.
+#
+# ArelHelpers adds a [] method to ActiveRecord::Relation which means it
+# also adds the same method to CollectionProxy, since CollectionProxy
+# inherits from Relation. For some reason, CollectionProxy doesn't define
+# its own [] method but instead lets ActiveRecord's complicated Delegation
+# module handle calls to it via method_missing. In the post.comments case
+# illustrated above, a call to [] is handled by this method_missing:
+# https://github.com/rails/rails/blob/4-1-stable/activerecord/lib/active_record/relation/delegation.rb#L91
+# Here, @klass refers to the Comment model, which means [] calls on an
+# instance of CollectionProxy actually get re-routed. Instead of calling
+# [] on a CollectionProxy like we were expecting, it calls [] on Comment,
+# and therefore on the mixed-in ArelHelpers::ArelTable. The final result
+# is that the caller gets back an Arel::Attribute instead of the instance
+# of Comment they were expecting.
+#
+# This "simple" monkey patch defines [] on CollectionProxy so the convoluted
+# method_missing logic in Delegation doesn't get triggered, and therefore
+# doesn't end up returning an unexpected Arel::Attribute.
+module ActiveRecord
+  module Associations
+    class CollectionProxy < Relation
+      def [](index)
+        to_a[index]
+      end
+    end
+  end
+end

data/lib/arel-helpers/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module ArelHelpers
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/spec/arel_table_spec.rb

@@ -10,4 +10,15 @@ describe ArelHelpers::ArelTable do
       post_id.relation.name.should == "posts"
     end
   end
+
+  it "should not interfere with associations" do
+    post = Post.create(title: "I'm a little teapot")
+    post.comments[0].should be_nil
+  end
+
+  it "should allow retrieving associated records" do
+    post = Post.create(title: "I'm a little teapot")
+    comment = post.comments.create
+    post.reload.comments[0].id.should == comment.id
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arel-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,23 +38,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- History.txt
-- README.md
-- Rakefile
-- arel-helpers.gemspec
-- lib/arel-helpers.rb
 - lib/arel-helpers/arel_table.rb
+- lib/arel-helpers/ext/collection_proxy.rb
 - lib/arel-helpers/join_association.rb
 - lib/arel-helpers/query_builder.rb
 - lib/arel-helpers/version.rb
+- lib/arel-helpers.rb
 - spec/arel_table_spec.rb
-- spec/env.rb
 - spec/env/migrations.rb
 - spec/env/models.rb
+- spec/env.rb
 - spec/join_association_spec.rb
 - spec/query_builder_spec.rb
 - spec/spec_helper.rb
+- Gemfile
+- History.txt
+- README.md
+- Rakefile
+- arel-helpers.gemspec
 homepage: http://github.com/camertron
 licenses: []
 metadata: {}
@@ -74,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Useful tools to help construct database queries with ActiveRecord and Arel.