Merge pull request #586 from technicalpickles/frozen-string-literals

JonRowe · JonRowe · commit 7be928d7eaf6 · 2024-02-04T10:43:17.000Z
Reduce memory usage by using frozen string literals
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -31,3 +31,9 @@ Lint/AssignmentInCondition:
   Exclude:
     # The pattern makes sense here
     - 'lib/rspec/support/mutex.rb'
+
+Style/FrozenStringLiteralComment:
+  Include:
+    - lib/**/*.rb
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -307,13 +307,6 @@ Style/FormatString:
   Exclude:
     - 'spec/rspec/support/encoded_string_spec.rb'
 
-# Offense count: 68
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/GlobalStdStream:
diff --git a/lib/rspec/support.rb b/lib/rspec/support.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     # @api private
diff --git a/lib/rspec/support/caller_filter.rb b/lib/rspec/support/caller_filter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_support "ruby_features"
 
 module RSpec
diff --git a/lib/rspec/support/comparable_version.rb b/lib/rspec/support/comparable_version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     # @private
diff --git a/lib/rspec/support/differ.rb b/lib/rspec/support/differ.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_support 'encoded_string'
 RSpec::Support.require_rspec_support 'hunk_generator'
 RSpec::Support.require_rspec_support "object_formatter"
diff --git a/lib/rspec/support/directory_maker.rb b/lib/rspec/support/directory_maker.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_support 'ruby_features'
 
 module RSpec
diff --git a/lib/rspec/support/encoded_string.rb b/lib/rspec/support/encoded_string.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     # @private
diff --git a/lib/rspec/support/fuzzy_matcher.rb b/lib/rspec/support/fuzzy_matcher.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     # Provides a means to fuzzy-match between two arbitrary objects.
diff --git a/lib/rspec/support/hunk_generator.rb b/lib/rspec/support/hunk_generator.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'diff/lcs'
 require 'diff/lcs/hunk'
 
diff --git a/lib/rspec/support/matcher_definition.rb b/lib/rspec/support/matcher_definition.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     # @private
diff --git a/lib/rspec/support/method_signature_verifier.rb b/lib/rspec/support/method_signature_verifier.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/support'
 RSpec::Support.require_rspec_support "ruby_features"
 RSpec::Support.require_rspec_support "matcher_definition"
diff --git a/lib/rspec/support/mutex.rb b/lib/rspec/support/mutex.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     # On 1.8.7, it's in the stdlib.
diff --git a/lib/rspec/support/object_formatter.rb b/lib/rspec/support/object_formatter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_support 'matcher_definition'
 
 module RSpec
diff --git a/lib/rspec/support/recursive_const_methods.rb b/lib/rspec/support/recursive_const_methods.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     # Provides recursive constant lookup methods useful for
diff --git a/lib/rspec/support/reentrant_mutex.rb b/lib/rspec/support/reentrant_mutex.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     # Allows a thread to lock out other threads from a critical section of code,
diff --git a/lib/rspec/support/ruby_features.rb b/lib/rspec/support/ruby_features.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rbconfig'
 RSpec::Support.require_rspec_support "comparable_version"
 
diff --git a/lib/rspec/support/source.rb b/lib/rspec/support/source.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_support 'encoded_string'
 RSpec::Support.require_rspec_support 'ruby_features'
 
diff --git a/lib/rspec/support/source/location.rb b/lib/rspec/support/source/location.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     class Source
diff --git a/lib/rspec/support/source/node.rb b/lib/rspec/support/source/node.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_support 'source/location'
 
 module RSpec
diff --git a/lib/rspec/support/source/token.rb b/lib/rspec/support/source/token.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_support 'source/location'
 
 module RSpec
diff --git a/lib/rspec/support/spec.rb b/lib/rspec/support/spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/support'
 require 'rspec/support/spec/in_sub_process'
 
diff --git a/lib/rspec/support/spec/deprecation_helpers.rb b/lib/rspec/support/spec/deprecation_helpers.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpecHelpers
   def expect_deprecation_with_call_site(file, line, snippet=//)
     expect(RSpec.configuration.reporter).to receive(:deprecation).
diff --git a/lib/rspec/support/spec/diff_helpers.rb b/lib/rspec/support/spec/diff_helpers.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'diff/lcs'
 
 module RSpec
diff --git a/lib/rspec/support/spec/formatting_support.rb b/lib/rspec/support/spec/formatting_support.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     module FormattingSupport
diff --git a/lib/rspec/support/spec/in_sub_process.rb b/lib/rspec/support/spec/in_sub_process.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     module InSubProcess
diff --git a/lib/rspec/support/spec/library_wide_checks.rb b/lib/rspec/support/spec/library_wide_checks.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/support/spec/shell_out'
 
 module RSpec
diff --git a/lib/rspec/support/spec/shell_out.rb b/lib/rspec/support/spec/shell_out.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 require 'rake/file_utils'
 require 'shellwords'
diff --git a/lib/rspec/support/spec/stderr_splitter.rb b/lib/rspec/support/spec/stderr_splitter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'stringio'
 
 module RSpec
diff --git a/lib/rspec/support/spec/string_matcher.rb b/lib/rspec/support/spec/string_matcher.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/matchers'
 # Special matcher for comparing encoded strings so that
 # we don't run any expectation failures through the Differ,
diff --git a/lib/rspec/support/spec/with_isolated_directory.rb b/lib/rspec/support/spec/with_isolated_directory.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tmpdir'
 
 RSpec.shared_context "isolated directory" do
diff --git a/lib/rspec/support/spec/with_isolated_stderr.rb b/lib/rspec/support/spec/with_isolated_stderr.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     module WithIsolatedStdErr
diff --git a/lib/rspec/support/version.rb b/lib/rspec/support/version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Support
     module Version
diff --git a/lib/rspec/support/warnings.rb b/lib/rspec/support/warnings.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/support'
 RSpec::Support.require_rspec_support "caller_filter"
 
diff --git a/lib/rspec/support/with_keywords_when_needed.rb b/lib/rspec/support/with_keywords_when_needed.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_support("method_signature_verifier")
 
 module RSpec

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`module RSpec`
`2`	`4`	`module Support`
`3`	`5`	`# @api private`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`RSpec::Support.require_rspec_support "ruby_features"`
`2`	`4`
`3`	`5`	`module RSpec`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`RSpec::Support.require_rspec_support 'encoded_string'`
`2`	`4`	`RSpec::Support.require_rspec_support 'hunk_generator'`
`3`	`5`	`RSpec::Support.require_rspec_support "object_formatter"`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`RSpec::Support.require_rspec_support 'ruby_features'`
`2`	`4`
`3`	`5`	`module RSpec`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'diff/lcs'`
`2`	`4`	`require 'diff/lcs/hunk'`
`3`	`5`