gitt 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a1ef8d6a3caccc88017da2ee4a6f639c9851c8dc6c9ee2ef8510fe83130718
-  data.tar.gz: 418b7d5e9ac48472cc9112ec031ab7d10e6ca04e0e1503dbe42b65c9a9c50d6f
+  metadata.gz: '089dc63b1472c88edd6c3135f33cf1888ff2e8c2a2c7653ed274fb76b0758bec'
+  data.tar.gz: 0e0f51674ebb293d760b5a9c7f07716e8a3d277ca25823a24decb7d57239bc86
 SHA512:
-  metadata.gz: 4637a417134c91608e031acc5d10cb4594b3db50253a2b5fdd059ee505dd67f43f34e685f0df656f8fd524449053adebb38e19e882ec1349cc667e2cdf323f53
-  data.tar.gz: a2f821d2cf5757e6c373855c5695452890589e701def37dde9b892958b8f5708c85e4f232bd4ad30f888c9eb4810e0d31307cb193ca7b9c6d08a9866c9c02797
+  metadata.gz: 918247b90b31936c807ad6643c3fdd31f6ba873599c83ce609b64c897ddc9e95bb3b323caa715a03737ed164ceca6be4fc7ea80b56dcb1550425da1d27bc2c29
+  data.tar.gz: 458707c1d8fdfa687ca9d3939da56192199e8bfe3ec050285003062e0a2febb62ee8247dc3668faed3755fc8d89f2b7b74ce99f86bf392b7eaa9f7d9701ebf9a

data/gitt.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "gitt"
-  spec.version = "3.8.0"
+  spec.version = "3.9.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/gitt"

data/lib/gitt/commands/log.rb

@@ -58,8 +58,8 @@ module Gitt
       attr_reader :shell, :key_map, :parser
 
       def pretty_format
-        key_map.reduce("") { |string, (key, value)| string + "<#{key}>#{value}</#{key}>%n" }
-               .then { |structure| %(--pretty=format:"#{structure}") }
+        key_map.reduce(+"") { |format, (key, value)| format << "<#{key}>#{value}</#{key}>%n" }
+               .then { |format| %(--pretty=format:"#{format}") }
       end
 
       def build_records entries
@@ -70,15 +70,16 @@ module Gitt
 
       # :reek:UtilityFunction
       def wrap_statistics entries
-        entries.gsub!(/\d+\sfile.+\d+\s(insertion|deletion).+\n/) do |match|
-          "<statistics>#{match}</statistics><break/>"
+        entries.gsub!(/\n"\n\s\d+\sfile.+\d+\s(insertion|deletion).+\n/) do |match|
+          match.delete_prefix!("\n\"\n").strip!
+          "\n<statistics>#{match}</statistics>\n<break/>"
         end
       end
 
       # :reek:UtilityFunction
       def add_empty_statistics entries
         entries.gsub! %(</trailers>\n"\n"<author_email>),
-                      "</trailers>\n<statistics></statistics>\n<author_email>"
+                      "</trailers>\n<statistics></statistics><break/>\n<author_email>"
       end
     end
   end

data/lib/gitt/commands/tag.rb

@@ -23,6 +23,7 @@ module Gitt
         sha: "%(objectname)",
         signature: "%(contents:signature)",
         subject: "%(subject)",
+        trailers: "%(trailers)",
         version: "%(refname)"
       }.freeze
 
@@ -88,7 +89,7 @@ module Gitt
       attr_reader :shell, :key_map, :parser
 
       def pretty_format
-        key_map.reduce("") { |content, (key, value)| content + "<#{key}>#{value}</#{key}>%n" }
+        key_map.reduce(+"") { |format, (key, value)| format << "<#{key}>#{value}</#{key}>%n" }
                .then { |format| %(--format="#{format}") }
       end
 

data/lib/gitt/models/commit.rb

@@ -32,30 +32,13 @@ module Gitt
       :trailers
     ) do
       include Directable
+      include Trailable
       include Dry::Monads[:result]
 
       def initialize(**)
         super
         freeze
       end
-
-      def find_trailer key
-        trailers.find { |trailer| trailer.key == key }
-                .then do |trailer|
-                  return Success trailer if trailer
-
-                  Failure "Unable to find trailer for key: #{key.inspect}."
-                end
-      end
-
-      def find_trailers key
-        trailers.select { |trailer| trailer.key == key }
-                .then { |trailers| Success trailers }
-      end
-
-      def trailer_value_for(key) = find_trailer(key).fmap(&:value)
-
-      def trailer_values_for(key) = find_trailers(key).fmap { |trailers| trailers.map(&:value) }
     end
   end
 end

data/lib/gitt/models/tag.rb

@@ -16,8 +16,11 @@ module Gitt
       :sha,
       :signature,
       :subject,
+      :trailers,
       :version
     ) do
+      include Trailable
+
       def initialize(**)
         super
         freeze

data/lib/gitt/parsers/commit.rb

@@ -18,7 +18,7 @@ module Gitt
 
       def call content
         attributer.call(content)
-                  .then { |attributes| process attributes }
+                  .then { |attributes| mutate attributes }
                   .then { |attributes| model[**attributes] }
       end
 
@@ -27,7 +27,7 @@ module Gitt
       attr_reader :attributer, :sanitizers, :model
 
       # :reek:TooManyStatements
-      def process attributes
+      def mutate attributes
         body, trailers = attributes.values_at :body, :trailers
         body = scissors_sanitizer.call body
 

data/lib/gitt/parsers/tag.rb

@@ -16,13 +16,16 @@ module Gitt
         @model = model
       end
 
+      # :reek:TooManyStatements
       def call content
         attributes = attributer.call content
-        attributes.transform_with! author_email: email_sanitizer,
-                                   authored_at: date_sanitizer,
-                                   committed_at: date_sanitizer,
-                                   committer_email: email_sanitizer,
-                                   version: version_serializer
+        body, trailers = attributes.values_at :body, :trailers
+        sanitize attributes
+
+        attributes[:body] = (
+          trailers ? body.sub(/\n??#{Regexp.escape trailers}\n??/, "") : body
+        ).to_s.chomp
+
         model[**attributes]
       end
 
@@ -30,10 +33,21 @@ module Gitt
 
       attr_reader :attributer, :sanitizers, :model
 
+      def sanitize attributes
+        attributes.transform_with! author_email: email_sanitizer,
+                                   authored_at: date_sanitizer,
+                                   committed_at: date_sanitizer,
+                                   committer_email: email_sanitizer,
+                                   trailers: trailers_sanitizer,
+                                   version: version_serializer
+      end
+
       def date_sanitizer = sanitizers.fetch :date
 
       def email_sanitizer = sanitizers.fetch :email
 
+      def trailers_sanitizer = sanitizers.fetch :trailers
+
       def version_serializer = sanitizers.fetch :version
     end
   end

data/lib/gitt/repository.rb

@@ -4,7 +4,6 @@ require "core"
 
 module Gitt
   # Primary object/wrapper for processing all Git related commands.
-  # :reek:TooManyMethods
   class Repository
     COMMANDS = {
       branch: Commands::Branch,
@@ -34,6 +33,11 @@ module Gitt
 
     def get(...) = commands.fetch(:config).get(...)
 
+    def inspect
+      "#<#{self.class}:#{object_id} @shell=#{shell.inspect} " \
+      "@commands=#{commands.values.map(&:class).inspect}>"
+    end
+
     def log(...) = commands.fetch(__method__).call(...)
 
     def origin? = commands.fetch(:config).origin?

data/lib/gitt/sanitizers/container.rb

@@ -6,7 +6,7 @@ module Gitt
       date: Date,
       email: Email,
       lines: Lines,
-      paragraphs: Paragraphs,
+      paragraphs: Paragraphs.new,
       scissors: Scissors,
       signature: Signature,
       statistic: Statistic.new,

data/lib/gitt/sanitizers/paragraphs.rb

@@ -1,9 +1,53 @@
 # frozen_string_literal: true
 
 require "core"
+require "refinements/array"
+require "strscan"
 
 module Gitt
   module Sanitizers
-    Paragraphs = -> text { text ? text.split("\n\n").map(&:chomp) : Core::EMPTY_ARRAY }
+    # Detects and parses paragraphs (including code blocks).
+    class Paragraphs
+      using Refinements::Array
+
+      PATTERN = /
+        (              # Condition start.
+        (?:\..*?\n)?   # Optional ASCII Doc label.
+        (?:\[.*\]\n)?  # Optional ASCII Doc directive.
+        [-_=+\.\*]{4}  # ASCII Doc block start.
+        [\s\S]*?       # Lazy block content of any character.
+        [-_=+\.\*]{4}  # ASCII Doc block end.
+        |              # Or.
+        ```            # Markdown start.
+        [\s\S]*?       # Lazy block content of any character.
+        ```            # Markdown end.
+        )              # Condition end.
+      /mx
+
+      def initialize pattern: PATTERN, client: StringScanner
+        @pattern = pattern
+        @client = client
+      end
+
+      def call(text) = scan(client.new(text.to_s))
+
+      private
+
+      attr_reader :pattern, :client
+
+      # :reek:FeatureEnvy
+      def scan scanner, collection = []
+        until scanner.eos?
+          match = scanner.scan_until pattern
+
+          break collection << scanner.string[scanner.rest].tap(&:strip!).split("\n\n") unless match
+
+          collection << scanner.pre_match.strip
+          collection << scanner.captures
+        end
+
+        collection.tap(&:flatten!).tap(&:compress!)
+      end
+    end
   end
 end

data/lib/gitt/sanitizers/statistic.rb

@@ -12,24 +12,25 @@ module Gitt
         (?<kind>file|insertion|deletion)  # Kind capture group.
       /x
 
+      def self.update_stats attributes, kind, total
+        case kind
+          when "file" then attributes[:files_changed] = total
+          when "insertion" then attributes[:insertions] = total
+          when "deletion" then attributes[:deletions] = total
+          else fail StandardError, "Invalid kind: #{kind.inspect}."
+        end
+      end
+
       def initialize empty: EMPTY, pattern: PATTERN
         @empty = empty
         @pattern = pattern
       end
 
-      # :reek:TooManyStatements
       def call text
         return empty unless text
 
-        text.scan(pattern).each.with_object(empty.dup) do |(number, kind), stats|
-          total = number.to_i
-
-          case kind
-            when "file" then stats[:files_changed] = total
-            when "insertion" then stats[:insertions] = total
-            when "deletion" then stats[:deletions] = total
-            # :nocov:
-          end
+        text.scan(pattern).each.with_object(empty.dup) do |(number, kind), aggregate|
+          self.class.update_stats aggregate, kind, number.to_i
         end
       end
 

data/lib/gitt/trailable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Gitt
+  # Provides shared behavior for objects that have trailers.
+  module Trailable
+    def find_trailer key
+      trailers.find { |trailer| trailer.key == key }
+              .then do |trailer|
+                return Success trailer if trailer
+
+                Failure "Unable to find trailer for key: #{key.inspect}."
+              end
+    end
+
+    def find_trailers key
+      trailers.select { |trailer| trailer.key == key }
+              .then { |trailers| Success trailers }
+    end
+
+    def trailer_value_for(key) = find_trailer(key).fmap(&:value)
+
+    def trailer_values_for(key) = find_trailers(key).fmap { |trailers| trailers.map(&:value) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitt
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core
@@ -135,6 +135,7 @@ files:
 - lib/gitt/sanitizers/trailers.rb
 - lib/gitt/sanitizers/version.rb
 - lib/gitt/shell.rb
+- lib/gitt/trailable.rb
 homepage: https://alchemists.io/projects/gitt
 licenses:
 - Hippocratic-2.1