mongoid-undo 0.0.1

data/.gitignore

@@ -0,0 +1,25 @@
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+* First public version.

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,38 @@
+# mongoid-undo
+
+Super simple versioning for your Mongoid app.
+
+TODO: Add usage and installation instructions.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+(The MIT license)
+
+Copyright (c) 2012 Mario Uher
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('spec/**/*_spec.rb')
+end
+
+task(default: :test)

data/lib/mongoid/undo.rb

@@ -0,0 +1,51 @@
+require 'active_support/concern'
+require 'mongoid'
+
+module Mongoid::Fields
+  class Localized
+    def mongoize(object)
+      if object.is_a? ::Hash
+        object
+      else
+        { ::I18n.locale.to_s => type.mongoize(object) }
+      end
+    end
+  end
+end
+
+
+module Mongoid
+  module Undo
+    extend ActiveSupport::Concern
+
+    include Mongoid::Paranoia
+    include Mongoid::Versioning
+
+    included do
+      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 }
+          reload
+        end
+      end
+    end
+
+    def undo
+      case action
+      when :create, :destroy
+        deleted_at.present? ? restore : delete
+      when :update
+        retrieve
+      end
+    end
+    alias_method :redo, :undo
+
+  private
+    def retrieve
+      update_attributes versions.last.versioned_attributes.except('version')
+    end
+  end
+end

data/lib/mongoid/undo/version.rb

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

data/mongoid-undo.gemspec

@@ -0,0 +1,18 @@
+require './lib/mongoid/undo/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'mongoid-undo'
+  gem.version       = Mongoid::Undo::VERSION
+  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.files         = `git ls-files`.split("\n")
+  gem.require_path  = 'lib'
+
+  gem.add_dependency 'mongoid'
+
+  gem.add_development_dependency 'minitest'
+end

data/spec/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: mongoid_undo_test
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong

data/spec/spec_helper.rb

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

@@ -0,0 +1,172 @@
+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
+        
+        field :name, type: String
+      end
+
+
+      subject { Document.create(name: 'Version 1') }
+
+
+      describe 'undoing create' do
+        before { subject.undo }
+
+
+        it 'deletes' do
+          subject.persisted?.wont_equal true
+          subject.deleted_at.wont_be_nil
+        end
+
+
+        describe 'and then redoing' do
+          it 'redoes' do
+            subject.redo
+            
+            subject.persisted?.must_equal true
+            subject.deleted_at.must_be_nil
+          end
+        end
+
+
+        it 'returns proper state' do
+          3.times do
+            subject.undo
+            subject.action.must_equal :create
+          end
+        end
+      end
+
+
+      describe 'undoing update' do
+        before { subject.update_attributes(name: subject.name.next) }
+
+
+        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 'returns proper state' do
+          3.times do
+            subject.undo
+            subject.action.must_equal :update
+          end
+        end
+      end
+
+
+      describe 'undoing destroy' do
+        describe 'having one version' do
+          before { subject.destroy }
+
+
+          it 'restores' do
+            subject.undo
+            
+            subject.persisted?.must_equal true
+            subject.deleted_at.must_be_nil
+          end
+
+
+          it 'returns proper state' do
+            3.times do
+              subject.undo
+              subject.action.must_equal :destroy
+            end
+          end
+        end
+
+
+        describe 'having multiple versions' do
+          before do
+            3.times { subject.update_attributes(name: subject.name.next) }
+            subject.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
+          end
+
+
+          it 'returns proper state' do
+            3.times do
+              subject.undo
+              subject.action.must_equal :destroy
+            end
+          end
+        end
+      end
+
+
+      describe :redo do
+        it 'is a convenient alias for undo' do
+          subject.method(:redo).must_equal subject.method(:undo)
+        end
+      end
+
+
+      describe :state do
+        it 'is a symbol' do
+          subject.fields['action'].options[:type].must_equal Symbol
+        end
+
+
+        it 'is versionless' do
+          subject.fields['action'].options[:versioned].must_equal false
+        end
+      end
+
+
+      describe :retrieve do
+        class Localized
+          include Mongoid::Document
+          include Mongoid::Undo
+          
+          field :language, localize: true
+        end
+
+
+        subject { Localized.new }
+
+
+        it 'works too with localized fields' do
+          subject.update_attributes language: 'English'
+          subject.update_attributes language: 'English Updated'
+          
+          assert_difference 'subject.version', +1 do
+            subject.send(:retrieve)
+          end
+          subject.language.must_equal 'English'
+          
+          assert_difference 'subject.version', +1 do
+            subject.send(:retrieve)
+          end
+          subject.language.must_equal 'English Updated'
+        end
+
+
+        after { I18n.locale = I18n.default_locale }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-undo
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Mario Uher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: mongoid
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !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.
+email: uher.mario@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/mongoid/undo.rb
+- lib/mongoid/undo/version.rb
+- mongoid-undo.gemspec
+- spec/mongoid.yml
+- spec/spec_helper.rb
+- spec/undo_spec.rb
+homepage: https://github.com/haihappen/mongoid-undo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Super simple versioning for your Mongoid app.
+test_files: []