git-lint 1.0.0

data/bin/git-lint

@@ -0,0 +1,9 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+require "git/lint"
+require "git/lint/cli"
+require "git/lint/identity"
+
+Process.setproctitle Git::Lint::Identity::VERSION_LABEL
+Git::Lint::CLI.start

data/lib/git/kit/repo.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Git
+  module Kit
+    class Repo
+      def initialize shell: Open3
+        @shell = shell
+      end
+
+      def exist?
+        shell.capture2e("git rev-parse --git-dir > /dev/null 2>&1")
+             .then { |result, status| result && status.success? }
+      end
+
+      def branch_name
+        shell.capture2e("git rev-parse --abbrev-ref HEAD | tr -d '\n'")
+             .then { |result, _status| result }
+      end
+
+      def shas start: "master", finish: branch_name
+        shell.capture2e(%(git log --pretty=format:"%H" #{start}..#{finish}))
+             .then { |result, _status| result.split "\n" }
+      end
+
+      private
+
+      attr_reader :shell
+    end
+  end
+end

data/lib/git/lint.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "git/lint/identity"
+require "git/kit/repo"
+require "git/lint/refinements/strings"
+require "git/lint/errors/base"
+require "git/lint/errors/severity"
+require "git/lint/errors/sha"
+require "git/lint/kit/filter_list"
+require "git/lint/validators/email"
+require "git/lint/validators/name"
+require "git/lint/validators/capitalization"
+require "git/lint/parsers/trailers/collaborator"
+require "git/lint/commits/saved"
+require "git/lint/commits/unsaved"
+require "git/lint/branches/environments/local"
+require "git/lint/branches/environments/circle_ci"
+require "git/lint/branches/environments/netlify_ci"
+require "git/lint/branches/environments/travis_ci"
+require "git/lint/branches/feature"
+require "git/lint/analyzers/abstract"
+require "git/lint/analyzers/commit_author_capitalization"
+require "git/lint/analyzers/commit_author_email"
+require "git/lint/analyzers/commit_author_name"
+require "git/lint/analyzers/commit_body_bullet"
+require "git/lint/analyzers/commit_body_bullet_capitalization"
+require "git/lint/analyzers/commit_body_bullet_delimiter"
+require "git/lint/analyzers/commit_body_issue_tracker_link"
+require "git/lint/analyzers/commit_body_leading_line"
+require "git/lint/analyzers/commit_body_line_length"
+require "git/lint/analyzers/commit_body_paragraph_capitalization"
+require "git/lint/analyzers/commit_body_phrase"
+require "git/lint/analyzers/commit_body_presence"
+require "git/lint/analyzers/commit_body_single_bullet"
+require "git/lint/analyzers/commit_subject_length"
+require "git/lint/analyzers/commit_subject_prefix"
+require "git/lint/analyzers/commit_subject_suffix"
+require "git/lint/analyzers/commit_trailer_collaborator_capitalization"
+require "git/lint/analyzers/commit_trailer_collaborator_duplication"
+require "git/lint/analyzers/commit_trailer_collaborator_email"
+require "git/lint/analyzers/commit_trailer_collaborator_key"
+require "git/lint/analyzers/commit_trailer_collaborator_name"
+require "git/lint/collector"
+require "git/lint/reporters/lines/sentence"
+require "git/lint/reporters/lines/paragraph"
+require "git/lint/reporters/line"
+require "git/lint/reporters/style"
+require "git/lint/reporters/commit"
+require "git/lint/reporters/branch"
+require "git/lint/runner"
+require "git/lint/cli"

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

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "refinements/strings"
+
+module Git
+  module Lint
+    module Analyzers
+      # An abstract class which provides basic functionality from which all analyzers inherit from.
+      class Abstract
+        using ::Refinements::Strings
+
+        LEVELS = %i[warn error].freeze
+        ISSUE_LINE_OFFSET = 2
+
+        def self.inherited klass
+          @descendants ||= []
+          @descendants << klass unless klass.to_s.start_with? "#<Class" # Ignore anonymous classes.
+        end
+
+        def self.id
+          to_s.delete_prefix("Git::Lint::Analyzers").snakecase.to_sym
+        end
+
+        def self.label
+          to_s.delete_prefix("Git::Lint::Analyzers").titleize
+        end
+
+        def self.defaults
+          fail NotImplementedError, "The `.#{__method__}` method must be implemented."
+        end
+
+        def self.descendants
+          @descendants || []
+        end
+
+        def self.build_issue_line index, line
+          {number: index + ISSUE_LINE_OFFSET, content: line}
+        end
+
+        attr_reader :commit
+
+        def initialize commit:, settings: self.class.defaults
+          @commit = commit
+          @settings = settings
+          @filter_list = load_filter_list
+        end
+
+        def enabled?
+          settings.fetch :enabled
+        end
+
+        def severity
+          settings.fetch(:severity).tap do |level|
+            fail Errors::Severity, level unless LEVELS.include? level
+          end
+        end
+
+        def valid?
+          fail NotImplementedError, "The `##{__method__}` method must be implemented."
+        end
+
+        def invalid?
+          !valid?
+        end
+
+        def warning?
+          invalid? && severity == :warn
+        end
+
+        def error?
+          invalid? && severity == :error
+        end
+
+        def issue
+          fail NotImplementedError, "The `##{__method__}` method must be implemented."
+        end
+
+        protected
+
+        attr_reader :settings, :filter_list
+
+        def load_filter_list
+          Kit::FilterList.new settings[:list]
+        end
+
+        def affected_commit_body_lines
+          commit.body_lines.each.with_object([]).with_index do |(line, lines), index|
+            yield if block_given?
+            lines << self.class.build_issue_line(index, line) if invalid_line? line
+          end
+        end
+
+        def affected_commit_trailer_lines
+          commit.trailer_lines
+                .each.with_object([])
+                .with_index(commit.trailer_index) do |(line, lines), index|
+                  yield if block_given?
+                  lines << self.class.build_issue_line(index, line) if invalid_line? line
+                end
+        end
+
+        def invalid_line? _line
+          fail NotImplementedError, "The `.#{__method__}` method must be implemented."
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      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
+          @validator = validator
+        end
+
+        def valid?
+          validator.new(commit.author_name).valid?
+        end
+
+        def issue
+          return {} if valid?
+
+          {hint: %(Capitalize each part of name: "#{commit.author_name}".)}
+        end
+
+        private
+
+        attr_reader :validator
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      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
+          @validator = validator
+        end
+
+        def valid?
+          validator.new(commit.author_email).valid?
+        end
+
+        def issue
+          return {} if valid?
+
+          {hint: %(Use "<name>@<server>.<domain>" instead of "#{commit.author_email}".)}
+        end
+
+        private
+
+        attr_reader :validator
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      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
+          @validator = validator
+        end
+
+        def valid?
+          validator.new(commit.author_name, minimum: minimum).valid?
+        end
+
+        def issue
+          return {} if valid?
+
+          {hint: "Author name must consist of #{minimum} parts (minimum)."}
+        end
+
+        private
+
+        attr_reader :validator
+
+        def minimum
+          settings.fetch :minimum
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitBodyBullet < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            excludes: %w[\\* •]
+          }
+        end
+
+        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
+
+        # :reek:FeatureEnvy
+        def invalid_line? line
+          return false if line.strip.empty?
+
+          !line.match?(/\A(?!\s*#{Regexp.union filter_list.to_regexp}\s+).+\Z/)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitBodyBulletCapitalization < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            includes: %w[\\-]
+          }
+        end
+
+        def valid?
+          lowercased_bullets.size.zero?
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Capitalize first word.",
+            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\s*#{Regexp.union filter_list.to_regexp}\s[[:lower:]]+/)
+        end
+
+        private
+
+        def lowercased_bullets
+          commit.body_lines.select { |line| invalid_line? line }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitBodyBulletDelimiter < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            includes: %w[\\-]
+          }
+        end
+
+        def valid?
+          commit.body_lines.none? { |line| invalid_line? line }
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Use space after 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\s*#{Regexp.union filter_list.to_regexp}(?!\s).+\Z/)
+        end
+      end
+    end
+  end
+end