mongoid_delorean 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.log
+.DS_Store
+doc
+tmp
+pkg
+*.gem
+*.pid
+coverage
+coverage.data
+build/*
+*.pbxuser
+*.mode1v3
+.svn
+profile
+.console_history
+.sass-cache/*
+.rake_tasks~
+*.log.lck
+solr/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_delorean.gemspec
+gemspec
+
+gem "rspec"
+gem 'database_cleaner'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    mongoid_delorean (1.0.0)
+      mongoid (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    database_cleaner (0.8.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    mongoid (3.0.5)
+      activemodel (~> 3.1)
+      moped (~> 1.1)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.2.1)
+    multi_json (1.3.6)
+    origin (1.0.8)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  mongoid_delorean!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Bates
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# Mongoid::Delorean
+
+A simple Mongoid 3 versioning system that works with embedded documents.
+
+Tracking document changes can be really important to a lot of systems, unfortunately all of the Mongoid versioning plugins either only work with Mongoid 2.x, don't handle embedded document changes, or worse, just don't work. <code>Mongoid::Delorean</code> solves those problems.
+
+<code>Mongoid::Delorean</code> is a simple plugin that does just what it sets out to do. It stores each version of your document as you make changes and then allows you to revert to earlier versions of the document. 
+
+If this wasn't great already, <code>Mongoid::Delorean</code> will even track changes made to any embedded documents, or documents that those embedded documents may have, and so on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_delorean'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_delorean
+
+## Usage
+
+Using Mongoid::Delorean is very simple. Just include the <code>Mongoid::Delorean::Trackable</code> module into the <code>Mongoid::Document</code> you want to track. There is no need to include it in embedded documents, the parent document will handle that for you.
+
+Now, when you save, or update, the parent (or any of the embedded documents) a new version will be saved for you.
+
+### Example
+
+<pre><code>
+class Article
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::Delorean::Trackable
+
+  field :name, type: String
+  field :summary, type: String
+
+  embeds_many :pages
+end
+
+class Page
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :name, type: String
+
+  embedded_in :article, inverse_of: :pages
+  embeds_many :sections
+end
+
+class Section
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :name, type: String
+  field :body, type: String
+
+  embedded_in :page, inverse_of: :sections
+end
+
+a = Article.create(name: "Article 1")
+a.version # => 1
+page = a.pages.create(name: "Page 1")
+a.version # => 2
+page.update_attributes(name: "The 1st Page")
+a.version # => 3
+a.revert! # revert to the last version
+page.reload
+page.name # => "Page 1"
+a.version # => 4
+page.sections.create(name: "Section 1")
+a.version # => 5
+a.revert!(2) # revert to version 2
+page.reload
+a.version # => 6
+page.name # => "Page 1"
+page.sections.size # => 0
+a.versions.size # => 6
+</code></pre>
+
+If you don't want to track changes you can wrap it with <code>without_history_tracking</code>:
+
+<pre><code>
+a = Article.create(name: "Article 1")
+a.without_history_tracking do
+  a.update_attributes(name: "The Article 1")
+end
+a.version # => 1
+</code></pre>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'  
+Bundler::GemHelper.install_tasks
+
+desc "Run tests"
+task :default => [:ruby]
+
+task :ruby do
+  system "bundle exec rspec"
+end

data/lib/mongoid/delorean/history.rb

@@ -0,0 +1,16 @@
+module Mongoid
+  module Delorean
+    class History
+
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      field :original_class, type: String
+      field :original_class_id, type: String
+      field :version, type: Integer, default: 0
+      field :altered_attributes, type: Hash, default: {}
+      field :full_attributes, type: Hash, default: {}
+
+    end
+  end
+end

data/lib/mongoid/delorean/trackable.rb

@@ -0,0 +1,121 @@
+module Mongoid
+  module Delorean
+    module Trackable
+
+      def self.included(klass)
+        super
+        klass.field :version, type: Integer, default: 0
+        klass.before_save :save_version
+      end
+
+      def versions
+        Mongoid::Delorean::History.where(original_class: self.class.name, original_class_id: self.id)
+      end
+
+      def save_version
+        if self.track_history?
+          unless self.kind_of?(Mongoid::Delorean::Trackable::CommonInstanceMethods)
+            extend Mongoid::Delorean::Trackable::CommonInstanceMethods
+          end
+          last_version = self.versions.last
+          _version = last_version ? last_version.version + 1 : 1
+
+          _attributes = self.attributes_with_relations
+          _attributes.merge!("version" => _version)
+          _changes = self.changes_with_relations.dup
+          _changes.merge!("version" => [self.version_was, _version])
+
+          Mongoid::Delorean::History.create(original_class: self.class.name, original_class_id: self.id, version: _version, altered_attributes: _changes, full_attributes: _attributes).inspect
+          self.without_history_tracking do
+            self.update_attributes(version: _version)
+          end
+        end
+      end
+
+      def track_history?
+        @__track_changes.nil? ? true : @__track_changes
+      end
+
+      def without_history_tracking
+        @__track_changes = false
+        yield
+        @__track_changes = true
+      end
+
+      def revert!(version = (self.version - 1))
+        old_version = self.versions.where(version: version).first
+        if old_version
+          old_version.full_attributes.each do |key, value|
+            self.send("#{key}=", value)
+          end
+          self.save!
+        end
+      end
+
+      module CommonInstanceMethods
+
+        def self.extended(klass)
+          super
+          included(klass)
+        end
+
+        def self.included(klass)
+          super
+          klass.embedded_relations.each do |name, details|
+            _klass = Kernel.const_get(details.class_name)
+            _klass.send(:include, Mongoid::Delorean::Trackable::CommonInstanceMethods)
+            _klass.after_save :save_parent_version
+          end
+        end
+
+        def save_parent_version
+          if self.embedded?
+            self._parent.save_parent_version
+          else
+            self.save_version
+          end
+        end
+        
+        def changes_with_relations
+          _changes = self.changes.dup
+
+          %w{version updated_at created_at}.each do |col|
+            _changes.delete(col)
+            _changes.delete(col.to_sym)
+          end
+
+          relation_changes = {}
+          self.embedded_relations.each do |name, details|
+            relation = self.send(name)
+            relation_changes[name] = []
+            r_changes = relation.map {|o| o.changes_with_relations}
+            relation_changes[name] << r_changes unless r_changes.empty?
+            relation_changes[name].flatten!
+            relation_changes.delete(name) if relation_changes[name].empty?
+          end
+
+          _changes.merge!(relation_changes)
+          return _changes
+        end
+
+        def attributes_with_relations
+          _attributes = self.attributes.dup
+          
+          relation_attrs = {}
+          self.embedded_relations.each do |name, details|
+            relation = self.send(name)
+            relation_attrs[name] = []
+            r_attrs = relation.map {|o| o.attributes_with_relations}
+            relation_attrs[name] << r_attrs unless r_attrs.empty?
+            r_changes = relation.map {|o| o.changes}
+            relation_attrs[name].flatten!
+          end
+          _attributes.merge!(relation_attrs)
+          return _attributes
+        end
+
+      end
+
+    end
+  end
+end

data/lib/mongoid/delorean/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Delorean
+    VERSION = "1.0.0"
+  end
+end

data/lib/mongoid_delorean.rb

@@ -0,0 +1,11 @@
+require 'mongoid'
+
+require "mongoid/delorean/version"
+require "mongoid/delorean/history"
+require "mongoid/delorean/trackable"
+
+module Mongoid
+  module Delorean
+    
+  end
+end

data/mongoid_delorean.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/delorean/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mongoid_delorean"
+  gem.version       = Mongoid::Delorean::VERSION
+  gem.authors       = ["Mark Bates"]
+  gem.email         = ["mark@markbates.com"]
+  gem.description   = %q{A simple Mongoid 3 versioning system that works with embedded documents.}
+  gem.summary       = %q{A simple Mongoid 3 versioning system that works with embedded documents.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("mongoid", ">=3.0.0")
+
+end

data/spec/config.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: mongoid_delorean_test
+      hosts:
+        - localhost:27017

data/spec/mongoid/delorean/trackable_spec.rb

@@ -0,0 +1,273 @@
+require 'spec_helper'
+
+describe Mongoid::Delorean::Trackable do
+  
+  class Article
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Mongoid::Delorean::Trackable
+
+    field :name, type: String
+    field :summary, type: String
+
+    embeds_many :pages
+  end
+
+  class Page
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :name, type: String
+
+    embedded_in :article, inverse_of: :pages
+    embeds_many :sections
+  end
+
+  class Section
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :name, type: String
+    field :body, type: String
+
+    embedded_in :page, inverse_of: :sections
+  end
+
+  class User
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Mongoid::Delorean::Trackable
+
+    field :name, type: String
+    field :age, type: Integer
+  end
+
+  context "simple document" do
+  
+    it "creates a history object" do
+      expect {
+        expect {
+          u = User.create!(name: "Mark")
+        }.to change(User, :count).by(1)
+      }.to change(Mongoid::Delorean::History, :count).by(1)
+    end
+
+    it "sets the first version to 1" do
+      u = User.create!(name: "Mark")
+      u.version.should eql(1)
+    end
+
+    it "returns a list of the versions" do
+      u = User.create!(name: "Mark")
+      versions = u.versions
+      versions.size.should eql(1)
+      versions.first.version.should eql(1)
+
+      u.save!
+      versions = u.versions
+      versions.size.should eql(2)
+      versions.last.version.should eql(2)
+    end
+
+    it "does not track created_at changes" do
+      u = User.create!(name: "Mark")
+      version = u.versions.first
+      version.altered_attributes.should_not include("created_at")
+    end
+
+    it "does not track updated_at changes" do
+      u = User.create!(name: "Mark")
+      u.update_attributes(age: 36)
+      version = u.versions.last
+      version.altered_attributes.should_not include("updated_at")
+    end
+
+    it "tracks the changes that were made" do
+      u = User.create!(name: "Mark")
+      version = u.versions.first
+      version.altered_attributes.should eql({"_id"=>[nil, u.id], "version"=>[nil, 1], "name"=>[nil, "Mark"]})
+
+      u.update_attributes(age: 36)
+      version = u.versions.last
+      version.altered_attributes.should eql({"version"=>[1, 2], "age"=>[nil, 36]})
+    end
+
+    it "tracks the full set of attributes at the time of saving" do
+      u = User.create!(name: "Mark")
+
+      version = u.versions.first
+      version.full_attributes.should eql({"_id"=>u.id, "version"=>1, "name"=>"Mark"})
+
+      u.update_attributes(age: 36)
+
+      version = u.versions.last
+      version.full_attributes.except("created_at", "updated_at").should eql({"_id"=>u.id, "version"=>2, "name"=>"Mark", "age"=>36})
+    end
+
+    describe "#without_history_tracking" do
+      
+      it "it doesn't track the history of the save" do
+        expect {
+          expect {
+            u = User.new(name: "Mark")
+            u.without_history_tracking do
+              u.save!
+            end
+          }.to change(User, :count).by(1)
+        }.to_not change(Mongoid::Delorean::History, :count).by(1)
+      end
+
+    end
+
+    describe '#revert!' do
+      
+      it "reverts to the last version" do
+        u = User.create!(name: "Mark")
+        u.update_attributes(age: 36)
+        u.update_attributes(name: "Mark Bates")
+        u.versions.size.should eql(3)
+        u.version.should eql(3)
+        u.revert!
+        u.version.should eql(4)
+        u.name.should eql("Mark")
+        u.age.should eql(36)
+      end
+
+      it "reverts to a specific version" do
+        u = User.create!(name: "Mark")
+        u.update_attributes(age: 36)
+        u.update_attributes(name: "Mark Bates")
+        u.versions.size.should eql(3)
+        u.version.should eql(3)
+        u.revert!(2)
+        u.version.should eql(4)
+        u.name.should eql("Mark")
+        u.age.should eql(36)
+      end
+
+      it "does nothing if the specific version doesn't exist" do
+        u = User.create!(name: "Mark")
+        u.update_attributes(age: 36)
+        u.update_attributes(name: "Mark Bates")
+        u.versions.size.should eql(3)
+        u.version.should eql(3)
+        u.revert!(20)
+        u.version.should eql(3)
+        u.name.should eql("Mark Bates")
+        u.age.should eql(36)
+      end
+
+    end
+
+  end
+
+  context "complex documents with embeds" do
+
+    it "tracks the changes" do
+      a = Article.create!(name: "My Article")
+
+      version = a.versions.first
+      version.altered_attributes.should eql({"_id"=>[nil, a.id], "version"=>[nil, 1], "name"=>[nil, "My Article"]})
+    end
+
+    it "tracks the changes including embedded docs" do
+      a = Article.new(name: "My Article")
+      page = a.pages.build(name: "Page 1")
+      a.save!
+
+      version = a.versions.first
+      version.altered_attributes.should eql({"_id"=>[nil, a.id], "version"=>[nil, 1], "name"=>[nil, "My Article"], "pages"=>[{"_id"=>[nil, page.id], "name"=>[nil, "Page 1"]}]})
+
+      page.name = "The Page 1"
+      a.save!
+
+      version = a.versions.last
+      version.altered_attributes.should eql({"pages"=>[{"name"=>["Page 1", "The Page 1"]}], "version"=>[1, 2]})
+
+      section = page.sections.build(body: "some body text")
+      a.save!
+
+      version = a.versions.last
+      version.altered_attributes.should eql({"pages"=>[{"sections"=>[{"_id"=>[nil, section.id], "body"=>[nil, "some body text"]}]}], "version"=>[2, 3]})
+    end
+
+    it "tracks the full set of attributes at the time of saving" do
+      a = Article.create!(name: "My Article")
+
+      version = a.versions.first
+      version.full_attributes.should eql({"_id"=>a.id, "version"=>1, "name"=>"My Article", "pages"=>[]})
+
+      a.update_attributes(summary: "Summary about the article")
+
+      version = a.versions.last
+      version.full_attributes.except("created_at", "updated_at").should eql({"_id"=>a.id, "version"=>2, "name"=>"My Article", "summary"=>"Summary about the article", "pages"=>[]})
+    end
+
+    it "tracks the full set of attributes including embeds at the time of saving" do
+      a = Article.new(name: "My Article")
+      page = a.pages.build(name: "Page 1")
+      a.save!
+
+      version = a.versions.first
+      version.full_attributes.should eql({"_id"=>a.id, "version"=>1, "name"=>"My Article", "pages"=>[{"_id"=>page.id, "name"=>"Page 1", "sections"=>[]}]})
+
+      a.update_attributes(summary: "Summary about the article")
+
+      version = a.versions.last
+      version.full_attributes.except("created_at", "updated_at").should eql({"_id"=>a.id, "version"=>2, "name"=>"My Article", "pages"=>[{"_id"=>page.id, "name"=>"Page 1", "sections"=>[]}], "summary"=>"Summary about the article"})
+    end
+
+    it "tracks changes when an embedded document is saved" do
+      a = Article.new(name: "Article 1")
+      page = a.pages.build(name: "Page 1")
+      a.save!
+      a.version.should eql(1)
+      page.name = "The 1st Page"
+      page.save!
+      a.reload
+      a.version.should eql(2)
+      page = a.pages.first
+      page.name.should eql("The 1st Page")
+    end
+
+    describe '#revert!' do
+      
+      it "reverts to the last version" do
+        a = Article.create!(name: "My Article")
+        a.pages.create!(name: "Page 1")
+        a.pages.should_not be_empty
+        a.revert!
+        a.name.should eql("My Article")
+        a.pages.should be_empty
+      end
+
+      it "reverts to a specific version" do
+        a = Article.create!(name: "My Article")
+        a.pages.build(name: "Page 1")
+        a.save!
+        a.pages.should_not be_empty
+        page = a.pages.first
+        page.name = "The 1st Page"
+        a.save!
+        page.sections.build(name: "Section 1")
+        a.save!
+        a.pages.first.sections.first.name.should eql("Section 1")
+        a.revert!(3)
+        page.reload
+        page.name.should eql("The 1st Page")
+        page.sections.should be_empty
+      end
+
+      it "does nothing if the specific version doesn't exist" do
+        a = Article.create!(name: "My Article")
+        a.pages.build(name: "Page 1")
+        a.save!
+        a.revert!(20)
+        a.version.should eql(2)
+      end
+
+    end
+    
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+
+require 'mongoid_delorean' # and any other gems you need
+
+require 'database_cleaner'
+
+Mongoid.load!(File.join(File.dirname(__FILE__), "config.yml"), :test)
+
+DatabaseCleaner[:mongoid].strategy = :truncation
+
+RSpec.configure do |config|
+
+  config.before(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_delorean
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A simple Mongoid 3 versioning system that works with embedded documents.
+email:
+- mark@markbates.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid/delorean/history.rb
+- lib/mongoid/delorean/trackable.rb
+- lib/mongoid/delorean/version.rb
+- lib/mongoid_delorean.rb
+- mongoid_delorean.gemspec
+- spec/config.yml
+- spec/mongoid/delorean/trackable_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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple Mongoid 3 versioning system that works with embedded documents.
+test_files:
+- spec/config.yml
+- spec/mongoid/delorean/trackable_spec.rb
+- spec/spec_helper.rb