activesupport-db-cache 0.0.2 → 0.0.3

data/.gitignore

@@ -10,9 +10,10 @@ coverage
 db/*.sqlite3
 doc/
 lib/bundler/man
+log/*
 pkg
 rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+tmp/*

data/.rspec

@@ -1,4 +1,3 @@
 --color
 --format documentation
---backtrace
 --default_path spec

data/README.md

@@ -1,6 +1,17 @@
 # Activesupport::Db::Cache
 
-TODO: Write a gem description
+ActiveSupport::Cache store that stores data in a database table. Useful for NOT highload applications, when you do not want to use separate cache server like Memcache, Redis etc.. I am going to use it with Heroku application because of limitation of FREE cache storages.
+
+Ruby on Rails support out of box.
+
+## Features
+
+* Very LOW speed: think twice before use it! :)
+* persistence: store cache after rails restart
+* :expire_in option: cache lifetime for each item separetely
+* total rows limit: auto clean old items when large (5000 rows max)
+* ability to use external databse for cache store
+* debug mode: ability to gather information about cache usage (access_time, access_counter)
 
 ## Installation
 
@@ -16,9 +27,82 @@ Or install it yourself as:
 
     $ gem install activesupport-db-cache
 
+Set cache store in a config/environments/production.rb:
+
+    ..
+    config.cache_store = ActiveSupport::Cache::ActiveRecordStore.new
+    ..
+
+Create migration for cache_items table:
+    
+    $ rails g migration create_cache_items
+
+Copy migration paste
+
+      def up
+        connection = ActiveSupport::Cache::ActiveRecordStore::CacheItem.connection
+        connection.create_table :cache_items do |t|
+          t.string :key
+          t.text :value
+          t.text :meta_info
+          t.datetime :expires_at
+          t.datetime :created_at
+          t.datetime :updated_at
+        end
+
+        connection.add_index :cache_items, :key, :unique => true
+        connection.add_index :cache_items, :expires_at
+        connection.add_index :cache_items, :updated_at
+      end
+
+      def down
+        ActiveSupport::Cache::ActiveRecordStore::CacheItem.connection.drop_table :cache_items
+      end
+
+Migrate database:
+    
+    $ rake db:migrate
+
+Done!
+
 ## Usage
 
-TODO: Write usage instructions here
+For usage details see ActiveSupport::Cache
+
+### External database
+
+By default ActiveRecordStore uses your ActiveRecord::Base.connection. If you whant to use some external database for cache pupose you should set ACTIVE_RECORD_CACHE_STORE_DATABASE_URL env variable:
+
+    $ ACTIVE_RECORD_CACHE_STORE_DATABASE_URL="sqlite3://./db/test2.sqlite3" rails s
+
+or postgres:
+
+    $ ACTIVE_RECORD_CACHE_STORE_DATABASE_URL="postgresql://user:password@host/database" rails s
+
+or any other.
+
+For Heroku you should add config variable:
+
+    $ heroku config:add ACTIVE_RECORD_CACHE_STORE_DATABASE_URL="postgresql://user:password@host/database"
+
+### Debug mode
+
+To profile your application you can use debug mode. In debug mode additional meta information is gathered: access_counter, access_time. Be careful: debug mode is EXTREMELY SLOW. Do not use in production for a long time.
+
+To enable debug mode you should set ACTIVE_RECORD_CACHE_STORE_DEBUG_MODE:
+
+    $ ACTIVE_RECORD_CACHE_STORE_DEBUG_MODE=1 rails s
+
+For Heroku you should add config variable:
+
+    $ heroku config:add ACTIVE_RECORD_CACHE_STORE_DEBUG_MODE=1
+
+Display debug information for a cache item:
+
+    $ rails c
+    > ActiveSupport::Cache::ActiveRecordStore::CacheItem.find_by_key(:foo).meta_info
+
+    > 
 
 ## Contributing
 

data/activesupport-db-cache.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["sergei.udalov@gmail.com"]
   gem.description   = %q{ActiveRecord DB Store engine for ActiveSupport::Cache}
   gem.summary       = %q{ActiveRecord DB Store engine for ActiveSupport::Cache}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/sergio-fry/activesupport-db-cache"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -20,4 +20,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency "activerecord", ">=3.0.0"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "timecop"
 end

data/lib/active_support/cache/active_record_store.rb

@@ -1,9 +1,13 @@
 require "base64"
+require "ostruct"
 
 module ActiveSupport
   module Cache
     class ActiveRecordStore < Store
-      VERSION = "0.0.2"
+      VERSION = "0.0.3"
+
+      # do not allow to store more items than
+      ITEMS_LIMIT = 5000
 
       # set database url:
       #   ENV['ACTIVE_RECORD_CACHE_STORE_DATABASE_URL'] = "sqlite3://./db/test2.sqlite3"
@@ -11,12 +15,38 @@ module ActiveSupport
         self.table_name = ENV['ACTIVE_RECORD_CACHE_STORE_TABLE'] || 'cache_items'
         establish_connection ENV['ACTIVE_RECORD_CACHE_STORE_DATABASE_URL'] if ENV['ACTIVE_RECORD_CACHE_STORE_DATABASE_URL'].present?
 
+        cattr_accessor :debug_mode
+
+        serialize :meta_info, Hash
+        before_save :init_meta_info, :bump_version
+
+        def debug_mode?
+          debug_mode
+        end
+
+        DEFAULT_META_INFO = { :version => 0, :access_counter => 0 }
+
         def value
-          Marshal.load(Base64.decode64(self[:value]))
+          Marshal.load(::Base64.decode64(self[:value])) if self[:value].present?
+        end
+
+        def value=(new_value)
+          @raw_value = new_value
+          self[:value] = ::Base64.encode64(Marshal.dump(@raw_value))
         end
 
         def expired?
-          false
+          expires_at.try(:past?) || false
+        end
+
+        private
+
+        def bump_version
+          meta_info[:version] = meta_info[:version] + 1 if value_changed?
+        end
+
+        def init_meta_info
+          self.meta_info = DEFAULT_META_INFO.merge(meta_info)
         end
       end
 
@@ -28,14 +58,45 @@ module ActiveSupport
         CacheItem.delete_all(:key => key)
       end
 
-      def read_entry(key, options)
-        CacheItem.find_by_key(key)
+      def read_entry(key, options={})
+        item = CacheItem.find_by_key(key)
+
+        if item.present? && debug_mode?
+          item.meta_info[:access_counter] += 1
+          item.meta_info[:access_time] = Time.now
+          item.save
+        end
+
+        item
       end
 
       def write_entry(key, entry, options)
+        options = options.clone.symbolize_keys
         item = CacheItem.find_or_initialize_by_key(key)
-        item.value = Base64.encode64(Marshal.dump(entry.value))
+        item.debug_mode = debug_mode?
+        item.value = entry.value
+        item.expires_at = options[:expires_in].try(:since)
         item.save
+
+        free_some_space
+      end
+
+      def debug_mode?
+        ENV['ACTIVE_RECORD_CACHE_STORE_DEBUG_MODE'] == "1"
+      end
+
+      private
+
+      def free_some_space
+        # free some space
+        if CacheItem.count >= ITEMS_LIMIT
+          # remove expired
+          CacheItem.where("expires_at < ?", Time.now).delete_all
+
+          # remove old items
+          oldest_updated_at = CacheItem.select(:updated_at).order(:updated_at).offset((ITEMS_LIMIT.to_f * 0.2).round).first.try(:updated_at)
+          CacheItem.where("updated_at < ?", oldest_updated_at).delete_all
+        end
       end
     end
   end

data/spec/active_support/cache/active_record_store_spec.rb

@@ -1,10 +1,21 @@
 require 'spec_helper.rb'
+require 'ostruct'
 
-module ActiveSupport
-  module Cache
-    describe ActiveRecordStore do
+include ActiveSupport::Cache
+
+describe ActiveRecordStore do
+  def meta_info_for(key)
+    OpenStruct.new(ActiveRecordStore::CacheItem.find_by_key(key).meta_info)
+  end
+
+  before do
+    @store = ActiveRecordStore.new
+  end
+
+  [true, false].each do |debug_mode|
+    describe "cache use when debug_mode='#{debug_mode}'" do
       before do
-        @store = ActiveRecordStore.new
+        @store.stub(:debug_mode?).and_return(debug_mode)
       end
 
       it "should store numbers" do
@@ -23,8 +34,26 @@ module ActiveSupport
         @store.read("foo")[:a].should eq(123)
       end
 
-      it "should expire entries"
-      it "should use LIMIT"
+      it "should expire entries" do
+        @store.write :foo, 123, :expires_in => 5.minutes
+        @store.read(:foo).should eq(123)
+        Timecop.travel 6.minutes.since do
+          @store.read(:foo).should be_blank
+        end
+      end
+
+      it "should use ITEMS_LIMIT" do
+        silence_warnings { ActiveRecordStore.const_set(:ITEMS_LIMIT, 10) }
+        @store.clear
+
+        15.times do |i|
+          @store.write(i, 123)
+
+          ActiveRecordStore::CacheItem.count
+        end
+
+        ActiveRecordStore::CacheItem.count.should <= 10
+      end
 
       describe "#read" do
         before do
@@ -40,6 +69,24 @@ module ActiveSupport
         end
       end
 
+      describe "#fetch" do
+        it "should return calculate if missed" do
+          @store.delete(:foo)
+          obj = mock(:obj)
+          obj.should_receive(:func).and_return(123)
+
+          @store.fetch(:foo) { obj.func }.should eq(123)
+        end
+
+        it "should read data from cache if hit" do
+          @store.write(:foo, 123)
+          obj = mock(:obj)
+          obj.should_not_receive(:func)
+
+          @store.fetch(:foo) { obj.func }.should eq(123)
+        end
+      end
+
       describe "#clear" do
         it "should clear cache" do
           @store.write("foo", 123)
@@ -57,6 +104,34 @@ module ActiveSupport
           @store.read("foo").should be_blank
         end
       end
+
+      describe "cache item meta info" do
+        before { @store.clear }
+
+        describe "item version" do
+          it "should be 1 for a new cache item", :filter => true do
+            @store.write(:foo, "foo")
+            meta_info_for(:foo).version.should eq(1)
+          end
+
+          it "should be incremented after cache update" do
+            @store.write(:foo, "bar")
+            meta_info_for(:foo).version.should eq(1)
+
+            @store.write(:foo, "123")
+            meta_info_for(:foo).version.should eq(2)
+
+            @store.write(:foo, "hoo")
+            meta_info_for(:foo).version.should eq(3)
+          end
+
+          it "should not be incremented if no data change" do
+            @store.write(:foo, "bar")
+            @store.write(:foo, "bar")
+            meta_info_for(:foo).version.should eq(1)
+          end
+        end
+      end
     end
   end
 end

data/spec/active_support/cache/debug_mode_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper.rb'
+require 'ostruct'
+
+include ActiveSupport::Cache
+
+describe ActiveRecordStore do
+  def meta_info_for(key)
+    OpenStruct.new(ActiveRecordStore::CacheItem.find_by_key(key).meta_info)
+  end
+
+  before do
+    @store = ActiveRecordStore.new
+  end
+
+  describe "debug mode" do
+    before { @store.clear }
+    context "debug mode is ON" do
+      before do
+        @store.stub(:debug_mode?).and_return(true)
+      end
+
+      describe "access_time" do
+        it "should be nil for a ne item" do
+          @store.write(:foo, 123)
+          meta_info_for(:foo).access_time.should be_nil
+        end
+
+        it "should store last access time" do
+          @store.write(:foo, 123)
+
+          atime = 10.minutes.ago
+
+          Timecop.freeze atime do
+            @store.read(:foo)
+          end
+
+          meta_info_for(:foo).access_time.should eq(atime)
+        end
+      end
+
+      describe "access_counter" do
+        it "should be 0 for a new item" do
+          @store.write(:foo, 123)
+          meta_info_for(:foo).access_counter.should eq(0)
+        end
+
+        it "should be incremented after each cache read" do
+          @store.write(:foo, 123)
+
+          @store.read(:foo)
+          meta_info_for(:foo).access_counter.should eq(1)
+
+          @store.read(:foo)
+          meta_info_for(:foo).access_counter.should eq(2)
+
+          @store.read(:foo)
+          meta_info_for(:foo).access_counter.should eq(3)
+        end
+      end
+    end
+
+    context "debug mode is OFF" do
+      before do
+        @store.stub(:debug_mode?).and_return(false)
+      end
+
+      describe "access_counter" do
+        it "should not be incremented after cache read" do
+          @store.write(:foo, 123)
+
+          @store.read(:foo)
+          meta_info_for(:foo).access_counter.should eq(0)
+
+          @store.read(:foo)
+          meta_info_for(:foo).access_counter.should eq(0)
+        end
+      end
+
+      describe "access_time" do
+        it "should not be updated" do
+          @store.write(:foo, 123)
+          @store.read(:foo)
+          meta_info_for(:foo).access_time.should be_nil
+        end
+      end
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -1,17 +1,25 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'activesupport-db-cache'
+require 'timecop'
 
 require "sqlite3"
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => 'db/test.sqlite3')
 ActiveRecord::Base.connection.create_table(:cache_items, :force => true) do |t|
   t.column :key, :string
   t.column :value, :text
+  t.column :meta_info, :text
+  t.column :expires_at, :datetime
+  t.column :created_at, :datetime
+  t.column :updated_at, :datetime
 end
 ActiveRecord::Base.connection.add_index(:cache_items, :key, :unique => true)
+ActiveRecord::Base.connection.add_index(:cache_items, :created_at)
+ActiveRecord::Base.connection.add_index(:cache_items, :updated_at)
 
-#logfile = File.open(File.expand_path("../../log/test.log", __FILE__), 'a')
-#ActiveSupport::Cache::ActiveRecordStore.logger = Logger.new(logfile)
+require 'logger'
+logfile = File.open(File.expand_path("../../log/test.log", __FILE__), 'a')
+ActiveRecord::Base.logger = Logger.new(logfile)
 
 Dir['./spec/support/*.rb'].map {|f| require f }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activesupport-db-cache
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
+date: 2013-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: ActiveRecord DB Store engine for ActiveSupport::Cache
 email:
 - sergei.udalov@gmail.com
@@ -91,11 +107,11 @@ files:
 - activesupport-db-cache.gemspec
 - lib/active_support/cache/active_record_store.rb
 - lib/activesupport-db-cache.rb
-- log/test.log
 - spec/active_support/cache/active_record_store_spec.rb
+- spec/active_support/cache/debug_mode_spec.rb
 - spec/spec_helper.rb
 - tasks/rspec.task
-homepage: ''
+homepage: https://github.com/sergio-fry/activesupport-db-cache
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -121,4 +137,5 @@ specification_version: 3
 summary: ActiveRecord DB Store engine for ActiveSupport::Cache
 test_files:
 - spec/active_support/cache/active_record_store_spec.rb
+- spec/active_support/cache/debug_mode_spec.rb
 - spec/spec_helper.rb