couchbase-eraser 0.1.0

data/LICENSE.MIT

@@ -0,0 +1,19 @@
+Copyright (c) 2013 LinkedIn
+
+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.markdown

@@ -0,0 +1,48 @@
+Overview
+--------
+
+CouchbaseEraser wraps the
+[Couchbase](http://rubydoc.info/gems/couchbase/latest/frames) client, tracks
+every write you perform, and provides a method to delete every key that you
+wrote to.
+
+This is useful for testing, where you want to avoid your tests interfering with
+each other by leaving data around in Couchbase.
+
+Usage
+-----
+
+In your `spec/spec_helper.rb` or similar, assuming you have a class
+`WidgetCache` with a class method `WidgetCache.couchbase` which returns the
+Couchbase client:
+
+```ruby
+require 'couchbase/eraser'
+
+class << WidgetCache
+  def couchbase_with_erasure
+    couchbase_eraser
+  end
+
+  def couchbase_eraser
+    @couchbase_eraser ||= Couchbase::Eraser.new(couchbase_without_erasure)
+  end
+
+  alias_method_chain :couchbase, :erasure
+end
+
+RSpec.configure do |config|
+  config.after(:each) do
+    WidgetCache.couchbase_eraser.erase_written_keys
+  end
+end
+```
+
+Limitations
+-----------
+
+For now the only supported operations are GET, SET and DELETE, although it
+shouldn't be hard to support more methods.  (For an operation which
+straightforwardly reads from or writes to a single key, it's a one-line change
+to add support for it.  Operations with more complicated semantics, such as
+map-reduce, will be harder to support.)

data/lib/couchbase/eraser.rb

@@ -0,0 +1,45 @@
+module Couchbase
+  class Eraser
+    READ_METHODS = %w(
+      get
+    ).map(&:to_sym)
+
+    WRITE_METHODS = %w(
+      set
+    ).map(&:to_sym)
+
+    attr_reader :client; private :client
+
+    def initialize(client)
+      @client = client
+      reset_keys!
+    end
+
+    def erase_written_keys
+      @keys.each do |key|
+        client.delete key, quiet: true
+      end
+      reset_keys!
+    end
+
+    ([:delete] + READ_METHODS).each do |meth|
+      meth = meth.to_sym
+      define_method meth do |key, *args, &block|
+        client.send meth, key, *args, &block
+      end
+    end
+
+    WRITE_METHODS.each do |meth|
+      meth = meth.to_sym
+      define_method meth do |key, *args, &block|
+        @keys << key
+        client.send meth, key, *args, &block
+      end
+    end
+
+    private
+    def reset_keys!
+      @keys = Set.new
+    end
+  end
+end

data/lib/couchbase-eraser.rb

@@ -0,0 +1 @@
+require File.expand_path('couchbase/eraser', File.dirname(__FILE__))

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: couchbase-eraser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sam Stokes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'CouchbaseEraser wraps the Couchbase client, tracks every write you
+  perform, and provides a method to delete every key that you wrote to.
+
+
+  This is useful for testing, where you want to avoid your tests interfering with
+  each other by leaving data around in Couchbase.
+
+'
+email:
+- sstokes@linkedin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/couchbase/eraser.rb
+- lib/couchbase-eraser.rb
+- LICENSE.MIT
+- README.markdown
+homepage: https://github.com/rapportive-oss/couchbase-eraser
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Wrapper for Couchbase client that deletes your data when you're done with
+  it
+test_files: []
+has_rdoc: