simple_cache_rs 0.9.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+gem "sqlite3"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler"
+  gem "jeweler"
+  gem 'simplecov', :require => false
+  gem "ruby-debug19"
+  gem "timecop"
+  gem "redis"
+end
+

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.6)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    multi_json (1.2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redis (2.2.2)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sqlite3 (1.3.5)
+    timecop (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler
+  redis
+  ruby-debug19
+  simplecov
+  sqlite3
+  timecop

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 radiospiel
+
+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.rdoc

@@ -0,0 +1,19 @@
+= simple_cache
+
+Description goes here.
+
+== Contributing to simple_cache
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 radiospiel. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "simple_cache_rs"
+  gem.homepage = "http://github.com/radiospiel/simple_cache"
+  gem.license = "MIT"
+  gem.summary = %Q{You need a cache? Just throw me in.}
+  gem.description = %Q{A sensibly fast, yet simplistic file based cache.}
+  gem.email = "eno@open-lab.org"
+  gem.authors = ["radiospiel"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "micro_sql #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.1

data/lib/simple_cache/marshal.rb

@@ -0,0 +1,19 @@
+require "base64"
+require "digest/md5"
+
+module SimpleCache::Marshal
+  extend self
+  
+  def uid(key)
+    md5 = Digest::MD5.hexdigest(key)
+    md5.unpack("LL").inject { |a,b| (a << 31) + b }
+  end
+
+  def unmarshal(marshalled)
+    ::Marshal.load Base64.decode64(marshalled) if marshalled
+  end
+
+  def marshal(value)
+    Base64.encode64 ::Marshal.dump(value)
+  end
+end

data/lib/simple_cache/redis_store.rb

@@ -0,0 +1,32 @@
+require "redis"
+
+class SimpleCache::RedisStore
+  Marshal = ::SimpleCache::Marshal
+  
+  def initialize(url)
+    @redis = Redis.connect(:url => url)
+  end
+  
+  def clear
+    @redis.flushdb
+  end
+  
+  def fetch(key, &block)
+    if value = @redis.get(Marshal.uid(key))
+      Marshal.unmarshal(value)
+    elsif block_given?
+      yield self, key
+    end
+  end
+
+  def store(key, value, max_age = nil)
+    cache_id = Marshal.uid(key)
+    if value
+      @redis.set cache_id, Marshal.marshal(value)
+      @redis.expire cache_id, max_age if max_age
+    else
+      @redis.del cache_id
+    end
+    value
+  end
+end

data/lib/simple_cache/sqlite_store.rb

@@ -0,0 +1,72 @@
+require "sqlite3"
+
+# A simplistic Sqlite database interface
+class SimpleCache::SqliteDatabase
+  def initialize(path)
+    FileUtils.mkdir_p File.dirname(@path)
+
+    @impl = SQLite3::Database.new(path)
+    @prepared_queries = {}
+    ask "PRAGMA synchronous = OFF"
+  end
+
+  def exec(sql, *args)
+    query = @prepared_queries[sql] ||= @impl.prepare(sql)
+    query.execute!(*args)
+  end
+
+  def ask(sql, *args)
+    exec(sql, *args).first
+  end
+end
+
+class SimpleCache::SqliteStore < SimpleCache::SqliteDatabase
+  Marshal = ::SimpleCache::Marshal
+  
+  TABLE_NAME = "simple_cache"
+
+  def self.base_dir
+    if RUBY_PLATFORM.downcase.include?("darwin")
+      "#{Dir.home}/Library/Cache"
+    else
+      "#{Dir.home}/cache"
+    end
+  end
+
+  attr :path
+
+  def initialize(name) 
+    @path = "#{SimpleCache::SqliteStore.base_dir}/#{name}/simple_cache.sqlite3" 
+    super @path
+
+    begin
+      ask("SELECT 1 FROM #{TABLE_NAME} LIMIT 1")
+    rescue SQLite3::SQLException
+      ask("CREATE TABLE #{TABLE_NAME}(uid INTEGER PRIMARY KEY, value TEXT, ttl INTEGER NOT NULL)")
+    end
+  end
+
+  def fetch(key, &block)
+    value, ttl = ask("SELECT value, ttl FROM #{TABLE_NAME} WHERE uid=?", Marshal.uid(key))
+    if ttl && (ttl == 0 || ttl > Time.now.to_i)
+      Marshal.unmarshal(value) 
+    elsif block_given?
+      yield self, key
+    end
+  end
+
+  def store(key, value, ttl = nil)
+    unless value.nil?
+      ask("REPLACE INTO #{TABLE_NAME}(uid, value, ttl) VALUES(?,?,?)", 
+            Marshal.uid(key), Marshal.marshal(value), ttl ? ttl + Time.now.to_i : 0)
+    else
+      ask("DELETE FROM #{TABLE_NAME} WHERE uid=?", Marshal.uid(key))
+    end
+
+    value
+  end
+
+  def clear
+    ask "DELETE FROM #{TABLE_NAME}"
+  end
+end

data/lib/simple_cache.rb

@@ -0,0 +1,43 @@
+require "uri"
+
+module SimpleCache
+end
+
+require_relative "simple_cache/marshal"
+require_relative "simple_cache/sqlite_store"
+
+module SimpleCache
+  def self.new(url)
+    uri = URI.parse(url)
+    
+    cache = case uri.scheme
+    when "redis"        then 
+      require_relative "simple_cache/redis_store"
+      SimpleCache::RedisStore.new(url)
+    when nil, "sqlite"  then 
+      SimpleCache::SqliteStore.new(uri.path)
+    else                raise uri.scheme.inspect
+    end
+    
+    cache.extend SimpleCache
+  end
+
+  singleton_class.class_eval do
+    attr :url, true
+
+    def store
+      Thread.current["simple_cache_store"] ||= new(url)
+    end
+  end
+
+  singleton_class.class_eval do
+    extend Forwardable
+    delegate [:fetch, :store, :cached, :clear] => :store
+  end
+  
+  def cached(key, ttl = nil, &block)
+    fetch(key) do
+      store(key, yield, ttl)
+    end
+  end
+end

data/simple_cache.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "simple_cache"
+  s.version = "0.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["radiospiel"]
+  s.date = "2012-04-08"
+  s.description = "A sensibly fast, yet simplistic file based cache."
+  s.email = "eno@open-lab.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/simple_cache.rb",
+    "lib/simple_cache/marshal.rb",
+    "lib/simple_cache/redis_store.rb",
+    "lib/simple_cache/sqlite_store.rb",
+    "simple_cache.gemspec",
+    "test/redis_store_test.rb",
+    "test/sqlite_store_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = "http://github.com/radiospiel/simple_cache"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "You need a cache? Just throw me in."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
+      s.add_development_dependency(%q<redis>, [">= 0"])
+    else
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_dependency(%q<timecop>, [">= 0"])
+      s.add_dependency(%q<redis>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    s.add_dependency(%q<timecop>, [">= 0"])
+    s.add_dependency(%q<redis>, [">= 0"])
+  end
+end
+

data/test/redis_store_test.rb

@@ -0,0 +1,15 @@
+require_relative 'test_helper'
+
+class SimpleCache::RedisStoreTest < Test::Unit::TestCase
+  include SimpleCache::TestCase
+
+  URL = "redis://localhost/1"
+  
+  def simple_cache
+    @simple_cache ||= SimpleCache.new(URL).tap(&:clear)
+  end
+  
+  def teardown
+    @simple_cache.clear if @simple_cache
+  end
+end

data/test/sqlite_store_test.rb

@@ -0,0 +1,22 @@
+require_relative 'test_helper'
+
+class SimpleCache::SqliteStoreTest < Test::Unit::TestCase
+  include SimpleCache::TestCase
+
+  def simple_cache
+    @simple_cache ||= SimpleCache.new("simple_cache_test").tap(&:clear)
+  end
+  
+  def teardown
+    File.unlink @simple_cache.path if @simple_cache
+  end
+
+  def test_expiration
+    assert_equal("1", simple_cache.store("forever", "1"))
+    assert_equal("2", simple_cache.store("young", "2", 3))
+    Timecop.freeze(Time.now + 10) do
+      assert_equal("1", simple_cache.fetch("forever"))
+      assert_equal(nil, simple_cache.fetch("young"))
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'ruby-debug'
+require 'simplecov'
+require 'timecop'
+require 'test/unit'
+SimpleCov.start do
+  add_filter "test/*.rb"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simple_cache'
+
+module SimpleCache::TestCase
+  def test_simple_cache_kindof
+    assert simple_cache.kind_of?(SimpleCache)
+  end
+  
+  def test_simple_cache
+    assert_equal(nil, simple_cache.fetch("bar"))
+
+    assert_equal("foo", simple_cache.store("bar", "foo"))
+    assert_equal("foo", simple_cache.fetch("bar"))
+    
+    done = 0
+    assert_equal "baz", simple_cache.cached("key") { done += 1; "baz" }
+    assert_equal 1, done
+    assert_equal "baz", simple_cache.cached("key") { done += 1; "baz" }
+    assert_equal 1, done
+
+    assert_equal(nil, simple_cache.store("bar", nil))
+    assert_equal(nil, simple_cache.fetch("bar"))
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: simple_cache_rs
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+  prerelease: 
+platform: ruby
+authors:
+- radiospiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70237177950000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70237177950000
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70237177949240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70237177949240
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70237177948560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70237177948560
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70237177947820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70237177947820
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70237177947140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70237177947140
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70237177946480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70237177946480
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70237177945820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70237177945820
+description: A sensibly fast, yet simplistic file based cache.
+email: eno@open-lab.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/simple_cache.rb
+- lib/simple_cache/marshal.rb
+- lib/simple_cache/redis_store.rb
+- lib/simple_cache/sqlite_store.rb
+- simple_cache.gemspec
+- test/redis_store_test.rb
+- test/sqlite_store_test.rb
+- test/test_helper.rb
+homepage: http://github.com/radiospiel/simple_cache
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2088364848885140711
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: You need a cache? Just throw me in.
+test_files: []