Merge branch 'develop' into tmr08c-fix-multi-line-comments

Author: tmr08c

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
           bundle install --jobs=4 --retry=3
 
       - name: Run Tests
-        run: bundle exec rspec
+        run: INTEGRATION_TESTS=1 bundle exec rspec
 
       - name: Rubocop
         run: bundle exec rubocop

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-03-01 03:15:48 +0900 using RuboCop version 0.68.1.
+# on 2020-04-03 00:51:53 +0900 using RuboCop version 0.68.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -163,12 +163,11 @@ Lint/InheritException:
   Exclude:
     - 'lib/annotate/annotate_models.rb'
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: MaximumRangeSize.
 Lint/MissingCopEnableDirective:
   Exclude:
     - 'lib/annotate/annotate_models.rb'
-    - 'lib/annotate/annotate_routes.rb'
 
 # Offense count: 2
 Lint/RescueException:
@@ -213,7 +212,7 @@ Naming/AccessorMethodName:
   Exclude:
     - 'lib/annotate.rb'
 
-# Offense count: 103
+# Offense count: 102
 # Configuration parameters: Blacklist.
 # Blacklist: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
 Naming/HeredocDelimiterNaming:
@@ -235,12 +234,13 @@ Naming/UncommunicativeMethodParamName:
   Exclude:
     - 'Rakefile'
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: inline, group
 Style/AccessModifierDeclarations:
   Exclude:
     - 'lib/annotate/annotate_models.rb'
+    - 'lib/annotate/annotate_routes/header_generator.rb'
 
 # Offense count: 1
 Style/CaseEquality:
@@ -266,7 +266,7 @@ Style/Dir:
   Exclude:
     - 'bin/annotate'
 
-# Offense count: 9
+# Offense count: 10
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -275,6 +275,7 @@ Style/Documentation:
     - 'lib/annotate/active_record_patch.rb'
     - 'lib/annotate/annotate_models.rb'
     - 'lib/annotate/annotate_routes.rb'
+    - 'lib/annotate/annotate_routes/header_generator.rb'
     - 'lib/annotate/annotate_routes/helpers.rb'
     - 'lib/annotate/version.rb'
     - 'lib/generators/annotate/install_generator.rb'
@@ -293,14 +294,13 @@ Style/ExpandPathArguments:
   Exclude:
     - 'annotate.gemspec'
 
-# Offense count: 10
+# Offense count: 9
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: format, sprintf, percent
 Style/FormatString:
   Exclude:
     - 'lib/annotate/annotate_models.rb'
-    - 'lib/annotate/annotate_routes.rb'
 
 # Offense count: 23
 # Configuration parameters: EnforcedStyle.
@@ -309,7 +309,7 @@ Style/FormatStringToken:
   Exclude:
     - 'lib/annotate/annotate_models.rb'
 
-# Offense count: 27
+# Offense count: 28
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: when_needed, always, never
@@ -338,7 +338,7 @@ Style/IfUnlessModifier:
     - 'Rakefile'
     - 'bin/annotate'
     - 'lib/annotate/annotate_models.rb'
-    - 'lib/annotate/annotate_routes.rb'
+    - 'lib/annotate/annotate_routes/header_generator.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -432,15 +432,14 @@ Style/RedundantSelf:
   Exclude:
     - 'lib/tasks/annotate_models_migrate.rake'
 
-# Offense count: 13
+# Offense count: 12
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, AllowInnerSlashes.
 # SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
   Exclude:
     - 'Rakefile'
     - 'lib/annotate/annotate_models.rb'
-    - 'lib/annotate/annotate_routes.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -521,7 +520,7 @@ Style/UnneededPercentQ:
   Exclude:
     - 'annotate.gemspec'
 
-# Offense count: 377
+# Offense count: 375
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

.travis.yml

@@ -3,14 +3,9 @@ rvm:
   - 2.4.9
   - 2.5.7
   - 2.6.5
-  - ruby-head
 
 env:
-  - RAILS_ENV=development RACK_ENV=development
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
+  - RAILS_ENV=development RACK_ENV=development INTEGRATION_TESTS=1
 
 addons:
   apt_packages:
@@ -30,7 +25,7 @@ jobs:
   include:
     - stage: gem release
       if: tag =~ ^v
-      rvm: 2.6.0
+      rvm: 2.6.5
       script: echo "Deploying to rubygems.org ..."
       deploy:
         provider: rubygems

Gemfile

@@ -38,5 +38,4 @@ end
 group :test do
   gem 'files', require: false
   gem 'git', require: false
-  gem 'wrong', require: false
 end

lib/annotate/annotate_models.rb

@@ -249,49 +249,7 @@ def get_schema_info(klass, header, options = {})
       cols = columns(klass, options)
       cols.each do |col|
         col_type = get_col_type(col)
-        attrs = []
-        attrs << "default(#{schema_default(klass, col)})" unless col.default.nil? || hide_default?(col_type, options)
-        attrs << 'unsigned' if col.respond_to?(:unsigned?) && col.unsigned?
-        attrs << 'not null' unless col.null
-        attrs << 'primary key' if klass.primary_key && (klass.primary_key.is_a?(Array) ? klass.primary_key.collect(&:to_sym).include?(col.name.to_sym) : col.name.to_sym == klass.primary_key.to_sym)
-
-        if col_type == 'decimal'
-          col_type << "(#{col.precision}, #{col.scale})"
-        elsif !%w[spatial geometry geography].include?(col_type)
-          if col.limit && !options[:format_yard]
-            if col.limit.is_a? Array
-              attrs << "(#{col.limit.join(', ')})"
-            else
-              col_type << "(#{col.limit})" unless hide_limit?(col_type, options)
-            end
-          end
-        end
-
-        # Check out if we got an array column
-        attrs << 'is an Array' if col.respond_to?(:array) && col.array
-
-        # Check out if we got a geometric column
-        # and print the type and SRID
-        if col.respond_to?(:geometry_type)
-          attrs << "#{col.geometry_type}, #{col.srid}"
-        elsif col.respond_to?(:geometric_type) && col.geometric_type.present?
-          attrs << "#{col.geometric_type.to_s.downcase}, #{col.srid}"
-        end
-
-        # Check if the column has indices and print "indexed" if true
-        # If the index includes another column, print it too.
-        if options[:simple_indexes] && klass.table_exists?# Check out if this column is indexed
-          indices = retrieve_indexes_from_table(klass)
-          if indices = indices.select { |ind| ind.columns.include? col.name }
-            indices.sort_by(&:name).each do |ind|
-              next if ind.columns.is_a?(String)
-              ind = ind.columns.reject! { |i| i == col.name }
-              attrs << (ind.empty? ? "indexed" : "indexed => [#{ind.join(", ")}]")
-            end
-          end
-        end
-
-        # Generate the column name optionally including column comments
+        attrs = get_attributes(col, col_type, klass, options)
         col_name = if with_comments?(klass, options) && col.comment
                      "#{col.name}(#{col.comment.gsub(/\n/, "\\n")})"
                    else
@@ -812,7 +770,7 @@ def annotate_model_file(annotated, file, header, options)
       begin
         return false if /#{SKIP_ANNOTATION_PREFIX}.*/ =~ (File.exist?(file) ? File.read(file) : '')
         klass = get_model_class(file)
-        do_annotate = klass &&
+        do_annotate = klass.is_a?(Class) &&
           klass < ActiveRecord::Base &&
           (!options[:exclude_sti_subclasses] || !(klass.superclass < ActiveRecord::Base && klass.table_name == klass.superclass.table_name)) &&
           !klass.abstract_class? &&
@@ -999,6 +957,55 @@ def ignored_translation_table_colums(klass)
         foreign_column_name
       ]
     end
+
+    ##
+    # Get the list of attributes that should be included in the annotation for
+    # a given column.
+    def get_attributes(column, column_type, klass, options)
+      attrs = []
+      attrs << "default(#{schema_default(klass, column)})" unless column.default.nil? || hide_default?(column_type, options)
+      attrs << 'unsigned' if column.respond_to?(:unsigned?) && column.unsigned?
+      attrs << 'not null' unless column.null
+      attrs << 'primary key' if klass.primary_key && (klass.primary_key.is_a?(Array) ? klass.primary_key.collect(&:to_sym).include?(column.name.to_sym) : column.name.to_sym == klass.primary_key.to_sym)
+
+      if column_type == 'decimal'
+        column_type << "(#{column.precision}, #{column.scale})"
+      elsif !%w[spatial geometry geography].include?(column_type)
+        if column.limit && !options[:format_yard]
+          if column.limit.is_a? Array
+            attrs << "(#{column.limit.join(', ')})"
+          else
+            column_type << "(#{column.limit})" unless hide_limit?(column_type, options)
+          end
+        end
+      end
+
+      # Check out if we got an array columnumn
+      attrs << 'is an Array' if column.respond_to?(:array) && column.array
+
+      # Check out if we got a geometric columnumn
+      # and print the type and SRID
+      if column.respond_to?(:geometry_type)
+        attrs << "#{column.geometry_type}, #{column.srid}"
+      elsif column.respond_to?(:geometric_type) && column.geometric_type.present?
+        attrs << "#{column.geometric_type.to_s.downcase}, #{column.srid}"
+      end
+
+      # Check if the column has indices and print "indexed" if true
+      # If the index includes another column, print it too.
+      if options[:simple_indexes] && klass.table_exists?# Check out if this column is indexed
+        indices = retrieve_indexes_from_table(klass)
+        if indices = indices.select { |ind| ind.columns.include? column.name }
+          indices.sort_by(&:name).each do |ind|
+            next if ind.columns.is_a?(String)
+            ind = ind.columns.reject! { |i| i == column.name }
+            attrs << (ind.empty? ? "indexed" : "indexed => [#{ind.join(", ")}]")
+          end
+        end
+      end
+
+      attrs
+    end
   end
 
   class BadModelFileError < LoadError

lib/annotate/annotate_routes.rb

@@ -1,5 +1,3 @@
-# rubocop:disable  Metrics/ModuleLength
-
 # == Annotate Routes
 #
 # Based on:
@@ -21,18 +19,15 @@
 #
 
 require_relative './annotate_routes/helpers'
+require_relative './annotate_routes/header_generator'
 
 module AnnotateRoutes
-  PREFIX = '== Route Map'.freeze
-  PREFIX_MD = '## Route Map'.freeze
-  HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action'].freeze
-
   class << self
     def do_annotations(options = {})
       if routes_file_exist?
         existing_text = File.read(routes_file)
         content, header_position = Helpers.strip_annotations(existing_text)
-        new_content = annotate_routes(header(options), content, header_position, options)
+        new_content = annotate_routes(HeaderGenerator.generate(options), content, header_position, options)
         new_text = new_content.join("\n")
 
         if rewrite_contents(existing_text, new_text)
@@ -71,49 +66,6 @@ def routes_file
       @routes_rb ||= File.join('config', 'routes.rb')
     end
 
-    def header(options = {})
-      routes_map = app_routes_map(options)
-
-      magic_comments_map, routes_map = Helpers.extract_magic_comments_from_array(routes_map)
-
-      out = []
-
-      magic_comments_map.each do |magic_comment|
-        out << magic_comment
-      end
-      out << '' if magic_comments_map.any?
-
-      out << comment(options[:wrapper_open]) if options[:wrapper_open]
-
-      out << comment(options[:format_markdown] ? PREFIX_MD : PREFIX) + (options[:timestamp] ? " (Updated #{Time.now.strftime('%Y-%m-%d %H:%M')})" : '')
-      out << comment
-      return out if routes_map.size.zero?
-
-      maxs = [HEADER_ROW.map(&:size)] + routes_map[1..-1].map { |line| line.split.map(&:size) }
-
-      if options[:format_markdown]
-        max = maxs.map(&:max).compact.max
-
-        out << comment(content(HEADER_ROW, maxs, options))
-        out << comment(content(['-' * max, '-' * max, '-' * max, '-' * max], maxs, options))
-      else
-        out << comment(content(routes_map[0], maxs, options))
-      end
-
-      out += routes_map[1..-1].map { |line| comment(content(options[:format_markdown] ? line.split(' ') : line, maxs, options)) }
-      out << comment(options[:wrapper_close]) if options[:wrapper_close]
-
-      out
-    end
-
-    def comment(row = '')
-      if row == ''
-        '#'
-      else
-        "# #{row}"
-      end
-    end
-
     def strip_on_removal(content, header_position)
       if header_position == :before
         content.shift while content.first == ''
@@ -162,32 +114,5 @@ def annotate_routes(header, content, header_position, options = {})
 
       new_content
     end
-
-    def app_routes_map(options)
-      routes_map = `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
-      # keep the line around.
-      routes_map.shift if routes_map.first =~ /^\(in \//
-
-      # Skip routes which match given regex
-      # Note: it matches the complete line (route_name, path, controller/action)
-      if options[:ignore_routes]
-        routes_map.reject! { |line| line =~ /#{options[:ignore_routes]}/ }
-      end
-
-      routes_map
-    end
-
-    def content(line, maxs, options = {})
-      return line.rstrip unless options[:format_markdown]
-
-      line.each_with_index.map do |elem, index|
-        min_length = maxs.map { |arr| arr[index] }.max || 0
-
-        sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
-      end.join(' | ')
-    end
   end
 end