mongoid-genesis 0.0.1

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 De Marque inc.
+
+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,98 @@
+Mongoid Genesis
+===============
+
+[![Build Status](https://secure.travis-ci.org/demarque/mongoid-genesis.png?branch=master)](http://travis-ci.org/demarque/mongoid-genesis)
+
+Mongoid Genesis will give you the ability to override data in your model
+without losing the initial data.
+
+Install
+-------
+
+```
+gem install mongoid_genesis
+```
+
+Rails 3
+-------
+
+In your Gemfile:
+
+```ruby
+gem 'mongoid_genesis'
+```
+
+Usage
+-----
+
+Mongoid Genesis is compatible with any mongoid collection or embedded object.
+
+
+**Model integration**
+
+```ruby
+class Book
+  include Mongoid::Document
+  include Mongoid::Genesis
+end
+```
+
+This will create an embedded object that will store the original data.
+
+**Basic manipulation**
+
+```ruby
+book = Book.new(:title => 'Art of war', :author => 'Sun Tzu')
+#=> #<Book _id: 1, title: "Art of war", author: "Sun Tzu">
+
+book.genesis
+#=> #<BookGenesis _id: 1>
+
+
+# The origin will be save
+
+book.write_and_preserve_attribute(:author, 'Sun Zi')
+#=> #<Book _id: 1, title: "Art of war", author: "Sun Zi">
+
+book.genesis
+#=> #<BookGenesis _id: 1, author: "Sun Tzu">
+
+
+# The origin will not be overwritten
+
+book.write_and_preserve_attribute(:author, 'Sun Wu')
+#=> #<Book _id: 1, title: "Art of war", author: "Sun Wu">
+
+book.genesis
+#=> #<BookGenesis _id: 1, author: "Sun Tzu">
+
+
+# Restoring the origin
+
+book.restore_genesis(:author)
+#=> #<Book _id: 1, title: "Art of war", author: "Sun Tzu">
+
+book.genesis
+#=> #<BookGenesis _id: 1, author: nil>
+
+
+# To make some modifications on the original without losing the current state
+
+book.write_and_preserve_attribute(:title, 'The Art of Peace')
+book.reverse_genesis
+
+#=> #<Book _id: 1, title: "The Art of War", author: "Sun Tzu">
+#=> #<BookGenesis _id: 1, title: "The Art of Peace">
+
+book.title = "The Art of War : Revisited"
+book.reverse_genesis
+
+#=> #<Book _id: 1, title: "The Art of Peace", author: "Sun Tzu">
+#=> #<BookGenesis _id: 1, title: "The Art of War : Revisited">
+
+```
+
+Copyright
+---------
+
+Copyright (c) 2012 De Marque inc. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/mongoid/genesis/storage.rb

@@ -0,0 +1,39 @@
+module Mongoid
+  module Genesis
+    module Storage
+      def field_preserved?(field_name)
+        self.attribute_present? field_name
+      end
+
+      def preserve(field_name)
+        self.write_attribute(field_name, self.alter.read_attribute(field_name)) if not field_preserved? field_name
+      end
+
+      def restore(field_name)
+        if field_preserved? field_name
+          self.alter.write_attribute(field_name, self.read_attribute(field_name))
+          self.remove_attribute(field_name)
+        end
+      end
+
+      def reverse
+        self.attributes.each do |name, value|
+          if not ['_id', '_type'].include? name
+            buffer = self.alter.read_attribute(name)
+
+            self.alter.write_attribute(name, self.read_attribute(name))
+            self.write_attribute(name, buffer)
+          end
+        end
+      end
+
+      def method_missing(*args, &block)
+        if self.alter.respond_to? args[0].to_s
+          self.read_attribute args[0]
+        else
+          raise NoMethodError.new("undefined local variable or method '#{args.first}' for #{self.class}")
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/genesis.rb

@@ -0,0 +1,35 @@
+module Mongoid
+  module Genesis
+    extend ActiveSupport::Concern
+
+    def self.included(base)
+      Object.const_set("#{base.name}Genesis", Class.new do
+        include Mongoid::Document
+        include Mongoid::Genesis::Storage
+
+        embedded_in :alter, :class_name => base.name, :inverse_of => :genesis
+      end)
+
+      base.embeds_one :genesis, :class_name => "#{base.name}Genesis", :inverse_of => :alter
+    end
+
+    def init_genesis
+      self.genesis = "#{self.class.name}Genesis".constantize.new
+    end
+
+    def restore_genesis(field_name)
+      self.genesis.restore(field_name)
+    end
+
+    def reverse_genesis
+      self.genesis.reverse
+    end
+
+    def write_and_preserve_attribute(field_name, value)
+      init_genesis if not self.genesis
+      self.genesis.preserve field_name
+
+      self.write_attribute(field_name, value)
+    end
+  end
+end

data/lib/mongoid_genesis.rb

@@ -0,0 +1,2 @@
+require File.expand_path(File.dirname(__FILE__) + '/mongoid/genesis')
+require File.expand_path(File.dirname(__FILE__) + '/mongoid/genesis/storage')

data/spec/mongoid/genesis_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Mongoid::Genesis do
+
+  context 'with the book "The Art of War" written by Sun Tzu' do
+    let(:book) { Book.new(:title => 'The Art of War', :author => 'Sun Tzu') }
+
+    subject { book }
+
+    describe "#init_genesis" do
+      before { book.init_genesis }
+
+      its('genesis.title') { should be_nil }
+
+      context "genesis.pages" do
+        specify { expect { book.genesis.pages }.to raise_error(NoMethodError) }
+      end
+    end
+
+    describe "#write_and_preserve_attribute" do
+      context "when changing title to 'The Art of Peace'" do
+        before { book.write_and_preserve_attribute :title, 'The Art of Peace' }
+
+        its(:title) { should eql 'The Art of Peace' }
+        its('genesis.title') { should eql 'The Art of War' }
+
+        context "when changing title to 'The Art of Neutrality'" do
+          before { book.write_and_preserve_attribute :title, 'The Art of Neutrality' }
+
+          its(:title) { should eql 'The Art of Neutrality' }
+          its('genesis.title') { should eql 'The Art of War' }
+        end
+      end
+    end
+
+    describe "#restore_genesis" do
+      context "when changing title to 'The Art of Peace'" do
+        before { book.write_and_preserve_attribute :title, 'The Art of Peace' }
+
+        context "when restoring genesis for title" do
+          before { book.restore_genesis(:title) }
+
+          its(:title) { should eql 'The Art of War' }
+          its('genesis.title') { should be_nil }
+        end
+      end
+    end
+
+    describe "#reverse_genesis" do
+      context "when changing title to 'The Art of Peace' and the author to 'Sun Wu'" do
+        before { book.write_and_preserve_attribute :title, 'The Art of Peace' }
+        before { book.write_and_preserve_attribute :author, 'Sun Wu' }
+
+        context "when reversing genesis" do
+          before { book.reverse_genesis }
+
+          its(:title) { should eql 'The Art of War' }
+          its(:author) { should eql 'Sun Tzu' }
+
+          context "when making raw change on title to 'The Art of War : Revisited'" do
+            before { book.title = 'The Art of War : Revisited' }
+
+            context "and reversing genesis again" do
+              before { book.reverse_genesis }
+
+              its(:title) { should eql 'The Art of Peace' }
+              its('genesis.title') { should eql 'The Art of War : Revisited' }
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require "rubygems"
+require "bundler/setup"
+
+require 'rspec'
+
+require 'mongoid'
+require File.expand_path('../../lib/mongoid_genesis', __FILE__)
+
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('mongoid_genesis_test')
+  config.allow_dynamic_fields = false
+end
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.after :each do
+    Mongoid.master.collections.reject { |c| c.name =~ /^system\./ }.each(&:drop)
+  end
+end

data/spec/support/models/book.rb

@@ -0,0 +1,10 @@
+class Book
+  include Mongoid::Document
+  include Mongoid::Genesis
+
+  field :author
+  field :title
+  field :url
+
+  attr_accessible :author, :title, :url
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-genesis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sebastien Rosa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &2152274840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152274840
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &2152273320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2152273320
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152272120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *2152272120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152270580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152270580
+- !ruby/object:Gem::Dependency
+  name: metrical
+  requirement: &2152269060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152269060
+description: Mongoid Genesis will give you the ability to override attribute values
+  without losing the original one.
+email:
+- sebastien@demarque.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- lib/mongoid/genesis/storage.rb
+- lib/mongoid/genesis.rb
+- lib/mongoid_genesis.rb
+- spec/mongoid/genesis_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/book.rb
+- LICENSE
+- README.md
+- Rakefile
+- Gemfile
+homepage: https://github.com/demarque/mongoid-genesis
+licenses:
+- MIT
+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-genesis
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Preserve the original data of a model.
+test_files: []