mongo_cache_store 0.2.5 → 0.3.0

data/.travis.yml

@@ -1,14 +1,28 @@
 language: ruby
+env:
+  - "ACTIVESUPPORT_VERSION=3.1"
+  - "ACTIVESUPPORT_VERSION=3.2"
+  - "ACTIVESUPPORT_VERSION=4"
 rvm:
   - 2.0.0
   - 1.9.3
   - 1.9.2
   - jruby-18mode
   - jruby-19mode
-  - rbx-19mode 
+  - rbx-19mode
   - ruby-head
   - jruby-head
   - 1.8.7
   - ree
 services:
   - mongodb
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      env: "ACTIVESUPPORT_VERSION=4"
+    - rvm: jruby-18mode
+      env: "ACTIVESUPPORT_VERSION=4"
+    - rvm: 1.8.7
+      env: "ACTIVESUPPORT_VERSION=4"
+    - rvm: ree
+      env: "ACTIVESUPPORT_VERSION=4"

data/Gemfile

@@ -1,4 +1,18 @@
 source 'https://rubygems.org'
 
+as_version = ENV["ACTIVESUPPORT_VERSION"] || "default"
+
+as = case as_version
+        when "master"
+          {:github => "rails/rails"}
+        when "default"
+          "~> 3.2.0"
+        else
+          "~> #{as_version}"
+        end
+
+gem "activesupport", as
+
 # Specify your gem's dependencies in mongo_cache_store.gemspec
 gemspec
+

data/README.md

@@ -1,6 +1,6 @@
 # MongoCacheStore
 
-A MongoDB cache store for ActiveSupport 3
+A MongoDB cache store for ActiveSupport
 
 ## Description
 
@@ -9,6 +9,16 @@ as a cache store to ActiveSupport applications.  Each backend
 allows the application to customize how the cache operates.  
 Support is available for standard, capped and TTL collections.
 
+## Upgrade Note
+
+To accomidate ActiveSupport 4 underlying storage routines had
+to change.  After upgrading to 0.3.0, any cached entries from 0.2.x
+will be considered a miss and will be overridden with a corresponding
+write action or expire naturally.
+
+MongoCacheStore::DATA\_STORE\_VERSION determines whether a cached entry
+is compatible with the current version of the gem.
+
 
 ## Initialize the cache
 
@@ -190,9 +200,10 @@ be flushed until it is automatically removed by MongoDB.
 
 TODO
  
-## Build Status
+## Build Health
 [![Build Status - Master](https://travis-ci.org/kmcgrath/mongo_cache_store.png?branch=master)](https://travis-ci.org/kmcgrath/mongo_cache_store)
-[![Build Status - Develop](https://travis-ci.org/kmcgrath/mongo_cache_store.png?branch=develop)](https://travis-ci.org/kmcgrath/mongo_cache_store)
+[![Code Climate](https://codeclimate.com/github/kmcgrath/mongo_cache_store.png)](https://codeclimate.com/github/kmcgrath/mongo_cache_store)
+[![Dependency Status](https://gemnasium.com/kmcgrath/mongo_cache_store.png)](https://gemnasium.com/kmcgrath/mongo_cache_store)
 
 Travis is used to build and test MongoCacheStore against:
 * 2.0.0

data/lib/active_support/cache/mongo_cache_store/backend/base.rb

@@ -20,7 +20,7 @@ module ActiveSupport
             options = names.extract_options!
             options = merged_options(options)
             results = {}
-             
+
             col = get_collection(options)
 
             key_map = names.inject({}) do |h, name|
@@ -28,18 +28,17 @@ module ActiveSupport
               h
             end
 
-            safe_rescue do 
+            safe_rescue do
               query = {
                 :_id => { '$in' => key_map.keys},
                 :expires_at => {
-                  '$gt' => Time.now 
+                  '$gt' => Time.now
                 }
               }
 
               col.find(query) do |cursor|
                 cursor.each do |r| 
                   results[key_map[r['_id']]] = inflate_entry(r).value
-                  puts results.inspect
                 end
               end
             end
@@ -84,12 +83,13 @@ module ActiveSupport
             def read_entry(key,options)
               col = get_collection(options)
 
-              safe_rescue do 
+              safe_rescue do
                 query = {
                   :_id => key,
                   :expires_at => {
-                    '$gt' => Time.now 
-                  }
+                    '$gt' => Time.now
+                  },
+                  :data_store_version => ::MongoCacheStore::DATA_STORE_VERSION
                 }
 
                 response = col.find_one(query)
@@ -102,16 +102,17 @@ module ActiveSupport
             def inflate_entry(from_mongo)
                 return nil if from_mongo.nil?
 
-                entry_options = {
-                  :compressed => from_mongo['compressed'],
-                  :expires_in => from_mongo['expires_in'] 
-                }
-                if from_mongo['serialized']
-                  r_value = from_mongo['value'].to_s
-                else
-                  r_value = Marshal.dump(from_mongo['value'])
+                case from_mongo['value']
+                when BSON::Binary
+                  fm = Marshal.load(from_mongo['value'].to_s)
+                  case fm
+                  when Entry
+                    if from_mongo['raw_value'].nil? == false
+                      fm.instance_eval { @value = from_mongo['raw_value'] }
+                    end
+                    fm
+                  end
                 end
-                ActiveSupport::Cache::Entry.create(r_value,from_mongo['created_at'],entry_options)              
             end
 
             def write_counter(name, amount, options)
@@ -121,17 +122,18 @@ module ActiveSupport
               safe_rescue do
                 doc = col.find_and_modify(
                   :query => {
-                    :_id => key
+                    :_id => key,
+                    :data_store_version => ::MongoCacheStore::DATA_STORE_VERSION
                   },
                   :update => {
                     :$inc => {
-                      :value => amount
+                      :raw_value => amount
                     }
                   }
                 )
 
                 return nil unless doc
-                doc['value'] + amount
+                doc['raw_value'] + amount
               end
             end
 
@@ -140,37 +142,35 @@ module ActiveSupport
               serialize = options[:serialize] == :always ? true : false
               serialize = false if entry.value.is_a?(Integer) || entry.value.nil?
 
-              value = begin 
-                if entry.compressed?
-                  BSON::Binary.new(entry.raw_value)
-                elsif serialize 
-                  BSON::Binary.new(entry.raw_value)
-                else
-                  entry.value
-                end
+              value = BSON::Binary.new(Marshal.dump(entry))
+              unless entry.send(:compressed?) || serialize
+                raw_value = entry.value
+                entry.instance_eval { @value = nil }
               end
 
               try_cnt = 0
 
               save_doc = {
                 :_id => key,
-                :created_at => Time.at(entry.created_at),
-                :expires_in => entry.expires_in,
-                :expires_at => entry.expires_in.nil? ? Time.utc(9999) : Time.at(entry.expires_at),
-                :compressed => entry.compressed?,
+                :created_at => Time.at(entry.instance_eval { @created_at}),
+                :expires_in => entry.instance_eval { @expires_in },
+                :expires_at => entry.expires_at.nil? ? Time.utc(9999) : Time.at(entry.expires_at),
+                :compressed => entry.send( :compressed? ),
                 :serialized => serialize,
-                :value => value 
+                :value => value,
+                :raw_value => raw_value,
+                :data_store_version => ::MongoCacheStore::DATA_STORE_VERSION
               }.merge(options[:xentry] || {})
 
               safe_rescue do
                 begin
                   col.save(save_doc)
-                rescue BSON::InvalidDocument => ex
+                rescue BSON::InvalidDocument
                   if (options[:serialize] == :on_fail and try_cnt < 2)
                     save_doc[:serialized] = true
                     save_doc[:value] = BSON::Binary.new(entry.raw_value)
                     try_cnt += 1
-                    retry 
+                    retry
                   end
                 end
               end
@@ -186,7 +186,7 @@ module ActiveSupport
             end
 
             def get_collection_name(options = {})
-              name_parts = ['cache'] 
+              name_parts = ['cache']
               name_parts.push(backend_name)
               name_parts.push options[:namespace] if !options[:namespace].nil?
               name = name_parts.join('.')

data/lib/active_support/cache/mongo_cache_store/backend/multi_ttl.rb

@@ -85,7 +85,7 @@ module ActiveSupport
                   :_id => key,
                   :collection => options[:collection].name,
                   :expires_in => options[:expires_in].nil? ? nil : options[:expires_in].to_i,
-                  :expires_at => entry.expires_at
+                  :expires_at => Time.at(entry.expires_at)
                 })
               end
             end

data/lib/active_support/cache/mongo_cache_store/backend/ttl.rb

@@ -43,22 +43,22 @@ module ActiveSupport
             now = Time.now 
             options[:xentry] = {
               :created_at   => now,
-              :expires_at   => entry.expires_in.nil? ? Time.utc(9999) : now + entry.expires_in.to_i
+              :expires_at   => entry.expires_at.nil? ? Time.utc(9999) : Time.at(entry.expires_at)
             }
 
             super(key,entry,options)
           end
 
 
-          private 
+          private
 
           def backend_name
             "ttl"
           end
 
           def get_collection(options)
-            return @collection if @collection.is_a? Mongo::Collection
-            collection = super 
+            return @collection if (@collection && @collection.is_a?(Mongo::Collection))
+            collection = super
             collection.ensure_index('expires_at',{ :expireAfterSeconds => 0 })
             @collection = collection
           end

data/lib/mongo_cache_store/version.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
 module MongoCacheStore
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
+  DATA_STORE_VERSION = "2"
 end

data/mongo_cache_store.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'mongo', '~>1'
-  gem.add_dependency 'activesupport', '~>3'
+  gem.add_dependency 'mongo', '~>1.8'
+  gem.add_dependency 'activesupport', '>= 3', '<4.1'
   gem.add_development_dependency 'mocha', '~>0.13'
   gem.add_development_dependency 'rake', '~>10.0'
 end

data/test/test_modules.rb

@@ -198,19 +198,21 @@ module CacheStoreBehavior
     assert_equal false, @cache.read('foo')
   end
 
-  def test_should_read_cached_numeric_from_previous_rails_versions
-    @old_cache = ActiveSupport::Cache::Entry.create( 1, Time.now )
-    assert_equal( 1, @old_cache.value )
-  end
+  if ActiveSupport::VERSION::MAJOR == 3
+    def test_should_read_cached_numeric_from_previous_rails_versions
+      @old_cache = ActiveSupport::Cache::Entry.create( 1, Time.now )
+      assert_equal( 1, @old_cache.value )
+    end
 
-  def test_should_read_cached_hash_from_previous_rails_versions
-    @old_cache = ActiveSupport::Cache::Entry.create( {}, Time.now )
-    assert_equal( {}, @old_cache.value )
-  end
+    def test_should_read_cached_hash_from_previous_rails_versions
+      @old_cache = ActiveSupport::Cache::Entry.create( {}, Time.now )
+      assert_equal( {}, @old_cache.value )
+    end
 
-  def test_should_read_cached_string_from_previous_rails_versions
-    @old_cache = ActiveSupport::Cache::Entry.create( 'string', Time.now )
-    assert_equal( 'string', @old_cache.value )
+    def test_should_read_cached_string_from_previous_rails_versions
+      @old_cache = ActiveSupport::Cache::Entry.create( 'string', Time.now )
+      assert_equal( 'string', @old_cache.value )
+    end
   end
 
   def test_read_multi
@@ -228,18 +230,20 @@ module CacheStoreBehavior
     assert_equal({"fu" => "baz"}, @cache.read_multi('foo', 'fu'))
   end
 
-  def test_read_and_write_compressed_small_data
-    @cache.write('foo', 'bar', :compress => true)
-    raw_value = @cache.send(:read_entry, 'foo', {}).raw_value
-    assert_equal 'bar', @cache.read('foo')
-    assert_equal 'bar', Marshal.load(raw_value)
-  end
+  if ActiveSupport::VERSION::MAJOR == 3
+    def test_read_and_write_compressed_small_data
+      @cache.write('foo', 'bar', :compress => true)
+      raw_value = @cache.send(:read_entry, 'foo', {}).raw_value
+      assert_equal 'bar', @cache.read('foo')
+      assert_equal 'bar', Marshal.load(raw_value)
+    end
 
-  def test_read_and_write_compressed_large_data
-    @cache.write('foo', 'bar', :compress => true, :compress_threshold => 2)
-    raw_value = @cache.send(:read_entry, 'foo', {}).raw_value
-    assert_equal 'bar', @cache.read('foo')
-    assert_equal 'bar', Marshal.load(Zlib::Inflate.inflate(raw_value))
+    def test_read_and_write_compressed_large_data
+      @cache.write('foo', 'bar', :compress => true, :compress_threshold => 2)
+      raw_value = @cache.send(:read_entry, 'foo', {}).raw_value
+      assert_equal 'bar', @cache.read('foo')
+      assert_equal 'bar', Marshal.load(Zlib::Inflate.inflate(raw_value))
+    end
   end
 
   def test_read_and_write_compressed_nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_cache_store
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-14 00:00:00.000000000 Z
+date: 2013-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,23 +26,29 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement