git-lint 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 217b7749f87f9d937c13906b0dc6433337e3bab50dce59ca7e8c83461bf36a76
-  data.tar.gz: 92c9afbc9da13b851bc167e371cabe36cf4b462694468c01d16c874b7f56bee0
+  metadata.gz: 0f890a2d629a880fe71b362f043772b891e8bb6610eeafac4ce7d68f20ccc636
+  data.tar.gz: d8e5e33287b6e4be9787a7d1c9ee8d4bc45a7df5de993b52b732b2de56fa1981
 SHA512:
-  metadata.gz: 7a43fffa66b31e106709d7da90c38c1fe291ccf2546d07b110f820c57d9ff5b38fd689e464ec2868644068ee07ef0e39506cb78c948c3f1f0291cb4686c64190
-  data.tar.gz: aeadbaf169dcb7f21df18c4737a405df4cb1e8ebdec17dc8565ce94906421c042b591eaa16ae999832611fbb34bfabe038fe826ba439e443df347a47a2c211c4
+  metadata.gz: a019791e28fe05d1bf198d60c5b8516481e68e1658dc1749d3b4a8c355d128c1f64f472d56b76c57305e2f0d58a2cf2ca6af86fe6fbd978f020d6bc60b2233b4
+  data.tar.gz: a10d7d047daff9d31d88fd53a435f12445e59013bc16df30ad877d7738d12ec45acead33e916c7dd122e527b48faea066a332fbe43b454e2ffec76602089e1b0

data/LICENSE.adoc

@@ -150,7 +150,7 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright link:https://www.alchemists.io[Alchemists].
+Copyright 2020 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
 compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]

data/README.adoc

@@ -8,6 +8,8 @@
 
 [link=http://badge.fury.io/rb/git-lint]
 image::https://badge.fury.io/rb/git-lint.svg[Gem Version]
+[link=https://www.alchemists.io/projects/code_quality]
+image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
 [link=https://circleci.com/gh/bkuhlmann/git-lint]
 image::https://circleci.com/gh/bkuhlmann/git-lint.svg?style=svg[Circle CI Status]
 
@@ -45,8 +47,6 @@ image::https://www.alchemists.io/images/screencasts/git_lint/cover.svg[Screencas
 
 == Setup
 
-=== Production
-
 To install, run:
 
 [source,bash]
@@ -54,24 +54,6 @@ To install, run:
 gem install git-lint
 ----
 
-=== Development
-
-To contribute, run:
-
-[source,bash]
-----
-git clone https://github.com/bkuhlmann/git-lint.git
-cd git-lint
-bin/setup
-----
-
-You can also use the IRB console for direct access to all objects:
-
-[source,bash]
-----
-bin/console
-----
-
 == Usage
 
 === Command Line Interface (CLI)
@@ -403,6 +385,36 @@ from `master`.
 Detection and configuration happens automatically by checking the `CIRCLECI` environment variable.
 No additional setup required!
 
+==== link:https://docs.github.com/en/free-pro-team@latest/actions[GitHub Actions]
+
+Detection happens automatically by checking the `GITHUB_ACTIONS` environment variable as supplied by
+the GitHub environment. The only configuration required is to add a `.github/workflows/git_lint.yml`
+to your repository with the following contents:
+
+[source,yaml]
+----
+name: Git Lint
+
+on: pull_request
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: '0'
+          ref: ${{github.head_ref}}
+      - name: Install
+        run: gem install git-lint
+      - name: Analyze
+        run: git-lint --analyze
+----
+
+The above will ensure Git Lint runs as an additional check on each Pull Request.
+
 ==== link:https://www.netlify.com[Netlify CI]
 
 Detection and configuration happens automatically by checking the `NETLIFY` environment variable. No
@@ -903,14 +915,19 @@ configuration disabled.
 * Use small, atomic commits:
 ** Easier to review and provide feedback.
 ** Easier to review implementation and corresponding tests.
-** Easier to document with detailed subject messages (especially when grouped together in a pull
-   request).
+** Easier to document with detailed subjects (especially when grouped together in a pull request).
 ** Easier to reword, edit, squash, fix, or drop when interactively rebasing.
 ** Easier to combine together versus tearing apart a larger commit into smaller commits.
 * Use logically ordered commits:
 ** Each commit should tell a story and be a logical building block to the next commit.
+** Each commit should, ideally, be the implementation plus corresponding test. Avoid committing
+   changes that are a jumble of mixed ideas as they are hard to decipher and a huge insult not only
+   to the reviewer but your future self.
 ** Each commit, when reviewed in order, should be able to explain _how_ the feature or bug fix was
    completed and implemented properly.
+* Keep refactored code separate from behavioral changes. This makes the review process easier
+  because you don't have to sift through all the line and format changes to figure out what is new
+  or changed.
 
 === Branches
 
@@ -944,8 +961,11 @@ configuration disabled.
 
 === Code Reviews
 
-There are two objectives each code review should achieve:
+There are three main objectives each code review should achieve:
 
+. *Joy* - The experience of working with you, receiving feedback, giving feedback, and demonstrating
+   a level of care influences others and encourages a collaborative environment that is fun to work
+   in. Use this time to build and reinforce trust amongst your fellow colleagues.
 . *Quality*: Ensures changes are of highest quality that adhere to team standards while enhancing
    the customer experience and not disrupting their workflow.
 . *Education*: Provides a chance for everyone on the team to learn more about the architecture,
@@ -955,13 +975,22 @@ There are two objectives each code review should achieve:
 In addition to the objectives above, the following guidelines are worth following:
 
 * Keep code reviews short and easy to review:
+** Review your own code first before submitting to others. By ensuring your are confident in the
+   overall implementation and the commits in terms of commit messages and implementation details,
+   you'll encourage higher quality feedback and show appreciation for the reviewer's time.
 ** Provide a high level overview that answers _why_ the code review is necessary.
-** Provide a link to the issue/task that prompted the code review (if any).
+** Provide a link to the issue that prompted the code review (if any) and any additional details
+   worth highlighting to guide the reviewer through the process.
 ** Provide screenshots/screencasts if possible.
-** Ensure commits within the code review are related to the purpose of the code review.
-** Prefer code reviews at about 250 lines in order to keep the quality of the code review and defect
-   detection high.
-** Avoid working on a large issue without getting feedback first in order to not overwhelm/surprise
+** Provide any ancillary notes or points of interest worth highlighting for the reviewer.
+** Ensure commits within the code review are related to the purpose of the code review and avoid
+   mixing in changes that are ancillary to the primary objective of the code view. If you do have
+   changes outside of the scope of the current code review, open those changes up as a separate code
+   review instead.
+** Prefer code reviews at about 300 lines in order to keep the quality of the code review and defect
+   detection high. This also shows you value the reviewers time and attention away from their own
+   work.
+** Avoid working on a large issues without first getting feedback in order to not overwhelm/surprise
    the maintainers. More discussion up front will help ensure your work has a faster chance of
    acceptance.
 * Review and rebase code reviews quickly:
@@ -1001,9 +1030,14 @@ In addition to the objectives above, the following guidelines are worth followin
     always meant as a response to helpful feedback.
 ** ✅ (`:white_check_mark:`) - Signifies code review approval. The author can
     rebase onto `master` and delete the feature branch at this point.
+* Use all feedback as a chance to learn, teach, strenghen the bond of trust between you and your
+  fellow colleagues, and avoid being cut by
+  link:https://fs.blog/2017/04/mental-model-hanlons-razor[Hanlon's Razor].
+* Use automation to ensure code reviews are consistent, of high quality, and swift to resolve. Each
+  code review can be an opportunity to identify and automate the process further.
 * Use face-to-face communication if a code review's written discussion gets lengthy/noisy.
-* Create new tasks/actions if additional features are discovered during a code review to avoid
-  delaying code review acceptance. Return to the code review once tasks have been logged.
+* Create follow-up actions if additional features are discovered during a code review to avoid
+  delaying code review acceptance. Return to the code review once the new actions have been logged.
 * The author, not the reviewer, should rebase the feature branch onto `master` upon approval.
 * Avoid reviewing your own code review before rebasing onto `master`. Have another pair of eyes
   review your code first.
@@ -1046,6 +1080,24 @@ image::https://www.alchemists.io/images/projects/git-lint/screenshots/github-set
 
 Applying the above changes will help maintain a clean Git history.
 
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/git-lint.git
+cd git-lint
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
 == Tests
 
 To test, run:

data/lib/git/lint.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
+require "git_plus"
 require "git/lint/identity"
-require "git/kit/repo"
 require "git/lint/refinements/strings"
 require "git/lint/errors/base"
 require "git/lint/errors/severity"
@@ -11,10 +11,9 @@ require "git/lint/validators/email"
 require "git/lint/validators/name"
 require "git/lint/validators/capitalization"
 require "git/lint/parsers/trailers/collaborator"
-require "git/lint/commits/saved"
-require "git/lint/commits/unsaved"
 require "git/lint/branches/environments/local"
 require "git/lint/branches/environments/circle_ci"
+require "git/lint/branches/environments/git_hub_action"
 require "git/lint/branches/environments/netlify_ci"
 require "git/lint/branches/environments/travis_ci"
 require "git/lint/branches/feature"

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

@@ -91,10 +91,10 @@ module Git
           end
         end
 
-        def affected_commit_trailer_lines
-          commit.trailer_lines
+        def affected_commit_trailers
+          commit.trailers
                 .each.with_object([])
-                .with_index(commit.trailer_index) do |(line, lines), index|
+                .with_index(commit.trailers_index) do |(line, lines), index|
                   yield if block_given?
                   lines << self.class.build_issue_line(index, line) if invalid_line? line
                 end

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

@@ -32,7 +32,7 @@ module Git
         attr_reader :validator
 
         def minimum
-          settings.fetch :minimum
+          settings.fetch __method__
         end
       end
     end

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

@@ -32,7 +32,11 @@ module Git
         end
 
         def invalid_line? line
-          line.match?(/\A\s*#{Regexp.union filter_list.to_regexp}(?!\s).+\Z/)
+          line.match?(/\A\s*#{pattern}(?!(#{pattern}|\s)).+\Z/)
+        end
+
+        def pattern
+          Regexp.union filter_list.to_regexp
         end
       end
     end

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

@@ -12,11 +12,12 @@ module Git
         end
 
         def valid?
-          raw_body = commit.raw_body
-          subject, body = raw_body.split "\n", 2
+          message = commit.message
+          subject, body = message.split "\n", 2
+
           return true if !String(subject).empty? && String(body).strip.empty?
 
-          raw_body.match?(/\A.+\n\n.+/)
+          message.match?(/\A.+(\n\n|\#).+/m)
         end
 
         def issue

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

@@ -34,7 +34,7 @@ module Git
         private
 
         def fixup_or_squash?
-          commit.is_a?(Git::Lint::Commits::Unsaved) && (commit.fixup? || commit.squash?)
+          commit.fixup? || commit.squash?
         end
       end
     end

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

@@ -23,7 +23,7 @@ module Git
         # rubocop:enable Metrics/ParameterLists
 
         def valid?
-          affected_commit_trailer_lines.empty?
+          affected_commit_trailers.empty?
         end
 
         def issue
@@ -31,7 +31,7 @@ module Git
 
           {
             hint: "Name must be capitalized.",
-            lines: affected_commit_trailer_lines
+            lines: affected_commit_trailers
           }
         end
 

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

@@ -20,7 +20,7 @@ module Git
         end
 
         def valid?
-          affected_commit_trailer_lines.empty?
+          affected_commit_trailers.empty?
         end
 
         def issue
@@ -28,7 +28,7 @@ module Git
 
           {
             hint: "Avoid duplication.",
-            lines: affected_commit_trailer_lines
+            lines: affected_commit_trailers
           }
         end
 
@@ -47,7 +47,7 @@ module Git
           zeros = Hash.new { |new_hash, missing_key| new_hash[missing_key] = 0 }
 
           zeros.tap do |collection|
-            commit.trailer_lines.each { |line| collection[line] += 1 if parser.new(line).match? }
+            commit.trailers.each { |line| collection[line] += 1 if parser.new(line).match? }
           end
         end
       end

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

@@ -24,7 +24,7 @@ module Git
         # rubocop:enable Metrics/ParameterLists
 
         def valid?
-          affected_commit_trailer_lines.empty?
+          affected_commit_trailers.empty?
         end
 
         def issue
@@ -32,7 +32,7 @@ module Git
 
           {
             hint: %(Email must follow name and use format: "<name@server.domain>".),
-            lines: affected_commit_trailer_lines
+            lines: affected_commit_trailers
           }
         end
 

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

@@ -20,7 +20,7 @@ module Git
         end
 
         def valid?
-          affected_commit_trailer_lines.empty?
+          affected_commit_trailers.empty?
         end
 
         def issue
@@ -28,7 +28,7 @@ module Git
 
           {
             hint: "Use format: #{filter_list.to_hint}.",
-            lines: affected_commit_trailer_lines
+            lines: affected_commit_trailers
           }
         end
 

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

@@ -25,7 +25,7 @@ module Git
         # rubocop:enable Metrics/ParameterLists
 
         def valid?
-          affected_commit_trailer_lines.empty?
+          affected_commit_trailers.empty?
         end
 
         def issue
@@ -33,7 +33,7 @@ module Git
 
           {
             hint: "Name must follow key and consist of #{minimum} parts (minimum).",
-            lines: affected_commit_trailer_lines
+            lines: affected_commit_trailers
           }
         end
 

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

@@ -6,21 +6,21 @@ module Git
       module Environments
         # Provides Circle CI build environment feature branch information.
         class CircleCI
-          def initialize repo: Git::Kit::Repo.new
-            @repo = repo
+          def initialize repository: GitPlus::Repository.new
+            @repository = repository
           end
 
           def name
-            "origin/#{repo.branch_name}"
+            "origin/#{repository.branch_name}"
           end
 
-          def shas
-            repo.shas start: "origin/master", finish: name
+          def commits
+            repository.commits "origin/master..#{name}"
           end
 
           private
 
-          attr_reader :repo
+          attr_reader :repository
         end
       end
     end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Branches
+      module Environments
+        # Provides GitHub Action build environment feature branch information.
+        class GitHubAction
+          def initialize repository: GitPlus::Repository.new
+            @repository = repository
+          end
+
+          def name
+            "origin/#{repository.branch_name}"
+          end
+
+          def commits
+            repository.commits "origin/master..#{name}"
+          end
+
+          private
+
+          attr_reader :repository
+        end
+      end
+    end
+  end
+end