Add frozen string literal magic comment

This cop was disabled probably by mistake, since it is present in both Arbre and Active Admin gems The only production code affected is: - app/controllers/inherited_resources/base.rb - lib/inherited_resources/version.rb Change to `version.rb` is safe. After inspecting the source code of `InheritedResources` module, the change seems safe, but it can represent a breaking change in third-party application. Since we are bumping the major version number, it would be fine to break if documented. Fixed with `rubocop -A` Also adds `Style/Encoding` cop for parity with Arbre
activeadmin · Aug 26, 2024 · 7fccb80 · 7fccb80
1 parent fdc9a9c
commit 7fccb80
Show file tree

Hide file tree

Showing 36 changed files with 44 additions and 0 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -373,5 +373,13 @@ Performance/UnfreezeString:
 Performance/UriDefaultParser:
   Enabled: true
 
+Style/Encoding:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - bin/console
+
 Style/HashSyntax:
   Enabled: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ## Version 2.0.0
 
 * Test against Rails 7.2 [#921][].
+* Add frozen string literal to `InheritedResources` module [#933][].
 * Change return codes to new Responders defaults [#918][].
 
 ## Version 1.14.0
@@ -234,3 +235,4 @@ _No changes_.
 [#873]: https://github.com/activeadmin/inherited_resources/pull/873
 [#918]: https://github.com/activeadmin/inherited_resources/pull/918
 [#921]: https://github.com/activeadmin/inherited_resources/pull/921
+[#921]: https://github.com/activeadmin/inherited_resources/pull/933
diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec path: '.'

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

diff --git a/app/controllers/inherited_resources/base.rb b/app/controllers/inherited_resources/base.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module InheritedResources
   # = Base
   #

diff --git a/gemfiles/rails_61/Gemfile b/gemfiles/rails_61/Gemfile
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec path: '../..'

diff --git a/gemfiles/rails_70/Gemfile b/gemfiles/rails_70/Gemfile
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec path: '../..'

diff --git a/gemfiles/rails_71/Gemfile b/gemfiles/rails_71/Gemfile
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec path: '../..'

diff --git a/inherited_resources.gemspec b/inherited_resources.gemspec
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "inherited_resources/version"

diff --git a/lib/inherited_resources/version.rb b/lib/inherited_resources/version.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module InheritedResources
   VERSION = '2.0.0'.freeze
 end
diff --git a/test/aliases_test.rb b/test/aliases_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Student

diff --git a/test/association_chain_test.rb b/test/association_chain_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Pet

diff --git a/test/autoload/engine.rb b/test/autoload/engine.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MyTestNamespace
   class Engine; end
 end
diff --git a/test/base_test.rb b/test/base_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class User

diff --git a/test/belongs_to_test.rb b/test/belongs_to_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Post

diff --git a/test/belongs_to_with_shallow_test.rb b/test/belongs_to_with_shallow_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Post

diff --git a/test/changelog_test.rb b/test/changelog_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class ChangelogTest < ActiveSupport::TestCase

diff --git a/test/class_methods_test.rb b/test/class_methods_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Book; end

diff --git a/test/customized_base_test.rb b/test/customized_base_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Car

diff --git a/test/customized_belongs_to_test.rb b/test/customized_belongs_to_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class GreatSchool

diff --git a/test/customized_redirect_to_test.rb b/test/customized_redirect_to_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Post;

diff --git a/test/defaults_test.rb b/test/defaults_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Malarz

diff --git a/test/multiple_nested_optional_belongs_to_test.rb b/test/multiple_nested_optional_belongs_to_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Student; end

diff --git a/test/nested_belongs_to_test.rb b/test/nested_belongs_to_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Country

diff --git a/test/nested_belongs_to_with_shallow_test.rb b/test/nested_belongs_to_with_shallow_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Dresser

diff --git a/test/nested_model_with_shallow_test.rb b/test/nested_model_with_shallow_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Subfaculty

diff --git a/test/nested_singleton_test.rb b/test/nested_singleton_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 # This test file is instead to test the how controller flow and actions

diff --git a/test/optional_belongs_to_test.rb b/test/optional_belongs_to_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Brands; end

diff --git a/test/polymorphic_test.rb b/test/polymorphic_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Factory; end

diff --git a/test/redirect_to_test.rb b/test/redirect_to_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Machine;

diff --git a/test/singleton_test.rb b/test/singleton_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 # This test file is instead to test the how controller flow and actions

diff --git a/test/strong_parameters_test.rb b/test/strong_parameters_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class Widget

diff --git a/test/tasks/gemfile_test.rb b/test/tasks/gemfile_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "minitest"
 
 class GemfilesTest < Minitest::Test

diff --git a/test/tasks/gemspec_test.rb b/test/tasks/gemspec_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "minitest"
 require "open3"
 require "inherited_resources/version"

diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 if ENV.fetch('COVERAGE', false)
   require 'simplecov'
   require 'simplecov-cobertura'

diff --git a/test/url_helpers_test.rb b/test/url_helpers_test.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class ModelBase