covercache 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzNkNTE2ZGNhMWY5NGZmYWMyZDY1NTE5NzhmYWQwZjlmZjEyMWVkOA==
+  data.tar.gz: !binary |-
+    ZWFlOWM5M2ZiZGFmZjE0NzAxNDVlYjVkMzU2YWM0ZGE2ODQ5ZDY4Mw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDJhMjcxZGQzZWYwMTAxNWMxNTQxMDdhNTM3ZGMxNmU4MDgzYmYwYzJjN2Vm
+    YWJkNjE5N2JjNGRkMmYxODczYmI0MDZmODlhNzJiZTQ4ZDg4YjU1M2NhMjUz
+    ZDk5ODdmODk5MjVkNTUyODE5YTc1ZDhlYmI3OWZlMDhiZjI0MjY=
+  data.tar.gz: !binary |-
+    NmQ4MmJiNjIyNzM5ZjgwMGUwNWJiNzkyOTljMDEzYWVhMmE3MzMxNzI3ZmIz
+    NzdkYjFlNzNlYWRjNGI1MGJhZTY1YzJjN2Q1OWE4MmZjZWMwMjk2ZDkyM2Iw
+    ZjI1NGM4NmQ1NDcxNGMyNjQ3ODhlMzYwNTBlNWYyYjg3MzcwYmM=

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in covercache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tõnis Simo
+
+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,55 @@
+# Covercache
+
+Covercache based on PackRat
+
+Covercache is a simple helper for Rails.cache<br />
+When included in your class it makes caching trivial.
+
+Add following line to your model which you want to cache
+
+    class Post < ActiveRecord::Base
+      covers_with_cache
+    
+Now you can wrap methods with Covercash (like PackRat). For example:
+
+      has_many :comments
+      scope :published, where(published: true)
+      
+      def cached_comments
+        covercache do
+          comments.all
+        end
+      end
+      
+      def self.cached_published
+        covercache do
+          published.all
+        end
+      end
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'covercache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install covercache
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,18 @@
+require "bundler/gem_tasks"
+
+# require 'rake/testtask'
+# Rake::TestTask.new(:test) do |test|
+#   test.libs << 'lib' << 'spec'
+#   test.pattern = 'spec/**/*_spec.rb'
+#   test.verbose = true
+# end
+# 
+# require 'rdoc/task'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "covercashe #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/covercache.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'covercache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "covercache"
+  spec.version       = Covercache::VERSION
+  spec.authors       = ["Tõnis Simo", "Brian Goff"]
+  spec.email         = ["anton.estum@gmail.com"]
+  spec.description   = %q{Helper method to simplify Rails caching, based on PackRat}
+  spec.summary       = %q{Rails cache helper based on PackRat gem}
+  spec.homepage      = "http://github.com/tonissimo/covercache"
+  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 "rails", "~> 3.2"
+  spec.add_development_dependency "rdoc"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  
+  spec.add_dependency "activesupport", "~> 3.0"
+  spec.add_dependency "activerecord", "~> 3.0"
+end

data/lib/covercache/model/cacher.rb

@@ -0,0 +1,43 @@
+module Covercache
+  module Model
+    module Cacher
+      private
+      def covercache(*args, &block)        
+        options = args.extract_options!
+        key     = []
+        should_debug = options[:debug].present? and options[:debug]
+
+        klass = covercaching_class_method? ? self : self.class
+
+        filtered_options = options.except(:debug, :overwrite_key)     # Remove PackRat related options so we can pass to Rails.cache
+        
+        unless options[:overwrite_key] # if overwrite_key was set, we skip creating our own key
+          model_digest   = covercaching_get_model_digest
+          calling_method = caller[0][/`([^']*)'/, 1] # Hack to get the method that called cache
+
+          key << klass.name
+          key << [model_digest, calling_method].compact.join('/')
+          key << cache_key if self.respond_to?(:cache_key)
+          key += args
+        end
+        
+        puts key.inspect if should_debug                              # Output the generated cache key to the console if debug is set
+        
+        # Make the actual Rails.cache call
+        Rails.cache.fetch key, filtered_options do
+          klass.covercache_keys << key unless key.in?(klass.covercache_keys)
+          block.call
+        end
+      end
+      
+      private
+      def covercaching_get_model_digest
+        self.covercache_model_digest.presence
+      end
+      
+      def covercaching_class_method?
+        self.is_a? Class
+      end
+    end
+  end
+end

data/lib/covercache/model.rb

@@ -0,0 +1,40 @@
+require 'active_support/concern' 
+require 'covercache/model/cacher'
+
+module Covercache
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      extend  Cacher          # Include and Extend so cache method is available in all contexts
+      include Cacher
+    end
+
+    module ClassMethods
+      def generate_model_digest
+        return unless covercache_model_source?
+        file = File.read self.covercache_model_source
+        Digest::MD5.hexdigest(file)
+      rescue
+        nil
+      end
+    
+      # Generates and sets file_digest attribute
+      def generate_model_digest!
+        self.covercache_model_digest = self.generate_model_digest
+      end
+      
+      def covercache_flush!
+        self.covercache_keys.each do |key|
+          Rails.cache.delete(key) # if Rails.cache.exist?(key)
+        end.clear
+        self.covercache_keys.empty?
+      end
+    end
+    
+    # flush cache on after_commit callback
+    def covercache_flush_cache!
+      self.class.send :covercache_flush!
+    end
+  end
+end

data/lib/covercache/version.rb

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

data/lib/covercache.rb

@@ -0,0 +1,44 @@
+require "where"
+require 'active_record'
+require 'active_support/core_ext'
+require "covercache/version"
+require "covercache/model"
+
+module Covercache
+  module CoversWithCache
+    def covers_with_cache
+      class_eval do
+        %w(keys model_source model_digest).each do |key, value|
+          class_attribute :"covercache_#{key}"
+          self.send(:"covercache_#{key}=", value) if value.present?
+        end
+                
+        self.covercache_keys ||= []
+        self.covercache_model_source = Where.is_class self, of: 'app/models'
+        
+        include Covercache::Model
+        
+        generate_model_digest!
+        
+        after_commit :covercache_flush_cache
+      end
+    end
+    
+    # TODO: coming soon...
+    def define_cached(*args)
+      method_name = args.shift              
+      opts = args.extract_options!
+      define_method :"cached_#{method_name}" do |*method_args|
+        puts self.inspect
+        if method_args.last.is_a?(Hash) and method_args.last.has_key?(:cache_key)
+          add_to_args = method_args.last.delete(:cache_key)
+          args += [add_to_args].flatten if add_to_args.present?
+        end
+        covercache(*args, opts) { self.send(method_name, *method_args) }
+      end      
+    end
+    
+  end
+end
+
+ActiveRecord::Base.extend Covercache::CoversWithCache

data/lib/where.rb

@@ -0,0 +1,69 @@
+# A little Ruby module for finding the source location where class and methods are defined.
+# https://gist.github.com/wtaysom/1236979
+
+module Where
+  #== Example
+  # 
+  #   Where.is_class Post, of: 'app/models'
+  # 
+  class <<self
+    def is_class(klass, opts={})
+      methods = defined_methods(klass)
+      file_groups = methods.group_by{|sl| sl[0]}
+      file_counts = file_groups.map do |file, sls|
+        lines = sls.map{|sl| sl[1]}
+        count = lines.size
+        line = lines.min
+        {file: file, count: count, line: line}
+      end
+      file_counts.sort_by!{|fc| fc[:count]}
+    
+      if opts[:of].present?
+        path_expand = joins_path(opts[:of])
+        return File.expand_path("../../spec/spec_helper.rb", __FILE__) unless !!path_expand
+        pattern = Regexp.new "^#{path_expand}/.*"
+        matches = file_counts.select do |fc| 
+          !!fc[:file][pattern] 
+        end
+        return matches.first[:file] if matches.first.present?
+      end
+    
+      source_locations = file_counts.map{|fc| [fc[:file], fc[:line]]}
+      source_locations
+    end
+  
+  private
+    def joins_path(of)
+      Rails.root.join(of).to_s
+    rescue NameError
+      return false
+    end    
+    
+    def source_location(method)
+      method.source_location || (
+        method.to_s =~ /: (.*)>/
+        $1
+      )
+    end
+  
+    def defined_methods(klass)
+      methods = klass.methods(false).map{|m| klass.method(m)} +
+        klass.instance_methods(false).map{|m| klass.instance_method(m)}
+      methods.map!(&:source_location)
+      methods.compact!
+      methods
+    end
+  end
+end
+
+def where_is(klass, method = nil)
+  Where.edit(if method
+    begin
+      Where.is_instance_method(klass, method)
+    rescue NameError
+      Where.is_method(klass, method)
+    end
+  else
+    Where.is_class_primarily(klass)
+  end)
+end

data/spec/libs/covercache_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'pp'
+
+describe "covercache" do
+  it 'should respond to covers_with_cache' do
+    Post.should respond_to(:covers_with_cache)
+  end
+  it 'should hove class keys storage' do
+    pp Post.covercache_keys
+    Post.covercache_keys.should be_an(Array)
+  end
+  it 'should have covercache_model_source attribute' do
+    pp Post.covercache_model_source
+    Post.covercache_model_source.should be_an(String)
+  end
+  it 'should have covercache_model_digest attribute' do
+    pp Post.covercache_model_digest
+    Post.covercache_model_digest.should be_an(String)
+  end
+  it 'should return the same digest for class and instance' do
+    post1 = Post.find(1)
+    pp post1.covercache_model_digest
+    Post.covercache_model_digest.should == post1.covercache_model_digest
+  end
+  it 'should return the same values with or without cache' do
+    test = Post.find(1)
+    pp test.inspect
+    pp test.cached_comments.inspect
+    test.cached_comments.count.should == test.comments.count
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'covercache'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rspec'
+require 'rspec/autorun'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", 
+                                        database: File.expand_path("../covercache.sqlite3", __FILE__)
+
+class Rails
+  def self.cache
+    Rails::Cache
+  end
+end
+
+class Rails::Cache
+  def self.fetch(*options, &block)
+    block.call
+  end
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = 'random'
+end
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :posts, :force => true do |t|
+    t.string :text
+    t.timestamps
+  end
+
+  create_table :comments, :force => true do |t|
+    t.belongs_to :post
+    t.string :text
+    t.timestamps
+  end
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+  covers_with_cache
+  def cached_comments
+    covercache debug: true do
+      comments.all
+    end
+  end
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+  covers_with_cache
+end
+
+post1 = Post.create(:text => "First post!")
+10.times {|i| post1.comments.create(text: "Comment ##{i} for first post")  }
+
+post2 = Post.create(:text => "Second post!")
+6.times {|i| post2.comments.create(text: "Comment ##{i} for second post") }

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: covercache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tõnis Simo
+- Brian Goff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Helper method to simplify Rails caching, based on PackRat
+email:
+- anton.estum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- covercache.gemspec
+- lib/covercache.rb
+- lib/covercache/model.rb
+- lib/covercache/model/cacher.rb
+- lib/covercache/version.rb
+- lib/where.rb
+- spec/covercache.sqlite3
+- spec/libs/covercache_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tonissimo/covercache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Rails cache helper based on PackRat gem
+test_files:
+- spec/covercache.sqlite3
+- spec/libs/covercache_spec.rb
+- spec/spec_helper.rb