in_place_relation 0.1.0 → 0.1.1

data/.hgignore

@@ -0,0 +1,2 @@
+syntax: glob
+*swp

data/README

@@ -0,0 +1,19 @@
+# This module provides an in-place wrapper for ActiveRecord::Relation.
+# 
+# So instead of doing this:
+# rel = SomeModel.where( ... )
+# rel = rel.joins(...).where(...) if x
+# rel = rel.select(...) unless y
+# rel = rel.merge( another_rel )
+# rel.all
+# 
+# you can do this:
+# rel = SomeModel.where( ... ).in_place
+# rel.joins(...).where(...) if x
+# rel.select(...) unless y
+# rel.merge( another_rel )
+# rel.all
+#
+# All ActiveRecord::Relation methods are either wrapped and return wrapper
+# itself or are passed directly to underlying relation object. In rare case you
+# might want to access this relation object directly, use #relation method

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+# Now I have no idea why this doesn't work without specifying the task explicitly
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = true
+end

data/in_place_relation.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
   s.executables   = `hg manifest | grep ^bin`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
+	s.add_development_dependency "activerecord-nulldb-adapter"
   s.add_runtime_dependency "activerecord", ">= 3"
 end

data/lib/in_place_relation.rb

@@ -1,17 +1,5 @@
 require "in_place_relation/version"
 
-# This module provides an in-place wrapper for ActiveRecord::Relation. So
-# instead of doing this:
-# rel = SomeModel.where( ... )
-# rel = rel.joins().where() if x
-# rel = rel.select() unless y
-# rel.all
-#
-# you can do this
-# rel = SomeModel.where( ... ).in_place
-# rel.joins().where() if x
-# rel.select() unless y
-# rel.all
 #
 # and get original relation with:
 # rel.relation   # ActiveRecord::Relation
@@ -20,17 +8,21 @@ module InPlaceRelation
   module Methods
 
     def in_place
-      return Wrapper.new( self )
+      # To keep things unified we always want a Relation here even if initial
+      # object was a model class or an association
+      rel = self.is_a?( ActiveRecord::Relation ) ? self : self.scoped
+      return Wrapper.new( rel )
     end
   end
 
   class Wrapper
 
+    # Wrapped ActiveRecord::Relation object
     attr_reader :relation
     
     METHODS_TO_WRAP = ActiveRecord::Relation::ASSOCIATION_METHODS + ActiveRecord::Relation::MULTI_VALUE_METHODS + ActiveRecord::Relation::SINGLE_VALUE_METHODS + [:merge]
 
-    METHODS_TO_WRAP.each do |meth|
+    METHODS_TO_WRAP.uniq.each do |meth|
       define_method( meth ) do |*args|
         @relation = @relation.send( meth, *args )
         return self
@@ -49,6 +41,10 @@ module InPlaceRelation
       @relation.send( name, *args, &block )
     end
 
+    def in_place
+      return self
+    end
+
   end
 
 end

data/lib/in_place_relation/version.rb

@@ -1,3 +1,3 @@
 module InPlaceRelation
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/in_place_relation_test.rb

@@ -0,0 +1,118 @@
+require 'active_record'
+require 'test/unit'
+require 'in_place_relation'
+
+# Workaround for nulldb Rails 3.1 incompatibility
+class Object
+
+  def returning( obj, &block )
+    obj.tap( &block )
+  end
+end
+
+class InPlaceRelationTest < Test::Unit::TestCase
+
+  ActiveRecord::Base.establish_connection :adapter => :nulldb
+
+  class Post < ActiveRecord::Base
+    has_many :comments
+  end
+
+  class Comment < ActiveRecord::Base
+    belongs_to :post
+  end
+
+  Post.connection.create_table "posts" do |t|
+    t.string :name
+    t.text :content
+    t.timestamps
+  end
+
+  Comment.connection.create_table "comments" do |t|
+    t.integer :post_id
+    t.string :title
+    t.text :content
+    t.timestamps
+  end
+
+  def test_on_class
+    rel = Post.in_place
+    oid = rel.object_id
+    rel.where( :id => 1 )
+    rel.joins( :comments )
+    rel.order( "id DESC" )
+    rel.limit( 20 )
+    rel.select( "DISTINCT posts.id" )
+    assert_equal oid, rel.object_id
+    assert_equal "posts.id = 1", rel.where_values.first.to_sql
+    #assert_equal "INNER JOIN comments ON comments.post_id = posts.id", rel.joins_values.first.to_sql
+    assert_equal "id DESC", rel.order_values.first
+    assert_equal 20, rel.limit_value
+    assert_equal "DISTINCT posts.id", rel.select_values.first
+  end
+
+  # This test doesn't work without database connection, probably passing schema
+  # to nulldb would suffice
+  def test_on_association
+    p = Post.create!( :id => 11 )
+    rel = p.comments.in_place
+    oid = rel.object_id
+    rel.where( :name => "NAME" )
+    rel.joins( :comments )
+    rel.order( "id DESC" )
+    rel.limit( 20 )
+    rel.select( "DISTINCT posts.id" )
+    assert_equal oid, rel.object_id
+    assert_equal "posts.id = 1", rel.where_sql
+    #assert_equal "INNER JOIN comments ON comments.post_id = posts.id", rel.joins_values.first.to_sql
+    assert_equal "id DESC", rel.order_values.first
+    assert_equal 20, rel.limit_value
+    assert_equal "DISTINCT posts.id", rel.select_values.first
+  end
+
+  def test_on_relation
+    rel = Post.where( :name => "some" ).in_place
+    oid = rel.object_id
+    rel.where( :id => 1 )
+    rel.joins( :comments )
+    rel.order( "id DESC" )
+    rel.limit( 20 )
+    rel.select( "DISTINCT posts.id" )
+    assert_equal oid, rel.object_id
+    assert_equal "WHERE posts.name = 'some' AND posts.id = 1", rel.where_sql
+    #assert_equal "INNER JOIN comments ON comments.post_id = posts.id", rel.joins_values.first.to_sql
+    assert_equal "id DESC", rel.order_values.first
+    assert_equal 20, rel.limit_value
+    assert_equal "DISTINCT posts.id", rel.select_values.first
+  end
+
+  def test_in_place_identity
+    rel = Comment.in_place
+    oid = rel.object_id
+    10.times { rel = rel.in_place }
+    assert_equal oid, rel.object_id
+  end
+
+  def test_where_chaining
+    rel = Post.where( :id => 1 ).in_place
+    rel.where( :id => 2, :name => "adsf" ).where( :created_at => "2011-01-01 00:00:00" ).where( "content LIKE ?", "%content word%" )
+    assert_equal "WHERE posts.id = 1 AND posts.id = 2 AND posts.name = 'adsf' AND posts.created_at = '2011-01-01 00:00:00' AND (content LIKE '%content word%')", rel.where_sql
+  end
+
+  def test_relation_identity
+    rel = Comment.where( :title => 'fdsa' )
+    wrap = rel.in_place
+    assert_equal rel.object_id, wrap.relation.object_id
+    assert_equal rel.where_sql, wrap.relation.where_sql
+  end
+
+  def test_merge
+    rel = Comment.where( :title => 'fdsa' )
+    wrap = Comment.where( :post_id => 43 ).in_place
+    oid = wrap.object_id
+    wrap.merge( rel )
+    assert_equal oid, wrap.object_id
+    assert_equal "WHERE comments.post_id = 43 AND comments.title = 'fdsa'", wrap.where_sql
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: in_place_relation
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Marek Janukowicz/Starware
@@ -15,13 +15,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-28 00:00:00 +01:00
+date: 2012-01-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: activerecord-nulldb-adapter
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,7 +45,7 @@ dependencies:
         - 3
         version: "3"
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 description: ActiveRecord::Relation wrapper that can be modified/combined in place
 email: 
 - marek@janukowicz.net
@@ -42,11 +56,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .hgignore
 - Gemfile
+- README
 - Rakefile
 - in_place_relation.gemspec
 - lib/in_place_relation.rb
 - lib/in_place_relation/version.rb
+- test/in_place_relation_test.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -81,5 +98,5 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A relation that can be changed in place
-test_files: []
-
+test_files: 
+- test/in_place_relation_test.rb