action_param_caching 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1232085c788b054a445d683168928962fb2094c0
+  data.tar.gz: 796b06fd01e778e03cc5c58083dd2c9504323428
+SHA512:
+  metadata.gz: 9fe6a6437d081580361e31feec198b77d69ab3ba658b92f1780edfcc2f02646633fec48ee36497042edf9868781542226cf853fccf38460b4ef1f76cf7413c6c
+  data.tar.gz: 56ed26ce55487a71e631cb3e51e05d61fb991a79421f9c789bd34a3ae52aab75a1f4fe16f73f4c6b13ec9a16079fa0b37f81a21b51af011e86e955f8426e0e01

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 cparratto
+
+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,38 @@
+# ActionParamCaching
+
+Action param caching simplfies action caching bases on parameter values. It allows you to quickly specify what actions you want to cache base on the parameters they are passed, the set of parameters you are interested in caching on, and an option prefix value for ignoring parameters that are designed to bust your cache.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'action_param_caching'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_param_caching
+
+## Usage
+
+ 1. Enable rails caching (See rails docs).
+ 2. Require 'action_param_caching'
+ 3. Add 'extend ActionParamCaching::Rails::ActionController' to your controller
+ 4. Add the correct param cache statement to your controller.
+    - Standard statement for full param chaching:
+      cache_with_params :on => [:index]
+    - Cache on a set or subset
+      cache_with_params :on => [:index], :with_set_or_subset => [:param1, :param2]
+    - Ignore params with prefix
+      cache_with_params :on => [:index], :filter_starting_with => '_'
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc "Run all spec in spec directory (excluding plugin spec)"
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/action_param_caching.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_param_caching/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_param_caching"
+  spec.version       = ActionParamCaching::VERSION
+  spec.authors       = ["cparratto"]
+  spec.email         = ["chris.parratto@pnmac.com"]
+  spec.description   = %q{Parameterized caching for ActionControllers}
+  spec.summary       = %q{Allows for parameterized caching for action controllers.}
+  spec.homepage      = "https://github.com/pennymac/action_param_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 "rspec"
+  spec.add_development_dependency "mocha"
+
+  spec.add_dependency "active_support"
+  spec.add_dependency "i18n"
+
+end
+

data/lib/action_param_caching/action_config.rb

@@ -0,0 +1,41 @@
+module ActionParamCaching
+  class ActionConfig
+    attr_reader :action, :valid_params, :filter_starting_with, :argz
+    attr_accessor :did_config_cache
+
+    def initialize(action, valid_params = [], filter_starting_with = nil)
+      @action = action
+      @valid_params = valid_params
+      @filter_starting_with = filter_starting_with
+      @did_config_cache = false
+    end
+
+    def cache_args
+         @argz = {}
+
+         if @valid_params && @valid_params.any?
+           @argz[:if] = self.if_proc
+         end
+
+         if @filter_starting_with
+           @argz[:cache_path] = self.filtered_path_proc
+         else
+           @argz[:cache_path] = self.path_proc
+         end
+
+         @argz
+    end
+
+    def filtered_path_proc
+      Proc.new { |request| params.delete_if { |k,v| k.to_s.start_with?(@filter_starting_with) }.to_query }
+    end
+
+    def path_proc
+      Proc.new { |request| params.to_query }
+    end
+
+    def if_proc
+      Proc.new { params.collect{|key, value| @valid_params.include?(key)}.all? }
+    end
+  end
+end

data/lib/action_param_caching/rails/action_controller.rb

@@ -0,0 +1,24 @@
+module ActionParamCaching
+  module Rails
+    module ActionController
+      attr_reader :action_cache_configs
+
+      def cache_with_params(options = {})
+        @action_cache_configs = {} if @action_cache_configs.nil?
+
+        options[:on].each do |action|
+          @action_cache_configs[action] = ActionParamCaching::ActionConfig.new(action, options[:with_set_or_subset], options[:filter_starting_with]) unless @action_cache_configs[action]
+        end
+
+        options[:on].each do |action|
+          config = @action_cache_configs[action]
+
+          unless config.did_config_cache
+            caches_action action, config.cache_args
+            config.did_config_cache = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_param_caching/version.rb

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

data/lib/action_param_caching.rb

@@ -0,0 +1,7 @@
+require "action_param_caching/version"
+require "action_param_caching/action_config"
+require "action_param_caching/rails/action_controller"
+
+module ActionParamCaching
+  # Your code goes here...
+end

data/spec/action_config_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+module ActionParamCaching
+  describe ActionConfig do
+    context "in order to track the cache configuration of an action" do
+      it "is initialized with valid params, an action, and a prefix filter" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index,[:id, :name, :amount], '_')
+        cache_config.action.should == :index
+        cache_config.valid_params.should == [:id, :name, :amount]
+        cache_config.filter_starting_with.should == '_'
+      end
+
+      it "sets the correct default values for valid params and prefix filters" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index)
+        cache_config.action.should == :index
+        cache_config.valid_params.should == []
+        cache_config.filter_starting_with.should be_nil
+      end
+
+      it "tracks if a cache has been configured" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index)
+        cache_config.did_config_cache.should be_false
+        cache_config.did_config_cache = true
+        cache_config.did_config_cache.should be_true
+      end
+    end
+
+    context "when generating action cache arguments" do
+      it "has an if condition when you specify valid params" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index,[:id, :name, :amount], '_')
+        cache_args = cache_config.cache_args
+        cache_args[:if].should be
+      end
+
+      it "does not have an if condition if you don't specify valid params" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index)
+        cache_args = cache_config.cache_args
+        cache_args[:if].should be_nil
+      end
+
+      it "has a the correct cache path when stripping params with a prefix" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index,[:id, :name, :amount], '_')
+
+
+        cache_config.stubs(:params).returns( {:_remove_me => true} )
+        cache_args = cache_config.cache_args
+        proc = cache_args[:cache_path]
+        proc.call(nil).should == ""
+      end
+
+      it "has a the correct cache path under normal conditions" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index,[:id, :name, :amount])
+        cache_args = cache_config.cache_args
+        cache_config.stubs(:params).returns( {:_remove_me => false} )
+        proc = cache_args[:cache_path]
+        proc.call(nil).should == cache_config.params.to_query
+      end
+
+      it "does not have a if argument if the valid params are empty" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index)
+        cache_args = cache_config.cache_args
+        cache_args[:if].should be_nil
+      end
+
+      it "does have an if argument that returns true if the params are a subset of the valid params" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index,[:id, :name, :amount])
+        cache_args = cache_config.cache_args
+        cache_config.stubs(:params).returns( {:id => 23, :name => "test"} )
+        proc = cache_args[:if]
+        proc.call.should be_true
+      end
+
+      it "does have an if argument that returns false if the params are not a subset of the valid params" do
+        cache_config = ActionParamCaching::ActionConfig.new(:index,[:id, :name, :amount])
+        cache_args = cache_config.cache_args
+        cache_config.stubs(:params).returns( {:id => 23, :name => "test", :not => "valid"} )
+        proc = cache_args[:if]
+        proc.call.should be_false
+      end
+    end
+  end
+end

data/spec/rails/action_controller_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+class TestController
+  extend ActionParamCaching::Rails::ActionController
+  def self.caches_action(action, args)
+  end
+end
+
+module ActionParamCaching
+  module Rails
+    describe ActionController do
+      it "provides param configuration for action caching" do
+        TestController.respond_to?(:action_cache_configs).should be_true
+      end
+
+      it "provides a means to configure caching for mutiple actions with one statement" do
+        TestController.cache_with_params :on => [:test1]
+        TestController.action_cache_configs[:test1].should be
+      end
+
+      it "provided a means to set a set or subset or params to cache on" do
+        TestController.cache_with_params :on => [:test2], :with_set_or_subset => [:param1, :param2]
+        TestController.action_cache_configs[:test2].valid_params.should == [:param1, :param2]
+      end
+
+      it "provides a means to filter params that have a prefix" do
+        TestController.cache_with_params :on => [:test3], :filter_starting_with => '_'
+        TestController.action_cache_configs[:test3].filter_starting_with.should == '_'
+      end
+
+      it "configures the cache actions using the specified params" do
+        TestController.expects(:caches_action)
+        TestController.cache_with_params :on => [:test4], :filter_starting_with => '_', :with_set_or_subset => [:param1, :param2]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'active_support/all'
+
+require 'action_param_caching' # and any other gems you need
+
+#Hash.send(:include, ActiveSupport::CoreExtensions::Hash) unless Hash.included_modules.include?(ActiveSupport::CoreExtensions::Hash)
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.order = "random"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: action_param_caching
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- cparratto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-18 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: 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: mocha
+  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: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parameterized caching for ActionControllers
+email:
+- chris.parratto@pnmac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_param_caching.gemspec
+- lib/action_param_caching.rb
+- lib/action_param_caching/action_config.rb
+- lib/action_param_caching/rails/action_controller.rb
+- lib/action_param_caching/version.rb
+- spec/action_config_spec.rb
+- spec/rails/action_controller_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pennymac/action_param_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.0.3
+signing_key: 
+specification_version: 4
+summary: Allows for parameterized caching for action controllers.
+test_files:
+- spec/action_config_spec.rb
+- spec/rails/action_controller_spec.rb
+- spec/spec_helper.rb