active_record_caching 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d77e9b56e028154a8c8b133b730984b879e01500
+  data.tar.gz: 186f290de41407edc2ae363a4b50f1d601143981
+SHA512:
+  metadata.gz: e38a1816a20a6e99d280fe83189ec7f4f642c8c536d9f0a4043afb5c4c677d7ecb4aaf7eb28b34d522dd8abf21e9069b610436c2cea42ea53d9b149e87d0703b
+  data.tar.gz: 42bf3e15c8e02db3f3229ba691d613a998ad7d3b678bf6535078e770d3d34c1ce79d6fbfa00cf3f25476b58ed8cbed585be6fea3b9e519da94496c9f37f0b02c

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Derek Lindahl
+
+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,45 @@
+# ActiveRecord Caching
+
+Adds "Advanced Caching" to ActiveRecord::Base as described in Adam Hawkins'
+blog, [Fast JSON APIs](http://broadcastingadam.com/2012/07/advanced_caching_part_6-fast_json_apis/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_record_caching'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_caching
+
+## Usage
+
+Index controller actions will support `#stale?`
+
+```ruby
+class ResourceController < ApplicationController
+  responds_to :json
+
+  def index
+    # uses the new #cache_key method defined on ActiveRecord::Base to
+    # set the etag
+    if stale? collection do
+      # Use cached JSON from individual hashes to render a collection
+      respond_with collection
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/./fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/active_record_caching.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_caching/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record_caching'
+  spec.version       = ActiveRecordCaching::VERSION
+  spec.authors       = ['Derek Lindahl']
+  spec.email         = ['dlindahl@customink.com']
+  spec.summary       = %q{Additonal caching logic for ActiveRecord for fast JSON APIs}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/dlindahl/active_record_caching'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6'
+  spec.add_development_dependency 'rake'
+end

data/lib/active_record_caching.rb

@@ -0,0 +1,8 @@
+require 'active_record_caching/version'
+require 'active_record_caching/errors'
+require 'active_record_caching/cache_key'
+require 'active_record_caching/cache_serializing'
+require 'active_record_caching/railtie'
+
+module ActiveRecordCaching
+end

data/lib/active_record_caching/cache_key.rb

@@ -0,0 +1,35 @@
+# Adds a #cache_key method to ActiveRecord::Base so that cache_digest has
+# something meaningful to use when caching collections (ActiveRecord::Relation)
+#
+# From http://broadcastingadam.com/2012/07/advanced_caching_part_6-fast_json_apis/
+module ActiveRecordCaching
+  module CacheKey
+    module Rails3
+      def cache_key
+        Digest::MD5.hexdigest(raw_cache_key)
+      end
+
+      def updated_at
+        scoped.maximum(:updated_at)
+      end
+
+      def raw_cache_key
+        "#{scoped.to_sql}-#{updated_at.try(:to_i)}-#{scoped.count}"
+      end
+    end
+
+    module Rails4
+      def cache_key
+        Digest::MD5.hexdigest(raw_cache_key)
+      end
+
+      def updated_at
+        all.maximum(:updated_at)
+      end
+
+      def raw_cache_key
+        "#{all.to_sql}-#{updated_at.try(:to_i)}-#{all.count}"
+      end
+    end
+  end
+end

data/lib/active_record_caching/cache_serializing.rb

@@ -0,0 +1,35 @@
+module ActiveRecordCaching
+  module CacheSerializing
+    def perform_caching?
+      valid_representation? && super
+    end
+
+    def cache_key
+      if defined?(super)
+        super
+      elsif object.respond_to?(:cache_key)
+        object.cache_key
+      else
+        raise NoMethodError, "undefined method `cache_key' for #{object}"
+      end
+    end
+
+    def respond_to?(method_name, *args)
+      return super if method_name != :cache_key
+
+      # If the serializer explicitly defines :cache_key or the object itself
+      # defines it, then we can assume that :cache_key is supported
+      method(:cache_key).owner != CacheSerializing || object.respond_to?(:cache_key)
+    end
+
+  private
+
+    # Allows easy determination about whether or not to read from the cache
+    # based on the serialized object's state of validations.
+    def valid_representation?
+      return true unless object.respond_to? :errors
+
+      object.errors.blank?
+    end
+  end
+end

data/lib/active_record_caching/errors.rb

@@ -0,0 +1,28 @@
+module ActiveRecordCaching
+  class CacheKeyExists < StandardError
+    def message
+      "ActiveRecord::Base.cache_key exists" \
+      "\n\n" \
+      "The ActiveRecord::Base.cache_key monkey patch is no longer required." \
+      "\n" \
+      "ActiveRecord::Base already responds to .cache_key" \
+      "\n\n"
+    end
+  end
+
+  class VersionCheckRequired < StandardError
+    def message
+      "ActiveModel::Serializer implementation check required."\
+      "\n\n" \
+      "There were some discrepancies found in regards to serialization\n" \
+      "caching with ActiveModel::Serializer > 0.8.1.\n\n" \
+      "Since it appears that ASM has been upgraded, you must double\n" \
+      "check that ASM does indeed support caching and ensure that the\n" \
+      "patches in CacheSerializing are still needed and compatible.\n\n" \
+      "For more information:\n\n" \
+      "  * https://github.com/rails-api/active_model_serializers/issues/467#issuecomment-30388385\n" \
+      "  * https://github.com/rails-api/active_model_serializers/issues/478#issuecomment-31367143\n" \
+      "\n\n"
+    end
+  end
+end

data/lib/active_record_caching/railtie.rb

@@ -0,0 +1,28 @@
+module ActiveRecordCaching
+  class Railtie < Rails::Railtie
+    config.before_initialize do |app|
+      ActiveSupport.on_load(:active_record) do
+        if ActiveRecord::Base.respond_to? :cache_key
+          raise CacheKeyExists
+        else
+          case Rails.version[0]
+          when '3' then ActiveRecord::Base.extend(ActiveRecordCaching::CacheKey::Rails3)
+          when '4' then ActiveRecord::Base.extend(ActiveRecordCaching::CacheKey::Rails4)
+          else
+            raise 'unsupported'
+          end
+        end
+      end
+
+      ActiveSupport.on_load(:active_model_serializers) do
+        require 'active_model/serializers/version'
+        if ActiveModel::Serializer::VERSION != '0.8.1'
+          raise VersionCheckRequired
+        end
+
+        ActiveModel::ArraySerializer.send :prepend, CacheSerializing
+        ActiveModel::Serializer.send :prepend, CacheSerializing
+      end
+    end
+  end
+end

data/lib/active_record_caching/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordCaching
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: active_record_caching
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Derek Lindahl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Additonal caching logic for ActiveRecord for fast JSON APIs
+email:
+- dlindahl@customink.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_caching.gemspec
+- lib/active_record_caching.rb
+- lib/active_record_caching/cache_key.rb
+- lib/active_record_caching/cache_serializing.rb
+- lib/active_record_caching/errors.rb
+- lib/active_record_caching/railtie.rb
+- lib/active_record_caching/version.rb
+homepage: https://github.com/dlindahl/active_record_caching
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Additonal caching logic for ActiveRecord for fast JSON APIs
+test_files: []