Merge pull request #551 from aycabta/use-frozen_string_literal-true

Use frozen_string_literal: true

Author: hsbt

Rakefile

@@ -63,6 +63,11 @@ parsed_files = PARSER_FILES.map do |parser_file|
       racc = Gem.bin_path 'racc', 'racc'
       rb_file = parser_file.gsub(/\.ry\z/, ".rb")
       ruby "#{racc} -l -o #{rb_file} #{parser_file}"
+      open(rb_file, 'r+') do |f|
+        newtext = "# frozen_string_literal: true\n#{f.read}"
+        f.rewind
+        f.write newtext
+      end
     elsif parser_file =~ /\.kpeg\z/ # need kpeg
       kpeg = Gem.bin_path 'kpeg', 'kpeg'
       rb_file = parser_file.gsub(/\.kpeg\z/, ".rb")

lib/rdoc.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 $DEBUG_RDOC = nil
 
 # :main: README.rdoc

lib/rdoc/alias.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Represent an alias, which is an old_name/new_name pair associated with a
 # particular context

lib/rdoc/anon_class.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # An anonymous class like:
 #

lib/rdoc/any_method.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # AnyMethod is the base class for objects representing methods
 
@@ -244,9 +244,9 @@ def param_list
     if @block_params then
       # If this method has explicit block parameters, remove any explicit
       # &block
-      params.sub!(/,?\s*&\w+/, '')
+      params = params.sub(/,?\s*&\w+/, '')
     else
-      params.sub!(/\&(\w+)/, '\1')
+      params = params.sub(/\&(\w+)/, '\1')
     end
 
     params = params.gsub(/\s+/, '').split(',').reject(&:empty?)
@@ -274,11 +274,11 @@ def param_seq
     if @block_params then
       # If this method has explicit block parameters, remove any explicit
       # &block
-      params.sub!(/,?\s*&\w+/, '')
+      params = params.sub(/,?\s*&\w+/, '')
 
       block = @block_params.tr_s("\n ", " ")
       if block[0] == ?(
-        block.sub!(/^\(/, '').sub!(/\)/, '')
+        block = block.sub(/^\(/, '').sub(/\)/, '')
       end
       params << " { |#{block}| ... }"
     end

lib/rdoc/attr.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # An attribute created by \#attr, \#attr_reader, \#attr_writer or
 # \#attr_accessor

lib/rdoc/class_module.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # ClassModule is the base class for objects representing either a class or a
 # module.

lib/rdoc/code_object.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Base class for the RDoc code tree.
 #
@@ -144,7 +144,7 @@ def comment=(comment)
                    # HACK correct fix is to have #initialize create @comment
                    #      with the correct encoding
                    if String === @comment and @comment.empty? then
-                     @comment.force_encoding comment.encoding
+                     @comment = RDoc::Encoding.change_encoding @comment, comment.encoding
                    end
                    @comment
                  end

lib/rdoc/code_objects.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 # This file was used to load all the RDoc::CodeObject subclasses at once.  Now
 # autoload handles this.
 

lib/rdoc/comment.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A comment holds the text comment for a RDoc::CodeObject and provides a
 # unified way of cleaning it up and parsing it into an RDoc::Markup::Document.
@@ -45,7 +45,7 @@ class RDoc::Comment
 
   def initialize text = nil, location = nil
     @location = location
-    @text     = text
+    @text     = text.nil? ? nil : text.dup
 
     @document   = nil
     @format     = 'rdoc'
@@ -114,10 +114,14 @@ def extract_call_seq method
 
       method.call_seq = seq.chomp
 
-    elsif @text.sub!(/^\s*:?call-seq:(.*?)(^\s*$|\z)/m, '') then
-      seq = $1
-      seq.gsub!(/^\s*/, '')
-      method.call_seq = seq
+    else
+      regexp = /^\s*:?call-seq:(.*?)(^\s*$|\z)/m
+      if regexp =~ @text then
+        @text = @text.sub(regexp, '')
+        seq = $1
+        seq.gsub!(/^\s*/, '')
+        method.call_seq = seq
+      end
     end
 
     method
@@ -133,8 +137,14 @@ def empty?
   ##
   # HACK dubious
 
-  def force_encoding encoding
-    @text.force_encoding encoding
+  def encode! encoding
+    # TODO: Remove this condition after Ruby 2.2 EOL
+    if RUBY_VERSION < '2.3.0'
+      @text = @text.force_encoding encoding
+    else
+      @text = String.new @text, encoding: encoding
+    end
+    self
   end
 
   ##
@@ -200,7 +210,7 @@ def parse
   def remove_private
     # Workaround for gsub encoding for Ruby 1.9.2 and earlier
     empty = ''
-    empty.force_encoding @text.encoding
+    empty = RDoc::Encoding.change_encoding empty, @text.encoding
 
     @text = @text.gsub(%r%^\s*([#*]?)--.*?^\s*(\1)\+\+\n?%m, empty)
     @text = @text.sub(%r%^\s*[#*]?--.*%m, '')
@@ -216,7 +226,7 @@ def text= text
       @text.nil? and @document
 
     @document = nil
-    @text = text
+    @text = text.nil? ? nil : text.dup
   end
 
   ##