sqlite_cache 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a284585e5ff271e5008b315d5d713065b59afd1
+  data.tar.gz: 4c210f3b9b71eafe9c523e50aca564390d719372
+SHA512:
+  metadata.gz: b6a4776c380d48af5960262a4496e02d80f95c57d168614f5e05cc5e315d2d4ee1c7eab5b583d9934b86e3e5379ee12896b2e042cc2b18c0c46addf3982958d9
+  data.tar.gz: 8e6976cb479d4754279823c6342788a44614c119a713d7b47df8275e4d58d65f40c455e74f005139a52c475d7100abc2278fe89d98211ab044451243fa5d7649

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+branches:
+  only:
+    - master

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lars Brillert
+
+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,45 @@
+# SqliteCache
+
+SqliteCache allows to use a SQLite database as storage for your cache. It comes with an API compatible with ActiveSupport::Cache and can though easily used in any Rails Application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sqlite_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sqlite_cache
+
+## Usage
+
+To use SqliteCache just head over to e.g. your `production.rb`file and add the following line
+
+```ruby
+config.cache_store = SqliteCache::Store.new
+```
+
+This will use an inmemory SQLite database. You can also specify a file location
+
+```ruby
+config.cache_store = SqliteCache::Store.new("tmp/cache.db")
+```
+
+For more information about Rails Caching please have a look at the [Rails Cache Guide](http://guides.rubyonrails.org/caching_with_rails.html)
+
+## Testing
+
+    rake
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sqlite_cache.rb

@@ -0,0 +1,8 @@
+require "sequel"
+require "active_support"
+
+require "sqlite_cache/version"
+require "sqlite_cache/store"
+
+module SqliteCache
+end

data/lib/sqlite_cache/store.rb

@@ -0,0 +1,97 @@
+module SqliteCache
+  class Store < ActiveSupport::Cache::Store
+    attr_accessor :logger
+
+    def initialize(path = "", options = nil)
+      @options = options ? options.dup : {}
+      @logger = @options[:logger]
+      @max_cleanup_time = @options.fetch(:max_prune_time, 2)
+
+      if path.present?
+        @db = Sequel.connect("sqlite://#{path}")
+      else
+        @db = Sequel.sqlite
+      end
+
+      @db.create_table(:cache) do
+        String :key
+        String :value
+      end unless @db.table_exists?(:cache)
+
+      @data = @db[:cache]
+    end
+
+    def clear(options = nil)
+      @data.delete
+    rescue Sequel::Error => e
+      logger.error("Sequel::Error (#{e}): #{e.message}") if logger
+      nil
+    end
+
+    def cleanup(max_time = nil)
+      instrument(:cleanup, size: @data.count) do
+        start_time = Time.now
+        @data.each do |row|
+          entry = read_entry(row[:key], options)
+          delete_entry(row[:key], options) if entry && entry.expired?
+          return if (max_time && Time.now - start_time > max_time)
+        end
+      end
+    end
+
+    protected
+
+      def count
+        @data.count
+      end
+
+      # Read an entry from the cache.
+      def read_entry(key, options) # :nodoc:
+        deserialize_entry(@data.where(key: key).get(:value))
+      rescue Sequel::Error => e
+        logger.error("Sequel::Error (#{e}): #{e.message}") if logger
+        nil
+      end
+
+      # Write an entry to the cache.
+      def write_entry(key, entry, options) # :nodoc:
+        cleanup(@max_cleanup_time)
+
+        method = exist?(key) ? :update : :insert
+
+        @data.send(method, {key: key, value: Marshal.dump(entry)})
+        true
+      rescue Sequel::Error => e
+        logger.error("Sequel::Error (#{e}): #{e.message}") if logger
+        false
+      end
+
+      # Delete an entry from the cache.
+      def delete_entry(key, options) # :nodoc:
+        @data.where(key: key).delete
+      rescue Sequel::Error => e
+        logger.error("Sequel::Error (#{e}): #{e.message}") if logger
+        false
+      end
+
+    private
+
+      def serialize_entry(value)
+        if value
+          entry = Marshal.dump(value) rescue value
+          entry.is_a?(Entry) ? entry : Entry.new(entry)
+        else
+          nil
+        end
+      end
+
+      def deserialize_entry(raw_value)
+        if raw_value
+          entry = Marshal.load(raw_value) rescue raw_value
+          entry.is_a?(ActiveSupport::Cache::Entry) ? entry : ActiveSupport::Cache::Entry.new(entry)
+        else
+          nil
+        end
+      end
+  end
+end

data/lib/sqlite_cache/version.rb

@@ -0,0 +1,3 @@
+module SqliteCache
+  VERSION = "1.0.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'sqlite_cache'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/sqlite_cache_store_spec.rb

@@ -0,0 +1,174 @@
+require "spec_helper"
+
+class Pony
+
+  attr_accessor :name
+
+  def initialize(name)
+    self.name = name
+  end
+
+  def ==(other)
+    self.name == other.name
+  end
+
+end
+
+describe SqliteCache::Store do
+
+
+  describe "#fetch" do
+    describe "with cache hit" do
+      before { subject.write("foo", "bar") }
+
+      it "will return the cached value" do
+        expect(subject.fetch("foo") { "baz" }).to eq("bar")
+      end
+
+      it "will the block value when forced" do
+        expect(subject.fetch("foo", force: true) { "baz" }).to eq("baz")
+      end
+
+      describe "when nil is cached" do
+        before { subject.write("foo", nil) }
+
+        it "will stick to the cache " do
+          expect(subject.fetch("foo") { "baz" }).to be_nil
+        end
+      end
+
+    end
+
+    describe "with cache miss" do
+      before { subject.clear }
+
+      it "will return the value from the block" do
+        expect(subject.fetch("foo") { "baz" }).to eq("baz")
+      end
+    end
+
+  end
+
+  describe "#read" do
+
+    describe "value that wont expire" do
+      before { subject.write("foo", "bar") }
+
+      it "will return the value from the cache" do
+        expect(subject.read("foo")).to eq("bar")
+      end
+    end
+
+    describe "when a value expires" do
+      let(:time) { Time.local(2008, 4, 24) }
+      before do
+        Time.stub(now: time)
+        subject.write("foo", "bar", expires_in: 60.second)
+      end
+
+      it "will be removed from the cache" do
+        expect{ Time.stub(now: time + 61) }.to change{subject.read("foo")}.from("bar").to(nil)
+      end
+    end
+
+    describe "value is a complex type" do
+      let(:pony) { Pony.new("name") }
+
+      before { subject.write("foo", pony) }
+      it "will return the value from the cache" do
+        expect(subject.read("foo")).to eq(pony)
+      end
+    end
+  end
+
+  describe "#write" do
+
+    it "will persist a value into the cache" do
+      expect{subject.write("foo", "bar")}.not_to raise_error
+      expect(subject.read("foo")).to eq("bar")
+    end
+
+    describe "updating a existing key" do
+      before { subject.write("foo", "bar") }
+
+      it "will update a value in the cache" do
+        expect{subject.write("foo", "baz")}.to change{ subject.read("foo")}.from("bar").to("baz")
+      end
+    end
+
+  end
+
+  describe "#delete" do
+
+    before { subject.write("foo", "bar") }
+    it "will delte a key from the cache" do
+      expect{subject.delete("foo")}.to change{ subject.read("foo")}.from("bar").to(nil)
+    end
+  end
+
+  describe "#exist?" do
+    it "will delte a key from the cache" do
+      expect{subject.write("foo", "bar")}.to change{ subject.exist?("foo")}.from(nil).to(true)
+    end
+  end
+
+  describe "#clear" do
+    before do
+      subject.write("foo", "bar")
+      subject.write("john", "doe")
+    end
+
+    it "will delte all keys from the cache" do
+      subject.clear
+
+      expect(subject.exist?("foo")).to be_nil
+      expect(subject.exist?("john")).to be_nil
+    end
+  end
+
+  describe "#cleanup" do
+    let(:time) { Time.local(2008, 4, 24) }
+
+    before do
+      subject.clear
+
+      Time.stub(now: time)
+
+      subject.write("john", "doe", expires_in: 120.second)
+      subject.write("foo", "bar", expires_in: 60.second)
+
+      Time.stub(now: time + 61)
+    end
+
+    it "will delte all expired keys from the cache" do
+      expect{ subject.cleanup }.to change{ subject.send(:read_entry, "foo", {})}.to(nil)
+    end
+
+    it "will leave the others untouched" do
+      expect{ subject.cleanup }.not_to change{ subject.send(:read_entry, "john", {})}.to(nil)
+    end
+
+    describe "with max_time applied" do
+      before do
+        subject.clear
+
+        Time.stub(now: time)
+
+        subject.write("john", "doe", expires_in: 30.second)
+        subject.write("foo", "bar", expires_in: 30.second)
+
+        Time.stub(now: time + 60)
+      end
+
+      it "cannot cleanup all items when running out of time" do
+        expect{ subject.cleanup(-12) }.to change{ subject.send(:count)}.by(-1)
+      end
+
+      it "can cleanup all items when time is plenty" do
+        expect{ subject.cleanup(2) }.to change{ subject.send(:count)}.by(-2)
+      end
+    end
+
+  end
+
+end

data/sqlite_cache.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sqlite_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sqlite_cache"
+  spec.version       = SqliteCache::VERSION
+  spec.authors       = ["Lars Brillert"]
+  spec.email         = ["lars@railslove.com"]
+  spec.description   = %q{Use sqlite3 as a caching adapter}
+  spec.summary       = %q{Use sqlite3 as a caching adapter}
+  spec.homepage      = "http://railslove.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "sequel"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "sqlite3"
+  spec.add_dependency "dalli"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: sqlite_cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lars Brillert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-23 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  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: 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: sqlite3
+  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: dalli
+  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'
+description: Use sqlite3 as a caching adapter
+email:
+- lars@railslove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sqlite_cache.rb
+- lib/sqlite_cache/store.rb
+- lib/sqlite_cache/version.rb
+- spec/spec_helper.rb
+- spec/sqlite_cache_store_spec.rb
+- sqlite_cache.gemspec
+homepage: http://railslove.com
+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: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Use sqlite3 as a caching adapter
+test_files:
+- spec/spec_helper.rb
+- spec/sqlite_cache_store_spec.rb