git-lint 1.0.0

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

@@ -0,0 +1,25 @@
+# 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/)
+          end
+
+          def squash?
+            match?(/\Asquash!\s/)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "pastel"
+
+module Git
+  module Lint
+    module Reporters
+      # Reports issues related to a single branch.
+      class Branch
+        using Refinements::Strings
+
+        def initialize collector: Collector.new, colorizer: Pastel.new
+          @collector = collector
+          @colorizer = colorizer
+        end
+
+        def to_s
+          "Running #{Identity::LABEL}...#{branch_report}\n" \
+          "#{commit_total}. #{issue_totals}.\n"
+        end
+
+        private
+
+        attr_reader :collector, :colorizer
+
+        def commit_report
+          collector.to_h.reduce "" do |details, (commit, analyzers)|
+            details + Commit.new(commit: commit, analyzers: analyzers).to_s
+          end
+        end
+
+        def branch_report
+          return "" unless collector.issues?
+
+          "\n\n#{commit_report}".chomp "\n"
+        end
+
+        def commit_total
+          %(#{"commit".pluralize count: collector.total_commits} inspected)
+        end
+
+        def issue_total
+          color = collector.errors? ? :red : :yellow
+          colorizer.public_send color, "issue".pluralize(count: collector.total_issues)
+        end
+
+        def warning_total
+          color = collector.warnings? ? :yellow : :green
+          colorizer.public_send color, "warning".pluralize(count: collector.total_warnings)
+        end
+
+        def error_total
+          color = collector.errors? ? :red : :green
+          colorizer.public_send color, "error".pluralize(count: collector.total_errors)
+        end
+
+        def issue_totals
+          if collector.issues?
+            "#{issue_total} detected (#{warning_total}, #{error_total})"
+          else
+            colorizer.green("0 issues") + " detected"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Reporters
+      # Reports issues related to a single commit.
+      class Commit
+        def initialize commit:, analyzers: []
+          @commit = commit
+          @analyzers = analyzers.select(&:invalid?)
+        end
+
+        def to_s
+          return "" if analyzers.empty?
+
+          "#{commit.sha} (#{commit.author_name}, #{commit.author_date_relative}): " \
+          "#{commit.subject}\n#{report}\n"
+        end
+
+        private
+
+        attr_reader :commit, :analyzers
+
+        def report
+          analyzers.reduce("") { |report, analyzer| report + Style.new(analyzer).to_s }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Reporters
+      # Reports issues related to an invalid line within the commit body.
+      class Line
+        DEFAULT_INDENT = "    "
+
+        def initialize data = {}
+          @data = data
+        end
+
+        def to_s
+          if content.include? "\n"
+            Lines::Paragraph.new(data).to_s
+          else
+            Lines::Sentence.new(data).to_s
+          end
+        end
+
+        private
+
+        attr_reader :data
+
+        def content
+          data.fetch :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Reporters
+      module Lines
+        class Paragraph
+          def initialize data = {}
+            @data = data
+          end
+
+          def to_s
+            %(#{label}"#{paragraph}"\n)
+          end
+
+          private
+
+          attr_reader :data
+
+          def label
+            "#{Line::DEFAULT_INDENT}Line #{number}: "
+          end
+
+          def paragraph
+            formatted_lines.join "\n"
+          end
+
+          def formatted_lines
+            content.split("\n").map.with_index do |line, index|
+              index.zero? ? line : "#{indent}#{line}"
+            end
+          end
+
+          def indent
+            " " * (label.length + 1)
+          end
+
+          def number
+            data.fetch :number
+          end
+
+          def content
+            data.fetch :content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Reporters
+      module Lines
+        class Sentence
+          def initialize data = {}
+            @data = data
+          end
+
+          def to_s
+            %(#{Line::DEFAULT_INDENT}Line #{number}: "#{content}"\n)
+          end
+
+          private
+
+          attr_reader :data
+
+          def number
+            data.fetch :number
+          end
+
+          def content
+            data.fetch :content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "pastel"
+
+module Git
+  module Lint
+    module Reporters
+      # Reports issues related to a single style.
+      class Style
+        def initialize analyzer, colorizer: Pastel.new
+          @analyzer = analyzer
+          @issue = analyzer.issue
+          @colorizer = colorizer
+        end
+
+        def to_s
+          colorizer.public_send color, message
+        end
+
+        private
+
+        attr_reader :analyzer, :issue, :colorizer
+
+        def message
+          "  #{analyzer.class.label}#{severity_suffix}. " \
+          "#{issue.fetch :hint}\n" \
+          "#{affected_lines}"
+        end
+
+        def severity_suffix
+          case analyzer.severity
+            when :warn then " Warning"
+            when :error then " Error"
+            else ""
+          end
+        end
+
+        def color
+          case analyzer.severity
+            when :warn then :yellow
+            when :error then :red
+            else :white
+          end
+        end
+
+        def affected_lines
+          issue.fetch(:lines, []).reduce("") { |lines, line| lines + Line.new(line).to_s }
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/runner.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    class Runner
+      def initialize configuration:, collector: Collector.new
+        @configuration = configuration
+        @collector = collector
+      end
+
+      def call commits: Branches::Feature.new.commits
+        Array(commits).map { |commit| check commit }
+        collector
+      end
+
+      private
+
+      attr_reader :configuration, :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

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Validators
+      class Capitalization
+        DEFAULT_PATTERN = /\A[[:upper:]].*\Z/.freeze
+
+        def initialize text, delimiter: Name::DEFAULT_DELIMITER, pattern: DEFAULT_PATTERN
+          @text = String text
+          @delimiter = delimiter
+          @pattern = pattern
+        end
+
+        def valid?
+          parts.all? { |name| String(name).match? pattern }
+        end
+
+        private
+
+        attr_reader :text, :delimiter, :pattern
+
+        def parts
+          text.split delimiter
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Git
+  module Lint
+    module Validators
+      class Email
+        def initialize text, pattern: URI::MailTo::EMAIL_REGEXP
+          @text = text
+          @pattern = pattern
+        end
+
+        def valid?
+          String(text).match? pattern
+        end
+
+        private
+
+        attr_reader :text, :pattern
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Validators
+      class Name
+        DEFAULT_DELIMITER = /\s{1}/.freeze
+        DEFAULT_MINIMUM = 2
+
+        def initialize text, delimiter: DEFAULT_DELIMITER, minimum: DEFAULT_MINIMUM
+          @text = text
+          @delimiter = delimiter
+          @minimum = minimum
+        end
+
+        def valid?
+          parts.size >= minimum && parts.all? { |name| !String(name).empty? }
+        end
+
+        private
+
+        attr_reader :text, :delimiter, :minimum
+
+        def parts
+          String(text).split delimiter
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,363 @@
+--- !ruby/object:Gem::Specification
+name: git-lint
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
+  NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
+  xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
+  brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
+  9z0A8KcGhz67SdcoQiD7qiCjL/2NTeWHOzkpPrdGlt088+VerEEGf5I13QCvaftP
+  D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
+  3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
+  AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
+  XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
+  bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
+  Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
+  7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
+  2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
+  QWc=
+  -----END CERTIFICATE-----
+date: 2020-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.5'
+- !ruby/object:Gem::Dependency
+  name: runcom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.83'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.83'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description:
+email:
+- brooke@alchemists.io
+executables:
+- git-lint
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.adoc
+files:
+- LICENSE.adoc
+- README.adoc
+- bin/git-lint
+- lib/git/kit/repo.rb
+- lib/git/lint.rb
+- lib/git/lint/analyzers/abstract.rb
+- lib/git/lint/analyzers/commit_author_capitalization.rb
+- lib/git/lint/analyzers/commit_author_email.rb
+- lib/git/lint/analyzers/commit_author_name.rb
+- 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_subject_length.rb
+- lib/git/lint/analyzers/commit_subject_prefix.rb
+- lib/git/lint/analyzers/commit_subject_suffix.rb
+- lib/git/lint/analyzers/commit_trailer_collaborator_capitalization.rb
+- lib/git/lint/analyzers/commit_trailer_collaborator_duplication.rb
+- 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/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/collector.rb
+- lib/git/lint/commits/saved.rb
+- lib/git/lint/commits/unsaved.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
+metadata:
+  bug_tracker_uri: https://github.com/bkuhlmann/git-lint/issues
+  changelog_uri: https://www.alchemists.io/projects/git-lint/changes.html
+  documentation_uri: https://www.alchemists.io/projects/git-lint
+  source_code_uri: https://github.com/bkuhlmann/git-lint
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A command line interface for linting Git commits.
+test_files: []