git-lint 4.6.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d02f9170b8002b1fec4f4c37602195fe1c097a9fb7a48dd29b7fea2f6d7d2fa8
-  data.tar.gz: 2d3f96fedecaa53da9f889ea11ee299c72ba6128fb83fa1773341e0140226f57
+  metadata.gz: 3955d8d2f1ec24fd3501d952c62d3639f96fa5e417ef56ca0fe48269048c8ba1
+  data.tar.gz: b02899b30de349bab2a672de98ab06ce4155c500781fb6274adc512afb3ef9a0
 SHA512:
-  metadata.gz: ded52e449c9ff4b05b0327976eec0534964d7b596130221ef14449b8a0b0e7d214d0dfe8c8b2846d7f057d578fae927825228ac1e2a1dbfa6b86dbae3b29495b
-  data.tar.gz: 6b846bc2625c81485f39ae22a4cb28623dbaf698ea7ff70d191a5ed94e470ab54e5097093ce3fce08cfc06e92094afdef1880d4cd85bf751a9d08c9dfefaf98d
+  metadata.gz: 521674b30c53b1ebefa82ed270e685280c69ae9b25ca323cc79658a7b308fb8edf6940d957760bffd7d8a39092e6648b828f12721de2a1ab41477684338fac7e
+  data.tar.gz: 422413f4a60e9f3a2079578c4d01f0e8fb6d76f3b4958f10704f5d2f87728251908fbf8a53a82109a899069fe2d446c6d359eb174c35f55057b0a8cea377a16f

data/README.adoc

@@ -407,12 +407,10 @@ ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, orn
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| true    | error    | maximum: 72
+| false   | error    | maximum: 72
 |===
 
-Ensures each line of the commit body doesn't force you to scroll horizontally to read the message.
-This allows commit messages to remain readable and is especially handy when commit messages are read
-via the command line or email clients.
+Ensures each line of the commit body doesn't extend beyond the maximum column limit.
 
 ==== Commit Body Paragraph Capitalization
 
@@ -462,7 +460,7 @@ and provides the missing spec to ensure this doesn't happen again.
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| false   | warn     | minimum: 1
+| true    | warn     | minimum: 1
 |===
 
 Ensures a minimum number of lines are present within the commit body. Lines with empty characters
@@ -517,6 +515,27 @@ Instead of using tracker shorthand syntax, take the time to write a short summar
 commit was made. Doing this will make it easier to understand _why_ the commit was made, keeps the
 commit self-contained, and makes learning about/debugging the commit faster.
 
+==== Commit Signature
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| false   | error    | includes: `["Good"]`
+|===
+
+Ensures all commit signatures are properly signed for improved security and validity of code being committed by various authors. By default, only "Good" signatures are allowed but you can expand this list if desired (although not recommended for security reasons). Valid options are:
+
+* *Bad* (_B_)
+* *Error* (_E_)
+* *Good* (_G_)
+* *None* (_N_)
+* *Revoked* (_R_)
+* *Unknown* (_U_)
+* *Expired* (_X_)
+* *Expired Key* (_Y_)
+
+All of the above obtained when using the pretty formats as provided by link:https://git-scm.com/docs/git-log#Documentation/git-log.txt-emGem[Git Log].
+
 ==== Commit Subject Length
 
 [options="header"]
@@ -598,7 +617,7 @@ releases.
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| false   | error    | none
+| true    | error    | none
 |===
 
 Ensures collaborator name is properly capitalized. Example:
@@ -611,15 +630,69 @@ shepherd derrial book
 Shepherd Derrial Book
 ....
 
-==== Commit Trailer Collaborator Duplication
+==== Commit Trailer Collaborator Email
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | none
+|===
+
+Ensures collaborator email address is valid for commit trailer.
+
+....
+# Disallowed
+Co-Authored-By: River Tam <invalid>
+
+# Allowed
+Co-Authored-By: River Tam <river@firefly.com>
+....
+
+==== Commit Trailer Collaborator Key
 
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| false   | error    | none
+| true   | error    | includes: `["Co-Authored-By"]`
 |===
 
-Ensures collaborator trailers are not duplicated. Example:
+Ensures collaborator trailer key is correct format.
+
+....
+# Disallowed
+Co-authored-by: River Tam <river@firefly.com>
+
+# Allowed
+Co-Authored-By: River Tam <river@firefly.com>
+....
+
+==== Commit Trailer Collaborator Name
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | minimum: 2
+|===
+
+Ensures collaborator name consists of, at least, a first and last name. Example:
+
+....
+# Disallowed
+Co-Authored-By: River <river@firefly.com>
+
+# Allowed
+Co-Authored-By: River Tam <river@firefly.com>
+....
+
+==== Commit Trailer Duplicate
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | minimum: 2
+|===
+
+Ensures commit trailer keys are not duplicated. Example:
 
 ....
 # Disallowed
@@ -631,58 +704,184 @@ Co-Authored-By: Malcolm Reynolds <malcolm@firefly.com>
 Co-Authored-By: Shepherd Derrial Book <shepherd@firefly.com>
 ....
 
-==== Commit Trailer Collaborator Email
+==== Commit Trailer Format Key
 
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| false   | error    | none
+| true    | error    | includes: `["Format"]`
 |===
 
-Ensures collaborator email address is valid for commit trailer.
+Ensures format trailer key is correct format.
 
 ....
 # Disallowed
-Co-Authored-By: River Tam <invalid>
+format: ASCII
 
 # Allowed
-Co-Authored-By: River Tam <river@firefly.com>
+Format: ASCII
 ....
 
-==== Commit Trailer Collaborator Key
+==== Commit Trailer Format Value
 
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| false   | error    | includes: `["Co-Authored-By"]`
+| true    | error    | includes: `["ASCII", "Markdown"]`
 |===
 
-Ensures collaborator trailer key is correct format.
+Ensures format trailer value is a valid value.
 
 ....
 # Disallowed
-Co-authored-by: River Tam <river@firefly.com>
+Format: Plain
 
 # Allowed
-Co-Authored-By: River Tam <river@firefly.com>
+Format: ASCII
 ....
 
-==== Commit Trailer Collaborator Name
+==== Commit Trailer Issue Key
 
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| false   | error    | minimum: 2
+| true    | error    | includes: `["Issue"]`
 |===
 
-Ensures collaborator name consists of, at least, a first and last name. Example:
+Ensures issue trailer key is correct format.
 
 ....
 # Disallowed
-Co-Authored-By: River <river@firefly.com>
+issue: 123
 
 # Allowed
-Co-Authored-By: River Tam <river@firefly.com>
+Issue: 123
+....
+
+==== Commit Trailer Issue Value
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | includes: `["[\\w-]+"]`
+|===
+
+Ensures issue trailer value is correct format.
+
+....
+# Disallowed
+Issue: 123+45
+
+# Allowed
+Issue: 123
+....
+
+==== Commit Trailer Signer Capitalization
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | none
+|===
+
+Ensures commit signer trailer name is properly capitalized.
+
+....
+# Disallowed
+Signed-By: jayne cobb
+
+# Allowed
+Signed-By: Jayne Cobb
+....
+
+==== Commit Trailer Signer Email
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | none
+|===
+
+Ensures commit signer trailer email is properly capitalized.
+
+....
+# Disallowed
+Signed-By: Jayne Cobb <invalid>
+
+# Allowed
+Signed-By: Jayne Cobb <jcobb@firefly.com>
+....
+
+==== Commit Trailer Signer Key
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | includes: `["Signed-By"]`
+|===
+
+Ensures signer trailer key is correct format.
+
+....
+# Disallowed
+signed-by: Jayne Cobb
+
+# Allowed
+Signed-By: Jayne Cobb
+....
+
+==== Commit Trailer Signer Name
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | minimum: 2
+|===
+
+Ensures signer name consists of, at least, a first and last name.
+
+....
+# Disallowed
+Signed-By: Jayne
+
+# Allowed
+Signed-By: Jayne Cobb
+....
+
+==== Commit Trailer Tracker Key
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | includes: `["Tracker"]`
+|===
+
+Ensures tracker trailer key is correct format.
+
+....
+# Disallowed
+tracker: Linear
+
+# Allowed
+Tracker: Linear
+....
+
+==== Commit Trailer Tracker Value
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | includes: `["[\\w\\-\\s]+"]`
+|===
+
+Ensures tracker trailer key is correct format.
+
+....
+# Disallowed
+Tracker: *ACME$
+
+# Allowed
+Tracker: ACME Issues
 ....
 
 === Git
@@ -788,18 +987,24 @@ Whenever a commit has been saved, this script will run Git Lint to check for iss
 
 === Rake
 
-This gem provides optional Rake tasks. They can be added to your project by adding the following
-requirement to the top of your `Rakefile`:
+You can add Rake support by adding the following to your `Rakefile`:
 
 [source,ruby]
 ----
-require "git/lint/rake/setup"
+begin
+  require "git/lint/rake/register"
+rescue LoadError => error
+  puts error.message
+end
+
+Git::Lint::Rake::Register.call
 ----
 
-Now, when running `bundle exec rake -T`, you'll see `git_lint` included in the list.
+Once required and registered, the following tasks will be available (i.e. `bundle exec rake -T`):
 
-If you need a concrete example, check out the
-link:https://github.com/bkuhlmann/git-lint/blob/main/Rakefile[Rakefile] of this project for details.
+....
+rake git_lint
+....
 
 === Continuous Integration (CI)
 

data/git-lint.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "git-lint"
-  spec.version = "4.6.0"
+  spec.version = "5.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/git-lint"
@@ -22,15 +22,16 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = "~> 3.1"
-  spec.add_dependency "cogger", "~> 0.4"
+  spec.required_ruby_version = "~> 3.2"
+  spec.add_dependency "cogger", "~> 0.5"
   spec.add_dependency "dry-container", "~> 0.11"
-  spec.add_dependency "git_plus", "~> 1.7"
-  spec.add_dependency "infusible", "~> 0.2"
+  spec.add_dependency "dry-monads", "~> 1.6"
+  spec.add_dependency "gitt", "~> 1.0"
+  spec.add_dependency "infusible", "~> 1.0"
   spec.add_dependency "pastel", "~> 0.8"
-  spec.add_dependency "refinements", "~> 9.7"
-  spec.add_dependency "runcom", "~> 8.7"
-  spec.add_dependency "spek", "~> 0.6"
+  spec.add_dependency "refinements", "~> 10.0"
+  spec.add_dependency "runcom", "~> 9.0"
+  spec.add_dependency "spek", "~> 1.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.bindir = "exe"

data/lib/git/lint/analyzer.rb

@@ -20,14 +20,25 @@ module Git
         Analyzers::CommitBodyPresence,
         Analyzers::CommitBodySingleBullet,
         Analyzers::CommitBodyTrackerShorthand,
+        Analyzers::CommitSignature,
         Analyzers::CommitSubjectLength,
         Analyzers::CommitSubjectPrefix,
         Analyzers::CommitSubjectSuffix,
         Analyzers::CommitTrailerCollaboratorCapitalization,
-        Analyzers::CommitTrailerCollaboratorDuplication,
         Analyzers::CommitTrailerCollaboratorEmail,
         Analyzers::CommitTrailerCollaboratorKey,
-        Analyzers::CommitTrailerCollaboratorName
+        Analyzers::CommitTrailerCollaboratorName,
+        Analyzers::CommitTrailerDuplicate,
+        Analyzers::CommitTrailerFormatKey,
+        Analyzers::CommitTrailerFormatValue,
+        Analyzers::CommitTrailerIssueKey,
+        Analyzers::CommitTrailerIssueValue,
+        Analyzers::CommitTrailerSignerCapitalization,
+        Analyzers::CommitTrailerSignerEmail,
+        Analyzers::CommitTrailerSignerKey,
+        Analyzers::CommitTrailerSignerName,
+        Analyzers::CommitTrailerTrackerKey,
+        Analyzers::CommitTrailerTrackerValue
       ].freeze
 
       # rubocop:disable Metrics/ParameterLists
@@ -54,7 +65,7 @@ module Git
 
       def process commits
         collector.clear
-        commits.map { |commit| analyze commit }
+        commits.value_or([]).map { |commit| analyze commit }
       end
 
       def analyze commit

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

@@ -12,13 +12,13 @@ module Git
         using ::Refinements::Strings
 
         LEVELS = %i[warn error].freeze
-        ISSUE_LINE_OFFSET = 2
+        BODY_OFFSET = 3
 
         def self.id = to_s.delete_prefix("Git::Lint::Analyzers").snakecase.to_sym
 
         def self.label = to_s.delete_prefix("Git::Lint::Analyzers").titleize
 
-        def self.build_issue_line(index, line) = {number: index + ISSUE_LINE_OFFSET, content: line}
+        def self.build_issue_line(index, line) = {number: index + BODY_OFFSET, content: line}
 
         attr_reader :commit
 
@@ -64,9 +64,12 @@ module Git
 
         def affected_commit_trailers
           commit.trailers
-                .each.with_object([])
-                .with_index(commit.trailers_index) do |(line, lines), index|
-                  lines << self.class.build_issue_line(index, line) if invalid_line? line
+                .each
+                .with_object([])
+                .with_index(commit.body_lines.size) do |(trailer, trailers), index|
+                  next unless invalid_line? trailer
+
+                  trailers << self.class.build_issue_line(index, trailer.to_s)
                 end
         end
 

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

@@ -5,22 +5,15 @@ module Git
     module Analyzers
       # Analyzes author for proper capitalization of author name.
       class CommitAuthorCapitalization < Abstract
-        def initialize commit, validator: Validators::Capitalization, **dependencies
-          super commit, **dependencies
-          @validator = validator
-        end
+        include Import[validator: "validators.capitalization"]
 
-        def valid? = validator.new(commit.author_name).valid?
+        def valid? = validator.call commit.author_name
 
         def issue
           return {} if valid?
 
           {hint: %(Capitalize each part of name: "#{commit.author_name}".)}
         end
-
-        private
-
-        attr_reader :validator
       end
     end
   end

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

@@ -5,22 +5,15 @@ module Git
     module Analyzers
       # Analyzes author email address for proper format.
       class CommitAuthorEmail < Abstract
-        def initialize commit, validator: Validators::Email, **dependencies
-          super commit, **dependencies
-          @validator = validator
-        end
+        include Import[validator: "validators.email"]
 
-        def valid? = validator.new(commit.author_email).valid?
+        def valid? = validator.call commit.author_email
 
         def issue
           return {} if valid?
 
           {hint: %(Use "<name>@<server>.<domain>" instead of "#{commit.author_email}".)}
         end
-
-        private
-
-        attr_reader :validator
       end
     end
   end

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

@@ -5,12 +5,9 @@ module Git
     module Analyzers
       # Analyzes author name for minimum parts of name.
       class CommitAuthorName < Abstract
-        def initialize commit, validator: Validators::Name, **dependencies
-          super commit, **dependencies
-          @validator = validator
-        end
+        include Import[validator: "validators.name"]
 
-        def valid? = validator.new(commit.author_name, minimum:).valid?
+        def valid? = validator.call(commit.author_name, minimum:)
 
         def issue
           return {} if valid?
@@ -20,8 +17,6 @@ module Git
 
         private
 
-        attr_reader :validator
-
         def minimum = settings.minimum
       end
     end

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

@@ -6,12 +6,12 @@ module Git
       # Analyzes leading line between commit subject and start of body.
       class CommitBodyLeadingLine < Abstract
         def valid?
-          message = commit.message
-          subject, body = message.split "\n", 2
+          raw = commit.raw
+          subject, body = raw.split "\n", 2
 
           return true if !String(subject).empty? && String(body).strip.empty?
 
-          message.match?(/\A.+(\n\n|\#).+/m)
+          raw.match?(/\A.+(\n\n|\#).+/m)
         end
 
         def issue

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

@@ -7,7 +7,12 @@ module Git
       class CommitBodyParagraphCapitalization < Abstract
         def self.invalid?(line) = line.match?(/\A[[:lower:]].+\Z/m)
 
-        def valid? = lowercased_lines.empty?
+        def initialize(...)
+          super
+          @invalids = commit.body_paragraphs.select { |line| self.class.invalid? line }
+        end
+
+        def valid? = invalids.empty?
 
         def issue
           return {} if valid?
@@ -20,13 +25,11 @@ module Git
 
         private
 
-        def lowercased_lines = commit.body_paragraphs.select { |line| self.class.invalid? line }
+        attr_reader :invalids
 
         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)
+          invalids.each.with_object [] do |line, lines|
+            lines << self.class.build_issue_line(commit.body_lines.index(line[/.+/]), line)
           end
         end
       end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes commit signature validity.
+      class CommitSignature < Abstract
+        include Import[sanitizer: "sanitizers.signature"]
+
+        def valid?
+          sanitizer.call(commit.signature).match?(/\A#{Regexp.union filter_list.to_regexp}\Z/)
+        end
+
+        def issue = valid? ? {} : {hint: %(Use: #{filter_list.to_hint}.)}
+
+        protected
+
+        def load_filter_list = Kit::FilterList.new(settings.includes)
+      end
+    end
+  end
+end

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

@@ -5,16 +5,11 @@ module Git
     module Analyzers
       # Analyzes commit trailer collaborator name capitalization.
       class CommitTrailerCollaboratorCapitalization < Abstract
-        # rubocop:disable Metrics/ParameterLists
-        def initialize commit,
-                       parser: Parsers::Trailers::Collaborator,
-                       validator: Validators::Capitalization,
-                       **dependencies
-          super commit, **dependencies
-          @parser = parser
-          @validator = validator
-        end
-        # rubocop:enable Metrics/ParameterLists
+        include Import[
+          pattern: "trailers.collaborator",
+          parser: "parsers.person",
+          validator: "validators.capitalization"
+        ]
 
         def valid? = affected_commit_trailers.empty?
 
@@ -29,14 +24,11 @@ module Git
 
         protected
 
-        def invalid_line? line
-          collaborator = parser.new line
-          collaborator.match? && !validator.new(collaborator.name.strip).valid?
+        def invalid_line? trailer
+          parser.call(trailer.value).then do |person|
+            trailer.key.match?(pattern) && !validator.call(person.name)
+          end
         end
-
-        private
-
-        attr_reader :parser, :validator
       end
     end
   end