fix: fix obvious cop violations

Author: chemica

lib/annotate.rb

@@ -17,7 +17,8 @@
   require 'active_support/core_ext/blank'
 end
 
-module Annotate
+# Defines the Annotate module
+module Annotate # rubocop:disable Metrics/ModuleLength
   ##
   # Set default values that can be overridden via environment variables.
   #
@@ -95,7 +96,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

@@ -156,7 +156,7 @@ 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|
+      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)
@@ -172,7 +172,7 @@ def get_schema_info(klass, header, options = {}) # rubocop:disable Metrics/Metho
            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
@@ -215,7 +215,7 @@ def get_schema_info(klass, header, options = {}) # rubocop:disable Metrics/Metho
     end
 
     def get_schema_header_text(klass, options = {})
-      info = String.new("#\n")  # Create a new mutable string
+      info = String.new("#\n") # Create a new mutable string
       if options[:format_markdown]
         info << "# Table name: `#{klass.table_name}`\n"
         info << "#\n"
@@ -658,7 +658,7 @@ def get_model_class(file)
         if File.file?(file_path) && Kernel.require(file_path)
           retry
         elsif model_path =~ %r{/}
-          model_path = model_path.split('/')[1..-1].join('/').to_s
+          model_path = model_path.split('/')[1..].join('/').to_s
           retry
         else
           raise

lib/annotate/annotate_routes/header_generator.rb

@@ -59,7 +59,7 @@ def generate
       out << comment
       return out if contents_without_magic_comments.size.zero?
 
-      maxs = [HEADER_ROW.map(&:size)] + contents_without_magic_comments[1..-1].map { |line| line.split.map(&:size) }
+      maxs = [HEADER_ROW.map(&:size)] + contents_without_magic_comments[1..].map { |line| line.split.map(&:size) }
 
       if markdown?
         max = maxs.map(&:max).compact.max
@@ -70,7 +70,7 @@ def generate
         out << comment(content(contents_without_magic_comments[0], maxs))
       end
 
-      out += contents_without_magic_comments[1..-1].map do |line|
+      out += contents_without_magic_comments[1..].map do |line|
         comment(content(markdown? ? line.split(' ') : line, maxs))
       end
       out << comment(options[:wrapper_close]) if options[:wrapper_close]

lib/annotate/parser.rb

@@ -4,7 +4,7 @@
 
 module Annotate
   # Class for handling command line arguments
-  class Parser # rubocop:disable Metrics/ClassLength
+  class Parser
     def self.parse(args, env = {})
       new(args, env).parse
     end

spec/lib/annotate/annotate_models/file_patterns_spec.rb

@@ -5,7 +5,7 @@
 
 describe AnnotateModels::FilePatterns do
   describe '.by_pattern' do
-    subject { AnnotateModels::FilePatterns.generate(root_directory, pattern_type, options) }
+    let(:file_patterns) { described_class.generate(root_directory, pattern_type, options) }
 
     let(:root_directory) { '/root' }
     let(:options) { {} }
@@ -14,70 +14,70 @@
       let(:pattern_type) { 'test' }
 
       it 'returns patterns of test files' do
-        is_expected.to eq([
-                            '/root/test/unit/%MODEL_NAME%_test.rb',
-                            '/root/test/models/%MODEL_NAME%_test.rb',
-                            '/root/spec/models/%MODEL_NAME%_spec.rb'
-                          ])
+        expect(file_patterns).to eq([
+                                      '/root/test/unit/%MODEL_NAME%_test.rb',
+                                      '/root/test/models/%MODEL_NAME%_test.rb',
+                                      '/root/spec/models/%MODEL_NAME%_spec.rb'
+                                    ])
       end
     end
 
     context 'when pattern_type is "fixture"' do
       let(:pattern_type) { 'fixture' }
 
       it 'returns patterns of fixture files' do
-        is_expected.to eq([
-                            '/root/test/fixtures/%TABLE_NAME%.yml',
-                            '/root/spec/fixtures/%TABLE_NAME%.yml',
-                            '/root/test/fixtures/%PLURALIZED_MODEL_NAME%.yml',
-                            '/root/spec/fixtures/%PLURALIZED_MODEL_NAME%.yml'
-                          ])
+        expect(file_patterns).to eq([
+                                      '/root/test/fixtures/%TABLE_NAME%.yml',
+                                      '/root/spec/fixtures/%TABLE_NAME%.yml',
+                                      '/root/test/fixtures/%PLURALIZED_MODEL_NAME%.yml',
+                                      '/root/spec/fixtures/%PLURALIZED_MODEL_NAME%.yml'
+                                    ])
       end
     end
 
     context 'when pattern_type is "scaffold"' do
       let(:pattern_type) { 'scaffold' }
 
       it 'returns patterns of scaffold files' do
-        is_expected.to eq([
-                            '/root/test/controllers/%PLURALIZED_MODEL_NAME%_controller_test.rb',
-                            '/root/spec/controllers/%PLURALIZED_MODEL_NAME%_controller_spec.rb',
-                            '/root/spec/requests/%PLURALIZED_MODEL_NAME%_spec.rb',
-                            '/root/spec/routing/%PLURALIZED_MODEL_NAME%_routing_spec.rb'
-                          ])
+        expect(file_patterns).to eq([
+                                      '/root/test/controllers/%PLURALIZED_MODEL_NAME%_controller_test.rb',
+                                      '/root/spec/controllers/%PLURALIZED_MODEL_NAME%_controller_spec.rb',
+                                      '/root/spec/requests/%PLURALIZED_MODEL_NAME%_spec.rb',
+                                      '/root/spec/routing/%PLURALIZED_MODEL_NAME%_routing_spec.rb'
+                                    ])
       end
     end
 
     context 'when pattern_type is "factory"' do
       let(:pattern_type) { 'factory' }
 
       it 'returns patterns of factory files' do
-        is_expected.to eq([
-                            '/root/test/exemplars/%MODEL_NAME%_exemplar.rb',
-                            '/root/spec/exemplars/%MODEL_NAME%_exemplar.rb',
-                            '/root/test/blueprints/%MODEL_NAME%_blueprint.rb',
-                            '/root/spec/blueprints/%MODEL_NAME%_blueprint.rb',
-                            '/root/test/factories/%MODEL_NAME%_factory.rb',
-                            '/root/spec/factories/%MODEL_NAME%_factory.rb',
-                            '/root/test/factories/%TABLE_NAME%.rb',
-                            '/root/spec/factories/%TABLE_NAME%.rb',
-                            '/root/test/factories/%PLURALIZED_MODEL_NAME%.rb',
-                            '/root/spec/factories/%PLURALIZED_MODEL_NAME%.rb',
-                            '/root/test/fabricators/%MODEL_NAME%_fabricator.rb',
-                            '/root/spec/fabricators/%MODEL_NAME%_fabricator.rb'
-                          ])
+        expect(file_patterns).to eq([
+                                      '/root/test/exemplars/%MODEL_NAME%_exemplar.rb',
+                                      '/root/spec/exemplars/%MODEL_NAME%_exemplar.rb',
+                                      '/root/test/blueprints/%MODEL_NAME%_blueprint.rb',
+                                      '/root/spec/blueprints/%MODEL_NAME%_blueprint.rb',
+                                      '/root/test/factories/%MODEL_NAME%_factory.rb',
+                                      '/root/spec/factories/%MODEL_NAME%_factory.rb',
+                                      '/root/test/factories/%TABLE_NAME%.rb',
+                                      '/root/spec/factories/%TABLE_NAME%.rb',
+                                      '/root/test/factories/%PLURALIZED_MODEL_NAME%.rb',
+                                      '/root/spec/factories/%PLURALIZED_MODEL_NAME%.rb',
+                                      '/root/test/fabricators/%MODEL_NAME%_fabricator.rb',
+                                      '/root/spec/fabricators/%MODEL_NAME%_fabricator.rb'
+                                    ])
       end
     end
 
     context 'when pattern_type is "serializer"' do
       let(:pattern_type) { 'serializer' }
 
       it 'returns patterns of serializer files' do
-        is_expected.to eq([
-                            '/root/app/serializers/%MODEL_NAME%_serializer.rb',
-                            '/root/test/serializers/%MODEL_NAME%_serializer_test.rb',
-                            '/root/spec/serializers/%MODEL_NAME%_serializer_spec.rb'
-                          ])
+        expect(file_patterns).to eq([
+                                      '/root/app/serializers/%MODEL_NAME%_serializer.rb',
+                                      '/root/test/serializers/%MODEL_NAME%_serializer_test.rb',
+                                      '/root/spec/serializers/%MODEL_NAME%_serializer_spec.rb'
+                                    ])
       end
     end
 
@@ -95,15 +95,15 @@
         let(:options) { { additional_file_patterns: } }
 
         it 'returns additional_file_patterns in the argument "options"' do
-          is_expected.to eq(additional_file_patterns)
+          expect(file_patterns).to eq(additional_file_patterns)
         end
       end
 
       context 'when additional_file_patterns is not specified in the options' do
         let(:options) { {} }
 
         it 'returns an empty array' do
-          is_expected.to eq([])
+          expect(file_patterns).to eq([])
         end
       end
     end
@@ -112,27 +112,27 @@
       let(:pattern_type) { 'controller' }
 
       it 'returns patterns of controller files' do
-        is_expected.to eq([
-                            '/root/app/controllers/%PLURALIZED_MODEL_NAME%_controller.rb'
-                          ])
+        expect(file_patterns).to eq([
+                                      '/root/app/controllers/%PLURALIZED_MODEL_NAME%_controller.rb'
+                                    ])
       end
     end
 
     context 'when pattern_type is "admin"' do
       let(:pattern_type) { 'admin' }
 
       it 'returns both singular and pluralized model names' do
-        is_expected.to eq(['/root/app/admin/%MODEL_NAME%.rb', '/root/app/admin/%PLURALIZED_MODEL_NAME%.rb'])
+        expect(file_patterns).to eq(['/root/app/admin/%MODEL_NAME%.rb', '/root/app/admin/%PLURALIZED_MODEL_NAME%.rb'])
       end
     end
 
     context 'when pattern_type is "helper"' do
       let(:pattern_type) { 'helper' }
 
       it 'returns patterns of helper files' do
-        is_expected.to eq([
-                            '/root/app/helpers/%PLURALIZED_MODEL_NAME%_helper.rb'
-                          ])
+        expect(file_patterns).to eq([
+                                      '/root/app/helpers/%PLURALIZED_MODEL_NAME%_helper.rb'
+                                    ])
       end
     end
   end