drafter 0.2.8 → 0.3.0

data/test/drafter/test_draft.rb

@@ -11,6 +11,7 @@ class TestDraft < Minitest::Unit::TestCase
 		describe "associations" do
 			it { must belong_to(:draftable) }
 			it { must have_many(:draft_uploads) }
+			# it { must have_many(:subdrafts).class_name("Draft") } TODO: fix foreign_key problem.
 		end
 	end
 
@@ -44,29 +45,76 @@ class TestDraft < Minitest::Unit::TestCase
 				@article_count = Article.count
 				@draft = @article.save_draft
 				@draft_count = Draft.count
-				@article = @draft.approve!
 			end
 
-			it "should create an article" do
-				assert_equal(@article_count + 1, Article.count)
-			end
+			describe "when the article has no comments" do
+				before do
+					@article = @draft.approve!
+				end
 
-			it "should return the saved article" do
-				assert_equal(Article, @article.class)
-			end
+				it "should create an article" do
+					assert_equal(@article_count + 1, Article.count)
+				end
 
-			it "should properly populate all the attributes" do
-				assert_equal("initial text", @article.text)
-			end
+				it "should return the saved article" do
+					assert_equal(Article, @article.class)
+				end
+
+				it "should properly populate all the attributes" do
+					assert_equal("initial text", @article.text)
+				end
 
-			it "should populate all the file uploads" do
-				assert_equal("foo.txt", @article.upload.filename)
-				assert_equal("foo foo foo", File.open(@article.upload.path).read)
+				it "should populate all the file uploads" do
+					assert_equal("foo.txt", @article.upload.filename)
+					assert_equal("foo foo foo", File.open(@article.upload.path).read)
+				end
+
+				it "should delete the article's draft" do
+					assert_equal(@draft_count - 1, Draft.count)
+					refute @article.reload.draft
+				end
 			end
 
-			it "should delete the article's draft" do
-				assert_equal(@draft_count - 1, Draft.count)
-				refute @article.reload.draft
+			describe "when the article has comments" do
+				before do
+					@article.comments.build(:text => "I'm a comment")
+					@comment_count = Comment.count
+					@article.save_draft
+					@article = @draft.approve!
+					@comment = Comment.last
+				end
+
+				it "should create an article" do
+					assert_equal(@article_count + 1, Article.count)
+				end
+
+				it "should create a comment" do
+					assert_equal(@comment_count + 1, Comment.count)
+				end
+
+				it "should return the saved article" do
+					assert_equal(Article, @article.class)
+				end
+
+				it "should properly re-associate the comment with the article" do
+					assert @article.reload.comments.include?(@comment)
+				end
+
+				it "should properly populate all the attributes" do
+					assert_equal("initial text", @article.text)
+				end
+
+				it "should populate all the file uploads" do
+					assert_equal("foo.txt", @article.upload.filename)
+					assert_equal("foo foo foo", File.open(@article.upload.path).read)
+				end
+
+				it "should delete the comment and article drafts" do
+					# Note: this isn't -1 because there were two drafts in play
+					# i.e. the article draft and the comment draft.
+					# assert_equal(@draft_count, Draft.count)
+					# refute @article.reload.draft
+				end
 			end
 		end
 
@@ -101,6 +149,130 @@ class TestDraft < Minitest::Unit::TestCase
 		end
 	end
 
+	describe "Restoring a draftable" do
+		before do
+			@article = Article.new(:text => "foo", :upload => file_upload)
+			@article.comments << Comment.new(:text => "comment 1", :upload => file_upload)
+			@article.comments << Comment.new(:text => "comment 2", :upload => file_upload)
+		end
+
+		describe "for an unsaved object" do
+			before do
+				@draft = @article.save_draft
+				@article = @draft.build_draftable
+			end
+
+			it "should build the object's attributes properly" do
+				assert_equal("foo", @article.text)
+			end
+
+			it "should build the object's files properly" do
+				assert_equal(file_upload.size, File.new(@article.upload.path).size)
+			end
+
+			it "should build the object's subobjects properly" do
+				assert_equal(2, @article.comments.length)
+				assert_equal("comment 1", @article.comments.first.text)
+				assert_equal("comment 2", @article.comments.second.text)
+			end
+
+			it "should build the subobjects' files properly" do
+				contents1 = File.new(@article.comments.first.upload.path).read
+				contents2 = File.new(@article.comments.second.upload.path).read
+				assert_equal("foo foo foo", contents1)
+				assert_equal("foo foo foo", contents2)
+			end
+
+			describe "add a new comment, save_draft and restore" do
+				before do
+	        @article.comments << Comment.new(:text => "comment 3")
+	        @draft = @article.save_draft
+	        @article = @draft.build_draftable
+				end
+
+				it "should build the object's attributes properly" do
+					assert_equal("foo", @article.text)
+				end
+
+				it "should build the object's files properly" do
+					assert_equal("foo foo foo", File.new(@article.upload.path).read)
+				end
+
+				it "should build the object's subobjects properly" do
+					assert_equal(3, @article.comments.length)
+					assert_equal("comment 1", @article.comments.first.text)
+					assert_equal("comment 2", @article.comments.second.text)
+					assert_equal("comment 3", @article.comments.third.text)
+				end
+
+				it "should build the subobjects' files properly" do
+					contents1 = File.new(@article.comments.first.upload.path).read
+					contents2 = File.new(@article.comments.second.upload.path).read
+					assert_equal("foo foo foo", contents1)
+					assert_equal("foo foo foo", contents2)
+				end
+
+				describe "save_draft and restore again" do
+					before do
+		        @article.text = "ChChChanges"
+		        @draft = @article.save_draft
+		        @article = @draft.build_draftable
+					end
+					it "should build the object's attributes properly" do
+						assert_equal("ChChChanges", @article.text)
+					end
+
+					it "should build the object's files properly" do
+						assert_equal("foo foo foo", File.new(@article.upload.path).read)
+					end
+
+					it "should build the object's subobjects properly" do
+						assert_equal(3, @article.comments.length)
+						assert_equal("comment 1", @article.comments.first.text)
+						assert_equal("comment 2", @article.comments.second.text)
+					end
+
+					it "should build the subobjects' files properly" do
+						contents1 = File.new(@article.comments.first.upload.path).read
+						contents2 = File.new(@article.comments.second.upload.path).read
+						assert_equal("foo foo foo", contents1)
+						assert_equal("foo foo foo", contents2)
+					end
+				end
+      end
+		end
+
+		describe "for a saved object" do
+			before do
+				@article.save!
+				@article.text = "flappa flap flap"
+				@draft = @article.save_draft
+				@article = @draft.build_draftable
+			end
+
+			it "should build the object's attributes properly" do
+				assert_equal("flappa flap flap", @article.text)
+			end
+
+			it "should build the object's files properly" do
+				assert_equal(file_upload.size, File.new(@article.upload.path).size)
+			end
+
+			it "should build the object's subobjects properly" do
+				assert_equal(2, @article.comments.length)
+				assert_equal("comment 1", @article.comments.first.text)
+				assert_equal("comment 2", @article.comments.second.text)
+			end
+
+			it "should build the subobjects' files properly" do
+				contents1 = File.new(@article.comments.first.upload.path).read
+				contents2 = File.new(@article.comments.second.upload.path).read
+				assert_equal("foo foo foo", contents1)
+				assert_equal("foo foo foo", contents2)
+			end
+		end
+	end
+
 	describe "Rejecting a draft" do
 		before do
 			@article = Article.new(

data/test/drafter/test_draftable.rb

@@ -11,28 +11,14 @@ class TestDraftable < MiniTest::Unit::TestCase
 			end
 		end
 
-		describe "without a :draft_title option" do
-			describe "instantiating" do
-				it "works" do
-					assert Post.new
-				end
-			end
-		end
-
 		it "should know it's draftable" do
 			assert Article.draftable?
 		end
-
-		describe "with a :draft_title argument" do
-			it "should know its :draft_title field" do
-				assert_equal(:text, Article.draftable_draft_title)
-			end
-		end
 	end
 
 	describe "A non-draftable ActiveRecord class" do
 		it "should know it's not draftable" do
-			refute Comment.draftable?
+			refute User.draftable?
 		end
 	end
 

data/test/drafter/test_id_hash.rb

@@ -0,0 +1,79 @@
+require 'helper'
+
+describe "Conditional id_hash output" do
+  describe "for an unapproved object" do
+    describe "with a draft attached" do
+      before do
+        @article = Article.new(:text => "I'm an article.")
+        @draft = @article.save_draft
+      end
+
+      it "should give back a :draft_id" do
+        assert_equal({:draft_id => @draft.to_param}, @article.id_hash)
+      end
+    end
+  end
+
+  describe "for a persisted object" do
+    describe "with a draft attached" do
+      before do
+        @article = Article.create(:text => "I'm an article.")
+        @article.text = "I am now an article with a draft"
+        @article.save_draft
+      end
+
+      it "should give back the article's :id in a Hash" do
+        assert_equal({:id => @article.to_param}, @article.id_hash)
+      end
+    end
+
+    describe "with no draft attached" do
+      before do
+        @article = Article.create(:text => "I'm an article.")
+      end
+
+      it "should give back the article's id in a Hash" do
+        assert_equal({:id => @article.to_param}, @article.id_hash)
+      end
+    end
+  end
+end
+
+describe "Conditional id_hash_as(:foo) output" do
+  describe "for an unapproved object" do
+    describe "with a draft attached" do
+      before do
+        @article = Article.new(:text => "I'm an article.")
+        @draft = @article.save_draft
+      end
+
+      it "should give back a :draft_foo_id" do
+        assert_equal({:draft_foo_id => @draft.to_param}, @article.id_hash_as(:foo))
+      end
+    end
+  end
+
+  describe "for a persisted object" do
+    describe "with a draft attached" do
+      before do
+        @article = Article.create(:text => "I'm an article.")
+        @article.text = "I am now an article with a draft"
+        @article.save_draft
+      end
+
+      it "should give back a :foo_id in a Hash" do
+        assert_equal({:foo_id => @article.to_param}, @article.id_hash_as(:foo))
+      end
+    end
+
+    describe "with no draft attached" do
+      before do
+        @article = Article.create(:text => "I'm an article.")
+      end
+
+      it "should give back the article's :foo_id in a Hash" do
+        assert_equal({:foo_id => @article.to_param}, @article.id_hash_as(:foo))
+      end
+    end
+  end
+end

data/test/drafter/test_subdrafts.rb

@@ -0,0 +1,178 @@
+require 'helper'
+
+class TestSubdrafts < Minitest::Unit::TestCase
+
+  describe "Saving a draft for an article" do
+    before do
+      @article = Article.new(:text => "I'm an article.")
+      @article_count = Article.count
+      @draft_count = Draft.count
+    end
+
+    describe "and attaching a comment" do
+      before do
+        @comment_count = Comment.count
+        @draft_upload_count = DraftUpload.count
+        @article.comments << Comment.new(:text => "What a great article!", :upload => file_upload)
+        @draft = @article.save_draft
+        @article_draft = Draft.first
+        @comment_draft = Draft.last
+      end
+
+      it "should not create a new comment" do
+        assert_equal(@comment_count, Comment.count)
+      end
+
+      it "should not create a new article" do
+        assert_equal(@article_count, Article.count)
+      end
+
+      it "should save drafts for the article and comment" do
+        assert_equal(@draft_count + 2, Draft.count)
+      end
+
+      it "should serialize the comment draft fields properly" do
+        assert @comment_draft.build_draftable.is_a? Comment
+        assert_equal("What a great article!", @comment_draft.text)
+      end
+
+      it "should save a draft upload for the comment's uploaded file" do
+        assert_equal(@draft_upload_count + 1, DraftUpload.count)
+        assert_equal(file_upload.size, File.new(@comment_draft.build_draftable.upload.path).size)
+      end
+
+      it "should correctly associate the comment draft with its parent" do
+        assert_equal(@article_draft, @comment_draft.parent)
+      end
+
+      describe "after calling build_draftable on a draft" do
+        before do
+          @article = @draft.build_draftable
+        end
+
+        it "should still have 1 comment on it" do
+          assert_equal(1, @article.comments.length)
+        end
+
+        describe "restoring the draft" do
+          it "should work" do
+            assert (@article = @draft.build_draftable).is_a? Article
+          end
+        end
+
+        describe "and adding another couple of comments" do
+          before do
+            @article.comments << Comment.new(:text => "SuperComment")
+            @draft = @article.save_draft
+            @article = @draft.build_draftable
+            @article.comments << Comment.new(:text => "AnotherComment")
+          end
+
+          it "should have 3 comments" do
+            assert_equal(3, @article.comments.length)
+            assert_equal("SuperComment", @article.comments.second.text)
+            assert_equal("AnotherComment", @article.comments.third.text)
+          end
+        end
+      end
+    end
+
+    describe "and attaching a @like, which is a polymorphic sub-object" do
+      before do
+        @like_count = Like.count
+        @article.save_draft
+        @like = Like.new(:likeable => @article)
+        @draft = @like.save_draft(@article.draft, :likes)
+        @article_draft = Draft.first
+        @like_draft = Draft.last
+      end
+
+      it "should save 2 new drafts" do
+        assert_equal(@draft_count + 2, Draft.count)
+      end
+
+      describe "restoring the like subdraft to the article" do
+        before do
+          @article = @article_draft.build_draftable
+        end
+
+        it "should work" do
+          assert_equal(1, @article.likes.length)
+        end
+      end
+
+      describe "approving the article (so we start from the top of the chain)" do
+        before do
+          @draft_count = Draft.count
+          @article_count = Article.count
+          @like_count = Like.count
+          @article_draft.approve!
+        end
+
+        it "should destroy the draft objects" do
+          assert_equal(@draft_count - 2, Draft.count)
+        end
+
+        it "should create a new article" do
+          assert_equal(@article_count + 1, Article.count)
+        end
+
+        it "should create a new Like" do
+          assert_equal(@like_count + 1, Like.count)
+        end
+      end
+
+    end
+
+    describe "and attaching a polymorphic sub-object with STI" do
+      before do
+        @really_like_count = ReallyLike.count
+        @article.save_draft
+        @really_like = ReallyLike.new(:likeable => @article)
+        @draft = @really_like.save_draft(@article.draft, :likes)
+        @article_draft = Draft.first
+        @really_like_draft = Draft.last
+      end
+
+      it "should save 2 new drafts" do
+        assert_equal(@draft_count + 2, Draft.count)
+      end
+
+      describe "restoring the like subdraft to the article" do
+        before do
+          @article = @article_draft.build_draftable
+        end
+
+        it "should work, using the parent class association" do
+          assert_equal(1, @article.likes.length)
+        end
+      end
+
+      describe "approving the article (so we start from the top of the chain)" do
+        before do
+          @draft_count = Draft.count
+          @article_count = Article.count
+          @like_count = Like.count
+          @really_like_count = ReallyLike.count
+          @article_draft.approve!
+        end
+
+        it "should destroy the draft objects" do
+          assert_equal(@draft_count - 2, Draft.count)
+        end
+
+        it "should create a new article" do
+          assert_equal(@article_count + 1, Article.count)
+        end
+
+        it "should create a new Like" do
+          assert_equal(@like_count + 1, Like.count)
+        end
+
+        it "should create a new ReallyLike" do
+          assert_equal(@really_like_count + 1, ReallyLike.count)
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -9,6 +9,7 @@ rescue Bundler::BundlerError => e
 end
 require 'minitest/spec'
 require 'debugger'
+require 'database_cleaner'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -32,7 +33,17 @@ load File.dirname(__FILE__) + '/support/uploader.rb'
 load File.dirname(__FILE__) + '/support/models.rb'
 load File.dirname(__FILE__) + '/support/data.rb'
 
-class MiniTest::Unit::TestCase
+DatabaseCleaner.strategy = :transaction
+
+class MiniTest::Spec
+
+  before :each do
+    DatabaseCleaner.start
+  end
+
+  after :each do
+    DatabaseCleaner.clean
+  end
 
   # Pull in shoulda matchers for minitest.
   #
@@ -49,10 +60,4 @@ class MiniTest::Unit::TestCase
 
 end
 
-MiniTest::Unit.autorun
-
-# Turn.config do |c|
-#  c.format  = :outline
-#  c.trace   = false
-#  c.natural = true
-# end
+MiniTest::Unit.autorun

data/test/support/models.rb

@@ -2,22 +2,48 @@
 
 # A draftable article class
 class Article < ActiveRecord::Base
+	draftable
+  approves_drafts_for :comments
+
+  has_many :comments
+  has_many :likes, :as => :likeable
+  has_many :really_likes
 
   validates_presence_of :text
+	mount_uploader :upload, Uploader
+end
 
-	draftable :draft_title => :text
+# A draftable comment class which belongs to Article.
+#
+# We can use this to test out has_many associations.
+class Comment < ActiveRecord::Base
+  draftable
 
-	mount_uploader :upload, Uploader
+  belongs_to :article
+  has_many :likes, :as => :likeable
+
+  mount_uploader :upload, Uploader
 
 end
 
-class Post < ActiveRecord::Base
+# A class which allows us to test whether we can restore a polymorphic
+# has_many relationship.
+class Like < ActiveRecord::Base
 
-  draftable
+  draftable(:polymorphic_as => :likeable)
+
+  belongs_to :likeable, :polymorphic => true
+
+  validates_presence_of :likeable
 
 end
 
+# A class which allows us to test whether we can restore a polymorphic
+# has_many relationship with STI involved.
+class ReallyLike < Like
 
-# A non-draftable comment class
-class Comment < ActiveRecord::Base
+end
+
+# A non-draftable class
+class User < ActiveRecord::Base
 end

data/test/support/schema.rb

@@ -2,20 +2,12 @@
 ActiveRecord::Schema.define do
   self.verbose = false
 
-  create_table :articles, :force => true do |t|
-    t.string :text
-    t.string :upload
-    t.timestamps
-  end
-
-  create_table :posts, :force => true do |t|
-    t.string :text
-    t.timestamps
-  end
-
+  # These ones are the tables that the library really relies on.
   create_table :drafts, :force => true do |t|
-  	t.text :data
-  	t.references :draftable, :polymorphic => true
+    t.integer :parent_id
+    t.string  :parent_association_name
+    t.text :data
+    t.references :draftable, :polymorphic => true
   end
 
   change_table :drafts do |t|
@@ -29,8 +21,26 @@ ActiveRecord::Schema.define do
     t.string :file_data
   end
 
+  # From here down, we use them for testing purposes only.
+  create_table :articles, :force => true do |t|
+    t.string :text
+    t.string :upload
+    t.timestamps
+  end
+
+  create_table :users, :force => true do |t|
+    t.string :email
+    t.timestamps
+  end
+
   create_table :comments, :force => true do |t|
+    t.integer :article_id
+    t.string  :upload
     t.string :text
   end
 
+  create_table :likes, :force => true do |t|
+    t.references :likeable, :polymorphic => true
+  end
+
 end

data/test/test_drafter.rb

@@ -10,7 +10,7 @@ class TestDrafter < MiniTest::Unit::TestCase
 
   describe "A non-draftable class" do
     it "does not respond to :save_draft" do
-      refute Comment.new.respond_to?(:save_draft)
+      refute User.new.respond_to?(:save_draft)
     end
   end