⚡️ Frozen Strings (performance benefit)

pboling · pboling · commit c91de22b5db4 · 2025-10-30T00:59:24.000-06:00
Signed-off-by: Peter H. Boling &lt;peter.boling@gmail.com&gt;
diff --git a/.simplecov b/.simplecov
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copied from https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/.simplecov
 # Licensed under MIT - https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/LICENSE
 
diff --git a/features/fixtures/simple/Gemfile b/features/fixtures/simple/Gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'activesupport', '7.0.4.3'
diff --git a/features/step_definitions/json_bom_matching.rb b/features/step_definitions/json_bom_matching.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Then('the generated Json BOM file {string} matches {string}') do |generated_file, expected_file|
   generated_file_contents = File.read(expand_path(generated_file))
   expected_file_contents = File.read(expand_path(expected_file))
diff --git a/features/step_definitions/xml_bom_matching.rb b/features/step_definitions/xml_bom_matching.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Then('the generated XML BOM file {string} matches {string}') do |generated_file, expected_file|
   generated_file_contents = File.read(expand_path(generated_file))
   expected_file_contents = File.read(expand_path(expected_file))
diff --git a/features/support/env.rb b/features/support/env.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Based on https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/features/support/env.rb
 # Licensed under MIT - https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/LICENSE
 
diff --git a/features/support/simplecov_support.rb b/features/support/simplecov_support.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copied from https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/features/support/simplecov_setup.rb
 # Licensed under MIT - https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/LICENSE
 
diff --git a/lib/bom_builder.rb b/lib/bom_builder.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of CycloneDX Ruby Gem.
 #
 # Licensed to the Apache Software Foundation (ASF) under one
diff --git a/lib/bom_component.rb b/lib/bom_component.rb
@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require_relative "cyclonedx/ruby"
 require_relative "cyclonedx_deprecated"
diff --git a/lib/bom_helpers.rb b/lib/bom_helpers.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of CycloneDX Ruby Gem.
 #
 # Licensed to the Apache Software Foundation (ASF) under one
@@ -20,7 +22,6 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) OWASP Foundation. All Rights Reserved.
 #
-# frozen_string_literal: true
 
 require_relative "cyclonedx/ruby"
 require_relative "cyclonedx_deprecated"
diff --git a/lib/cyclonedx/bom_builder.rb b/lib/cyclonedx/bom_builder.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cyclonedx
   class BomBuilder
     SUPPORTED_BOM_FORMATS = %w[xml json]
diff --git a/lib/cyclonedx/bom_component.rb b/lib/cyclonedx/bom_component.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cyclonedx
   class BomComponent
     DEFAULT_TYPE = "library".freeze
diff --git a/lib/cyclonedx/bom_helpers.rb b/lib/cyclonedx/bom_helpers.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of CycloneDX Ruby Gem.
 #
 # Licensed to the Apache Software Foundation (ASF) under one
diff --git a/lib/cyclonedx/ruby/deprecation.rb b/lib/cyclonedx/ruby/deprecation.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Provides tools that allow methods to be deprecated with new releases of the gem.
 #
 # Usage:
diff --git a/lib/cyclonedx_deprecated.rb b/lib/cyclonedx_deprecated.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "cyclonedx/ruby/deprecation"
 
 # Legacy class name kept for compatibility until v2.0.0
diff --git a/spec/cyclonedx/bom_component_spec.rb b/spec/cyclonedx/bom_component_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_examples "a valid hash_val result for gem" do
   it { expect(result.count).to eq(1) }
   it { expect(result[0][:type]).to eq('library') }
diff --git a/spec/cyclonedx/bom_helpers_spec.rb b/spec/cyclonedx/bom_helpers_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe Cyclonedx::BomHelpers do
   context '#purl' do
     context "when legacy method is called" do

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`# Copied from https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/.simplecov`
`2`	`4`	`# Licensed under MIT - https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/LICENSE`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`source 'https://rubygems.org'`
`2`	`4`
`3`	`5`	`gem 'activesupport', '7.0.4.3'`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`Then('the generated Json BOM file {string} matches {string}') do \|generated_file, expected_file\|`
`2`	`4`	`generated_file_contents = File.read(expand_path(generated_file))`
`3`	`5`	`expected_file_contents = File.read(expand_path(expected_file))`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`Then('the generated XML BOM file {string} matches {string}') do \|generated_file, expected_file\|`
`2`	`4`	`generated_file_contents = File.read(expand_path(generated_file))`
`3`	`5`	`expected_file_contents = File.read(expand_path(expected_file))`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`# Based on https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/features/support/env.rb`
`2`	`4`	`# Licensed under MIT - https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/LICENSE`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`# This file is part of CycloneDX Ruby Gem.`
`2`	`4`	`#`
`3`	`5`	`# Licensed to the Apache Software Foundation (ASF) under one`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`module Cyclonedx`
`2`	`4`	`class BomBuilder`
`3`	`5`	`SUPPORTED_BOM_FORMATS = %w[xml json]`