drawer 0.0.7

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008 Michel Martens
+
+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,34 @@
+= Drawer
+
+Ultra slim file-based cache.
+
+== Usage
+
+  require 'drawer'
+
+  cache = Drawer.new('db/development.drawer')
+  cache.get('foo')                #=> nil
+  cache.set('foo', 123)
+  cache.get('foo')                #=> 123
+  cache.flush_all
+  cache.get('foo')                #=> nil
+  cache.set('bar', 456)
+  cache.set('baz', 789)
+  cache.get_multi('bar', 'baz')   #=> [456, 789]
+
+An optional second parameter is a class to be used as the persistence layer.
+By default, DrawerStore is used, but it can be replaced by any class that
+provides load and save methods. For example:
+
+  cache = Drawer.new(some_file, MyStoreClass)
+
+Now, MyStoreClass.load(some_file) and MyStoreClass.save(@cache, some_file) will
+be used for retrieving and saving the cached contents.
+
+== Installation
+
+  $ gem sources -a http://gems.github.com (you only have to do this once)
+  $ sudo gem install soveran-drawer
+
+Copyright (c) 2008 Michel Martens.
+Released under the MIT license.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/clean'
+
+gem_spec_file = 'drawer.gemspec'
+
+gem_spec = eval(File.read(gem_spec_file)) rescue nil
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+  rm_f FileList['pkg/**/*.*']
+end if gem_spec
+
+task :default => :test
+
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.libs << "drawer"
+  t.test_files = FileList['test/*.rb']
+  t.verbose = true
+end
+
+
+desc "Generate the gemspec file."
+task :gemspec do
+  require 'erb'
+
+  File.open(gem_spec_file, 'w') do |f|
+    f.write ERB.new(File.read("#{gem_spec_file}.erb")).result(binding)
+  end
+end
+
+desc "Builds and installs the gem."
+task :install => :repackage do
+  `sudo gem install pkg/#{gem_spec.name}-#{gem_spec.version}.gem`
+end

data/bin/drawer

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+unless file_name = ARGV.first
+  puts "Usage: drawer path_to_drawer_file"
+  exit 1
+end
+
+unless File.exists?(file_name)
+  puts "The file #{file_name} doesn't exist"
+  exit
+end
+
+ENV['DRAWER'] = file_name
+
+require "drawer/console"

data/example/db/development.yml

@@ -0,0 +1,2 @@
+--- {}
+

data/example/drawer_sample.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), '../lib/drawer')
+
+cache_file = File.join(File.dirname(__FILE__), 'db/development.yml')
+
+cache = Drawer.new(cache_file)
+
+puts "Store the value 123 in the 'foo' key."
+puts "=> " + cache.set("foo", 123).inspect
+
+puts "Store the value 456 in the 'bar' key."
+puts "=> " + cache.set("bar", 456).inspect
+
+puts "Retrieve the value for the key 'foo'."
+puts "=> " + cache.get("foo").inspect
+
+puts "Retrieve the value for the keys 'foo' and 'bar'."
+puts "=> " + cache.get_multi("foo", "bar").inspect
+
+puts "Flush the cache."
+puts "=> " + cache.flush_all.inspect
+
+puts "Try to get foo again."
+puts "=> " + cache.get("foo").inspect

data/example/drawer_sample_gem.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'drawer'
+
+cache_file = File.join(File.dirname(__FILE__), 'db/development.yml')
+
+cache = Drawer.new(cache_file)
+
+puts "Store the value 123 in the given key."
+puts "=> " + cache.set("foo", 123).inspect
+
+puts "Retrieve the value for the key foo."
+puts "=> " + cache.get("foo").inspect
+
+puts "Flush the cache."
+puts "=> " + cache.flush_all.inspect
+
+puts "Try to get foo again."
+puts "=> " + cache.get("foo").inspect

data/lib/drawer.rb

@@ -0,0 +1,83 @@
+require 'yaml'
+
+class DrawerStore
+  def self.load(file)
+    YAML.load_file(File.expand_path(file))
+  end
+
+  def self.save(object, file)
+    File.open(File.expand_path(file), 'w') do |f|
+      YAML.dump(object, f)
+    end
+  end
+end
+
+class Drawer
+  attr :cache
+  attr :store
+
+  def initialize(file, store = DrawerStore)
+    @store = store
+    @cache = store.load(file) || {}
+
+    at_exit do
+      save(file)
+    end
+  end
+
+  def get(k)
+    cache[k] or (set(k, yield) if block_given?)
+  end
+
+  def get_multi(*ks)
+    ks.collect { |k| get(k) }
+  end
+
+  def set(k, v)
+    cache[k] = v
+  end
+
+  def add(k, v)
+    set(k, v) unless cache[k]
+  end
+
+  def remove(k)
+    cache.delete(k)
+  end
+
+  def flush_all
+    cache.clear
+  end
+
+  def inspect
+    "Drawer count: #{cache.size}. Type 'cache' to view the content."
+  end
+
+  def save(file)
+    store.save(@cache, file)
+  end
+
+  def self.open(file, &block)
+    file = File.expand_path(file)
+    drawer = Drawer.new(file)
+    yield drawer if block_given?
+    drawer
+  end
+
+  def self.open!(file)
+    file = File.expand_path(file)
+    create(file)
+    open(file)
+  end
+
+  def self.create(file)
+    unless File.exists?(file)
+      FileUtils.mkdir_p File.dirname(file)
+      FileUtils.touch(file)
+    end
+  end
+
+  def self.remove(file)
+    FileUtils.rm(file)
+  end
+end

data/lib/drawer/console.rb

@@ -0,0 +1,2 @@
+bootstrap = File.join(File.dirname(__FILE__), 'irb.rb')
+system "irb --simple-prompt #{bootstrap}"

data/lib/drawer/irb.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'drawer'
+
+IRB.conf[:IRB_RC] = lambda do
+  system 'clear'
+end
+
+irb Drawer.new(ENV['DRAWER'])

data/test/db/test.yml

@@ -0,0 +1,2 @@
+--- {}
+

data/test/drawer_test.rb

@@ -0,0 +1,112 @@
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+
+require File.join(File.dirname(__FILE__), '../lib/drawer')
+
+def cache_file
+  @cache_file ||= File.join(File.dirname(__FILE__), 'db/test.yml')
+end
+
+class TestDrawer < Test::Unit::TestCase
+  context "drawer" do
+    setup do
+      Drawer.create(cache_file)
+      @drawer = Drawer.new(cache_file)
+      @drawer.flush_all
+    end
+
+    should "return nil if a key is not found" do
+      assert_nil @drawer.get("foo")
+    end
+
+    should "set a key with a block on a cache miss" do
+      assert_equal 123, @drawer.get("foo") { 123 }
+      assert_nothing_raised { @drawer.get("foo") { raise 'Should not call block.' } }
+    end
+
+    should "successfully set a key" do
+      @drawer.set("foo", 123)
+      assert_equal 123, @drawer.get("foo")
+      
+      assert_equal 124, @drawer.set("foo", 124)
+    end
+
+    should "clear an entry with remove" do
+      @drawer.set("foo", 123)
+      @drawer.remove("foo")
+      assert_nil @drawer.get("foo")
+    end
+
+    context "flush_all" do
+      setup do
+        @drawer.set("foo", 123)
+        @drawer.flush_all
+      end
+
+      should "clear all keys" do
+        assert_nil @drawer.get("foo")
+      end
+    end
+
+    context "get_multi" do
+      setup do
+        10.times do |i|
+          @drawer.set(i, i * i)
+        end
+      end
+
+      should "return a list of values" do
+        assert_equal [9, 25, 49], @drawer.get_multi(3, 5, 7)
+      end
+    end
+
+    context "class methods" do
+      setup do
+        Drawer.remove(cache_file)
+        Drawer.create(cache_file)
+      end
+
+      context "open" do
+        should "return an instance of Drawer" do
+          assert_kind_of Drawer, Drawer.open(cache_file)
+        end
+      end
+
+      context "open with block" do
+        should "call the passed block" do
+          drawer = Drawer.open(cache_file) do |cache|
+            cache.set("foo", 123)
+          end
+          assert_equal 123, drawer.get('foo')
+        end
+      end
+    end
+
+    context "class methods with unexistent file" do
+      setup do
+        Drawer.remove(cache_file)
+      end
+
+      context "open" do
+        should "raise if the file doesn't exist" do
+          assert_raise Errno::ENOENT do
+            Drawer.open(cache_file)
+          end
+        end
+
+        should "not create the file" do
+          Drawer.open(cache_file) rescue Errno::ENOENT
+          assert_equal false, File.exists?(cache_file)
+        end
+      end
+
+      context "open!" do
+        should "create the file" do
+          Drawer.open!(cache_file)
+          assert_equal true, File.exists?(cache_file)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: drawer
+version: !ruby/object:Gem::Version 
+  version: 0.0.7
+platform: ruby
+authors: 
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-05 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: michel@soveran.com
+executables: 
+- drawer
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/drawer/console.rb
+- lib/drawer/irb.rb
+- lib/drawer.rb
+- README.rdoc
+- LICENSE
+- Rakefile
+- example/db/development.yml
+- example/drawer_sample.rb
+- example/drawer_sample_gem.rb
+- test/db/test.yml
+- test/drawer_test.rb
+has_rdoc: false
+homepage: http://github.com/soveran/drawer
+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: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Ultra light file-based cache.
+test_files: []
+