hash-cache 0.1.1

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

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: hash-cache
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- remi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "Adds #get and #set methods to hashes so they can be used as conventional cache stores"
+email: remi@remitaylor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/hash/cache.rb
+- lib/hash-cache.rb
+has_rdoc: true
+homepage: http://github.com/devfu/hash-cache
+licenses: []
+
+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.5
+signing_key: 
+specification_version: 3
+summary: "Adds #get and #set methods to hashes"
+test_files: []
+