git-lint 2.4.0 → 3.1.0

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: git-lint
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
@@ -28,78 +28,92 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-10-03 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: git_plus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.4'
+        version: '9.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.4'
+        version: '9.1'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '2.5'
 description:
 email:
 - brooke@alchemists.io
@@ -112,8 +126,10 @@ extra_rdoc_files:
 files:
 - LICENSE.adoc
 - README.adoc
-- bin/git-lint
+- exe/git-lint
+- git-lint.gemspec
 - lib/git/lint.rb
+- lib/git/lint/analyzer.rb
 - lib/git/lint/analyzers/abstract.rb
 - lib/git/lint/analyzers/commit_author_capitalization.rb
 - lib/git/lint/analyzers/commit_author_email.rb
@@ -121,13 +137,13 @@ files:
 - lib/git/lint/analyzers/commit_body_bullet.rb
 - lib/git/lint/analyzers/commit_body_bullet_capitalization.rb
 - lib/git/lint/analyzers/commit_body_bullet_delimiter.rb
-- lib/git/lint/analyzers/commit_body_issue_tracker_link.rb
 - lib/git/lint/analyzers/commit_body_leading_line.rb
 - lib/git/lint/analyzers/commit_body_line_length.rb
 - lib/git/lint/analyzers/commit_body_paragraph_capitalization.rb
 - lib/git/lint/analyzers/commit_body_phrase.rb
 - lib/git/lint/analyzers/commit_body_presence.rb
 - lib/git/lint/analyzers/commit_body_single_bullet.rb
+- lib/git/lint/analyzers/commit_body_tracker_shorthand.rb
 - lib/git/lint/analyzers/commit_subject_length.rb
 - lib/git/lint/analyzers/commit_subject_prefix.rb
 - lib/git/lint/analyzers/commit_subject_suffix.rb
@@ -136,40 +152,51 @@ files:
 - lib/git/lint/analyzers/commit_trailer_collaborator_email.rb
 - lib/git/lint/analyzers/commit_trailer_collaborator_key.rb
 - lib/git/lint/analyzers/commit_trailer_collaborator_name.rb
-- lib/git/lint/branches/environments/circle_ci.rb
-- lib/git/lint/branches/environments/git_hub_action.rb
-- lib/git/lint/branches/environments/local.rb
-- lib/git/lint/branches/environments/netlify_ci.rb
-- lib/git/lint/branches/environments/travis_ci.rb
-- lib/git/lint/branches/feature.rb
-- lib/git/lint/cli.rb
+- lib/git/lint/cli/actions/analyze/branch.rb
+- lib/git/lint/cli/actions/analyze/commit.rb
+- lib/git/lint/cli/actions/config.rb
+- lib/git/lint/cli/actions/hook.rb
+- lib/git/lint/cli/parser.rb
+- lib/git/lint/cli/parsers/analyze.rb
+- lib/git/lint/cli/parsers/core.rb
+- lib/git/lint/cli/shell.rb
 - lib/git/lint/collector.rb
+- lib/git/lint/commits/container.rb
+- lib/git/lint/commits/loader.rb
+- lib/git/lint/commits/systems/circle_ci.rb
+- lib/git/lint/commits/systems/git_hub_action.rb
+- lib/git/lint/commits/systems/local.rb
+- lib/git/lint/commits/systems/netlify_ci.rb
+- lib/git/lint/configuration/content.rb
+- lib/git/lint/configuration/defaults.yml
+- lib/git/lint/configuration/loader.rb
+- lib/git/lint/configuration/setting.rb
+- lib/git/lint/container.rb
 - lib/git/lint/errors/base.rb
 - lib/git/lint/errors/severity.rb
 - lib/git/lint/errors/sha.rb
-- lib/git/lint/identity.rb
 - lib/git/lint/kit/filter_list.rb
 - lib/git/lint/parsers/trailers/collaborator.rb
 - lib/git/lint/rake/setup.rb
 - lib/git/lint/rake/tasks.rb
-- lib/git/lint/refinements/strings.rb
 - lib/git/lint/reporters/branch.rb
 - lib/git/lint/reporters/commit.rb
 - lib/git/lint/reporters/line.rb
 - lib/git/lint/reporters/lines/paragraph.rb
 - lib/git/lint/reporters/lines/sentence.rb
 - lib/git/lint/reporters/style.rb
-- lib/git/lint/runner.rb
 - lib/git/lint/validators/capitalization.rb
 - lib/git/lint/validators/email.rb
 - lib/git/lint/validators/name.rb
 homepage: https://www.alchemists.io/projects/git-lint
 licenses:
-- Apache-2.0
+- Hippocratic-3.0
 metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/git-lint/issues
-  changelog_uri: https://www.alchemists.io/projects/git-lint/changes.html
+  changelog_uri: https://www.alchemists.io/projects/git-lint/versions
   documentation_uri: https://www.alchemists.io/projects/git-lint
+  label: Git Lint
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/git-lint
 post_install_message:
 rdoc_options: []
@@ -179,14 +206,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.3.5
 signing_key:
 specification_version: 4
 summary: A command line interface for linting Git commits.

data/bin/git-lint

@@ -1,9 +0,0 @@
-#! /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/lint/analyzers/commit_body_issue_tracker_link.rb

@@ -1,39 +0,0 @@
-# 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 }
-
-        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))
-
-        def invalid_line?(line) = line.match?(/.*#{Regexp.union filter_list.to_regexp}.*/)
-      end
-    end
-  end
-end

data/lib/git/lint/branches/environments/circle_ci.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  module Lint
-    module Branches
-      module Environments
-        # Provides Circle CI build environment feature branch information.
-        class CircleCI
-          def initialize repository: GitPlus::Repository.new
-            @repository = repository
-          end
-
-          def name = "origin/#{repository.branch_name}"
-
-          def commits = repository.commits("origin/#{repository.branch_default}..#{name}")
-
-          private
-
-          attr_reader :repository
-        end
-      end
-    end
-  end
-end

data/lib/git/lint/branches/environments/local.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  module Lint
-    module Branches
-      module Environments
-        # Provides local build environment feature branch information.
-        class Local
-          def initialize repository: GitPlus::Repository.new
-            @repository = repository
-          end
-
-          def name = repository.branch_name
-
-          def commits = repository.commits("#{repository.branch_default}..#{name}")
-
-          private
-
-          attr_reader :repository
-        end
-      end
-    end
-  end
-end

data/lib/git/lint/branches/environments/travis_ci.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "open3"
-
-module Git
-  module Lint
-    module Branches
-      module Environments
-        # Provides Travis CI build environment feature branch information.
-        class TravisCI
-          def initialize repository: GitPlus::Repository.new, shell: Open3, environment: ENV
-            @repository = repository
-            @shell = shell
-            @environment = environment
-          end
-
-          def name = pull_request_branch.empty? ? ci_branch : pull_request_branch
-
-          def commits
-            prepare_project
-            repository.commits "origin/#{repository.branch_default}..#{name}"
-          end
-
-          private
-
-          attr_reader :environment, :repository, :shell
-
-          def prepare_project
-            slug = pull_request_slug
-
-            unless slug.empty?
-              shell.capture3 "git remote add -f original_branch https://github.com/#{slug}.git"
-              shell.capture3 "git fetch original_branch #{name}:#{name}"
-            end
-
-            shell.capture3 "git remote set-branches --add origin #{repository.branch_default}"
-            shell.capture3 "git fetch"
-          end
-
-          def ci_branch = environment["TRAVIS_BRANCH"]
-
-          def pull_request_branch = environment["TRAVIS_PULL_REQUEST_BRANCH"]
-
-          def pull_request_slug = environment["TRAVIS_PULL_REQUEST_SLUG"]
-        end
-      end
-    end
-  end
-end

data/lib/git/lint/branches/feature.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-require "refinements/strings"
-
-module Git
-  module Lint
-    module Branches
-      # Represents a feature branch.
-      class Feature
-        extend Forwardable
-
-        using ::Refinements::Strings
-
-        def_delegators :selected_environment, :name, :commits
-
-        def initialize environment: ENV, git_repo: GitPlus::Repository.new
-          message = "Invalid repository. Are you within a Git-enabled project?"
-          fail Errors::Base, message unless git_repo.exist?
-
-          @current_environment = environment
-          @selected_environment = load_environment
-        end
-
-        private
-
-        attr_reader :current_environment, :selected_environment
-
-        def load_environment
-          if key? "CIRCLECI" then Environments::CircleCI.new
-          elsif key? "GITHUB_ACTIONS" then Environments::GitHubAction.new
-          elsif key? "NETLIFY" then Environments::NetlifyCI.new environment: current_environment
-          elsif key? "TRAVIS" then Environments::TravisCI.new environment: current_environment
-          else Environments::Local.new
-          end
-        end
-
-        def key?(key) = current_environment.fetch(key, "false").to_bool
-      end
-    end
-  end
-end

data/lib/git/lint/cli.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-require "thor"
-require "thor/actions"
-require "runcom"
-require "pathname"
-require "pastel"
-
-module Git
-  module Lint
-    # The Command Line Interface (CLI) for the gem.
-    class CLI < Thor
-      include Thor::Actions
-
-      package_name Identity::VERSION_LABEL
-
-      def self.configuration
-        defaults = Analyzers::Abstract.descendants.reduce({}) do |settings, analyzer|
-          settings.merge analyzer.id => analyzer.defaults
-        end
-
-        Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: defaults
-      end
-
-      def initialize args = [], options = {}, config = {}
-        super args, options, config
-        @configuration = self.class.configuration
-        @runner = Runner.new configuration: @configuration.to_h
-        @colorizer = Pastel.new
-      rescue Runcom::Errors::Base => error
-        abort error.message
-      end
-
-      desc "-c, [--config]", "Manage gem configuration."
-      map %w[-c --config] => :config
-      method_option :edit,
-                    aliases: "-e",
-                    desc: "Edit gem configuration.",
-                    type: :boolean,
-                    default: false
-      method_option :info,
-                    aliases: "-i",
-                    desc: "Print gem configuration.",
-                    type: :boolean,
-                    default: false
-      def config
-        path = configuration.current
-
-        if options.edit? then `#{ENV["EDITOR"]} #{path}`
-        elsif options.info?
-          path ? say(path) : say("Configuration doesn't exist.")
-        else help :config
-        end
-      end
-
-      desc "-a, [--analyze]", "Analyze feature branch for issues."
-      map %w[-a --analyze] => :analyze
-      method_option :commits,
-                    aliases: "-c",
-                    desc: "Analyze specific commit SHA(s).",
-                    type: :array,
-                    default: []
-      def analyze
-        # FIX: Need to accept SHAs.
-        # collector = analyze_commits options.commits
-        collector = analyze_commits
-        abort if collector.errors?
-      rescue Errors::Base => error
-        abort colorizer.red("#{Identity::LABEL}: #{error.message}")
-      end
-
-      desc "--hook", "Add Git Hook support."
-      map "--hook" => :hook
-      method_option :commit_message, desc: "Analyze commit message.", banner: "PATH", type: :string
-      def hook
-        if options.commit_message?
-          check_commit_message options.commit_message
-        else
-          help "--hook"
-        end
-      rescue Errors::Base, GitPlus::Error => error
-        abort colorizer.red("#{Identity::LABEL}: #{error.message}")
-      end
-
-      desc "-v, [--version]", "Show gem version."
-      map %w[-v --version] => :version
-      def version
-        say Identity::VERSION_LABEL
-      end
-
-      desc "-h, [--help=COMMAND]", "Show this message or get help for a command."
-      map %w[-h --help] => :help
-      def help task = nil
-        say and super
-      end
-
-      private
-
-      attr_reader :configuration, :runner, :colorizer
-
-      def analyze_commits
-        runner.call.tap do |collector|
-          reporter = Reporters::Branch.new collector: collector
-          say reporter.to_s
-        end
-      end
-
-      def check_commit_message path
-        commit = GitPlus::Repository.new.unsaved Pathname(path)
-        collector = runner.call commits: [commit]
-        reporter = Reporters::Branch.new collector: collector
-        say reporter.to_s
-        abort if collector.errors?
-      end
-    end
-  end
-end

data/lib/git/lint/identity.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  module Lint
-    # Gem identity information.
-    module Identity
-      NAME = "git-lint"
-      LABEL = "Git Lint"
-      VERSION = "2.4.0"
-      VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
-    end
-  end
-end

data/lib/git/lint/refinements/strings.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  module Lint
-    module Refinements
-      module Strings
-        refine String do
-          def pluralize count:, suffix: "s"
-            return "#{count} #{self}" if count == 1
-
-            "#{count} #{self}#{suffix}"
-          end
-
-          def fixup? = match?(/\Afixup!\s/)
-
-          def squash? = match?(/\Asquash!\s/)
-        end
-      end
-    end
-  end
-end

data/lib/git/lint/runner.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  module Lint
-    class Runner
-      def initialize configuration:, branch: Branches::Feature.new, collector: Collector.new
-        @configuration = configuration
-        @branch = branch
-        @collector = collector
-      end
-
-      def call commits: branch.commits
-        commits.map { |commit| check commit }
-        collector
-      end
-
-      private
-
-      attr_reader :configuration, :branch, :collector
-
-      def check commit
-        configuration.map { |id, settings| load_analyzer id, commit, settings }
-                     .select(&:enabled?)
-                     .map { |analyzer| collector.add analyzer }
-      end
-
-      def load_analyzer id, commit, settings
-        klass = Analyzers::Abstract.descendants.find { |descendant| descendant.id == id }
-        fail Errors::Base, "Invalid analyzer: #{id}. See docs for supported analyzer." unless klass
-
-        klass.new commit: commit, settings: settings
-      end
-    end
-  end
-end