actionpack-page_caching 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 781564cc88b5d47624ce552331dbbf58634f5891
-  data.tar.gz: f7dfd38f06481f38eef9f7630258dae673ecd881
+  metadata.gz: bcc463b295ac09cfa6b0ca15557d7e00da2bf92b
+  data.tar.gz: 1ca39e53842cb9446214249e47cfe791596e763e
 SHA512:
-  metadata.gz: 96c15cb3d1b344f31655c04b265ba1c3fb6484726880af6a36165eefcc3dfbbff89851fd47de410429c2a3c1e75e0baa038ef23ecb3b0fbf75c69ed7e9c3c708
-  data.tar.gz: d005f7998314f2311492592d958b78397934de01bec68f16806ef5b99ee122e426007bdaecbad7a5d71e2309b53fe56d3bad0b7ce0ca7395fb153cc462082826
+  metadata.gz: cd19ec3f9214460795607de16e4d66769b7621cac4caa329ada8ec810b9414a6f1e5280b8132d683adcba70343b85750356c8d0d3d017f7d98ed199384ad1b14
+  data.tar.gz: afa5b80f7c9ce7c54e284fa35bc3c484d7c0552aff051999dd668edd99827059570b019a01e00da544d23c68a78e9427354f68e5b36981221fc808f38f283912

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-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,11 +1,36 @@
-# 1.0.2
+## 1.1.0 (January 23, 2017)
 
-* Fix load order problem with other gems.
+*   Support dynamic `page_cache_directory` using a Proc, Symbol or callable
 
-# 1.0.1
+    *Andrew White*
 
-* Add Railtie to set `page_cache_directory` by default to `public` folder. (Fixes #5)
+*   Support instance level setting of `page_cache_directory`
 
-# 1.0.0
+    *Andrew White*
 
-* First Release
+*   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)
+
+*   Add Railtie to set `page_cache_directory` by default to `public` folder.
+
+    Fixes #5.
+
+    *Žiga Vidic*
+
+
+## 1.0.0 (February 27, 2013)
+
+*   Extract Action Pack - Action Caching from Rails core.
+
+    *Francesco Rodriguez*, *Rafael Mendonça França*, *Michiel Sikkes*

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,14 @@ actionpack-page_caching
 
 Static page 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-page_caching'
+``` ruby
+gem "actionpack-page_caching"
+```
 
 And then execute:
 
@@ -23,7 +23,7 @@ Or install it yourself as:
 Usage
 -----
 
-Page caching is an approach to caching where the entire action output of is
+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
@@ -34,13 +34,52 @@ where people log in and manipulate their own data are often less likely candidat
 
 First you need to set `page_cache_directory` in your configuration file:
 
-    config.action_controller.page_cache_directory = "#{Rails.root.to_s}/public/deploy"
+``` ruby
+config.action_controller.page_cache_directory = "#{Rails.root}/public/cached_pages"
+```
 
-Specifying which actions to cache is done through the `caches_page` class method:
+The `page_cache_directory` setting can be used with a Proc:
+
+``` ruby
+class WeblogController < ApplicationController
+  self.page_cache_directory = -> { Rails.root.join("public", request.domain) }
+end
+```
+
+a Symbol:
 
-    class WeblogController < ActionController::Base
-      caches_page :show, :new
+``` ruby
+class WeblogController < ApplicationController
+  self.page_cache_directory = :domain_cache_directory
+
+  private
+    def domain_cache_directory
+      Rails.root.join("public", request.domain)
     end
+end
+```
+
+or a callable object:
+
+``` ruby
+class DomainCacheDirectory
+  def self.call(request)
+    Rails.root.join("public", request.domain)
+  end
+end
+
+class WeblogController < ApplicationController
+  self.page_cache_directory = DomainCacheDirectory
+end
+```
+
+Specifying which actions to cache is done through the `caches_page` class method:
+
+``` ruby
+class WeblogController < ActionController::Base
+  caches_page :show, :new
+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
@@ -54,17 +93,23 @@ 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:
 
-    class WeblogController < ActionController::Base
-      def update
-        List.update(params[:list][:id], params[:list])
-        expire_page action: 'show', id: params[:list][:id]
-        redirect_to action: 'show', id: params[:list][:id]
-      end
-    end
+``` ruby
+class WeblogController < ActionController::Base
+  def update
+    List.update(params[:list][:id], params[:list])
+    expire_page action: "show", id: params[:list][:id]
+    redirect_to action: "show", id: params[:list][:id]
+  end
+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
+
 Contributing
 ------------
 
@@ -77,5 +122,5 @@ Contributing
 Code Status
 -----------
 
-* [![Build Status](https://travis-ci.org/rails/actionpack-page_caching.png?branch=master)](https://travis-ci.org/rails/page_caching)
-* [![Dependency Status](https://gemnasium.com/rails/actionpack-page_caching.png)](https://gemnasium.com/rails/actionpack-page_caching)
+* [![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)

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-page_caching.gemspec

@@ -1,20 +1,21 @@
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |gem|
-  gem.name          = 'actionpack-page_caching'
-  gem.version       = '1.0.2'
-  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)'
-  gem.summary       = 'Static page caching for Action Pack (removed from core in Rails 4.0)'
-  gem.homepage      = 'https://github.com/rails/actionpack-page_caching'
+  gem.name          = "actionpack-page_caching"
+  gem.version       = "1.1.0"
+  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)"
+  gem.summary       = "Static page caching for Action Pack (removed from core in Rails 4.0)"
+  gem.homepage      = "https://github.com/rails/actionpack-page_caching"
+  gem.license       = "MIT"
 
+  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.require_paths = ["lib"]
+  gem.license       = 'MIT'
 
-  gem.add_dependency 'actionpack', '>= 4.0.0', '< 5'
+  gem.add_dependency "actionpack", ">= 4.0.0", "< 6"
 
-  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency "mocha"
 end

data/gemfiles/Gemfile-4-0-stable

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