undo-storage-rails_cache 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTc4ZDI0OWYyN2ZlMDdjZjU4NWNmYWQxOTg4MjM1MGY1YTQyMDgyZQ==
-  data.tar.gz: !binary |-
-    NzIzMTMxODY0ODA1MGU5NjM4Y2UyMGJjMTdjNGRlYWE2ZTJhNmJiOQ==
+SHA1:
+  metadata.gz: 402dfa78018e83220e282c74986babe501261407
+  data.tar.gz: febbba1204c31d2604f25e68034d69759c62937c
 SHA512:
-  metadata.gz: !binary |-
-    NTY5OTVjMDA0YWM4NzU2Zjg0MGVkZGRhZmI4MTBlYTdhOTZlMDljM2Q3NjA0
-    MjAzNDlmMzY1MzQ2NzFmZDAwZWZmODdmZTdhYzhhZDNkZDE3YzRjMGRlZDJi
-    OGExMjhhY2E0NWVhN2Y1OTQ2NTU1OGY1NTlhMjg4NzE3OGJlYjE=
-  data.tar.gz: !binary |-
-    NTVhZmNkYzNiN2RiMGU0OGFmNGY2YjE3NmJhMTRlY2M0MDA1MjE2MDlhNjM4
-    M2Y3ODkxNDliMjgxYThjMzg4MDEyZmY3N2YzMTdmMzlkN2EyNWUyZWZmZTAw
-    YmI4NDk4MDdlNmIxNTg1OGQyZjZmNDJkNDM3ZjMxOWM0YmNlNjk=
+  metadata.gz: a07b94576f504783b2e6efaa1fce4c80241aa04f9923634f4489cbffd47231d2635d78bdd32fe8bdf27b0d0121b5c2cfa9309ef79f285fddcfe641ca5b0a885b
+  data.tar.gz: 7b8749b26ea40931c2e21a357b5eb046471e5ca686316d4caf82f30dbd381954f3f2eb2331f8f5653c30d7cd1b6a19b67f957db4a3aed75a34c12d8283105551

data/.ruby-version

@@ -1 +1 @@
-2.1.0-p0
+2.1.1

data/Gemfile

@@ -2,7 +2,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rails', '4.0.2'
+  gem 'rails', '>= 4.0.2'
+
   if !!ENV['CI']
     gem "coveralls"
   else
@@ -10,9 +11,3 @@ group :test do
     gem "pry-plus" if "ruby" == RUBY_ENGINE
   end
 end
-
-platforms :rbx do
-  gem 'racc'
-  gem 'rubysl', '~> 2.0'
-  gem 'psych'
-end

data/README.md

@@ -1,15 +1,19 @@
 Undo
 ==========
 [![Build Status](https://travis-ci.org/AlexParamonov/undo-storage-rails_cache.png?branch=master)](https://travis-ci.org/AlexParamonov/undo-storage-rails_cache)
-[![Gemnasium Build Status](https://gemnasium.com/AlexParamonov/undo-storage-rails_cache.png)](http://gemnasium.com/AlexParamonov/undo-storage-rails_cache)
 [![Coverage Status](https://coveralls.io/repos/AlexParamonov/undo-storage-rails_cache/badge.png?branch=master)](https://coveralls.io/r/AlexParamonov/undo-storage-rails_cache?branch=master)
+[![Code Climate](https://codeclimate.com/github/AlexParamonov/undo-storage-rails_cache.png)](https://codeclimate.com/github/AlexParamonov/undo-storage-rails_cache)
+[![Gemnasium Build Status](https://gemnasium.com/AlexParamonov/undo-storage-rails_cache.png)](http://gemnasium.com/AlexParamonov/undo-storage-rails_cache)
 [![Gem Version](https://badge.fury.io/rb/undo-storage-rails_cache.png)](http://badge.fury.io/rb/undo-storage-rails_cache)
 
-Rails.cache adapter for Undo gem.
+Rails.cache adapter for [Undo gem](https://github.com/AlexParamonov/undo).
+Designed to be used with Rails cache, but it can be used with any
+similarly quaking cache store. Rails constant may not even be defined.
 
 Contents
 ---------
 1. Installation
+1. Usage
 1. Requirements
 1. Contacts
 1. Compatibility
@@ -31,12 +35,32 @@ Or install it yourself as:
 
     $ gem install undo-storage-rails_cache
 
+
+Usage
+-----
+
+    Undo.configure do |config|
+      config.storage = Undo::Storage::RailsCache.new
+    end
+
+Default options will applied on each call to cache storage:
+
+    Undo.configure do |config|
+      config.storage = Undo::Storage::RailsCache.new(expires_in: 1.hour)
+    end
+
+As any Undo storage it gets argument bypassed from #store, #restore and #wrap:
+
+    Undo.store object, expires_in: 1.minute
+
+
 Requirements
 ------------
 1. Ruby 1.9 or above
+1. [The Undo](https://github.com/AlexParamonov/undo).
 
 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-storage-rails_cache/issues)
 
@@ -58,7 +82,7 @@ See [build history](http://travis-ci.org/#!/AlexParamonov/undo-storage-rails_cac
 
 ## Contributing
 
-1. Fork repository ( http://github.com/AlexParamonov/undo-storage-rails_cache/fork )
+1. [Fork repository](http://github.com/AlexParamonov/undo-storage-rails_cache/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`)

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/undo/storage/rails_cache.rb

@@ -1,34 +1,32 @@
-require 'json'
+require 'undo/storage/adapter'
 
 module Undo
   module Storage
-    class RailsCache
-      VERSION = "0.0.1"
-
+    class RailsCache < Adapter
       def initialize(cache = nil, options = {})
         @cache = cache
         @cache ||= Rails.cache if defined? Rails
-        @options = options
-      end
 
-      def put(uuid, object)
-        cache.write uuid, serialize(object), options
+        super options
       end
 
-      def fetch(uuid)
-        deserialize cache.read uuid, options
+      def store(uuid, object, options = {})
+        cache.write uuid,
+                    pack(object),
+                    adapter_options(options)
       end
 
-      private
-      attr_reader :cache, :options
-
-      def serialize(object)
-        object.to_json
+      def fetch(uuid, options = {})
+        raise KeyError, "key #{uuid} not found" unless cache.exist? uuid
+        unpack cache.read uuid, adapter_options(options)
       end
 
-      def deserialize(data)
-        JSON.load data
+      def delete(uuid, options = {})
+        cache.delete uuid, adapter_options(options)
       end
+
+      private
+      attr_reader :cache
     end
   end
 end

data/spec/integration/undo_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper_rails"
+require "undo"
+require 'undo/integration/shared_undo_integration_examples.rb'
+
+Undo.configure do |config|
+  config.storage = Undo::Storage::RailsCache.new
+end
+
+describe Undo do
+  include_examples "undo integration"
+end

data/spec/spec_helper_lite.rb

@@ -1,11 +1,4 @@
-if !!ENV['CI']
-  require 'coveralls'
-  Coveralls.wear!
-else
-  require 'pry'
-end
-
-ENV['RAILS_ENV'] ||= 'test'
 require 'rspec'
+require_relative "support/ci_helper"
 
 $: << File.expand_path('../lib', File.dirname(__FILE__))

data/spec/spec_helper_rails.rb

@@ -1,11 +1,3 @@
-if !!ENV['CI']
-  require 'coveralls'
-  Coveralls.wear!
-else
-  require 'pry'
-end
-
 ENV['RAILS_ENV'] ||= 'test'
-
+require_relative "spec_helper_lite"
 require File.expand_path('../rails_app/config/environment', __FILE__)
-require 'rspec'

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/storage/rails_cache_integration_spec.rb

@@ -1,20 +1,29 @@
 require "spec_helper_rails"
 
 describe Undo::Storage::RailsCache do
+  it "stores and fetches object" do
+    subject.store 123, "hello" => "world"
+    expect(subject.fetch 123).to eq "hello" => "world"
+  end
+
+  it "deletes stored data" do
+    subject.store 123, "hello" => "world"
+    subject.delete 123
+    expect { subject.fetch 123 }.to raise_error(KeyError)
+  end
+
   it "uses Rails.cache by default" do
-    adapter = described_class.new
     expect(Rails.cache).to receive :write
-    adapter.put "foo", "bar"
+    subject.store "foo", "bar"
   end
 
-  it "stores object in cache" do
-    adapter = described_class.new
-    adapter.put "123", "hello" => "world"
-    expect(adapter.fetch "123").to eq "hello" => "world"
-  end
+  describe "options" do
+    it "accepts known options" do
+      expect { subject.store "foo", "bar", expires_in: 1.minute }.not_to raise_error
+    end
 
-  it "sends params correctly" do
-    adapter = described_class.new Rails.cache, expires_in: 1.second
-    expect { adapter.put "foo", "bar" }.not_to raise_error
+    it "silently ignores unknown options" do
+      expect { subject.store "foo", "bar", unknown: [:something] }.not_to raise_error
+    end
   end
 end

data/spec/undo/storage/rails_cache_spec.rb

@@ -2,35 +2,32 @@ require "spec_helper_lite"
 require 'undo/storage/rails_cache'
 
 describe Undo::Storage::RailsCache do
-  let(:adapter) { described_class.new cache }
-  let(:cache) { double :cache }
+  subject { described_class.new cache }
+  let(:cache) { double :cache, exist?: true }
 
-  it "writes hash to cache as json" do
-    expect(cache).to receive(:write).with("123", '{"hello":"world"}', anything)
-    adapter.put "123", "hello" => "world"
-  end
+  it "uses provided cache storage" do
+    subject = described_class.new cache
 
-  it "reads hash from cache" do
-    expect(cache).to receive(:read).with("123", anything) { '{"hello":"world"}' }
-    expect(adapter.fetch "123").to eq "hello" => "world"
+    expect(cache).to receive :write
+    subject.store "foo", "bar"
   end
 
   it "does not raise when created without arguments" do
     expect { described_class.new }.not_to raise_error
   end
 
-  describe "options" do
-    let(:adapter) { described_class.new cache, options }
-    let(:options) { Hash.new }
+  describe "default options" do
+    subject { described_class.new cache, options }
+    let(:options) { { additional: :option } }
 
     it "sends provided options to cache.read" do
-      expect(cache).to receive(:read).with any_args, options
-      adapter.fetch "foo"
+      expect(cache).to receive(:read).with anything, options
+      subject.fetch "foo"
     end
 
     it "sends provided options to cache.write" do
-      expect(cache).to receive(:write).with any_args, options
-      adapter.put "foo", "bar"
+      expect(cache).to receive(:write).with anything, anything, options
+      subject.store "foo", "bar"
     end
 
     before do
@@ -38,4 +35,26 @@ describe Undo::Storage::RailsCache do
       allow(cache).to receive(:read).with(any_args) { { :foo => :bar }.to_json }
     end if RUBY_VERSION < "2.0"
   end
+
+  describe "options" do
+    let(:object) { double :object }
+    let(:options) { { foo: :bar } }
+
+    it "accepts options per method" do
+      cache.as_null_object
+
+      expect do
+        subject.store 123, object, options
+        subject.fetch 123, options
+        subject.delete 123, options
+      end.not_to raise_error
+    end
+
+    it "has higher priority than default options" do
+      subject = described_class.new cache, expires_in: 10
+
+      expect(cache).to receive(:write).with anything, anything, expires_in: 1
+      subject.store 123, object, expires_in: 1
+    end
+  end
 end

data/undo-storage-rails_cache.gemspec

@@ -1,15 +1,17 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'undo/storage/rails_cache'
 
 Gem::Specification.new do |spec|
   spec.name          = "undo-storage-rails_cache"
-  spec.version       = Undo::Storage::RailsCache::VERSION
+  spec.version       = IO.read("VERSION")
   spec.authors       = ["Alexander Paramonov"]
   spec.email         = ["alexander.n.paramonov@gmail.com"]
   spec.summary       = %q{Rails.cache storage adapter for Undo}
-  spec.description   = %q{Rails.cache storage adapter for Undo}
+  spec.description   = %q{
+Rails.cache storage adapter for Undo. Does not depend on Rails and can
+be used with any similarly quaking storage.
+  }
   spec.homepage      = "http://github.com/AlexParamonov/undo-storage-rails_cache"
   spec.license       = "MIT"
 
@@ -18,7 +20,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  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

@@ -1,75 +1,92 @@
 --- !ruby/object:Gem::Specification
 name: undo-storage-rails_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexander Paramonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+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.5'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        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: Rails.cache storage adapter for Undo
+description: "\nRails.cache storage adapter for Undo. Does not depend on Rails and
+  can\nbe used with any similarly quaking storage.\n  "
 email:
 - alexander.n.paramonov@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- VERSION
 - lib/undo/storage/rails_cache.rb
+- spec/integration/undo_spec.rb
 - spec/rails_app/.gitignore
 - spec/rails_app/Rakefile
 - spec/rails_app/config.ru
@@ -80,6 +97,7 @@ files:
 - spec/rails_app/script/rails
 - spec/spec_helper_lite.rb
 - spec/spec_helper_rails.rb
+- spec/support/ci_helper.rb
 - spec/undo/storage/rails_cache_integration_spec.rb
 - spec/undo/storage/rails_cache_spec.rb
 - undo-storage-rails_cache.gemspec
@@ -93,21 +111,22 @@ 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.2.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Rails.cache storage adapter for Undo
 test_files:
+- spec/integration/undo_spec.rb
 - spec/rails_app/.gitignore
 - spec/rails_app/Rakefile
 - spec/rails_app/config.ru
@@ -118,6 +137,7 @@ test_files:
 - spec/rails_app/script/rails
 - spec/spec_helper_lite.rb
 - spec/spec_helper_rails.rb
+- spec/support/ci_helper.rb
 - spec/undo/storage/rails_cache_integration_spec.rb
 - spec/undo/storage/rails_cache_spec.rb
 has_rdoc: