method_cacheable 0.0.1

data/method_cacheable.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "method_cacheable"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Schneems"]
+  s.date = "2011-12-12"
+  s.description = "\n    Cache methods quickly and easily\n  "
+  s.email = "richard.schneeman@gmail.com"
+  s.files = [
+    ".rvmrc",
+    ".yardoc/checksums",
+    ".yardoc/objects/root.dat",
+    ".yardoc/proxy_types",
+    "Gemfile",
+    "Rakefile",
+    "VERSION",
+    "autotest/discover.rb",
+    "doc/JohnnyCache.html",
+    "doc/JohnnyCache/ClassMethods.html",
+    "doc/JohnnyCache/MethodCache.html",
+    "doc/_index.html",
+    "doc/class_list.html",
+    "doc/css/common.css",
+    "doc/css/full_list.css",
+    "doc/css/style.css",
+    "doc/file_list.html",
+    "doc/frames.html",
+    "doc/index.html",
+    "doc/js/app.js",
+    "doc/js/full_list.js",
+    "doc/js/jquery.js",
+    "doc/method_list.html",
+    "doc/top-level-namespace.html",
+    "johnny_cache.gemspec",
+    "lib/method_cachable.rb",
+    "license.txt",
+    "method_cacheable.gemspec",
+    "pkg/johnny_cache-0.0.1.gem",
+    "readme.md",
+    "spec/method_cachable/method_cache_spec.rb",
+    "spec/method_cachable_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/Schnems/method_cacheable"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Cache methods quickly and easily."
+  s.test_files = [
+    "spec/method_cachable/method_cache_spec.rb",
+    "spec/method_cachable_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<keytar>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<rdiscount>, [">= 0"])
+      s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<autotest-standalone>, [">= 0"])
+      s.add_development_dependency(%q<autotest-growl>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<keytar>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rdiscount>, [">= 0"])
+      s.add_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<autotest-standalone>, [">= 0"])
+      s.add_dependency(%q<autotest-growl>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<keytar>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rdiscount>, [">= 0"])
+    s.add_dependency(%q<rake>, ["~> 0.8.7"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<autotest-standalone>, [">= 0"])
+    s.add_dependency(%q<autotest-growl>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/readme.md

@@ -0,0 +1,108 @@
+The Cache in Black
+==================
+Cache method calls and speed up your Ruby on Rails application with MethodCachable.
+
+Method Cacheable
+============
+
+``` ruby
+  class User < ActiveRecord::Base
+    include MethodCachable
+
+    has_many :pictures
+
+    def expensive_method(val)
+      sleep 120
+      return val
+    end
+  end
+
+  user = User.last
+
+  # Call User#expensive_method normally
+  user.expensive_method(22)
+  # => 22
+
+  # Fetch User#expensive_method from cache
+  user.cache.expensive_method(22)
+  # => 22
+
+  # Call User#expensive_method normally
+  Benchmark.measure { user.expensive_method(22) }.real
+  # => 120.00037693977356
+
+  # Fetch User#expensive_method from cache
+  Benchmark.measure { user.cache.expensive_method(22) }.real
+  # => 0.000840902328491211
+
+  # SOOOOOOOO FAST!!
+```
+
+
+Install
+=======
+in your Gemfile
+
+    gem 'method_cachable'
+
+then in your models
+
+    include MethodCachable
+
+
+Usage
+========
+
+Explicitly write & read methods.
+
+``` ruby
+  user.cache(:read).pictures  # => nil
+  user.cache(:write).pictures # => [<# Picture ...>, <# Picture ...>] # refreshes the cache
+  user.cache(:read).pictures  # => [<# Picture ...>, <# Picture ...>]
+```
+
+By default the `cache` method will will `:fetch` from the cache store. This means that if the key exists it will be pulled, if not the method will be called, returned, and the key will be set.
+
+``` ruby
+  user.cache(:read).expensive_method("w00t") # => nil
+  user.cache.expensive_method("w00t")        # => "w00t" # sets the cache via :fetch
+  user.cache.expensive_method("w00t")        # => "w00t" # pulls from the cache
+```
+
+You can also call `:fetch` explicitly if you prefer (but why, thats more typing)
+
+``` ruby
+  user.cache(:fetch).expensive_method("w00t")  # => "w00t" # pulls from the cache
+```
+
+Different method arguments to the method generate different cache objects. I.E. different input => different output, same input => same output
+
+``` ruby
+  user.cache.expensive_method(:schneems => :is_awesome).inspect
+  # => {:schneems => :is_awesome}
+  user.cache.expensive_method("j/k lol").inspect
+  # => "j/k lol"
+```
+
+Configuration
+=============
+
+Any configuration options passed to the cache method will be passed to the cache store (default is [Rails.cache](http://api.rubyonrails.org/classes/ActionController/Caching.html#method-i-cache Rails.cache))
+
+``` ruby
+  user.cache(:write, :expires_in => 5.seconds).pictures # => [<# Picture ...>, #... ]
+  user.cache(:read).pictures                            # => [<# Picture ...>, #... ]
+  sleep 10                                              # => 2
+  user.cache(:read).pictures                            # => nil
+```
+
+
+Contribution
+============
+
+Fork away. If you want to chat about a feature idea, or a question you can find me on the twitters [@schneems](http://twitter.com/schneems).  Put any major changes into feature branches. Make sure all tests stay green, and make sure your changes are covered.
+
+
+licensed under MIT License
+Copyright (c) 2011 Schneems. See LICENSE.txt for
+further details.

data/spec/method_cachable/method_cache_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+
+describe MethodCachable::MethodCache do
+  before(:all) do
+    @user = User.new
+  end
+
+  before(:each) do
+    @uniq ||= 0
+    @uniq += 1
+  end
+
+  describe 'initialize' do
+    it 'saves caller' do
+      @user.cache.caller_object.should eq(@user)
+    end
+
+    it 'saves cache_method' do
+      cache_method = :fetch
+      @user.cache(cache_method).cache_operation.should eq(cache_method)
+    end
+
+    it 'saves options' do
+      options = {:foo => "bar"}
+      @user.cache(options).options.should eq(options)
+    end
+
+    it 'saves options and cache_method' do
+      cache_method = :write
+      options = {:foo => "bar"}
+      cache = @user.cache(cache_method, options)
+      cache.options.should      eq(options)
+      cache.cache_operation.should eq(cache_method)
+    end
+  end
+end

data/spec/method_cachable_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+
+describe MethodCachable do
+  before(:each) do
+    @user = User.new
+    @uniq ||= 0
+    @uniq += 1
+  end
+
+  describe '' do
+    describe 'calling a cached method' do
+      describe 'fetch' do
+        it 'should return the result of the normal method' do
+          @user.cache.foo(@uniq).should == @user.foo(@uniq)
+        end
+
+        it 'should bypass the normal method if the cache is written' do
+          @user.cache(:write).foo(@uniq)
+          @user.should_not_receive(:foo)
+          @user.cache(:fetch).foo(@uniq)
+        end
+
+        it 'should bypass the normal method if the cache has been fetched before' do
+          @user.cache(:fetch).foo(@uniq)
+          @user.should_not_receive(:foo)
+          @user.cache(:fetch).foo(@uniq)
+        end
+
+        it 'should call the normal method if the cache has been not fetched before' do
+          @user.should_receive(:foo)
+          @user.cache(:fetch).foo(@uniq)
+        end
+
+        it 'should call the normal method if the cache has been not fetched before' do
+          @user.should_receive(:foo)
+          @user.cache.foo(@uniq)
+        end
+
+      end
+
+      describe 'read' do
+        it 'read should return nil if cache has not been set yet' do
+          @user.cache(:read).foo(@uniq).should eq(nil)
+        end
+
+        it 'read should return value if cache has been set' do
+          result = @user.cache.foo(@uniq)
+          @user.cache(:read).foo(@uniq).should eq(result)
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../..', 'lib'))
+
+## Fake rails for testing Rails.cache
+class Rails
+  def self.cache
+    self
+  end
+
+  def self.fetch(key, options, &block)
+    eval("@#{key.gsub(':', '_')} ||= block.call")
+  end
+
+  def self.write(key, val, options, &block)
+    eval("@#{key.gsub(':', '_')} = val")
+  end
+
+  def self.read(key, options)
+    eval("@#{key.gsub(':', '_')}")
+  end
+end
+
+
+require 'method_cachable'
+class User
+  include MethodCachable
+  define_keys :foo
+
+  def foo(var=nil)
+    "bar#{var}"
+  end
+
+  def id
+   @id ||= rand(100)
+  end
+end
+
+
+require 'rspec'
+require 'rspec/autorun'
+

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification 
+name: method_cacheable
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Schneems
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activesupport
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: keytar
+  prerelease: false
+  type: :runtime
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: yard
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rdiscount
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  name: rake
+  prerelease: false
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  prerelease: false
+  type: :development
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: autotest-standalone
+  prerelease: false
+  type: :development
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: autotest-growl
+  prerelease: false
+  type: :development
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  prerelease: false
+  type: :development
+  requirement: *id009
+description: "\n    Cache methods quickly and easily\n  "
+email: richard.schneeman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .rvmrc
+- .yardoc/checksums
+- .yardoc/objects/root.dat
+- .yardoc/proxy_types
+- Gemfile
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- doc/JohnnyCache.html
+- doc/JohnnyCache/ClassMethods.html
+- doc/JohnnyCache/MethodCache.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- johnny_cache.gemspec
+- lib/method_cachable.rb
+- license.txt
+- method_cacheable.gemspec
+- pkg/johnny_cache-0.0.1.gem
+- readme.md
+- spec/method_cachable/method_cache_spec.rb
+- spec/method_cachable_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Schnems/method_cacheable
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Cache methods quickly and easily.
+test_files: 
+- spec/method_cachable/method_cache_spec.rb
+- spec/method_cachable_spec.rb
+- spec/spec_helper.rb