gitt 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf995a1e83d2a4b629d45413b6368c0597ee4860bea8116537114a93ee4dfbb4
-  data.tar.gz: b83e9922914f836999e24aecaa9204aa112e50fd9d8b3a44397b202b3e257ecb
+  metadata.gz: 8fbec0bde106e2f9fc5f6a0e24ae9eeeb074fb91302984a3fbc29eccde828499
+  data.tar.gz: 56fb1a05bf0a206ad67ce3d6d908b5bb72dfc0d65a9ee90d7552ca8b258663bc
 SHA512:
-  metadata.gz: af182dd15da70427375a655da1b74d74bb15fa3980bc954f931b591c84bf6cf0fb87aea892b42f65e70ea22b8680dfef2979ed96430f57b1d27fd20dc2af9954
-  data.tar.gz: b8f3056ba6fa218c79c663d0536404db6f4dd7d061f8c1b45ee3c67a6cf958e143c665c840b00d86d9e659b46643b74bb41a9ec419891eeff683072de008c597
+  metadata.gz: 556cafdb7dfaf50dbc4b2238326e2e3cd7a5f7d145127c3775bca51752bc3afa04bbf13489396d7a3b1d8060e588423c402205b9eb4b7f2a38ff1f11f21df78d
+  data.tar.gz: 49ab793068b0447402e43fac302cd881d4b120d18189fa51230fc0b1d90ac11fcafb3838f910a3882c14c98b463deac9f5c72d5a4834516e81f12ff385150d83

data/README.adoc

@@ -23,7 +23,7 @@ toc::[]
 
 == Features
 
-* Wraps a subset of native {git_link} commands with additional enhancements to improve your working experience.
+* Wraps native {git_link} commands with additional enhancements to improve your working experience.
 * Answers link:https://dry-rb.org/gems/dry-monads[monads] you can link:https://alchemists.io/articles/ruby_function_composition[pipe] together for more complex workflows.
 * Provides _optional_ {rspec_link} shared contexts that speed up the testing of your own Git related implementations.
 
@@ -49,30 +49,34 @@ At a high level, this project provides a centralized Object API via a single obj
 ----
 git = Gitt.new
 
-git.branch          # Equivalent to `git branch <arguments>`.
-git.branch_default  # Answers default branch.
-git.branch_name     # Answers current branch.
-git.call            # Allows you to run any Git command.
-git.commits         # Answers enhanced commit records.
-git.config          # Equivalent to `git config <arguments>`.
-git.exist?          # Answers if current directory is a Git repository or not.
-git.get             # Equivalent to `git config get`.
-git.inspect         # Allows you to inspect the current instance.
-git.log             # Equivalent to `git log <arguments>`.
-git.origin?         # Answers if repository has an origin or not.
-git.set             # Equivalent to `get config set`.
-git.tag             # Equivalent to `git tag <arguments>`.
-git.tags            # Answers enhanced tag records.
-git.tag?            # Answers if local or remote tag exists.
-git.tag_create      # Create a new tag.
-git.tag_last        # Answers last tag created.
-git.tag_local?      # Answers if local tag exists?
-git.tag_remote?     # Answers if remote tag exists?
-git.tag_show        # Answers information about a single tag.
-git.tagged?         # Answers if the repository has any tags.
-git.tags_push       # Pushes local tags to remote git.
-git.uncommitted     # Parses `COMMIT_EDITMSG` file and answers the unsaved commit message.
-----
+git.branch             # Equivalent to `git branch <arguments>`.
+git.branch_default     # Answers default branch.
+git.branch_name        # Answers current branch.
+git.call               # Allows you to run any Git command.
+git.commits            # Answers enhanced commit records.
+git.config             # Equivalent to `git config <arguments>`.
+git.exist?             # Answers if current directory is a Git repository or not.
+git.get                # Equivalent to `git config get`.
+git.inspect            # Allows you to inspect the current instance.
+git.log                # Equivalent to `git log <arguments>`.
+git.origin?            # Answers if repository has an origin or not.
+git.set                # Equivalent to `get config set`.
+git.tag                # Equivalent to `git tag <arguments>`.
+git.tags               # Answers enhanced tag records.
+git.tag?               # Answers if local or remote tag exists.
+git.tag_create         # Create a new tag.
+git.tag_delete_local   # Deletes local tag.
+git.tag_delete_remote  # Deletes remote tag.
+git.tag_last           # Answers last tag created.
+git.tag_local?         # Answers if local tag exists?
+git.tag_remote?        # Answers if remote tag exists?
+git.tag_show           # Answers information about a single tag.
+git.tagged?            # Answers if the repository has any tags.
+git.tags_push          # Pushes local tags to remote git.
+git.uncommitted        # Parses `COMMIT_EDITMSG` file and answers the unsaved commit message.
+----
+
+💡 In general, the above (and individual commands below) support link:https://docs.ruby-lang.org/en/master/Process.html#method-c-spawn[Process#spawn] arguments where you can provide environment, command, arguments, and options (hash). Example: `git.tag({"GIT_COMMITTER_DATE" => "2025-01-01 20:00:00"}, "0.0.0", chdir: "path/to/repo")` This allows you to perform advanced operations where you might need to supply environment variables or options like changing directory (as shown in the example). Check the method signatures to learn more.
 
 === Commands
 
@@ -165,6 +169,12 @@ stdout, stderr, status = tag.call
 # Creates a new tag.
 tag.create "0.0.0", "Version 0.0.0"
 
+# Deletes local tag.
+tag.delete_local "0.0.0"
+
+# Deletes remote tag.
+tag.delete_remote "0.0.0"
+
 # Answers true or false base on whether local and remote tag exist.
 tag.exist? "0.1.0"
 
@@ -331,6 +341,19 @@ describe Demo do
 end
 ----
 
+==== Git Tag
+
+Provides a default `git_tag` record of `Gitt::Models::Tag` with minimal information for testing purposes and can be used as follows:
+
+[source,ruby]
+----
+require "gitt/rspec/shared_contexts/git_tag"
+
+describe Demo do
+  include_context "with Git tag"
+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:

data/gitt.gemspec

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

data/lib/gitt/commands/branch.rb

@@ -12,16 +12,16 @@ module Gitt
         @shell = shell
       end
 
-      def default fallback = "main"
-        shell.call("config", "init.defaultBranch")
+      def default(fallback = "main", *, **)
+        shell.call("config", "init.defaultBranch", *, **)
              .fmap(&:chomp)
              .fmap { |name| name.empty? ? fallback : name }
              .or(Success(fallback))
       end
 
-      def call(*) = shell.call("branch", *)
+      def call(*, **) = shell.call("branch", *, **)
 
-      def name = shell.call("rev-parse", "--abbrev-ref", "HEAD").fmap(&:chomp)
+      def name(*, **) = shell.call("rev-parse", "--abbrev-ref", "HEAD", *, **).fmap(&:chomp)
 
       private
 

data/lib/gitt/commands/config.rb

@@ -13,16 +13,17 @@ module Gitt
         @shell = shell
       end
 
-      def call(*) = shell.call("config", *)
+      def call(*, **) = shell.call("config", *, **)
 
-      def get(key, fallback = Core::EMPTY_STRING, *)
-        call(*, "--get", key).fmap(&:chomp)
-                             .or { |error| block_given? ? yield(error) : Success(fallback) }
+      def get(key, fallback = Core::EMPTY_STRING, *, **)
+        shell.call("config", "--get", key, *, **)
+             .fmap(&:chomp)
+             .or { |error| block_given? ? yield(error) : Success(fallback) }
       end
 
       def origin? = !get("remote.origin.url").value_or(Core::EMPTY_STRING).empty?
 
-      def set(key, value, *) = call(*, "--add", key, value).fmap { value }
+      def set(key, value, *, **) = shell.call("config", "--add", key, value, *, **).fmap { value }
 
       private
 

data/lib/gitt/commands/log.rb

@@ -35,11 +35,11 @@ module Gitt
         @parser = parser
       end
 
-      def call(*) = shell.call("log", *)
+      def call(*, **) = shell.call("log", *, **)
 
-      def index *arguments
+      def index(*arguments, **)
         arguments.prepend("--shortstat", pretty_format)
-                 .then { |pretty_format| call(*pretty_format) }
+                 .then { |pretty_format| call(*pretty_format, **) }
                  .fmap { |content| String(content).scrub("?") }
                  .fmap { |entries| build_records entries }
       end

data/lib/gitt/commands/tag.rb

@@ -33,7 +33,7 @@ module Gitt
         @parser = parser
       end
 
-      def call(*) = shell.call("tag", *)
+      def call(*, **) = shell.call("tag", *, **)
 
       def create version, body = Core::EMPTY_STRING, *flags
         return Failure "Unable to create Git tag without version." unless version
@@ -45,17 +45,30 @@ module Gitt
         end
       end
 
+      def delete_local(version, *, **)
+        call("--delete", version, *, **).fmap { |text| text[/\d+\.\d+\.\d+/] }
+                                        .alt_map do |error|
+                                          error.delete_prefix("error: tag ").chomp
+                                        end
+      end
+
+      def delete_remote(version, *, **)
+        shell.call("push", "--delete", "origin", version, *, **)
+             .fmap { version }
+             .alt_map { |error| error.gsub("error: ", "").chomp }
+      end
+
       def exist?(version) = local?(version) || remote?(version)
 
-      def index *arguments
+      def index(*arguments, **)
         arguments.prepend(pretty_format, "--list")
-                 .then { |flags| call(*flags) }
+                 .then { |flags| call(*flags, **) }
                  .fmap { |content| String(content).scrub("?").split %("\n") }
                  .fmap { |entries| build_records entries }
       end
 
-      def last
-        shell.call("describe", "--abbrev=0", "--tags")
+      def last(*, **)
+        shell.call("describe", "--abbrev=0", "--tags", *, **)
              .fmap(&:strip)
              .or do |error|
                if error.match?(/no names found/i)
@@ -70,7 +83,7 @@ module Gitt
         call("--list", version).value_or(Core::EMPTY_STRING).match?(/\A#{version}\Z/)
       end
 
-      def push = shell.call "push", "--tags"
+      def push(*, **) = shell.call("push", "--tags", *, **)
 
       def remote? version
         shell.call("ls-remote", "--tags", "origin", version)
@@ -78,8 +91,8 @@ module Gitt
              .match?(%r(.+tags/#{version}\Z))
       end
 
-      def show version
-        call(pretty_format, "--list", version).fmap { |content| parser.call content }
+      def show(version, *, **)
+        call(pretty_format, "--list", version, *, **).fmap { |content| parser.call content }
       end
 
       def tagged? = !call.value_or(Core::EMPTY_STRING).empty?

data/lib/gitt/repository.rb

@@ -21,7 +21,7 @@ module Gitt
 
     def branch_default(...) = commands.fetch(:branch).default(...)
 
-    def branch_name = commands.fetch(:branch).name
+    def branch_name(...) = commands.fetch(:branch).name(...)
 
     def call(...) = shell.call(...)
 
@@ -52,7 +52,11 @@ module Gitt
 
     def tag_create(...) = commands.fetch(:tag).create(...)
 
-    def tag_last = commands.fetch(:tag).last
+    def tag_delete_local(...) = commands.fetch(:tag).delete_local(...)
+
+    def tag_delete_remote(...) = commands.fetch(:tag).delete_remote(...)
+
+    def tag_last(...) = commands.fetch(:tag).last(...)
 
     def tag_local?(...) = commands.fetch(:tag).local?(...)
 
@@ -62,7 +66,7 @@ module Gitt
 
     def tagged? = commands.fetch(:tag).tagged?
 
-    def tags_push = commands.fetch(:tag).push
+    def tags_push(...) = commands.fetch(:tag).push(...)
 
     def uncommitted(...) = commands.fetch(:log).uncommitted(...)
 

data/lib/gitt/rspec/shared_contexts/git_tag.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+RSpec.shared_context "with Git tag" do
+  let :git_tag do
+    Gitt::Models::Tag[
+      author_email: "test@example.com",
+      author_name: "Test User",
+      authored_at: 1735714800,
+      authored_relative_at: "1 day ago",
+      body: "Generated by Milestoner.",
+      committed_at: 1735718461,
+      committed_relative_at: "1 hour ago",
+      committer_email: "test@example.com",
+      committer_name: "Test User",
+      sha: "180dec7d8ae8cbe3565a727c63c2111e49e0b737",
+      signature: "",
+      subject: "Version 0.0.0",
+      trailers: [],
+      version: "0.0.0"
+    ]
+  end
+end

data/lib/gitt/shell.rb

@@ -12,8 +12,10 @@ module Gitt
       @client = client
     end
 
-    def call(*, **)
-      client.capture3("git", *, **).then do |stdout, stderr, status|
+    def call(*all, **)
+      environment, arguments = all.partition { it.is_a? Hash }
+
+      client.capture3(*environment, "git", *arguments, **).then do |stdout, stderr, status|
         status.success? ? Success(stdout) : Failure(stderr)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitt
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -34,7 +34,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-12-27 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core
@@ -121,6 +121,7 @@ files:
 - 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/git_tag.rb
 - lib/gitt/rspec/shared_contexts/temp_dir.rb
 - lib/gitt/sanitizers/container.rb
 - lib/gitt/sanitizers/date.rb