git-lint 2.4.0 → 3.0.0

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

@@ -3,16 +3,10 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes author for proper capitalization of author name.
       class CommitAuthorCapitalization < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error
-          }
-        end
-
-        def initialize commit:, settings: self.class.defaults, validator: Validators::Capitalization
-          super commit: commit, settings: settings
+        def initialize commit, validator: Validators::Capitalization
+          super commit
           @validator = validator
         end
 

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

@@ -3,16 +3,10 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes author email address for proper format.
       class CommitAuthorEmail < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error
-          }
-        end
-
-        def initialize commit:, settings: self.class.defaults, validator: Validators::Email
-          super commit: commit, settings: settings
+        def initialize commit, validator: Validators::Email
+          super commit
           @validator = validator
         end
 

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

@@ -3,21 +3,14 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes author name for minimum parts of name.
       class CommitAuthorName < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            minimum: 2
-          }
-        end
-
-        def initialize commit:, settings: self.class.defaults, validator: Validators::Name
-          super commit: commit, settings: settings
+        def initialize commit, validator: Validators::Name
+          super commit
           @validator = validator
         end
 
-        def valid? = validator.new(commit.author_name, minimum: minimum).valid?
+        def valid? = validator.new(commit.author_name, minimum:).valid?
 
         def issue
           return {} if valid?
@@ -29,9 +22,7 @@ module Git
 
         attr_reader :validator
 
-        def minimum
-          settings.fetch __method__
-        end
+        def minimum = settings.minimum
       end
     end
   end

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

@@ -3,15 +3,8 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit body for correct bullet point syntax.
       class CommitBodyBullet < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            excludes: %w[\\* •]
-          }
-        end
-
         def valid? = commit.body_lines.all? { |line| !invalid_line? line }
 
         def issue
@@ -25,7 +18,7 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.fetch(:excludes))
+        def load_filter_list = Kit::FilterList.new(settings.excludes)
 
         # :reek:FeatureEnvy
         def invalid_line? line

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

@@ -3,15 +3,8 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit body for proper capitalization of bullet sentences.
       class CommitBodyBulletCapitalization < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            includes: %w[\\-]
-          }
-        end
-
         def valid? = lowercased_bullets.size.zero?
 
         def issue
@@ -25,7 +18,7 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.fetch(:includes))
+        def load_filter_list = Kit::FilterList.new(settings.includes)
 
         def invalid_line? line
           line.match?(/\A\s*#{Regexp.union filter_list.to_regexp}\s[[:lower:]]+/)

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

@@ -3,15 +3,8 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit body delimiter usage.
       class CommitBodyBulletDelimiter < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            includes: %w[\\-]
-          }
-        end
-
         def valid? = commit.body_lines.none? { |line| invalid_line? line }
 
         def issue
@@ -25,7 +18,7 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.fetch(:includes))
+        def load_filter_list = Kit::FilterList.new(settings.includes)
 
         def invalid_line?(line) = line.match?(/\A\s*#{pattern}(?!(#{pattern}|\s)).+\Z/)
 

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

@@ -3,14 +3,8 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes leading line between commit subject and start of body.
       class CommitBodyLeadingLine < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error
-          }
-        end
-
         def valid?
           message = commit.message
           subject, body = message.split "\n", 2

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

@@ -3,33 +3,26 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit body line length to prevent unnecessary horizontal scrolling.
       class CommitBodyLineLength < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            length: 72
-          }
-        end
-
         def valid? = commit.body_lines.all? { |line| !invalid_line? line }
 
         def issue
           return {} if valid?
 
           {
-            hint: "Use #{length} characters or less per line.",
+            hint: "Use #{maximum} characters or less per line.",
             lines: affected_commit_body_lines
           }
         end
 
         protected
 
-        def invalid_line?(line) = line.length > length
+        def invalid_line?(line) = line.length > maximum
 
         private
 
-        def length = settings.fetch(:length)
+        def maximum = settings.maximum
       end
     end
   end

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

@@ -3,14 +3,8 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes proper capitalization of commit body paragraphs.
       class CommitBodyParagraphCapitalization < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error
-          }
-        end
-
         def self.invalid?(line) = line.match?(/\A[[:lower:]].+\Z/m)
 
         def valid? = lowercased_lines.empty?

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

@@ -3,44 +3,8 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes use of commit body phrases that are not informative.
       class CommitBodyPhrase < Abstract
-        # rubocop:disable Metrics/MethodLength
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            excludes: [
-              "absolutely",
-              "actually",
-              "all intents and purposes",
-              "along the lines",
-              "at this moment in time",
-              "basically",
-              "each and every one",
-              "everyone knows",
-              "fact of the matter",
-              "furthermore",
-              "however",
-              "in due course",
-              "in the end",
-              "last but not least",
-              "matter of fact",
-              "obviously",
-              "of course",
-              "really",
-              "simply",
-              "things being equal",
-              "would like to",
-              /\beasy\b/,
-              /\bjust\b/,
-              /\bquite\b/,
-              /as\sfar\sas\s.+\sconcerned/,
-              /of\sthe\s(fact|opinion)\sthat/
-            ]
-          }
-        end
-        # rubocop:enable Metrics/MethodLength
-
         def valid? = commit.body_lines.all? { |line| !invalid_line? line }
 
         def issue
@@ -54,7 +18,7 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.fetch(:excludes))
+        def load_filter_list = Kit::FilterList.new(settings.excludes)
 
         def invalid_line? line
           line.downcase.match? Regexp.new(

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

@@ -3,16 +3,9 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes pretense of commit body.
       class CommitBodyPresence < Abstract
-        using GitPlus::Refinements::Strings
-
-        def self.defaults
-          {
-            enabled: true,
-            severity: :warn,
-            minimum: 1
-          }
-        end
+        using ::Refinements::Strings
 
         def valid?
           return true if commit.fixup?
@@ -21,12 +14,12 @@ module Git
           valid_lines.size >= minimum
         end
 
-        def minimum = settings.fetch(:minimum)
+        def minimum = settings.minimum
 
         def issue
           return {} if valid?
 
-          {hint: %(Use minimum of #{"line".pluralize count: minimum} (non-empty).)}
+          {hint: %(Use minimum of #{"#{minimum} line".pluralize "s", count: minimum} (non-empty).)}
         end
       end
     end

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

@@ -3,15 +3,8 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit bodies with only a single bullet point.
       class CommitBodySingleBullet < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            includes: %w[\\-]
-          }
-        end
-
         def valid? = affected_commit_body_lines.size != 1
 
         def issue
@@ -25,7 +18,7 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.fetch(:includes))
+        def load_filter_list = Kit::FilterList.new(settings.includes)
 
         def invalid_line?(line) = line.match?(/\A#{Regexp.union filter_list.to_regexp}\s+/)
       end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes body tracker shorthand usage.
+      class CommitBodyTrackerShorthand < Abstract
+        def valid? = commit.body_lines.none? { |line| invalid_line? line }
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Explain issue instead of using shorthand. Avoid: #{filter_list.to_hint}.",
+            lines: affected_commit_body_lines
+          }
+        end
+
+        protected
+
+        def load_filter_list = Kit::FilterList.new(settings.excludes)
+
+        def invalid_line?(line) = line.match?(/.*#{Regexp.union filter_list.to_regexp}.*/)
+      end
+    end
+  end
+end

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

@@ -3,26 +3,19 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit subject length is short and concise.
       class CommitSubjectLength < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            length: 72
-          }
-        end
-
-        def valid? = commit.subject.sub(/(fixup!|squash!)\s{1}/, "").size <= length
+        def valid? = commit.subject.sub(/(fixup!|squash!)\s{1}/, "").size <= maximum
 
         def issue
           return {} if valid?
 
-          {hint: "Use #{length} characters or less."}
+          {hint: "Use #{maximum} characters or less."}
         end
 
         private
 
-        def length = settings.fetch(:length)
+        def maximum = settings.maximum
       end
     end
   end

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

@@ -3,15 +3,8 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit subject uses standard prefix.
       class CommitSubjectPrefix < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            includes: %w[Fixed Added Updated Removed Refactored]
-          }
-        end
-
         def valid?
           return true if commit.prefix?
           return true if filter_list.empty?
@@ -27,7 +20,7 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.fetch(:includes))
+        def load_filter_list = Kit::FilterList.new(settings.includes)
       end
     end
   end

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

@@ -3,19 +3,8 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit subject suffix for punctuation.
       class CommitSubjectSuffix < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            excludes: [
-              "\\.",
-              "\\?",
-              "\\!"
-            ]
-          }
-        end
-
         def valid?
           return true if filter_list.empty?
 
@@ -30,7 +19,7 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.fetch(:excludes))
+        def load_filter_list = Kit::FilterList.new(settings.excludes)
       end
     end
   end

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

@@ -3,24 +3,15 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit trailer collaborator name capitalization.
       class CommitTrailerCollaboratorCapitalization < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error
-          }
-        end
-
-        # rubocop:disable Metrics/ParameterLists
-        def initialize commit:,
-                       settings: self.class.defaults,
+        def initialize commit,
                        parser: Parsers::Trailers::Collaborator,
                        validator: Validators::Capitalization
-          super commit: commit, settings: settings
+          super commit
           @parser = parser
           @validator = validator
         end
-        # rubocop:enable Metrics/ParameterLists
 
         def valid? = affected_commit_trailers.empty?
 

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

@@ -3,18 +3,10 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit trailer collaborator duplication.
       class CommitTrailerCollaboratorDuplication < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error
-          }
-        end
-
-        def initialize commit:,
-                       settings: self.class.defaults,
-                       parser: Parsers::Trailers::Collaborator
-          super commit: commit, settings: settings
+        def initialize commit, parser: Parsers::Trailers::Collaborator
+          super commit
           @parser = parser
           @tally = build_tally
         end

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

@@ -3,25 +3,16 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit trailer collaborator email address format.
       class CommitTrailerCollaboratorEmail < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error
-          }
-        end
-
-        # rubocop:disable Metrics/ParameterLists
-        def initialize commit:,
-                       settings: self.class.defaults,
+        def initialize commit,
                        parser: Parsers::Trailers::Collaborator,
                        validator: Validators::Email
 
-          super commit: commit, settings: settings
+          super commit
           @parser = parser
           @validator = validator
         end
-        # rubocop:enable Metrics/ParameterLists
 
         def valid? = affected_commit_trailers.empty?
 

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

@@ -3,19 +3,10 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit trailer collaborator key usage.
       class CommitTrailerCollaboratorKey < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            includes: ["Co-Authored-By"]
-          }
-        end
-
-        def initialize commit:,
-                       settings: self.class.defaults,
-                       parser: Parsers::Trailers::Collaborator
-          super commit: commit, settings: settings
+        def initialize commit, parser: Parsers::Trailers::Collaborator
+          super commit
           @parser = parser
         end
 
@@ -32,7 +23,7 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.fetch(:includes))
+        def load_filter_list = Kit::FilterList.new(settings.includes)
 
         def invalid_line? line
           collaborator = parser.new line

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

@@ -3,26 +3,16 @@
 module Git
   module Lint
     module Analyzers
+      # Analyzes commit trailer collaborator name construction.
       class CommitTrailerCollaboratorName < Abstract
-        def self.defaults
-          {
-            enabled: true,
-            severity: :error,
-            minimum: 2
-          }
-        end
-
-        # rubocop:disable Metrics/ParameterLists
-        def initialize commit:,
-                       settings: self.class.defaults,
+        def initialize commit,
                        parser: Parsers::Trailers::Collaborator,
                        validator: Validators::Name
 
-          super commit: commit, settings: settings
+          super commit
           @parser = parser
           @validator = validator
         end
-        # rubocop:enable Metrics/ParameterLists
 
         def valid? = affected_commit_trailers.empty?
 
@@ -39,14 +29,14 @@ module Git
 
         def invalid_line? line
           collaborator = parser.new line
-          collaborator.match? && !validator.new(collaborator.name.strip, minimum: minimum).valid?
+          collaborator.match? && !validator.new(collaborator.name.strip, minimum:).valid?
         end
 
         private
 
         attr_reader :parser, :validator
 
-        def minimum = settings.fetch(:minimum)
+        def minimum = settings.minimum
       end
     end
   end

data/lib/git/lint/cli/actions/analyze/branch.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module CLI
+      module Actions
+        module Analyze
+          # Handles analyze action for branch.
+          class Branch
+            def initialize analyzer: Analyzer.new, container: Container
+              @analyzer = analyzer
+              @container = container
+            end
+
+            def call
+              parse
+            rescue Errors::Base => error
+              logger.error { error.message }
+              kernel.abort
+            end
+
+            private
+
+            attr_reader :analyzer, :container
+
+            def parse
+              analyzer.call do |collector, reporter|
+                kernel.puts reporter
+                kernel.abort if collector.errors?
+              end
+            end
+
+            def repository = container[__method__]
+
+            def kernel = container[__method__]
+
+            def logger = container[__method__]
+          end
+        end
+      end
+    end
+  end
+end