redis-activesupport-with-cas 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4abb278597b98f98b1c3cd0a48e5ab19483c7e49
+  data.tar.gz: 93388de649c88393897dd81f98a8dbfd6ac8616d
+SHA512:
+  metadata.gz: a718347768ba3d70de2b1fd1d621aaaee364bc730ab1079bc450437161bba2f2b889d865c7ba49187e3a11ff73c90cc5c4d8300cb41255c7e80a8a81e25ae554
+  data.tar.gz: 80291ac50fa93373fe0701fc9f432da8b22776a90f3fee3293fca476da71b3f648379edbb2f5260e1070b708a4ad2c0815cd450c48342241d3e9c0c2dd9f5746

data/.gitignore

@@ -0,0 +1,9 @@
+Gemfile.lock
+*.gem
+tmp/
+stdout
+.idea/
+.ruby-version
+.ruby-gemset
+.yardoc/
+doc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'i18n'

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Rajko Albrecht
+
+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,32 @@
+# Redis store with CAS for ActiveSupport
+
+__`redis-activesupport-with-cas`__ provides a cache for __ActiveSupport__ including 'Compare and Swap' methods.
+ 
+It is based on [redis-store](https://github.com/redis-store/redis-store) and may used with [Identity Cache](https://github.com/Shopify/identity_cache).
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'redis-activesupport-with-cas'
+```
+
+## Usage
+
+```ruby
+ActiveSupport::Cache.lookup_store :redis_store_with_cas # { ... optional configuration ... }
+```
+
+## Running tests
+
+```shell
+gem install bundler
+git clone https://git.alwin-it.de/ruby-redis/redis-activesupport-with-cas.git
+cd redis-activesupport-with-cas
+bundle install
+bundle exec rake
+```
+
+## Copyright
+
+2017 Rajko Albrecht, released under the MIT license

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'redis-store/testing/tasks'

data/irb.rb

@@ -0,0 +1,4 @@
+require "irb"
+require 'active_support/cache/redis_store_with_cas'
+
+IRB.start(__FILE__)

data/lib/active_support/cache/redis_store_with_cas.rb

@@ -0,0 +1,80 @@
+require 'active_support'
+require 'redis-store-with-cas'
+require 'active_support/cache/redis_store'
+
+module ActiveSupport
+  module Cache
+    module RedisStoreCas
+
+      attr_accessor :read_only
+
+      def cas name,options=nil
+        options = merged_options(options)
+        key = normalize_key(name, options)
+        instrument(:cas, name, options) do
+          ttl = cas_expiration options
+          @data.cas(key,ttl) do |entry|
+            value = yield entry.value
+            break true if read_only
+            options[:raw].present? ? value : Entry.new(value, options)
+          end
+        end
+      end
+
+      def cas_multi(*names)
+        options = names.extract_options!
+        return if names.empty?
+
+        options = merged_options(options)
+        keys_to_names = Hash[names.map { |name| [normalize_key(name, options), name] }]
+
+        instrument(:cas_multi, names, options) do
+          @data.cas_multi(*(keys_to_names.keys), {:expires_in => cas_expiration(options)}) do |raw_values|
+            values = {}
+            raw_values.each do |key, entry|
+              values[keys_to_names[key]] = entry.value unless entry.expired?
+            end
+            values = yield values
+            break true if read_only
+            mapped_values = values.map do |name,value|
+              [normalize_key(name, options),options[:raw].present? ? value : Entry.new(value, options)]
+            end
+            Hash[mapped_values]
+          end
+          true
+        end
+
+      end
+
+      private
+
+      def cas_expiration(options)
+        if options[:expires_in].present? && options[:race_condition_ttl].present? && options[:raw].blank?
+          options[:expires_in].to_f + options[:race_condition_ttl].to_f
+        else
+          nil
+        end
+      end
+
+    end
+
+    class RedisStoreWithCas < RedisStore
+
+      def initialize(*adresses)
+        super adresses
+        check_and_extend_cas
+      end
+
+      def candocas?
+        @data.is_a?(Redis::Store) && @data.respond_to?(:cas)
+      end
+
+      private
+
+      def check_and_extend_cas
+        extend RedisStoreCas if candocas?
+      end
+
+    end
+  end
+end

data/lib/active_support/redis-activesupport-with-cas.rb

@@ -0,0 +1,3 @@
+require 'redis-store-with-cas'
+require 'active_support'
+require 'active_support/cache/redis_store_with_cas'

data/redis-activesupport-with-cas.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'redis-activesupport-with-cas'
+  s.version     = '0.0.1'
+  s.authors     = ['Rajko Albrecht']
+  s.email       = ['ral@alwins-world.de']
+  s.homepage    = 'https://git.alwin-it.de/alwin/redis-activesupport-with-cas'
+  s.summary     = %q{Extend redis activesupport for Ruby frameworks with cas}
+  s.description = %q{Extend the redis activesupport with CAS (compare-and-swap) functionality for better cache integrity support}
+
+  s.rubyforge_project = 'redis-activesupport-with-cas'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.license       = 'MIT'
+
+  s.add_dependency 'redis', '>= 2.2', '< 4'
+  s.add_dependency 'redis-store', '>= 1.1.0', '< 2'
+  s.add_dependency 'redis-activesupport'
+  s.add_dependency 'redis-store-with-cas'
+
+  s.add_development_dependency 'rake',     '~> 10'
+  s.add_development_dependency 'bundler',  '~> 1.3'
+  s.add_development_dependency 'mocha',    '~> 0.14.0'
+  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'git',      '~> 1.2'
+  s.add_development_dependency 'pry-nav',  '~> 0.2.4'
+  s.add_development_dependency 'pry',      '~> 0.10.4'
+  s.add_development_dependency 'redis-store-testing'
+
+end

data/test/active_support/cache/redis_store_with_cas_test.rb

@@ -0,0 +1,120 @@
+require 'active_support/test_helper'
+require 'ostruct'
+
+describe "ActiveSupport::Cache::RedisStoreWithCas" do
+
+  def setup
+    @store  = ActiveSupport::Cache::RedisStoreWithCas.new "redis://127.0.0.1:6379/5/cachetest"
+    @dstore = ActiveSupport::Cache::RedisStoreWithCas.new "redis://127.0.0.1:6379/5", "redis://127.0.0.1:6379/6"
+
+    @rabbit = OpenStruct.new :name => "bunny"
+    @white_rabbit = OpenStruct.new :color => "white"
+    @black_rabbit = OpenStruct.new :color => 'black'
+
+  end
+
+  def teardown
+    @store.instance_variable_get("@data").flushdb
+    @dstore.instance_variable_get("@data").flushdb
+  end
+
+  describe "Including into cache" do
+    it "should not done with distributed store" do
+      refute @dstore.candocas?
+      assert @store.candocas?
+    end
+  end
+
+  describe "Single cas " do
+    it "should not swap missing key" do
+      refute @store.cas('rabbit') { |_value| flunk }
+    end
+
+    it "should correct swap value" do
+      @store.write "rabbit", @rabbit
+      assert(@store.cas('rabbit') do |value|
+        assert_equal @rabbit, value
+        @white_rabbit
+      end)
+      @store.read("rabbit").must_equal(@white_rabbit)
+    end
+
+    it "should not swap if value changes" do
+      @store.write('rabbit', @rabbit)
+      refute @store.cas('rabbit') { |_value|
+        @store.write('rabbit', @black_rabbit)
+        @white_rabbit
+      }
+      @store.read("rabbit").must_equal(@black_rabbit)
+    end
+
+    describe "Test Multi cas" do
+      it "should fail with empty names" do
+        refute @store.cas_multi { |_hash| flunk }
+      end
+
+      it "should set new values" do
+        @store.write('rabbit', @white_rabbit)
+        @store.write('hare', @black_rabbit)
+        assert_equal true, (@store.cas_multi('rabbit', 'hare') do |hash|
+          assert_equal({ "rabbit" => @white_rabbit, 'hare' => @black_rabbit }, hash)
+          { "rabbit" => @black_rabbit, 'hare' => @white_rabbit }
+        end)
+        assert_equal({ "rabbit" => @black_rabbit, 'hare' => @white_rabbit }, @store.read_multi('rabbit', 'hare'))
+      end
+
+      it "should set a ttl " do
+        @store.write('rabbit', @white_rabbit)
+        @store.write('hare', @black_rabbit)
+        @store.cas_multi('rabbit','hare',{:expires_in => 600,:race_condition_ttl => 1}) do |hash|
+          { "rabbit" => @black_rabbit, "hare" =>  @white_rabbit}
+        end
+        values = @store.read_multi('rabbit', 'hare')
+        assert_equal({ "rabbit" => @black_rabbit, 'hare' => @white_rabbit },values)
+        re = @store.instance_variable_get('@data')
+        assert re.ttl('rabbit') > 0
+        assert re.ttl('hare') > 0
+
+      end
+
+      it "should not send values for not existing keys" do
+        assert(@store.cas_multi('not_exist') do |hash|
+          assert hash.empty?
+          {}
+        end)
+      end
+
+      it "should not write keys not in parameter" do
+        @store.write('foo', 'baz')
+        assert @store.cas_multi('foo') { |_hash| { 'fu' => 'baz' } }
+        assert_nil @store.read('fu')
+        assert_equal 'baz', @store.read('foo')
+      end
+
+      def test_cas_multi_with_partial_update
+        @store.write('foo', 'bar')
+        @store.write('fud', 'biz')
+        assert(@store.cas_multi('foo', 'fud') do |hash|
+          assert_equal({ "foo" => "bar", "fud" => "biz" }, hash)
+
+          { "foo" => "baz" }
+        end)
+        assert_equal({ "foo" => "baz", "fud" => "biz" }, @store.read_multi('foo', 'fud'))
+      end
+
+      def test_cas_multi_with_partial_conflict
+        @store.write('foo', 'bar')
+        @store.write('fud', 'biz')
+        result = @store.cas_multi('foo', 'fud') do |hash|
+          assert_equal({ "foo" => "bar", "fud" => "biz" }, hash)
+          @store.write('foo', 'bad')
+          { "foo" => "baz", "fud" => "buz" }
+        end
+        assert result
+        assert_equal({ "foo" => "bad", "fud" => "buz" }, @store.read_multi('foo', 'fud'))
+      end
+
+    end
+  end
+
+end

data/test/active_support/test_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'active_support'
+require 'active_support/cache/redis_store_with_cas'
+
+puts "Testing against ActiveSupport v.#{ActiveSupport::VERSION::STRING}"

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: redis-activesupport-with-cas
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rajko Albrecht
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: redis-store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: redis-activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-store-with-cas
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: redis-store-testing
+  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'
+description: Extend the redis activesupport with CAS (compare-and-swap) functionality
+  for better cache integrity support
+email:
+- ral@alwins-world.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- irb.rb
+- lib/active_support/cache/redis_store_with_cas.rb
+- lib/active_support/redis-activesupport-with-cas.rb
+- redis-activesupport-with-cas.gemspec
+- test/active_support/cache/redis_store_with_cas_test.rb
+- test/active_support/test_helper.rb
+homepage: https://git.alwin-it.de/alwin/redis-activesupport-with-cas
+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: redis-activesupport-with-cas
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Extend redis activesupport for Ruby frameworks with cas
+test_files:
+- test/active_support/cache/redis_store_with_cas_test.rb
+- test/active_support/test_helper.rb