git-lint 2.3.3 → 3.0.2

data/lib/git/lint/configuration/defaults.yml

@@ -0,0 +1,118 @@
+:analyzers:
+  :commit_author_capitalization:
+    :enabled: true
+    :severity: :error
+  :commit_author_email:
+    :enabled: true
+    :severity: :error
+  :commit_author_name:
+    :enabled: true
+    :severity: :error
+    :minimum: 2
+  :commit_body_bullet:
+    :enabled: true
+    :severity: :error
+    :excludes:
+      - "\\*"
+      - "•"
+  :commit_body_bullet_capitalization:
+    :enabled: true
+    :severity: :error
+    :includes: "\\-"
+  :commit_body_bullet_delimiter:
+    :enabled: true
+    :severity: :error
+    :includes: "\\-"
+  :commit_body_tracker_shorthand:
+    :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+"
+  :commit_body_leading_line:
+    :enabled: false
+    :severity: :warn
+  :commit_body_line_length:
+    :enabled: true
+    :severity: :error
+    :maximum: 72
+  :commit_body_paragraph_capitalization:
+    :enabled: true
+    :severity: :error
+  :commit_body_phrase:
+    :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"
+  :commit_body_presence:
+    :enabled: false
+    :severity: :warn
+    :minimum: 1
+  :commit_body_single_bullet:
+    :enabled: true
+    :severity: :error
+    :includes: "\\-"
+  :commit_subject_length:
+    :enabled: true
+    :severity: :error
+    :maximum: 72
+  :commit_subject_prefix:
+    :enabled: true
+    :severity: :error
+    :includes:
+      - Fixed
+      - Added
+      - Updated
+      - Removed
+      - Refactored
+  :commit_subject_suffix:
+    :enabled: true
+    :severity: :error
+    :excludes:
+      - "\\."
+      - "\\?"
+      - "\\!"
+  :commit_trailer_collaborator_capitalization:
+    :enabled: true
+    :severity: :error
+  :commit_trailer_collaborator_duplication:
+    :enabled: true
+    :severity: :error
+  :commit_trailer_collaborator_email:
+    :enabled: true
+    :severity: :error
+  :commit_trailer_collaborator_key:
+    :enabled: true
+    :severity: :error
+    :includes:
+      - "Co-Authored-By"
+  :commit_trailer_collaborator_name:
+    :enabled: true
+    :severity: :error
+    :minimum: 2

data/lib/git/lint/configuration/loader.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/hashes"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+module Git
+  module Lint
+    module Configuration
+      # Represents the fully assembled Command Line Interface (CLI) configuration.
+      class Loader
+        using ::Refinements::Hashes
+        using ::Refinements::Structs
+
+        DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
+        CLIENT = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
+
+        def self.call = new.call
+
+        def self.with_defaults = new(client: DEFAULTS)
+
+        def initialize content: Content.new, client: CLIENT, setting: Setting
+          @content = content
+          @client = client
+          @setting = setting
+        end
+
+        def call
+          client.to_h
+                .then do |defaults|
+                  content.merge(
+                    **defaults.except(:analyzers).flatten_keys,
+                    analyzers: load_analyzer_settings(defaults)
+                  ).freeze
+                end
+        end
+
+        private
+
+        attr_reader :content, :client, :setting
+
+        def load_analyzer_settings defaults
+          defaults.fetch(:analyzers).map { |id, body| setting[id:, **body] }
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/configuration/setting.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Configuration
+      # Defines analyzer specific settings.
+      Setting = Struct.new(
+        :enabled,
+        :excludes,
+        :id,
+        :includes,
+        :maximum,
+        :minimum,
+        :severity,
+        keyword_init: true
+      ) do
+        def initialize *arguments
+          super
+          freeze
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/container.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "git_plus"
+require "logger"
+require "pastel"
+
+module Git
+  module Lint
+    # Provides a global gem container for injection into other objects.
+    module Container
+      extend Dry::Container::Mixin
+
+      register(:configuration) { Configuration::Loader.call }
+      register(:repository) { GitPlus::Repository.new }
+      register(:colorizer) { Pastel.new enabled: $stdout.tty? }
+      register(:kernel) { Kernel }
+
+      register :log_colors do
+        {
+          "DEBUG" => self[:colorizer].white.detach,
+          "INFO" => self[:colorizer].green.detach,
+          "WARN" => self[:colorizer].yellow.detach,
+          "ERROR" => self[:colorizer].red.detach,
+          "FATAL" => self[:colorizer].white.bold.on_red.detach,
+          "ANY" => self[:colorizer].white.bold.detach
+        }
+      end
+
+      register :logger do
+        Logger.new $stdout,
+                   level: Logger.const_get(ENV.fetch("LOG_LEVEL", "INFO")),
+                   formatter: (
+                     lambda do |severity, _at, _name, message|
+                       self[:log_colors][severity].call "#{message}\n"
+                     end
+                   )
+      end
+    end
+  end
+end

data/lib/git/lint/errors/severity.rb

@@ -3,6 +3,7 @@
 module Git
   module Lint
     module Errors
+      # Categorizes severity errors.
       class Severity < Base
         def initialize level
           super %(Invalid severity level: #{level}. Use: #{Analyzers::Abstract::LEVELS.join ", "}.)

data/lib/git/lint/errors/sha.rb

@@ -3,6 +3,7 @@
 module Git
   module Lint
     module Errors
+      # Categorizes commit SHA errors.
       class SHA < Base
         def initialize sha
           super %(Invalid commit SHA: "#{sha}". Unable to obtain commit details.)

data/lib/git/lint/identity.rb

@@ -6,8 +6,9 @@ module Git
     module Identity
       NAME = "git-lint"
       LABEL = "Git Lint"
-      VERSION = "2.3.3"
+      VERSION = "3.0.2"
       VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
+      SUMMARY = "A command line interface for linting Git commits."
     end
   end
 end

data/lib/git/lint/kit/filter_list.rb

@@ -3,8 +3,8 @@
 module Git
   module Lint
     module Kit
+      # Represents an regular expression list which may be used as an analyzer setting.
       class FilterList
-        # Represents an regular expression list which may be used as an analyzer setting.
         def initialize list = []
           @list = Array list
         end

data/lib/git/lint/parsers/trailers/collaborator.rb

@@ -4,6 +4,7 @@ module Git
   module Lint
     module Parsers
       module Trailers
+        # Parses collaborator information within a commit trailer.
         class Collaborator
           DEFAULT_KEY_PATTERN = /\ACo.*Authored.*By.*\Z/i
 

data/lib/git/lint/rake/tasks.rb

@@ -6,25 +6,26 @@ require "git/lint"
 module Git
   module Lint
     module Rake
+      # Defines and installs Rake tasks for use in downstream projects.
       class Tasks
         include ::Rake::DSL
 
         def self.setup = new.install
 
-        def initialize cli: CLI
-          @cli = cli
+        def initialize shell: CLI::Shell.new
+          @shell = shell
         end
 
         def install
           desc "Run Git Lint"
           task :git_lint do
-            cli.start ["--analyze"]
+            shell.call ["--analyze"]
           end
         end
 
         private
 
-        attr_reader :cli
+        attr_reader :shell
       end
     end
   end

data/lib/git/lint/reporters/branch.rb

@@ -7,7 +7,7 @@ module Git
     module Reporters
       # Reports issues related to a single branch.
       class Branch
-        using GitPlus::Refinements::Strings
+        using ::Refinements::Strings
 
         def initialize collector: Collector.new, colorizer: Pastel.new
           @collector = collector
@@ -19,6 +19,8 @@ module Git
           "#{commit_total}. #{issue_totals}.\n"
         end
 
+        alias to_str to_s
+
         private
 
         attr_reader :collector, :colorizer
@@ -31,12 +33,13 @@ module Git
 
         def commit_report
           collector.to_h.reduce "" do |details, (commit, analyzers)|
-            details + Commit.new(commit: commit, analyzers: analyzers).to_s
+            details + Commit.new(commit:, analyzers:)
           end
         end
 
         def commit_total
-          %(#{"commit".pluralize count: collector.total_commits} inspected)
+          total = collector.total_commits
+          %(#{total} #{"commit".pluralize "s", count: total} inspected)
         end
 
         def issue_totals
@@ -49,17 +52,20 @@ module Git
 
         def issue_total
           color = collector.errors? ? :red : :yellow
-          colorizer.public_send color, "issue".pluralize(count: collector.total_issues)
+          total = collector.total_issues
+          colorizer.public_send color, "#{total} issue".pluralize("s", count: total)
         end
 
         def warning_total
           color = collector.warnings? ? :yellow : :green
-          colorizer.public_send color, "warning".pluralize(count: collector.total_warnings)
+          total = collector.total_warnings
+          colorizer.public_send color, "#{total} warning".pluralize("s", count: total)
         end
 
         def error_total
           color = collector.errors? ? :red : :green
-          colorizer.public_send color, "error".pluralize(count: collector.total_errors)
+          total = collector.total_errors
+          colorizer.public_send color, "#{total} error".pluralize("s", count: total)
         end
       end
     end

data/lib/git/lint/reporters/commit.rb

@@ -17,11 +17,13 @@ module Git
           "#{commit.subject}\n#{report}\n"
         end
 
+        alias to_str to_s
+
         private
 
         attr_reader :commit, :analyzers
 
-        def report = analyzers.reduce("") { |report, analyzer| report + Style.new(analyzer).to_s }
+        def report = analyzers.reduce("") { |report, analyzer| report + Style.new(analyzer) }
       end
     end
   end

data/lib/git/lint/reporters/line.rb

@@ -12,13 +12,11 @@ module Git
         end
 
         def to_s
-          if content.include? "\n"
-            Lines::Paragraph.new(data).to_s
-          else
-            Lines::Sentence.new(data).to_s
-          end
+          content.include?("\n") ? Lines::Paragraph.new(data).to_s : Lines::Sentence.new(data).to_s
         end
 
+        alias to_str to_s
+
         private
 
         attr_reader :data

data/lib/git/lint/reporters/lines/paragraph.rb

@@ -4,6 +4,7 @@ module Git
   module Lint
     module Reporters
       module Lines
+        # Reports paragraph details.
         class Paragraph
           def initialize data = {}
             @data = data
@@ -13,6 +14,8 @@ module Git
             %(#{label}"#{paragraph}"\n)
           end
 
+          alias to_str to_s
+
           private
 
           attr_reader :data

data/lib/git/lint/reporters/lines/sentence.rb

@@ -4,6 +4,7 @@ module Git
   module Lint
     module Reporters
       module Lines
+        # Reports sentence details.
         class Sentence
           def initialize data = {}
             @data = data
@@ -11,6 +12,8 @@ module Git
 
           def to_s = %(#{Line::DEFAULT_INDENT}Line #{number}: "#{content}"\n)
 
+          alias to_str to_s
+
           private
 
           attr_reader :data

data/lib/git/lint/reporters/style.rb

@@ -15,6 +15,8 @@ module Git
 
         def to_s = colorizer.public_send(color, message)
 
+        alias to_str to_s
+
         private
 
         attr_reader :analyzer, :issue, :colorizer
@@ -42,7 +44,7 @@ module Git
         end
 
         def affected_lines
-          issue.fetch(:lines, []).reduce("") { |lines, line| lines + Line.new(line).to_s }
+          issue.fetch(:lines, []).reduce("") { |lines, line| lines + Line.new(line) }
         end
       end
     end

data/lib/git/lint/validators/capitalization.rb

@@ -3,6 +3,7 @@
 module Git
   module Lint
     module Validators
+      # Validates the capitalizationn of text.
       class Capitalization
         DEFAULT_PATTERN = /\A[[:upper:]].*\Z/
 

data/lib/git/lint/validators/email.rb

@@ -5,6 +5,7 @@ require "uri"
 module Git
   module Lint
     module Validators
+      # Validates the format of email addresses.
       class Email
         def initialize text, pattern: URI::MailTo::EMAIL_REGEXP
           @text = text

data/lib/git/lint/validators/name.rb

@@ -3,6 +3,7 @@
 module Git
   module Lint
     module Validators
+      # Validates the format of names.
       class Name
         DEFAULT_DELIMITER = /\s{1}/
         DEFAULT_MINIMUM = 2

data/lib/git/lint.rb

@@ -1,50 +1,21 @@
 # frozen_string_literal: true
 
+require "zeitwerk"
 require "git_plus"
-require "git/lint/identity"
-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/branches/environments/local"
-require "git/lint/branches/environments/circle_ci"
-require "git/lint/branches/environments/git_hub_action"
-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"
+
+Zeitwerk::Loader.new.then do |loader|
+  loader.inflector.inflect "cli" => "CLI",
+                           "sha" => "SHA",
+                           "circle_ci" => "CircleCI",
+                           "netlify_ci" => "NetlifyCI",
+                           "travis_ci" => "TravisCI"
+  loader.push_dir "#{__dir__}/.."
+  loader.ignore "#{__dir__}/lint/rake"
+  loader.setup
+end
+
+module Git
+  # Main namespace.
+  module Lint
+  end
+end