git-lint 2.4.0 → 3.0.0

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module CLI
+      module Actions
+        module Analyze
+          # Handles analyze action for commit(s) by SHA.
+          class Commit
+            def initialize analyzer: Analyzer.new,
+                           parser: GitPlus::Parsers::Commits::Saved::History.with_show,
+                           container: Container
+              @analyzer = analyzer
+              @parser = parser
+              @container = container
+            end
+
+            def call sha = nil
+              process sha
+            rescue Errors::Base => error
+              logger.error { error.message }
+              kernel.abort
+            end
+
+            private
+
+            attr_reader :analyzer, :parser, :container
+
+            def process sha
+              analyzer.call commits: parser.call(*sha) do |collector, reporter|
+                kernel.puts reporter
+                kernel.abort if collector.errors?
+              end
+            end
+
+            def kernel = container[__method__]
+
+            def logger = container[__method__]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/cli/actions/config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module CLI
+      module Actions
+        # Handles gem configuration action.
+        class Config
+          def initialize configuration: Configuration::Loader::CLIENT, container: Container
+            @configuration = configuration
+            @container = container
+          end
+
+          def call action
+            case action
+              when :edit then edit
+              when :view then view
+              else logger.error { "Invalid configuration action: #{action}." }
+            end
+          end
+
+          private
+
+          attr_reader :configuration, :container
+
+          def edit = kernel.system("$EDITOR #{configuration.current}")
+
+          def view = kernel.system("cat #{configuration.current}")
+
+          def kernel = container[__method__]
+
+          def logger = container[__method__]
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/cli/actions/hook.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module CLI
+      module Actions
+        # Handles unsaved Git commit action.
+        class Hook
+          def initialize analyzer: Analyzer.new, container: Container
+            @analyzer = analyzer
+            @container = container
+          end
+
+          def call path
+            analyzer.call commits: [repository.unsaved(path)] do |collector, reporter|
+              kernel.puts reporter
+              kernel.abort if collector.errors?
+            end
+          end
+
+          private
+
+          attr_reader :analyzer, :container
+
+          def repository = container[__method__]
+
+          def kernel = container[__method__]
+
+          def logger = container[__method__]
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/cli/parser.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Git
+  module Lint
+    module CLI
+      # Assembles and parses all Command Line Interface (CLI) options.
+      class Parser
+        CLIENT = OptionParser.new nil, 40, "  "
+        SECTIONS = [Parsers::Core, Parsers::Analyze].freeze # Order matters.
+
+        def initialize sections: SECTIONS, client: CLIENT, container: Container
+          @sections = sections
+          @client = client
+          @configuration = container[:configuration].dup
+        end
+
+        def call arguments = []
+          sections.each { |section| section.call configuration, client: }
+          client.parse arguments
+          configuration.freeze
+        end
+
+        def to_s = client.to_s
+
+        private
+
+        attr_reader :sections, :client, :configuration
+      end
+    end
+  end
+end

data/lib/git/lint/cli/parsers/analyze.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Git
+  module Lint
+    module CLI
+      module Parsers
+        # Handles parsing of Command Line Interface (CLI) core options.
+        class Analyze
+          using ::Refinements::Structs
+
+          def self.call(...) = new(...).call
+
+          def initialize configuration = Container[:configuration], client: Parser::CLIENT
+            @configuration = configuration
+            @client = client
+          end
+
+          def call arguments = []
+            client.separator "\nANALYZE OPTIONS:\n"
+            add_sha
+            client.parse arguments
+            configuration
+          end
+
+          private
+
+          attr_reader :configuration, :client
+
+          def add_sha
+            client.on "--sha HASH", "Analyze specific commit SHA." do |sha|
+              configuration.merge! analyze_sha: sha
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/cli/parsers/core.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Git
+  module Lint
+    module CLI
+      module Parsers
+        # Handles parsing of Command Line Interface (CLI) core options.
+        class Core
+          using ::Refinements::Structs
+
+          def self.call(...) = new(...).call
+
+          def initialize configuration = Container[:configuration], client: Parser::CLIENT
+            @configuration = configuration
+            @client = client
+          end
+
+          def call arguments = []
+            client.banner = "#{Identity::LABEL} - #{Identity::SUMMARY}"
+            client.separator "\nUSAGE:\n"
+            collate
+            client.parse arguments
+            configuration
+          end
+
+          private
+
+          attr_reader :configuration, :client
+
+          def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
+
+          def add_analyze
+            client.on "-a", "--analyze [options]", "Analyze current branch commits." do
+              configuration.merge! action_analyze: true
+            end
+          end
+
+          def add_config
+            client.on(
+              "-c",
+              "--config ACTION",
+              %i[edit view],
+              "Manage gem configuration. Actions: edit or view."
+            ) do |action|
+              configuration.merge! action_config: action
+            end
+          end
+
+          def add_hook
+            client.on "--hook PATH", "Hook for analyzing unsaved commits." do |path|
+              configuration.merge! action_hook: Pathname(path)
+            end
+          end
+
+          def add_version
+            client.on "-v", "--version", "Show gem version." do
+              configuration.merge! action_version: Identity::VERSION_LABEL
+            end
+          end
+
+          def add_help
+            client.on "-h", "--help", "Show this message." do
+              configuration.merge! action_help: true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/cli/shell.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module CLI
+      # The main Command Line Interface (CLI) object.
+      class Shell
+        ACTIONS = {
+          analyze_branch: Actions::Analyze::Branch.new,
+          analyze_commit: Actions::Analyze::Commit.new,
+          config: Actions::Config.new,
+          hook: Actions::Hook.new
+        }.freeze
+
+        def initialize parser: Parser.new, actions: ACTIONS, container: Container
+          @parser = parser
+          @actions = actions
+          @container = container
+        end
+
+        def call arguments = []
+          perform parser.call(arguments)
+        rescue OptionParser::ParseError, Errors::Base => error
+          logger.error { error.message }
+        end
+
+        private
+
+        attr_reader :parser, :actions, :container
+
+        def perform configuration
+          case configuration
+            in action_analyze: true, analyze_sha: nil then analyze_branch
+            in action_analyze: true, analyze_sha: String => sha then analyze_commit sha
+            in action_config: Symbol => action then config action
+            in action_hook: Pathname => path then hook path
+            in action_version: String => version then logger.info version
+            else usage
+          end
+        end
+
+        def analyze_branch = actions.fetch(__method__).call
+
+        def analyze_commit(sha) = actions.fetch(__method__).call(sha)
+
+        def config(action) = actions.fetch(__method__).call(action)
+
+        def hook(path) = actions.fetch(__method__).call(path)
+
+        def usage = logger.unknown { parser.to_s }
+
+        def logger = container[__method__]
+      end
+    end
+  end
+end

data/lib/git/lint/collector.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require "refinements/hashes"
-
 module Git
   module Lint
+    # Collects and categorizes, by severity, all issues (if any).
     class Collector
-      using ::Refinements::Hashes
-
       def initialize
         @collection = Hash.new { |default, missing_id| default[missing_id] = [] }
       end
@@ -18,6 +15,8 @@ module Git
 
       def retrieve(id) = collection[id]
 
+      def clear = collection.clear && self
+
       def empty? = collection.empty?
 
       def warnings? = collection.values.flatten.any?(&:warning?)

data/lib/git/lint/commits/container.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "git_plus"
+
+module Git
+  module Lint
+    module Commits
+      # Provides container specific to this namespace for all systems.
+      module Container
+        extend Dry::Container::Mixin
+
+        register(:repository) { GitPlus::Repository.new }
+        register(:shell) { Open3 }
+        register(:environment) { ENV }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "refinements/strings"
+
+module Git
+  module Lint
+    module Commits
+      # Automatically detects and loads system.
+      class Loader
+        using ::Refinements::Strings
+
+        SYSTEMS = {
+          circle_ci: Systems::CircleCI.new,
+          git_hub_action: Systems::GitHubAction.new,
+          netlify_ci: Systems::NetlifyCI.new,
+          local: Systems::Local.new
+        }.freeze
+
+        def initialize systems: SYSTEMS, container: Container
+          @systems = systems
+          @container = container
+        end
+
+        def call
+          message = "Invalid repository. Are you within a Git repository?"
+          fail Errors::Base, message unless repository.exist?
+
+          load_system.call
+        end
+
+        private
+
+        attr_reader :systems, :container
+
+        def load_system
+          if key? "CIRCLECI" then systems.fetch :circle_ci
+          elsif key? "GITHUB_ACTIONS" then systems.fetch :git_hub_action
+          elsif key? "NETLIFY" then systems.fetch :netlify_ci
+          else systems.fetch :local
+          end
+        end
+
+        def key?(key) = environment.fetch(key, "false").to_bool
+
+        def repository = container[__method__]
+
+        def environment = container[__method__]
+      end
+    end
+  end
+end

data/lib/git/lint/commits/systems/circle_ci.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Commits
+      module Systems
+        # Provides Circle CI build environment feature branch information.
+        class CircleCI
+          def initialize container: Container
+            @container = container
+          end
+
+          def call = repository.commits("origin/#{repository.branch_default}..#{name}")
+
+          private
+
+          attr_reader :container
+
+          def name = "origin/#{repository.branch_name}"
+
+          def repository = container[__method__]
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/{branches/environments → commits/systems}/git_hub_action.rb

@@ -2,21 +2,23 @@
 
 module Git
   module Lint
-    module Branches
-      module Environments
+    module Commits
+      module Systems
         # Provides GitHub Action build environment feature branch information.
         class GitHubAction
-          def initialize repository: GitPlus::Repository.new
-            @repository = repository
+          def initialize container: Container
+            @container = container
           end
 
-          def name = "origin/#{repository.branch_name}"
-
-          def commits = repository.commits("origin/#{repository.branch_default}..#{name}")
+          def call = repository.commits("origin/#{repository.branch_default}..#{name}")
 
           private
 
-          attr_reader :repository
+          attr_reader :container
+
+          def name = "origin/#{repository.branch_name}"
+
+          def repository = container[__method__]
         end
       end
     end

data/lib/git/lint/commits/systems/local.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Commits
+      module Systems
+        # Provides local build environment feature branch information.
+        class Local
+          def initialize container: Container
+            @container = container
+          end
+
+          def call = repository.commits("#{repository.branch_default}..#{name}")
+
+          private
+
+          attr_reader :container
+
+          def name = repository.branch_name
+
+          def repository = container[__method__]
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/{branches/environments → commits/systems}/netlify_ci.rb

@@ -4,19 +4,15 @@ require "open3"
 
 module Git
   module Lint
-    module Branches
-      module Environments
+    module Commits
+      module Systems
         # Provides Netlify CI build environment feature branch information.
         class NetlifyCI
-          def initialize repository: GitPlus::Repository.new, shell: Open3, environment: ENV
-            @repository = repository
-            @shell = shell
-            @environment = environment
+          def initialize container: Container
+            @container = container
           end
 
-          def name = environment["HEAD"]
-
-          def commits
+          def call
             shell.capture3 "git remote add -f origin #{environment["REPOSITORY_URL"]}"
             shell.capture3 "git fetch origin #{name}:#{name}"
             repository.commits "origin/#{repository.branch_default}..origin/#{name}"
@@ -24,7 +20,15 @@ module Git
 
           private
 
-          attr_reader :repository, :shell, :environment
+          attr_reader :container
+
+          def name = environment["HEAD"]
+
+          def repository = container[__method__]
+
+          def shell = container[__method__]
+
+          def environment = container[__method__]
         end
       end
     end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Configuration
+      # Defines configuration content as the primary source of truth for use throughout the gem.
+      Content = Struct.new(
+        :action_analyze,
+        :action_config,
+        :action_help,
+        :action_hook,
+        :action_version,
+        :analyze_sha,
+        :analyzers,
+        keyword_init: true
+      ) do
+        def initialize *arguments
+          super
+          freeze
+        end
+
+        def find_setting(id) = analyzers.find { |setting| setting.id == id }
+      end
+    end
+  end
+end

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