git-lint 6.2.0 → 7.0.0

data/lib/git/lint/analyzer.rb

@@ -6,25 +6,25 @@ module Git
     class Analyzer
       include Import[:configuration]
 
-      # rubocop:todo Metrics/CollectionLiteralLength
       ANALYZERS = [
         Analyzers::CommitAuthorCapitalization,
         Analyzers::CommitAuthorEmail,
         Analyzers::CommitAuthorName,
-        Analyzers::CommitBodyBullet,
         Analyzers::CommitBodyBulletCapitalization,
         Analyzers::CommitBodyBulletDelimiter,
+        Analyzers::CommitBodyBulletOnly,
         Analyzers::CommitBodyLeadingLine,
         Analyzers::CommitBodyLineLength,
         Analyzers::CommitBodyParagraphCapitalization,
         Analyzers::CommitBodyPhrase,
         Analyzers::CommitBodyPresence,
-        Analyzers::CommitBodySingleBullet,
         Analyzers::CommitBodyTrackerShorthand,
+        Analyzers::CommitBodyWordRepeat,
         Analyzers::CommitSignature,
         Analyzers::CommitSubjectLength,
         Analyzers::CommitSubjectPrefix,
         Analyzers::CommitSubjectSuffix,
+        Analyzers::CommitSubjectWordRepeat,
         Analyzers::CommitTrailerCollaboratorCapitalization,
         Analyzers::CommitTrailerCollaboratorEmail,
         Analyzers::CommitTrailerCollaboratorKey,
@@ -34,6 +34,11 @@ module Git
         Analyzers::CommitTrailerFormatValue,
         Analyzers::CommitTrailerIssueKey,
         Analyzers::CommitTrailerIssueValue,
+        Analyzers::CommitTrailerMilestoneKey,
+        Analyzers::CommitTrailerMilestoneValue,
+        Analyzers::CommitTrailerOrder,
+        Analyzers::CommitTrailerReviewerKey,
+        Analyzers::CommitTrailerReviewerValue,
         Analyzers::CommitTrailerSignerCapitalization,
         Analyzers::CommitTrailerSignerEmail,
         Analyzers::CommitTrailerSignerKey,
@@ -41,7 +46,6 @@ module Git
         Analyzers::CommitTrailerTrackerKey,
         Analyzers::CommitTrailerTrackerValue
       ].freeze
-      # rubocop:enable Metrics/CollectionLiteralLength
 
       # rubocop:disable Metrics/ParameterLists
       def initialize(

data/lib/git/lint/analyzers/abstract.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 require "core"
-require "refinements/strings"
+require "refinements/string"
 
 module Git
   module Lint
     module Analyzers
-      # An abstract class which provides basic functionality from which all analyzers inherit from.
+      # An abstract class which provides basic functionality for all analyzers to inherit from.
       class Abstract
         include Import[:configuration, :environment]
 
-        using ::Refinements::Strings
+        using Refinements::String
 
         LEVELS = %w[warn error].freeze
         BODY_OFFSET = 3

data/lib/git/lint/analyzers/commit_author_capitalization.rb

@@ -3,7 +3,7 @@
 module Git
   module Lint
     module Analyzers
-      # Analyzes author for proper capitalization of author name.
+      # Analyzes author name for proper capitalization.
       class CommitAuthorCapitalization < Abstract
         include Import[validator: "validators.capitalization"]
 

data/lib/git/lint/analyzers/commit_body_bullet_capitalization.rb

@@ -23,7 +23,7 @@ module Git
         end
 
         def invalid_line? line
-          line.match?(/\A\s*#{Regexp.union filter_list.to_regexp}\s[[:lower:]]+/)
+          line.match?(/\A\s*#{Regexp.union filter_list}\s[[:lower:]]+/)
         end
 
         private

data/lib/git/lint/analyzers/commit_body_bullet_delimiter.rb

@@ -24,7 +24,7 @@ module Git
 
         def invalid_line?(line) = line.match?(/\A\s*#{pattern}(?!(#{pattern}|\s)).+\Z/)
 
-        def pattern = Regexp.union(filter_list.to_regexp)
+        def pattern = Regexp.union filter_list
       end
     end
   end

data/lib/git/lint/analyzers/{commit_body_single_bullet.rb → commit_body_bullet_only.rb}

@@ -4,8 +4,8 @@ module Git
   module Lint
     module Analyzers
       # Analyzes commit bodies with only a single bullet point.
-      class CommitBodySingleBullet < Abstract
-        def valid? = affected_commit_body_lines.size != 1
+      class CommitBodyBulletOnly < Abstract
+        def valid? = !affected_commit_body_lines.one?
 
         def issue
           return {} if valid?
@@ -19,10 +19,10 @@ module Git
         protected
 
         def load_filter_list
-          Kit::FilterList.new configuration.commits_body_single_bullet_includes
+          Kit::FilterList.new configuration.commits_body_bullet_only_includes
         end
 
-        def invalid_line?(line) = line.match?(/\A#{Regexp.union filter_list.to_regexp}\s+/)
+        def invalid_line?(line) = line.match?(/\A#{Regexp.union filter_list}\s+/)
       end
     end
   end

data/lib/git/lint/analyzers/commit_body_phrase.rb

@@ -11,7 +11,7 @@ module Git
           return {} if valid?
 
           {
-            hint: %(Avoid: #{filter_list.to_hint}.),
+            hint: %(Avoid: #{filter_list.to_usage}.),
             lines: affected_commit_body_lines
           }
         end
@@ -23,10 +23,7 @@ module Git
         end
 
         def invalid_line? line
-          line.downcase.match? Regexp.new(
-            Regexp.union(filter_list.to_regexp).source,
-            Regexp::IGNORECASE
-          )
+          line.downcase.match? Regexp.new(Regexp.union(filter_list).source, Regexp::IGNORECASE)
         end
       end
     end

data/lib/git/lint/analyzers/commit_body_presence.rb

@@ -3,9 +3,9 @@
 module Git
   module Lint
     module Analyzers
-      # Analyzes pretense of commit body.
+      # Analyzes presence of commit body.
       class CommitBodyPresence < Abstract
-        using ::Refinements::Strings
+        using Refinements::String
 
         def valid?
           return true if commit.fixup?
@@ -19,7 +19,7 @@ module Git
         def issue
           return {} if valid?
 
-          {hint: %(Use minimum of #{"#{minimum} line".pluralize "s", count: minimum} (non-empty).)}
+          {hint: %(Use minimum of #{"#{minimum} line".pluralize "s", minimum} (non-empty).)}
         end
       end
     end

data/lib/git/lint/analyzers/commit_body_tracker_shorthand.rb

@@ -11,7 +11,7 @@ module Git
           return {} if valid?
 
           {
-            hint: "Explain issue instead of using shorthand. Avoid: #{filter_list.to_hint}.",
+            hint: "Explain issue instead of using shorthand. Avoid: #{filter_list.to_usage}.",
             lines: affected_commit_body_lines
           }
         end
@@ -22,7 +22,7 @@ module Git
           Kit::FilterList.new configuration.commits_body_tracker_shorthand_excludes
         end
 
-        def invalid_line?(line) = line.match?(/.*#{Regexp.union filter_list.to_regexp}.*/)
+        def invalid_line?(line) = line.match?(/.*#{Regexp.union filter_list}.*/)
       end
     end
   end

data/lib/git/lint/analyzers/commit_body_word_repeat.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes commit body for repeated words.
+      class CommitBodyWordRepeat < Abstract
+        include Import[validator: "validators.repeated_word"]
+
+        def valid? = commit.body_lines.all? { |line| !invalid_line? line }
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Avoid repeating these words: #{validator.call commit.body}.",
+            lines: affected_commit_body_lines
+          }
+        end
+
+        protected
+
+        def invalid_line? line
+          return false if line.start_with? "#"
+
+          !validator.call(line).empty?
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/analyzers/commit_signature.rb

@@ -8,10 +8,10 @@ module Git
         include Import[sanitizer: "sanitizers.signature"]
 
         def valid?
-          sanitizer.call(commit.signature).match?(/\A#{Regexp.union filter_list.to_regexp}\Z/)
+          sanitizer.call(commit.signature).match?(/\A#{Regexp.union filter_list}\Z/)
         end
 
-        def issue = valid? ? {} : {hint: %(Use: #{filter_list.to_hint}.)}
+        def issue = valid? ? {} : {hint: %(Use: #{filter_list.to_usage "or"}.)}
 
         protected
 

data/lib/git/lint/analyzers/commit_subject_prefix.rb

@@ -9,13 +9,13 @@ module Git
           return true if locally_prefixed?
           return true if filter_list.empty?
 
-          commit.subject.match?(/\A#{Regexp.union filter_list.to_regexp}/)
+          commit.subject.match?(/\A#{Regexp.union filter_list}/)
         end
 
         def issue
           return {} if valid?
 
-          {hint: %(Use: #{filter_list.to_hint}.)}
+          {hint: %(Use: #{filter_list.to_usage "or"}.)}
         end
 
         protected
@@ -26,7 +26,7 @@ module Git
                        .then { |list| Kit::FilterList.new list }
         end
 
-        def locally_prefixed? = !ci? && commit.prefix?
+        def locally_prefixed? = !ci? && commit.directive?
 
         def ci? = environment["CI"] == "true"
 

data/lib/git/lint/analyzers/commit_subject_suffix.rb

@@ -8,13 +8,13 @@ module Git
         def valid?
           return true if filter_list.empty?
 
-          !commit.subject.match?(/#{Regexp.union filter_list.to_regexp}\Z/)
+          !commit.subject.match?(/#{Regexp.union filter_list}\Z/)
         end
 
         def issue
           return {} if valid?
 
-          {hint: %(Avoid: #{filter_list.to_hint}.)}
+          {hint: %(Avoid: #{filter_list.to_usage}.)}
         end
 
         protected

data/lib/git/lint/analyzers/commit_subject_word_repeat.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes commit subject for repeated words.
+      class CommitSubjectWordRepeat < Abstract
+        include Import[validator: "validators.repeated_word"]
+
+        def valid? = validator.call(commit.subject).empty?
+
+        def issue
+          return {} if valid?
+
+          {hint: "Avoid repeating these words: #{validator.call commit.subject}."}
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/analyzers/commit_trailer_collaborator_capitalization.rb

@@ -6,7 +6,7 @@ module Git
       # Analyzes commit trailer collaborator name capitalization.
       class CommitTrailerCollaboratorCapitalization < Abstract
         include Import[
-          pattern: "trailers.collaborator",
+          setting: "trailers.collaborator",
           parser: "parsers.person",
           validator: "validators.capitalization"
         ]
@@ -26,7 +26,7 @@ module Git
 
         def invalid_line? trailer
           parser.call(trailer.value).then do |person|
-            trailer.key.match?(pattern) && !validator.call(person.name)
+            trailer.key.match?(setting.pattern) && !validator.call(person.name)
           end
         end
       end

data/lib/git/lint/analyzers/commit_trailer_collaborator_email.rb

@@ -6,9 +6,8 @@ module Git
       # Analyzes commit trailer collaborator email address format.
       class CommitTrailerCollaboratorEmail < Abstract
         include Import[
-          pattern: "trailers.collaborator",
+          setting: "trailers.collaborator",
           parser: "parsers.person",
-          sanitizer: "sanitizers.email",
           validator: "validators.email"
         ]
 
@@ -26,8 +25,8 @@ module Git
         protected
 
         def invalid_line? trailer
-          email = sanitizer.call parser.call(trailer.value).email
-          trailer.key.match?(pattern) && !validator.call(email)
+          email = parser.call(trailer.value).email
+          trailer.key.match?(setting.pattern) && !validator.call(email)
         end
 
         private

data/lib/git/lint/analyzers/commit_trailer_collaborator_key.rb

@@ -5,7 +5,7 @@ module Git
     module Analyzers
       # Analyzes commit trailer collaborator key usage.
       class CommitTrailerCollaboratorKey < Abstract
-        include Import[pattern: "trailers.collaborator"]
+        include Import[setting: "trailers.collaborator"]
 
         def valid? = affected_commit_trailers.empty?
 
@@ -13,20 +13,18 @@ module Git
           return {} if valid?
 
           {
-            hint: "Use format: #{filter_list.to_hint}.",
+            hint: "Use format: #{filter_list.to_usage}.",
             lines: affected_commit_trailers
           }
         end
 
         protected
 
-        def load_filter_list
-          Kit::FilterList.new configuration.commits_trailer_collaborator_key_includes
-        end
+        def load_filter_list = Kit::FilterList.new setting.name
 
         def invalid_line? trailer
           trailer.key.then do |key|
-            key.match?(pattern) && !key.match?(/\A#{Regexp.union filter_list.to_regexp}\Z/)
+            key.match?(setting.pattern) && !key.match?(/\A#{Regexp.union filter_list}\Z/)
           end
         end
       end

data/lib/git/lint/analyzers/commit_trailer_collaborator_name.rb

@@ -6,7 +6,7 @@ module Git
       # Analyzes commit trailer collaborator name construction.
       class CommitTrailerCollaboratorName < Abstract
         include Import[
-          pattern: "trailers.collaborator",
+          setting: "trailers.collaborator",
           parser: "parsers.person",
           validator: "validators.name"
         ]
@@ -26,7 +26,7 @@ module Git
 
         def invalid_line? trailer
           parser.call(trailer.value).then do |person|
-            trailer.key.match?(pattern) && !validator.call(person.name, minimum:)
+            trailer.key.match?(setting.pattern) && !validator.call(person.name, minimum:)
           end
         end
 

data/lib/git/lint/analyzers/commit_trailer_format_key.rb

@@ -5,7 +5,7 @@ module Git
     module Analyzers
       # Analyzes commit trailer format key usage.
       class CommitTrailerFormatKey < Abstract
-        include Import[pattern: "trailers.format"]
+        include Import[setting: "trailers.format"]
 
         def valid? = affected_commit_trailers.empty?
 
@@ -13,20 +13,18 @@ module Git
           return {} if valid?
 
           {
-            hint: "Use format: #{filter_list.to_hint}.",
+            hint: "Use format: #{filter_list.to_usage}.",
             lines: affected_commit_trailers
           }
         end
 
         protected
 
-        def load_filter_list
-          Kit::FilterList.new configuration.commits_trailer_format_key_includes
-        end
+        def load_filter_list = Kit::FilterList.new setting.name
 
         def invalid_line? trailer
           trailer.key.then do |key|
-            key.match?(pattern) && !key.match?(/\A#{Regexp.union filter_list.to_regexp}\Z/)
+            key.match?(setting.pattern) && !key.match?(/\A#{Regexp.union filter_list}\Z/)
           end
         end
       end

data/lib/git/lint/analyzers/commit_trailer_format_value.rb

@@ -5,7 +5,7 @@ module Git
     module Analyzers
       # Analyzes commit trailer format value.
       class CommitTrailerFormatValue < Abstract
-        include Import[pattern: "trailers.format"]
+        include Import[setting: "trailers.format"]
 
         def valid? = affected_commit_trailers.empty?
 
@@ -13,7 +13,7 @@ module Git
           return {} if valid?
 
           {
-            hint: "Use format: #{filter_list.to_hint}.",
+            hint: "Use format: #{filter_list.to_usage "or"}.",
             lines: affected_commit_trailers
           }
         end
@@ -25,10 +25,10 @@ module Git
         end
 
         def invalid_line? trailer
-          trailer.key.match?(pattern) && !trailer.value.match?(value_pattern)
+          trailer.key.match?(setting.pattern) && !trailer.value.match?(value_pattern)
         end
 
-        def value_pattern = /\A#{Regexp.union filter_list.to_regexp}\Z/
+        def value_pattern = /\A#{Regexp.union filter_list}\Z/
       end
     end
   end

data/lib/git/lint/analyzers/commit_trailer_issue_key.rb

@@ -5,7 +5,7 @@ module Git
     module Analyzers
       # Analyzes commit trailer issue key usage.
       class CommitTrailerIssueKey < Abstract
-        include Import[pattern: "trailers.issue"]
+        include Import[setting: "trailers.issue"]
 
         def valid? = affected_commit_trailers.empty?
 
@@ -13,20 +13,18 @@ module Git
           return {} if valid?
 
           {
-            hint: "Use format: #{filter_list.to_hint}.",
+            hint: "Use format: #{filter_list.to_usage}.",
             lines: affected_commit_trailers
           }
         end
 
         protected
 
-        def load_filter_list
-          Kit::FilterList.new configuration.commits_trailer_issue_key_includes
-        end
+        def load_filter_list = Kit::FilterList.new setting.name
 
         def invalid_line? trailer
           trailer.key.then do |key|
-            key.match?(pattern) && !key.match?(/\A#{Regexp.union filter_list.to_regexp}\Z/)
+            key.match?(setting.pattern) && !key.match?(/\A#{Regexp.union filter_list}\Z/)
           end
         end
       end

data/lib/git/lint/analyzers/commit_trailer_issue_value.rb

@@ -5,7 +5,7 @@ module Git
     module Analyzers
       # Analyzes commit trailer issue value.
       class CommitTrailerIssueValue < Abstract
-        include Import[pattern: "trailers.issue"]
+        include Import[setting: "trailers.issue"]
 
         def valid? = affected_commit_trailers.empty?
 
@@ -13,7 +13,7 @@ module Git
           return {} if valid?
 
           {
-            hint: "Use format: #{filter_list.to_hint}.",
+            hint: "Use format: #{filter_list.to_usage}.",
             lines: affected_commit_trailers
           }
         end
@@ -25,10 +25,10 @@ module Git
         end
 
         def invalid_line? trailer
-          trailer.key.match?(pattern) && !trailer.value.match?(value_pattern)
+          trailer.key.match?(setting.pattern) && !trailer.value.match?(value_pattern)
         end
 
-        def value_pattern = /\A#{Regexp.union filter_list.to_regexp}\Z/
+        def value_pattern = /\A#{Regexp.union filter_list}\Z/
       end
     end
   end

data/lib/git/lint/analyzers/commit_trailer_milestone_key.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes commit trailer milestone key usage.
+      class CommitTrailerMilestoneKey < Abstract
+        include Import[setting: "trailers.milestone"]
+
+        def valid? = affected_commit_trailers.empty?
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Use: #{filter_list.to_usage}.",
+            lines: affected_commit_trailers
+          }
+        end
+
+        protected
+
+        def load_filter_list = Kit::FilterList.new setting.name
+
+        def invalid_line? trailer
+          trailer.key.then do |key|
+            key.match?(setting.pattern) && !key.match?(/\A#{Regexp.union filter_list}\Z/)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/analyzers/commit_trailer_milestone_value.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes commit trailer milestone value.
+      class CommitTrailerMilestoneValue < Abstract
+        include Import[setting: "trailers.milestone"]
+
+        def valid? = affected_commit_trailers.empty?
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Use: #{filter_list.to_usage "or"}.",
+            lines: affected_commit_trailers
+          }
+        end
+
+        protected
+
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_trailer_milestone_value_includes
+        end
+
+        def invalid_line? trailer
+          trailer.key.match?(setting.pattern) && !trailer.value.match?(value_pattern)
+        end
+
+        def value_pattern = /\A#{Regexp.union filter_list}\Z/
+      end
+    end
+  end
+end

data/lib/git/lint/analyzers/commit_trailer_order.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes commit trailer order value.
+      class CommitTrailerOrder < Abstract
+        def initialize(...)
+          super
+          @original_order = commit.trailers.map(&:key)
+          @sorted_order = original_order.sort
+        end
+
+        def valid? = original_order == sorted_order
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Ensure keys are alphabetically sorted.",
+            lines: affected_commit_trailers
+          }
+        end
+
+        protected
+
+        def invalid_line? trailer
+          key = trailer.key
+          original_order.index(key) != sorted_order.index(key)
+        end
+
+        private
+
+        attr_reader :original_order, :sorted_order
+      end
+    end
+  end
+end

data/lib/git/lint/analyzers/commit_trailer_reviewer_key.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes commit trailer reviwer key usage.
+      class CommitTrailerReviewerKey < Abstract
+        include Import[setting: "trailers.reviewer"]
+
+        def valid? = affected_commit_trailers.empty?
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Use: #{filter_list.to_usage}.",
+            lines: affected_commit_trailers
+          }
+        end
+
+        protected
+
+        def load_filter_list = Kit::FilterList.new setting.name
+
+        def invalid_line? trailer
+          trailer.key.then do |key|
+            key.match?(setting.pattern) && !key.match?(/\A#{Regexp.union filter_list}\Z/)
+          end
+        end
+      end
+    end
+  end
+end