cache_hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff056e231d380da9b9835a65116f1294cac072cd
+  data.tar.gz: a2c6a788d6b00896aff970f80ba4106858608e66
+SHA512:
+  metadata.gz: 06f006651e1ea46ec1e6bc9f79e44e34e93975b5458557b30457021b31bed99612a7dbc4026dd94983b9c3bced61a053f4d6ce1ca1ad91160158e5ab2a86fd4d
+  data.tar.gz: 4b9d620a16629cdb601130fad5bd428c5171fa8964c6a7e148e98881ca9b3b694d5a5ad486e27af7f4234d8bf370e2eac8dd365e75467f5e0a305f8927a7268f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Doug Everly
+
+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,93 @@
+# CacheHash
+
+Simple hash with expiring values.
+
+* Simple - Returns value or nil.
+* Default - Returns value or default
+* Block - Returns value, or refreshes the value by yielding to long running job.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cache_hash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_hash
+
+## Usage
+
+### Simple
+
+Returns value or nil.
+
+    c = CacheHash.new(ttl: 3)
+    c[:a] = "its here"
+    puts c[:a] # => "its here" or nil if called after 3 seconds
+
+### Default Value
+
+Returns value or default.
+
+    x = 0
+    c[:foo] = "HAZ VALUE"
+    c.fetch(:foo, "NO VALUE") # => "HAZ VALUE"
+    # wait 3 seconds
+    c.fetch(:foo, "NO VALUE") # => "NO VALUE"
+    
+
+### Block
+
+Returns value, or refreshes the value by yielding to long running job.
+
+    c = CacheHash.new(ttl: 5)
+    users = ['smith', 'jones']
+    
+    # first run loads cache
+    
+    users.each do |user|
+       row = c.fetch(user) {
+        # long running job
+        get_user(user)
+      }
+    end
+    
+    # second run hits cache
+
+    users.each do |user|
+       row = c.fetch(user) {
+        # long running job
+        get_user(user)
+      }
+    end
+    
+    
+    # third run refreshes cache
+
+    sleep 6
+    users.each do |user|
+       row = c.fetch(user) {
+        # long running job
+        get_user(user)
+      }
+    end
+
+
+    c = CacheHash.new(ttl: 2, gc_interval: 1)
+
+    
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cache_hash/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/test.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cache_hash'
+
+def test1
+  puts "Testing fetch"
+  c = CacheHash.new(ttl: 3, gc_interval: 1)
+
+  c[:a] = "its here"
+
+  sleep 1
+  puts c.fetch(:a, "its gone!")
+
+  sleep 1
+  puts c.fetch(:a, "its gone!")
+
+  sleep 1
+  puts c.fetch(:a, "its gone!")
+
+  sleep 1
+  puts c.fetch(:a, "its gone!")
+
+  sleep 1
+  puts c.fetch(:a, "its gone!")
+end
+
+def test2
+  puts "Testing array syntax"
+  c = CacheHash.new(ttl: 3, gc_interval: 1)
+
+  c[:a] = "its here"
+
+  sleep 1
+  puts c[:a] || "its gone!"
+
+  sleep 1
+  puts c[:a] || "its gone!"
+
+  sleep 1
+  puts c[:a] || "its gone!"
+
+  sleep 1
+  puts c[:a] || "its gone!"
+
+  sleep 1
+  puts c[:a] || "its gone!"
+
+  sleep 1
+  puts c[:a] || "its gone!"
+
+  sleep 1
+  puts c[:a] || "its gone!"
+
+
+end
+
+def test3
+  puts "Testing block"
+  c = CacheHash.new(ttl: 3, gc_interval: 1)
+  
+  x = 0
+  10.times do
+    r = c.fetch(:foo) {
+      puts "expired cache"
+      x
+    }
+    x = x + 1
+    puts r
+    sleep 2
+  end
+  
+end
+
+def test4
+  puts "Testing default"
+  c = CacheHash.new(ttl: 2, gc_interval: 1)
+  
+  x = 0
+  c[:foo] = "HAZ VALUE"
+  4.times do
+    r = c.fetch(:foo, "NO VALUE")
+    x = x + 1
+    puts r
+    sleep 1
+  end
+  
+end
+
+test2
+test1
+test3
+test4

data/cache_hash.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache_hash"
+  spec.version       = CacheHash::VERSION
+  spec.authors       = ["Doug Everly"]
+  spec.email         = ["Doug@Everly.org"]
+  spec.summary       = %q{Simple hash with expiring values.}
+  spec.description   = %q{Simple hash with expiring values.
+
+* Simple - Returns value or nil.
+* Default - Returns value or default
+* Block - Returns value, or refreshes the value by yielding to long running job.}
+
+  spec.homepage      = "https://github.com/DougEverly/CacheHash"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/cache_hash.rb

@@ -0,0 +1,85 @@
+require "cache_hash/version"
+
+class CacheHash
+  # CacheHash is a simple hash implementation where the 
+  # value is purged after TTL seconds.
+  
+  attr_reader :ttl, :gc_interval
+  
+  # Creates CacheHash and starts garbage collection
+  # @param [seconds] ttl Number to seconds to retain value
+  # @param [seconds] gc_interval Seconds to wait between GC
+  def initialize(ttl: 60, gc_interval: 10)
+    @data = Hash.new
+    @mutex = Mutex.new
+    @gc_thread = nil
+
+    @ttl  = ttl
+    @gc_interval = gc_interval # seconds
+    start_gc
+  end
+  
+  # Sets a value for a key and returns the value
+  # @param [Object] key
+  # @param [Object] value
+  # @return [Object] value
+  def []=(key, value)
+    @mutex.synchronize {
+      @data[key] = {
+        value: value,
+        expires_at: Time.now.to_i + @ttl
+      }
+    }
+    value
+  end
+  
+  # Gets value for key, or nil if expired
+  # @param [Object] key
+  # @return [Object, nil]
+  def [](key)
+    @mutex.synchronize {
+      if @data.has_key?(key)
+        if Time.now.to_i > @data[key][:expires_at]
+          # @data.delete(key)
+          return nil
+        else
+          return @data[key][:value]
+        end
+      end
+    }
+    return nil
+  end
+  
+  # Gets value for key, or default_value if expired
+  # @param [Object] key
+  # @param [Object] default_value
+  # @param [Block]
+  # @return [Object, nil]
+  def fetch(key, default_value = nil)
+    raise ArgumentError, "Block not given" if (block_given? && default_value)
+    self[key] || default_value || (self[key] = yield) # (*args))
+  end
+    
+  # Kick off garbage collection in a thread
+  def start_gc
+    @gc_thread = Thread.new do
+      loop do
+        sleep @gc_interval
+        gc
+      end
+    end
+  end
+  
+  # Delete keys with expired values
+  def gc
+    now = Time.now.to_i
+    @mutex.synchronize {
+      @data.each_pair do |key, value|
+        if now > @data[key][:expires_at]
+          @data.delete key
+        end
+      end
+    }
+  end
+  
+end

data/lib/cache_hash/version.rb

@@ -0,0 +1,3 @@
+class CacheHash
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: cache_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Doug Everly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  Simple hash with expiring values.
+
+  * Simple - Returns value or nil.
+  * Default - Returns value or default
+  * Block - Returns value, or refreshes the value by yielding to long running job.
+email:
+- Doug@Everly.org
+executables:
+- test.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/test.rb
+- cache_hash.gemspec
+- lib/cache_hash.rb
+- lib/cache_hash/version.rb
+homepage: https://github.com/DougEverly/CacheHash
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Simple hash with expiring values.
+test_files: []