actionpack-action_caching 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f520a1e93eaed67273fa9b78f43a2915df547394
-  data.tar.gz: 98e0478487f7409433511112956e3b3a1a7db96c
+  metadata.gz: 1c3e6a065ee870841cd63083ad4fbe729a3f3d39
+  data.tar.gz: 7ec1ff92fc66365d06709ff8158687922aae7dc3
 SHA512:
-  metadata.gz: 8ebda7c53fa67b946d11c0881d214f5a1080aa84d03c168b4378da40a8eb1af8a6c876024f38fd06d2044ce191eeb5f9e7b64306db4533acdf541cb7cefb175b
-  data.tar.gz: 0eb3f5eba1f7b0fc80f3eecd049cebcd9846b7e9dbfca20112232e23f0ada954bf1bc06f9d9176771de3e54931389993106f2f29bfc52baa0c93e0a9f88eaf1f
+  metadata.gz: c48324f7e2c76ddc22e3b9799bef687f2de43d122c319cc62df0fa5539b3a42209f24cb88847e8dd1168bf6a710f951179359de51d8570d63115211efc87a97e
+  data.tar.gz: e9c4f0b4f373207d16cc27f486c5747661f70d4adad18d21287126e3072e3a55b1bdf83296893b5ea85d331907d578f44e7979dc9257978e3d97f87991d96a83

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+engines:
+  rubocop:
+    enabled: true
+
+ratings:
+  paths:
+  - "**.rb"

data/.gitignore

@@ -1,17 +1,5 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
+.ruby-version
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
+gemfiles/*.lock
+pkg/*
 test/tmp
-test/version_tmp
-tmp

data/.rubocop.yml

@@ -0,0 +1,116 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+# Align `when` with `case`.
+Style/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Style/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Style/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Style/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Style/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: rails
+
+# Two spaces, no tabs (for indentation).
+Style/IndentationWidth:
+  Enabled: true
+
+Style/SpaceAfterColon:
+  Enabled: true
+
+Style/SpaceAfterComma:
+  Enabled: true
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Style/SpaceAroundKeyword:
+  Enabled: true
+
+Style/SpaceAroundOperators:
+  Enabled: true
+
+Style/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Style/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Style/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Style/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Style/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Style/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  AlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/.travis.yml

@@ -1,16 +1,55 @@
 language: ruby
+sudo: false
+
+cache:
+  bundler: true
+
 before_install:
   - gem install bundler
+
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.9
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+
 gemfile:
   - Gemfile
-  - gemfiles/Gemfile-edge
   - gemfiles/Gemfile-4-0-stable
+  - gemfiles/Gemfile-4-1-stable
+  - gemfiles/Gemfile-4-2-stable
+  - gemfiles/Gemfile-5-0-stable
+  - gemfiles/Gemfile-edge
+
 matrix:
   allow_failures:
     - gemfile: gemfiles/Gemfile-edge
+  exclude:
+    - rvm: 1.9.3
+      gemfile: Gemfile
+    - rvm: 2.0.0
+      gemfile: Gemfile
+    - rvm: 2.1.9
+      gemfile: Gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/Gemfile-5-0-stable
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile-5-0-stable
+    - rvm: 2.1.9
+      gemfile: gemfiles/Gemfile-5-0-stable
+    - rvm: 1.9.3
+      gemfile: gemfiles/Gemfile-edge
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile-edge
+    - rvm: 2.1.9
+      gemfile: gemfiles/Gemfile-edge
+    - rvm: 2.4.0
+      gemfile: gemfiles/Gemfile-4-0-stable
+    - rvm: 2.4.0
+      gemfile: gemfiles/Gemfile-4-1-stable
+
 notifications:
   email: false
   irc:

data/CHANGELOG.md

@@ -1,10 +1,41 @@
-## 1.1.1
+## 1.2.0 (January 23, 2014)
+
+*   Support proc options with zero arguments
+
+    Fixes #40.
+
+    *Andrew White*
+
+*   The options `:layout` and `:cache_path` now behave the same when
+    passed a `Symbol`, `Proc` or object that responds to call.
+
+    *Andrew White*
+
+*   Respect `Accept` header when caching actions
+
+    Fixes #18.
+
+    *Andrew White*
+
+*   Support Rails 4.0, 4.1, 4.2, 5.0 and edge
+
+    *Eileen Uchitelle*, *Andrew White*
+
+*   Call `to_s` on the extension as it may be a symbol
+
+    Fixes #10.
+
+    *Andrew White*
+
+
+## 1.1.1 (January 2, 2014)
 
 *   Fix load order problem with other gems
 
     *Andrew White*
 
-## 1.1.0
+
+## 1.1.0 (November 1, 2013)
 
 *   Allow to use non-proc object in `cache_path` option. You can pass an object that
     responds to a `call` method.
@@ -24,6 +55,7 @@
 
     *Piotr Niełacny*
 
+
 ## 1.0.0 (February 28, 2013)
 
 *   Extract Action Pack - Action Caching from Rails core.

data/Gemfile

@@ -1,5 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rails'
+gem "rails"

data/README.md

@@ -3,14 +3,12 @@ actionpack-action_caching
 
 Action caching for Action Pack (removed from core in Rails 4.0).
 
-**NOTE:** It will continue to be officially maintained until Rails 4.1.
-
 Installation
 ------------
 
 Add this line to your application's Gemfile:
 
-    gem 'actionpack-action_caching'
+    gem "actionpack-action_caching"
 
 And then execute:
 
@@ -31,7 +29,7 @@ authentication and other restrictions on whether someone is allowed
 to execute such action.
 
     class ListsController < ApplicationController
-      before_filter :authenticate, except: :public
+      before_action :authenticate, except: :public
 
       caches_page   :public
       caches_action :index, :show
@@ -56,17 +54,18 @@ Different representations of the same resource, e.g.
 `http://david.example.com/lists.xml`
 are treated like separate requests and so are cached separately.
 Keep in mind when expiring an action cache that
-`action: 'lists'` is not the same as
-`action: 'list', format: :xml`.
+`action: "lists"` is not the same as
+`action: "list", format: :xml`.
 
 You can modify the default action cache path by passing a
 `:cache_path` option. This will be passed directly to
 `ActionCachePath.new`. This is handy for actions with
 multiple possible routes that should be cached differently. If a
-block is given, it is called with the current controller instance.
+proc (or an object that responds to `to_proc`) is given, it is
+called with the current controller instance.
 
-And you can also use `:if` (or `:unless`) to pass a
-proc that specifies when the action should be cached.
+And you can also use `:if` (or `:unless`) to control when the action
+should be cached, similar to how you use them with `before_action`.
 
 As of Rails 3.0, you can also pass `:expires_in` with a time
 interval (in seconds) to schedule expiration of the cached item.
@@ -74,38 +73,45 @@ interval (in seconds) to schedule expiration of the cached item.
 The following example depicts some of the points made above:
 
     class ListsController < ApplicationController
-      before_filter :authenticate, except: :public
+      before_action :authenticate, except: :public
+
+      # simple fragment cache
+      caches_action :current
+
+      # expire cache after an hour
+      caches_action :archived, expires_in: 1.hour
 
-      caches_page :public
+      # cache unless it's a JSON request
+      caches_action :index, unless: -> { request.format.json? }
 
-      caches_action :index, if: Proc.new do
-        !request.format.json?  # cache if is not a JSON request
-      end
+      # custom cache path
+      caches_action :show, cache_path: { project: 1 }
 
-      caches_action :show, cache_path: { project: 1 },
-        expires_in: 1.hour
+      # custom cache path with a proc
+      caches_action :history, cache_path: -> { request.domain }
 
-      caches_action :feed, cache_path: Proc.new do
-        if params[:user_id]
-          user_list_url(params[:user_id], params[:id])
-        else
-          list_url(params[:id])
+      # custom cache path with a symbol
+      caches_action :feed, cache_path: :user_cache_path
+
+      protected
+        def user_cache_path
+          if params[:user_id]
+            user_list_url(params[:user_id], params[:id])
+          else
+            list_url(params[:id])
+          end
         end
-      end
     end
 
 If you pass `layout: false`, it will only cache your action
 content. That's useful when your layout has dynamic information.
 
-Warning: If the format of the request is determined by the Accept HTTP
-header the Content-Type of the cached response could be wrong because
-no information about the MIME type is stored in the cache key. So, if
-you first ask for MIME type M in the Accept header, a cache entry is
-created, and then perform a second request to the same resource asking
-for a different MIME type, you'd get the content cached for M.
-
-The `:format` parameter is taken into account though. The safest
-way to cache by MIME type is to pass the format in the route.
+Note: Both the `:format` param and the `Accept` header are taken
+into account when caching the fragment with the `:format` having
+precedence. For backwards compatibility when the `Accept` header
+indicates a HTML request the fragment is stored without the
+extension but if an explicit `"html"` is passed in `:format` then
+that _is_ used for storing the fragment.
 
 Contributing
 ------------
@@ -119,5 +125,5 @@ Contributing
 Code Status
 -----------
 
-* [![Build Status](https://travis-ci.org/rails/actionpack-action_caching.png?branch=master)](https://travis-ci.org/rails/actionpack-action_caching)
-* [![Dependency Status](https://gemnasium.com/rails/actionpack-action_caching.png)](https://gemnasium.com/rails/actionpack-action_caching)
+* [![Build Status](https://travis-ci.org/rails/actionpack-action_caching.svg?branch=master)](https://travis-ci.org/rails/actionpack-action_caching)
+* [![Dependency Status](https://gemnasium.com/rails/actionpack-action_caching.svg)](https://gemnasium.com/rails/actionpack-action_caching)

data/Rakefile

@@ -1,11 +1,11 @@
 #!/usr/bin/env rake
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs = ['test']
-  t.pattern = 'test/**/*_test.rb'
-  t.ruby_opts = ['-w']
+  t.libs = ["test"]
+  t.pattern = "test/**/*_test.rb"
+  t.ruby_opts = ["-w"]
 end
 
 task default: :test

data/actionpack-action_caching.gemspec

@@ -1,22 +1,21 @@
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |gem|
-  gem.name          = 'actionpack-action_caching'
-  gem.version       = '1.1.1'
-  gem.author        = 'David Heinemeier Hansson'
-  gem.email         = 'david@loudthinking.com'
-  gem.description   = 'Action caching for Action Pack (removed from core in Rails 4.0)'
-  gem.summary       = 'Action caching for Action Pack (removed from core in Rails 4.0)'
-  gem.homepage      = 'https://github.com/rails/actionpack-action_caching'
+  gem.name          = "actionpack-action_caching"
+  gem.version       = "1.2.0"
+  gem.author        = "David Heinemeier Hansson"
+  gem.email         = "david@loudthinking.com"
+  gem.description   = "Action caching for Action Pack (removed from core in Rails 4.0)"
+  gem.summary       = "Action caching for Action Pack (removed from core in Rails 4.0)"
+  gem.homepage      = "https://github.com/rails/actionpack-action_caching"
 
+  gem.required_ruby_version = ">= 1.9.3"
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
-  gem.license       = 'MIT'
+  gem.require_paths = ["lib"]
+  gem.license       = "MIT"
 
-  gem.add_dependency 'actionpack', '>= 4.0.0', '< 5.0'
+  gem.add_dependency "actionpack", ">= 4.0.0", "< 6"
 
-  gem.add_development_dependency 'mocha'
-  gem.add_development_dependency 'activerecord', '>= 4.0.0.beta', '< 5'
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "activerecord", ">= 4.0.0", "< 6"
 end