methodcache 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Citizen Logistics, Inc.
+
+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.rdoc

@@ -0,0 +1,17 @@
+= methodcache
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Citizen Logistics, Inc.. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "methodcache"
+    gem.summary = %Q{like memoizable etc but more production oriented}
+    gem.description = %Q{like memoizable etc but more production oriented}
+    gem.email = "joe@citizenlogistics.com"
+    gem.homepage = "http://github.com/citizenlogistics/methodcache"
+    gem.authors = ["Joe Edelman"]
+    gem.add_development_dependency "minitest"
+    gem.add_development_dependency "yard"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/methodcache/everywhere.rb

@@ -0,0 +1,3 @@
+class Module
+  include MethodCache::ModuleExtensions
+end

data/lib/methodcache.rb

@@ -0,0 +1,77 @@
+require 'benchmark'
+
+class MethodCache
+  def initialize obj, name, type, options
+    @name        = name
+    @type        = type
+    @timestamps  = {}
+    @values      = {}
+    @last_clean  = Time.now
+    @clean_every = options[:clean_every] || 10*60
+    @duration    = options[:for] || 60
+    @warn_time   = options[:warn_time] || 0.03
+    @umeth       = obj.instance_method(name)
+  end
+
+  def timebox title, max_t = 0.01
+    result = nil
+    t = Benchmark.realtime{ result = yield }
+    warn "#{title}: #{(time*1000).to_i}ms" unless t < max_t
+    result
+  end
+
+  def to_proc
+    cache = self
+    proc{ |*params| cache.try(self, *params) }
+  end
+
+  def compute?(key, obj, *params)
+    ts = @timestamps[key]
+    return unless !ts or ts <= Time.now - @duration
+    timebox "#{@name}(#{key}) was not cached #{ts} < #{Time.now - @duration}", @warn_time do
+      @values[key] = @umeth.bind(obj).call(*params)
+      @timestamps[key] = Time.now
+    end
+    true
+  end
+
+  def clean?
+    expiry = Time.now - @duration
+    return unless @last_clean < Time.now - @clean_every
+    @timestamps.keys.each do |key|
+      next unless @timestamps[key] < expiry
+      @timestamps.delete(key)
+      @values.delete(key)
+    end
+    @last_clean = Time.now
+  end
+
+  def try(obj, *params)
+    key = (@type == :instance ? params + [obj.id] : params).hash
+    compute?(key, obj, *params) and clean?
+    @values[key]
+  end
+
+  module ModuleExtensions
+    def instance_cache name, options = {}
+      define_method(name, &MethodCache.new(self, name, :instance, options))
+    end
+
+    def singleton_cache name, options = {}
+      define_method(name, &MethodCache.new(self, name, :singleton, options))
+    end
+
+    def class_cache name, options = {}
+      metaclass = (class<<self;self;end)
+      cache = MethodCache.new(metaclass, name, :singleton, options)
+      metaclass.send(:define_method, name, &cache)
+    end
+
+    def module_cache name, options = {}
+      class_cache name, options
+      singleton_cache name, options
+    end
+
+    alias_method :cache, :singleton_cache
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'minitest/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'methodcache'
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest::Unit.autorun

data/test/test_methodcache.rb

@@ -0,0 +1,18 @@
+require 'helper'
+require 'methodcache/everywhere'
+
+class TestMethodcache < MiniTest::Unit::TestCase
+  A = [0]
+
+  def run_once
+    A[0] += 1
+  end
+
+  singleton_cache :run_once
+
+  def test_it
+    run_once
+    run_once
+    assert_equal 1, A[0]
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: methodcache
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Joe Edelman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: like memoizable etc but more production oriented
+email: joe@citizenlogistics.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/methodcache.rb
+- lib/methodcache/everywhere.rb
+- test/helper.rb
+- test/test_methodcache.rb
+has_rdoc: true
+homepage: http://github.com/citizenlogistics/methodcache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: like memoizable etc but more production oriented
+test_files: 
+- test/helper.rb
+- test/test_methodcache.rb