memcached_snappy_store 0.0.1

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
+.ruby-version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in memcached_snappy_store.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Camilo Lopez
+
+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,36 @@
+# MemcachedSnappyStore
+
+ActiveSupport cache store that adds snappy compression at the cost of making the ```incr, decr, add``` operations unavailable. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'memcached_snappy_store'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memcached_snappy_store
+
+## Usage
+
+In your environment file:
+
+```ruby
+
+  config.cache_store = :memcached_snappy_store,  
+    Memcached::Rails.new(:servers => ['memcached1.foo.com', 'memcached2.foo.com']) 
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib/**/*"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/active_support/cache/memcached_snappy_store.rb

@@ -0,0 +1,48 @@
+module ActiveSupport
+  module Cache
+    class MemcachedSnappyStore < Cache::MemCacheStore
+      class UnsupportedOperation < StandardError; end
+
+      def increment(*args)
+        raise UnsupportedOperation.new("increment is not supported by: #{self.class.name}")
+      end
+
+      def decrement(*args)
+        raise UnsupportedOperation.new("decrement is not supported by: #{self.class.name}")
+      end
+
+      protected
+
+      def write_entry(key, entry, options)
+        # normally unless_exist would make this method use add,  add will not make sense on compressed entries
+        raise UnsupportedOperation.new("unless_exist would try to use the unsupported add method") if options && options[:unless_exist]
+
+        value = options[:raw] ? entry.value.to_s : entry
+        expires_in = options[:expires_in].to_i
+        if expires_in > 0 && !options[:raw]
+          # Set the memcache expire a few minutes in the future to support race condition ttls on read
+          expires_in += 5.minutes
+        end
+
+        serialized_value = Marshal.dump(value)
+        serialized_compressed_value = Snappy.deflate(serialized_value)
+
+        response = @data.set(escape_key(key), serialized_compressed_value, expires_in, true)
+        response == Response::STORED
+      rescue MemCache::MemCacheError => e
+        logger.error("MemCacheError (#{e}): #{e.message}") if logger
+        false
+      end
+
+
+      def deserialize_entry_with_snappy(*args)
+        compressed_value = args.first
+        decompressed_value = compressed_value.nil? ? compressed_value : Snappy.inflate(compressed_value)
+        args[0] = decompressed_value
+        deserialize_entry_without_snappy(*args)
+      end
+
+      alias_method_chain :deserialize_entry, :snappy
+    end
+  end
+end

data/lib/memcached_snappy_store.rb

@@ -0,0 +1,2 @@
+require "active_support/cache"
+

data/memcached_snappy_store.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Camilo Lopez"]
+  gem.email         = ["camilo@camilolopez.com"]
+  gem.description   = %q{Memcached store that will compress all entries using snappy}
+  gem.summary       = %q{Memcached store that will compress all entries using snappy}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "memcached_snappy_store"
+  gem.require_paths = ["lib"]
+  gem.version       = '0.0.1'
+  gem.add_runtime_dependency "activesupport", "~>3.2.12"
+  gem.add_runtime_dependency "snappy", "0.0.4"
+  gem.add_development_dependency "i18n"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "timecop"
+  gem.add_development_dependency "memcache"
+  gem.add_development_dependency "memcache-client"
+end

data/test/test_memcached_snappy_store.rb

@@ -0,0 +1,94 @@
+require 'snappy'
+require 'memcache'
+require 'minitest/autorun'
+require 'active_support/cache'
+require 'active_support'
+require 'mocha/setup'
+require 'timecop'
+
+
+class TestMemcachedSnappyStore < ActiveSupport::TestCase
+
+  setup do
+     @cache = ActiveSupport::Cache.lookup_store(:memcached_snappy_store)
+     @cache.clear
+  end
+
+  test "test should not allow increment" do
+    assert_raise(ActiveSupport::Cache::MemcachedSnappyStore::UnsupportedOperation) do
+      @cache.increment('foo')
+    end
+  end
+
+  test "should not allow decrement" do
+    assert_raise(ActiveSupport::Cache::MemcachedSnappyStore::UnsupportedOperation) do
+      @cache.decrement('foo')
+    end
+  end
+
+  test "write should not allow  the implicit add operation when unless_exist is passed to write" do
+    assert_raise(ActiveSupport::Cache::MemcachedSnappyStore::UnsupportedOperation) do
+      @cache.write('foo', 'bar', :unless_exist => true)
+    end
+  end
+
+  test "should use snappy to write cache entries" do 
+    # Freezing time so created_at is the same in entry and the entry created
+    # internally and assert_equal between the raw data in the cache and the
+    # compressed explicitly makes sense
+    Timecop.freeze do
+      entry_value = { :omg => 'data' }
+      entry = ActiveSupport::Cache::Entry.new(entry_value)
+      key = 'moarponies'
+      assert @cache.write(key, entry_value)
+
+      serialized_entry = Marshal.dump(entry)
+      serialized_compressed_entry = Snappy.deflate(serialized_entry)
+      actual_cache_value = @cache.instance_eval{ @data.get(key, true ) }
+
+      assert_equal serialized_compressed_entry, actual_cache_value
+    end
+  end
+
+  test "should use snappy to read cache entries" do
+    entry_value = { :omg => 'data' }
+    key = 'ponies'
+
+    @cache.write(key, entry_value)
+    cache_entry = ActiveSupport::Cache::Entry.new(entry_value)
+    serialized_cached_entry =  Marshal.dump(cache_entry)
+
+    Snappy.expects(:inflate).returns(serialized_cached_entry)
+    assert_equal entry_value, @cache.read(key)
+  end
+
+  test "should skip snappy to reading not found" do
+    key = 'ponies2'
+    Snappy.expects(:inflate).never
+    assert_nil @cache.read(key)
+  end
+
+  test "should use snappy to multi read cache entries but not on missing entries" do
+    keys = %w{ one tow three }
+    values = keys.map{ |k| k * 10 }
+    entries = values.map{ |v| ActiveSupport::Cache::Entry.new(v) }
+
+    keys.each_with_index{ |k, i| @cache.write(k, values[i]) }
+
+    keys_and_missing = keys << 'missing'
+
+    Snappy.expects(:inflate).times(3).returns(*entries)
+    assert_equal values, @cache.read_multi(*keys_and_missing).values
+  end
+
+  test "should use snappy to multi read cache entries" do
+    keys = %w{ one tow three }
+    values = keys.map{ |k| k * 10 }
+    entries = values.map{ |v| ActiveSupport::Cache::Entry.new(v) }
+
+    keys.each_with_index{ |k, i| @cache.write(k, values[i]) }
+
+    Snappy.expects(:inflate).times(3).returns(*entries)
+    assert_equal values, @cache.read_multi(*keys).values
+  end
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: memcached_snappy_store
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Camilo Lopez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  name: activesupport
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  name: snappy
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: i18n
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: minitest
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: mocha
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: timecop
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: memcache
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: memcache-client
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Memcached store that will compress all entries using snappy
+email:
+- camilo@camilolopez.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/active_support/cache/memcached_snappy_store.rb
+- lib/memcached_snappy_store.rb
+- memcached_snappy_store.gemspec
+- test/test_memcached_snappy_store.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 4438705946747853744
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 4438705946747853744
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Memcached store that will compress all entries using snappy
+test_files:
+- test/test_memcached_snappy_store.rb