gitt 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10109921053ef53c8865eac269ab03709ff3d04a309df4424812b1d21fa0264a
-  data.tar.gz: 98ee929f656a98a0ff42d2baa7e2f195d91f4a283675ae9aa8225fc4d11453e5
+  metadata.gz: 10c0a2508e0246a09377b0964f6cd839932090c7c1079773f653a18411b79b86
+  data.tar.gz: 43c3cfb91b3083424254794bdca13cf9971a07a8463b73fa8142b4a80c86ab95
 SHA512:
-  metadata.gz: 8d20d960474f171061be96e2b3a64a3a84ea1ffc0e83eac1f7b5f2cf74633aa4869be6bdae9fae10175d3577a09bb6a536ed6aab4e75d910716c4da2408cecca
-  data.tar.gz: b57f2c27d7bb8d42b835c374ac604f9d8561c903e6ac8d6cf9c3bab13c1769e73371e5a485b063246f877055d2e459a7e2d01f796329cb6c873c9344b841d1e9
+  metadata.gz: 9cfa2bf0a28272d3538f30890abfb3e57e3734b53f9c5dedbdedc98954424e0cc375ff67b1b9814617ac70c5b86d75a3f0706d5aee66f45c868bf53d158718ea
+  data.tar.gz: 9b7cea5e367c368108cda7ed705d0e020520b71da9f85b6139238853b06c30bb80a5a79d4aba8ed033a4c66f331cb14781d5ffb960d40c35d0738d43ac0ec40f

data/README.adoc

@@ -193,57 +193,88 @@ In order to have access to rich data from the Git client, there are several mode
 
 ==== Commit
 
-An instance of `Gitt::Models::Commit` is what is answered back to when using `Gitt::Repository` via the `#commits` or `#uncommitted` methods. In each case, you'll either get an array of records, a single record, or a failure depending on the result. Here's an example of a single record:
+An instance of `Gitt::Models::Commit` is what is answered back to when using `Gitt` via the `#commits` or `#uncommitted` methods. In each case, you'll either get an array of records, a single record, or a failure depending on the result. Here's an example of a single record:
 
 [source,ruby]
 ----
-# #<struct Gitt::Models::Commit
-#  author_date_relative="2 days ago",
-#  author_email="demo@example.com",
-#  author_name="Demo User",
-#  body="Necessary to explain recent changes.\n",
-#  body_lines=["Necessary to explain recent changes."],
-#  body_paragraphs=["Necessary to explain recent changes."],
-#  message="Updated documentation with new functionality\n\nNecessary to explain recent changes.\n",
-#  sha="5e21a9866827bf5c68bd445ea01b3837a3936b45",
-#  subject="Updated documentation with new functionality",
-#  trailers=[],
-#  trailers_index=nil>
+# #<Struct:Gitt::Models::Commit:0x0001d4e8
+#   author_email = "demo@example.io",
+#   author_name = "Brooke Kuhlmann",
+#   authored_at = "1720130186",
+#   authored_relative_at = "33 seconds ago",
+#   body = "",
+#   body_lines = [],
+#   body_paragraphs = [],
+#   committed_at = "1720130186",
+#   committed_relative_at = "33 seconds ago",
+#   committer_email = "demo@example.io",
+#   committer_name = "Brooke Kuhlmann",
+#   deletions = 3,
+#   encoding = "",
+#   files_changed = 3,
+#   fingerprint = "F2BC49BC4FFB9A48",
+#   fingerprint_key = "D1488588D2DEDF73E62F07A1F2BC49BC4FFB9A48",
+#   insertions = 9,
+#   lines = [
+#     "Added version release notes"
+#   ],
+#   notes = "",
+#   raw = "Added version release notes\n",
+#   sha = "49e033d7020068630fd3823a29c2eb8a1ef01770",
+#   signature = "Good",
+#   subject = "Added version release notes",
+#   trailers = []
+# >
 ----
 
 You get a {struct_link} with the following attributes:
 
-* `author_date_relative`: Stores the relative date of when the commit was made.
 * `author_email`: Stores the author email.
 * `author_name`: Stores the author name.
+* `authored_at`: Stores local time of when the commit was made.
+* `author_relative_at`: Stores the relative time of when the commit was made.
 * `body`: Stores the commit body which excludes the subject and leading space.
 * `body_lines`: Stores each line of the body in an array.
 * `body_paragraphs`: Stores each paragraph of the body as an array (i.e. broken by double new lines).
-* `message`: Stores the entire, raw, commit message (i.e. subject and body).
+* `committed_at`: Stores local time of when the commit was updated.
+* `committed_relative_at`: Stores the relative time of when the commit was updated.
+* `committer_email`: Stores the committer email.
+* `committer_name`: Stores the committer name.
+* `deletions`: Stores number of deleted lines.
+* `encoding`: Stored encoding. Blank if UTF-8 andf filled if otherwise.
+* `files_changed`: Stores number of files changed.
+* `fingerprint`: Stores the fingerprint used when creating a secure commit.
+* `fingerprint_key`: Stores the fingerprint key used when creating a secure commit.
+* `insertions`: Stores the number inserted lines.
+* `lines`: Stores each line of the commit message as an array.
+* `notes`: Stores commit note (if any.
+* `raw`: Stores the raw commit message (subject + message).
 * `sha`: Stores the commit SHA.
+* `signature`: Stores the signature type and level of security.
 * `subject`: Stores the commit subject.
 * `trailers`: Stores any commit trailers as an array of `Gitt::Models::Trailer` records.
-* `trailers_index`: Stores the starting index of trailers within the commit message.
 
 ==== Tag
 
-An instance of `Gitt::Models::Tag` is what is answered back to when using `Gitt::Repository` via the `#tag_parse` method. Here's an example:
+An instance of `Gitt::Models::Tag` is what is answered back to when using `Gitt` via the `#tags` method, for example. Here's an example:
 
 [source,ruby]
 ----
-# #<struct Gitt::Models::Tag
-#  author_email="demo@example.com",
-#  author_name="Brooke Kuhlmann",
-#  authored_at="1671892451",
-#  authored_relative_at="1 year ago",
-#  body="A demo body.",
-#  committed_at="1671997684",
-#  committed_relative_at="1 year ago",
-#  committer_email="demo@example.com",
-#  committer_name="Brooke Kuhlmann",
-#  sha="662f32b2846c7bd4f153560478f035197f5279d5",
-#  subject="Version 1.0.0",
-#  version="1.0.0">
+#<Struct:Gitt::Models::Tag:0x000314c0
+  author_email = "demo@example.io",
+  author_name = "Brooke Kuhlmann",
+  authored_at = "1671892451",
+  authored_relative_at = "1 year, 6 months ago",
+  body = "Example.\n\n-----BEGIN PGP SIGNATURE-----\n\niQIzBAABCAAdFiEE0UiFiNLe33PmLweh8rxJvE/Nii2FB9wo6oc\nhVJ+beT6vnmZHKsvrqkpb1BAE10/pS8RkXjjaBmYaUIBYmG6RQ/+yUvyNjldWLuO\nBkYyUawSBT94V/ve/oYxTdylCkWj1TGYG+iP4NNnhz64rMikckY=\n=ptac\n-----END PGP SIGNATURE-----\n",
+  committed_at = "1671997684",
+  committed_relative_at = "1 year, 6 months ago",
+  committer_email = "demo@example.io",
+  committer_name = "Brooke Kuhlmann",
+  sha = "662f32b2846c7bd4f153560478f035197f5279d5",
+  signature = "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABCAAdFiEE0UiFiNLe33PmLweh8rxJvE/Nii2FB9wo6oc\nhVJ+beT6vnmZHKsvrqkpb1BAE10/pS8RkXjjaBmYaUIBYmG6RQ/+yUvyNjldWLuO\nBkYyUawSBT94V/ve/oYxTdylCkWj1TGYG+iP4NNnhz64rMikckY=\n=ptac\n-----END PGP SIGNATURE-----\n",
+  subject = "Version 1.0.0",
+  version = "1.0.0"
+>
 ----
 
 You get a {struct_link} with the following attributes:
@@ -253,11 +284,12 @@ You get a {struct_link} with the following attributes:
 *  `authored_at`: Stores author creation date.
 *  `authored_relative_at`: Stores author creation date relative to current time.
 *  `body`: Stores body of tag which can be sentences, multiple paragraphs, and/or signature information.
-*  `committer_email`: Stores committer email.
-*  `committer_name`: Store committer name.
 *  `committed_at`: Stores committer creation date.
 *  `committed_relative_at`: Stores committer creation date relative to current time.
+*  `committer_email`: Stores committer email.
+*  `committer_name`: Store committer name.
 *  `sha`: Stores the commit SHA for which this tag labels
+*  `signature`: Stores the signature when the tag was securely created.
 *  `subject`: Stores the subject.
 *  `version`: Stores the version.
 

data/gitt.gemspec

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

data/lib/gitt/commands/log.rb

@@ -23,6 +23,8 @@ module Gitt
         raw: "%B",
         sha: "%H",
         signature: "%G?",
+        fingerprint: "%GK",
+        fingerprint_key: "%GF",
         subject: "%s",
         trailers: "%(trailers)"
       }.freeze

data/lib/gitt/commands/tag.rb

@@ -15,12 +15,13 @@ module Gitt
         author_name: "%(*authorname)",
         authored_at: "%(*authordate:raw)",
         authored_relative_at: "%(*authordate:relative)",
+        body: "%(body)",
         committed_at: "%(*committerdate:raw)",
         committed_relative_at: "%(*committerdate:relative)",
         committer_email: "%(*committeremail)",
         committer_name: "%(*committername)",
-        body: "%(body)",
         sha: "%(objectname)",
+        signature: "%(contents:signature)",
         subject: "%(subject)",
         version: "%(refname)"
       }.freeze
@@ -37,7 +38,7 @@ module Gitt
         return Failure "Unable to create Git tag without version." unless version
         return Failure "Tag exists: #{version}." if exist? version
 
-        Tempfile.open "git_plus" do |file|
+        Tempfile.open "gitt" do |file|
           file.write body
           write version, file.tap(&:rewind), *flags
         end

data/lib/gitt/models/commit.rb

@@ -20,6 +20,8 @@ module Gitt
       :deletions,
       :encoding,
       :files_changed,
+      :fingerprint,
+      :fingerprint_key,
       :insertions,
       :lines,
       :notes,

data/lib/gitt/models/tag.rb

@@ -14,6 +14,7 @@ module Gitt
       :committer_email,
       :committer_name,
       :sha,
+      :signature,
       :subject,
       :version
     ) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitt
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-07-01 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core