Enforce Style/FrozenStringLiteralComment. (#6265)

Merge pull request 6265

.rubocop.yml

@@ -9,6 +9,7 @@ AllCops:
     - benchmark/**/*
     - script/**/*
     - vendor/**/*
+    - tmp/**/*
 Layout/AlignArray:
   Enabled: false
 Layout/AlignHash:
@@ -99,6 +100,9 @@ Style/BracesAroundHashParameters:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
 Style/Documentation:
   Enabled: false
   Exclude:

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 gemspec :name => "jekyll"
 

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rubygems"
 require "rake"
 require "rdoc"

exe/jekyll

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 STDOUT.sync = true
 
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)

features/step_definitions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Before do
   FileUtils.rm_rf(Paths.test_dir) if Paths.test_dir.exist?
   FileUtils.mkdir_p(Paths.test_dir) unless Paths.test_dir.directory?

features/support/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "fileutils"
 require "colorator"
 require "cucumber/formatter/console"

features/support/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "fileutils"
 require "jekyll"
 require "time"
@@ -107,7 +109,8 @@ def run_in_shell(*args)
 
   File.write(Paths.status_file, p.exitstatus)
   File.open(Paths.output_file, "wb") do |f|
-    f.puts "$ " << args.join(" ")
+    f.print "$ "
+    f.puts args.join(" ")
     f.puts output
     f.puts "EXIT STATUS: #{p.exitstatus}"
   end

jekyll.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

lib/jekyll.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift __dir__ # For use/testing when no gem is installed
 
 # Require all of the Ruby files in the given directory.
@@ -162,8 +164,9 @@ module Jekyll
     def sanitized_path(base_directory, questionable_path)
       return base_directory if base_directory.eql?(questionable_path)
 
-      questionable_path.insert(0, "/") if questionable_path.start_with?("~")
+      clean_path = questionable_path.dup
-      clean_path = File.expand_path(questionable_path, "/")
+      clean_path.insert(0, "/") if clean_path.start_with?("~")
+      clean_path = File.expand_path(clean_path, "/")
 
       return clean_path if clean_path.eql?(base_directory)
 

lib/jekyll/cleaner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "set"
 
 module Jekyll

lib/jekyll/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Collection
     attr_reader :site, :label, :metadata

lib/jekyll/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Command
     class << self

lib/jekyll/commands/build.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Commands
     class Build < Command

lib/jekyll/commands/clean.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Commands
     class Clean < Command

lib/jekyll/commands/doctor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "addressable/uri"
 
 module Jekyll

lib/jekyll/commands/help.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Commands
     class Help < Command

lib/jekyll/commands/new.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "erb"
 
 module Jekyll

lib/jekyll/commands/new_theme.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "erb"
 
 class Jekyll::Commands::NewTheme < Jekyll::Command

lib/jekyll/commands/serve.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Commands
     class Serve < Command

lib/jekyll/commands/serve/servlet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "webrick"
 
 module Jekyll

lib/jekyll/configuration.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   class Configuration < Hash

lib/jekyll/converter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Converter < Plugin
     # Public: Get or set the highlighter prefix. When an argument is specified,

lib/jekyll/converters/identity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Converters
     class Identity < Converter

lib/jekyll/converters/markdown.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Converters
     class Markdown < Converter

lib/jekyll/converters/markdown/rdiscount_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Converters
     class Markdown

lib/jekyll/converters/markdown/redcarpet_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Jekyll::Converters::Markdown::RedcarpetParser
   module CommonMethods
     def add_code_tags(code, lang)
@@ -48,9 +50,7 @@ class Jekyll::Converters::Markdown::RedcarpetParser
     def block_code(code, lang)
       code = "<pre>#{super}</pre>"
 
-      output = "<div class=\"highlight\">"
+      "<div class=\"highlight\">#{add_code_tags(code, lang)}</div>"
-      output << add_code_tags(code, lang)
-      output << "</div>"
     end
 
     protected

lib/jekyll/converters/smartypants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Kramdown::Parser::SmartyPants < Kramdown::Parser::Kramdown
   def initialize(source, options)
     super

lib/jekyll/convertible.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 require "set"
 

lib/jekyll/deprecator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Deprecator
     extend self

lib/jekyll/document.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   class Document

lib/jekyll/drops/collection_drop.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   module Drops

lib/jekyll/drops/document_drop.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   module Drops

lib/jekyll/drops/drop.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   module Drops

lib/jekyll/drops/excerpt_drop.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   module Drops

lib/jekyll/drops/jekyll_drop.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   module Drops

lib/jekyll/drops/site_drop.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   module Drops

lib/jekyll/drops/static_file_drop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Drops
     class StaticFileDrop < Drop

lib/jekyll/drops/unified_payload_drop.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   module Drops

lib/jekyll/drops/url_drop.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   module Drops

lib/jekyll/entry_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class EntryFilter
     attr_reader :site

lib/jekyll/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Errors
     FatalException = Class.new(::RuntimeError)

lib/jekyll/excerpt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Excerpt
     extend Forwardable
@@ -117,7 +119,7 @@ module Jekyll
       if tail.empty?
         head
       else
-        "" << head << "\n\n" << tail.scan(%r!^ {0,3}\[[^\]]+\]:.+$!).join("\n")
+        head.to_s.dup << "\n\n" << tail.scan(%r!^ {0,3}\[[^\]]+\]:.+$!).join("\n")
       end
     end
   end

lib/jekyll/external.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module External
     class << self

lib/jekyll/filters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "addressable/uri"
 require "json"
 require "date"

lib/jekyll/filters/grouping_filters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Filters
     module GroupingFilters

lib/jekyll/filters/url_filters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "addressable/uri"
 
 module Jekyll

lib/jekyll/frontmatter_defaults.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   # This class handles custom defaults for YAML frontmatter settings.
   # These are set in _config.yml and apply both to internal use (e.g. layout)

lib/jekyll/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   Generator = Class.new(Plugin)
 end

lib/jekyll/hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Hooks
     DEFAULT_PRIORITY = 20

lib/jekyll/layout.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Layout
     include Convertible

lib/jekyll/liquid_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module LiquidExtensions
 

lib/jekyll/liquid_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll/liquid_renderer/file"
 require "jekyll/liquid_renderer/table"
 

lib/jekyll/liquid_renderer/file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class LiquidRenderer
     class File

lib/jekyll/liquid_renderer/table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class LiquidRenderer::Table
     def initialize(stats)
@@ -13,7 +15,7 @@ module Jekyll
     private
 
     def generate_table(data, widths)
-      str = "\n"
+      str = String.new("\n")
 
       table_head = data.shift
       str << generate_row(table_head, widths)
@@ -28,7 +30,7 @@ module Jekyll
     end
 
     def generate_table_head_border(row_data, widths)
-      str = ""
+      str = String.new("")
 
       row_data.each_index do |cell_index|
         str << "-" * widths[cell_index]
@@ -40,7 +42,7 @@ module Jekyll
     end
 
     def generate_row(row_data, widths)
-      str = ""
+      str = String.new("")
 
       row_data.each_with_index do |cell_data, cell_index|
         str << if cell_index.zero?

lib/jekyll/log_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class LogAdapter
     attr_reader :writer, :messages

lib/jekyll/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Page
     include Convertible

lib/jekyll/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Plugin
     PRIORITIES = {

lib/jekyll/plugin_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class PluginManager
     attr_reader :site

lib/jekyll/publisher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Publisher
     def initialize(site)

lib/jekyll/reader.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 require "csv"
 

lib/jekyll/readers/collection_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class CollectionReader
     SPECIAL_COLLECTIONS = %w(posts data).freeze

lib/jekyll/readers/data_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class DataReader
     attr_reader :site, :content

lib/jekyll/readers/layout_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class LayoutReader
     attr_reader :site

lib/jekyll/readers/page_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class PageReader
     attr_reader :site, :dir, :unfiltered_content

lib/jekyll/readers/post_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class PostReader
     attr_reader :site, :unfiltered_content

lib/jekyll/readers/static_file_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class StaticFileReader
     attr_reader :site, :dir, :unfiltered_content

lib/jekyll/readers/theme_assets_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class ThemeAssetsReader
     attr_reader :site

lib/jekyll/regenerator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Regenerator
     attr_reader :site, :metadata, :cache

lib/jekyll/related_posts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class RelatedPosts
     class << self

lib/jekyll/renderer.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   class Renderer

lib/jekyll/site.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 require "csv"
 

lib/jekyll/static_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class StaticFile
     attr_reader :relative_path, :extname, :name, :data

lib/jekyll/stevenson.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Stevenson < ::Logger
     def initialize

lib/jekyll/tags/highlight.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Tags
     class HighlightBlock < Liquid::Block

lib/jekyll/tags/include.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Jekyll
   module Tags

lib/jekyll/tags/link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Tags
     class Link < Liquid::Tag

lib/jekyll/tags/post_url.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Tags
     class PostComparer

lib/jekyll/theme.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Theme
     extend Forwardable

lib/jekyll/theme_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Jekyll::ThemeBuilder
   SCAFFOLD_DIRECTORIES = %w(
     assets _layouts _includes _sass

lib/jekyll/url.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "addressable/uri"
 
 # Public: Methods that generate a URL for a resource such as a Post or a Page.
@@ -93,7 +95,7 @@ module Jekyll
 
     def generate_url_from_drop(template)
       template.gsub(%r!:([a-z_]+)!) do |match|
-        pool = possible_keys(match.sub(":".freeze, "".freeze))
+        pool = possible_keys(match.sub(":", ""))
 
         winner = pool.find { |key| @placeholders.key?(key) }
         if winner.nil?

lib/jekyll/utils.rb

@@ -1,4 +1,6 @@
 
+# frozen_string_literal: true
+
 module Jekyll
   module Utils
     extend self
@@ -247,6 +249,8 @@ module Jekyll
     #
     # Returns the updated permalink template
     def add_permalink_suffix(template, permalink_style)
+      template = template.dup
+
       case permalink_style
       when :pretty
         template << "/"
@@ -256,6 +260,7 @@ module Jekyll
         template << "/" if permalink_style.to_s.end_with?("/")
         template << ":output_ext" if permalink_style.to_s.end_with?(":output_ext")
       end
+
       template
     end
 
@@ -296,7 +301,7 @@ module Jekyll
     def merged_file_read_opts(site, opts)
       merged = (site ? site.file_read_opts : {}).merge(opts)
       if merged["encoding"] && !merged["encoding"].start_with?("bom|")
-        merged["encoding"].insert(0, "bom|")
+        merged["encoding"] = "bom|#{merged["encoding"]}"
       end
       merged
     end

lib/jekyll/utils/exec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "open3"
 
 module Jekyll

lib/jekyll/utils/platforms.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Utils
     module Platforms

lib/jekyll/utils/win_tz.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Utils
     module WinTZ

lib/jekyll/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   VERSION = "3.5.1".freeze
 end

lib/theme_template/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 gemspec

rake/docs.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #############################################################################
 #
 # Packaging tasks for jekyll-docs

rake/release.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #############################################################################
 #
 # Packaging tasks

rake/site.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #############################################################################
 #
 # Site tasks - https://jekyllrb.com

test/fixtures/test-dependency-theme/test-dependency-theme.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.name          = "test-dependency-theme"
   s.version       = "0.1.0"

test/fixtures/test-theme/test-theme.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.name        = "test-theme"
   s.version     = "0.1.0"

test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $stdout.puts "# -------------------------------------------------------------"
 $stdout.puts "# SPECS AND TESTS ARE RUNNING WITH WARNINGS OFF."
 $stdout.puts "# SEE: https://github.com/Shopify/liquid/issues/730"

test/simplecov_custom_profile.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "simplecov"
 
 SimpleCov.profiles.define "gem" do

test/source/_plugins/dummy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Dummy < Generator
     priority :high

test/test_ansi.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "helper"
 
 class TestAnsi < JekyllUnitTest

test/test_cleaner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "helper"
 
 class TestCleaner < JekyllUnitTest

test/test_coffeescript.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "helper"
 
 class TestCoffeeScript < JekyllUnitTest

test/test_collections.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "helper"
 
 class TestCollections < JekyllUnitTest

test/test_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "helper"
 
 class TestCommand < JekyllUnitTest

test/test_commands_serve.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "webrick"
 require "mercenary"
 require "helper"