devfu-hash-cache 0.1.0

data/README.rdoc

@@ -0,0 +1,65 @@
+= Hash Cache
+
+Hashes make good in-memory caches.  We all do it!
+
+I often create projects that allow some kind of caching repository to exist.
+Usually, I use an instance of a Hash during development, but I might actually 
+want to swap it out with memcached or another cache store, in production.
+
+Whenever I do this, I always have to add #get and #set methods to Hash, as these 
+methods are pretty conventional for cache stores.
+
+Well ... I'm sick of it.  Introducting a mini RubyGem that does this for you.
+
+== Installation
+
+  sudo gem install devfu-hash-cache --source http://gems.github.com
+
+== Usage
+
+  >> cache = { }
+  => {}
+
+  >> cache.set 'chunky', 'bacon'
+  NoMethodError: undefined method `set' for {}:Hash
+          from (irb):2
+
+  >> require 'hash/cache'
+  => true
+
+  >> cache.set 'chunky', 'bacon'
+  => "bacon"
+
+  >> cache
+  => {"chunky"=>"bacon"}
+
+Ta Da!
+
+If you won't want to apply these methods to all Hashes, just a particular instance of a Hash:
+
+  >> require 'hash-cache'
+  => true
+
+  >> cache = { }
+  => {}
+
+  >> cache.set 'chunky', 'bacon'
+  NoMethodError: undefined method `set' for {}:Hash
+          from (irb):2
+
+  >> cache = Hash::Cache.new(cache)
+  => {}
+
+  >> cache.set 'chunky', 'bacon'
+  => "bacon"
+
+  >> cache
+  => {"chunky"=>"bacon"}
+
+  >> Hash.new.get 'foo'
+  NoMethodError: undefined method `get' for {}:Hash
+    from (irb):11
+
+For more information, check out:
+RDoc::  http://code.devfu.com/hash-cache
+Specs:: http://github.com/devfu/hash-cache/blob/master/spec/hash-cache_spec.rb

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+puts "\nGem: hash-cache\n\n"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = 'hash-cache'
+    s.summary     = 'Adds #get and #set methods to Hash(es)'
+    s.email       = 'remi@remitaylor.com'
+    s.homepage    = 'http://github.com/devfu/hash-cache'
+    s.description = 'Adds #get and #set methods to Hash(es) so they can be used as conventional cache stores'
+    s.authors     = %w( remi )
+    s.files       = FileList['[A-Z]*', '{lib,spec,bin,examples}/**/*'] 
+    # s.add_dependency 'person-gemname'
+    # s.executables << 'script'
+    # s.rubyforge_project = 'gemname'
+    # s.extra_rdoc_files = %w( README.rdoc )
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+# require 'hanna'
+# require 'darkfish-rdoc'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'hash-cache'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  # rdoc.options += ["--template=#{`allison --path`}"]  # sudo gem install allison
+  # rdoc.options += %w( -f darkfish )                   # sudo gem install darkfish-rdoc
+  # rdoc.options += %w( -T hanna )                      # sudo gem install mislav-hanna
+  rdoc.options += %w( -m README.rdoc ) # the initial page displayed
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Confirm that gemspec is $SAFE'
+task :safe do
+  require 'yaml'
+  require 'rubygems/specification'
+  data = File.read('hash-cache.gemspec')
+  spec = nil
+  if data !~ %r{!ruby/object:Gem::Specification}
+    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+  else
+    spec = YAML.load(data)
+  end
+  spec.validate
+  puts spec
+  puts "OK"
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/hash-cache.rb

@@ -0,0 +1,80 @@
+class Hash #:nodoc:
+
+  # A module which adds #get and #set methods to an object, usually a Hash
+  #
+  # To get and set values, we call the object's indexer methods, eg.
+  #
+  #   return object[ key ]
+  #
+  #   object[ key ] = value
+  #
+  # Any object which has [] and []= methods can have Hash::Cache included 
+  # in it to get these #get and #set method implementations.
+  module Cache
+
+    def self.included base
+      methods = base.respond_to?(:instance_methods) ? base.instance_methods : base.methods
+      raise "Hash::Cache can only be included in objects that implement the [] method"  unless methods.include?('[]')
+      raise "Hash::Cache can only be included in objects that implement the []= method" unless methods.include?('[]=')
+    end
+
+    # Get a new Hash object with Hash::Cache included
+    #
+    # This allows you to easily get Hash instances with #get and #set 
+    # methods without causing all instances of Hash to get these methods.
+    #
+    #   >> require 'hash-cache'
+    #   => true
+    #
+    #   >> cache = Hash::Cache.new
+    #   => {}
+    #
+    #   >> cache.set 'chunky', 'bacon'
+    #   => "bacon"
+    #
+    #   >> cache.get 'chunky'
+    #   => "bacon"
+    #
+    #   >> cache['chunky']
+    #   => "bacon"
+    #
+    #   >> cache
+    #   => {"chunky"=>"bacon"}
+    #
+    # This accepts an optional Hash instance as an argument which 
+    # will include Hash::Cache in just that particular instance)
+    #
+    #   >> hash = { :chunky => 'bacon' }
+    #   => {:chunky=>"bacon"}
+    #
+    #   >> hash.get :chunky
+    #   NoMethodError: undefined method `get' for {:chunky=>"bacon"}:Hash
+    #     from (irb):7
+    #
+    #   >> Hash::Cache.new(hash).get :chunky
+    #   => "bacon"
+    #
+    #   >> hash.get :chunky   # the original object has the new methods too (we don't dup/clone)
+    #   => "bacon"
+    #
+    #   >> Hash.new.get 'foo'
+    #   NoMethodError: undefined method `get' for {}:Hash
+    #     from (irb):11
+    #
+    def self.new hash = nil
+      hash = hash || Hash.new
+      hash.send :extend, self
+      hash
+    end
+
+    def get key
+      self[ key ]
+    end
+
+    def set key, value
+      self[ key ] = value
+    end
+
+  end
+
+end

data/lib/hash/cache.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/../hash-cache' unless defined? Hash::Cache
+Hash.send :include, Hash::Cache

data/spec/hash-cache_spec.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/hash-cache'
+
+describe Hash::Cache do
+
+  it 'should not have #get or #set methods by default' do
+    Hash.new.should_not respond_to('get')
+    Hash.new.should_not respond_to('set')
+  end
+
+  it 'should get a useful message if including Hash::Cache in an incompatible class' do
+    lambda {
+      Fixnum.send :include, Hash::Cache
+    }.should raise_error(/can only be included in objects that implement the \[\]= method/)
+  end
+
+  it 'should have an easy way to get an instance of Hash with Hash::Cache included' do
+    cache = Hash::Cache.new
+
+    cache.get('chunky').should be_nil
+    cache.set 'chunky', 'bacon'
+    cache.get('chunky').should == 'bacon'
+  end
+
+  it 'should accept an existing Hash in the constructor' do
+    Hash::Cache.new( :x => 5 ).get(:x).should == 5
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: devfu-hash-cache
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- remi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-24 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "Adds #get and #set methods to Hash(es) so they can be used as conventional cache stores"
+email: remi@remitaylor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/hash-cache.rb
+- lib/hash/cache.rb
+- spec/hash-cache_spec.rb
+- spec/spec.opts
+has_rdoc: false
+homepage: http://github.com/devfu/hash-cache
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.5
+signing_key: 
+specification_version: 3
+summary: "Adds #get and #set methods to Hash(es)"
+test_files: 
+- spec/hash-cache_spec.rb