sqlitecache 0.0.1

data/COPYING

@@ -0,0 +1,56 @@
+SqliteCache is copyrighted free software by Nicholas J Humfrey <njh@aelius.com>.
+You can redistribute it and/or modify it under either the terms of the GPL
+version 2 (see the file GPL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/NEWS

@@ -0,0 +1,2 @@
+Version 0.1.0 (2008-10-30)
+  * Initial Release.

data/README

@@ -0,0 +1,37 @@
+== SQLiteCache
+
+SQLiteCache is a gem to allow you cache slow operations in ruby code.
+It provides a simple API to make it easy to add caching to your ruby code.
+
+RubyForge Project Page  http://rubyforge.org/projects/sqlitecache/
+
+== Installing
+
+You may get the latest stable version from Rubyforge. Source gems are also available.
+
+  $ gem install sqlitecache
+
+=== Loading sqlitecache gem itself
+
+You have installed the gem already, yeah?
+
+ require 'rubygems'
+ require 'sqlitecache'
+
+== Example
+
+  cache = SqliteCache('my_cache.db')
+  result = cache.do_cached('key') do
+    my_intensive_operation
+  end
+
+== Resources
+
+Documentation: http://sqlitecache.rubyforge.org/
+
+== Contact
+
+Author::     Nicholas J Humfrey
+Email::      njh@aelius.com 
+Home Page::  http://www.aelius.com/njh/
+License::    Distributes under the same terms as Ruby

data/Rakefile

@@ -0,0 +1,90 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+NAME = "sqlitecache"
+VERS = "0.0.1"
+CLEAN.include ['pkg', 'rdoc']
+
+Gem::manage_gems
+
+spec = Gem::Specification.new do |s|
+  s.name              = NAME
+  s.version           = VERS
+  s.author            = "Nicholas J Humfrey"
+  s.email             = "njh@aelius.com"
+  s.homepage          = "http://sqlitecache.rubyforge.org"
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = "SQLite Cache is a gem to allow you cache slow queries in ruby code." 
+  s.rubyforge_project = "sqlitecache" 
+  s.description       = "The SQLite Cache gem allows you cache slow queries in ruby code. It provides a simple API to make it easy to add caching to your ruby code."
+  s.files             = FileList["Rakefile", "lib/sqlite_cache.rb", "examples/*"]
+  s.require_path      = "lib"
+  
+  # rdoc
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = ["README", "NEWS", "COPYING"]
+  
+  # Dependencies
+  s.add_dependency "rake"
+end
+
+desc "Default: package up the gem."
+task :default => :package
+
+task :build_package => [:repackage]
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = true
+  pkg.gem_spec = spec
+end
+
+desc "Run :package and install the resulting .gem"
+task :install => :package do
+  sh %{sudo gem install --local pkg/#{NAME}-#{VERS}.gem}
+end
+
+desc "Run :clean and uninstall the .gem"
+task :uninstall => :clean do
+  sh %{sudo gem uninstall #{NAME}}
+end
+
+
+
+## Testing
+desc "Run all the specification tests"
+Rake::TestTask.new(:spec) do |t|
+  t.warning = true
+  t.verbose = true
+  t.pattern = 'spec/*_spec.rb'
+end
+  
+desc "Check the syntax of all ruby files"
+task :check_syntax do
+  `find . -name "*.rb" |xargs -n1 ruby -c |grep -v "Syntax OK"`
+  puts "* Done"
+end
+
+desc "Create rspec report as HTML"
+task :rspec_html do
+  sh %{spec -f html spec/sqlite_cache_spec.rb > rspec_results.html}
+end
+
+## Documentation
+desc "Generate documentation for the library"
+Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "sqlitecache Documentation"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.main = "README"
+  rdoc.rdoc_files.include("README", "NEWS", "COPYING", "lib/sqlite_cache.rb")
+}
+
+desc "Upload rdoc to rubyforge"
+task :upload_rdoc => [:rdoc] do
+  sh %{/usr/bin/scp -r -p rdoc/* sqlitecache.rubyforge.org:/var/www/gforge-projects/sqlitecache}
+end
+

data/lib/sqlite_cache.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'sqlite3'
+require 'yaml'
+
+
+## Lightweight, persistent cache, to store keys and their values in an SQLite database.
+class SqliteCache
+  ## Enable/disable cache hit counting [boolean]
+  attr_accessor :count_hits
+  
+  ## Number of times to retry, if database is locked [integer, default 100]
+  attr_accessor :busy_retries
+  
+  ## Name of the table in the database to store things in.
+  TABLE_NAME = 'sqlitecache'
+
+  ## Create a new SQLiteCache. Where <tt>path</tt> is the full path to the SQLite database file to use.
+  def initialize( path )
+    @db = SQLite3::Database.new( path )
+    @count_hits = false
+    @busy_retries = 100
+
+    # Wait up to 10 seconds to access locked database
+    @db.busy_handler do |resource,retries|
+      sleep 0.1
+      retries<@busy_retries
+    end
+    
+    # Create the table, if it doesn't exist
+    if @db.table_info(TABLE_NAME).empty?
+      @db.execute( %Q{
+        CREATE TABLE #{TABLE_NAME} (
+          id INTEGER PRIMARY KEY AUTOINCREMENT,
+          key TEXT,
+          value TEXT,
+          hits INTEGER DEFAULT 0,
+          created_at INTEGER,
+          updated_at INTEGER
+        );
+      } )
+      @db.execute( %Q{ CREATE UNIQUE INDEX key_index ON #{TABLE_NAME} (key) } )
+    end
+  end
+  
+  ## Delete everything in the cache.
+  def purge
+    @db.execute( "DELETE FROM #{TABLE_NAME};" )
+  end
+  
+  ## Return the number of items in the cache.
+  def size
+    @db.get_first_value( "SELECT COUNT(*) FROM #{TABLE_NAME};" ).to_i
+  end
+
+  ## Fetch something from the cache, based on a key string.
+  def fetch( key )
+    key = key.to_s.strip unless key.nil?
+    raise "Invalid key" if key.nil? or key == ''
+
+    id,value,hits = @db.get_first_row(
+      "SELECT id,value,hits "+
+      "FROM #{TABLE_NAME} "+
+      "WHERE key=?",
+      key.to_s.strip
+    )
+
+    # Return nil if there is cache MISS.
+    return nil if value.nil?
+    
+    # Increment the number of hits
+    if @count_hits
+      @db.execute(
+        "UPDATE #{TABLE_NAME} SET hits=?, updated_at=? WHERE id=?",
+        hits.to_i+1, Time.now.to_i, id
+      )
+    end
+
+    # Otherwise if there is a HIT, parse the YAML into an object
+    return YAML::load(value)
+  end
+
+  ## Store a key and value in the cache.
+  def store( key, value )
+    key = key.to_s.strip unless key.nil?
+    raise "Invalid key" if key.nil? or key == ''
+  
+    @db.execute( %Q{
+        INSERT INTO #{TABLE_NAME}
+        (key,value,created_at)
+        VALUES (?,?,?)
+      },
+      key,
+      value.to_yaml,
+      Time.now.to_i
+    )
+    
+    return value
+  end
+
+  ## Perform a block if key isn't already cached.
+  def do_cached( key, &block )
+  
+    # have a look in the cache
+    value = fetch( key )
+
+    # Cache HIT?
+    return value unless value.nil?
+
+    # Cache MISS : execute the block
+    value = block.call( key )
+
+    # Store value in the cache
+    return store( key, value )
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: sqlitecache
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nicholas J Humfrey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-30 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: The SQLite Cache gem allows you cache slow queries in ruby code. It provides a simple API to make it easy to add caching to your ruby code.
+email: njh@aelius.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- NEWS
+- COPYING
+files: 
+- Rakefile
+- lib/sqlite_cache.rb
+- README
+- NEWS
+- COPYING
+has_rdoc: true
+homepage: http://sqlitecache.rubyforge.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: sqlitecache
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: SQLite Cache is a gem to allow you cache slow queries in ruby code.
+test_files: []
+