memmo 0.0.1

data/README.md

@@ -0,0 +1,44 @@
+Memmo
+=====
+
+[![Build Status](https://secure.travis-ci.org/educabilia/memmo.png?branch=master)](https://travis-ci.org/educabilia/memmo)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/educabilia/memmo)
+
+Memmo is a small library for creating key-based, in-memory caches in Ruby.
+
+It features thread safety and TTLs.
+
+Usage
+-----
+
+```ruby
+
+require "memmo"
+
+$memmo = Memmo.new
+
+$memmo.register(:popular_posts, ttl: 60) do
+  # Somewhat expensive query
+  Post.find(...)
+end
+
+# This call will trigger a miss and will run our expensive query.
+$memmo[:popular_posts].each do |post|
+  puts(post)
+end
+
+# This call will be fast for the next 60 seconds.
+$memmo[:popular_posts]
+```
+
+Test environments
+-----------------
+
+It's common to avoid caches when testing your application. For this
+purpose you can disable Memmo entirely:
+
+```ruby
+require "test/unit"
+
+Memmo.enabled = false
+```

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/memmo/version.rb

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

data/lib/memmo.rb

@@ -0,0 +1,50 @@
+class Memmo
+  def self.enabled
+    @enabled
+  end
+
+  def self.enabled=(value)
+    @enabled = value
+  end
+
+  def initialize
+    @mutex = Mutex.new
+    @loaders = {}
+    @cache = {}
+  end
+
+  def register(name, options = {}, &block)
+    @mutex.synchronize do
+      @loaders[name] = [options, block]
+      refresh(name)
+    end
+  end
+
+  def get(name)
+    return refresh(name)[1] unless Memmo.enabled
+
+    if !@cache.include?(name) || (@loaders[name][0][:ttl] && Time.now - @cache[name][0] > @loaders[name][0][:ttl])
+      @mutex.synchronize do
+        refresh(name)
+      end
+    end
+
+    @cache[name][1]
+  end
+
+  def clear
+    @cache.clear
+  end
+
+  def [](name)
+    get(name)
+  end
+
+  self.enabled = true
+
+protected
+
+  def refresh(name)
+    @cache[name] = [Time.now, @loaders[name][1].call]
+  end
+end

data/memmo.gemspec

@@ -0,0 +1,13 @@
+require File.expand_path("lib/memmo/version", File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name              = "memmo"
+  s.version           = Memmo::VERSION
+  s.summary           = "In-memory, thread-safe caches supporting time-to-live."
+  s.authors           = ["Educabilia", "Damian Janowski"]
+  s.email             = ["opensource@educabilia.com", "djanowski@dimaion.com"]
+  s.homepage          = "https://github.com/educabilia/memmo"
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {test}/*`.split("\n")
+end

data/rakefile

@@ -0,0 +1,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.warning = true
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/test/memmo_test.rb

@@ -0,0 +1,68 @@
+require "test/unit"
+
+require_relative "../lib/memmo"
+
+class MemmoTest < Test::Unit::TestCase
+  def setup
+    @memmo = Memmo.new
+  end
+
+  def test_miss
+    @memmo.register(:numbers) { [1, 2, 3] }
+
+    assert_equal [1, 2, 3], @memmo.get(:numbers)
+  end
+
+  def test_cache
+    calls = 0
+
+    @memmo.register(:numbers) do
+      calls += 1
+
+      [1, 2, 3]
+    end
+
+    assert_equal [1, 2, 3], @memmo.get(:numbers)
+    assert_equal [1, 2, 3], @memmo.get(:numbers)
+    assert_equal 1, calls
+
+    assert_equal [1, 2, 3], @memmo[:numbers]
+  end
+
+  def test_cache_ttl
+    calls = 0
+
+    @memmo.register(:numbers, ttl: 0.1) do
+      calls += 1
+
+      [1, 2, 3]
+    end
+
+    assert_equal [1, 2, 3], @memmo.get(:numbers)
+    assert_equal [1, 2, 3], @memmo.get(:numbers)
+    assert_equal 1, calls
+
+    sleep 0.2
+
+    assert_equal [1, 2, 3], @memmo.get(:numbers)
+    assert_equal 2, calls
+  end
+
+  def test_can_be_disabled
+    Memmo.enabled = false
+
+    calls = 0
+
+    @memmo.register(:numbers, ttl: 10) do
+      calls += 1
+    end
+
+    @memmo.get(:numbers)
+
+    assert_equal 2, calls
+  end
+
+  def teardown
+    Memmo.enabled = true
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: memmo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Educabilia
+- Damian Janowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-09 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- opensource@educabilia.com
+- djanowski@dimaion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- UNLICENSE
+- lib/memmo.rb
+- lib/memmo/version.rb
+- memmo.gemspec
+- rakefile
+- test/memmo_test.rb
+homepage: https://github.com/educabilia/memmo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: In-memory, thread-safe caches supporting time-to-live.
+test_files: []