Enable frozen string literals across the project (#3483)

https://docs.rubocop.org/rubocop/cops_style.html#stylefrozenstringliteralcomment

This feature is designed to help transition from mutable string literals
to frozen string literals. The "frozen_string_literal: true" magic
comment was added to the top of all files to enable frozen string
literals. Frozen string literals may be default in future Ruby. Using
frozen string literals is good practice and easier to reason about.

Author: jdufresne

.rubocop.yml

@@ -168,9 +168,6 @@ Style/Encoding:
 Style/EndlessMethod:
   Enabled: true
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 Style/HashConversion:
   Enabled: true
 

Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'rails-6.0' do
   gem 'rails', '~> 6.0.0'
   gem 'sassc-rails', '~> 2.1'

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'appraisal', '>= 2.0'

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 

app/controllers/rails_admin/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/abstract_model'
 
 module RailsAdmin

app/controllers/rails_admin/main_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   class MainController < RailsAdmin::ApplicationController
     include ActionView::Helpers::TextHelper

app/helpers/rails_admin/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module ApplicationHelper
     def authorized?(action_name, abstract_model = nil, object = nil)

app/helpers/rails_admin/form_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nested_form/builder_mixin'
 
 module RailsAdmin

app/helpers/rails_admin/main_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module MainHelper
     def rails_admin_form_for(*args, &block)

config/initializers/active_record_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ActiveSupport.on_load(:active_record) do
   module ActiveRecord
     class Base

config/initializers/mongoid_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(::Mongoid::Document)
   require 'rails_admin/adapters/mongoid/extension'
   Mongoid::Document.include RailsAdmin::Adapters::Mongoid::Extension

config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RailsAdmin::Engine.routes.draw do
   controller 'main' do
     RailsAdmin::Config::Actions.all(:root).each { |action| match "/#{action.route_fragment}", action: action.action_name, as: action.action_name, via: action.http_methods }

lib/generators/rails_admin/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails_admin/version'
 require File.expand_path('utils', __dir__)

lib/generators/rails_admin/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Generators
     module Utils

lib/rails_admin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/engine'
 require 'rails_admin/abstract_model'
 require 'rails_admin/config'

lib/rails_admin/abstract_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/support/datetime'
 
 module RailsAdmin

lib/rails_admin/adapters/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'rails_admin/adapters/active_record/association'
 require 'rails_admin/adapters/active_record/object_extension'

lib/rails_admin/adapters/active_record/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module ActiveRecord

lib/rails_admin/adapters/active_record/object_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module ActiveRecord

lib/rails_admin/adapters/active_record/property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module ActiveRecord

lib/rails_admin/adapters/mongoid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 require 'rails_admin/config/sections/list'
 require 'rails_admin/adapters/mongoid/association'

lib/rails_admin/adapters/mongoid/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module Mongoid

lib/rails_admin/adapters/mongoid/bson.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 
 module RailsAdmin

lib/rails_admin/adapters/mongoid/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module Mongoid

lib/rails_admin/adapters/mongoid/object_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module Mongoid

lib/rails_admin/adapters/mongoid/property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module Mongoid

lib/rails_admin/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/model'
 require 'rails_admin/config/sections/list'
 require 'active_support/core_ext/module/attribute_accessors'
@@ -260,7 +262,7 @@ def model(entity, &block)
       def asset_source
         @asset_source ||=
           begin
-            warn <<-MSG.gsub(/^ +/, '').freeze
+            warn <<-MSG.gsub(/^ +/, '')
               [Warning] After upgrading RailsAdmin to 3.x you haven't set asset_source yet, using :sprockets as the default.
               To suppress this message, run 'rails rails_admin:install' to setup the asset delivery method suitable to you.
             MSG

lib/rails_admin/config/actions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/proxyable'
 require 'rails_admin/config/configurable'
 require 'rails_admin/config/hideable'

lib/rails_admin/config/actions/bulk_delete.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/dashboard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/delete.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/edit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/export.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/history_index.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/history_show.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/index.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'activemodel-serializers-xml'
 
 module RailsAdmin

lib/rails_admin/config/actions/new.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/show.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/actions/show_in_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

lib/rails_admin/config/configurable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     # A module for all configurables.

lib/rails_admin/config/fields.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Fields

lib/rails_admin/config/fields/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config'
 require 'rails_admin/config/fields/base'
 

lib/rails_admin/config/fields/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/proxyable'
 require 'rails_admin/config/configurable'
 require 'rails_admin/config/hideable'

lib/rails_admin/config/fields/factories/action_text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 

lib/rails_admin/config/fields/factories/active_storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'

lib/rails_admin/config/fields/factories/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/belongs_to_association'

lib/rails_admin/config/fields/factories/carrierwave.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'

lib/rails_admin/config/fields/factories/devise.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/password'

lib/rails_admin/config/fields/factories/dragonfly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'

lib/rails_admin/config/fields/factories/enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types/enum'
 require 'rails_admin/config/fields/types/active_record_enum'

lib/rails_admin/config/fields/factories/paperclip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'

lib/rails_admin/config/fields/factories/password.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types/password'
 

lib/rails_admin/config/fields/factories/shrine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'

lib/rails_admin/config/fields/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string/inflections'
 require 'rails_admin/config/proxyable'
 require 'rails_admin/config/configurable'

lib/rails_admin/config/fields/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string/inflections'
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/association'

lib/rails_admin/config/fields/types/action_text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/text'
 
 module RailsAdmin

lib/rails_admin/config/fields/types/active_record_enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/enum'
 
 module RailsAdmin

lib/rails_admin/config/fields/types/active_storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/file_upload'
 
 module RailsAdmin

lib/rails_admin/config/fields/types/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/action_text'
 require 'rails_admin/config/fields/types/active_record_enum'
 require 'rails_admin/config/fields/types/active_storage'

lib/rails_admin/config/fields/types/belongs_to_association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/association'
 
 module RailsAdmin

lib/rails_admin/config/fields/types/boolean.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Fields

lib/rails_admin/config/fields/types/bson_object_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/string'
 
 module RailsAdmin

lib/rails_admin/config/fields/types/carrierwave.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/base'
 require 'rails_admin/config/fields/types/file_upload'