git-lint 1.0.0

data/lib/git/lint/collector.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "refinements/strings"
+
+module Git
+  module Lint
+    class Collector
+      using Refinements::Strings
+
+      def initialize
+        @collection = Hash.new { |default, missing_id| default[missing_id] = [] }
+      end
+
+      def add analyzer
+        collection[analyzer.commit] << analyzer
+        analyzer
+      end
+
+      def retrieve id
+        collection[id]
+      end
+
+      def empty?
+        collection.empty?
+      end
+
+      def warnings?
+        collection.values.flatten.any?(&:warning?)
+      end
+
+      def errors?
+        collection.values.flatten.any?(&:error?)
+      end
+
+      def issues?
+        collection.values.flatten.any?(&:invalid?)
+      end
+
+      def total_warnings
+        collection.values.flatten.count(&:warning?)
+      end
+
+      def total_errors
+        collection.values.flatten.count(&:error?)
+      end
+
+      def total_issues
+        collection.values.flatten.count(&:invalid?)
+      end
+
+      def total_commits
+        collection.keys.size
+      end
+
+      def to_h
+        collection
+      end
+
+      private
+
+      attr_reader :collection
+    end
+  end
+end

data/lib/git/lint/commits/saved.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Git
+  module Lint
+    module Commits
+      # Represents an existing commit.
+      # :reek:TooManyMethods
+      class Saved
+        using Refinements::Strings
+
+        FORMATS = {
+          sha: "%H",
+          author_name: "%an",
+          author_email: "%ae",
+          author_date_relative: "%ar",
+          subject: "%s",
+          body: "%b",
+          raw_body: "%B",
+          trailers: "%(trailers)"
+        }.freeze
+
+        def self.pattern
+          FORMATS.reduce("") { |pattern, (key, value)| pattern + "<#{key}>#{value}</#{key}>%n" }
+        end
+
+        def initialize sha:, shell: Open3
+          data, status = shell.capture2e show_command(sha)
+          fail Errors::SHA, sha unless status.success?
+
+          @data = data.scrub "?"
+        end
+
+        def == other
+          other.is_a?(self.class) && sha == other.sha
+        end
+        alias eql? ==
+
+        def <=> other
+          sha <=> other.sha
+        end
+
+        def hash
+          sha.hash
+        end
+
+        def body_lines
+          body_without_trailing_spaces
+        end
+
+        def body_paragraphs
+          body_without_trailers.split("\n\n").map(&:chomp).reject { |line| line.start_with? "#" }
+        end
+
+        def trailer_lines
+          trailers.split "\n"
+        end
+
+        def trailer_index
+          body.split("\n").index trailer_lines.first
+        end
+
+        def fixup?
+          subject.fixup?
+        end
+
+        def squash?
+          subject.squash?
+        end
+
+        private
+
+        attr_reader :data
+
+        def show_command sha
+          %(git show --stat --pretty=format:"#{self.class.pattern}" #{sha})
+        end
+
+        def body_without_trailing_spaces
+          body_without_comments.reverse.drop_while(&:empty?).reverse
+        end
+
+        def body_without_comments
+          body_without_trailers.split("\n").reject { |line| line.start_with? "#" }
+        end
+
+        def body_without_trailers
+          body.sub trailers, ""
+        end
+
+        def method_missing name, *arguments, &block
+          return super unless respond_to_missing? name
+
+          String data[%r(<#{name}>(?<content>.*?)</#{name}>)m, :content]
+        end
+
+        def respond_to_missing? name, include_private = false
+          FORMATS.key?(name.to_sym) || super
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/commits/unsaved.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "open3"
+require "securerandom"
+
+module Git
+  module Lint
+    module Commits
+      # Represents a partially formed, unsaved commit.
+      # :reek:TooManyMethods
+      class Unsaved
+        using Refinements::Strings
+
+        SUBJECT_LINE = 1
+        SCISSOR_PATTERN = /\#\s-+\s>8\s-+\n.+/m.freeze
+
+        attr_reader :sha, :raw_body
+
+        def initialize path:, sha: SecureRandom.hex(20), shell: Open3
+          fail Errors::Base, %(Invalid commit message path: "#{path}".) unless File.exist? path
+
+          @path = Pathname path
+          @sha = sha
+          @shell = shell
+          @raw_body = File.read(path).scrub "?"
+        end
+
+        def author_name
+          shell.capture2e("git config --get user.name").then { |result, _status| result.chomp }
+        end
+
+        def author_email
+          shell.capture2e("git config --get user.email").then { |result, _status| result.chomp }
+        end
+
+        def author_date_relative
+          "0 seconds ago"
+        end
+
+        def subject
+          String raw_body.split("\n").first
+        end
+
+        # :reek:FeatureEnvy
+        def body
+          raw_body.sub(SCISSOR_PATTERN, "").split("\n").drop(SUBJECT_LINE).then do |lines|
+            computed_body = lines.join "\n"
+            lines.empty? ? computed_body : "#{computed_body}\n"
+          end
+        end
+
+        def body_lines
+          body_without_trailing_spaces
+        end
+
+        # :reek:FeatureEnvy
+        def body_paragraphs
+          body_without_trailers.split("\n\n")
+                               .map { |line| line.delete_prefix "\n" }
+                               .map(&:chomp)
+                               .reject { |line| line.start_with? "#" }
+        end
+
+        def trailers
+          trailers, status = shell.capture2e %(git interpret-trailers --only-trailers "#{path}")
+
+          return "" unless status.success?
+
+          trailers
+        end
+
+        def trailer_lines
+          trailers.split "\n"
+        end
+
+        def trailer_index
+          body.split("\n").index trailer_lines.first
+        end
+
+        def == other
+          other.is_a?(self.class) && raw_body == other.raw_body
+        end
+        alias eql? ==
+
+        def <=> other
+          raw_body <=> other.raw_body
+        end
+
+        def hash
+          raw_body.hash
+        end
+
+        def fixup?
+          subject.fixup?
+        end
+
+        def squash?
+          subject.squash?
+        end
+
+        private
+
+        attr_reader :path, :shell
+
+        def body_without_trailing_spaces
+          body_without_comments.reverse.drop_while(&:empty?).reverse
+        end
+
+        def body_without_comments
+          body_without_trailers.split("\n").reject { |line| line.start_with? "#" }
+        end
+
+        def body_without_trailers
+          body.sub trailers, ""
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/errors/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Errors
+      # The root class of gem related errors.
+      class Base < StandardError
+        def initialize message = "Invalid #{Identity::LABEL} action."
+          super message
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/errors/severity.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Errors
+      class Severity < Base
+        def initialize level
+          super %(Invalid severity level: #{level}. Use: #{Analyzers::Abstract::LEVELS.join ", "}.)
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/errors/sha.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Errors
+      class SHA < Base
+        def initialize sha
+          super %(Invalid commit SHA: "#{sha}". Unable to obtain commit details.)
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/identity.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    # Gem identity information.
+    module Identity
+      NAME = "git-lint"
+      LABEL = "Git Lint"
+      VERSION = "1.0.0"
+      VERSION_LABEL = "#{LABEL} #{VERSION}"
+    end
+  end
+end

data/lib/git/lint/kit/filter_list.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Kit
+      class FilterList
+        # Represents an regular expression list which may be used as an analyzer setting.
+        def initialize list = []
+          @list = Array list
+        end
+
+        def to_hint
+          to_regexp.map(&:inspect).join ", "
+        end
+
+        def to_regexp
+          list.map { |item| Regexp.new item }
+        end
+
+        def empty?
+          list.empty?
+        end
+
+        private
+
+        attr_reader :list
+      end
+    end
+  end
+end

data/lib/git/lint/parsers/trailers/collaborator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Parsers
+      module Trailers
+        class Collaborator
+          DEFAULT_KEY_PATTERN = /\ACo.*Authored.*By.*\Z/i.freeze
+
+          DEFAULT_MATCH_PATTERN = /
+            (?<key>\A.+)         # Key (anchored to start of line).
+            (?<delimiter>:)      # Key delimiter.
+            (?<key_space>\s?)    # Space delimiter (optional).
+            (?<name>.*?)         # Collaborator name (smallest possible).
+            (?<name_space>\s?)   # Space delimiter (optional).
+            (?<email><.+>)?      # Collaborator email (optional).
+            \Z                   # End of line.
+          /x.freeze
+
+          def initialize text,
+                         key_pattern: DEFAULT_KEY_PATTERN,
+                         match_pattern: DEFAULT_MATCH_PATTERN
+
+            @text = String text
+            @key_pattern = key_pattern
+            @match_pattern = match_pattern
+            @matches = build_matches
+          end
+
+          def key
+            String matches["key"]
+          end
+
+          def name
+            String matches["name"]
+          end
+
+          def email
+            String(matches["email"]).delete_prefix("<").delete_suffix(">")
+          end
+
+          def match?
+            text.match? key_pattern
+          end
+
+          private
+
+          attr_reader :text, :key_pattern, :match_pattern, :matches
+
+          def build_matches
+            text.match(match_pattern).then { |data| data ? data.named_captures : Hash.new }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/rake/setup.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "git/lint/rake/tasks"
+Git::Lint::Rake::Tasks.setup

data/lib/git/lint/rake/tasks.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rake"
+require "git/lint"
+
+module Git
+  module Lint
+    module Rake
+      class Tasks
+        include ::Rake::DSL
+
+        def self.setup
+          new.install
+        end
+
+        def initialize cli: CLI
+          @cli = cli
+        end
+
+        def install
+          desc "Run Git Lint"
+          task :git_lint do
+            cli.start ["--analyze"]
+          end
+        end
+
+        private
+
+        attr_reader :cli
+      end
+    end
+  end
+end