mongoid_revisions 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mongoid_revisions.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# Mongoid Revisions
+
+Add support for revisions to your Mongoid documents
+
+## Installation
+
+Add to your Gemfile and run the `bundle` command to install it.
+
+ ```ruby
+ gem "mongoid_revisions"
+ ```
+
+**Requires Ruby 1.9.2 or later and Mongoid 2.4.2 or later.**
+
+## Usage
+
+To add support for revisions to a Mongoid documents, include the module to your Model:
+
+ ```ruby
+ class Comment
+   include Mongoid::Document
+   include Mongoid::Revisions
+ end
+ ```
+
+This gem adds to your Mongoid document the following attributes:
+
+- revision
+- tag
+- token
+
+## 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.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => ['spec']
+
+
+
+#require "bundler/gem_tasks"
+#require 'rspec/core/rake_task'
+
+#RSpec::Core::RakeTask.new(:spec)
+#task default: :spec

data/lib/mongoid_revisions/version.rb

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

data/lib/mongoid_revisions.rb

@@ -0,0 +1,40 @@
+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
+  end
+end

data/mongoid_revisions.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid_revisions/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid_revisions"
+  s.version     = MongoidRevisions::VERSION
+  s.authors     = ["Emiliano Della Casa"]
+  s.email       = ["e.dellacasa@engim.eu"]
+  s.homepage    = ""
+  s.summary     = %q{Add support for revisions to your Mongoid documents}
+  s.description = %q{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}
+
+  s.rubyforge_project = "mongoid_revisions"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  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'
+end

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/mongoid/models/project.rb

@@ -0,0 +1,7 @@
+class Project
+  include Mongoid::Document
+  include Mongoid::Revisions
+
+  field :name  
+
+end

data/spec/mongoid_revisions/revisions_spec.rb

@@ -0,0 +1,83 @@
+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 
+
+  
+  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
+    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

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler'
+
+require 'mongoid'
+models_folder = File.join(File.dirname(__FILE__), 'mongoid/models')
+
+Mongoid.configure do |config|
+  name = 'revisions_mongo_test'
+  host = 'localhost'
+  config.master = Mongo::Connection.new.db(name)
+  config.autocreate_indexes = true
+end
+
+require 'mongoid_revisions'
+
+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
+}

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_revisions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Emiliano Della Casa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &80569250 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *80569250
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &80568200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+  type: :development
+  prerelease: false
+  version_requirements: *80568200
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &80567950 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !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:
+- e.dellacasa@engim.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/mongoid_revisions.rb
+- lib/mongoid_revisions/version.rb
+- mongoid_revisions.gemspec
+- spec/.rspec
+- spec/mongoid/models/project.rb
+- spec/mongoid_revisions/revisions_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: mongoid_revisions
+rubygems_version: 1.8.11
+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