Enable and support Ruby 2.3+ frozen_string_literals

xing · Aug 11, 2016 · 49d885f · 49d885f
1 parent a37c3cb
commit 49d885f
Show file tree

Hide file tree

Showing 384 changed files with 440 additions and 56 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -66,8 +66,6 @@ Style/NestedTernaryOperator:
   Enabled: false
 Style/MutableConstant:
   Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false
 Style/WhenThen:
   Enabled: false
 Style/StringLiterals:

diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 group :development do

diff --git a/Rakefile b/Rakefile
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/lib/yard'
 require File.dirname(__FILE__) + '/lib/yard/rubygems/specification'
 require 'rbconfig'

diff --git a/benchmarks/builtins_vs_eval.rb b/benchmarks/builtins_vs_eval.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'benchmark'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
 

diff --git a/benchmarks/concat_vs_join.rb b/benchmarks/concat_vs_join.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 
 STR1 = "Hello"

diff --git a/benchmarks/erb_vs_erubis.rb b/benchmarks/erb_vs_erubis.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'erubis'
 require 'erubis/tiny'

diff --git a/benchmarks/format_args.rb b/benchmarks/format_args.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 require 'lib/yard'
 

diff --git a/benchmarks/generation.rb b/benchmarks/generation.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
 

diff --git a/benchmarks/marshal_vs_dbm.rb b/benchmarks/marshal_vs_dbm.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'benchmark'
 require 'dbm'
 

diff --git a/benchmarks/parsing.rb b/benchmarks/parsing.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 require 'yard'
 require 'logger'

diff --git a/benchmarks/pathname_vs_string.rb b/benchmarks/pathname_vs_string.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require "benchmark"
 require File.dirname(__FILE__) + '/../lib/yard'

diff --git a/benchmarks/rdoc_vs_yardoc.rb b/benchmarks/rdoc_vs_yardoc.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 
 files = Dir.glob(File.dirname(__FILE__) + '/../lib/**/*.rb').join(" ")

diff --git a/benchmarks/registry_store_types.rb b/benchmarks/registry_store_types.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'benchmark'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
 

diff --git a/benchmarks/ri_vs_yri.rb b/benchmarks/ri_vs_yri.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 
 TIMES = 10

diff --git a/benchmarks/ripper_parser.rb b/benchmarks/ripper_parser.rb
@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'benchmark'
 require File.dirname(__FILE__) + '/../lib/yard'
 

diff --git a/benchmarks/splat_vs_flatten.rb b/benchmarks/splat_vs_flatten.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 
 # To prove that flattening a small list is not significantly slower than

diff --git a/benchmarks/template_erb.rb b/benchmarks/template_erb.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
 

diff --git a/benchmarks/template_format.rb b/benchmarks/template_format.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
 

diff --git a/benchmarks/template_profile.rb b/benchmarks/template_profile.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'ruby-prof'
 # require 'benchmark'

diff --git a/benchmarks/yri_cache.rb b/benchmarks/yri_cache.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + "/../lib/yard"
 require "benchmark"
 include YARD::CLI

diff --git a/bin/yard b/bin/yard
@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # We do all this work just to find the proper load path
 path = __FILE__

diff --git a/bin/yardoc b/bin/yardoc
@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # We do all this work just to find the proper load path
 path = __FILE__

diff --git a/bin/yri b/bin/yri
@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # We do all this work just to find the proper load path
 path = __FILE__

diff --git a/docs/templates/default/fulldoc/html/setup.rb b/docs/templates/default/fulldoc/html/setup.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def generate_tag_list
   @list_title = "Tag List"
   @list_type = "tag"

diff --git a/docs/templates/default/layout/html/setup.rb b/docs/templates/default/layout/html/setup.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def init
   super
   sections.place(:tag_list).after_any(:files)

diff --git a/docs/templates/default/yard_tags/html/setup.rb b/docs/templates/default/yard_tags/html/setup.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def init
   sections :list, [T('docstring')]
 end

diff --git a/docs/templates/plugin.rb b/docs/templates/plugin.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 include YARD
 include Templates
 

diff --git a/lib/rubygems_plugin.rb b/lib/rubygems_plugin.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 if defined?(Gem::VERSION) && Gem::VERSION >= "2.0."
   require File.expand_path(File.dirname(__FILE__) + '/yard/rubygems/hook')
 else

diff --git a/lib/yard.rb b/lib/yard.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   # The root path for YARD source libraries
   ROOT = File.expand_path(File.dirname(__FILE__))

diff --git a/lib/yard/autoload.rb b/lib/yard/autoload.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # @private
 def __p(path) File.join(YARD::ROOT, 'yard', *path.split('/')); end
 

diff --git a/lib/yard/cli/command.rb b/lib/yard/cli/command.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 
 module YARD

diff --git a/lib/yard/cli/command_parser.rb b/lib/yard/cli/command_parser.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # This class parses a command name out of the +yard+ CLI command and calls

diff --git a/lib/yard/cli/config.rb b/lib/yard/cli/config.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # CLI command to view or edit configuration options

diff --git a/lib/yard/cli/diff.rb b/lib/yard/cli/diff.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'tmpdir'
 require 'fileutils'
 require 'open-uri'

diff --git a/lib/yard/cli/display.rb b/lib/yard/cli/display.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Display one object

diff --git a/lib/yard/cli/gems.rb b/lib/yard/cli/gems.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # @since 0.6.0

diff --git a/lib/yard/cli/graph.rb b/lib/yard/cli/graph.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Options to pass to the {Graph} CLI.

diff --git a/lib/yard/cli/help.rb b/lib/yard/cli/help.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Handles help for commands

diff --git a/lib/yard/cli/i18n.rb b/lib/yard/cli/i18n.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "pathname"
 
 module YARD

diff --git a/lib/yard/cli/list.rb b/lib/yard/cli/list.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Lists all constant and method names in the codebase. Uses {Yardoc} --list.

diff --git a/lib/yard/cli/markup_types.rb b/lib/yard/cli/markup_types.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Lists all markup types

diff --git a/lib/yard/cli/server.rb b/lib/yard/cli/server.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # A local documentation server

diff --git a/lib/yard/cli/stats.rb b/lib/yard/cli/stats.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # @since 0.6.0

diff --git a/lib/yard/cli/yardoc.rb b/lib/yard/cli/yardoc.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'digest/sha1'
 require 'fileutils'
 

diff --git a/lib/yard/cli/yardopts_command.rb b/lib/yard/cli/yardopts_command.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 
 module YARD

diff --git a/lib/yard/cli/yri.rb b/lib/yard/cli/yri.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rbconfig'
 
 module YARD

diff --git a/lib/yard/code_objects/base.rb b/lib/yard/code_objects/base.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CodeObjects
     # A list of code objects. This array acts like a set (no unique items)
@@ -580,7 +581,7 @@ def copyable_attributes
       # @param [String] source the source code to format
       # @return [String] formatted source
       def format_source(source)
-        source.chomp!
+        source = source.chomp
         last = source.split(/\r?\n/).last
         indent = last ? last[/^([ \t]*)/, 1].length : 0
         source.gsub(/^[ \t]{#{indent}}/, '')

diff --git a/lib/yard/code_objects/class_object.rb b/lib/yard/code_objects/class_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :class
 

diff --git a/lib/yard/code_objects/class_variable_object.rb b/lib/yard/code_objects/class_variable_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :class_variable
 

diff --git a/lib/yard/code_objects/constant_object.rb b/lib/yard/code_objects/constant_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :constant
 

diff --git a/lib/yard/code_objects/extended_method_object.rb b/lib/yard/code_objects/extended_method_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   # Represents an instance method of a module that was mixed into the class
   # scope of another namespace.

diff --git a/lib/yard/code_objects/extra_file_object.rb b/lib/yard/code_objects/extra_file_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   # An ExtraFileObject represents an extra documentation file (README or other
   # file). It is not strictly a CodeObject (does not inherit from `Base`) although

diff --git a/lib/yard/code_objects/macro_object.rb b/lib/yard/code_objects/macro_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ostruct'
 
 module YARD

diff --git a/lib/yard/code_objects/method_object.rb b/lib/yard/code_objects/method_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator CSEP, :method
   register_separator ISEP, :method

diff --git a/lib/yard/code_objects/module_object.rb b/lib/yard/code_objects/module_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :module
 

diff --git a/lib/yard/code_objects/namespace_mapper.rb b/lib/yard/code_objects/namespace_mapper.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CodeObjects
     # This module controls registration and accessing of namespace separators

diff --git a/lib/yard/code_objects/namespace_object.rb b/lib/yard/code_objects/namespace_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :namespace
   default_separator NSEP

diff --git a/lib/yard/code_objects/proxy.rb b/lib/yard/code_objects/proxy.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CodeObjects
     # A special type of +NoMethodError+ when raised from a {Proxy}

diff --git a/lib/yard/code_objects/root_object.rb b/lib/yard/code_objects/root_object.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CodeObjects
     # Represents the root namespace object (the invisible Ruby module that

diff --git a/lib/yard/config.rb b/lib/yard/config.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   # This class maintains all system-wide configuration for YARD and handles
   # the loading of plugins. To access options call {options}, and to load

diff --git a/lib/yard/core_ext/array.rb b/lib/yard/core_ext/array.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Array
   # Places values before or after another object (by value) in
   # an array. This is used in tandem with the before and after

diff --git a/lib/yard/core_ext/file.rb b/lib/yard/core_ext/file.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 
 class File

diff --git a/lib/yard/core_ext/hash.rb b/lib/yard/core_ext/hash.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Hash
   class << self
     def create(*args)

diff --git a/lib/yard/core_ext/insertion.rb b/lib/yard/core_ext/insertion.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # The Insertion class inserts a value before or after another
 # value in a list.
 #

diff --git a/lib/yard/core_ext/module.rb b/lib/yard/core_ext/module.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Module
   # Returns the class name of a full module namespace path
   #

diff --git a/lib/yard/core_ext/string.rb b/lib/yard/core_ext/string.rb
@@ -1,20 +1,21 @@
+# frozen_string_literal: true
 class String
   # Splits text into tokens the way a shell would, handling quoted
   # text as a single token. Use '\"' and "\'" to escape quotes and
   # '\\' to escape a backslash.
   #
   # @return [Array] an array representing the tokens
   def shell_split
-    out = [""]
+    out = [String.new("")]
     state = :none
     escape_next = false
-    quote = ""
+    quote = String.new("")
     strip.split(//).each do |char|
       case state
       when :none, :space
         case char
         when /\s/
-          out << "" unless state == :space
+          out << String.new("") unless state == :space
           state = :space
           escape_next = false
         when "\\"
@@ -30,7 +31,7 @@ def shell_split
             escape_next = false
           else
             state = char
-            quote = ""
+            quote = String.new("")
           end
         else
           state = :none

diff --git a/lib/yard/core_ext/symbol_hash.rb b/lib/yard/core_ext/symbol_hash.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # A subclass of Hash where all keys are converted into Symbols, and
 # optionally, all String values are converted into Symbols.
 class SymbolHash < Hash

diff --git a/lib/yard/docstring.rb b/lib/yard/docstring.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   # A documentation string, or "docstring" for short, encapsulates the
   # comments and metadata, or "tags", of an object. Meta-data is expressed