mm-draft 0.1.5

data/Gemfile

@@ -0,0 +1,20 @@
+source :rubygems
+
+gem 'rake'
+gem 'bson_ext', '>= 1.6.4'
+gem 'multi_json', '>= 1.3.6'
+
+group :test do
+  gem 'jnunemaker-matchy', '>= 0.4', :require => 'matchy'
+  gem 'shoulda',           '>= 3.1.1'
+  gem 'mocha',             '>= 0.12.3'
+  gem 'database_cleaner',  '>= 0.8.0'
+end
+
+group :development do
+  gem "wirble"
+  gem "hirb"
+  gem "awesome_print"  
+end
+
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# MongoMapper Draft plugin
+
+Plugin for MongoMapper to have draft/published option on models.
+
+Works with ramdiv-mongo_mapper_acts_as_tree.
+
+NOTE: Since ramdiv-mongo_mapper_acts_as_tree hasn't been updated in a while, I will change this to support Oktavilla/mongo_mapper_tree instead (http://github.com/ramdiv/mongo_mapper_acts_as_tree)
+
+##Instance methods
+<pre>
+.draft?           - true/false
+.published?       - true/false
+.published_record - returns the published record) (or nil, if the document never has been published)
+.draft_record     - returns the draft record for a published record
+</pre>
+
+*draft_record* will return self if the draft? returns true
+*published_record* will return self if draft? returns false
+
+## Usage:
+Create record as normal.
+
+*.save* - Saves draft (with normal validation)
+
+*.publish* - Saves the current record as draft, creates a new published record (returns true/false, depending on validation of draft record)
+
+Validation is skipped on the published record, as the draft record should be checked for validations when saving.
+
+All records will be duplicated (draft + published) in the DB instead of beeing embedded documents, as embedding would limit the size to half of what MongoDB is capable of.
+
+Duplicating the records also gives the benefit of working directly on the published record. (although this isn't recommended, as it kind of breaks the draft/published structure)
+
+## Example
+
+### Model
+<pre>
+class Monkey
+  include MongoMapper::Document
+  plugin MongoMapper::Draft
+
+  key :name, String, :default => "test"
+end
+</pre>
+### Usage of model
+<pre>
+m = Monkey.new
+m.name = "Leif"
+m.save
+
+m.is_published? (will return false)
+m.publish (will return true/false)
+
+m.name = "Artn"
+m.save
+
+m.name # returns "Artn"
+
+m.published_model.name # returns "Leif"
+</pre>
+
+
+Copyright (c) 2011 Leif Ringstad, released under the MIT license

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rake'
+
+require File.join(File.dirname(__FILE__), 'lib', 'mongo_mapper', 'plugins', 'draft', 'version')
+
+require 'rake/testtask'
+namespace :test do
+  Rake::TestTask.new(:units) do |test|
+    test.libs << 'test'
+    test.ruby_opts << '-rubygems'
+    test.pattern = 'test/unit/**/test_*.rb'
+    test.verbose = true 
+  end
+
+#TODO Add performance
+  Rake::TestTask.new(:performance) do |test|
+    test.libs << 'test'
+    test.ruby_opts << '-rubygems'
+    test.pattern = 'test/performance/test/**/*.rb'
+    test.verbose = true 
+  end
+end
+
+task :default => 'test:units'
+
+desc 'Builds the gem'
+task :build do
+  sh 'gem build mm-draft.gemspec'
+  Dir.mkdir('pkg') unless File.directory?('pkg')
+  sh "mv mm-draft-#{MongoMapper::Draft::VERSION}.gem pkg/mm-draft-#{MongoMapper::Draft::VERSION}.gem"
+end
+
+desc 'Builds and Installs the gem'
+task :install => :build do
+  sh "gem install pkg/mm-draft-#{MongoMapper::Draft::VERSION}.gem"
+end

data/lib/draft.rb

@@ -0,0 +1,2 @@
+require 'mongo_mapper'
+require File.join(File.dirname(__FILE__), 'mongo_mapper/plugins/draft/draft')

data/lib/locale/en.yml

@@ -0,0 +1,6 @@
+en:
+  mongo_mapper:
+    errors:
+      messages:
+        draft:
+          todo: "TODO"

data/lib/mongo_mapper/plugins/draft/callbacks.rb

@@ -0,0 +1,12 @@
+module MongoMapper
+  module Plugins
+    module Draft
+      module Callbacks
+        extend ActiveSupport::Concern        
+        included do
+          before_destroy :unpublish        
+        end # included_do
+      end
+    end # Versioned
+  end # Module plugins
+end # module MongoMapper

data/lib/mongo_mapper/plugins/draft/draft.rb

@@ -0,0 +1,129 @@
+require File.join(File.dirname(__FILE__), 'callbacks')
+require File.join(File.dirname(__FILE__), 'keys')
+# I18n.load_path << File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'locale', 'en.yml'), __FILE__)
+
+module MongoMapper
+  module Plugins
+    module Draft
+
+      extend ActiveSupport::Concern
+
+      include MongoMapper::Plugins::Draft::Callbacks
+      include MongoMapper::Plugins::Draft::Keys
+
+      def draft?
+        self.draft
+      end
+      
+      def published?
+        if draft?
+          return false if self.draft_record_published_id == nil # save a query and return false
+          return true if (self.class.find(self.draft_record_published_id) != nil)
+        else
+          return true
+        end
+        false
+      end
+      
+      def publish
+        if (draft? == false) # don't publish non-drafts... 
+          return false
+        end
+        
+        if (self.changed?) # save any changes, in case publish is called directly instead of save
+          return false if (self.save == false)
+        end
+
+        
+        # if already published, keep some old data to update instead of insert
+        if (self.published?)
+          old_published_record = self.published_record
+          # support for mm-tree
+          # remove parents from previous published record
+          if (self.respond_to?("parent_id_field") && self.respond_to?("path_field") && self.respond_to?("depth_field"))
+            old_published_record.parent = nil
+            old_published_record.save
+          end
+          live_record = self.clone
+          live_record._id = self.published_record_id
+          live_record.created_at = old_published_record.created_at if self.respond_to?("created_at")
+        else
+          live_record = self.clone
+          live_record.created_at = Time.now.utc if self.respond_to?("created_at")
+        end
+
+        self.draft_record_published_id = live_record._id
+        self.class.skip_callback(:save, :before, :update_timestamps ) if self.respond_to?("updated_at")
+        self.save!
+        self.class.set_callback(:save, :before, :update_timestamps ) if self.respond_to?("updated_at")
+
+        if (self.respond_to?("parent_id_field") && self.respond_to?("path_field") && self.respond_to?("depth_field"))
+          # if so, remove the current parent (should have already been don)
+          # set parent to nil for live_record before setting "real" parent.
+          # live_record.parent = nil
+
+          if (self.parent != nil)
+            # no need to copy order value, as it's copied in the clone process
+            # check draft.parent.published_record != nil, and set as parent
+            if (self.parent != nil)
+              if (self.parent.published_record != nil)
+                live_record.parent = self.parent.published_record
+              end
+            end
+          end
+        end
+        
+        live_record.draft = false;
+        live_record.updated_at = Time.now.utc if self.respond_to?("updated_at")
+        live_record.save!
+        return true
+      end
+      
+      def published_record
+        if draft?
+          return nil if self.draft_record_published_id == nil # save a query and return nil of draft_record_published_id == nil
+          self.class.find(self.draft_record_published_id)
+        else
+          self
+        end
+      end
+
+      def published_record_id
+        if draft?
+          self.draft_record_published_id
+        else
+          self._id
+        end
+      end
+      
+      def draft_record
+        if draft?
+          self
+        else
+          self.class.all(:conditions => { :draft => true, :draft_record_published_id => self._id }).first
+        end
+      end
+      
+      def unpublish
+        published_rec = self.published_record
+        draft_rec = self.draft_record
+
+        self.class.skip_callback(:destroy, :before, :unpublish)
+        published_rec.destroy if published_rec != nil # destroy published record
+        self.class.set_callback(:destroy, :before, :unpublish)
+
+        draft_rec.draft_record_published_id = nil if draft_rec != nil # update draft record
+        draft_rec.save! if draft_rec != nil
+        # if draft?
+        #   published = self.class.find(self.draft_record_published_id)
+        #   published.destroy if (published != nil)
+        #   self.draft_record_published_id = nil
+        #   self.save! # remove draft_record_published_id
+        # else
+        #   self.draft_record.unpublish
+        # end
+      end
+
+    end # Module Draft
+  end # Module plugins
+end # module MongoMapper

data/lib/mongo_mapper/plugins/draft/keys.rb

@@ -0,0 +1,13 @@
+module MongoMapper
+  module Plugins
+    module Draft
+      module Keys
+        extend ActiveSupport::Concern        
+        included do
+          key :draft, Boolean, :default => true
+          key :draft_record_published_id, ObjectId # points to the live page version if draft == true. else NIL          
+        end # included_do
+      end # Keys
+    end # Versioned
+  end # Module plugins
+end # module MongoMapper

data/lib/mongo_mapper/plugins/draft/version.rb

@@ -0,0 +1,5 @@
+module MongoMapper
+  module Draft
+    VERSION = '0.1.5'
+  end
+end

data/test/models/monkey.rb

@@ -0,0 +1,10 @@
+class Monkey
+  include MongoMapper::Document
+  plugin MongoMapper::Plugins::Draft
+
+  attr_accessible :name
+  
+  key :name, String
+
+  timestamps!
+end

data/test/performance/models/monkey.rb

@@ -0,0 +1,9 @@
+class Monkey
+  include MongoMapper::Document
+  plugin MongoMapper::Plugins::Draft
+
+  attr_accessible :name, :age
+
+  key :name, String
+  key :age, Integer
+end

data/test/performance/models/monkey_no_draft.rb

@@ -0,0 +1,7 @@
+class MonkeyNoVersion
+  include MongoMapper::Document
+  attr_accessible :name, :age
+
+  key :name, String
+  key :age, Integer
+end

data/test/performance/performance_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'draft'
+
+Bundler.require(:default, :test)
+
+MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017)
+MongoMapper.database = "mm-draft-performance"
+
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each {|file| require file}
+
+DatabaseCleaner.strategy = :truncation

data/test/performance/test/read_write.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'performance_helper'))
+
+require 'benchmark'
+
+DatabaseCleaner.start
+
+Benchmark.bm(22) do |x|
+  ids_draft = []
+  ids_no_draft = []
+  
+  # Write performance
+  x.report("write without draft  ") do
+    500.times { |i| ids_no_draft << MonkeyNodraft.create(:name => "Baboo", :age => 12, ).id }
+  end
+  x.report("write with draft     ") do
+    500.times { |i| ids_draft << Monkey.create(:name => "Baboo", :age => 12, ).id }
+  end
+
+  # Read performance
+  x.report("read with draft      ") do
+    ids_draft.each { |id| Monkey.first(:id => id) }
+  end
+  x.report("read without draft   ") do
+    ids_no_draft.each { |id| MonkeyNodraft.first(:id => id) }
+  end
+end
+
+DatabaseCleaner.clean

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'draft'
+
+Bundler.require(:default, :test)
+
+MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017)
+MongoMapper.database = "mm-draft-test"
+
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each {|file| require file}
+
+DatabaseCleaner.strategy = :truncation
+
+class Test::Unit::TestCase
+  # Drop all collections after each test case.
+  def setup
+    DatabaseCleaner.start
+  end
+
+  def teardown
+    DatabaseCleaner.clean
+  end
+
+  # Make sure that each test case has a teardown
+  # method to clear the db after each test.
+  def inherited(base)
+    base.define_method setup do
+      super
+    end
+
+    base.define_method teardown do
+      super
+    end
+  end
+
+end

data/test/unit/test_draft.rb

@@ -0,0 +1,194 @@
+require 'test_helper'
+
+class DraftTest < Test::Unit::TestCase
+  context "draft monkey records" do
+    setup do
+      @monkey_1   = Monkey.create(:name => "Chip")
+      @monkey_2   = Monkey.create(:name => "Unaton")
+      @monkey_1.publish
+    end
+
+    should "have same name as draft" do
+      @monkey_1.name.should == "Chip"
+      @monkey_1.published_record.name.should == "Chip"
+      @monkey_1.published_record.name.should == @monkey_1.name
+    end
+
+    should "be published" do
+      @monkey_1.published_record.should_not == nil
+    end
+    
+    should "not have same created time as draft" do
+      @monkey_1.unpublish 
+      @monkey_1.publish
+      @monkey_1.created_at.should_not == @monkey_1.published_record.created_at
+    end
+    
+    should "not be published" do
+      @monkey_2.published?.should_not == true
+      @monkey_2.published_record.should == nil
+    end
+    
+    should "not be draft" do
+      @monkey_1.published_record.draft?.should_not == true
+    end
+    
+    should "be draft" do
+      @monkey_2.draft?.should == true
+    end
+    
+    should "rename draft only" do
+      @monkey_1.name = "Sagofon"
+      @monkey_1.published_record.should_not == nil
+      @monkey_1.name.should_not == @monkey_1.published_record.name
+    end
+    
+    should "rename both draft and published record" do
+      @monkey_1.name = "Sagofon"
+      @monkey_1.publish
+      @monkey_1.published_record.should_not == nil
+      @monkey_1.name.should == @monkey_1.published_record.name
+    end
+
+    should "have updated updated_at both published record" do
+      @monkey_1.name ="Kake"
+      @monkey_1.save
+      @monkey_1.publish
+      @monkey_1.published_record.updated_at.should_not == @monkey_1.updated_at
+    end
+
+    should "unpublish draft record" do
+      @monkey_1.unpublish
+      assert !@monkey_1.published?
+      @monkey_1.published_record_id.should == nil
+      @monkey_1.published_record.should == nil
+    end
+
+    should "unpublish published record directly" do
+      # It is recommended to unpublish a draft record instead of unpublising a published record
+      @monkey_1.publish # publish record again...
+      @monkey_1.published_record.unpublish
+      # reload monkey_1
+      @monkey_1.reload
+      @monkey_1.published?.should_not == true
+      @monkey_1.published_record_id.should == nil
+      @monkey_1.published_record.should == nil
+    end
+
+    should "destroy published record only" do
+      @monkey_2.publish
+      tmp_id = @monkey_2.published_record_id
+      @monkey_2.published_record.destroy
+      @monkey_2.reload
+      @monkey_2.published_record_id.should == nil
+      @monkey_2.published_record.should == nil
+      @monkey_2.name.should == "Unaton" # make sure we didn't loose the draft
+      @monkey_2.published?.should_not == true
+      @monkey_2.draft?.should == true
+      Monkey.find(tmp_id).should == nil
+    end
+
+    should "destroy draft and published record" do
+      @monkey_2.publish # publish record again...
+      tmp_draft_id = @monkey_2._id
+      tmp_published_id = @monkey_2.published_record_id
+      @monkey_2.destroy
+      # keep ID's in order to check that they are destroyed!
+      Monkey.find(tmp_draft_id).should == nil
+      Monkey.find(tmp_published_id).should == nil
+    end
+
+  end # context "draft monkey records" do
+    
+  # context "tree-record" do
+  #   setup do
+  #     @root_1     = Dog.create(:name => "Atmel")
+  #     @child_1    = Dog.create(:name => "ATmega644P", :parent => @root_1)
+  #     @child_2    = Dog.create(:name => "ATmega2561", :parent => @root_1)
+  #     @child_2_1  = Dog.create(:name => "ATtiny24", :parent => @child_2)
+  
+  #     @root_2     = Dog.create(:name => "ST Ericsson")
+  #     @child_3    = Dog.create(:name => "ISP1181B", :parent => @root_2)
+
+  #     @root_1.publish
+  #     @child_1.publish
+  #     @child_2.publish
+  #     @child_2_1.publish
+  #     @root_2.publish
+  #   end
+    
+  #   should "test draft record parents" do
+  #     assert_equal(@root_2, @child_3.parent)
+  #     assert_equal(@child_2, @child_2_1.parent)     
+  #   end
+
+  #   should "test parents for published records" do
+  #     assert_equal(@root_1.published_record, @child_1.published_record.parent)
+  #     assert_equal(@root_1.published_record, @child_2.published_record.parent)
+  #     assert_equal(@child_2.published_record, @child_2_1.published_record.parent)
+  #   end
+
+  #   should "move draft record to new parent, but keep published at old parent" do
+  #     @child_2.parent = @root_2
+      
+  #     assert !@root_2.is_or_is_ancestor_of?(@child_2_1)
+  #     assert !@child_2_1.is_or_is_descendant_of?(@root_2)
+  #     assert !@root_2.descendants.include?(@child_2_1)
+
+  #     @child_2.save
+  #     @child_2_1.reload
+
+  #     assert @root_2.is_or_is_ancestor_of?(@child_2_1)
+  #     assert @child_2_1.is_or_is_descendant_of?(@root_2)
+  #     assert @root_2.descendants.include?(@child_2_1)
+
+  #     # test published against root_1
+  #     assert @root_1.published_record.is_or_is_ancestor_of?(@child_2_1.published_record)
+  #     assert @child_2_1.published_record.is_or_is_descendant_of?(@root_1.published_record)
+  #     assert @root_1.published_record.descendants.include?(@child_2_1.published_record)     
+  #   end
+    
+  #   should "move both draft and published record to new parent" do
+  #     @child_2.parent = @root_2
+      
+  #     assert !@root_2.is_or_is_ancestor_of?(@child_2_1)
+  #     assert !@child_2_1.is_or_is_descendant_of?(@root_2)
+  #     assert !@root_2.descendants.include?(@child_2_1)
+
+  #     # can only test published after saving and publishing
+  #     @child_2.save
+  #     @child_2.publish # will also save
+  #     @child_2.reload
+  #     @child_2_1.reload
+
+  #     assert @root_2.is_or_is_ancestor_of?(@child_2_1)
+  #     assert @child_2_1.is_or_is_descendant_of?(@root_2)
+  #     assert @root_2.descendants.include?(@child_2_1)
+
+  #     assert @root_2.published_record.is_or_is_ancestor_of?(@child_2_1.published_record)
+  #     assert @child_2_1.published_record.is_or_is_descendant_of?(@root_2.published_record)
+  #     assert @root_2.published_record.descendants.include?(@child_2_1.published_record)
+  #   end
+    
+  #   should "set a record as a root and check for ancestor" do
+  #     @child_2.parent = nil
+      
+  #     assert !@root_2.is_or_is_ancestor_of?(@child_2_1)
+  #     assert !@child_2_1.is_or_is_descendant_of?(@root_2)
+  #     assert !@root_2.descendants.include?(@child_2_1)
+
+  #     # can only test published after saving and publishing
+  #     @child_2.save
+  #     @child_2.publish # will also save
+  #     @child_2.reload
+  #     @child_2_1.reload
+
+  #     assert @child_2.root?
+  #     assert @child_2.published_record.root?
+  #     assert @child_2_1.is_or_is_descendant_of?(@child_2)
+
+  #     assert !@root_1.published_record.is_or_is_ancestor_of?(@child_2_1.published_record)
+  #     assert !@child_2_1.published_record.is_or_is_descendant_of?(@root_1.published_record)
+  #     assert !@root_1.published_record.descendants.include?(@child_2_1.published_record)      
+  #   end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: mm-draft
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+  prerelease: 
+platform: ruby
+authors:
+- Leif Ringstad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: 
+email:
+- leifcr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/draft.rb
+- lib/locale/en.yml
+- lib/mongo_mapper/plugins/draft/callbacks.rb
+- lib/mongo_mapper/plugins/draft/draft.rb
+- lib/mongo_mapper/plugins/draft/keys.rb
+- lib/mongo_mapper/plugins/draft/version.rb
+- Gemfile
+- Rakefile
+- README.md
+- test/models/monkey.rb
+- test/performance/models/monkey.rb
+- test/performance/models/monkey_no_draft.rb
+- test/performance/performance_helper.rb
+- test/performance/test/read_write.rb
+- test/test_helper.rb
+- test/unit/test_draft.rb
+homepage: http://github.com/leifcr/mm-draft
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A MongoMapper extension adding draft/publishing support
+test_files:
+- test/models/monkey.rb
+- test/performance/models/monkey.rb
+- test/performance/models/monkey_no_draft.rb
+- test/performance/performance_helper.rb
+- test/performance/test/read_write.rb
+- test/test_helper.rb
+- test/unit/test_draft.rb