hash_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61ac041d1e693549eb5e98520b4e974b0f8197f7
+  data.tar.gz: 42c22e0f28c1df9c7d91073e29455cab89c4075a
+SHA512:
+  metadata.gz: 6ee6af4165117ee25f8f8c707aeba7c8a923ef9af0bea40af20ffe2c72f443391edbb81959157f97c97819468e001ec7d6d9ddf7c6a39409cbc5c35f482bf0bc
+  data.tar.gz: f9be59948e4c22d7801f5e3055ba1ccdbb2c7a2d9b1a0bf12b4e8a933215db8abf5399b2575218bd9cd7fc6a10dd458e736d65a42928395587fd9ad03e3db96d

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hash_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathan Long
+
+MIT License
+
+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.md

@@ -0,0 +1,70 @@
+# HashCache
+
+HashCache is a small collection of hashes that cache data.
+
+## Usage
+
+HashCache provides the following classes.
+
+### HashCache::TTL
+
+TTL (Time To Live) remembers values for as many seconds as you tell it. The default is 3600 seconds (1 hour).
+
+```ruby
+require 'hash_cache/ttl'
+
+h = HashCache::TTL.new(ttl: 5)
+h[:a] = 'aardvark'
+h[:a] #=> 'aardvark'
+sleep(6)
+h[:a] #=> nil
+```
+
+If you pass `refresh: true`, reading a value will reset its timer; otherwise, only writing will.
+
+The `memoize` method fetches a key if it exists and isn't expired; otherwise, it calculates the value using the block and saves it.
+
+```ruby
+h = HashCache::TTL.new(ttl: 5)
+
+# Runs the block
+h.memoize(:a) { |k| calculation_for(k) }
+
+# Returns the previously-calculated value
+h.memoize(:a) { |k| calculation_for(k) }
+
+sleep(6)
+
+# Runs the block
+h.memoize(:a) { |k| calculation_for(k) }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hash_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_cache
+
+## Coming Soon
+
+Other classes with different cache expiration strategies.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+# Thanks
+
+Original tests were adapted from [volatile_hash](https://github.com/satyap/volatile_hash).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run the specs in documentation format"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--format documentation'
+end
+
+task :default => :spec

data/hash_cache.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_cache"
+  spec.version       = HashCache::VERSION
+  spec.authors       = ["Nathan Long"]
+  spec.email         = ["nathanmlong@gmail.com"]
+  spec.description   = %q{A small collection of hashes that cache}
+  spec.summary       = %q{A small collection of hashes that cache}
+  spec.homepage      = "https://github.com/nathanl/hash_cache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec",   "~> 2.14"
+
+end

data/lib/hash_cache/ttl.rb

@@ -0,0 +1,49 @@
+module HashCache
+  class TTL
+    attr_accessor :ttl, :refresh
+
+    def initialize(options = {})
+      self.ttl     = options.fetch(:ttl) { 3600 }
+      self.refresh = !!(options.fetch(:refresh, false))
+      self.data    = {}
+    end
+
+    def [](key)
+      return nil unless data.has_key?(key)
+      if (current_time - data[key][:time]) < ttl
+        data[key][:time] = current_time if refresh
+        data[key][:value]
+      else
+        data.delete(key)
+        nil
+      end
+    end
+
+    def []=(key, val)
+      data[key] = {time: current_time, value: val}
+    end
+
+    def fetch(key, default = (default_omitted = true; nil))
+      return self[key]  if data.has_key?(key)
+      return default    unless default_omitted
+      return yield(key) if block_given?
+      raise KeyError
+    end
+
+    def memoize(key)
+      raise ArgumentError, "Block is required" unless block_given?
+      self[key] # triggers flush or refresh if expired
+      return self[key]       if data.has_key?(key)
+      self[key] = yield(key) if block_given?
+    end
+
+    private
+
+    attr_accessor :data
+
+    def current_time
+      Time.now
+    end
+
+  end
+end

data/lib/hash_cache/version.rb

@@ -0,0 +1,3 @@
+module HashCache
+  VERSION = "0.0.1"
+end

data/lib/hash_cache.rb

@@ -0,0 +1,5 @@
+require 'time'
+require "hash_cache/version"
+
+module HashCache
+end

data/spec/hash_cache/ttl_spec.rb

@@ -0,0 +1,158 @@
+require          'spec_helper'
+require_relative '../../lib/hash_cache/ttl'
+
+describe HashCache::TTL do
+
+  let(:options) { {} }
+  let(:cache)   {
+    described_class.new(options).tap {|c|
+      c[:c] = 'Caspian'
+      c.stub(:current_time).and_return(start_time)
+    }
+  }
+
+  let(:start_time) { Time.now }
+  let(:before_ttl) { start_time + 1800 }
+  let(:after_ttl)  { start_time + 3601 }
+
+  it "remembers cached values before the TTL expires" do
+    expect(cache[:c]).to eq('Caspian')
+    cache.stub(:current_time).and_return(before_ttl)
+    expect(cache[:c]).to eq('Caspian')
+  end
+
+  it "forgets cached values after the TTL expires" do
+    expect(cache[:c]).to eq('Caspian')
+    cache.stub(:current_time).and_return(after_ttl)
+    expect(cache[:c]).to be_nil
+  end
+
+  it "continues returning nil for cached values after the TTL expires" do
+    expect(cache[:c]).to eq('Caspian')
+    cache.stub(:current_time).and_return(after_ttl)
+    expect(cache[:c]).to be_nil
+    expect(cache[:c]).to be_nil
+  end
+
+  it "resets TTL when an item is updated" do
+    cache.stub(:current_time).and_return(before_ttl)
+    cache[:c] = 'Cornelius'
+    cache.stub(:current_time).and_return(after_ttl)
+    expect(cache[:c]).to eq('Cornelius')
+  end
+
+  it "doesn't reset TTL when an item is accessed" do
+    cache.stub(:current_time).and_return(before_ttl)
+    expect(cache[:c]).to eq('Caspian')
+    cache.stub(:current_time).and_return(after_ttl)
+    expect(cache[:c]).to be_nil
+  end
+
+  context "when asked to refresh TTL on access" do
+
+    let(:options) { {refresh: true} }
+
+    it "keeps values that were accessed before the TTL expired" do
+      cache.stub(:current_time).and_return(before_ttl)
+      expect(cache[:c]).to eq('Caspian')
+      cache.stub(:current_time).and_return(after_ttl)
+      expect(cache[:c]).to eq('Caspian')
+    end
+
+  end
+
+  describe "fetch" do
+
+    it "returns the value if an existing key is accessed" do
+      expect(cache.fetch(:c)).to eq('Caspian')
+    end
+
+    it "raises an error if a missing key is accessed" do
+      expect{cache.fetch(:nonexistent)}.to raise_error(KeyError)
+    end
+
+    it "uses a default value if one is supplied" do
+      expect(cache.fetch(:nonexistent, 'hi')).to eq('hi')
+    end
+
+    it "gets its default from a block if one is supplied" do
+      expect(cache.fetch(:nonexistent) { |key| key.to_s.upcase }).to eq('NONEXISTENT')
+    end
+
+    it "uses the immediate value if both it and the block are supplied" do
+      expect(cache.fetch(:nonexistent, 'hi') { |key| key.to_s.upcase }).to eq('hi')
+    end
+
+  end
+
+  describe "memoize" do
+
+    it "requires a block" do
+      expect{cache_memoize(:c)}.to raise_error
+    end
+
+    let(:greeting) { 'hi' }
+
+    context "when the key already exists" do
+
+      context "before the TTL is up" do
+
+        it "returns the existing value" do
+          expect(cache.memoize(:c) { 'Eustace' } ).to eq('Caspian')
+        end
+
+        it "does not calculate the value" do
+          cache.stub(:current_time).and_return(before_ttl)
+          expect(greeting).not_to receive(:upcase)
+          cache.memoize(:c) { greeting.upcase }
+        end
+
+      end
+
+      context "after the TTL is up" do
+
+        it "recalculates the value" do
+          cache.stub(:current_time).and_return(after_ttl)
+          expect(greeting).to receive(:upcase)
+          cache.memoize(:c) { greeting.upcase }
+        end
+
+        it "returns the calculated value" do
+          cache.stub(:current_time).and_return(after_ttl)
+          expect(cache.memoize(:c) { |key| key.to_s.upcase }).to eq('C')
+        end
+
+      end
+
+    end
+
+    context "when the key does not exist" do
+
+      it "calculates the value" do
+        expect(greeting).to receive(:upcase)
+        cache.memoize(:nonexistent) { greeting.upcase }
+      end
+
+      it "returns the value" do
+        expect(cache.memoize(:nonexistent) { |key| key.to_s.upcase }).to eq('NONEXISTENT')
+      end
+
+      it "does not calculate the value again within the TTL" do
+        cache.memoize(:nonexistent) { greeting.upcase }
+        cache.stub(:current_time).and_return(before_ttl)
+        expect(greeting).not_to receive(:upcase)
+        cache.memoize(:nonexistent) { greeting.upcase }
+      end
+
+      it "does calculate the value again after the TTL is up" do
+        cache.memoize(:nonexistent) { greeting.upcase }
+        cache.stub(:current_time).and_return(after_ttl)
+        expect(greeting).to receive(:upcase)
+        cache.memoize(:nonexistent) { greeting.upcase }
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+
+RSpec.configure do |config|
+  config.order = :random
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: hash_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Long
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: A small collection of hashes that cache
+email:
+- nathanmlong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_cache.gemspec
+- lib/hash_cache.rb
+- lib/hash_cache/ttl.rb
+- lib/hash_cache/version.rb
+- spec/hash_cache/ttl_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nathanl/hash_cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A small collection of hashes that cache
+test_files:
+- spec/hash_cache/ttl_spec.rb
+- spec/spec_helper.rb