Handle frozen source code string literals

This change is needed to stop Ruby 3.4 emitting warnings about string
literals being frozen in the future.

.rubocop.yml

@@ -84,13 +84,6 @@ RSpec/ExampleLength:
 Style/AndOr:
   EnforcedStyle: conditionals
 
-# Require comment for files in lib and bin
-Style/FrozenStringLiteralComment:
-  Include:
-    - 'bin/*'
-    - 'lib/**/*'
-  EnforcedStyle: always
-
 # Allow multiline block chains
 Style/MultilineBlockChain:
   Enabled: false

.simplecov

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 SimpleCov.start do
   track_files 'lib/**/*.rb'
   add_filter 'lib/reek/version.rb' # version.rb is loaded too early to test

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/clean'
 

docs/templates/default/docstring/setup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def init
   super
   return unless show_api_marker_section?

docs/yard_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard'
 
 # Template helper to modify processing of links in HTML generated from our

features/step_definitions/reek_steps.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 When /^I run reek (.*)$/ do |args|
   reek(args)
 end

features/step_definitions/sample_file_steps.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../samples/paths'
 
 Given(/^the smelly file '(.+)'$/) do |filename|

features/support/env.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../lib/reek'
 require_relative '../../lib/reek/cli/application'
 require 'aruba/cucumber'

lib/reek/source/source_code.rb

@@ -75,11 +75,17 @@ def origin
 
       def code
         @code ||=
-          case source
-          when File, Pathname then source.read
-          when IO             then source.readlines.join
-          when String         then source
-          end.force_encoding(Encoding::UTF_8)
+          begin
+            str =
+              case source
+              when File, Pathname then source.read
+              when IO             then source.readlines.join
+              when String         then source
+              end
+
+            str = str.dup if str.frozen?
+            str.force_encoding(Encoding::UTF_8)
+          end
       end
 
       attr_reader :parser, :source

reek.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/reek/version'
 
 Gem::Specification.new do |spec|

spec/performance/reek/smell_detectors/runtime_speed_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../../spec_helper'
 require_lib 'reek/examiner'
 

spec/quality/documentation_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require 'kramdown'
 

spec/quality/reek_source_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 
 RSpec.describe 'Reek source code' do

spec/reek/ast/node_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/ast/node'
 

spec/reek/ast/object_refs_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/ast/object_refs'
 

spec/reek/ast/reference_collector_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/ast/reference_collector'
 

spec/reek/ast/sexp_extensions_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/ast/sexp_extensions'
 

spec/reek/cli/application_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/cli/application'
 

spec/reek/cli/command/report_command_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../../spec_helper'
 require_lib 'reek/cli/command/report_command'
 require_lib 'reek/cli/options'

spec/reek/cli/command/todo_list_command_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../../spec_helper'
 require_lib 'reek/cli/command/todo_list_command'
 require_lib 'reek/cli/options'

spec/reek/cli/options_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/cli/options'
 

spec/reek/cli/silencer_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/cli/silencer'
 

spec/reek/code_climate/code_climate_configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/code_climate/code_climate_configuration'
 

spec/reek/code_climate/code_climate_fingerprint_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/code_climate/code_climate_fingerprint'
 

spec/reek/code_climate/code_climate_formatter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/code_climate/code_climate_formatter'
 

spec/reek/code_climate/code_climate_report_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/code_climate'

spec/reek/code_comment_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require_lib 'reek/code_comment'
 

spec/reek/configuration/app_configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require_relative '../../spec_helper'
 require_lib 'reek/configuration/app_configuration'

spec/reek/configuration/configuration_file_finder_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'pathname'
 require 'tmpdir'

spec/reek/configuration/default_directive_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/configuration/default_directive'
 

spec/reek/configuration/directory_directives_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/errors/config_file_error'
 require_lib 'reek/configuration/directory_directives'

spec/reek/configuration/excluded_paths_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/errors/config_file_error'
 require_lib 'reek/configuration/excluded_paths'

spec/reek/configuration/rake_task_converter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/configuration/rake_task_converter'
 

spec/reek/configuration/schema_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/configuration/schema'
 

spec/reek/configuration/schema_validator_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/configuration/schema_validator'
 require_lib 'reek/errors/config_file_error'

spec/reek/context/code_context_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/context/method_context'
 require_lib 'reek/context/module_context'

spec/reek/context/ghost_context_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/context/code_context'
 require_lib 'reek/context/ghost_context'

spec/reek/context/method_context_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/context/method_context'
 

spec/reek/context/module_context_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/context/module_context'
 require_lib 'reek/context/root_context'

spec/reek/context/root_context_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/context/root_context'
 

spec/reek/context/statement_counter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/context/statement_counter'
 

spec/reek/context_builder_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require_lib 'reek/context_builder'
 

spec/reek/detector_repository_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require_lib 'reek/smell_detectors/base_detector'
 require_lib 'reek/detector_repository'

spec/reek/documentation_link_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 
 RSpec.describe Reek::DocumentationLink do

spec/reek/errors/base_error_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 
 require_lib 'reek/errors/base_error'

spec/reek/examiner_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/logging_error_handler'

spec/reek/logging_error_handler_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require_lib 'reek/logging_error_handler'
 

spec/reek/rake/task_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/rake/task'
 

spec/reek/report/github_report_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/json_report'

spec/reek/report/html_report_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/html_report'

spec/reek/report/json_report_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/json_report'

spec/reek/report/location_formatter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/report/location_formatter'
 

spec/reek/report/progress_formatter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/report/progress_formatter'
 

spec/reek/report/text_report_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/text_report'

spec/reek/report/xml_report_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/xml_report'

spec/reek/report/yaml_report_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/yaml_report'

spec/reek/report_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require_lib 'reek/report'
 

spec/reek/smell_configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require_lib 'reek/smell_configuration'
 

spec/reek/smell_detectors/attribute_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/smell_detectors/attribute'
 

spec/reek/smell_detectors/base_detector_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/smell_detectors/base_detector'
 require_lib 'reek/smell_detectors/duplicate_method_call'

spec/reek/smell_detectors/boolean_parameter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require_lib 'reek/smell_detectors/boolean_parameter'