has_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8867bbfb9f3a5f8e0ff7f89a41366845fdbfcc9
+  data.tar.gz: 2dee457ae3ff8996e6ca7ea2f40fa9cdf3dfb8b4
+SHA512:
+  metadata.gz: 336d950b006f184c5d5b5ad698fc5bcb30206b6de4c53dfc6838a3588d35b79ed2139a52ad547b75e84b1b6178097fee1fa0fdc64b1f2fa45e1fa0d95254ba82
+  data.tar.gz: fb61d9b6a9f4df6e06f4da7acf7ee74d568c744be645de556ad3f0e87252172bc50b13bef5bd9a7690bb102ed936203ce16b6fb34ed7e0e98804d48013699faf

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Peter Fern
+
+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/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+# Yard
+ENV['YARD_USER'] = 'pdf'
+ENV['YARD_PROJECT'] = 'has_cache'
+require 'yard'
+require 'yard-rails'
+require 'yard-blame'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = %w{lib/**/*.rb}
+  t.options = %w{--protected --private --readme README.md
+                 --markup markdown --markup-provider redcarpet
+                 --plugin rails --plugin blame
+                 --files README.md,CONTRIBUTING.md}
+end
+
+# Gems
+Bundler::GemHelper.install_tasks
+
+# RuboCop
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new(:rubocop)
+
+# RSpec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task doc: :yard
+task default: :spec

data/lib/has_cache/cache.rb

@@ -0,0 +1,100 @@
+require 'sourcify'
+
+module HasCache
+  # The cache class proxies calls to the original target, caching the results,
+  # and returns the cached results if passed the same target and arguments
+  class Cache
+    extend HasCache::Utilities
+    include HasCache::Utilities
+
+    attr_accessor :target, :cache_root, :cache_options
+
+    def self.new(*args, &block)
+      o = allocate
+      o.__send__(:initialize, *args, &block)
+      return o unless block_given?
+
+      key = o.generate_key
+      begin
+        block_source = block.to_source(ignore_nested: true)
+      rescue => e
+        if key == o.cache_root
+          # rubocop:disable LineLength, StringLiterals
+          raise ArgumentError, "Could not generate key from block, must call with `.cached(key: some_unique_key) { block }` (#{e})"
+          # rubocop:enable LineLength, StringLiterals
+        end
+      end
+      unless o.cache_options.delete(:canonical_key) || block_source.nil?
+        key += [block_source]
+      end
+      Rails.cache.fetch(key, o.cache_options) do
+        if o.target.is_a?(Class)
+          result = o.target.class_eval(&block)
+        else
+          result = o.target.instance_eval(&block)
+        end
+        extract_result(result)
+      end
+    end
+
+    def initialize(target, options = {})
+      @target = target
+      @cache_root = []
+      @cache_options = merged_options(target, options)
+      if target.is_a?(Class)
+        @cache_root = [target.name, :class]
+      else
+        @cache_root = [target.class.name, :instance]
+        unless target.respond_to?(:has_cache_key)
+          if target.class.respond_to?(:primary_key)
+            @cache_root << target.send(target.class.send(:primary_key).to_sym)
+          elsif target.respond_to?(:id)
+            @cache_root << target.send(:id)
+          elsif target.respond_to?(:name)
+            @cache_root << target.send(:name)
+          else
+            # rubocop:disable LineLength, StringLiterals
+            fail ArgumentError, "Could not find key for instance of `#{target.class.name}`, must call with `instance.cached(key: some_unique_key).method`"
+            # rubocop:enable LineLength, StringLiterals
+          end
+        end
+      end
+    end
+
+    def generate_key
+      key = cache_root
+      if cache_options.key?(:key)
+        options_key = cache_options.delete(:key)
+        if options_key.is_a?(Proc)
+          if target.is_a?(Class)
+            key += Array.wrap(target.class_eval(&options_key))
+          else
+            key += Array.wrap(target.instance_eval(&options_key))
+          end
+        else
+          key += Array.wrap(options_key)
+        end
+      elsif target.respond_to?(:has_cache_key)
+        key += target.send(:has_cache_key)
+      end
+      key
+    end
+
+    private
+
+      def method_missing(method, *args)
+        key = generate_key
+        unless cache_options.delete(:canonical_key)
+          key += [method]
+          key += args unless args.empty?
+        end
+        Rails.cache.fetch(key, cache_options) do
+          extract_result(target.send(method, *args))
+        end
+      end
+
+      def respond_to?(method)
+        target.respond_to?(method)
+      end
+  end
+end

data/lib/has_cache/mixin.rb

@@ -0,0 +1,33 @@
+module HasCache
+  # Mixin module to extend ActiveRecord::Base
+  module Mixin
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    # Mixin class methods
+    module ClassMethods
+      def has_cache(*args)
+        cattr_accessor :has_cache_options
+
+        options = args.extract_options!
+        self.has_cache_options = options || {}
+
+        extend HasCache::Mixin::CachedMethod
+        include HasCache::Mixin::CachedMethod
+      end
+    end
+
+    # Contains the cached method for proxying calls through
+    # HasCache::Cache, on both classes and instances.
+    module CachedMethod
+      def cached(*args, &block)
+        HasCache::Cache.new(self, *args, &block)
+      end
+    end
+  end
+end
+
+# Add mixin to ActiveRecord::Base
+ActiveRecord::Base.send :include, HasCache::Mixin

data/lib/has_cache/utilities.rb

@@ -0,0 +1,26 @@
+module HasCache
+  # Container for utility methods
+  module Utilities
+    def extract_result(result)
+      if result.is_a?(ActiveRecord::Relation)
+        if result.respond_to?(:load) &&
+           result.method(:load).owner == ActiveRecord::Relation
+          result.load
+        elsif result.respond_to?(:to_a)
+          result.to_a
+        end
+      end
+      result
+    end
+
+    def merged_options(target, local_options)
+      if target.is_a?(Class)
+        class_options = target.has_cache_options
+      else
+        class_options = target.class.has_cache_options
+      end
+      class_options.delete(:key) if target.respond_to?(:has_cache_key)
+      class_options.merge(local_options)
+    end
+  end
+end

data/lib/has_cache/version.rb

@@ -0,0 +1,4 @@
+# @private
+module HasCache
+  VERSION = '0.0.1'
+end

data/lib/has_cache.rb

@@ -0,0 +1,8 @@
+require 'has_cache/utilities'
+require 'has_cache/mixin'
+require 'has_cache/cache'
+
+# HasCache top-level namespace
+# @author Peter Fern <ruby@0xc0dedbad.com>
+module HasCache
+end

data/lib/tasks/has_cache_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_cache do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,297 @@
+--- !ruby/object:Gem::Specification
+name: has_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Fern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sourcify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  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: rubocop
+  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: yard
+  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: yard-rails
+  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: yard-blame
+  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: redcarpet
+  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: fabrication
+  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: ffaker
+  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: database_cleaner
+  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: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |2
+      Using `has_cache` in your classes provides a `cached` method that allows
+      automatic caching the result of a method that is normally available on the
+      class, or an instance of the class.
+
+      It mitigates the hassle of creating and tracking keys as you would with
+      the standard Cache Store interface, by inferring keys from the location
+      `cached` is invoked.
+email:
+- ruby@0xc0dedbad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/has_cache/cache.rb
+- lib/has_cache/utilities.rb
+- lib/has_cache/mixin.rb
+- lib/has_cache/version.rb
+- lib/has_cache.rb
+- lib/tasks/has_cache_tasks.rake
+- MIT-LICENSE
+- Rakefile
+homepage: http://rubygems.org/gems/has_cache
+licenses: []
+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: Convenience wrapper for the Rails Cache Store
+test_files: []
+has_rdoc: