chore: auto-fix linting, fix frozen string literal violations, fix env access in specs

Author: chemica

Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
@@ -14,7 +16,9 @@ guard :rspec, cmd: 'bundle exec rspec' do
   # Rails example
   watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  do |m|
+    ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"]
+  end
   watch(%r{^spec/support/(.+)\.rb$})                  { 'spec' }
   watch('config/routes.rb')                           { 'spec/routing' }
   watch('app/controllers/application_controller.rb')  { 'spec/controllers' }
@@ -25,5 +29,7 @@ guard :rspec, cmd: 'bundle exec rspec' do
 
   # Turnip features and steps
   watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+  end
 end

Rakefile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 def exit_exception(e)
-  $stderr.puts e.message
+  warn e.message
   exit e.status_code
 end
 
@@ -8,7 +10,7 @@ begin
   require 'bundler'
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts 'Run `bundle install` to install missing gems'
+  warn 'Run `bundle install` to install missing gems'
   exit_exception(e)
 end
 
@@ -28,7 +30,7 @@ require 'mg'
 begin
   MG.new('annotate.gemspec')
 rescue Exception
-  $stderr.puts("WARNING: Couldn't read gemspec.  As such, a number of tasks may be unavailable to you until you run 'rake gem:gemspec' to correct the issue.")
+  warn("WARNING: Couldn't read gemspec.  As such, a number of tasks may be unavailable to you until you run 'rake gem:gemspec' to correct the issue.")
   # Gemspec is probably in a broken state, so let's give ourselves a chance to
   # build a new one...
 end
@@ -54,9 +56,7 @@ namespace :gem do
 
       Bundler.load.dependencies_for(*RUNTIME_GROUPS).each do |dep|
         runtime_resolved = Bundler.definition.specs_for(RUNTIME_GROUPS).find { |spec| spec.name == dep.name }
-        unless runtime_resolved.nil?
-          gem.add_dependency(dep.name, dep.requirement)
-        end
+        gem.add_dependency(dep.name, dep.requirement) unless runtime_resolved.nil?
       end
 
       gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
@@ -73,7 +73,7 @@ namespace :gem do
           fn =~ /^pkg/ ||
           fn =~ /^spec/ ||
           fn =~ /^doc/ ||
-          fn =~ /^vendor\/cache/
+          fn =~ %r{^vendor/cache}
       end.sort
     end
     File.open('annotate.gemspec', 'wb') do |fh|
@@ -135,21 +135,22 @@ namespace :integration do
     target_dir = File.expand_path(ENV['TARGET']) if ENV['TARGET']
     raise 'Must specify TARGET=x, where x is an integration test scenario!' unless target_dir && Dir.exist?(target_dir)
     raise 'TARGET directory must be within spec/integration/!' unless target_dir.start_with?(integration_dir)
+
     candidates = {}
     FileList[
       "#{target_dir}/.rvmrc",
       "#{target_dir}/**/*"
     ].select { |fname| !(File.symlink?(fname) || File.directory?(fname)) }
       .map { |fname| fname.sub(integration_dir, '') }
       .reject do |fname|
-        fname =~ /\/\.gitkeep$/ ||
-          fname =~ /\/app\/models\// ||
-          fname =~ /\/routes\.rb$/ ||
-          fname =~ /\/fixtures\// ||
-          fname =~ /\/factories\// ||
+        fname =~ %r{/\.gitkeep$} ||
+          fname =~ %r{/app/models/} ||
+          fname =~ %r{/routes\.rb$} ||
+          fname =~ %r{/fixtures/} ||
+          fname =~ %r{/factories/} ||
           fname =~ /\.sqlite3$/ ||
-          (fname =~ /\/test\// && fname !~ /_helper\.rb$/) ||
-          (fname =~ /\/spec\// && fname !~ /_helper\.rb$/)
+          (fname =~ %r{/test/} && fname !~ /_helper\.rb$/) ||
+          (fname =~ %r{/spec/} && fname !~ /_helper\.rb$/)
       end
       .map { |fname| "#{integration_dir}#{fname}" }
       .each do |fname|
@@ -164,9 +165,11 @@ namespace :integration do
 
     candidates.each_key do |digest|
       next unless fixtures.key?(digest)
+
       candidates[digest].each do |fname|
         # Double-check contents in case of hash collision...
         next unless FileUtils.identical?(fname, fixtures[digest])
+
         destination_dir = Pathname.new(File.dirname(fname))
         relative_target = Pathname.new(fixtures[digest]).relative_path_from(destination_dir)
         Dir.chdir(destination_dir) do

annotate.gemspec

@@ -1,5 +1,6 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'annotate/version'
 
@@ -18,15 +19,14 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/ctran/annotate_models'
   s.licenses = ['Ruby']
   s.require_paths = ['lib']
-  s.rubygems_version = '2.1.11'
   s.summary = 'Annotates Rails Models, routes, fixtures, and others based on the database schema.'
 
-  s.specification_version = 4 if s.respond_to? :specification_version
-  s.add_runtime_dependency(%q<rake>, '>= 10.4', '< 14.0')
-  s.add_runtime_dependency(%q<activerecord>, ['>= 3.2', '< 8.0'])
+  s.add_dependency('activerecord', ['>= 8.0.0', '< 9'])
+  s.add_dependency('rake', '>= 10.4', '< 14.0')
 
   s.metadata = {
-    "bug_tracker_uri" => "https://github.com/ctran/annotate_models/issues/",
-    "source_code_uri" => "https://github.com/ctran/annotate_models.git"
+    'bug_tracker_uri' => 'https://github.com/ctran/annotate_models/issues/',
+    'source_code_uri' => 'https://github.com/ctran/annotate_models.git',
+    'rubygems_mfa_required' => 'true'
   }
 end

bin/annotate

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-unless File.exist?('./Rakefile') || File.exist?('./Gemfile')
-  abort 'Please run annotate from the root of the project.'
-end
+abort 'Please run annotate from the root of the project.' unless File.exist?('./Rakefile') || File.exist?('./Gemfile')
 
 require 'rubygems'
 begin
@@ -11,7 +10,7 @@ begin
 rescue StandardError
 end
 
-here = File.expand_path(File.dirname __FILE__)
+here = __dir__
 $LOAD_PATH << "#{here}/../lib"
 
 require 'annotate'
@@ -24,7 +23,7 @@ options_result = Annotate::Parser.parse(ARGV)
 exit if options_result[:exit]
 
 options = Annotate.setup_options(
-  is_rake: ENV['is_rake'] && !ENV['is_rake'].empty?
+  is_rake: ENV.fetch('is_rake', nil) && !ENV['is_rake'].empty?
 )
 Annotate.eager_load(options) if Annotate::Helpers.include_models?
 

lib/annotate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'annotate/version'
 require 'annotate/annotate_models'
@@ -21,6 +23,7 @@ module Annotate
   #
   def self.set_defaults(options = {})
     return if @has_set_defaults
+
     @has_set_defaults = true
 
     options = ActiveSupport::HashWithIndifferentAccess.new(options)
@@ -44,20 +47,23 @@ def self.set_defaults(options = {})
   #
   def self.setup_options(options = {})
     Constants::POSITION_OPTIONS.each do |key|
-      options[key] = Annotate::Helpers.fallback(ENV[key.to_s], ENV['position'], 'before')
+      options[key] = Annotate::Helpers.fallback(ENV.fetch(key.to_s, nil), ENV.fetch('position', nil), 'before')
     end
     Constants::FLAG_OPTIONS.each do |key|
-      options[key] = Annotate::Helpers.true?(ENV[key.to_s])
+      options[key] = Annotate::Helpers.true?(ENV.fetch(key.to_s, nil))
     end
     Constants::OTHER_OPTIONS.each do |key|
-      options[key] = !ENV[key.to_s].blank? ? ENV[key.to_s] : nil
+      options[key] = ENV[key.to_s].blank? ? nil : ENV.fetch(key.to_s, nil)
     end
     Constants::PATH_OPTIONS.each do |key|
-      options[key] = !ENV[key.to_s].blank? ? ENV[key.to_s].split(',') : []
+      options[key] = ENV[key.to_s].blank? ? [] : ENV[key.to_s].split(',')
     end
 
     options[:additional_file_patterns] ||= []
-    options[:additional_file_patterns] = options[:additional_file_patterns].split(',') if options[:additional_file_patterns].is_a?(String)
+    if options[:additional_file_patterns].is_a?(String)
+      options[:additional_file_patterns] =
+        options[:additional_file_patterns].split(',')
+    end
     options[:model_dir] = ['app/models'] if options[:model_dir].empty?
 
     options[:wrapper_open] ||= options[:wrapper]
@@ -111,15 +117,15 @@ def self.bootstrap_rake
       require 'rake/dsl_definition'
     rescue StandardError => e
       # We might just be on an old version of Rake...
-      $stderr.puts e.message
+      warn e.message
       exit e.status_code
     end
     require 'rake'
 
     load './Rakefile' if File.exist?('./Rakefile')
     begin
       Rake::Task[:environment].invoke
-    rescue
+    rescue StandardError
       nil
     end
     unless defined?(Rails)

lib/annotate/active_record_patch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # monkey patches
 
 module ::ActiveRecord