mongoid-genesis 0.0.3 → 0.0.4

data/README.md

@@ -28,7 +28,7 @@ Usage
 Mongoid Genesis is compatible with any mongoid collection or embedded object.
 
 
-**Model integration**
+#### Model integration
 
 ```ruby
 class Book
@@ -39,47 +39,58 @@ end
 
 This will create an embedded object that will store the original data.
 
-**Basic structure**
+#### Basic structure
 
 ```ruby
-book = Book.new(:title => 'Art of war', :author => 'Sun Tzu')
-#=> #<Book _id: 1, title: "Art of war", author: "Sun Tzu">
+book = Book.new(:title => 'The Art of War', :author => 'Sun Tzu')
+#=> #<Book _id: 1, title: "The Art of War", author: "Sun Tzu">
 
 book.genesis
 #=> #<BookGenesis _id: 1>
 ```
 
-**Preserve the original attribute**
+#### Preserve the original attribute
 
 ```ruby
 book.write_and_preserve_attribute(:author, 'Sun Zi')
-#=> #<Book _id: 1, title: "Art of war", author: "Sun Zi">
+#=> #<Book _id: 1, title: "The Art of War", author: "Sun Zi">
 
 book.genesis
 #=> #<BookGenesis _id: 1, author: "Sun Tzu">
 ```
 
-**After preserving the original attribute, it will not be overwritten**
+#### After preserving the original attribute, it will not be overwritten
 
 ```ruby
 book.write_and_preserve_attribute(:author, 'Sun Wu')
-#=> #<Book _id: 1, title: "Art of war", author: "Sun Wu">
+#=> #<Book _id: 1, title: "The Art of War", author: "Sun Wu">
 
 book.genesis
 #=> #<BookGenesis _id: 1, author: "Sun Tzu">
 ```
 
-**You can restore the original attribute**
+#### At all time, you can read the original attribute
+
+```ruby
+book.read_attribute_genesis(:title)
+#=> "The Art of War"
+
+book.write_and_preserve_attribute(:title, 'The Art of Peace')
+book.read_attribute_genesis(:title)
+#=> "The Art of War"
+```
+
+#### You can restore the original attribute
 
 ```ruby
 book.restore_genesis(:author)
-#=> #<Book _id: 1, title: "Art of war", author: "Sun Tzu">
+#=> #<Book _id: 1, title: "The Art of War", author: "Sun Tzu">
 
 book.genesis
 #=> #<BookGenesis _id: 1, author: nil>
 ```
 
-**To update the original document without losing the current state**
+#### To update the original document without losing the current state
 
 ```ruby
 book.write_and_preserve_attribute(:title, 'The Art of Peace')
@@ -95,6 +106,25 @@ book.reverse_genesis
 #=> #<BookGenesis _id: 1, title: "The Art of War : Revisited">
 ```
 
+Cheat Sheet
+---------
+
+#### read_attribute_genesis(field_name)
+Read the original attribute of the record. If the attribute wasn't overwritten, it will return the same thing as .read_attribute.
+
+#### restore_genesis(field_name)
+Restore the original value for the given field
+
+
+#### reverse_genesis
+Restore the record to its original state
+
+
+#### write_and_preserve_attribute(field_name, value)
+Overwrite the attribute with the *value* and saves the original value in the genesis object.
+
+
+
 Copyright
 ---------
 

data/lib/mongoid/genesis.rb

@@ -17,8 +17,14 @@ module Mongoid
       self.genesis = "#{self.class.name}Genesis".constantize.new
     end
 
+    def read_attribute_genesis(field_name)
+      source = (self.genesis and self.genesis.field_preserved?(field_name)) ? self.genesis : self
+
+      return source.read_attribute field_name
+    end
+
     def restore_genesis(field_name)
-      self.genesis.restore(field_name)
+      self.genesis.restore field_name
     end
 
     def reverse_genesis

data/spec/mongoid/genesis_spec.rb

@@ -17,34 +17,42 @@ describe Mongoid::Genesis do
       end
     end
 
-    describe "#write_and_preserve_attribute" do
+    describe "#read_attribute_genesis" do
+      context "when reading the genesis title" do
+        subject { book.read_attribute_genesis(:title) }
+
+        it { should eql 'The Art of War' }
+      end
+
+      context "when changing the author to 'Sun Wu'" do
+        before { book.write_and_preserve_attribute :author, 'Sun Wu' }
+
+        context "when reading the genesis title" do
+          subject { book.read_attribute_genesis(:title) }
+
+          it { should eql 'The Art of War' }
+        end
+      end
+
       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 reading the genesis title" do
+          subject { book.read_attribute_genesis(:title) }
 
-        context "and changing title to 'The Art of Neutrality'" do
-          before { book.write_and_preserve_attribute :title, 'The Art of Neutrality' }
+          it { should eql 'The Art of War' }
+        end
 
-          its(:title) { should eql 'The Art of Neutrality' }
-          its('genesis.title') { should eql 'The Art of War' }
+        context "and restoring the title" do
+          before { book.restore_genesis :title }
 
-          context "and rechanging it to 'The Art of War'" do
-            before { book.write_and_preserve_attribute :title, 'The Art of War' }
+          context "when reading the genesis title" do
+            subject { book.read_attribute_genesis(:title) }
 
-            its(:title) { should eql 'The Art of War' }
-            its('genesis.title') { should be_nil }
+            it { should eql 'The Art of War' }
           end
         end
       end
-
-      context "when changing title to nil" do
-        before { book.write_and_preserve_attribute :title, nil }
-
-        its(:title) { should be_nil }
-        its('genesis.title') { should eql 'The Art of War' }
-      end
     end
 
     describe "#restore_genesis" do
@@ -83,7 +91,36 @@ describe Mongoid::Genesis do
           end
         end
       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 "and 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' }
+
+          context "and rechanging it to 'The Art of War'" do
+            before { book.write_and_preserve_attribute :title, 'The Art of War' }
+
+            its(:title) { should eql 'The Art of War' }
+            its('genesis.title') { should be_nil }
+          end
+        end
+      end
+
+      context "when changing title to nil" do
+        before { book.write_and_preserve_attribute :title, nil }
+
+        its(:title) { should be_nil }
+        its('genesis.title') { should eql 'The Art of War' }
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid-genesis
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Sebastien Rosa