gitt 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67fb49f7ebd543d63e48b98ecb8f029d8e7f0c2b432658a183832601b5cb215e
-  data.tar.gz: 4965f486ade08bbd43377aaac03ecab487dddfaac6fb87d8f371298562e7162a
+  metadata.gz: c62b336c059bf040e1402ebb4f6ac8ebc3bccd73c88374107309aba415f3498d
+  data.tar.gz: 3c10aab04d441c1fe43f9713df9dc8cd7a2c5aa17cd1527bf59565fa38be2978
 SHA512:
-  metadata.gz: d8fbbb7d74f006bb38459dbd2945e5aa7df742940dda9956ea0fe3dac2d264ec4180e082714df8af6e4cfa85bcc92077381e5902893d10b3283cd94b18a7fccf
-  data.tar.gz: 25c53ca9387f38f8a77fd51572174024a0df6272bb8ddffad0686c819defeaca223dec2479a2381e16c92fcc3e23d137793801e55918ef0684fbcb61cbf739e0
+  metadata.gz: 827cc90c8d331de050a46f1f84a702aaf02271b11a587a9eb0bc3fd360bafe88ede43e4300113dfec8aaab7215d1045588a2121c5dc9e8748e34d83ad1acc821
+  data.tar.gz: a440ca56f42594cfa6cd0e4ea82e5c203e99893e9591458a28f34367cc6c595a54c171cb9de9f246fcd4467e6ea146fd55b0194e0035d2ceda61d598e07ed0f2

data/README.adoc

@@ -182,11 +182,11 @@ In order to have access to rich data from the Git client, there are several mode
 
 ==== Commit
 
-An instance of `Gitt::Commits::Model` 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::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:
 
 [source,ruby]
 ----
-# #<struct Gitt::Commits::Model
+# #<struct Gitt::Models::Commit
 #  author_date_relative="2 days ago",
 #  author_email="demo@example.com",
 #  author_name="Demo User",
@@ -211,20 +211,20 @@ You get a {struct_link} with the following attributes:
 * `message`: Stores the entire, raw, commit message (i.e. subject and body).
 * `sha`: Stores the commit SHA.
 * `subject`: Stores the commit subject.
-* `trailers`: Stores any commit trailers as an array of `GtiPlus::Trailers::Model` records.
+* `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::Tags::Model` 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::Repository` via the `#tag_parse` method. Here's an example:
 
 [source,ruby]
 ----
-# #<struct Gitt::Tags::Model
+# #<struct Gitt::Models::Tag
 #  author_date="Tue Dec 29 17:33:01 2020 -0700",
 #  author_email="demo@example.com",
 #  author_name="Demo User",
-#  body="- Added gem skeleton\n- Added RSpec dependnecy",
+#  body="- Added gem skeleton\n- Added RSpec dependency",
 #  sha="d041d07c29f97b5b06b3b2fd05fa1dd018c7da7c",
 #  subject="Version 0.1.0",
 #  version="0.1.0">
@@ -246,7 +246,7 @@ A trailer is nested within a commit record when trailer information exists. Exam
 
 [source,ruby]
 ----
-#<struct Gitt::Commits::Trailers::Model key="Issue", delimiter=":", space=" ", value="123">
+#<struct Gitt::Models::Trailer key="Issue", delimiter=":", space=" ", value="123">
 ----
 
 The attributes break down as follows:
@@ -258,15 +258,15 @@ The attributes break down as follows:
 
 === RSpec
 
-For fans of {rspec_link}, this gem provides shared contexts you can use within your own test suites. These shared contexts are _optional_ and must be manually required to use.
+For fans of {rspec_link}, this gem provides shared contexts you can use within your own test suites. These shared contexts are _optional_, not required for you by default, and must be manually required to use.
 
 ==== Git Commit
 
-Provides a default `git_commit` record of `Gitt::Commits::Model` with minimal information for testing purposes and can be used as follows:
+Provides a default `git_commit` record of `Gitt::Models::Commit` with minimal information for testing purposes and can be used as follows:
 
 [source,ruby]
 ----
-require "gitt/shared_contexts/git_commit"
+require "gitt/rspec/shared_contexts/git_commit"
 
 describe Demo do
   include_context "with Git commit"
@@ -279,8 +279,8 @@ Provides a simple Git repository with a single commit for testing purposes. This
 
 [source,ruby]
 ----
-require "gitt/shared_contexts/git_repo"
-require "refinemenets/pathnames"
+require "gitt/rspec/shared_contexts/git_repo"
+require "refinements/pathnames"
 
 describe Demo do
   include_context "with Git repository"
@@ -299,8 +299,8 @@ Provides a temporary directory (i.e. `tmp/rspec`) for creating directories and o
 
 [source,ruby]
 ----
-require "gitt/shared_contexts/temp_dir"
-require "refinemenets/pathnames"
+require "gitt/rspec/shared_contexts/temp_dir"
+require "refinements/pathnames"
 
 describe Demo do
   include_context "with temporary directory"

data/gitt.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |spec|
   spec.name = "gitt"
-  spec.version = "1.1.3"
+  spec.version = "2.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/gitt"
-  spec.summary = "Provides a monadic Object API wrapper around the Git CLI."
+  spec.summary = "A monadic Object API for the Git CLI."
   spec.license = "Hippocratic-2.1"
 
   spec.metadata = {
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 3.2"
   spec.add_dependency "core", "~> 0.1"
   spec.add_dependency "dry-monads", "~> 1.6"
-  spec.add_dependency "refinements", "~> 10.0"
+  spec.add_dependency "refinements", "~> 11.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

data/lib/gitt/models/commit.rb

@@ -20,10 +20,9 @@ module Gitt
       :sha,
       :signature,
       :subject,
-      :trailers,
-      keyword_init: true
+      :trailers
     ) do
-      def initialize *arguments
+      def initialize(**)
         super
         freeze
       end

data/lib/gitt/models/person.rb

@@ -3,10 +3,10 @@
 module Gitt
   module Models
     # Represents a person within a repository.
-    Person = Struct.new :name, :delimiter, :email, keyword_init: true do
+    Person = Struct.new :name, :delimiter, :email do
       def self.for(string, parser: Parsers::Person.new) = parser.call string
 
-      def initialize *arguments
+      def initialize(**)
         super
         freeze
       end

data/lib/gitt/models/tag.rb

@@ -15,10 +15,9 @@ module Gitt
       :committer_name,
       :sha,
       :subject,
-      :version,
-      keyword_init: true
+      :version
     ) do
-      def initialize *arguments
+      def initialize(**)
         super
         freeze
       end

data/lib/gitt/models/trailer.rb

@@ -6,7 +6,7 @@ module Gitt
     Trailer = Struct.new :key, :delimiter, :space, :value, keyword_init: true do
       def self.for(string, parser: Parsers::Trailer.new) = parser.call string
 
-      def initialize *arguments
+      def initialize(**)
         super
         freeze
       end

data/lib/gitt/parsers/commit.rb

@@ -21,7 +21,7 @@ module Gitt
       def call content
         attributer.call(content)
                   .then { |attributes| process attributes }
-                  .then { |attributes| model[attributes] }
+                  .then { |attributes| model[**attributes] }
       end
 
       private

data/lib/gitt/parsers/person.rb

@@ -17,7 +17,7 @@ module Gitt
         @model = model
       end
 
-      def call(content) = model[content.match(pattern).named_captures]
+      def call(content) = model[**content.match(pattern).named_captures]
 
       private
 

data/lib/gitt/parsers/tag.rb

@@ -23,7 +23,7 @@ module Gitt
                                    committed_at: date_sanitizer,
                                    committer_email: email_sanitizer,
                                    version: -> value { value.delete_prefix "refs/tags/" if value }
-        model[attributes]
+        model[**attributes]
       end
 
       private

data/lib/gitt/parsers/trailer.rb

@@ -20,7 +20,7 @@ module Gitt
       def call content
         content.match(pattern)
                .then { |data| data ? data.named_captures : {} }
-               .then { |attributes| model[attributes] }
+               .then { |attributes| model[**attributes] }
       end
 
       private

data/lib/gitt/{shared_contexts → rspec/shared_contexts}/git_commit.rb

@@ -7,10 +7,13 @@ RSpec.shared_context "with Git commit" do
       author_name: "Test User",
       authored_relative_at: "1 day ago",
       body: "",
+      body_lines: [],
+      body_paragraphs: [],
+      lines: [],
       raw: "",
       sha: "180dec7d8ae8cbe3565a727c63c2111e49e0b737",
       subject: "Added documentation",
-      trailers: ""
+      trailers: []
     ]
   end
 end

data/lib/gitt.rb

@@ -4,7 +4,7 @@ require "zeitwerk"
 
 Zeitwerk::Loader.for_gem.then do |loader|
   loader.inflector.inflect "container" => "CONTAINER"
-  loader.ignore "#{__dir__}/gitt/shared_contexts"
+  loader.ignore "#{__dir__}/gitt/rspec/shared_contexts"
   loader.setup
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitt
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-04-30 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core
@@ -71,14 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,9 @@ files:
 - lib/gitt/parsers/tag.rb
 - lib/gitt/parsers/trailer.rb
 - lib/gitt/repository.rb
+- lib/gitt/rspec/shared_contexts/git_commit.rb
+- lib/gitt/rspec/shared_contexts/git_repo.rb
+- lib/gitt/rspec/shared_contexts/temp_dir.rb
 - lib/gitt/sanitizers/container.rb
 - lib/gitt/sanitizers/date.rb
 - lib/gitt/sanitizers/email.rb
@@ -128,9 +131,6 @@ files:
 - lib/gitt/sanitizers/scissors.rb
 - lib/gitt/sanitizers/signature.rb
 - lib/gitt/sanitizers/trailers.rb
-- lib/gitt/shared_contexts/git_commit.rb
-- lib/gitt/shared_contexts/git_repo.rb
-- lib/gitt/shared_contexts/temp_dir.rb
 - lib/gitt/shell.rb
 homepage: https://alchemists.io/projects/gitt
 licenses:
@@ -158,8 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
-summary: Provides a monadic Object API wrapper around the Git CLI.
+summary: A monadic Object API for the Git CLI.
 test_files: []