memory_cache 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b852238fe4c99abb21c7d4e17a5d0235610e993
+  data.tar.gz: 19a28888d448eb7e400e25cbfa457467bb60f869
+SHA512:
+  metadata.gz: 37e3c7494952cf0e8a6c317c4bac43ebbbdb757631c49b9597f121056a8d68aa8182d59e7737bee98075492ae7b5a83da68e5271d6a407b67dc4ad1b8c038d25
+  data.tar.gz: aafaf7509991e83c9e4597281570e4fba51d15f4fd4304c14ea5b0bf1fc16b5245f0c0cd4e1b5bec396a2677281233f0e49236e3758d2473c66560679facee39

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in memory_cache.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec'
+  gem 'timecop'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Niels Buus
+
+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,68 @@
+# MemoryCache
+
+Cache the result of a ruby block within the ruby process for a finite period. Useful when you want to cache a few things, but don't want to bother with setting up a separate caching service like memcached.
+
+Example:
+
+    # In an initializer
+    JsonCache = MemoryCache.new(minutes: 5)
+
+    # In your code
+    JsonCache.get(url) do
+      raw_json = open(url).read
+      JSON.parse(raw_json)
+    end
+    
+The block will be invoked the first time, but any subsequent calls to `get`in the next 5 minutes will ignore the block and just return the same value as the first invocation did.
+    
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'memory_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memory_cache
+
+## Usage
+
+Load the gem and create a cache. Specify the cache duration through the initializer. `seconds`, `minutes`, `hours` and `days` are valid options.
+
+    cache = MemoryCache.new(minutes: 2, seconds: 30)
+
+This creates a cache where objects expire after 150 seconds.
+
+If you fail to provide any of the above keys, the initializer will raise an ArgumentError.
+
+Unlike other cache libraries, memory_cache doesn't have a `set` method. Instead the `get` method also acts as a `set` method by passing a block.
+
+    cache.get('the_game')
+    => nil
+    cache.get('the_game') { "you just lost it".upcase }
+    => "YOU JUST LOST IT"
+    cache.get('the_game')
+    => "YOU JUST LOST IT"
+
+    # 2 minutes and 31 seconds later
+    cache.get('the_game')
+    => nil
+
+## Keep in mind
+
+MemoryCache does nothing to clean up the cache. Expired values will remain the internal hash of MemoryCache until they are replaced by new invocation with a block.
+
+If your key set is massive or your block return values are fatty, consider calling `clear` on the cache now and then or go for a more advanced caching solution.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/memory_cache/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/lib/memory_cache.rb

@@ -0,0 +1,45 @@
+# require "memory_cache/version"
+
+class MemoryCache
+  VERSION = "1.0.0"
+
+  attr_accessor :ttl_in_seconds, :cache
+  private :cache
+
+  def initialize(options = {minutes: 5})
+    @cache = {}
+    @ttl_in_seconds = calculate_ttl_in_seconds(options)
+  end
+
+  def get(key, &block)
+    key = key.to_s
+    record = cache[key]
+    if record.nil? || record[:expires] < Time.now.to_i
+      if block_given?
+        cache[key] = {
+            object: block.call,
+            expires: Time.now.to_i + ttl_in_seconds
+        }
+      else
+        return nil
+      end
+    end
+    cache[key][:object]
+  end
+
+  def clear
+    @cache = {}
+  end
+
+  private
+
+  def calculate_ttl_in_seconds(options)
+    seconds = options.fetch(:seconds, 0)
+    seconds += options.fetch(:minutes, 0) * 60
+    seconds += options.fetch(:hours, 0) * 60 * 60
+    seconds += options.fetch(:days, 0) * 60 * 60 * 24
+    fail ArgumentError.new("No duration specifieed for cache") if seconds.zero?
+    seconds
+  end
+
+end

data/lib/memory_cache/version.rb

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

data/memory_cache.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memory_cache'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memory_cache"
+  spec.version       = MemoryCache::VERSION
+  spec.authors       = ["Niels Buus"]
+  spec.email         = ["nielsbuus@gmail.com"]
+  spec.summary       = "Cache the results of expensive code for a fixed time in memory. Handy for slow web services."
+  spec.description   = "Cache the result of a ruby block within the ruby process for a finite period. Useful when you want to cache a few things, but don't want to bother with setting up a separate caching service like memcached."
+  spec.homepage      = "https://github.com/nielsbuus/memory_cache"
+  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"]
+
+end

data/spec/memory_cache_spec.rb

@@ -0,0 +1,81 @@
+require_relative "../lib/memory_cache"
+require "timecop"
+
+describe MemoryCache do
+
+  let(:cache) { MemoryCache.new(minutes: 2) }
+  let(:slow_object) { double("slow").as_null_object }
+
+  it "caches the result of passed block when reading" do
+    expect(slow_object).to receive(:query).exactly(1).times
+
+    3.times do
+      cache.get "slow_key" do
+        slow_object.query
+      end
+    end
+  end
+
+  it "invokes block when cached object has expired" do
+    Timecop.freeze
+
+    expect(slow_object).to receive(:query).exactly(2).times
+
+    cache.get "slow_key" do
+      slow_object.query
+    end
+
+    Timecop.travel(60) do
+      cache.get "slow_key" do
+        slow_object.query # Should use the cache
+      end
+    end
+
+    Timecop.travel(300) do
+      cache.get "slow_key" do
+        slow_object.query # Should bust the cache
+      end
+    end
+
+  end
+
+  it "returns the result of the first block until expiration" do
+    Timecop.freeze
+    result = cache.get("slow_key") { 9000 + 1 }
+    expect(result).to eql 9001
+
+    Timecop.travel(60) do
+      result = cache.get("slow_key") { "ignore me" }
+      expect(result).to eql 9001
+    end
+
+    Timecop.travel(180) do
+      result = cache.get("slow_key") { "try me" }
+      expect(result).to eql "try me"
+    end
+  end
+
+  it "fails if initiates without duration" do
+    expect {
+      MemoryCache.new({})
+    }.to raise_error(ArgumentError)
+  end
+  
+  context "with no block" do
+    
+    context "it reads from the cache even if no block is provided" do
+      
+      it "returns nil when the cache key holds no value" do
+        expect(cache.get("something_slow")).to be_nil
+      end
+      
+      it "returns the value, when the cache key holds a value" do
+        cache.get("something_slow") { "result" }
+        expect(cache.get("something_slow")).to eql "result"        
+      end
+      
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: memory_cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Niels Buus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-12 00:00:00.000000000 Z
+dependencies: []
+description: Cache the result of a ruby block within the ruby process for a finite
+  period. Useful when you want to cache a few things, but don't want to bother with
+  setting up a separate caching service like memcached.
+email:
+- nielsbuus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/memory_cache.rb
+- lib/memory_cache/version.rb
+- memory_cache.gemspec
+- spec/memory_cache_spec.rb
+homepage: https://github.com/nielsbuus/memory_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.2.2
+signing_key: 
+specification_version: 4
+summary: Cache the results of expensive code for a fixed time in memory. Handy for
+  slow web services.
+test_files:
+- spec/memory_cache_spec.rb