actionpack-action_caching 1.0.0 → 1.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5a35e289d60b7b914b0b671d816c17e0abcdf42a97e6b8be14a255e230858c8
+  data.tar.gz: 4fe16b31cfac741be48dedc405659ef387b18c0f2199817f4b8b0987da5e1e5e
+SHA512:
+  metadata.gz: 0ac9a52dd25c03562d88acd255c1c1ae69d21753da1498858c1ef6d56c0937ed206a73238bd86cac92fe8b88afdddf991a35450a60a7402246e131af625287ba
+  data.tar.gz: e11f0ccd152d9ff6e9a0f3411e3099f5dde36b9bf7cbad4bf2711e9801e673d2d21f532a816054b53722a716526752d0f1c42b4c90eddb139b1fddad7967a5df

data/.codeclimate.yml

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

data/.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        gemfile:
+          - '4-2-stable'
+          - '5-0-stable'
+          - '5-1-stable'
+          - '5-2-stable'
+          - '6-0-stable'
+          - '6-1-stable'
+          - 'edge'
+        ruby:
+          - '2.4'
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+        exclude:
+          - gemfile: '4-2-stable'
+            ruby: '2.5'
+          - gemfile: '4-2-stable'
+            ruby: '2.6'
+          - gemfile: '4-2-stable'
+            ruby: '2.7'
+          - gemfile: '4-2-stable'
+            ruby: '3.0'
+          - gemfile: '5-0-stable'
+            ruby: '2.7'
+          - gemfile: '5-0-stable'
+            ruby: '3.0'
+          - gemfile: '5-1-stable'
+            ruby: '2.7'
+          - gemfile: '5-1-stable'
+            ruby: '3.0'
+          - gemfile: '5-2-stable'
+            ruby: '2.7'
+          - gemfile: '5-2-stable'
+            ruby: '3.0'
+          - gemfile: '6-0-stable'
+            ruby: '2.4'
+          - gemfile: '6-1-stable'
+            ruby: '2.4'
+          - gemfile: 'edge'
+            ruby: '2.4'
+          - gemfile: 'edge'
+            ruby: '2.5'
+          - gemfile: 'edge'
+            ruby: '2.6'
+      fail-fast: false
+
+    runs-on: ubuntu-latest
+    name: ${{ matrix.ruby }} rails-${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          bundler: ${{ fromJSON('["2", "1"]')[matrix.ruby == '2.4'] }}
+
+      - run: bundle exec rake test
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/Gemfile-${{ matrix.gemfile }}
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3

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/CHANGELOG.md

@@ -0,0 +1,81 @@
+## 1.2.2 (May 10, 2021)
+
+*   Add support for Rails 6.1
+
+    *Jonathan Fleckenstein*, *Prem Sichanugrist*
+
+
+## 1.2.1 (November 12, 2019)
+
+*   Fix HTML escaping when `:layout` is `false`.
+
+    *Anton Katunin*
+
+*   Add support to Rails 6.
+
+    *Jacob Bednarz*
+
+
+## 1.2.0 (January 23, 2017)
+
+*   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 (November 1, 2013)
+
+*   Allow to use non-proc object in `cache_path` option. You can pass an object that
+    responds to a `call` method.
+
+    Example:
+
+        class CachePath
+          def call(controller)
+            controller.id
+          end
+        end
+
+        class TestController < ApplicationController
+          caches_action :index, :cache_path => CachePath.new
+          def index; end
+        end
+
+    *Piotr Niełacny*
+
+
+## 1.0.0 (February 28, 2013)
+
+*   Extract Action Pack - Action Caching from Rails core.
+
+    *Francesco Rodriguez*

data/Gemfile

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

data/README.md

@@ -1,14 +1,16 @@
 actionpack-action_caching
 =========================
 
-Action caching for Action Pack (removed from core in Rails 4.0)
+Action caching for Action Pack (removed from core in Rails 4.0).
 
 Installation
 ------------
 
 Add this line to your application's Gemfile:
 
-    gem 'actionpack-action_caching'
+```ruby
+gem 'actionpack-action_caching'
+```
 
 And then execute:
 
@@ -28,12 +30,14 @@ that filters run before the cache is served, which allows for
 authentication and other restrictions on whether someone is allowed
 to execute such action.
 
-    class ListsController < ApplicationController
-      before_filter :authenticate, except: :public
+```ruby
+class ListsController < ApplicationController
+  before_action :authenticate, except: :public
 
-      caches_page   :public
-      caches_action :index, :show
-    end
+  caches_page   :public
+  caches_action :index, :show
+end
+```
 
 In this example, the `public` action doesn't require authentication
 so it's possible to use the faster page caching. On the other hand
@@ -54,56 +58,66 @@ 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.
 
 The following example depicts some of the points made above:
 
-    class ListsController < ApplicationController
-      before_filter :authenticate, except: :public
+```ruby
+class ListsController < ApplicationController
+  before_action :authenticate, except: :public
 
-      caches_page :public
+  # simple fragment cache
+  caches_action :current
 
-      caches_action :index, if: Proc.new do
-        !request.format.json?  # cache if is not a JSON request
-      end
+  # expire cache after an hour
+  caches_action :archived, expires_in: 1.hour
+
+  # cache unless it's a JSON request
+  caches_action :index, unless: -> { request.format.json? }
+
+  # 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])
-        end
+  # 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
+```
 
 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
 ------------
@@ -113,3 +127,8 @@ Contributing
 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.
+
+Code Status
+-----------
+
+* [![Build Status](https://travis-ci.org/rails/actionpack-action_caching.svg?branch=master)](https://travis-ci.org/rails/actionpack-action_caching)