branch-name 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a3968d20d8af29e02e511894c96e66b09965f60fd945efdb42c0454d190ce75
-  data.tar.gz: 3d936e247ea81a147fd4e117ee15a10ffce733557c117060c1ead457c1c0bf13
+  metadata.gz: 589277a07c2a1a873385e77be6276f7b0f2aaecbe6d5047b4f6e56e436ffcf8a
+  data.tar.gz: a185c55be39afb5611b25cecd50d39a761c0fedef40bf96b4927fd3e410ac3a2
 SHA512:
-  metadata.gz: 64bf17dc7a54feffe42ed5195d869291a59689c4cc7a06a0c2329ae3c1dbc86cc3ba08225aa58a30b964cd7c82fb6e55aedb8e121a346b2ddc5602938feb46bd
-  data.tar.gz: 29a1c7a1b64f38ed6404c6c9f87d5c95bc5470d31408362b42b96ceaf9b0ca8958a7d59f8bbab0b06b322734b4326ae55652cf5aa4edbcaf3d35fd5aabef8b57
+  metadata.gz: 5418d3f1ad7aa1cdc5ab523fb1824ffcf022c5c16ad54d3f9be773eaa4f02b3ba5f040ab2b3b5f5a8f7c0aecbe58dc2be848464f5409f68468cfb0059b222e49
+  data.tar.gz: eb1fc297bdd508848208e8b95a389d0ac8ff37e9c2310a865a209587ea42377206c17543595790ac7dabb8f90ac73171a0160c7fd4e3d3359ac963e7dc2679cd

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## ['3.2.1'] - 2022-09-26
+## ['3.2.2'] - 2022-09-27
+* Changes:
+  * Refactor code that patches Thor incorrect display of nested commands (subcommangs).
+
+## ['3.2.1'] - 2022-09-27
 * Changes:
   * Fix rubocop violations.
   * Miscellaneous mixin refactors.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    branch-name (3.2.1)
+    branch-name (3.2.2)
       activesupport (~> 7.0, >= 7.0.4)
       colorize (~> 0.8.1)
       os (~> 1.1, >= 1.1.4)

data/lib/branch/name/subcommands/delete.rb

@@ -3,7 +3,6 @@
 require 'thor'
 require_relative '../configurable'
 require_relative '../exitable'
-require_relative 'help_nestable'
 require_relative 'nestable'
 require_relative '../task_defaultable'
 
@@ -17,16 +16,12 @@ module Branch
         include TaskDefaultable
 
         class << self
-          def ancestor_name
+          def base_usage
             'config delete'
           end
         end
 
-        # NOTE: This must be included AFTER defining .ancestor_name
-        include HelpNestable
-
         desc 'all', 'Deletes all config files (local and global) for this gem'
-        help_override "#{ancestor_name} all"
         long_desc <<-LONG_DESC
           NAME
           \x5
@@ -42,7 +37,6 @@ module Branch
         end
 
         desc 'global', 'Deletes the global config file for this gem'
-        help_override "#{ancestor_name} global"
         long_desc <<-LONG_DESC
           NAME
           \x5
@@ -57,7 +51,6 @@ module Branch
         end
 
         desc 'local', 'Deletes the local config file for this gem'
-        help_override "#{ancestor_name} local"
         long_desc <<-LONG_DESC
           NAME
           \x5

data/lib/branch/name/subcommands/init.rb

@@ -3,7 +3,6 @@
 require 'thor'
 require_relative '../configurable'
 require_relative '../exitable'
-require_relative 'help_nestable'
 require_relative 'nestable'
 require_relative '../task_defaultable'
 
@@ -17,16 +16,12 @@ module Branch
         include TaskDefaultable
 
         class << self
-          def ancestor_name
+          def base_usage
             'config init'
           end
         end
 
-        # NOTE: This must be included AFTER defining .ancestor_name
-        include HelpNestable
-
         desc 'global', 'Creates and initializes a .branch-name file in the global folder'
-        help_override "#{ancestor_name} global"
         long_desc <<-LONG_DESC
           NAME
           \x5
@@ -42,7 +37,6 @@ module Branch
         end
 
         desc 'local', 'Creates and initializes a .branch-name file in the local folder'
-        help_override "#{ancestor_name} local"
         long_desc <<-LONG_DESC
           NAME
           \x5

data/lib/branch/name/subcommands/nestable.rb

@@ -15,33 +15,29 @@ module Branch
         end
 
         module ClassMethods
-          def ancestor_name
+          def base_usage
             raise NotImplementedError
           end
 
+          # Thor override
+          # rubocop:disable Style/OptionHash
+          def desc(usage, description, options = {})
+            super "#{base_usage} #{usage} ", description, options
+          end
+          # rubocop:enable Style/OptionHash
+
           # Thor override
           # rubocop:disable Style/GlobalVars
           # rubocop:disable Lint/UnusedMethodArgument
           # rubocop:disable Style/OptionalBooleanParameter
           def banner(command, namespace = nil, subcommand = false)
             command.formatted_usage(self, $thor_runner, subcommand).split("\n").map do |_formatted_usage|
-              "#{basename} #{@help_override[command.usage]}"
+              "#{basename} #{command.usage}"
             end.join("\n")
           end
           # rubocop:enable Style/GlobalVars
           # rubocop:enable Lint/UnusedMethodArgument
           # rubocop:enable Style/OptionalBooleanParameter
-
-          def help_override(help_string)
-            if @usage.blank?
-              raise 'Thor.desc must be called for the command that should ' \
-                    "be associated with \"#{help_string}\" prior to calling " \
-                    '.help_override'
-            end
-
-            @help_override = {} unless defined? @help_override
-            @help_override[@usage] = help_string
-          end
         end
       end
     end

data/lib/branch/name/version.rb

@@ -3,6 +3,6 @@
 module Branch
   module Name
     # branch-name version
-    VERSION = '3.2.1'
+    VERSION = '3.2.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
@@ -119,7 +119,6 @@ files:
 - lib/branch/name/projectable.rb
 - lib/branch/name/subcommands/config.rb
 - lib/branch/name/subcommands/delete.rb
-- lib/branch/name/subcommands/help_nestable.rb
 - lib/branch/name/subcommands/init.rb
 - lib/branch/name/subcommands/nestable.rb
 - lib/branch/name/task_defaultable.rb

data/lib/branch/name/subcommands/help_nestable.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Branch
-  module Name
-    module Subcommands
-      # This module helps fix a bug in Thor that prohibits help for nested
-      # subcommands from displaying help properly. Nested subcommands fail
-      # to display their subcommand ancestor command name. This fixes that
-      # bug. This module is used in conjunction with the Nestable module.
-      module HelpNestable
-        class << self
-          def included(base)
-            # Thor override
-            base.desc 'help [COMMAND]', 'Describe available commands or one specific command'
-            base.help_override "#{base.ancestor_name} help [SUBCOMMAND]"
-            # rubocop:disable Style/OptionalBooleanParameter
-            # def help(command = nil, subcommand = false)
-            #   puts "subcommand: #{subcommand}"
-            #   super
-            # end
-            # rubocop:enable Style/OptionalBooleanParameter
-          end
-        end
-      end
-    end
-  end
-end