Merge pull request #1 from groach/rails-8-support

Rails 8 support

Author: groach

.github/workflows/ci.yml

@@ -2,19 +2,19 @@ name: CI
 on:
   pull_request:
     branches:
-      - '*'
+      - "*"
 
   push:
     branches:
-      - '*'
+      - "*"
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7']
+        ruby: ["3.4.4"]
 
     steps:
       - name: Checkout

.rubocop.yml

@@ -7,12 +7,18 @@ require:
 
 AllCops:
   Exclude:
-    - 'vendor/**/*'
-    - 'spec/fixtures/**/*'
-    - 'tmp/**/*'
-    - 'spec/integration/**/*'
+    - "vendor/**/*"
+    - "spec/fixtures/**/*"
+    - "tmp/**/*"
+    - "spec/integration/**/*"
   NewCops: enable
 
 Metrics/BlockLength:
   Exclude:
-    - 'spec/**/*.rb'
+    - "spec/**/*.rb"
+Style/FetchEnvVar:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+RSpec/RemoveConst:
+  Enabled: false

.tool-versions

@@ -1 +1 @@
-ruby 2.7.3
+ruby 3.4.4

Gemfile

@@ -1,14 +1,13 @@
 source 'https://rubygems.org'
 
-ruby '>= 2.4.0'
+ruby '>= 3.0.0'
 
-gem 'activerecord', '>= 4.2.5', '< 6', require: false
+gem 'activerecord', '>= 4.2.5', '< 9', require: false
 gem 'rake', require: false
 
 group :development do
   gem 'bump'
   gem 'mg', require: false
-  gem 'travis', require: false
   platforms :mri, :mingw do
     gem 'yard', require: false
   end
@@ -19,17 +18,16 @@ group :development, :test do
   gem 'guard-rspec', require: false
   gem 'rspec', require: false
 
-  gem 'rubocop', '~> 1.12.0', require: false
+  gem 'rubocop', '~> 1.76.1', require: false
   gem 'rubocop-rake', require: false
-  gem 'rubocop-rspec', '~> 2.2.0', require: false
+  gem 'rubocop-rspec', '~> 3.6.0', require: false
   gem 'simplecov', require: false
   gem 'terminal-notifier-guard', require: false
 
   gem 'codeclimate-test-reporter'
   gem 'coveralls'
 
   gem 'overcommit'
-  gem 'ruby_dep', '1.5.0'
 
   platforms :mri, :mingw do
     gem 'pry', require: false

annotate.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.name = 'annotate'
   s.version = Annotate.version
 
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 3.0.0'
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.authors = ['Alex Chaffee', 'Cuong Tran', 'Marcos Piccinini', 'Turadg Aleahmad', 'Jon Frisby']
   s.description = 'Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema.'
@@ -18,15 +18,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(%q<rake>, '>= 10.4', '< 14.0')
+  s.add_dependency(%q<activerecord>, ['>= 3.2', '< 9.0'])
 
   s.metadata = {
     "bug_tracker_uri" => "https://github.com/ctran/annotate_models/issues/",
-    "source_code_uri" => "https://github.com/ctran/annotate_models.git"
+    "source_code_uri" => "https://github.com/ctran/annotate_models.git",
+    'rubygems_mfa_required' => 'true'
   }
 end

lib/annotate.rb

@@ -35,7 +35,7 @@ def self.set_defaults(options = {})
       end
 
       default_value = ENV[key.to_s] unless ENV[key.to_s].blank?
-      ENV[key.to_s] = default_value.nil? ? nil : default_value.to_s
+      ENV[key.to_s] = default_value&.to_s
     end
   end
 
@@ -89,7 +89,7 @@ def self.eager_load(options)
       if Rails.version.split('.').first.to_i < 3
         Rails.configuration.eager_load_paths.each do |load_path|
           matcher = /\A#{Regexp.escape(load_path)}(.*)\.rb\Z/
-          Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
+          Dir.glob("#{load_path}/**/*.rb").each do |file|
             require_dependency file.sub(matcher, '\1')
           end
         end

lib/annotate/annotate_models.rb

@@ -39,7 +39,7 @@ module AnnotateModels
     }
   }.freeze
 
-  MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*(?:\n|r\n))|(^# coding:.*(?:\n|\r\n))|(^# -\*- coding:.*(?:\n|\r\n))|(^# -\*- encoding\s?:.*(?:\n|\r\n))|(^#\s*frozen_string_literal:.+(?:\n|\r\n))|(^# -\*- frozen_string_literal\s*:.+-\*-(?:\n|\r\n))/).freeze
+  MAGIC_COMMENT_MATCHER = /(^#\s*encoding:.*(?:\n|r\n))|(^# coding:.*(?:\n|\r\n))|(^# -\*- coding:.*(?:\n|\r\n))|(^# -\*- encoding\s?:.*(?:\n|\r\n))|(^#\s*frozen_string_literal:.+(?:\n|\r\n))|(^# -\*- frozen_string_literal\s*:.+-\*-(?:\n|\r\n))/
 
   class << self
     def annotate_pattern(options = {})
@@ -155,8 +155,8 @@ def get_schema_info(klass, header, options = {}) # rubocop:disable Metrics/Metho
       with_comments_column = with_comments_column?(klass, options)
 
       # Precalculate Values
-      cols_meta = cols.map do |col|
-        col_comment = with_comments || with_comments_column ? col.comment&.gsub(/\n/, "\\n") : nil
+      cols_meta = cols.to_h do |col|
+        col_comment = with_comments || with_comments_column ? col.comment&.gsub("\n", "\\n") : nil
         col_type = get_col_type(col)
         attrs = get_attributes(col, col_type, klass, options)
         col_name = if with_comments && col_comment
@@ -166,7 +166,7 @@ def get_schema_info(klass, header, options = {}) # rubocop:disable Metrics/Metho
                    end
         simple_formatted_attrs = attrs.join(", ")
         [col.name, { col_type: col_type, attrs: attrs, col_name: col_name, simple_formatted_attrs: simple_formatted_attrs, col_comment: col_comment }]
-      end.to_h
+      end
 
       # Output annotation
       bare_max_attrs_length = cols_meta.map { |_, m| m[:simple_formatted_attrs].length }.max
@@ -179,15 +179,15 @@ def get_schema_info(klass, header, options = {}) # rubocop:disable Metrics/Metho
         col_comment = cols_meta[col.name][:col_comment]
 
         if options[:format_rdoc]
-          info << sprintf("# %-#{max_size}.#{max_size}s<tt>%s</tt>", "*#{col_name}*::", attrs.unshift(col_type).join(", ")).rstrip + "\n"
+          info << (sprintf("# %-#{max_size}.#{max_size}s<tt>%s</tt>", "*#{col_name}*::", attrs.unshift(col_type).join(", ")).rstrip + "\n")
         elsif options[:format_yard]
-          info << sprintf("# @!attribute #{col_name}") + "\n"
+          info << ("# @!attribute #{col_name}" + "\n")
           ruby_class = col.respond_to?(:array) && col.array ? "Array<#{map_col_type_to_ruby_classes(col_type)}>": map_col_type_to_ruby_classes(col_type)
-          info << sprintf("#   @return [#{ruby_class}]") + "\n"
+          info << ("#   @return [#{ruby_class}]" + "\n")
         elsif options[:format_markdown]
           name_remainder = max_size - col_name.length - non_ascii_length(col_name)
           type_remainder = (md_type_allowance - 2) - col_type.length
-          info << (sprintf("# **`%s`**%#{name_remainder}s | `%s`%#{type_remainder}s | `%s`", col_name, " ", col_type, " ", attrs.join(", ").rstrip)).gsub('``', '  ').rstrip + "\n"
+          info << ((sprintf("# **`%s`**%#{name_remainder}s | `%s`%#{type_remainder}s | `%s`", col_name, " ", col_type, " ", attrs.join(", ").rstrip)).gsub('``', '  ').rstrip + "\n")
         elsif with_comments_column
           info << format_default(col_name, max_size, col_type, bare_type_allowance, simple_formatted_attrs, bare_max_attrs_length, col_comment)
         else
@@ -423,7 +423,7 @@ def get_check_constraint_info(klass, options = {})
     #  :position_in_*<Symbol>:: where to place the annotated section in fixture or model file,
     #                           :before, :top, :after or :bottom. Default is :before.
     #
-    def annotate_one_file(file_name, info_block, position, options = {})
+    def annotate_one_file?(file_name, info_block, position, options = {})
       return false unless File.exist?(file_name)
       old_content = File.read(file_name)
       return false if old_content =~ /#{SKIP_ANNOTATION_PREFIX}.*\n/
@@ -486,7 +486,7 @@ def magic_comments_as_string(content)
       end
     end
 
-    def remove_annotation_of_file(file_name, options = {})
+    def remove_annotation_of_file?(file_name, options = {})
       if File.exist?(file_name)
         content = File.read(file_name)
         return false if content =~ /#{SKIP_ANNOTATION_PREFIX}.*\n/
@@ -542,7 +542,7 @@ def annotate(klass, file, header, options = {})
         model_file_name = File.join(file)
         annotated = []
 
-        if annotate_one_file(model_file_name, info, :position_in_class, options_with_position(options, :position_in_class))
+        if annotate_one_file?(model_file_name, info, :position_in_class, options_with_position(options, :position_in_class))
           annotated << model_file_name
         end
 
@@ -563,7 +563,7 @@ def annotate(klass, file, header, options = {})
             .map { |f| expand_glob_into_files(f) }
             .flatten
             .each do |f|
-              if annotate_one_file(f, info, position_key, options_with_position(options, position_key))
+              if annotate_one_file?(f, info, position_key, options_with_position(options, position_key))
                 annotated << f
               end
             end
@@ -694,7 +694,7 @@ def parse_options(options = {})
     end
 
     def split_model_dir(option_value)
-      option_value = option_value.is_a?(Array) ? option_value : option_value.split(',')
+      option_value = option_value.split(',') unless option_value.is_a?(Array)
       option_value.map(&:strip).reject(&:empty?)
     end
 
@@ -762,13 +762,13 @@ def remove_annotations(options = {})
             model_name = klass.name.underscore
             table_name = klass.table_name
             model_file_name = file
-            deannotated_klass = true if remove_annotation_of_file(model_file_name, options)
+            deannotated_klass = true if remove_annotation_of_file?(model_file_name, options)
 
             get_patterns(options, matched_types(options))
               .map { |f| resolve_filename(f, model_name, table_name) }
               .each do |f|
                 if File.exist?(f)
-                  remove_annotation_of_file(f, options)
+                  remove_annotation_of_file?(f, options)
                   deannotated_klass = true
                 end
               end

lib/annotate/annotate_routes.rb

@@ -18,8 +18,8 @@
 # Released under the same license as Ruby. No Support. No Warranty.
 #
 
-require_relative './annotate_routes/helpers'
-require_relative './annotate_routes/header_generator'
+require_relative 'annotate_routes/helpers'
+require_relative 'annotate_routes/header_generator'
 
 module AnnotateRoutes
   class << self
@@ -95,7 +95,7 @@ def rewrite_contents(existing_text, new_text, frozen)
     def annotate_routes(header, content, header_position, options = {})
       magic_comments_map, content = Helpers.extract_magic_comments_from_array(content)
       if %w(before top).include?(options[:position_in_routes])
-        header = header << '' if content.first != ''
+        header <<= '' if content.first != ''
         magic_comments_map << '' if magic_comments_map.any?
         new_content = magic_comments_map + header + content
       else

lib/annotate/annotate_routes/header_generator.rb

@@ -1,4 +1,4 @@
-require_relative './helpers'
+require_relative 'helpers'
 
 module AnnotateRoutes
   class HeaderGenerator
@@ -16,7 +16,7 @@ def generate(options = {})
       private
 
       def routes_map(options)
-        result = `rake routes`.chomp("\n").split(/\n/, -1)
+        result = `rake routes`.chomp("\n").split("\n", -1)
 
         # In old versions of Rake, the first line of output was the cwd.  Not so
         # much in newer ones.  We ditch that line if it exists, and if not, we
@@ -29,7 +29,7 @@ def routes_map(options)
         # Skip routes which match given regex
         # Note: it matches the complete line (route_name, path, controller/action)
         if regexp_for_ignoring_routes
-          result.reject { |line| line =~ regexp_for_ignoring_routes }
+          result.grep_v(regexp_for_ignoring_routes)
         else
           result
         end
@@ -44,18 +44,16 @@ def initialize(options, routes_map)
     def generate
       magic_comments_map, contents_without_magic_comments = Helpers.extract_magic_comments_from_array(routes_map)
 
-      out = []
-
-      magic_comments_map.each do |magic_comment|
-        out << magic_comment
+      out = magic_comments_map.map do |magic_comment|
+        magic_comment
       end
       out << '' if magic_comments_map.any?
 
       out << comment(options[:wrapper_open]) if options[:wrapper_open]
 
-      out << comment(markdown? ? PREFIX_MD : PREFIX) + timestamp_if_required
+      out << (comment(markdown? ? PREFIX_MD : PREFIX) + timestamp_if_required)
       out << comment
-      return out if contents_without_magic_comments.size.zero?
+      return out if contents_without_magic_comments.empty?
 
       maxs = [HEADER_ROW.map(&:size)] + contents_without_magic_comments[1..-1].map { |line| line.split.map(&:size) }
 

lib/annotate/annotate_routes/helpers.rb

@@ -1,6 +1,6 @@
 module AnnotateRoutes
   module Helpers
-    MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze
+    MAGIC_COMMENT_MATCHER = /(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/
 
     class << self
       # TODO: write the method doc using ruby rdoc formats
@@ -15,7 +15,7 @@ def strip_annotations(content)
         mode = :content
         header_position = 0
 
-        content.split(/\n/, -1).each_with_index do |line, line_number|
+        content.split("\n", -1).each_with_index do |line, line_number|
           if mode == :header && line !~ /\s*#/
             mode = :content
             real_content << line unless line.blank?