git-lint 1.0.0

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitBodyIssueTrackerLink < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            excludes: [
+              "(f|F)ix(es|ed)?\\s\\#\\d+",
+              "(c|C)lose(s|d)?\\s\\#\\d+",
+              "(r|R)esolve(s|d)?\\s\\#\\d+",
+              "github\\.com\\/.+\\/issues\\/\\d+"
+            ]
+          }
+        end
+
+        def valid?
+          commit.body_lines.none? { |line| invalid_line? line }
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Explain issue instead of using link. Avoid: #{filter_list.to_hint}.",
+            lines: affected_commit_body_lines
+          }
+        end
+
+        protected
+
+        def load_filter_list
+          Kit::FilterList.new settings.fetch :excludes
+        end
+
+        def invalid_line? line
+          line.match?(/.*#{Regexp.union filter_list.to_regexp}.*/)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitBodyLeadingLine < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error
+          }
+        end
+
+        def valid?
+          raw_body = commit.raw_body
+          subject, body = raw_body.split "\n", 2
+          return true if !String(subject).empty? && String(body).strip.empty?
+
+          raw_body.match?(/\A.+\n\n.+/)
+        end
+
+        def issue
+          return {} if valid?
+
+          {hint: "Use blank line between subject and body."}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitBodyLineLength < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            length: 72
+          }
+        end
+
+        def valid?
+          commit.body_lines.all? { |line| !invalid_line? line }
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Use #{length} characters or less per line.",
+            lines: affected_commit_body_lines
+          }
+        end
+
+        protected
+
+        def invalid_line? line
+          line.length > length
+        end
+
+        private
+
+        def length
+          settings.fetch :length
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitBodyParagraphCapitalization < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error
+          }
+        end
+
+        def self.invalid? line
+          line.match?(/\A[[:lower:]].+\Z/m)
+        end
+
+        def valid?
+          lowercased_lines.empty?
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Capitalize first word.",
+            lines: affected_lines
+          }
+        end
+
+        private
+
+        def lowercased_lines
+          commit.body_paragraphs.select { |line| self.class.invalid? line }
+        end
+
+        def affected_lines
+          klass = self.class
+
+          commit.body_paragraphs.each.with_object([]).with_index do |(line, lines), index|
+            lines << klass.build_issue_line(index, line) if klass.invalid? line
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      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 }
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: %(Avoid: #{filter_list.to_hint}.),
+            lines: affected_commit_body_lines
+          }
+        end
+
+        protected
+
+        def load_filter_list
+          Kit::FilterList.new settings.fetch(:excludes)
+        end
+
+        def invalid_line? line
+          line.downcase.match? Regexp.new(
+            Regexp.union(filter_list.to_regexp).source,
+            Regexp::IGNORECASE
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitBodyPresence < Abstract
+        using Refinements::Strings
+
+        def self.defaults
+          {
+            enabled: true,
+            severity: :warn,
+            minimum: 1
+          }
+        end
+
+        def valid?
+          return true if commit.fixup?
+
+          valid_lines = commit.body_lines.reject { |line| line.match?(/^\s*$/) }
+          valid_lines.size >= minimum
+        end
+
+        def minimum
+          settings.fetch :minimum
+        end
+
+        def issue
+          return {} if valid?
+
+          {hint: %(Use minimum of #{"line".pluralize count: minimum} (non-empty).)}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitBodySingleBullet < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            includes: %w[\\-]
+          }
+        end
+
+        def valid?
+          affected_commit_body_lines.size != 1
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Use paragraph instead of single bullet.",
+            lines: affected_commit_body_lines
+          }
+        end
+
+        protected
+
+        def load_filter_list
+          Kit::FilterList.new settings.fetch :includes
+        end
+
+        def invalid_line? line
+          line.match?(/\A#{Regexp.union filter_list.to_regexp}\s+/)
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitSubjectPrefix < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            includes: %w[Fixed Added Updated Removed Refactored]
+          }
+        end
+
+        def valid?
+          return true if fixup_or_squash?
+          return true if filter_list.empty?
+
+          commit.subject.match?(/\A#{Regexp.union filter_list.to_regexp}/)
+        end
+
+        def issue
+          return {} if valid?
+
+          {hint: %(Use: #{filter_list.to_hint}.)}
+        end
+
+        protected
+
+        def load_filter_list
+          Kit::FilterList.new settings.fetch(:includes)
+        end
+
+        private
+
+        def fixup_or_squash?
+          commit.is_a?(Git::Lint::Commits::Unsaved) && (commit.fixup? || commit.squash?)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitSubjectSuffix < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            excludes: [
+              "\\.",
+              "\\?",
+              "\\!"
+            ]
+          }
+        end
+
+        def valid?
+          return true if filter_list.empty?
+
+          !commit.subject.match?(/#{Regexp.union filter_list.to_regexp}\Z/)
+        end
+
+        def issue
+          return {} if valid?
+
+          {hint: %(Avoid: #{filter_list.to_hint}.)}
+        end
+
+        protected
+
+        def load_filter_list
+          Kit::FilterList.new settings.fetch(:excludes)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitTrailerCollaboratorCapitalization < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error
+          }
+        end
+
+        # rubocop:disable Metrics/ParameterLists
+        def initialize commit:,
+                       settings: self.class.defaults,
+                       parser: Parsers::Trailers::Collaborator,
+                       validator: Validators::Capitalization
+          super commit: commit, settings: settings
+          @parser = parser
+          @validator = validator
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        def valid?
+          affected_commit_trailer_lines.empty?
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Name must be capitalized.",
+            lines: affected_commit_trailer_lines
+          }
+        end
+
+        protected
+
+        def invalid_line? line
+          collaborator = parser.new line
+          collaborator.match? && !validator.new(collaborator.name.strip).valid?
+        end
+
+        private
+
+        attr_reader :parser, :validator
+      end
+    end
+  end
+end