undo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20c52711aa6a7b2718cf79b9ecc238f1a77b53e2
-  data.tar.gz: fd06dc16acb71cd5fde5d9bfe4b69c8f00272a1c
+  metadata.gz: 4898ed46bb0f2c3a761f82478c73b9d78c6e1a7d
+  data.tar.gz: 6a3b917da4a4ebd61757e227d1e54e090dd23c05
 SHA512:
-  metadata.gz: 6a94e5461a9937c5141ca1bdd5cdbf3fb9d653de480ecf1a9c508580f0f1774060cb6902dc55bb4e74d4729ed3b5bc0e1b4b8873cca76cbe24ba617daee8cdf9
-  data.tar.gz: 11a5d31f76ddced0163edfb1d382ed03a5d7c84dfd7378a0c805f562b34eb0ed5d05659449b56f59cfdb6e119d1115bc4a69d6f233e4f57eaa766ba8a3f5f172
+  metadata.gz: 5675e00c800a9e4e6a590e112fe331b211e6f57f97d1b851a335343c721e89c06c4d0325617a8696da4a8fb8e25f1cf7b38bee0c2d3e85d9de42428abfa23e86
+  data.tar.gz: 955338eac937b4825f4604c1601d43b0032d6bdf70b685ea1469d3ed3aef8329be1bf085284c3fd765ba03eb5338d8b967e08c33afa63d5b42755cd87f082095

data/README.md

@@ -71,36 +71,21 @@ state on each hit to `mutator methods`. By default mutator_methods are
 place or using global configuration (see below).
 
 To use something more advanced rather plain memory storage and
-path though serializer, configure the Undo:  
+pass through serializer, configure the Undo:  
 
 ``` ruby
 Undo.configure do |config|
-  config.storage = Undo::Storage::RailsCache
-  config.serializer = Undo::Serializer::ActiveModel
+  config.storage = Undo::Storage::RailsCache.new
+  config.serializer = Undo::Serializer::ActiveModel.new
 end
 ```
 gem `undo-storage-rails_cache` and gem `undo-serializer-active_model` are required for this.  
 There are a bunch of other Rails free adapters. Read about them in configuration chapter below.
 
-To append custom mutator_methods use  
-
-``` ruby
-Undo.configure do |config|
-  config.mutator_methods += [:put, :push, :pop]
-end
-```
-
-To define custom uuid generator use `uuid_generator` option:
-
-``` ruby
-Undo.configure do |config|
-  config.uuid_generator = ->(object) { "#{object.class.name}_#{object.id}" }
-end
-```
-
 ### UUID
 
-By default uuids are generated by `SecureRandom.uuid`.
+By default uuids are generated by `SecureRandom.uuid`. The generator is managed by `uuid_generator` 
+setting (see below in configuration chapter).
 
 UUID can be provided to both #wrap and #store methods and it will be used instead of generated one:  
 
@@ -141,7 +126,7 @@ end
 
 Currently available serializers:
 * `Undo::Serializer::Null` pass though serializer. It do nothing and returns whatever passed to it.
-* `gem undo-serializer-active_model`
+* `gem undo-serializer-active_model` depends on #attributes method so can be used with Virtus and PORO objects as well as with ActiveRecord objects.
 
 Check [documentation](http://github.com/AlexParamonov/undo) on project
 repository for currently available serializers.
@@ -159,11 +144,11 @@ end
 
 `mutator methods` option defines a list of methods that will trigger storage#put
 By default mutator_methods are `update`, `delete`, `destroy`.  
-To set custom mutator_methods use  
+To append custom mutator_methods use  
 
 ``` ruby
 Undo.configure do |config|
-  config.mutator_methods = [:put, :push, :pop]
+  config.mutator_methods += [:put, :push, :pop]
 end
 ```
 
@@ -191,6 +176,13 @@ post.destroy
 Undo.restore uuid, serializer: PostDeserializer.new(options)
 ```
 
+Additionally when given serializer accepts additional options to
+`#serialize` or `#deserialize`, those options can be set in place as well:
+
+``` ruby
+Undo.store post, include: :comments
+```
+
 
 Contacts
 -------------

data/lib/undo.rb

@@ -10,24 +10,24 @@ module Undo
   def self.store(object, options = {})
     config.with(options) do |config|
       uuid(object, options).tap do |uuid|
-        config.storage.put uuid, config.serializer.serialize(object)
+        config.storage.put uuid,
+                           config.serializer.serialize(object, config.filter(options))
       end
     end
   end
 
   def self.restore(uuid, options = {})
     config.with(options) do |config|
-      config.serializer.deserialize config.storage.fetch(uuid)
+      config.serializer.deserialize config.storage.fetch(uuid),
+                                    config.filter(options)
+
     end
   end
 
   def self.wrap(object, options = {})
+    options[:uuid] ||= uuid object, options
     config.with(options) do |config|
-      Wrapper.new(
-        object,
-        uuid(object, options),
-        mutator_methods: config.mutator_methods
-      )
+      Wrapper.new object, options.merge(mutator_methods: config.mutator_methods)
     end
   end
 

data/lib/undo/config.rb

@@ -25,5 +25,11 @@ module Undo
 
       block_given? ? block.call(config) : config
     end
+
+    def filter(options)
+      options.delete_if do |key, _|
+        attributes.keys.include? key
+      end
+    end
   end
 end

data/lib/undo/serializer/null.rb

@@ -1,11 +1,11 @@
 module Undo
   module Serializer
     class Null
-      def serialize(object)
+      def serialize(object, options = {})
         object
       end
 
-      def deserialize(object)
+      def deserialize(object, options = {})
         object
       end
     end

data/lib/undo/version.rb

@@ -1,3 +1,3 @@
 module Undo
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/undo/wrapper.rb

@@ -6,10 +6,11 @@ module Undo
     def_delegators :object, :class, :kind_of?
     attr_reader :uuid
 
-    def initialize(object, uuid, options = {})
+    def initialize(object, options = {})
       @object = object
-      @mutator_methods = options.fetch :mutator_methods, []
-      @uuid = object.respond_to?(:uuid) ? object.uuid : uuid
+      @mutator_methods = options.delete(:mutator_methods) || []
+      @uuid = object.respond_to?(:uuid) ? object.uuid : options.fetch(:uuid)
+      @options = options
 
       super object
     end
@@ -20,10 +21,14 @@ module Undo
     end
 
     private
-    attr_reader :object, :mutator_methods
+    attr_reader :object, :options
+
+    def mutator_methods
+      Kernel.Array(@mutator_methods)
+    end
 
     def store
-      Undo.store object, uuid: uuid
+      Undo.store object, options.merge(uuid: uuid)
     end
   end
 end

data/spec/undo/wrapper_spec.rb

@@ -2,14 +2,12 @@ require "spec_helper_lite"
 
 describe Undo::Wrapper do
   subject { described_class }
-  let(:model) { subject.new object, uuid }
+  let(:model) { subject.new object, uuid: uuid, mutator_methods: mutator_methods }
+  let(:mutator_methods) { [:change] }
   let(:object) { double :object, change: true }
   let(:uuid) { double :uuid }
 
   describe "storage" do
-    let(:model) { subject.new object, uuid, mutator_methods: mutator_methods }
-    let(:mutator_methods) { [:change] }
-
     it "stores object when mutator method is called" do
       expect(model).to receive(:store)
       model.change
@@ -25,6 +23,8 @@ describe Undo::Wrapper do
       it "uses object#uuid instead" do
         expect(object).to receive(:uuid) { "123" }
         expect(model.uuid).to eq "123"
+        expect(Undo).to receive(:store).with(object,  hash_including(uuid: "123"))
+        model.change
       end
     end
   end

data/spec/undo_spec.rb

@@ -21,7 +21,7 @@ describe Undo do
     let(:serializer) { double :serializer }
 
     it "serializes data before storing" do
-      expect(serializer).to receive(:serialize).with(object).ordered
+      expect(serializer).to receive(:serialize).with(object, anything).ordered
       expect(storage).to receive(:put).ordered
 
       subject.store object,
@@ -33,12 +33,41 @@ describe Undo do
       uuid = subject.store object
 
       expect(storage).to receive(:fetch).and_return(foo: :bar).ordered
-      expect(serializer).to receive(:deserialize).with(foo: :bar).ordered
+      expect(serializer).to receive(:deserialize).with({ foo: :bar }, anything).ordered
 
       subject.restore uuid,
         storage: storage,
         serializer: serializer
     end
+
+    it "pass through options from store to serialize" do
+      expect(serializer).to receive(:serialize).with(object, foo: :bar)
+
+      subject.store object,
+        serializer: serializer,
+        foo: :bar
+    end
+
+    it "pass through options from wrap to serialize" do
+      expect(serializer).to receive(:serialize)
+
+      wrapper = subject.wrap object,
+        serializer: serializer,
+        mutator_methods: :change,
+        foo: :bar
+
+      wrapper.change
+    end
+
+
+    it "pass through options from restore to deserialize" do
+      uuid = subject.store object
+      expect(serializer).to receive(:deserialize).with(object, foo: :bar)
+
+      subject.restore uuid,
+        serializer: serializer,
+        foo: :bar
+    end
   end
 
   describe "#wrap" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexander Paramonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus