cache_pipe 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 252433b1973bebce21b6a17a8e07fea894f7623d
+  data.tar.gz: fbe5c6e875b7628b784632926329166b7bd316e1
+SHA512:
+  metadata.gz: 59c03b130ff5c054e265f36d16517b26848d5c6a7ef476b2cdffdaa538dd3c522e4ee0e1e1710894ca8fef2f4f8707a7ca1b66c20f5410f53556c8b8e85b006a
+  data.tar.gz: 15b6addd0ceaf7b9f12ab7149fd625620b6e59280642c5268e4b96fc30d6fc85a73a537d169fe74683dc491e3ae06a087dc6802061b763ec624803f62b311570

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Amitree
+
+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,29 @@
+# cache\_pipe
+
+Provides a wrapper around a Rails cache store, allowing values to be
+transformed before storage and after retrieval.
+
+Currently it provides a single transformation, `:wrap_nil`, which allows
+caching engines like [Dalli](https://github.com/mperham/dalli) to store `nil`
+values.
+
+## Usage
+
+Add to your Gemfile:
+
+```ruby
+gem 'cache_pipe'
+```
+
+Then change your Rails configuration, e.g. `config/environments/production.rb`:
+
+```ruby
+config.cache_store = :cache_pipe, :wrap_nil, :dalli_store, { value_max_bytes: 10485760, expires_in: 86400 }
+# Instead of config.cache_store = :dalli_store, { value_max_bytes: 10485760, expires_in: 86400 }
+```
+
+## TODO
+
+In the future, we may want to support additional transformations.  Let me know
+if you have other applications that aren't covered by the current
+implementation!

data/lib/active_support/cache/cache_pipe.rb

@@ -0,0 +1,71 @@
+module ActiveSupport
+  module Cache
+    class CachePipe < SimpleDelegator
+      class WrappedNil ; end
+
+      NIL_VALUE = WrappedNil.new
+
+      #
+      # In your environment configruation:
+      #   config.cache_store = :cache_pipe, :wrap_nil, :dalli_store, { value_max_bytes: 10485760, expires_in: 86400 }
+      #
+      # will cause a call to:
+      #   ActiveSupport::Cache::CachePipe.new(:wrap_nil, :dalli_store, { value_max_bytes: 10485760, expires_in: 86400 })
+      #
+      def initialize transformation, *store_options
+        super ActiveSupport::Cache.lookup_store(*store_options)
+        case transformation
+        when :wrap_nil
+          @transform_read = :unwrap_nil
+          @transform_write = :wrap_nil
+        else
+          raise "Invalid transformation #{transformation}.  Valid values are: :wrap_nil"
+        end
+      end
+
+      def fetch name, options=nil
+        if block_given?
+          transform_read __getobj__.fetch(name, options) { transform_write(yield) }
+        else
+          transform_read __getobj__.fetch(name, options)
+        end
+      end
+
+      def read name, options=nil
+        transform_read __getobj__.read(name, options)
+      end
+
+      def write name, value, options=nil
+        __getobj__.write name, transform_write(value), options
+      end
+
+    private
+
+      def transform_read value
+        send(@transform_read, value)
+      end
+
+      def transform_write value
+        send(@transform_write, value)
+      end
+
+      def wrap_nil value
+        case value
+        when nil
+          NIL_VALUE
+        else
+          value
+        end
+      end
+
+      def unwrap_nil(value)
+        case value
+        when NIL_VALUE
+          nil
+        else
+          value
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: cache_pipe
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Tony Novak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Provides a wrapper around a Rails cache store, allowing values to be
+  transformed before storage and after retrieval.
+email: engineering@amitree.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/active_support/cache/cache_pipe.rb
+homepage: https://github.com/amitree/cache_pipe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a wrapper around a Rails cache store, allowing values to be transformed
+  before storage and after retrieval.
+test_files: []