couch_publish 0.0.1

data/lib/couch_publish/couch_publish.rb

@@ -0,0 +1,59 @@
+module CouchPublish
+  def self.included(base)
+    base.send :include, Memories unless base.ancestors.include? Memories
+  end
+
+  def publish!(&block)
+    self.milestone! &block
+  end
+  
+  # Returns true if this version is published
+  def published?
+    self.milestone? or self.milestone_commit?
+  end
+
+  # Returns true if this version has not been published
+  def draft?
+    not self.published?
+  end
+  
+  # Returns the latest version of the document that was published
+  def last_published_version
+    self.milestones.empty? ? nil : self.milestones.last.instance
+  end
+
+  # Has any of version of this document ever been published?
+  def previously_published?
+    not self.milestones.empty?
+  end
+
+  # Discard the working draft, and revert the document
+  # back to the last published version
+  def discard_draft!(&block)
+    discard_draft_exception_check
+    self.rollback_to_latest_milestone!
+    self.publish! &block
+    self
+  end
+
+  # Discard the working draft, and revert the document
+  # back to the last published state, but don't save.
+  # Note that if you save the document after calling this method, 
+  # you would still have to call the publish! method 
+  # if you want the revert to be published
+  def discard_draft
+    discard_draft_exception_check
+    self.rollback_to_latest_milestone
+    self
+  end
+
+  def published_versions
+    self.milestones
+  end
+
+  private
+  def discard_draft_exception_check
+    raise "The current version of the document is published. There is no working draft to discard!" if self.published?
+    raise "This document has never been published. If we discard the current draft, then we'd end up in an existential conundrum." unless self.previously_published?
+  end
+end

data/lib/couch_publish.rb

@@ -0,0 +1,2 @@
+require 'memories'
+require 'couch_publish/couch_publish'

data/spec/lib/couch_publish_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+describe CouchPublish do
+  context "given a document instance that includes CouchPublish" do
+        
+    describe "#publish!" do
+      before do
+        @doc = Article.create :title => 'test', :body => 'test test'
+      end
+
+      it "should create a milestone" do
+        @doc.milestones.length.should == 0
+        @doc.publish!
+        @doc.milestones.length.should == 1
+      end
+    end
+
+    describe "#published_versions" do
+      before do
+        @doc = Article.create :title => 'test', :body => 'test test'
+        @doc.publish!
+        @doc.title = 'test 2'
+        @doc.save
+        @doc.title = 'test 3'
+        @doc.save
+        @doc.publish!
+      end
+
+      it "should return all milestones" do
+        @doc.published_versions.should == @doc.milestones
+      end
+    end
+
+    
+    describe "#draft?" do
+      context "given a new document" do 
+        before do
+          @doc = Article.create :title => 't', :body => 't' 
+        end
+
+        it "should return true" do
+          @doc.draft?.should be_true
+        end
+      end
+
+      context "given a document that was just published" do 
+        before do
+          @doc = Article.create :title => 't', :body => 't' 
+          @doc.publish!
+        end
+
+        it "should return false" do
+          @doc.draft?.should be_false
+        end
+      end
+    end
+
+    describe "#published?" do
+      context "given a document that has been published" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+          @doc.publish!
+        end
+
+        it "should return true" do
+          @doc.published?.should be_true
+        end
+      end
+
+      context "given a document that has never been published" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+        end
+
+        it "should return false" do
+          @doc.published?.should be_false
+        end
+      end
+    end
+
+    describe "#last_published_version" do
+      context "given a document that has been published" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+          @doc.publish!
+          @doc.title = 'test 2'
+          @doc.save
+        end
+
+        it "should return the latest milestone" do
+          @doc.last_published_version.should == @doc.milestones.last.instance
+        end
+      end
+
+      context "given a document that has never been published" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+        end
+
+        it "should return nil" do
+          @doc.last_published_version.should be_nil
+        end
+      end
+    end
+    
+    describe "#discard_draft!" do
+      context "given a document whose current version is published" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+          @doc.publish!
+          @doc.title = 'test 2'
+          @doc.save
+          @doc.publish!
+        end
+
+        it "should raise an exception" do
+          proc {@doc.discard_draft!}.should raise_exception("The current version of the document is published. There is no working draft to discard!")
+        end
+      end
+
+      context "given a document that has never been published" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+        end
+
+        it "should raise an exception" do
+          proc {@doc.discard_draft!}.should raise_exception("This document has never been published. If we discard the current draft, then we'd end up in an existential conundrum.")
+        end
+      end
+
+      context "given a document whose current version is not published, but has previous published versions" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+          @doc.publish!
+          @doc.title = 'test 2'
+          @doc.save
+        end
+
+        it "should revert the current document to the previous publish state" do
+          @doc.discard_draft!.title.should == "test"
+        end
+
+        it "should mark the newly reverted version as published" do
+          @doc.discard_draft!.published?.should be_true
+        end
+      end
+    end
+    
+    describe "#discard_draft" do
+      context "given a document whose current version is published" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+          @doc.publish!
+          @doc.title = 'test 2'
+          @doc.save
+          @doc.publish!
+        end
+
+        it "should raise an exception" do
+          proc {@doc.discard_draft}.should raise_exception("The current version of the document is published. There is no working draft to discard!")
+        end
+      end
+
+      context "given a document that has never been published" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+        end
+
+        it "should raise an exception" do
+          proc {@doc.discard_draft}.should raise_exception("This document has never been published. If we discard the current draft, then we'd end up in an existential conundrum.")
+        end
+      end
+
+      context "given a document whose current version is not published, but has previous published versions" do
+        before do
+          @doc = Article.create :title => 'test', :body => 'test'
+          @doc.publish!
+          @doc.title = 'test 2'
+          @doc.save
+        end
+
+        it "should revert the current document to the previous publish state" do
+          @doc.discard_draft.title.should == "test"
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift './lib'
+require 'rspec'
+require 'couch_publish'
+
+COUCHDB_SERVER = CouchRest.new "http://admin:password@localhost:5984"
+COUCH_PUBLISH_TEST_DB = COUCHDB_SERVER.database!('couch_publish_test')
+
+class Article < CouchRest::Model::Base
+  use_database COUCH_PUBLISH_TEST_DB
+  include CouchPublish
+
+  property :title
+  property :body
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:each) do
+    COUCH_PUBLISH_TEST_DB.recreate!
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: couch_publish
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: memories
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  type: :runtime
+  version_requirements: *id001
+description: Rides on top of the `memories` gem to add simple publishing functionality with rollback and preview support.
+email: moonmaster9000@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/couch_publish.rb
+- lib/couch_publish/couch_publish.rb
+- spec/lib/couch_publish_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/moonmaster9000/couch_publish
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Publishing functionality for couchdb documents.
+test_files: 
+- spec/lib/couch_publish_spec.rb
+- spec/spec_helper.rb