mongoid-undo 0.0.1 → 0.1.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
-# 0.1.0
+# 0.1.0 (December 22, 2012)
+* Refactored specs.
+* Renamed action field to _action.
 
+# 0.0.2 (December 22, 2012)
+* Added rake to Gemfile.
+
+# 0.0.1 (December 21, 2012)
 * First public version.

data/Gemfile

@@ -1,3 +1,6 @@
 source :rubygems
 
 gemspec
+
+gem 'minitest'
+gem 'rake'

data/README.md

@@ -1,8 +1,76 @@
 # mongoid-undo
 
-Super simple versioning for your Mongoid app.
+Super simple undo for your Mongoid app, based on both great modules
+[Mongoid::Paranoia](http://mongoid.org/en/mongoid/docs/extras.html#paranoia) and
+[Mongoid::Versioning](http://mongoid.org/en/mongoid/docs/extras.html#versioning).
 
-TODO: Add usage and installation instructions.
+## How does it work?
+
+* `Mongoid::Paranoia` is used to mark documents as deleted, instead of deleting them really, otherwise restoring would be impossible ;).
+* `Mongoid::Versioning` is used to keep the older versions of your document, so we can restore them.
+* `Mongoid::Undo` adds an `_action` field to your documents, so we can easily determine whether it was created, updated, or destroyed.
+
+But instead of explaining all the details, you should get the idea by looking at the Usage section.
+
+## Usage
+
+```ruby
+class Document
+  include Mongoid::Document
+  include Mongoid::Undo
+end
+```
+
+### Creating (and undoing)
+
+```ruby
+document = Document.create
+document.persisted? #=> true
+
+document.undo
+document.persisted? #=> false
+
+document.redo # A nice alias for undo ;)
+document.persisted? #=> true
+```
+
+### Updating (and undoing)
+
+```ruby
+document = Document.create(name: 'foo')
+
+document.update_attributes(name: 'bar')
+document.name #=> 'bar'
+
+document.undo
+document.name #=> 'foo'
+
+document.redo
+document.name #=> 'bar'
+```
+
+### Destroying (and undoing)
+
+```ruby
+document = Document.first
+
+document.destroy
+document.persisted? #=> false
+
+document.undo
+document.persisted? #=> true
+
+document.redo
+document.persisted? #=> false
+```
+
+## Installation
+
+In your Gemfile:
+
+```ruby
+gem 'mongoid-undo'
+```
 
 ## Contributing
 

data/lib/mongoid/undo/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Undo
-    VERSION = '0.0.1'
+    VERSION = '0.1.0'
   end
 end

data/lib/mongoid/undo.rb

@@ -22,19 +22,19 @@ module Mongoid
     include Mongoid::Versioning
 
     included do
-      field :action, type: Symbol, versioned: false
+      field :_action, type: Symbol, versioned: false
       index deleted_at: 1
 
       [:create, :update, :destroy].each do |action|
         set_callback action, :after do
-          collection.find(atomic_selector).update '$set' => { action: action }
+          collection.find(atomic_selector).update('$set' => { _action: action })
           reload
         end
       end
     end
 
     def undo
-      case action
+      case _action
       when :create, :destroy
         deleted_at.present? ? restore : delete
       when :update
@@ -45,7 +45,7 @@ module Mongoid
 
   private
     def retrieve
-      update_attributes versions.last.versioned_attributes.except('version')
+      update_attributes(versions.last.versioned_attributes.except('version'))
     end
   end
 end

data/mongoid-undo.gemspec

@@ -6,13 +6,11 @@ Gem::Specification.new do |gem|
   gem.authors       = 'Mario Uher'
   gem.email         = 'uher.mario@gmail.com'
   gem.homepage      = 'https://github.com/haihappen/mongoid-undo'
-  gem.summary       = 'Super simple versioning for your Mongoid app.'
-  gem.description   = 'mongoid-undo provides a super simple and easy to use versioning system for Mongo apps.'
+  gem.summary       = 'Super simple undo for your Mongoid app.'
+  gem.description   = 'mongoid-undo provides a super simple and easy to use undo system for Mongo apps.'
 
   gem.files         = `git ls-files`.split("\n")
   gem.require_path  = 'lib'
 
   gem.add_dependency 'mongoid'
-
-  gem.add_development_dependency 'minitest'
 end

data/spec/spec_helper.rb

@@ -2,8 +2,6 @@ require 'minitest/autorun'
 require 'minitest/pride'
 require 'minitest/spec'
 
-require 'active_support/testing/assertions'
-
 require './lib/mongoid/undo'
 
 Mongoid.load!(File.expand_path('../mongoid.yml', __FILE__), 'test')

data/spec/undo_spec.rb

@@ -3,8 +3,6 @@ require File.expand_path('../spec_helper', __FILE__)
 module Mongoid
   module Undo
     describe self do
-      include ActiveSupport::Testing::Assertions
-
       class Document
         include Mongoid::Document
         include Mongoid::Undo
@@ -13,105 +11,140 @@ module Mongoid
       end
 
 
-      subject { Document.create(name: 'Version 1') }
+      subject { Document.new(name: 'foo') }
+      let(:name) { subject.name }
+      let(:action) { subject.send(:_action) }
 
 
-      describe 'undoing create' do
-        before { subject.undo }
+      describe 'creating' do
+        before { subject.save }
 
 
-        it 'deletes' do
-          subject.persisted?.wont_equal true
-          subject.deleted_at.wont_be_nil
+        it 'sets action to :create' do
+          action.must_equal :create
         end
 
 
-        describe 'and then redoing' do
-          it 'redoes' do
-            subject.redo
-            
-            subject.persisted?.must_equal true
-            subject.deleted_at.must_be_nil
+        describe 'undoing' do
+          before { subject.undo }
+
+
+          it 'deletes' do
+            subject.persisted?.wont_equal true
           end
-        end
 
 
-        it 'returns proper state' do
-          3.times do
-            subject.undo
-            subject.action.must_equal :create
+          it 'keeps :create action' do
+            action.must_equal :create
           end
-        end
-      end
 
 
-      describe 'undoing update' do
-        before { subject.update_attributes(name: subject.name.next) }
+          describe 'redoing' do
+            before { subject.redo }
 
 
-        it 'creates a new version' do
-          assert_difference 'subject.version', +1 do
-            subject.undo
-          end
-          
-          # Ensure the new version is saved to the db
-          subject.persisted?.must_equal true
-          subject.name.must_equal 'Version 1'
-        end
+            it 'restores' do
+              subject.persisted?.must_equal true
+            end
 
 
-        it 'returns proper state' do
-          3.times do
-            subject.undo
-            subject.action.must_equal :update
+            it 'keeps :create action' do
+              action.must_equal :create
+            end
           end
         end
-      end
 
 
-      describe 'undoing destroy' do
-        describe 'having one version' do
-          before { subject.destroy }
+        describe 'updating' do
+          before { subject.update_attributes(name: 'bar') }
 
 
-          it 'restores' do
-            subject.undo
-            
-            subject.persisted?.must_equal true
-            subject.deleted_at.must_be_nil
+          it 'sets action to :update' do
+            action.must_equal :update
           end
 
 
-          it 'returns proper state' do
-            3.times do
-              subject.undo
-              subject.action.must_equal :destroy
+          describe 'undoing' do
+            before { subject.undo }
+
+
+            it 'retrieves' do
+              name.must_equal 'foo'
+            end
+
+
+            it 'saves a new version' do
+              subject.version.must_equal 3
+            end
+
+
+            it 'keeps :update action' do
+              action.must_equal :update
+            end
+
+
+            describe 'redoing' do
+              before { subject.redo }
+
+
+              it 'retrieves' do
+                name.must_equal 'bar'
+              end
+
+
+              it 'saves a new version' do
+                subject.version.must_equal 4
+              end
+
+
+              it 'keeps :update action' do
+                action.must_equal :update
+              end
             end
           end
         end
 
 
-        describe 'having multiple versions' do
-          before do
-            3.times { subject.update_attributes(name: subject.name.next) }
-            subject.destroy
+        describe 'destroying' do
+          before { subject.destroy }
+
+
+          it 'sets action to :destroy' do
+            action.must_equal :destroy
           end
 
 
-          it 'restores' do
-            assert_difference 'subject.version', 0 do
-              subject.undo
-            end
-            
-            subject.persisted?.must_equal true
-            subject.deleted_at.must_be_nil
+          it 'marks as destroyed' do
+            subject.persisted?.must_equal false
           end
 
 
-          it 'returns proper state' do
-            3.times do
-              subject.undo
-              subject.action.must_equal :destroy
+          describe 'undoing' do
+            before { subject.undo }
+
+
+            it 'restores' do
+              subject.persisted?.wont_equal false
+            end
+
+
+            it 'keeps :destroy action' do
+              action.must_equal :destroy
+            end
+
+
+            describe 'redoing' do
+              before { subject.redo }
+
+
+              it 'deletes' do
+                subject.persisted?.must_equal false
+              end
+
+
+              it 'keeps :destroy action' do
+                action.must_equal :destroy
+              end
             end
           end
         end
@@ -125,19 +158,19 @@ module Mongoid
       end
 
 
-      describe :state do
+      describe :_action do
         it 'is a symbol' do
-          subject.fields['action'].options[:type].must_equal Symbol
+          subject.fields['_action'].options[:type].must_equal Symbol
         end
 
 
         it 'is versionless' do
-          subject.fields['action'].options[:versioned].must_equal false
+          subject.fields['_action'].options[:versioned].must_equal false
         end
       end
 
 
-      describe :retrieve do
+      describe 'localization' do
         class Localized
           include Mongoid::Document
           include Mongoid::Undo
@@ -146,26 +179,16 @@ module Mongoid
         end
 
 
-        subject { Localized.new }
-
-
         it 'works too with localized fields' do
-          subject.update_attributes language: 'English'
-          subject.update_attributes language: 'English Updated'
+          subject = Localized.create(language: 'English')
           
-          assert_difference 'subject.version', +1 do
-            subject.send(:retrieve)
-          end
+          subject.update_attributes(language: 'English Updated')
+          subject.undo
           subject.language.must_equal 'English'
           
-          assert_difference 'subject.version', +1 do
-            subject.send(:retrieve)
-          end
+          subject.redo
           subject.language.must_equal 'English Updated'
         end
-
-
-        after { I18n.locale = I18n.default_locale }
       end
     end
   end

metadata

@@ -2,14 +2,14 @@
 name: mongoid-undo
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mario Uher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-21 00:00:00.000000000 Z
+date: 2012-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,24 +27,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-- !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-  name: minitest
-  type: :development
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-description: mongoid-undo provides a super simple and easy to use versioning system
-  for Mongo apps.
+description: mongoid-undo provides a super simple and easy to use undo system for
+  Mongo apps.
 email: uher.mario@gmail.com
 executables: []
 extensions: []
@@ -84,5 +68,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Super simple versioning for your Mongoid app.
+summary: Super simple undo for your Mongoid app.
 test_files: []