Install rubocop and fix offenses

Using the rules from the main Rails repository.

Author: pixeltrix

.codeclimate.yml

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

.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

Gemfile

@@ -1,6 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rails'
+gem "rails"
 gem "mime-types", "< 3"

README.md

@@ -9,7 +9,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'actionpack-page_caching'
+gem "actionpack-page_caching"
 ```
 
 And then execute:
@@ -62,8 +62,8 @@ 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]
+    expire_page action: "show", id: params[:list][:id]
+    redirect_to action: "show", id: params[:list][:id]
   end
 end
 ```

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

actionpack-page_caching.gemspec

@@ -1,21 +1,19 @@
-# -*- 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.license       = 'MIT'
+  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.license       = "MIT"
 
   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.add_dependency 'actionpack', '>= 4.0.0', '< 5'
+  gem.add_dependency "actionpack", ">= 4.0.0", "< 5"
 
-  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency "mocha"
 end

gemfiles/Gemfile-4-0-stable

@@ -1,6 +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"

gemfiles/Gemfile-4-1-stable

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

gemfiles/Gemfile-4-2-stable

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

gemfiles/Gemfile-edge

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

lib/action_controller/caching/pages.rb

@@ -1,5 +1,5 @@
-require 'fileutils'
-require 'active_support/core_ext/class/attribute_accessors'
+require "fileutils"
+require "active_support/core_ext/class/attribute_accessors"
 
 module ActionController
   module Caching
@@ -32,8 +32,8 @@ module Caching
     #   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]
+    #       expire_page action: "show", id: params[:list][:id]
+    #       redirect_to action: "show", id: params[:list][:id]
     #     end
     #   end
     #
@@ -51,7 +51,7 @@ module Pages
         # likely require configuring your web server to look in the new location for
         # cached files.
         class_attribute :page_cache_directory
-        self.page_cache_directory ||= ''
+        self.page_cache_directory ||= ""
 
         # The compression used for gzip. If +false+ (default), the page is not compressed.
         # If can be a symbol showing the ZLib compression method, for example, <tt>:best_compression</tt>
@@ -63,29 +63,29 @@ module Pages
       module ClassMethods
         # Expires the page that was cached with the +path+ as a key.
         #
-        #   expire_page '/lists/show'
+        #   expire_page "/lists/show"
         def expire_page(path)
           return unless perform_caching
           path = page_cache_path(path)
 
           instrument_page_cache :expire_page, path do
             File.delete(path) if File.exist?(path)
-            File.delete(path + '.gz') if File.exist?(path + '.gz')
+            File.delete(path + ".gz") if File.exist?(path + ".gz")
           end
         end
 
         # Manually cache the +content+ in the key determined by +path+.
         #
-        #   cache_page "I'm the cached content", '/lists/show'
+        #   cache_page "I'm the cached content", "/lists/show"
         def cache_page(content, path, extension = nil, gzip = Zlib::BEST_COMPRESSION)
           return unless perform_caching
           path = page_cache_path(path, extension)
 
           instrument_page_cache :write_page, path do
             FileUtils.makedirs(File.dirname(path))
-            File.open(path, 'wb+') { |f| f.write(content) }
+            File.open(path, "wb+") { |f| f.write(content) }
             if gzip
-              Zlib::GzipWriter.open(path + '.gz', gzip) { |f| f.write(content) }
+              Zlib::GzipWriter.open(path + ".gz", gzip) { |f| f.write(content) }
             end
           end
         end
@@ -109,26 +109,27 @@ def caches_page(*actions)
           options = actions.extract_options!
 
           gzip_level = options.fetch(:gzip, page_cache_compression)
-          gzip_level = case gzip_level
-          when Symbol
-            Zlib.const_get(gzip_level.upcase)
-          when Fixnum
-            gzip_level
-          when false
-            nil
-          else
-            Zlib::BEST_COMPRESSION
-          end
+          gzip_level = \
+            case gzip_level
+            when Symbol
+              Zlib.const_get(gzip_level.upcase)
+            when Fixnum
+              gzip_level
+            when false
+              nil
+            else
+              Zlib::BEST_COMPRESSION
+            end
 
-          after_filter({only: actions}.merge(options)) do |c|
+          after_filter({ only: actions }.merge(options)) do |c|
             c.cache_page(nil, nil, gzip_level)
           end
         end
 
         private
           def page_cache_file(path, extension)
-            name = (path.empty? || path == '/') ? '/index' : URI.parser.unescape(path.chomp('/'))
-            unless (name.split('/').last || name).include? '.'
+            name = (path.empty? || path == "/") ? "/index" : URI.parser.unescape(path.chomp("/"))
+            unless (name.split("/").last || name).include? "."
               name << (extension || self.default_static_extension)
             end
             return name
@@ -139,13 +140,13 @@ def page_cache_path(path, extension = nil)
           end
 
           def instrument_page_cache(name, path)
-            ActiveSupport::Notifications.instrument("#{name}.action_controller", path: path){ yield }
+            ActiveSupport::Notifications.instrument("#{name}.action_controller", path: path) { yield }
           end
       end
 
       # Expires the page that was cached with the +options+ as a key.
       #
-      #   expire_page controller: 'lists', action: 'show'
+      #   expire_page controller: "lists", action: "show"
       def expire_page(options = {})
         return unless self.class.perform_caching
 
@@ -166,18 +167,19 @@ def expire_page(options = {})
       # the contents of response.body is used. If no options are provided, the url of the current
       # request being handled is used.
       #
-      #   cache_page "I'm the cached content", controller: 'lists', action: 'show'
+      #   cache_page "I'm the cached content", controller: "lists", action: "show"
       def cache_page(content = nil, options = nil, gzip = Zlib::BEST_COMPRESSION)
         return unless self.class.perform_caching && caching_allowed?
 
-        path = case options
+        path = \
+          case options
           when Hash
             url_for(options.merge(only_path: true, format: params[:format]))
           when String
             options
           else
             request.path
-        end
+          end
 
         if (type = Mime::LOOKUP[self.content_type]) && (type_symbol = type.symbol).present?
           extension = ".#{type_symbol}"

lib/action_controller/page_caching.rb

@@ -1,4 +1,4 @@
-require 'action_controller/caching/pages'
+require "action_controller/caching/pages"
 
 module ActionController
   module Caching

lib/actionpack/page_caching.rb

@@ -1 +1 @@
-require 'actionpack/page_caching/railtie'
+require "actionpack/page_caching/railtie"