gitt 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89432cb99090adf3338c1f9226c01a018afaaa08df54d4d84929bb20f6b0ea1d
-  data.tar.gz: 93d61f586d6d5df881c55b47a814b21fd5ca63ade7c182a8269bf5dd9f975d2d
+  metadata.gz: d6db467cc857d649e08395a7c9b1c21ae3e6cb642f29b3da28c59e2f22897d20
+  data.tar.gz: 4d1e7a21157c389c0890cc73a854d13115d0d9e1508098ad30dc9077b2ca2465
 SHA512:
-  metadata.gz: 9c40e0cc1712b995d90aaeff4302a08d13ba02e7e297f61ec522e648e31b2f26b68f03e5cd9fede300553d5ab22cf2c0d3319b26bf55071b253647410a9aeee9
-  data.tar.gz: abc1e6a2f5b6b88740807e180c9675897b24b21e9469d9ef49441b66944d359c9f28be0c476f3393901620715564464088ad8e66cfd7bfe3b1cf19b2f07c19bd
+  metadata.gz: c64c55d0370c4087f440a216b5d5f43fbc30e2530e7629db23423f9555104cdde3f61fdb6377d7679dd4e28d80747245f2172253520666ce1a46621984e9115a
+  data.tar.gz: 722fe4f60211868b47ee89cb4ee3306c397114e2f10571f901411f04f21e886ff47adffa89141f3c1b2ec0a0b1855887eac72a13e104c2ee0d277f725b0894de

data/README.adoc

@@ -3,17 +3,18 @@
 :figure-caption!:
 
 :git_link: link:https://git-scm.com[Git]
-:struct_link: link:https://www.alchemists.io/articles/ruby_structs[Struct]
+:rspec_link: link:https://rspec.info[RSpec]
+:struct_link: link:https://alchemists.io/articles/ruby_structs[Struct]
 
 = Gitt
 
 Provides a monadic Object API to the {git_link} CLI. This project is also an extraction of work originally implemented within the following projects:
 
-* link:https://www.alchemists.io/projects/git-lint[Git Lint]
-* link:https://www.alchemists.io/projects/milestoner[Milestoner]
-* link:https://www.alchemists.io/projects/rubysmith[Rubysmith]
+* link:https://alchemists.io/projects/git-lint[Git Lint]
+* link:https://alchemists.io/projects/milestoner[Milestoner]
+* link:https://alchemists.io/projects/rubysmith[Rubysmith]
 
-If you are looking for alternatives within this space, you might find the following gems of benefit too:
+This project doesn't try to encompass the vast feature set natively provided by {git_link} but only exposes the most used features, limited as this may be. Over time, more of the {git_link} feature set will be implemented but it'll most likely happen slowly and organically. If you are looking for alternatives to this gem, then you might find the following of interest:
 
 * link:https://github.com/ruby-git/ruby-git[Ruby Git]
 * link:https://github.com/libgit2/rugged[Rugged]
@@ -22,8 +23,9 @@ toc::[]
 
 == Features
 
-* Wraps all Git commands with additional enhancements to improve your working experience.
-* Answers link:https://dry-rb.org/gems/dry-monads[monads] so you can pipe commands together for more powerful and complex workflows.
+* Wraps a subset of native {git_link} commands with additional enhancements to improve your working experience.
+* Answers link:https://dry-rb.org/gems/dry-monads[monads] you can pipe together -- or link:https://alchemists.io/projects/transactable[transact] -- for more powerful and complex workflows.
+* Provides _optional_ {rspec_link} shared contexts that speed up the testing of your own Git related implementations.
 
 == Requirements
 
@@ -61,7 +63,7 @@ git.set             # Equivalent to `get config set`.
 git.tag             # Equivalent to `git tag <arguments>`.
 git.tag?            # Answers if local or remote tag exists.
 git.tag_create      # Create a new tag.
-git.tag_last        # Anwswers last tag created.
+git.tag_last        # Answers last tag created.
 git.tag_local?      # Answers if local tag exists?
 git.tag_parse       # Parses and answers a tag record.
 git.tag_remote?     # Answers if remote tag exists?
@@ -73,7 +75,7 @@ git.uncommitted     # Parses a file and answers an unsaved commit message.
 === Commands
 
 Should you want to use individual commands instead of interacting with the `Repository` object, you
-can leverage any of the objects in the `Commands` namespace which -- at a minimum -- use the link:https://www.alchemists.io/articles/interactor_pattern[Command Pattern]. Here are the _select_ commands which are enhanced further:
+can leverage any of the objects in the `Commands` namespace which -- at a minimum -- use the link:https://alchemists.io/articles/interactor_pattern[Command Pattern]. Here are the _select_ commands which are enhanced further:
 
 ==== link:https://git-scm.com/docs/git-branch[Branch]
 
@@ -254,6 +256,65 @@ The attributes break down as follows:
 * `space`: Answers either a space or an empty string with the former being invalid.
 * `value`: Answers the value associated with the key.
 
+=== 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.
+
+==== Git Commit
+
+Provides a default `git_commit` record of `Gitt::Commits::Model` with minimal information for testing purposes and can be used as follows:
+
+[source,ruby]
+----
+require "gitt/shared_contexts/git_commit"
+
+describe Demo do
+  include_context "with Git commit"
+end
+----
+
+==== Git Repository
+
+Provides a simple Git repository with a single commit for testing purposes. This repository is set up and torn down _around_ each spec. The repository is built within your project's `tmp` directory and provides a `git_repo_dir` pathname you can interact with. Here's how to use it:
+
+[source,ruby]
+----
+require "gitt/shared_contexts/git_repo"
+require "refinemenets/pathnames"
+
+describe Demo do
+  include_context "with Git repository"
+
+  using Refinements::Pathnames
+
+  it "is a demo" do
+    git_repo_dir.change_dir { # Your expectation goes here. }
+  end
+end
+----
+
+==== Temporary Directory
+
+Provides a temporary directory (i.e. `tmp/rspec`) for creating directories and or files you want set up and torn down _around_ each spec. Access to the `temp_dir` pathname is also provided for you. Here's how to use it:
+
+[source,ruby]
+----
+require "gitt/shared_contexts/temp_dir"
+require "refinemenets/pathnames"
+
+describe Demo do
+  include_context "with temporary directory"
+
+  using Refinements::Pathnames
+
+  it "is a demo" do
+    temp_dir.change_dir { # Your expectation goes here. }
+  end
+end
+----
+
+💡 The Git Repository shared context -- mentioned above -- includes this shared context by default so you don't have to manually include this shared context when using the Git Repository shared context.
+
 == Development
 
 To contribute, run:
@@ -278,22 +339,22 @@ To test, run:
 
 [source,bash]
 ----
-bundle exec rake
+bin/rake
 ----
 
-== link:https://www.alchemists.io/policies/license[License]
+== link:https://alchemists.io/policies/license[License]
 
-== link:https://www.alchemists.io/policies/security[Security]
+== link:https://alchemists.io/policies/security[Security]
 
-== link:https://www.alchemists.io/policies/code_of_conduct[Code of Conduct]
+== link:https://alchemists.io/policies/code_of_conduct[Code of Conduct]
 
-== link:https://www.alchemists.io/policies/contributions[Contributions]
+== link:https://alchemists.io/policies/contributions[Contributions]
 
-== link:https://www.alchemists.io/projects/gitt/versions[Versions]
+== link:https://alchemists.io/projects/gitt/versions[Versions]
 
-== link:https://www.alchemists.io/community[Community]
+== link:https://alchemists.io/community[Community]
 
 == Credits
 
-* Built with link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
-* Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
+* Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
+* Engineered by link:https://alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/gitt.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |spec|
   spec.name = "gitt"
-  spec.version = "1.1.0"
+  spec.version = "1.1.2"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
-  spec.homepage = "https://www.alchemists.io/projects/gitt"
+  spec.homepage = "https://alchemists.io/projects/gitt"
   spec.summary = "Provides a monadic Object API wrapper around the Git CLI."
   spec.license = "Hippocratic-2.1"
 
   spec.metadata = {
     "bug_tracker_uri" => "https://github.com/bkuhlmann/gitt/issues",
-    "changelog_uri" => "https://www.alchemists.io/projects/gitt/versions",
-    "documentation_uri" => "https://www.alchemists.io/projects/gitt",
+    "changelog_uri" => "https://alchemists.io/projects/gitt/versions",
+    "documentation_uri" => "https://alchemists.io/projects/gitt",
     "funding_uri" => "https://github.com/sponsors/bkuhlmann",
     "label" => "Gitt",
     "rubygems_mfa_required" => "true",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitt
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -10,25 +10,32 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIC/jCCAeagAwIBAgIBBTANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMjAzMTkxNzI0MzJaFw0yMzAzMTkx
-  NzI0MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
-  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
-  xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
-  brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
-  9z0A8KcGhz67SdcoQiD7qiCjL/2NTeWHOzkpPrdGlt088+VerEEGf5I13QCvaftP
-  D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
-  3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
-  AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAJbbNyWzFjqUNVPPCUCo
-  IMrhDa9xf1xkORXNYYbmXgoxRy/KyNbUr+jgEEoWJAm9GXlcqxxWAUI6pK/i4/Qi
-  X6rPFEFmeObDOHNvuqy8Hd6AYsu+kP94U/KJhe9wnWGMmGoNKJNU3EkW3jM/osSl
-  +JRxiH5t4WtnDiVyoYl5nYC02rYdjJkG6VMxDymXTqn7u6HhYgZkGujq1UPar8x2
-  hNIWJblDKKSu7hA2d6+kUthuYo13o1sg1Da/AEDg0hoZSUvhqDEF5Hy232qb3pDt
-  CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
-  RFE=
+  MIIEeDCCAuCgAwIBAgIBATANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
+  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
+  aW8wHhcNMjMwMzIyMTYxNDQxWhcNMjUwMzIxMTYxNDQxWjBBMQ8wDQYDVQQDDAZi
+  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
+  GRYCaW8wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCro8tj5/E1Hg88
+  f4qfiwPVd2zJQHvdYt4GHVvuHRRgx4HGhJuNp+4BId08RBn7V6V1MW6MY3kezRBs
+  M+7QOQ4b1xNLTvY7FYQB1wGK5a4x7TTokDrPYQxDB2jmsdDYCzVbIMrAvUfcecRi
+  khyGZCdByiiCl4fKv77P12tTT+NfsvXkLt/AYCGwjOUyGKTQ01Z6eC09T27GayPH
+  QQvIkakyFgcJtzSyGzs8bzK5q9u7wQ12MNTjJoXzW69lqp0oNvDylu81EiSUb5S6
+  QzzPxZBiRB1sgtbt1gUbVI262ZDq1gR+HxPFmp+Cgt7ZLIJZAtesQvtcMzseXpfn
+  hpmm0Sw22KGhRAy/mqHBRhDl5HqS1SJp2Ko3lcnpXeFResp0HNlt8NSu13vhC08j
+  GUHU9MyIXbFOsnp3K3ADrAVjPWop8EZkmUR3MV/CUm00w2cZHCSGiXl1KMpiVKvk
+  Ywr1gd2ZME4QLSo+EXUtLxDUa/W3xnBS8dBOuMMz02FPWYr3PN8CAwEAAaN7MHkw
+  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAFgmv0tYMZnItuPycSM
+  F5wykJEVMB8GA1UdEQQYMBaBFGJyb29rZUBhbGNoZW1pc3RzLmlvMB8GA1UdEgQY
+  MBaBFGJyb29rZUBhbGNoZW1pc3RzLmlvMA0GCSqGSIb3DQEBCwUAA4IBgQAX+EGY
+  9RLYGxF1VLZz+G1ACQc4uyrCB6kXwI06kzUa5dF9tPXqTX9ffnz3/W8ck2IQhKzu
+  MKO2FVijzbDWTsZeZGglS4E+4Jxpau1lU9HhOIcKolv6LeC6UdALTFudY+GLb8Xw
+  REXgaJkjzzhkUSILmEnRwEbY08dVSl7ZAaxVI679vfI2yapLlIwpbBgmQTiTvPr3
+  qyyLUno9flYEOv9fmGHunSrM+gE0/0niGTXa5GgXBXYGS2he4LQGgSBfGp/cTwMU
+  rDKJRcusZ12lNBeDfgqACz/BBJF8FLodgk6rGMRZz7+ZmjjHEmpG5bQpR6Q2BuWL
+  XMtYk/QzaWuhiR7pWjiF8jbdd7RO6or0ohq7iFkokz/5xrtQ/vPzU2RQ3Qc6YaKw
+  3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
+  gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-01-07 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core
@@ -125,13 +132,13 @@ files:
 - lib/gitt/shared_contexts/git_repo.rb
 - lib/gitt/shared_contexts/temp_dir.rb
 - lib/gitt/shell.rb
-homepage: https://www.alchemists.io/projects/gitt
+homepage: https://alchemists.io/projects/gitt
 licenses:
 - Hippocratic-2.1
 metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/gitt/issues
-  changelog_uri: https://www.alchemists.io/projects/gitt/versions
-  documentation_uri: https://www.alchemists.io/projects/gitt
+  changelog_uri: https://alchemists.io/projects/gitt/versions
+  documentation_uri: https://alchemists.io/projects/gitt
   funding_uri: https://github.com/sponsors/bkuhlmann
   label: Gitt
   rubygems_mfa_required: 'true'
@@ -151,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: Provides a monadic Object API wrapper around the Git CLI.