undo-wrapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9759604e0e526194d8a1cc83679ac6f6fac72fba
+  data.tar.gz: abc741709de1f3b969e7a37febe767c4f537af53
+SHA512:
+  metadata.gz: 9325f22f5ee6c3e8e4891433f255319a1c1fdbdb30d6b5bc37d9c3afb858b7c1febd3821d60b4342ae17e360eb0a38c5f58ac37711408d056b8177baa48e2db6
+  data.tar.gz: 14b729afe94b46bbbfadfda1ba2f3910ac3aeec212968aff39800866f528c1f3e0c126b3111f20935ff9688774ad2e2ffe4b09a78dbdb571a86a20c6bf093c13

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/tags

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+undo-wrapper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.0
+  - 1.9.3
+  - ruby-head
+  - rbx
+  - jruby-19mode
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+
+script:
+  - "bundle exec rake ci:all"

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+gemspec
+
+group :test do
+  if !!ENV['CI']
+    gem "coveralls"
+  else
+    gem "pry"
+    gem "pry-plus" if "ruby" == RUBY_ENGINE
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexander Paramonov
+
+MIT License
+
+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,111 @@
+Undo
+==========
+[![Build Status](https://travis-ci.org/AlexParamonov/undo-wrapper.png?branch=master)](https://travis-ci.org/AlexParamonov/undo-wrapper)
+[![Coverage Status](https://coveralls.io/repos/AlexParamonov/undo-wrapper/badge.png?branch=master)](https://coveralls.io/r/AlexParamonov/undo-wrapper?branch=master)
+[![Code Climate](https://codeclimate.com/github/AlexParamonov/undo-wrapper.png)](https://codeclimate.com/github/AlexParamonov/undo-wrapper)
+[![Gemnasium Build Status](https://gemnasium.com/AlexParamonov/undo-wrapper.png)](http://gemnasium.com/AlexParamonov/undo-wrapper)
+[![Gem Version](https://badge.fury.io/rb/undo-wrapper.png)](http://badge.fury.io/rb/undo-wrapper)
+
+Wrapper for [Undo gem](https://github.com/AlexParamonov/undo).
+Observe changes and stores object state before the change.
+
+Contents
+---------
+1. Installation
+1. Usage
+1. Requirements
+1. Contacts
+1. Compatibility
+1. Contributing
+1. Copyright
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'undo-wrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install undo-wrapper
+
+
+Usage
+-----
+
+`Undo::wrapper` allows to wrap object in decorator:
+
+    decorated_object = Undo.wrap object
+    decorated_object.destroy
+    Undo.restore decorated_object.uuid
+
+decorated_object is a pure decorator, so it quacks like original
+object. The Undo will store object state on each hit to mutation
+methods such as `update`, `delete`, `destroy`. Those methods can be
+changed either in place or using global configuration.
+
+`store_on` defines a list of methods which may mutate object state.
+For each hit to such methods `Undo.store` will be called.
+
+By default `store_on` are `update`, `delete`, `destroy`. To
+append custom `store_on` use:
+
+    Undo::Wrapper.configure do |config|
+      config.store_on += [:put, :push, :pop]
+    end
+
+    Undo.wrap object, store_on: [:delete, :destroy]
+
+Or in place:
+
+    Undo.wrap object, store_on: :save
+
+Any option, that is not recognized by the Undo as configuration
+option, will be bypass to the serializer and storage adapter:
+
+    Undo.wrap post, include: :comments, expires_in: 1.hour
+
+
+Requirements
+------------
+1. Ruby 1.9 or above
+1. Undo gem
+
+Contacts
+--------
+Have questions or recommendations? Contact me via `alexander.n.paramonov@gmail.com`  
+Found a bug or have enhancement request? You are welcome at [Github bugtracker](https://github.com/AlexParamonov/undo-wrapper/issues)
+
+
+Compatibility
+-------------
+tested with Ruby
+
+* 2.1
+* 2.0
+* 1.9.3
+* ruby-head
+* rbx
+* jruby-19mode
+* jruby-head
+
+See [build history](http://travis-ci.org/#!/AlexParamonov/undo-wrapper/builds)
+
+
+## Contributing
+
+1. [Fork repository](http://github.com/AlexParamonov/undo-wrapper/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Copyright
+---------
+Copyright © 2014 Alexander Paramonov.
+Released under the MIT License. See the LICENSE file for further details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+namespace :ci do
+  desc "Run tests on CI"
+  RSpec::Core::RakeTask.new('all') do |t|
+    t.rspec_opts = '-fprogress'
+    t.verbose = true
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/undo/wrapper.rb

@@ -0,0 +1,41 @@
+require "undo"
+require_relative "wrapper/configuration"
+require_relative "wrapper_integration"
+require "forwardable"
+
+module Undo
+  class Wrapper < SimpleDelegator
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= Configuration.new
+    end
+
+    extend Forwardable
+    def_delegators :object, :class, :kind_of?
+
+    attr_reader :undo_uuid, :config
+
+    def initialize(object, options)
+      @object = object
+      @config = Undo::Wrapper.config.with options
+      @options = options
+
+      super object
+    end
+
+    def method_missing(method, *args, &block)
+      store if config.store_on.include? method
+      super method, *args, &block
+    end
+
+    private
+    attr_reader :object, :options
+
+    def store
+      @undo_uuid = Undo.store object, options
+    end
+  end
+end

data/lib/undo/wrapper/configuration.rb

@@ -0,0 +1,15 @@
+module Undo
+  class Wrapper < SimpleDelegator
+    class Configuration
+      attr_accessor :store_on
+
+      def initialize(attributes = {})
+        @store_on = attributes.fetch :store_on, [:delete, :destroy]
+      end
+
+      def with(attribute_updates = {})
+        self.class.new store_on: (attribute_updates.delete(:store_on) || store_on)
+      end
+    end
+  end
+end

data/lib/undo/wrapper_integration.rb

@@ -0,0 +1,5 @@
+module Undo
+  def self.wrap(object, options = {})
+    Wrapper.new object, options
+  end
+end

data/spec/integration/undo_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper_lite"
+require "undo"
+require 'undo/wrapper'
+require 'undo/integration/shared_undo_integration_examples.rb'
+
+describe Undo do
+  include_examples "undo integration"
+end

data/spec/spec_helper_lite.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+require_relative "support/ci_helper"
+require 'undo/wrapper'
+
+$: << File.expand_path('../lib', File.dirname(__FILE__))

data/spec/support/ci_helper.rb

@@ -0,0 +1,16 @@
+if !!ENV["CI"]
+  require 'simplecov'
+  require 'coveralls'
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '/vendor/'
+    minimum_coverage(90)
+  end
+else
+  require "pry"
+end

data/spec/undo/wrapper_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper_lite"
+
+describe Undo::Wrapper do
+  subject do
+    described_class.new(
+      object,
+      store_on: [:change]
+    )
+  end
+
+  let(:object) { double :object, change: "changed" }
+
+  describe "when mutation method is called" do
+    it "calls the method and returns result" do
+      expect(subject.change).to eq "changed"
+    end
+
+    it "stores object state" do
+      expect(Undo).to receive(:store).with(object, anything)
+      subject.change
+    end
+
+    it "does not store object state on another methods call" do
+      expect(Undo).not_to receive(:store)
+      subject.object_id
+    end
+  end
+end

data/spec/undo_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper_lite"
+
+describe Undo do
+  let(:object) { double :object, change: true }
+  subject { described_class }
+
+  describe "pass through options to serializer" do
+    let(:serializer) { double :serializer }
+
+    specify "from #wrap" do
+      expect(serializer).to receive(:serialize).with(object, foo: :bar)
+
+      wrapper = subject.wrap object,
+        serializer: serializer,
+        store_on: [:change],
+        foo: :bar
+
+      wrapper.change
+    end
+  end
+
+  describe "pass through options to storage" do
+    let(:storage) { double :storage }
+
+    specify "from #wrap" do
+      expect(storage).to receive(:store).with(anything, object, foo: :bar)
+
+      wrapper = subject.wrap object,
+        storage: storage,
+        store_on: [:change],
+        foo: :bar
+
+      wrapper.change
+    end
+  end
+
+  describe "#wrap" do
+    before do
+      subject::Wrapper.configure do |config|
+        config.store_on = [:change]
+      end
+    end
+
+    it "is a decorator" do
+      object = %w[hello world]
+
+      decorator = subject.wrap object
+      expect(object).to receive(:some_method)
+      decorator.some_method
+
+      expect(decorator.class).to eq Array
+      expect(decorator).to be_a Array
+    end
+
+    describe "restores" do
+      specify "using provided uuid" do
+        uuid = "uniq_identifier"
+        model = subject.wrap object, uuid: uuid
+        model.change
+
+        expect(subject.restore uuid).to eq object
+      end
+
+      specify "using gerenated uuid" do
+        uuid = object.object_id
+        model = subject.wrap object, uuid_generator: -> object { object.object_id }
+        model.change
+
+        expect(model.undo_uuid).to eq uuid
+        expect(subject.restore uuid).to eq object
+      end
+    end
+  end
+end

data/undo-wrapper.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "undo-wrapper"
+  spec.version       = IO.read("VERSION")
+  spec.authors       = ["Alexander Paramonov"]
+  spec.email         = ["alexander.n.paramonov@gmail.com"]
+  spec.summary       = %q{Observes changes and stores object state before the change}
+  spec.description   = %q{Observes changes and stores object state before the change}
+  spec.homepage      = "http://github.com/AlexParamonov/undo-wrapper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "undo", "~> 1.0"
+  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0.beta1"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: undo-wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Paramonov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: undo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+description: Observes changes and stores object state before the change
+email:
+- alexander.n.paramonov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/undo/wrapper.rb
+- lib/undo/wrapper/configuration.rb
+- lib/undo/wrapper_integration.rb
+- spec/integration/undo_spec.rb
+- spec/spec_helper_lite.rb
+- spec/support/ci_helper.rb
+- spec/undo/wrapper_spec.rb
+- spec/undo_spec.rb
+- undo-wrapper.gemspec
+homepage: http://github.com/AlexParamonov/undo-wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Observes changes and stores object state before the change
+test_files:
+- spec/integration/undo_spec.rb
+- spec/spec_helper_lite.rb
+- spec/support/ci_helper.rb
+- spec/undo/wrapper_spec.rb
+- spec/undo_spec.rb
+has_rdoc: