[Chore] Frozen string literal, finally

Ruby 3.4 makes string literals frozen by default, so this change will be required for the future.
okuramasafumi · Jul 15, 2024 · 5b0196d · 5b0196d
1 parent dcd5445
commit 5b0196d
Show file tree

Hide file tree

Showing 51 changed files with 101 additions and 6 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -121,10 +121,6 @@ Style/DocumentationMethod:
   Exclude:
     - 'README.md'
 
-# This might be true in the future, but not many good things
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # I don't want to think about error class in example code
 Style/ImplicitRuntimeError:
   Exclude:

diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in alba.gemspec

diff --git a/Rakefile b/Rakefile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

diff --git a/bin/console b/bin/console
@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'alba'

diff --git a/gemfiles/without_active_support.gemfile b/gemfiles/without_active_support.gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'minitest', '~> 5.14' # For test

diff --git a/gemfiles/without_oj.gemfile b/gemfiles/without_oj.gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'activesupport', require: false # For backend

diff --git a/lib/alba.rb b/lib/alba.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require_relative 'alba/version'
 require_relative 'alba/errors'

diff --git a/lib/alba/association.rb b/lib/alba/association.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Representing association
   # @api private

diff --git a/lib/alba/conditional_attribute.rb b/lib/alba/conditional_attribute.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'association'
 require_relative 'constants'
 require 'ostruct'

diff --git a/lib/alba/constants.rb b/lib/alba/constants.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file includes public constants to prevent circular dependencies.
 module Alba
   REMOVE_KEY = Object.new.freeze # A constant to remove key from serialized JSON

diff --git a/lib/alba/default_inflector.rb b/lib/alba/default_inflector.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'active_support/inflector'
   require 'active_support/core_ext/module/delegation'

diff --git a/lib/alba/deprecation.rb b/lib/alba/deprecation.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Module for printing deprecation warning
   # @api private

diff --git a/lib/alba/errors.rb b/lib/alba/errors.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Base class for Errors
   class Error < StandardError; end

diff --git a/lib/alba/layout.rb b/lib/alba/layout.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'forwardable'
 

diff --git a/lib/alba/nested_attribute.rb b/lib/alba/nested_attribute.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Representing nested attribute
   # @api private

diff --git a/lib/alba/railtie.rb b/lib/alba/railtie.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Rails integration
   class Railtie < Rails::Railtie

diff --git a/lib/alba/resource.rb b/lib/alba/resource.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'association'
 require_relative 'conditional_attribute'
 require_relative 'constants'

diff --git a/lib/alba/type.rb b/lib/alba/type.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Representing type itself, combined with {Alba::TypedAttribute}
   class Type

diff --git a/lib/alba/typed_attribute.rb b/lib/alba/typed_attribute.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Representing typed attributes to encapsulate logic about types
   # @api private

diff --git a/lib/alba/version.rb b/lib/alba/version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
-  VERSION = '3.2.0'.freeze
+  VERSION = '3.2.0'
 end
diff --git a/test/alba_test.rb b/test/alba_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class AlbaTest < Minitest::Test

diff --git a/test/dependencies/railties_test.rb b/test/dependencies/railties_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Rails integration
 require 'rails'
 require_relative '../test_helper'

diff --git a/test/dependencies/test_dependencies.rb b/test/dependencies/test_dependencies.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class DependenciesTest < Minitest::Test

diff --git a/test/resource_test.rb b/test/resource_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class ResourceTest < Minitest::Test

diff --git a/test/support/custom_inflector.rb b/test/support/custom_inflector.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Fake implementation of custom inflector
 module CustomInflector
   module_function

diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 
 require 'simplecov-cobertura'

diff --git a/test/usecases/circular_association_test.rb b/test/usecases/circular_association_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Based on https://github.com/jsonapi-serializer/comparisons
 require_relative '../test_helper'
 require 'securerandom'

diff --git a/test/usecases/collection_test.rb b/test/usecases/collection_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class CollectionTest < Minitest::Test

diff --git a/test/usecases/conditional_attributes_test.rb b/test/usecases/conditional_attributes_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class ConditionalAttributesTest < Minitest::Test

diff --git a/test/usecases/custom_type_test.rb b/test/usecases/custom_type_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class CustomTypeTest < Minitest::Test

diff --git a/test/usecases/field_selection_test.rb b/test/usecases/field_selection_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class FieldSelectionTest < Minitest::Test

diff --git a/test/usecases/helper_test.rb b/test/usecases/helper_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class HelperTest < Minitest::Test

diff --git a/test/usecases/inheritance_and_ignorance_test.rb b/test/usecases/inheritance_and_ignorance_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class InheritanceAndIgnoranceTest < Minitest::Test

diff --git a/test/usecases/key_transform_test.rb b/test/usecases/key_transform_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require_relative '../support/custom_inflector'
 

diff --git a/test/usecases/layout_test.rb b/test/usecases/layout_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class LayoutTest < Minitest::Test

diff --git a/test/usecases/many_test.rb b/test/usecases/many_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class ManyTest < Minitest::Test

diff --git a/test/usecases/meta_test.rb b/test/usecases/meta_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class MetaTest < Minitest::Test

diff --git a/test/usecases/nested_array_and_hash_test.rb b/test/usecases/nested_array_and_hash_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class HashAttributeTest < Minitest::Test

diff --git a/test/usecases/nested_attribute_test.rb b/test/usecases/nested_attribute_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class NestedAttributeTest < Minitest::Test

diff --git a/test/usecases/nil_filtering_test.rb b/test/usecases/nil_filtering_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class NilFilteringTest < Minitest::Test

diff --git a/test/usecases/nil_handler_test.rb b/test/usecases/nil_handler_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class NilHandlerTest < Minitest::Test

diff --git a/test/usecases/no_association_test.rb b/test/usecases/no_association_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class NoAssociationTest < Minitest::Test

diff --git a/test/usecases/object_method_and_resource_method_test.rb b/test/usecases/object_method_and_resource_method_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class ObjectMethodAndResourceMethodTest < Minitest::Test

diff --git a/test/usecases/on_error_test.rb b/test/usecases/on_error_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class OnErrorTest < Minitest::Test

diff --git a/test/usecases/one_test.rb b/test/usecases/one_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class OneTest < Minitest::Test
@@ -100,7 +102,7 @@ class UserResource4
 
     one :profile,
         proc { |profile, params|
-          profile.email.sub!('@', params[:replace_atmark_with]) if params[:replace_atmark_with]
+          profile.email = profile.email.sub('@', params[:replace_atmark_with]) if params[:replace_atmark_with]
           profile
         },
         resource: ProfileResource

diff --git a/test/usecases/params_test.rb b/test/usecases/params_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class ParamsTest < Minitest::Test

diff --git a/test/usecases/root_key_collection_test.rb b/test/usecases/root_key_collection_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class RootKeyCollectionTest < Minitest::Test

diff --git a/test/usecases/type_validation_test.rb b/test/usecases/type_validation_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class TypeValidationTest < Minitest::Test

diff --git a/test/usecases/user_defined_serializable_hash_test.rb b/test/usecases/user_defined_serializable_hash_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class UserDefinedSerializableHashTest < Minitest::Test

diff --git a/test/usecases/with_inference_test.rb b/test/usecases/with_inference_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require_relative '../support/custom_inflector'
 

diff --git a/test/usecases/with_struct_test.rb b/test/usecases/with_struct_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 
 class WithStructTest < Minitest::Test