mongoid_revisions 0.0.1 → 0.0.2

data/README.md

@@ -25,12 +25,47 @@ To add support for revisions to a Mongoid documents, include the module to your
 
 This gem adds to your Mongoid document the following attributes:
 
-- revision
+- revision (read only)
 - tag
-- token
+- token (read only)
+
+and the following methods:
+
+- revisions
+- tag_version
+- revise
+
+Token is a randomly generated string that is common to all revisions of the same document and it is wirte protected to preserve the functionality of this library.
+
+Simply call the revise method
+
+ ```ruby
+	last_comment_revision=@comment.revise
+ ```
+
+to create a new revision for a document. Please note that the original object will be unchanged!
+
+To access all revisitons for a givent document, use
+
+ ```ruby
+  @comment.revisions
+ ```
+
+Lastly, to modify a revision with a given tag, use
+
+ ```ruby
+  @comment.revise.tag_version("Beta stage")
+ ```
+
+to change the tag attribute of the document and save it in a single call.
+
+## Future changes (sort of TODO list)
+
+- Recursive revision to linked documents
+- Branching to create a new document at revision a 0 and with a token different from the original
 
 ## Development
 
 Questions or problems? Please post them on the [issue tracker](https://github.com/emilianodellacasa/mongoid_revisions/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests passing by running `bundle` and `rake`.
 
-This gem is created by Emiliano Della Casa and is under the MIT License.
+This gem is created by Emiliano Della Casa and is under the MIT License and it is distributed by courtesy of [Engim srl](http://www.engim.eu/en).

data/lib/mongoid_revisions/version.rb

@@ -1,3 +1,3 @@
 module MongoidRevisions
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/mongoid_revisions.rb

@@ -1,40 +1,68 @@
 require "mongoid_revisions/version"
 
 module Mongoid
-  module Revisions
-    extend ActiveSupport::Concern
-
-    included do
-      field :revision, :type => Integer, :default => 1
-      field :tag, :type => String, :default => "1.0.0"
-      field :token, :type => String
-
-
-      set_callback :create, :before, :create_unique_token
-    end
-
-    # CREATE A UNIQUE ID FOR THE DOCUMENT BUT ONLY IF TOKEN IS EMPTY
-    def create_unique_token
-	self.token=SecureRandom.hex(16) if self.token.nil?
-    end
-
-    # RETURN ALL REVISIONS FOR THIS DOCUMENT
-    def revisions
-	self.class.where(:token=>self.token) #.order_by([[:revision,:asc]])
-    end 
-
-    # ASSIGN A NEW TAG TO THIS REVISION
-    def tag_revision(tag)
-	self.tag=tag
-	self.save
-    end
-
-    # CREATE A NEW REVISION FOR THE DOCUMENT
-    def revise
-	new_revision = self.class.create self.attributes.except("_id")
-	new_revision.revision = (self.revision || 1) + 1
-	new_revision.tag = "#{new_revision.revision}.0.0"
-	new_revision.save
-    end
+	module Revisions
+		extend ActiveSupport::Concern
+
+			included do
+				field :revision, :type => Integer, :default => 0
+				field :tag, :type => String, :default => "0.0.0"
+				field :token, :type => String
+
+				set_callback :create, :before, :create_unique_token
+			end
+
+			# BLOCK ACCESS TO REVISION ATTRIBUTE
+			def revision=(rev)
+				# DOES NOTHING
+			end
+
+			def token=(tok)
+			end
+
+			# RETURN ALL REVISIONS FOR THIS DOCUMENT
+			def revisions
+				self.class.where(:token=>self.token).order_by([[:revision,:asc]])
+			end 
+
+			# ASSIGN A NEW TAG TO THIS REVISION
+			def tag_revision(tag)
+				self.tag=tag
+				self.save
+			end
+
+			# CREATE A NEW REVISION FOR THE DOCUMENT
+			def revise
+				new_revision = self.class.create self.attributes.except("_id")
+				new_revision._token = self.token
+				new_revision._revision = (self.revision || 1) + 1
+				new_revision.tag = "#{new_revision.revision}.0.0"
+				new_revision.save
+				self.relations.each do |relation|
+          metadata = self.class.reflect_on_association(relation[0])
+          metadata.class_name.constantize.where(metadata.foreign_key.to_sym=>self.id).each do |child|
+            new_child = metadata.class_name.constantize.create child.attributes.except("_id")
+            new_child.revision = child.revision+1
+            new_child.tag = "#{new_child.revision}.0.0"
+						new_child[metadata.foreign_key.to_sym]=new_revision.id
+            new_child.save
+          end
+        end
+	    end
+
+  	  protected
+
+			def _revision=(rev)
+				self[:revision]=rev
+			end
+
+			def _token=(tok)
+				self[:token]=tok
+			end
+
+      # CREATE A UNIQUE ID FOR THE DOCUMENT BUT ONLY IF TOKEN IS EMPTY
+      def create_unique_token
+        self._token=SecureRandom.hex(16) if self.token.nil?
+      end
   end
 end

data/spec/mongoid/models/milestone.rb

@@ -0,0 +1,9 @@
+class Milestone
+  include Mongoid::Document
+  include Mongoid::Revisions
+
+  field :description 
+
+  belongs_to :project
+
+end

data/spec/mongoid/models/project.rb

@@ -4,4 +4,6 @@ class Project
 
   field :name  
 
+  has_many :milestones
+
 end

data/spec/mongoid_revisions/revisions_spec.rb

@@ -1,83 +1,110 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Mongoid::Revisions do
-  before :all do
-    Project.delete_all
-    @project = Project.create!(:name=>"My first project")
-  end
-
-  context "just created" do
-    it "is at revision 1" do
-	@project.revision.should==1
-    end
-
-    it "has a default tag" do
-	@project.tag.should=="1.0.0"
-    end 
-
-    it "has a unique token" do
-	@project.token.should_not be_nil
-    end
-
-    it "has just 1 revision" do
-	@project.revisions.count.should==1
-    end
-
-    it "can have a different tag" do
-        @project.tag_revision("Alpha Stage")
-	@project.tag.should=="Alpha Stage"
-    end
-  end 
+	before :all do
+		Project.delete_all
+		@project = Project.create!(:name=>"My first project")
+		@project.milestones.create!(:description=>"First Milestone")
+	end
+
+	context "just created" do
+		it "is at revision 0" do
+			@project.revision.should==0
+		end
+
+		it "has a default tag" do
+			@project.tag.should=="0.0.0"
+		end 
+
+		it "has a unique token" do
+			@project.token.should_not be_nil
+		end
+
+		it "has just 1 revision" do
+			@project.revisions.count.should==1
+		end
+
+		it "can have a different tag" do
+			@project.tag_revision("Alpha Stage")
+			@project.tag.should=="Alpha Stage"
+		end
+
+		it "has a single milestone" do
+			@project.milestones.count==1
+		end
+
+		it "does not allow modification to its revision" do
+			@project.revision=56
+			@project.revision.should==0
+		end
+
+		it "does not allow modifications to its token" do
+			@project.token="ciccio"
+			@project.token.should_not=="ciccio"
+		end
+	end 
 
   
-  describe "when I do not want a new revision" do
-    before :all do
-      @project.save
-    end
-
-    it "has 1 revisions" do
-      @project.revisions.count.should==1
-    end
-
-    it "it is at revision 1" do
-      @project.revision.should==1
-    end
-  end
-
-  describe "when I want a new revision" do
-    before :all do
-      @project.revise
-    end
-
-    it "has 2 revisions" do
-      @project.revisions.count.should==2
-    end
-
-    it "it is at revision 1" do
-      @project.revision.should==1
-    end
-
-    it "last revision is at revision 2" do
-      @project.revisions.last.revision.should==2
-    end
-
-    it "last revision has the default tag" do
-      @project.revisions.last.tag.should=="2.0.0"
-    end
-
-    it "has 2 revisions" do
-      @project.revisions.count.should==2
+	describe "when I do not want a new revision" do
+	  before :all do
+			@project.save
+		end
+
+		it "has 1 revisions" do
+			@project.revisions.count.should==1
+		end
+
+		it "it is at revision 0" do
+			@project.revision.should==0
+		end
+
+		it "has a single milestone" do
+			@project.milestones.count==1
+		end
+	end
+
+	describe "when I want a new revision" do
+		before :all do
+			@project.revise
+		end
+
+		it "has 2 revisions" do
+			@project.revisions.count.should==2
+		end
+
+		it "it is at revision 0" do
+			@project.revision.should==0
+		end
+
+		it "last revision is at revision 1" do
+			@project.revisions.last.revision.should==1
+		end
+
+		it "last revision has the default tag" do
+			@project.revisions.last.tag.should=="1.0.0"
+		end
+
+		it "has 2 revisions" do
+			@project.revisions.count.should==2
+		end
+
+		it "creates a new milestone" do
+			Milestone.count.should==2
+		end
+
+    it "last revision has a single milestone" do
+			#puts @project.revisions.last.inspect
+			@project.revisions.last.milestones.count.should==1
     end
   end
 
-  describe "adding a random number of revisions" do
-    it "should give me the right number of revisions" do
-	count = rand(10)
-	count.times do 
-          @project.revise
-        end
-	@project.revisions.count.should==(count+2)
-    end
-  end
-  
+	describe "adding a random number of revisions" do
+		it "should give me the right number of revisions" do
+			count = rand(10)
+			count.times do 
+				@project.revise
+			end
+			@project.revisions.count.should==(count+2)
+		end
+	end
 end

metadata

@@ -1,57 +1,60 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mongoid_revisions
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.0.2
 platform: ruby
-authors:
+authors: 
 - Emiliano Della Casa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-08 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-02-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &80569250 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 2.8.0
   type: :development
-  prerelease: false
-  version_requirements: *80569250
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: mongoid
-  requirement: &80568200 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 2.4.2
   type: :development
-  prerelease: false
-  version_requirements: *80568200
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: bson_ext
-  requirement: &80567950 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.5.2
   type: :development
-  prerelease: false
-  version_requirements: *80567950
-description: Add support for revisions to your Mongoid documents by creating a new
-  version of a document every time you change it and replicating all of its associations
-email:
+  version_requirements: *id003
+description: Add support for revisions to your Mongoid documents by creating a new version of a document every time you change it and replicating all of its associations
+email: 
 - e.dellacasa@engim.eu
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - README.md
@@ -60,34 +63,36 @@ files:
 - lib/mongoid_revisions/version.rb
 - mongoid_revisions.gemspec
 - spec/.rspec
+- spec/mongoid/models/milestone.rb
 - spec/mongoid/models/project.rb
 - spec/mongoid_revisions/revisions_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: mongoid_revisions
-rubygems_version: 1.8.11
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Add support for revisions to your Mongoid documents
-test_files:
-- spec/mongoid/models/project.rb
-- spec/mongoid_revisions/revisions_spec.rb
-- spec/spec_helper.rb
+test_files: []
+