Class: Git::Lint::Analyzers::Abstract

Inherits:

Object

• Object
• Git::Lint::Analyzers::Abstract

Defined in:

lib/git/lint/analyzers/abstract.rb

Overview

An abstract class which provides basic functionality for all analyzers to inherit from.

Direct Known Subclasses

CommitAuthorCapitalization, CommitAuthorEmail, CommitAuthorName, CommitBodyBulletCapitalization, CommitBodyBulletDelimiter, CommitBodyBulletOnly, CommitBodyLeadingLine, CommitBodyLineLength, CommitBodyParagraphCapitalization, CommitBodyPhrase, CommitBodyPresence, CommitBodyTrackerShorthand, CommitBodyWordRepeat, CommitSignature, CommitSubjectLength, CommitSubjectPrefix, CommitSubjectSuffix, CommitSubjectWordRepeat, CommitTrailerCollaboratorCapitalization, CommitTrailerCollaboratorEmail, CommitTrailerCollaboratorKey, CommitTrailerCollaboratorName, CommitTrailerDuplicate, CommitTrailerFormatKey, CommitTrailerFormatValue, CommitTrailerIssueKey, CommitTrailerIssueValue, CommitTrailerMilestoneKey, CommitTrailerMilestoneValue, CommitTrailerOrder, CommitTrailerReviewerKey, CommitTrailerReviewerValue, CommitTrailerSignerCapitalization, CommitTrailerSignerEmail, CommitTrailerSignerKey, CommitTrailerSignerName, CommitTrailerTrackerKey, CommitTrailerTrackerValue

Constant Summary

LEVELS =

%w[warn error].freeze

BODY_OFFSET =

3

Instance Attribute Summary

• #commit ⇒ Object readonly

  Returns the value of attribute commit.

Class Method Summary

• .build_issue_line(index, line) ⇒ Object
• .id ⇒ Object
• .label ⇒ Object

Instance Method Summary

• #error? ⇒ Boolean
• #initialize(commit) ⇒ Abstract constructor

  A new instance of Abstract.

• #invalid? ⇒ Boolean
• #issue ⇒ Object
• #severity ⇒ Object
• #valid? ⇒ Boolean
• #warning? ⇒ Boolean

Constructor Details

#initialize(commit) ⇒ Abstract

Returns a new instance of Abstract.

# File 'lib/git/lint/analyzers/abstract.rb', line 26

def initialize(commit, **)
  super(**)
  @commit = commit
  @filter_list = load_filter_list
end

Instance Attribute Details

#commit ⇒ Object (readonly)

Returns the value of attribute commit.

# File 'lib/git/lint/analyzers/abstract.rb', line 24

def commit
  @commit
end

Class Method Details

.build_issue_line(index, line) ⇒ Object

# File 'lib/git/lint/analyzers/abstract.rb', line 22

def self.build_issue_line(index, line) = {number: index + BODY_OFFSET, content: line}

.id ⇒ Object

# File 'lib/git/lint/analyzers/abstract.rb', line 18

def self.id = to_s.delete_prefix!("Git::Lint::Analyzers").snakecase

.label ⇒ Object

# File 'lib/git/lint/analyzers/abstract.rb', line 20

def self.label = to_s.delete_prefix("Git::Lint::Analyzers").titleize

Instance Method Details

#error? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/git/lint/analyzers/abstract.rb', line 43

def error? = invalid? && severity == "error"

#invalid? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/git/lint/analyzers/abstract.rb', line 39

def invalid? = !valid?

#issue ⇒ Object

# File 'lib/git/lint/analyzers/abstract.rb', line 45

def issue = fail NoMethodError, "The `##{__method__}` method must be implemented."

#severity ⇒ Object

# File 'lib/git/lint/analyzers/abstract.rb', line 32

def severity
  configuration.public_send("#{self.class.id}_severity".sub("commit_", "commits_"))
               .tap { |level| fail Errors::Severity, level unless LEVELS.include? level }
end

#valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/git/lint/analyzers/abstract.rb', line 37

def valid? = fail NoMethodError, "The `##{__method__}` method must be implemented."

#warning? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/git/lint/analyzers/abstract.rb', line 41

def warning? = invalid? && severity == "warn"