mongoid_revisions 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.2

data/README.md

@@ -1,4 +1,4 @@
-# Mongoid Revisions
+# Mongoid Revisions [![Build Status](https://secure.travis-ci.org/emilianodellacasa/mongoid_revisions.png)](https://secure.travis-ci.org/emilianodellacasa/mongoid_revisions.png)
 
 Add support for revisions to your Mongoid documents
 
@@ -23,42 +23,61 @@ To add support for revisions to a Mongoid documents, include the module to your
  end
  ```
 
-This gem adds to your Mongoid document the following attributes:
+### Added Attributes
 
 - revision (read only)
 - tag
 - token (read only)
 
-and the following methods:
+### Added Methods
 
 - revisions
 - tag_version
 - revise
+- branch
 
-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.
+### Token Field
+
+Token is a randomly generated string that is common to all revisions of the same document and it is write protected to preserve the functionality of this library. 
+
+An index is automatically added to this field but to apply it you will have to issue the following command
+
+ ```ruby
+  rake db:mongoid:create_indexes
+ ```
+
+like all mongoid indexes.
+
+### Create a new revision
 
 Simply call the revise method
 
  ```ruby
-	last_comment_revision=@comment.revise
+	last_comment_revision = @comment.revise
  ```
 
-to create a new revision for a document. Please note that the original object will be unchanged! 
+Please note that the original object will be unchanged! 
+
+### Create a new branch
 
 To create a new branch of a given document, use
 
 ```ruby
-  new_comment=@comment.branch
+  new_comment = @comment.branch
  ```
 
 and the returned document will have a different token and will be at revision 0.
 
-To access all revisitons for a givent document, use
+### Get all document's revisions
+
+To access all revisions for a given document, use
 
  ```ruby
   @comment.revisions
  ```
 
+### Tag a revision
+
 Lastly, to modify a revision with a given tag, use
 
  ```ruby
@@ -67,10 +86,49 @@ Lastly, to modify a revision with a given tag, use
 
 to change the tag attribute of the document and save it in a single call.
 
+### Access a document by a particular revision or tag
+
+You can access a document by its revision or tag by using the following functions:
+
+ ```ruby
+  @comment.at_revision(2)
+ ```
+
+ ```ruby
+  @comment.tagged("Beta stage")
+ ```
+
+### Navigate thru revisions
+
+You can navigate thru all revisions of a document by using the 'next' and 'previous' functions:
+
+ ```ruby
+  @comment.next
+ ```
+
+ ```ruby
+  @comment.previous
+ ```
+
+## Relations Gotcha
+
+At present time, not all relation types supported by Mongoid get cloned by this gem. 
+
+Here follow a list of all relation types with the indication in they are supported or not:
+
+- has_one : SUPPORTED
+- has_many : SUPPORTED
+- belongs_to : UNSUPPORTED (Doesn't make any sense IMHO, but it will be possible to support it)
+- has_and_belongs_to_many : SUPPORTED (only the relation between the two models gets cloned)
+- embeds_many : UNSUPPORTED
+- embeds_one : UNSUPPORTED
+
 ## Future changes (sort of TODO list)
 
-- Check if linked relations cloning work for all relation's tipologies
 - Recursive revision to linked documents
+- Add search method for tag
+- Add support for cloning of "embeds_many" and "embeds_one" relations
+- Add relation blacklist for all relations you don't want to clone
 
 ## Development
 

data/lib/mongoid_revisions/version.rb

@@ -1,3 +1,3 @@
 module MongoidRevisions
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/mongoid_revisions.rb

@@ -9,6 +9,8 @@ module Mongoid
 				field :tag, :type => String, :default => "0.0.0"
 				field :token, :type => String
 
+				index :token
+
 				set_callback :create, :before, :create_unique_token
 			end
 
@@ -17,7 +19,9 @@ module Mongoid
 				# DOES NOTHING
 			end
 
+			# BLOCK ACCESS TO TOKEN ATTRIBUTE
 			def token=(tok)
+				# DOES NOTHING
 			end
 
 			# RETURN ALL REVISIONS FOR THIS DOCUMENT
@@ -25,6 +29,26 @@ module Mongoid
 				self.class.where(:token=>self.token).order_by([[:revision,:asc]])
 			end 
 
+			# RETURN A SPECIFIC REVISION
+			def at_revision(revision)
+				self.class.where(:token=>self.token,:revision=>revision.to_i).first
+			end
+
+			# RETURN A SPECIFIC REVISION WITH A SPECIFIC TAG
+			def tagged(tag)
+				self.class.where(:token=>self.token,:tag=>tag).first
+			end
+
+			# RETURN NEXT REVISION
+			def next
+				at_revision(self.revision+1)
+			end
+
+			# RETURN PREVIOUS REVISION
+			def previous
+				at_revision(self.revision-1)
+			end
+
 			# ASSIGN A NEW TAG TO THIS REVISION
 			def tag_revision(tag)
 				self.tag=tag
@@ -50,14 +74,18 @@ module Mongoid
 				new.tag = "#{new.revision}.0.0"
         new.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.id
-            new_child.save
-          end
+					metadata=relation[1]
+					if metadata[:relation]==Mongoid::Relations::Embedded::Many or metadata[:relation]==Mongoid::Relations::Embedded::One
+						# TODO
+					elsif metadata[:relation]!=Mongoid::Relations::Referenced::In
+						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.id
+	            new_child.save
+  	        end
+					end
         end
         new
 			end

data/mongoid_revisions.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+	s.add_development_dependency "rake"
   s.add_development_dependency 'rspec', '~> 2.8.0'
   s.add_development_dependency 'mongoid', '~> 2.4.2'
   s.add_development_dependency 'bson_ext', '~> 1.5.2'

data/spec/mongoid/models/configuration.rb

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

data/spec/mongoid/models/note.rb

@@ -0,0 +1,9 @@
+class Note
+  include Mongoid::Document
+	include Mongoid::Revisions
+
+  field :text
+
+	embedded_in :project
+
+end

data/spec/mongoid/models/project.rb

@@ -5,5 +5,9 @@ class Project
   field :name  
 
   has_many :milestones
-
+	belongs_to :user
+	has_one :configuration
+  embeds_many :notes
+	embeds_one :version
+	has_and_belongs_to_many :teams
 end

data/spec/mongoid/models/team.rb

@@ -0,0 +1,9 @@
+class Team
+  include Mongoid::Document
+	include Mongoid::Revisions
+
+  field :name
+
+  has_and_belongs_to_many :projects
+
+end

data/spec/mongoid/models/user.rb

@@ -0,0 +1,8 @@
+class User
+  include Mongoid::Document
+
+  field :username
+
+  has_many :projects
+
+end

data/spec/mongoid/models/version.rb

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

data/spec/mongoid_revisions/revisions_spec.rb

@@ -3,8 +3,13 @@ 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")
+		@user = User.create!(:username=>"teddy")
+		@project = Project.create!(:name=>"My first project",:user_id=>@user.id)
 		@project.milestones.create!(:description=>"First Milestone")
+		@project.create_configuration(:directory_name=>"/opt/project")
+		@project.notes.create!(:text=>"This is a note")
+		@project.create_version(:description=>"1.0.0")
+		@project.teams.create(:name=>"Team A")
 	end
 
 	context "just created" do
@@ -33,6 +38,18 @@ describe Mongoid::Revisions do
 			@project.milestones.count==1
 		end
 
+		it "has a single note" do
+      @project.notes.count==1
+    end
+
+		it "has a single team" do
+			@project.teams.count==1
+		end
+
+		it "has a single configuration" do
+      @project.configuration.should_not be_nil
+    end
+
 		it "does not allow modification to its revision" do
 			@project.revision=56
 			@project.revision.should==0
@@ -42,6 +59,10 @@ describe Mongoid::Revisions do
 			@project.token="ciccio"
 			@project.token.should_not=="ciccio"
 		end
+
+		it "should have a index on token" do
+			Project.index_options.count.should==1
+		end
 	end 
 
   
@@ -61,6 +82,14 @@ describe Mongoid::Revisions do
 		it "has a single milestone" do
 			@project.milestones.count==1
 		end
+
+		it "has a single note" do
+      @project.notes.count==1
+    end
+
+		it "has a single version" do
+      @project.version.should_not be_nil
+    end
 	end
 
 	describe "when I want a new revision" do
@@ -99,6 +128,64 @@ describe Mongoid::Revisions do
     it "last revision has a single milestone" do
 			@project.revisions.last.milestones.count.should==1
     end
+
+    it "last revision has a single team" do
+      @project.revisions.last.teams.count.should==1
+    end
+
+		it "original revision has a single team" do
+      @project.teams.count.should==1
+    end
+
+		it "original project has a single note" do
+      @project.notes.count.should==1
+    end
+
+		it "last revision has a single note" do
+			pending # EMBEDDED RELATIONS NOT SUPPORTED (YET)
+      @project.revisions.last.notes.count.should==1
+    end
+
+  	it "last revision has a single version" do
+      pending # EMBEDDED RELATIONS NOT SUPPORTED (YET)
+      @project.revisions.last.version.should_not be_nil
+    end
+
+		it "does not create a new User" do
+			User.count.should==1
+		end
+
+		it "should create a new configuration" do
+			Configuration.count.should==2
+		end
+
+		it "last revision has a single configuration" do
+      @project.revisions.last.configuration.should_not be_nil
+    end
+
+		it "should allow me to access a particular revision" do
+			@project.at_revision(1).revision.should==1
+		end
+
+		it "should allow me to access a particular revision using its tag" do
+			@project.tagged("1.0.0").tag.should=="1.0.0"
+		end
+
+		it "should allow me to navigate to the next revision" do
+			@project.next.revision.should==@project.revision+1
+		end
+
+		it "should allow me to navigate to the previous revision" do
+      @new_revised_project.previous.revision.should==@project.revision
+    end
+
+		it "should me give me nil if there is no next revision" do
+			@new_revised_project.next.should==nil
+		end
+
+		it "should me give me nil if there is no previous revision" do
+			@project.previous.should==nil
+    end
   end
 
 	describe "adding a random number of revisions" do

data/spec/spec_helper.rb

@@ -17,5 +17,5 @@ Dir[ File.join(models_folder, '*.rb') ].each { |file|
   require file
   file_name = File.basename(file).sub('.rb', '')
   klass = file_name.classify.constantize
-  klass.collection.drop
+  klass.collection.drop unless klass.embedded?
 }

metadata

@@ -2,7 +2,7 @@
 name: mongoid_revisions
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Emiliano Della Casa
@@ -10,41 +10,52 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-13 00:00:00 Z
+date: 2012-02-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 2.8.0
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mongoid
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 2.4.2
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: bson_ext
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 1.5.2
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 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
@@ -56,6 +67,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -63,8 +75,13 @@ files:
 - lib/mongoid_revisions/version.rb
 - mongoid_revisions.gemspec
 - spec/.rspec
+- spec/mongoid/models/configuration.rb
 - spec/mongoid/models/milestone.rb
+- spec/mongoid/models/note.rb
 - spec/mongoid/models/project.rb
+- spec/mongoid/models/team.rb
+- spec/mongoid/models/user.rb
+- spec/mongoid/models/version.rb
 - spec/mongoid_revisions/revisions_spec.rb
 - spec/spec_helper.rb
 homepage: ""