actionpack-page_caching 1.1.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bcc463b295ac09cfa6b0ca15557d7e00da2bf92b
-  data.tar.gz: 1ca39e53842cb9446214249e47cfe791596e763e
+SHA256:
+  metadata.gz: 89bc2dc16c419dd0cc85e43d0318d2cf25698aadf2e5b52f79188038a4159bd9
+  data.tar.gz: 1ee8bbc284ae4ccf1249648779edd731dd856102886eda5ceffe6827b46c7bbb
 SHA512:
-  metadata.gz: cd19ec3f9214460795607de16e4d66769b7621cac4caa329ada8ec810b9414a6f1e5280b8132d683adcba70343b85750356c8d0d3d017f7d98ed199384ad1b14
-  data.tar.gz: afa5b80f7c9ce7c54e284fa35bc3c484d7c0552aff051999dd668edd99827059570b019a01e00da544d23c68a78e9427354f68e5b36981221fc808f38f283912
+  metadata.gz: c62d167b5f9b06ec6ae84253cab216544d9e887da74b5dc860fc75655bbea488349eb2b85cea21609ad4ce5fd4abe0c815acb09c05d489af968d7f5e8f1a6d52
+  data.tar.gz: adb8c87f834ad88955f8c0d8e5282b64a41ac5948e235d923647164d68d30bac56b4ee4b4de50b9d587a0c48e5835981162873c6f59e6e557d2e3af9d86e41e0

data/.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+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/.rubocop.yml

@@ -1,116 +1,192 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.4
   # 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:
+# Align `when` with `case`.
+Layout/CaseIndentation:
   Enabled: true
 
-# Do not use braces for hash literals when they are the last argument of a
-# method call.
-Style/BracesAroundHashParameters:
+Layout/ClosingHeredocIndentation:
   Enabled: true
 
-# Align `when` with `case`.
-Style/CaseIndentation:
+# Align comments with method definitions.
+Layout/CommentIndentation:
   Enabled: true
 
-# Align comments with method definitions.
-Style/CommentIndentation:
+Layout/ElseAlignment:
   Enabled: true
 
-# No extra empty lines.
-Style/EmptyLines:
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: only_before
+
+Layout/EmptyLinesAroundBlockBody:
   Enabled: true
 
 # In a regular class definition, no empty lines around the body.
-Style/EmptyLinesAroundClassBody:
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
   Enabled: true
 
 # In a regular module definition, no empty lines around the body.
-Style/EmptyLinesAroundModuleBody:
+Layout/EmptyLinesAroundModuleBody:
   Enabled: true
 
-# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
-Style/HashSyntax:
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/FirstArgumentIndentation:
   Enabled: true
 
 # Method definitions after `private` or `protected` isolated calls need one
 # extra level of indentation.
-Style/IndentationConsistency:
+Layout/IndentationConsistency:
   Enabled: true
-  EnforcedStyle: rails
+  EnforcedStyle: indented_internal_methods
 
 # Two spaces, no tabs (for indentation).
-Style/IndentationWidth:
+Layout/IndentationWidth:
   Enabled: true
 
-Style/SpaceAfterColon:
+Layout/LeadingCommentSpace:
   Enabled: true
 
-Style/SpaceAfterComma:
+Layout/SpaceAfterColon:
   Enabled: true
 
-Style/SpaceAroundEqualsInParameterDefault:
+Layout/SpaceAfterComma:
   Enabled: true
 
-Style/SpaceAroundKeyword:
+Layout/SpaceAfterSemicolon:
   Enabled: true
 
-Style/SpaceAroundOperators:
+Layout/SpaceAroundEqualsInParameterDefault:
   Enabled: true
 
-Style/SpaceBeforeFirstArg:
-    Enabled: true
-
-# Defining a method with parameters needs parentheses.
-Style/MethodDefParentheses:
+Layout/SpaceAroundKeyword:
   Enabled: true
 
 # Use `foo {}` not `foo{}`.
-Style/SpaceBeforeBlockBraces:
+Layout/SpaceBeforeBlockBraces:
   Enabled: true
 
-# Use `foo { bar }` not `foo {bar}`.
-Style/SpaceInsideBlockBraces:
+Layout/SpaceBeforeComma:
   Enabled: true
 
-# Use `{ a: 1 }` not `{a:1}`.
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceBeforeComment:
   Enabled: true
 
-Style/SpaceInsideParens:
+Layout/SpaceBeforeFirstArg:
   Enabled: true
 
-# Check quotes usage according to lint rule below.
-Style/StringLiterals:
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
   Enabled: true
-  EnforcedStyle: double_quotes
 
 # Detect hard tabs, no hard tabs.
-Style/Tab:
+Layout/Tab:
   Enabled: true
 
-# Blank lines should not have any spaces.
-Style/TrailingBlankLines:
+# Empty lines should not have any spaces.
+Layout/TrailingEmptyLines:
   Enabled: true
 
 # No trailing whitespace.
-Style/TrailingWhitespace:
+Layout/TrailingWhitespace:
   Enabled: true
 
-# Use quotes for string literals when they are enough.
-Style/UnneededPercentQ:
+Lint/AmbiguousOperator:
   Enabled: true
 
-# Align `end` with the matching keyword or starting expression except for
-# assignments, where it should be aligned with the LHS.
-Lint/EndAlignment:
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
   Enabled: true
-  AlignWith: variable
 
 # Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
 Lint/RequireParentheses:
   Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantFreeze:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  Enabled: true

data/CHANGELOG.md

@@ -1,36 +1,89 @@
-## 1.1.0 (January 23, 2017)
+## 1.2.4 (May 15, 2021)
 
-*   Support dynamic `page_cache_directory` using a Proc, Symbol or callable
+- Fix `URI.parser` deprecation warning in Rails 6.1
 
-    *Andrew White*
+  _Andrew White_
 
-*   Support instance level setting of `page_cache_directory`
+## 1.2.3 (June 12, 2020)
 
-    *Andrew White*
+- Simplifies code in `page_caching.rb`
 
-*   Add support for Rails 5.0 and master
+  _Xavier Noria_
 
-    *Andrew White*
+## 1.2.2 (May 6, 2020)
 
+- Fix variable name
 
-## 1.0.2 (November 15, 2013)
+  _Jack McCracken_
 
-*   Fix load order problem with other gems.
+## 1.2.1 (May 6, 2020)
 
-    *Rafael Mendonça França*
+- Only write relative URIs when their normalized path begins with the normalized cache directory path
 
+  _Jack McCracken_
 
-## 1.0.1 (October 24, 2013)
+## 1.2.0 (December 11, 2019)
+
+- Update RuboCop config
+
+  _Rafael Mendonça França_
+
+- Fix for Rails 6 MIME lookups
+
+  _Rob Zolkos_
+
+- Remove Rails 4.2 from testing matrix
+
+  _Rob Zolkos_
+
+- Minimum of Ruby 2.4 required
+
+  _Rob Zolkos_
+
+- Remove upper dependency for `actionpack`
+
+  _Anton Kolodii_
+
+## 1.1.1 (September 25, 2018)
+
+- Fixes handling of several forward slashes as root path
+
+  _Xavier Noria_
 
-*   Add Railtie to set `page_cache_directory` by default to `public` folder.
+- Documentation overhaul
+
+  _Xavier Noria_
+
+## 1.1.0 (January 23, 2017)
+
+- Support dynamic `page_cache_directory` using a Proc, Symbol or callable
+
+  _Andrew White_
+
+- Support instance level setting of `page_cache_directory`
+
+  _Andrew White_
+
+- Add support for Rails 5.0 and master
+
+  _Andrew White_
+
+## 1.0.2 (November 15, 2013)
+
+- Fix load order problem with other gems.
+
+  _Rafael Mendonça França_
+
+## 1.0.1 (October 24, 2013)
 
-    Fixes #5.
+- Add Railtie to set `page_cache_directory` by default to `public` folder.
 
-    *Žiga Vidic*
+  Fixes #5.
 
+  _Žiga Vidic_
 
 ## 1.0.0 (February 27, 2013)
 
-*   Extract Action Pack - Action Caching from Rails core.
+- Extract Action Pack - Action Caching from Rails core.
 
-    *Francesco Rodriguez*, *Rafael Mendonça França*, *Michiel Sikkes*
+  _Francesco Rodriguez_, _Rafael Mendonça França_, _Michiel Sikkes_

data/Gemfile

@@ -3,3 +3,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rails"
+gem "rubocop", ">= 0.77.0", require: false

data/README.md

@@ -1,12 +1,41 @@
-actionpack-page_caching
-=======================
+# actionpack-page_caching
 
 Static page caching for Action Pack (removed from core in Rails 4.0).
 
-Installation
-------------
+## Introduction
+
+Page caching is an approach to caching in which response bodies are stored in
+files that the web server can serve directly:
+
+1. A request to endpoint _E_ arrives.
+2. Its response is calculated and stored in a file _F_.
+3. Next time _E_ is requested, the web server sends _F_ directly.
+
+That applies only to GET or HEAD requests whose response code is 200, the rest
+are ignored.
+
+Unlike caching proxies or other more sophisticated setups, page caching results
+in a dramatic speed up while being dead simple at the same time. Awesome
+cost/benefit.
+
+The reason for such performance boost is that cached endpoints are
+short-circuited by the web server, which is very efficient at serving static
+files. Requests to cached endpoints do not even reach your Rails application.
 
-Add this line to your application's Gemfile:
+This technique, however, is only suitable for pages that do not need to go
+through your Rails stack, precisely. For example, content management systems
+like wikis have typically many pages that are a great fit for this approach, but
+account-based systems where people log in and manipulate their own data are
+often less likely candidates. As a use case you can check, [Rails
+Contributors](https://contributors.rubyonrails.org/) makes heavy use of page
+caching. Its source code is [here](https://github.com/rails/rails-contributors).
+
+It is not all or nothing, though, in HTML cached pages JavaScript can still
+tweak details here and there dynamically as a trade-off.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
 
 ``` ruby
 gem "actionpack-page_caching"
@@ -14,39 +43,71 @@ gem "actionpack-page_caching"
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
+
+## Usage
+
+### Enable Caching
+
+Page caching needs caching enabled:
+
+```ruby
+config.action_controller.perform_caching = true
+```
+
+That goes typically in `config/environments/production.rb`, but you can activate
+that flag in any mode.
+
+Since Rails 5 there is a special toggler to easily enable/disable caching in
+`development` mode without editing its configuration file. Just execute
+
+```
+$ bin/rails dev:cache
+```
+
+to enable/disable caching in `development` mode.
+
+### Configure the Cache Directory
 
-Or install it yourself as:
+#### Default Cache Directory
 
-    $ gem install actionpack-page_caching
+By default, files are stored below the `public` directory of your Rails
+application, with a path that matches the one in the URL.
 
-Usage
------
+For example, a page-cached request to `/posts/what-is-new-in-rails-6` would be
+stored by default in the file `public/posts/what-is-new-in-rails-6.html`, and
+the web server would be configured to check that path in the file system before
+falling back to Rails. More on this later.
 
-Page caching is an approach to caching where the entire action output is
-stored as a HTML file that the web server can serve without going through
-Action Pack. This is the fastest way to cache your content as opposed to going
-dynamically through the process of generating the content. Unfortunately, this
-incredible speed-up is only available to stateless pages where all visitors are
-treated the same. Content management systems -- including weblogs and wikis --
-have many pages that are a great fit for this approach, but account-based systems
-where people log in and manipulate their own data are often less likely candidates.
+#### Custom Cache Directory
 
-First you need to set `page_cache_directory` in your configuration file:
+The default page caching directory can be overridden:
 
 ``` ruby
-config.action_controller.page_cache_directory = "#{Rails.root}/public/cached_pages"
+config.action_controller.page_cache_directory = Rails.root.join("public", "cached_pages")
 ```
 
-The `page_cache_directory` setting can be used with a Proc:
+There is no need to ensure the directory exists when the application boots,
+whenever a page has to be cached, the page cache directory is created if needed.
+
+#### Custom Cache Directory per Controller
+
+The globally configured cache directory, default or custom, can be overridden in
+each controller. There are three ways of doing this.
+
+With a lambda:
 
 ``` ruby
 class WeblogController < ApplicationController
-  self.page_cache_directory = -> { Rails.root.join("public", request.domain) }
+  self.page_cache_directory = -> {
+    Rails.root.join("public", request.domain)
+  }
 end
 ```
 
-a Symbol:
+a symbol:
 
 ``` ruby
 class WeblogController < ApplicationController
@@ -73,7 +134,11 @@ class WeblogController < ApplicationController
 end
 ```
 
-Specifying which actions to cache is done through the `caches_page` class method:
+Intermediate directories are created as needed also in this case.
+
+### Specify Actions to be Cached
+
+Specifying which actions have to be cached is done through the `caches_page` class method:
 
 ``` ruby
 class WeblogController < ActionController::Base
@@ -81,17 +146,44 @@ class WeblogController < ActionController::Base
 end
 ```
 
-This will generate cache files such as `weblog/show/5.html` and
-`weblog/new.html`, which match the URLs used that would normally trigger
-dynamic page generation. Page caching works by configuring a web server to first
-check for the existence of files on disk, and to serve them directly when found,
-without passing the request through to Action Pack. This is much faster than
-handling the full dynamic request in the usual way.
+### Configure The Web Server
+
+The [wiki](https://github.com/rails/actionpack-page_caching/wiki) of the project
+has some examples of web server configuration.
+
+### Cache Expiration
+
+Expiration of the cache is handled by deleting the cached files, which results
+in a lazy regeneration approach in which the content is stored again as cached
+endpoints are hit.
 
-Expiration of the cache is handled by deleting the cached file, which results
-in a lazy regeneration approach where the cache is not restored before another
-hit is made against it. The API for doing so mimics the options from `url_for`
-and friends:
+#### Full Cache Expiration
+
+If the cache is stored in a separate directory like `public/cached_pages`, you
+can easily expire the whole thing by removing said directory.
+
+Removing a directory recursively with something like `rm -rf` is unreliable
+because that operation is not atomic and can mess up with concurrent page cache
+generation.
+
+In POSIX systems moving a file is atomic, so the recommended approach would be
+to move the directory first out of the way, and then recursively delete that
+one. Something like
+
+```bash
+#!/bin/bash
+
+tmp=public/cached_pages-$(date +%s)
+mv public/cached_pages $tmp
+rm -rf $tmp
+```
+
+As noted before, the page cache directory is created if it does not exist, so
+moving the directory is enough to have a clean cache, no need to recreate.
+
+#### Fine-grained Cache Expiration
+
+The API for doing so mimics the options from `url_for` and friends:
 
 ``` ruby
 class WeblogController < ActionController::Base
@@ -103,12 +195,10 @@ class WeblogController < ActionController::Base
 end
 ```
 
-Additionally, you can expire caches using [Sweepers](https://github.com/rails/rails-observers#action-controller-sweeper)
-that act on changes in the model to determine when a cache is supposed to be expired.
-
-Finally, configure your web server to serve these static pages when they are present
-rather than the original files. See the [project wiki][1] for example configurations.
-[1]: https://github.com/rails/actionpack-page_caching/wiki
+Additionally, you can expire caches using
+[Sweepers](https://github.com/rails/rails-observers#action-controller-sweeper)
+that act on changes in the model to determine when a cache is supposed to be
+expired.
 
 Contributing
 ------------
@@ -122,5 +212,4 @@ Contributing
 Code Status
 -----------
 
-* [![Build Status](https://travis-ci.org/rails/actionpack-page_caching.svg?branch=master)](https://travis-ci.org/rails/actionpack-page_caching)
-* [![Dependency Status](https://gemnasium.com/rails/actionpack-page_caching.svg)](https://gemnasium.com/rails/actionpack-page_caching)
+* [![Build Status](https://github.com/rails/actionpack-page_caching/actions/workflows/ci.yml/badge.svg)](https://github.com/rails/actionpack-page_caching/actions/workflows/ci.yml)

data/actionpack-page_caching.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "actionpack-page_caching"
-  gem.version       = "1.1.0"
+  gem.version       = "1.2.4"
   gem.author        = "David Heinemeier Hansson"
   gem.email         = "david@loudthinking.com"
   gem.description   = "Static page caching for Action Pack (removed from core in Rails 4.0)"
@@ -8,14 +8,14 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/rails/actionpack-page_caching"
   gem.license       = "MIT"
 
-  gem.required_ruby_version = '>= 1.9.3'
+  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.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.license       = 'MIT'
+  gem.license       = "MIT"
 
-  gem.add_dependency "actionpack", ">= 4.0.0", "< 6"
+  gem.add_dependency "actionpack", ">= 4.0.0"
 
   gem.add_development_dependency "mocha"
 end

data/gemfiles/Gemfile-4-2-stable

@@ -3,8 +3,3 @@ source "https://rubygems.org"
 gemspec path: ".."
 
 gem "rails", github: "rails/rails", branch: "4-2-stable"
-gem "mime-types", "< 3"
-
-if RUBY_VERSION < "2.1"
-  gem "nokogiri", "< 1.7"
-end

data/gemfiles/Gemfile-5-1-stable

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", github: "rails/rails", branch: "5-1-stable"

data/gemfiles/Gemfile-5-2-stable

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", github: "rails/rails", branch: "5-2-stable"

data/gemfiles/Gemfile-6-0-stable

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", github: "rails/rails", branch: "6-0-stable"

data/gemfiles/Gemfile-6-1-stable

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", github: "rails/rails", branch: "6-1-stable"

data/gemfiles/Gemfile-edge

@@ -2,5 +2,4 @@ source "https://rubygems.org"
 
 gemspec path: ".."
 
-gem "rails", github: "rails/rails", branch: "master"
-gem "arel", github: "rails/arel", branch: "master"
+gem "rails", github: "rails/rails", branch: "main"

data/lib/action_controller/caching/pages.rb

@@ -93,6 +93,10 @@ module ActionController
             end
           end
 
+          def normalized_cache_directory
+            File.expand_path(cache_directory)
+          end
+
           def handle_proc_cache_directory
             if @controller
               @controller.instance_exec(&@cache_directory)
@@ -136,15 +140,13 @@ module ActionController
             MSG
           end
 
-          def default_extension
-            @default_extension
-          end
+          attr_reader :default_extension
 
           def cache_file(path, extension)
-            if path.empty? || path == "/"
+            if path.empty? || path =~ %r{\A/+\z}
               name = "/index"
             else
-              name = URI.parser.unescape(path.chomp("/"))
+              name = URI::DEFAULT_PARSER.unescape(path.chomp("/"))
             end
 
             if File.extname(name).empty?
@@ -155,15 +157,22 @@ module ActionController
           end
 
           def cache_path(path, extension = nil)
-            File.join(cache_directory, cache_file(path, extension))
+            unnormalized_path = File.join(normalized_cache_directory, cache_file(path, extension))
+            normalized_path = File.expand_path(unnormalized_path)
+
+            normalized_path if normalized_path.start_with?(normalized_cache_directory)
           end
 
           def delete(path)
+            return unless path
+
             File.delete(path) if File.exist?(path)
             File.delete(path + ".gz") if File.exist?(path + ".gz")
           end
 
           def write(content, path, gzip)
+            return unless path
+
             FileUtils.makedirs(File.dirname(path))
             File.open(path, "wb+") { |f| f.write(content) }
 
@@ -275,7 +284,13 @@ module ActionController
               request.path
             end
 
-          if (type = Mime::LOOKUP[self.content_type]) && (type_symbol = type.symbol).present?
+          type = if self.respond_to?(:media_type)
+            Mime::LOOKUP[self.media_type]
+          else
+            Mime::LOOKUP[self.content_type]
+          end
+
+          if type && (type_symbol = type.symbol).present?
             extension = ".#{type_symbol}"
           end
 

data/lib/action_controller/page_caching.rb

@@ -2,12 +2,8 @@ require "action_controller/caching/pages"
 
 module ActionController
   module Caching
-    eager_autoload do
-      autoload :Pages
-    end
-
     include Pages
   end
 end
 
-ActionController::Base.send(:include, ActionController::Caching::Pages)
+ActionController::Base.include(ActionController::Caching::Pages)

data/test/caching_test.rb

@@ -1,11 +1,14 @@
+require "rails/version"
 require "abstract_unit"
-require "mocha/setup"
+require "mocha/minitest"
+require "find"
 
 CACHE_DIR = "test_cache"
 # Don't change "../tmp" cavalierly or you might hose something you don't want hosed
 TEST_TMP_DIR = File.expand_path("../tmp", __FILE__)
 FILE_STORE_PATH = File.join(TEST_TMP_DIR, CACHE_DIR)
 
+
 module PageCachingTestHelpers
   def setup
     super
@@ -24,7 +27,6 @@ module PageCachingTestHelpers
   end
 
   private
-
     def assert_page_cached(action, options = {})
       expected = options[:content] || action.to_s
       path = cache_file(action, options)
@@ -176,6 +178,28 @@ class PageCachingTest < ActionController::TestCase
   include PageCachingTestHelpers
   tests PageCachingTestController
 
+  def test_cache_does_not_escape
+    draw do
+      get "/page_caching_test/ok/:id", to: "page_caching_test#ok"
+    end
+
+    project_root = File.expand_path("../../", __FILE__)
+
+    # Make a path that escapes the cache directory
+    get_to_root = "../../../"
+
+    # Make sure this relative path points at the project root
+    assert_equal project_root, File.expand_path(File.join(FILE_STORE_PATH, get_to_root))
+
+    if Rails.version =~ /^4\./
+      get :ok, id: "#{get_to_root}../pwnd"
+    else
+      get :ok, params: { id: "#{get_to_root}../pwnd" }
+    end
+
+    assert_predicate Find.find(File.join(project_root, "test")).grep(/pwnd/), :empty?
+  end
+
   def test_page_caching_resources_saves_to_correct_path_with_extension_even_if_default_route
     draw do
       get "posts.:format", to: "posts#index", as: :formatted_posts
@@ -330,19 +354,17 @@ class PageCachingTest < ActionController::TestCase
   end
 
   def test_page_caching_directory_set_as_pathname
-    begin
-      ActionController::Base.page_cache_directory = Pathname.new(FILE_STORE_PATH)
+    ActionController::Base.page_cache_directory = Pathname.new(FILE_STORE_PATH)
 
-      draw do
-        get "/page_caching_test/ok", to: "page_caching_test#ok"
-      end
-
-      get :ok
-      assert_response :ok
-      assert_page_cached :ok
-    ensure
-      ActionController::Base.page_cache_directory = FILE_STORE_PATH
+    draw do
+      get "/page_caching_test/ok", to: "page_caching_test#ok"
     end
+
+    get :ok
+    assert_response :ok
+    assert_page_cached :ok
+  ensure
+    ActionController::Base.page_cache_directory = FILE_STORE_PATH
   end
 
   def test_page_caching_directory_set_on_controller_instance

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionpack-page_caching
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.4
 platform: ruby
 authors:
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2021-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -51,19 +45,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - actionpack-page_caching.gemspec
-- gemfiles/Gemfile-4-0-stable
-- gemfiles/Gemfile-4-1-stable
 - gemfiles/Gemfile-4-2-stable
 - gemfiles/Gemfile-5-0-stable
+- gemfiles/Gemfile-5-1-stable
+- gemfiles/Gemfile-5-2-stable
+- gemfiles/Gemfile-6-0-stable
+- gemfiles/Gemfile-6-1-stable
 - gemfiles/Gemfile-edge
 - lib/action_controller/caching/pages.rb
 - lib/action_controller/page_caching.rb
@@ -76,7 +72,7 @@ homepage: https://github.com/rails/actionpack-page_caching
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,9 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Static page caching for Action Pack (removed from core in Rails 4.0)
 test_files:

data/.travis.yml

@@ -1,64 +0,0 @@
-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-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:
-    on_success: change
-    on_failure: always
-    channels:
-      - "irc.freenode.org#rails-contrib"
-  campfire:
-    on_success: change
-    on_failure: always
-    rooms:
-      - secure: "eRCx+FMvH50pmLu0GZTF7NN+2X+CesgodYUlHvCr5EXQ0ZO/YUmeW8vAh/N8\njSrLWYpk/4P/JA63JGWsvFor/zpkTnfwzX3LWgw04GV0V3T9jsn9CD2Coiu6\nFll5u4fUCUwpfbB4RlCkjvFdQmW+F9mmbRGMCDO5CmuPHOyyPH0="

data/gemfiles/Gemfile-4-0-stable

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: ".."
-
-gem "rails", github: "rails/rails", branch: "4-0-stable"
-gem "mime-types", "< 3"

data/gemfiles/Gemfile-4-1-stable

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: ".."
-
-gem "rails", github: "rails/rails", branch: "4-1-stable"
-gem "mime-types", "< 3"