custom_fragment_cache 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWQyOTVjNmI4NDMyZTRlZjlhNTNmZWVjZWJmMTk1MTdmYjljYjhjMw==
+  data.tar.gz: !binary |-
+    YTVhOGViMDhlN2QxN2RmODlmNGNkMmMwMWFiMWVmZWEyZjVjZmViOA==
+SHA512:
+  metadata.gz: !binary |-
+    NDlkOGMyNTMyYzhmOGRmYWM2YTQ3ZThhZDhhMGUwMDdlMGQ5ZDZmNWI0OWU0
+    ZTRjMTQxOWZmMjQ5ZDU3YjMwNjg1NGQwNjA4OWNmODdjMDgzY2JkOGZiZGFi
+    YmIzODZiYjQ0N2I2ZWZjOTlkM2U1YjU2MmQ5ZjUwMmRkNmFkZGE=
+  data.tar.gz: !binary |-
+    MWMxMWViYWUwMmRmN2Q2MGFiYzVlOTdlMDZhNGVhYjY5N2NlZWVmMWZhYmIw
+    NjI5YWMxODc5ZTAzMTg4OGRlNDBjMjk1MWE0ZGJjMDYzMzUyODc4MTI5MTcx
+    OGMxODA1NDE0MGYzZWEzMzk4YWZjYjFmNjBmMDMxNWRjNmZjYzc=

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 custom_fragment_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yarin Goldman
+
+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,66 @@
+# CustomFragmentCache
+
+CustomFragmentCache gives you a simple way for defining your own fragments cache with the ability to specify expiration according to fields.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'custom_fragment_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install custom_fragment_cache
+
+## Usage
+### Define fragments:
+Define it on ActiveRecord:
+``` ruby
+class User < ActiveRecord::Base
+  include CustomFragmentCache
+  
+  define_cache_fragment(:full_name, trigger_fields: %w(first_name last_name)) # When one of the trigger fields will be changed it will expire the cache
+  define_cache_fragment(:full_name, safe_fields: %w(id created_at updated_at)) # When one of the none safe fields will be changed it will expire the cache
+end
+```
+
+You can also define it on ActiveRecord::Observer
+``` ruby
+class UserCache < ActiveRecord::Observer
+  include CustomFragmentCache
+  observe :user
+
+  define_cache_fragment(:full_name, trigger_fields: %w(first_name last_name))
+end
+```
+
+### Use cache on the view:
+Use `custom_cache` instead of `cache`
+``` ruby
+<p>
+  <span>Hello </span>
+  <span><% custom_cache(User.first, :full_name) { "#{User.first.first_name} #{User.first.last_name}" } %></span>
+</p>
+```
+
+Jbuilder support
+``` ruby
+json.custom_cache!(user, :full_name) do
+  json.first_name user.first_name
+  json.last_name user.last_name
+end
+```
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/custom_fragment_cache/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 new Pull Request

data/Rakefile

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

data/custom_fragment_cache.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'custom_fragment_cache/version'
+require 'active_support/concern'
+require 'active_support/cache'
+require 'custom_fragment_cache/logic'
+require 'custom_fragment_cache/fragment'
+require 'custom_fragment_cache/configuration'
+
+Gem::Specification.new do |spec|
+  spec.name          = "custom_fragment_cache"
+  spec.version       = CustomFragmentCache::VERSION
+  spec.authors       = ["Yarin Goldman"]
+  spec.email         = ["yarin@gettaxi.com"]
+  spec.summary       = %q{Define your custom fragment caches}
+  spec.description   = %q{Define your custom fragment caches}
+  spec.homepage      = ""
+  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_runtime_dependency 'activesupport', '>= 3.0'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/custom_fragment_cache.rb

@@ -0,0 +1,33 @@
+require 'active_support/concern'
+require 'active_support/core_ext/object/blank'
+require 'custom_fragment_cache/railtie' if defined?(Rails)
+require 'custom_fragment_cache/logic'
+require 'custom_fragment_cache/fragment'
+require 'custom_fragment_cache/helper'
+require 'custom_fragment_cache/cache_helper_method'
+require 'custom_fragment_cache/configuration'
+require 'custom_fragment_cache/version'
+
+module CustomFragmentCache
+  extend ActiveSupport::Concern
+  include Logic
+
+  included do
+    # Don't call after_save when it's Observer
+    after_save :fragments_validity unless self.superclass == ActiveRecord::Observer
+  end
+
+  # Observer support
+  def after_save(record)
+    fragments_validity(record)
+  end
+
+  def fragments_validity(record = self)
+    self.class.fragment_caches.each do |fragment_cache|
+      if expire_cache?(fragment_cache, record)
+        expire_fragment(cache_key(fragment_cache.name, record))
+      end
+    end
+  end
+
+end

data/lib/custom_fragment_cache/cache_helper_method.rb

@@ -0,0 +1,13 @@
+module CustomFragmentCache
+  class CacheHelperMethod
+    def self.base_custom_cache(context, method_name, resource, name, options = {}, &block)
+      if CustomFragmentCache.configuration.enabled
+        fragment_cache_key = ::CustomFragmentCache::Logic.cache_key(name, resource)
+        default_options = { expires_in: CustomFragmentCache.configuration.expiration_time }
+        context.__send__(method_name, fragment_cache_key, default_options.merge(options), &block)
+      else
+        block.call
+      end
+    end
+  end
+end

data/lib/custom_fragment_cache/configuration.rb

@@ -0,0 +1,22 @@
+module CustomFragmentCache
+  class Configuration
+    attr_accessor :enabled, :expiration_time
+
+    def initialize
+      @enabled = true
+      @expiration_time = 1.hour
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+end

data/lib/custom_fragment_cache/fragment.rb

@@ -0,0 +1,31 @@
+module CustomFragmentCache
+  class Fragment
+    attr_reader :name, :opts, :fields, :fields_method
+
+    def initialize(name, opts)
+      @name = name
+      @opts = opts.with_indifferent_access
+      @fields = {}
+      @fields_method = :none
+      set_fields
+    end
+
+    def set_fields
+      validate_fields_method
+
+      if @opts[:safe_fields].present?
+        @fields = @opts[:safe_fields].to_a
+        @fields_method = :safe
+      elsif @opts[:trigger_fields].present?
+        @fields = @opts[:trigger_fields].to_a
+        @fields_method = :trigger
+      end
+    end
+
+    def validate_fields_method
+      if @opts.key?(:safe_fields) && @opts.key?(:trigger_fields)
+        raise ArgumentError, "Set trigger and safe fields are not allowed together"
+      end
+    end
+  end
+end

data/lib/custom_fragment_cache/helper.rb

@@ -0,0 +1,7 @@
+module CustomFragmentCache
+  module Helper
+    def custom_cache(resource, name, options = {}, &block)
+      CacheHelperMethod.base_custom_cache(self, :cache, resource, name, options, &block)
+    end
+  end
+end

data/lib/custom_fragment_cache/logic.rb

@@ -0,0 +1,56 @@
+module CustomFragmentCache
+  module Logic
+    extend ActiveSupport::Concern
+
+    def expire_cache?(fragment_cache, record)
+      if fragment_cache.fields_method == :safe
+        unsafe_dirty_fields = record.changed - fragment_cache.fields
+        return true if unsafe_dirty_fields.present?
+      elsif fragment_cache.fields_method == :trigger
+        trigger_dirty_fields = record.changed & fragment_cache.fields
+        return true if trigger_dirty_fields.present?
+      end
+    end
+
+    def expire_fragment(key)
+      action_controller = ActionController::Base.new
+
+      if action_controller.send(:cache_configured?)
+        action_controller.instrument_fragment_cache :expire_fragment, key do
+          if key.is_a?(Regexp)
+            action_controller.cache_store.delete_matched(key)
+          elsif action_controller.cache_store.is_a?(ActiveSupport::Cache::RedisStore)
+            # TODO find better solution
+            action_controller.cache_store.delete_matched("*#{key}*")
+          else
+            action_controller.cache_store.delete(key)
+          end
+        end
+      end
+    end
+
+    def prefix
+      "custom_fragment_cache"
+    end
+
+    def cache_key(fragment_name, record)
+      "#{prefix}:#{record.class.name.downcase}-#{record.id}:#{fragment_name}"
+    end
+    module_function :cache_key, :prefix
+
+    module ClassMethods
+      def add_fragment_cache(fragment_cache)
+        (@fragment_caches ||= []) << fragment_cache
+      end
+
+      def fragment_caches
+        @fragment_caches || []
+      end
+
+      def define_cache_fragment(name, opts = {})
+        fragment_cache = CustomFragmentCache::Fragment.new(name, opts)
+        add_fragment_cache(fragment_cache)
+      end
+    end
+  end
+end

data/lib/custom_fragment_cache/railtie.rb

@@ -0,0 +1,15 @@
+module CustomFragmentCache
+  class Railtie < Rails::Railtie
+    initializer "custom_fragment_cache.extend_cache_helpers" do |app|
+      ActiveSupport.on_load :action_view do
+        include Helper
+      end
+
+      JbuilderTemplate.class_eval do
+        def custom_cache!(resource, name, options = {}, &block)
+          CacheHelperMethod.base_custom_cache(self, :cache!, resource, name, options, &block)
+        end
+      end
+    end
+  end
+end

data/lib/custom_fragment_cache/version.rb

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

data/spec/custom_fragment_cache/logic_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'pry'
+require 'custom_fragment_cache'
+
+describe CustomFragmentCache do
+  class DummyClass
+    include CustomFragmentCache::Logic
+  end
+
+  describe "#expire_cache?" do
+    context "safe fields" do
+      it "returns true when some non safe field changed" do
+        cache = Object.new
+        cache.stub(:fields_method) { :safe }
+        cache.stub(:fields) { ["a"] }
+        resource = Object.new
+        resource.stub(:changed) { ["a", "b"] }
+        DummyClass.new.expire_cache?(cache, resource).should be_true
+      end
+
+      it "returns false when only safe fields changed" do
+        cache = Object.new
+        cache.stub(:fields_method) { :safe }
+        cache.stub(:fields) { ["a", "b"] }
+        resource = Object.new
+        resource.stub(:changed) { ["a", "b"] }
+        DummyClass.new.expire_cache?(cache, resource).should be_false
+      end
+    end
+
+    context "trigger fields" do
+      it "returns true when some of the trigger fields changed" do
+        cache = Object.new
+        cache.stub(:fields_method) { :trigger }
+        cache.stub(:fields) { ["a"] }
+        resource = Object.new
+        resource.stub(:changed) { ["a", "b", "c"] }
+        DummyClass.new.expire_cache?(cache, resource).should be_true
+      end
+
+      it "returns false when none of the trigger fields changed" do
+        cache = Object.new
+        cache.stub(:fields_method) { :trigger }
+        cache.stub(:fields) { ["x", "y"] }
+        resource = Object.new
+        resource.stub(:changed) { ["a", "b", "c"] }
+        DummyClass.new.expire_cache?(cache, resource).should be_false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: custom_fragment_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yarin Goldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: 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: pry
+  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: Define your custom fragment caches
+email:
+- yarin@gettaxi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- custom_fragment_cache.gemspec
+- lib/custom_fragment_cache.rb
+- lib/custom_fragment_cache/cache_helper_method.rb
+- lib/custom_fragment_cache/configuration.rb
+- lib/custom_fragment_cache/fragment.rb
+- lib/custom_fragment_cache/helper.rb
+- lib/custom_fragment_cache/logic.rb
+- lib/custom_fragment_cache/railtie.rb
+- lib/custom_fragment_cache/version.rb
+- spec/custom_fragment_cache/logic_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Define your custom fragment caches
+test_files:
+- spec/custom_fragment_cache/logic_spec.rb
+- spec/spec_helper.rb
+has_rdoc: