cacheify 0.1.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Saša_Branković
+
+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,67 @@
+= Cacheify
+
+Simple caching of methods calls.
+
+Cacheify uses ActiveSupport::Cache::Store to perform caching so, depending on
+what you choose, it may cache to memory, disk, memcache or
+whatever is supported by the cache store.
+
+== Installation
+
+  sudo gem install cacheify
+
+== Usage
+
+Mixin the Cacheify module, use the +cacheify+ method.
+  
+  require 'cacheify'
+  
+  class Foo
+    include Cacheify
+    cacheify :bar, :expires_in => 1.hour
+    
+    def bar
+    end
+  end
+
+And you're +foo+ instance calls to +bar+ will get cached.
+
+  Foo.new.bar # will hit cache if cached, or get cached otherwise
+
+To enable cacheify on existing class just +extend+:
+
+  Thing.extend Cacheify
+  Thing.caches :very_expensive_operation
+
+If you use Cacheify <b>a lot</b>, you may even do:
+
+  Object.extend Cacheify
+
+But that's just evil.
+
+=== Choosing your Cache store
+
+To setup what cache store Cacheify is using:
+
+  Cacheify.cache_store = :file_store, "tmp/cacheify"
+
+The arguments are the same as in ActiveSupport::Cache#lookup_store[http://api.rubyonrails.org/classes/ActiveSupport/Cache.html#M001011]
+
+== More info
+
+* ActiveSupport::Cache[http://api.rubyonrails.org/classes/ActiveSupport/Cache.html] is what's used for caching
+* Why cacheify? {Introductory blog post}[http://blog.hakeraj.com].
+
+== 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 Sasa Brankovic. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cacheify"
+    gem.summary = %Q{Simple caching of method calls}
+    gem.description = %Q{Cacheify can cache method calls to memory, disk, memcache or whatever is supported by the ActiveSupport::Cache::Store.}
+    gem.email = "sasa@hakeraj.com"
+    gem.homepage = "http://github.com/fox/cacheify"
+    gem.authors = ["Saša_Branković"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "activesupport"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cacheify #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/cacheify.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cacheify}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sa\305\241a_Brankovi\304\207"]
+  s.date = %q{2010-03-12}
+  s.description = %q{Cacheify can cache method calls to memory, disk, memcache or whatever is supported by the ActiveSupport::Cache::Store.}
+  s.email = %q{sasa@hakeraj.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cacheify.gemspec",
+     "lib/cacheify.rb",
+     "spec/cacheify_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/fox/cacheify}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple caching of method calls}
+  s.test_files = [
+    "spec/cacheify_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

data/lib/cacheify.rb

@@ -0,0 +1,49 @@
+require 'active_support'
+require 'digest/md5'
+
+##
+# Enables caching of method calls
+module Cacheify
+  ##
+  # Set cache store to be used by Cachify (or leave it be to use defaults).
+  # 
+  # The default is FileStore tmp/cacheify or, if you're running 
+  # inside Rails app, whatever Rails is using.
+  #
+  # === Parameters
+  # store options as understood by ActiveSupport::Cache#lookup_store
+  def self.cache_store=(store_option)
+    @cache_store = ActiveSupport::Cache.lookup_store(store_option)
+  end
+
+  def self.cache # :nodoc: 
+    @cache_store ||= defined?(Rails) ? Rails.cache : ActiveSupport::Cache.lookup_store(:file_store, "tmp/cacheify")
+  end
+
+  ##
+  # Cache results of methods.
+  #
+  # === Parameters
+  # * method names to cache
+  # * optionally, last argument can be a hash of options passed to ActiveSupport::Cache::Store for caching. 
+  #
+  # === Example
+  # cache_method :big_calculation, :expires_in => 5.minutes
+  def cacheify(*symbols)
+    options = symbols.extract_options!
+
+    symbols.each do |method|
+      non_cached_method = "_non_cached_#{method}".to_sym 
+      return if respond_to? non_cached_method # cached already, skip it
+      
+      alias_method non_cached_method, method
+      
+      define_method(method) do |*args, &block|
+        cache_name = Digest::MD5.hexdigest(args.inspect)
+        marshalled_result = Cacheify.cache.fetch(cache_name, options) do 
+          send(non_cached_method, *args, &block)
+        end
+      end
+    end
+  end
+end

data/spec/cacheify_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# Example class we'll use in specs
+class Foo 
+  def bar(something = nil)
+    "#{rand(99999999)}#{something}"
+  end
+end
+
+describe "Cacheify" do
+  before :all do
+    Foo.extend Cacheify
+    Foo.cacheify :bar
+    
+    @foo = Foo.new
+    @first_call = @foo.bar("hello")
+  end
+
+  context "calling method twice on a cachified object" do
+    before do
+      @second_call = @foo.bar("hello")
+    end
+    
+    it "should return cached result second time" do
+      @first_call.should == @second_call
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cacheify'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: cacheify
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Sa\xC5\xA1a_Brankovi\xC4\x87"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Cacheify can cache method calls to memory, disk, memcache or whatever is supported by the ActiveSupport::Cache::Store.
+email: sasa@hakeraj.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cacheify.gemspec
+- lib/cacheify.rb
+- spec/cacheify_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/fox/cacheify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple caching of method calls
+test_files: 
+- spec/cacheify_spec.rb
+- spec/spec_helper.rb