git-lint 1.0.0

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitTrailerCollaboratorDuplication < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error
+          }
+        end
+
+        def initialize commit:,
+                       settings: self.class.defaults,
+                       parser: Parsers::Trailers::Collaborator
+          super commit: commit, settings: settings
+          @parser = parser
+          @tally = build_tally
+        end
+
+        def valid?
+          affected_commit_trailer_lines.empty?
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Avoid duplication.",
+            lines: affected_commit_trailer_lines
+          }
+        end
+
+        protected
+
+        def invalid_line? line
+          collaborator = parser.new line
+          collaborator.match? && tally[line] != 1
+        end
+
+        private
+
+        attr_reader :parser, :tally
+
+        def build_tally
+          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? }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitTrailerCollaboratorEmail < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error
+          }
+        end
+
+        # rubocop:disable Metrics/ParameterLists
+        def initialize commit:,
+                       settings: self.class.defaults,
+                       parser: Parsers::Trailers::Collaborator,
+                       validator: Validators::Email
+
+          super commit: commit, settings: settings
+          @parser = parser
+          @validator = validator
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        def valid?
+          affected_commit_trailer_lines.empty?
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: %(Email must follow name and use format: "<name@server.domain>".),
+            lines: affected_commit_trailer_lines
+          }
+        end
+
+        protected
+
+        def invalid_line? line
+          collaborator = parser.new line
+          collaborator.match? && !validator.new(collaborator.email).valid?
+        end
+
+        private
+
+        attr_reader :parser, :validator
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitTrailerCollaboratorKey < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            includes: ["Co-Authored-By"]
+          }
+        end
+
+        def initialize commit:,
+                       settings: self.class.defaults,
+                       parser: Parsers::Trailers::Collaborator
+          super commit: commit, settings: settings
+          @parser = parser
+        end
+
+        def valid?
+          affected_commit_trailer_lines.empty?
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Use format: #{filter_list.to_hint}.",
+            lines: affected_commit_trailer_lines
+          }
+        end
+
+        protected
+
+        def load_filter_list
+          Kit::FilterList.new settings.fetch :includes
+        end
+
+        def invalid_line? line
+          collaborator = parser.new line
+          key = collaborator.key
+
+          collaborator.match? && !key.empty? && !key.match?(
+            /\A#{Regexp.union filter_list.to_regexp}\Z/
+          )
+        end
+
+        private
+
+        attr_reader :parser
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      class CommitTrailerCollaboratorName < Abstract
+        def self.defaults
+          {
+            enabled: true,
+            severity: :error,
+            minimum: 2
+          }
+        end
+
+        # rubocop:disable Metrics/ParameterLists
+        def initialize commit:,
+                       settings: self.class.defaults,
+                       parser: Parsers::Trailers::Collaborator,
+                       validator: Validators::Name
+
+          super commit: commit, settings: settings
+          @parser = parser
+          @validator = validator
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        def valid?
+          affected_commit_trailer_lines.empty?
+        end
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Name must follow key and consist of #{minimum} parts (minimum).",
+            lines: affected_commit_trailer_lines
+          }
+        end
+
+        protected
+
+        def invalid_line? line
+          collaborator = parser.new line
+          collaborator.match? && !validator.new(collaborator.name.strip, minimum: minimum).valid?
+        end
+
+        private
+
+        attr_reader :parser, :validator
+
+        def minimum
+          settings.fetch :minimum
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Branches
+      module Environments
+        # Provides Circle CI build environment feature branch information.
+        class CircleCI
+          def initialize repo: Git::Kit::Repo.new
+            @repo = repo
+          end
+
+          def name
+            "origin/#{repo.branch_name}"
+          end
+
+          def shas
+            repo.shas start: "origin/master", finish: name
+          end
+
+          private
+
+          attr_reader :repo
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Branches
+      module Environments
+        # Provides local build environment feature branch information.
+        class Local
+          def initialize repo: Git::Kit::Repo.new
+            @repo = repo
+          end
+
+          def name
+            repo.branch_name
+          end
+
+          def shas
+            repo.shas start: "master", finish: name
+          end
+
+          private
+
+          attr_reader :repo
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Git
+  module Lint
+    module Branches
+      module Environments
+        # Provides Netlify CI build environment feature branch information.
+        class NetlifyCI
+          def initialize environment: ENV, repo: Git::Kit::Repo.new, shell: Open3
+            @environment = environment
+            @repo = repo
+            @shell = shell
+          end
+
+          def name
+            environment["HEAD"]
+          end
+
+          def shas
+            shell.capture2e "git remote add -f origin #{environment["REPOSITORY_URL"]}"
+            shell.capture2e "git fetch origin #{name}:#{name}"
+            repo.shas start: "origin/master", finish: "origin/#{name}"
+          end
+
+          private
+
+          attr_reader :environment, :repo, :shell
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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 environment: ENV, repo: Git::Kit::Repo.new, shell: Open3
+            @environment = environment
+            @repo = repo
+            @shell = shell
+          end
+
+          def name
+            pull_request_branch.empty? ? ci_branch : pull_request_branch
+          end
+
+          def shas
+            prepare_project
+            repo.shas start: "origin/master", finish: name
+          end
+
+          private
+
+          attr_reader :environment, :repo, :shell
+
+          def prepare_project
+            slug = pull_request_slug
+
+            unless slug.empty?
+              shell.capture2e "git remote add -f original_branch https://github.com/#{slug}.git"
+              shell.capture2e "git fetch original_branch #{name}:#{name}"
+            end
+
+            shell.capture2e "git remote set-branches --add origin master"
+            shell.capture2e "git fetch"
+          end
+
+          def ci_branch
+            environment["TRAVIS_BRANCH"]
+          end
+
+          def pull_request_branch
+            environment["TRAVIS_PULL_REQUEST_BRANCH"]
+          end
+
+          def pull_request_slug
+            environment["TRAVIS_PULL_REQUEST_SLUG"]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Git
+  module Lint
+    module Branches
+      # Represents a feature branch.
+      class Feature
+        extend Forwardable
+
+        def_delegators :selected_environment, :name, :shas
+
+        def initialize environment: ENV, git_repo: Git::Kit::Repo.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
+
+        def commits
+          shas.map { |sha| Commits::Saved.new sha: sha }
+        end
+
+        private
+
+        attr_reader :current_environment, :selected_environment
+
+        def load_environment
+          if key? "CIRCLECI" then Environments::CircleCI.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[key] == "true"
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/cli.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "thor"
+require "thor/actions"
+require "runcom"
+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
+        collector = analyze_commits options.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 => 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 load_collector shas
+        commits = shas.map { |sha| Commits::Saved.new sha: sha }
+        commits.empty? ? runner.call : runner.call(commits: commits)
+      end
+
+      def analyze_commits shas
+        load_collector(shas).tap do |collector|
+          reporter = Reporters::Branch.new collector: collector
+          say reporter.to_s
+        end
+      end
+
+      def check_commit_message path
+        commit = Commits::Unsaved.new path: path
+        collector = runner.call commits: commit
+        reporter = Reporters::Branch.new collector: collector
+        say reporter.to_s
+        abort if collector.errors?
+      end
+    end
+  end
+end