undo 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a5040011eba1d15fba3685916c6b860e1c27bcb
-  data.tar.gz: 13ac49e306629143828ceb2c8b9485fc331b6f13
+  metadata.gz: 20c52711aa6a7b2718cf79b9ecc238f1a77b53e2
+  data.tar.gz: fd06dc16acb71cd5fde5d9bfe4b69c8f00272a1c
 SHA512:
-  metadata.gz: 0c7b26509df4c556ff01122e53af31069be2b3ebb5b64bcd3cab7a2cc7f471130a4c11fb1fe850ca317cc1daddfecbdf4d6ed52642ef7b8dd6de34499c72c03f
-  data.tar.gz: 30eef3cf3133a1515ef46e1ada8baf4e517c92d3155ef8970514075e088bf6817ecf89761edd8ceed6ae9f46051b465ab0244d1d3eca66a5713a8f0eae89bb46
+  metadata.gz: 6a94e5461a9937c5141ca1bdd5cdbf3fb9d653de480ecf1a9c508580f0f1774060cb6902dc55bb4e74d4729ed3b5bc0e1b4b8873cca76cbe24ba617daee8cdf9
+  data.tar.gz: 11a5d31f76ddced0163edfb1d382ed03a5d7c84dfd7378a0c805f562b34eb0ed5d05659449b56f59cfdb6e119d1115bc4a69d6f233e4f57eaa766ba8a3f5f172

data/README.md

@@ -53,14 +53,35 @@ Usage
 
 ### Undo operation
 
-Wrap object in Undo decorator:
+``` ruby
+uuid = Undo.store object
+Undo.restore uuid
+```
+That is basically it :)
+
+Additionally possible to wrap object in Undo decorator:
 
 ``` ruby
-Undo.wrap object
+decorated_object = Undo.wrap object
+Undo.restore decorated_object.uuid
 ```
+Use decorated_object as usual afterwards. Undo gem will store object
+state on each hit to `mutator methods`. By default mutator_methods are
+`update`, `delete`, `destroy`. Those methods can be changed either in
+place or using global configuration (see below).
+
+To use something more advanced rather plain memory storage and
+path though serializer, configure the Undo:  
+
+``` ruby
+Undo.configure do |config|
+  config.storage = Undo::Storage::RailsCache
+  config.serializer = Undo::Serializer::ActiveModel
+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.
 
-And use it as usual afterwards. Undo gem will store object state on each hit to `mutator methods`.  
-By default mutator_methods are `update`, `delete`, `destroy`.  
 To append custom mutator_methods use  
 
 ``` ruby
@@ -69,36 +90,47 @@ Undo.configure do |config|
 end
 ```
 
-To restore previous version
+To define custom uuid generator use `uuid_generator` option:
 
-```
-Undo.restore uuid
+``` ruby
+Undo.configure do |config|
+  config.uuid_generator = ->(object) { "#{object.class.name}_#{object.id}" }
+end
 ```
 
-`uuid` is provided by wrapped object:
+### UUID
 
-```
-Undo.wrap(object).uuid
+By default uuids are generated by `SecureRandom.uuid`.
+
+UUID can be provided to both #wrap and #store methods and it will be used instead of generated one:  
+
+``` ruby
+uuid = "uniq identifier"
+
+Undo.store object, uuid: uuid
+Undo.restore uuid
 ```
 
-By default it is using `SecureRandom.uuid`.  
-To define custom uuid generator use `uuid_generator` option:
+If object respond to #uuid method then it value will be used instead:
 
 ``` ruby
-Undo.configure do |config|
-  config.uuid_generator = ->(object) { "#{object.class.name}_#{object.id}" }
-end
+object = OpenStruct.new uuid: "uniq identifier"
+Undo.store object # => uniq identifier
+Undo.restore "uniq identifier"
 ```
 
 ### Configuration options
+
 `storage` option responsible for putting and fetching object state to or from some storage.  
 Implement `put(uuid, object)` and `fetch(uuid)` methods.  
 Currently available storages:
 * `Undo::Storage::Memory` simple runtime storage (Hash)
+* `gem "undo-storage-rails_cache"` designed for Rails, but can be used with any ducktype cache store
 * `gem "undo-storage-redis"` designed to be used with `gem "redis"` from v0.1 to current
 
 See also [documentation](http://github.com/AlexParamonov/undo)
-on project repository for full list of currently available storage adapters.  
+on project repository for full list of currently available storage adapters.
+
 To convert objects to data that can be processed by storage adapters and backward, use `serializers`:
 
 ``` ruby
@@ -109,6 +141,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`
 
 Check [documentation](http://github.com/AlexParamonov/undo) on project
 repository for currently available serializers.
@@ -135,6 +168,7 @@ end
 ```
 
 ### In place configuration
+
 Any configuration option from previous chapter can be applied in
 place for given operation. To restore object from another storage use
 `storage` option:

data/lib/undo.rb

@@ -1,24 +1,44 @@
 require "undo/version"
 require "undo/config"
+require "undo/wrapper"
 
 module Undo
-  require "undo/model"
-
   def self.configure(&block)
     block_given? ? block.call(config) : config
   end
 
-  def self.config
-    @config ||= Undo::Config.new
+  def self.store(object, options = {})
+    config.with(options) do |config|
+      uuid(object, options).tap do |uuid|
+        config.storage.put uuid, config.serializer.serialize(object)
+      end
+    end
   end
 
-  def self.wrap(object, *args)
-    Model.new object, *args
+  def self.restore(uuid, options = {})
+    config.with(options) do |config|
+      config.serializer.deserialize config.storage.fetch(uuid)
+    end
   end
 
-  def self.restore(uuid, options = {})
+  def self.wrap(object, options = {})
     config.with(options) do |config|
-      config.serializer.deserialize config.storage.fetch uuid
+      Wrapper.new(
+        object,
+        uuid(object, options),
+        mutator_methods: config.mutator_methods
+      )
     end
   end
+
+  private
+  def self.uuid(object, options = {})
+    options[:uuid] || config.uuid_generator.call(object)
+  end
+
+  def self.config
+    @config ||= Undo::Config.new
+  end
+
+  private_class_method :uuid, :config
 end

data/lib/undo/version.rb

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

data/lib/undo/wrapper.rb

@@ -0,0 +1,29 @@
+require "forwardable"
+
+module Undo
+  class Wrapper < SimpleDelegator
+    extend Forwardable
+    def_delegators :object, :class, :kind_of?
+    attr_reader :uuid
+
+    def initialize(object, uuid, options = {})
+      @object = object
+      @mutator_methods = options.fetch :mutator_methods, []
+      @uuid = object.respond_to?(:uuid) ? object.uuid : uuid
+
+      super object
+    end
+
+    def method_missing(method, *args, &block)
+      store if mutator_methods.include? method
+      super method, *args, &block
+    end
+
+    private
+    attr_reader :object, :mutator_methods
+
+    def store
+      Undo.store object, uuid: uuid
+    end
+  end
+end

data/spec/undo/wrapper_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper_lite"
+
+describe Undo::Wrapper do
+  subject { described_class }
+  let(:model) { subject.new object, uuid }
+  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
+    end
+  end
+
+  describe "#uuid" do
+    it "uses provided uuid" do
+      expect(model.uuid).to eq uuid
+    end
+
+    describe "when object respond_to uuid" do
+      it "uses object#uuid instead" do
+        expect(object).to receive(:uuid) { "123" }
+        expect(model.uuid).to eq "123"
+      end
+    end
+  end
+end

data/spec/undo_spec.rb

@@ -4,6 +4,43 @@ describe Undo do
   let(:object) { double :object, change: true }
   subject { described_class }
 
+  it "stores and restores object" do
+    uuid = subject.store object
+    expect(subject.restore uuid).to eq object
+  end
+
+  it "stores and restores object using provided uuid" do
+    uuid = "uniq_identifier"
+    subject.store object, uuid: uuid
+
+    expect(subject.restore uuid).to eq object
+  end
+
+  describe "serializing" do
+    let(:storage) { double :storage }
+    let(:serializer) { double :serializer }
+
+    it "serializes data before storing" do
+      expect(serializer).to receive(:serialize).with(object).ordered
+      expect(storage).to receive(:put).ordered
+
+      subject.store object,
+        storage: storage,
+        serializer: serializer
+    end
+
+    it "deserializes data before restoring" do
+      uuid = subject.store object
+
+      expect(storage).to receive(:fetch).and_return(foo: :bar).ordered
+      expect(serializer).to receive(:deserialize).with(foo: :bar).ordered
+
+      subject.restore uuid,
+        storage: storage,
+        serializer: serializer
+    end
+  end
+
   describe "#wrap" do
     before do
       subject.configure do |config|
@@ -21,26 +58,22 @@ describe Undo do
       expect(decorator.class).to eq Array
       expect(decorator).to be_a Array
     end
-  end
 
-  describe "restores object by uuid" do
-    it "restores object" do
-      model = subject.wrap object
-      model.change
-      restored_object = subject.restore model.uuid
+    describe "restores" do
+      specify "using provided uuid" do
+        uuid = "uniq_identifier"
+        model = subject.wrap object, uuid: uuid
+        model.change
 
-      expect(restored_object).to eq object
-    end
-
-    it "restores using provided options" do
-      serializer = double :serializer
-      expect(serializer).to receive(:deserialize) { object }
+        expect(subject.restore uuid).to eq object
+      end
 
-      model = subject.wrap object
-      model.change
-      restored_object = subject.restore model.uuid, serializer: serializer
+      specify "using gerenated uuid" do
+        model = subject.wrap object
+        model.change
 
-      expect(restored_object).to eq object
+        expect(subject.restore model.uuid).to eq object
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexander Paramonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -92,14 +92,14 @@ files:
 - Rakefile
 - lib/undo.rb
 - lib/undo/config.rb
-- lib/undo/model.rb
 - lib/undo/serializer/null.rb
 - lib/undo/storage/memory.rb
 - lib/undo/version.rb
+- lib/undo/wrapper.rb
 - spec/spec_helper_lite.rb
-- spec/undo/model_spec.rb
 - spec/undo/serializer/null_spec.rb
 - spec/undo/storage/memory_spec.rb
+- spec/undo/wrapper_spec.rb
 - spec/undo_spec.rb
 - undo.gemspec
 homepage: http://github.com/AlexParamonov/undo
@@ -122,14 +122,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Reverts operation made upon object
 test_files:
 - spec/spec_helper_lite.rb
-- spec/undo/model_spec.rb
 - spec/undo/serializer/null_spec.rb
 - spec/undo/storage/memory_spec.rb
+- spec/undo/wrapper_spec.rb
 - spec/undo_spec.rb
 has_rdoc: 

data/lib/undo/model.rb

@@ -1,38 +0,0 @@
-require "forwardable"
-
-module Undo
-  class Model < SimpleDelegator
-    extend Forwardable
-    def_delegators :object, :class, :kind_of?
-
-    def initialize(object, options = {})
-      @object = object
-      @config = config.with options
-      super object
-    end
-
-    def uuid
-      @uuid ||= object.respond_to?(:uuid) ? object.uuid : generate_uuid
-    end
-
-    def method_missing(method, *args, &block)
-      store if config.mutator_methods.include? method
-      super method, *args, &block
-    end
-
-    private
-    attr_reader :object
-
-    def generate_uuid
-      config.uuid_generator.call object
-    end
-
-    def store
-      config.storage.put uuid, config.serializer.serialize(object)
-    end
-
-    def config
-      @config ||= Undo.config
-    end
-  end
-end

data/spec/undo/model_spec.rb

@@ -1,61 +0,0 @@
-require "spec_helper_lite"
-
-describe Undo::Model do
-  subject { described_class }
-  let(:model) { subject.new object }
-  let(:object) { double :object }
-
-  describe "#uuid" do
-    it "using object#uuid" do
-      expect(object).to receive(:uuid) { "123" }
-      expect(model.uuid).to eq "123"
-    end
-
-    context "object do not respond to #uuid" do
-      it "using configured uuid gerenator" do
-        model = subject.new object, uuid_generator: proc { "123" }
-        expect(model.uuid).to eq "123"
-      end
-
-      it "using SecureRandom uuid gerenator by default" do
-        expect(SecureRandom).to receive(:uuid) { "123" }
-        expect(model.uuid).to eq "123"
-      end
-
-      it "passes object to custom uuid gerenator" do
-        uuid_generator = double :uuid_generator
-        expect(uuid_generator).to receive(:call).with(object)
-
-        model = subject.new object, uuid_generator: uuid_generator
-        model.uuid
-      end
-
-    end
-
-    describe "stores object data" do
-      let(:object) { double :object, change: true }
-      let(:storage) { double :storage }
-      let(:serializer) { double :serializer }
-
-      specify "when called mutator method" do
-        expect(storage).to receive(:put)
-
-        model = subject.new object,
-                            storage: storage,
-                            mutator_methods: [:change]
-        model.change
-      end
-
-      it "serializes data before storing" do
-        expect(serializer).to receive(:serialize).with(object).ordered
-        expect(storage).to receive(:put).ordered
-
-        model = subject.new object,
-                            storage: storage,
-                            serializer: serializer,
-                            mutator_methods: [:change]
-        model.change
-      end
-    end
-  end
-end