caching 0.0.1

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: QuozNf6fqDc11Mubic8FmNgsDQ0y8Hyjg

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0
+  - jruby

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in caching.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gabriel Naiman
+
+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,51 @@
+# Caching
+
+[![Gem Version](https://badge.fury.io/rb/caching.png)](https://rubygems.org/gems/caching)
+[![Build Status](https://travis-ci.org/gabynaiman/caching.png?branch=master)](https://travis-ci.org/gabynaiman/caching)
+[![Coverage Status](https://coveralls.io/repos/gabynaiman/caching/badge.png?branch=master)](https://coveralls.io/r/gabynaiman/caching?branch=master)
+[![Code Climate](https://codeclimate.com/github/gabynaiman/caching.png)](https://codeclimate.com/github/gabynaiman/caching)
+[![Dependency Status](https://gemnasium.com/gabynaiman/caching.png)](https://gemnasium.com/gabynaiman/caching)
+
+Cache methods
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'caching'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install caching
+
+## Usage
+
+    class Model
+      extend Caching
+      
+      cache :slow_method, :other_slow_method
+
+      def slow_method
+        ...
+      end
+
+      def other_slow_method
+        ...
+      end
+
+      def fast_method
+        ...
+      end
+    end
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task default: :spec

data/caching.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caching/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "caching"
+  spec.version       = Caching::VERSION
+  spec.authors       = ["Gabriel Naiman"]
+  spec.email         = ["gnaiman@keepcon.com"]
+  spec.description   = 'Cache methods'
+  spec.summary       = 'Cache methods'
+  spec.homepage      = "https://github.com/gabynaiman/caching"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 4.7"
+  spec.add_development_dependency "turn", "~> 0.9"
+  spec.add_development_dependency "simplecov"
+end

data/lib/caching/proxy.rb

@@ -0,0 +1,25 @@
+module Caching
+  class Proxy
+  
+    instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$)/ }
+
+    def initialize(target, *methods)
+      @target = target
+      @methods = methods.map(&:to_sym)
+      @storage = Storage.new
+    end
+
+    def method_missing(method, *args, &block)
+      if @methods.include? method.to_sym
+        @storage.fetch(method) { @target.send(method, *args, &block) }
+      else
+        @target.send(method, *args, &block)
+      end
+    end
+
+    def clear_cache(*methods)
+      @storage.clear *methods
+    end
+
+  end
+end

data/lib/caching/storage.rb

@@ -0,0 +1,29 @@
+module Caching
+  class Storage
+    
+    def initialize
+      @storage = {}
+    end
+
+    def read(key)
+      @storage[key]
+    end
+
+    def write(key, value)
+      @storage[key] = value
+    end
+
+    def fetch(key)
+      read(key) || write(key, yield)
+    end
+
+    def clear(*keys)
+      if keys.empty?
+        @storage = {}
+      else
+        keys.each { |k| @storage.delete k }
+      end
+    end
+
+  end
+end

data/lib/caching/version.rb

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

data/lib/caching.rb

@@ -0,0 +1,17 @@
+Dir["#{File.dirname(__FILE__)}/caching/*.rb"].each { |file| require file }
+
+module Caching
+
+  def self.extended(klass)
+    constructor = klass.method :new
+
+    klass.define_singleton_method :new do |*args, &block|
+      Proxy.new constructor.call(*args, &block), *@cached_methods
+    end
+  end
+
+  def cache(*methods)
+    @cached_methods = (@cached_methods ||= []) | methods.map(&:to_sym).uniq
+  end
+
+end

data/spec/caching_spec.rb

@@ -0,0 +1,61 @@
+require 'minitest_helper'
+
+describe Caching do
+  
+  class Cachable
+    extend Caching
+    cache :slow_method, :other_slow_method
+
+    def initialize
+      @slow_method = 0
+      @other_slow_method = 0
+      @fast_method = 0
+    end
+
+    def slow_method
+      @slow_method += 1
+    end
+
+    def other_slow_method
+      @other_slow_method += 1
+    end
+
+    def fast_method
+      @fast_method += 1
+    end
+  end
+
+  it 'Cache methods' do
+    object = Cachable.new
+
+    3.times { object.slow_method.must_equal 1 }
+    3.times { object.other_slow_method.must_equal 1 }
+    object.fast_method.must_equal 1
+    object.fast_method.must_equal 2
+  end
+
+  it 'Clear cache for all methods' do
+    object = Cachable.new
+
+    3.times { object.slow_method.must_equal 1 }
+    3.times { object.other_slow_method.must_equal 1 }
+
+    object.clear_cache
+
+    object.slow_method.must_equal 2
+    object.other_slow_method.must_equal 2
+  end
+
+  it 'Clear cache for specific method' do
+    object = Cachable.new
+
+    3.times { object.slow_method.must_equal 1 }
+    3.times { object.other_slow_method.must_equal 1 }
+
+    object.clear_cache :slow_method
+
+    object.slow_method.must_equal 2
+    object.other_slow_method.must_equal 1
+  end
+
+end

data/spec/coverage_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start

data/spec/minitest_helper.rb

@@ -0,0 +1,9 @@
+require 'coverage_helper'
+require 'minitest/autorun'
+require 'turn'
+require 'caching'
+
+Turn.config do |c|
+  c.format = :pretty
+  c.natural = true
+end

data/spec/proxy_spec.rb

@@ -0,0 +1,59 @@
+require 'minitest_helper'
+
+describe Caching::Proxy do
+  
+  class Fake
+    attr_reader :x, :y
+
+    def initialize
+      @x = 0
+      @y = 0
+    end
+
+    def next_x
+      @x += 1
+    end
+
+    def next_y
+      @y += 1
+    end
+  end
+
+  it 'Cache specific method' do
+    object = Fake.new
+    proxy = Caching::Proxy.new object, :next_x
+
+    proxy.next_x.must_equal 1
+    proxy.next_x.must_equal 1
+
+    proxy.next_y.must_equal 1
+    proxy.next_y.must_equal 2
+  end
+
+  it 'Clear cache for all methods' do
+    object = Fake.new
+    proxy = Caching::Proxy.new object, :next_x, :next_y
+
+    3.times{ proxy.next_x.must_equal 1 }
+    3.times{ proxy.next_y.must_equal 1 }
+    
+    proxy.clear_cache
+
+    proxy.next_x.must_equal 2
+    proxy.next_y.must_equal 2
+  end
+
+  it 'Clear cache for specific method' do
+    object = Fake.new
+    proxy = Caching::Proxy.new object, :next_x, :next_y
+
+    3.times{ proxy.next_x.must_equal 1 }
+    3.times{ proxy.next_y.must_equal 1 }
+    
+    proxy.clear_cache :next_x
+
+    proxy.next_x.must_equal 2
+    proxy.next_y.must_equal 1
+  end
+
+end

data/spec/storage_spec.rb

@@ -0,0 +1,47 @@
+require 'minitest_helper'
+
+describe Caching::Storage do
+
+  it 'Write and Read' do
+    storage = Caching::Storage.new
+    storage.write :key_1, 'value_1'
+    storage.write :key_2, 'value_2'
+
+    storage.read(:key_1).must_equal 'value_1'
+    storage.read(:key_2).must_equal 'value_2'
+  end
+
+  it 'Fetch' do
+    storage = Caching::Storage.new
+    number = 0
+
+    storage.fetch(:key) { number += 1 }.must_equal 1
+    storage.fetch(:key) { number += 1 }.must_equal 1
+    number.must_equal 1
+  end
+
+  it 'Clear all' do
+    storage = Caching::Storage.new
+    storage.write :key_1, 'value_1'
+    storage.write :key_2, 'value_2'
+    
+    storage.clear
+
+    storage.read(:key_1).must_be_nil
+    storage.read(:key_2).must_be_nil
+  end
+
+  it 'Clear specific keys' do
+    storage = Caching::Storage.new
+    storage.write :key_1, 'value_1'
+    storage.write :key_2, 'value_2'
+    storage.write :key_3, 'value_3'
+    
+    storage.clear :key_1, :key_3
+
+    storage.read(:key_1).must_be_nil
+    storage.read(:key_2).must_equal 'value_2'
+    storage.read(:key_3).must_be_nil
+  end
+
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: caching
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gabriel Naiman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cache methods
+email:
+- gnaiman@keepcon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- caching.gemspec
+- lib/caching.rb
+- lib/caching/proxy.rb
+- lib/caching/storage.rb
+- lib/caching/version.rb
+- spec/caching_spec.rb
+- spec/coverage_helper.rb
+- spec/minitest_helper.rb
+- spec/proxy_spec.rb
+- spec/storage_spec.rb
+homepage: https://github.com/gabynaiman/caching
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+summary: Cache methods
+test_files:
+- spec/caching_spec.rb
+- spec/coverage_helper.rb
+- spec/minitest_helper.rb
+- spec/proxy_spec.rb
+- spec/storage_spec.rb
+has_rdoc: