branch-name 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c79db6ebf8cf49b09e86cc7ffff4bbe74fe88981da302cf83231cbce59a8ec0d
-  data.tar.gz: 15f849bc8342043994590d68b2caa5ea439a7c9a9c89a16a04a03211d3f47250
+  metadata.gz: ecf9d15cb3f6a7be37ca9d39377e9d8c103b71557ae26a01dbf19670ce3c9548
+  data.tar.gz: 2ee162f10d1bd5bf48cde5e2d7611241600030098b9e50331472eef08077bbad
 SHA512:
-  metadata.gz: edd5e60ccba0dd53b403290dc1956df060e2d31ca61c2959feb97d9ee80f8cda6802e8b90c441f8571fbf254e93929c9ba382af284cfda5ef3de997319a7e52d
-  data.tar.gz: 866f0482f61a59968b7b8fe3c4923551e3e0920416383aa5aa146ce1c4a827fb5f917bceef4297d020058c6e4a76f047c3027166937ff05ba9d1adc3216292b9
+  metadata.gz: d7dd261862332096d9dd74d38ade8fd517b72ea07fe867a8d2b2b6cbf367b13e296ce2f8fc35cd9bd2a697e53a51d39edc842ca9ad644a6ece15dcd4e0c0b3ac
+  data.tar.gz: cba46ce2945c423427d1e39930d9695841a0153fa041d61899f90b396a156162a4dcce047f1c04d1b131ce7573aa497b3f351538d8d12f6bc7820fcf2fe39b6e

data/CHANGELOG.md

@@ -1,6 +1,13 @@
+## ['3.0.0'] - 2022-09-26
+* Enhancements:
+* Changes:
+  * Default default commands to :help.
+  * Remove references to system for options, folder locations, etc. These were not being used and the nature of this tool is that global options should suffice.
+* Bug Fixes: Not really a branch-name bug, but patched Thor bug that displays nested subcommands incorrectly.
+
 ## ['2.2.0'] - 2022-09-24
 * Enhancements:
-  * Add support for `branch-name create` `-x` argument (see `branch-name help create`) which allows you to position the ticket and ticket description within the forulated branch name.
+  * Add support for `branch-name create` `-x` argument (see `branch-name help create`) which allows you to position the ticket and ticket description within the formulated branch name.
   * The `branch-name create :project_location` option string now accepts any [`Time.strftime`](`https://apidock.com/ruby/Time/strftime`) format directive.
   * Add better test coverage, although not what it should be (I'm working on it); this started a "quick and dirty" tool.
   * `branch-name create` will now create the PROJECT_LOCATION if it does not exist.

data/Gemfile.lock

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

data/README.md

@@ -1,5 +1,16 @@
 # `branch-name`
 
+[![GitHub version](http://badge.fury.io/gh/gangelo%2Fbranch-name.svg)](https://badge.fury.io/gh/gangelo%2Fbranch-name)
+
+[![Gem Version](https://badge.fury.io/rb/branch-name.svg)](https://badge.fury.io/rb/branch-name)
+
+[![](http://ruby-gem-downloads-badge.herokuapp.com/branch-name?type=total)](http://www.rubydoc.info/gems/branch-name/)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/branch-name/)
+
+[![Report Issues](https://img.shields.io/badge/report-issues-red.svg)](https://github.com/gangelo/branch-name/issues)
+
+[![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
+
 `branch-name` is a gem that provides a command-line interface that allows you to accomplish several tasks, tasks I *personally* find myself having to carry out every time I work on a feature branch. I created this gem *for myself*; however, you are free to use it yourself, if any of these tasks fits into your personal routine:
 
 1. Formulate a git *feature branch name*, given a [jira](https://www.atlassian.com/software/jira) ticket and jira ticket description. **Why? Because I am constantly having to create git feature branch names that are based on jira ticket and jira ticket descriptions.**

data/lib/branch/name/cli.rb

@@ -12,6 +12,7 @@ require_relative 'locatable'
 require_relative 'normalizable'
 require_relative 'projectable'
 require_relative 'subcommands/config'
+require_relative 'task_defaultable'
 require_relative 'version'
 
 module Branch
@@ -26,11 +27,11 @@ module Branch
       include Locatable
       include Normalizable
       include Projectable
+      include TaskDefaultable
 
       class_option :debug, type: :boolean, default: false
       class_option :verbose, type: :boolean, default: false
 
-      default_task :create
       map %w[--version -v] => :version
 
       desc 'create [OPTIONS] DESCRIPTION [TICKET]', 'Formulate a branch name based on a ticket

data/lib/branch/name/configurable.rb

@@ -34,10 +34,6 @@ module Branch
         File.join(local_folder, CONFIG_FILENAME)
       end
 
-      def system_config_file
-        File.join(system_folder, CONFIG_FILENAME)
-      end
-
       def global_config_file?
         File.exist? global_config_file
       end
@@ -46,10 +42,6 @@ module Branch
         File.exist? local_config_file
       end
 
-      def system_config_file?
-        File.exist? system_config_file
-      end
-
       def create_global_config_file!
         create_config_file global_config_file
       end
@@ -58,10 +50,6 @@ module Branch
         create_config_file local_config_file
       end
 
-      def create_system_config_file!
-        create_config_file system_config_file
-      end
-
       def delete_global_config_file!
         delete_config_file global_config_file
       end
@@ -70,10 +58,6 @@ module Branch
         delete_config_file local_config_file
       end
 
-      def delete_system_config_file!
-        delete_config_file system_config_file
-      end
-
       private
 
       def create_config_file(config_file)

data/lib/branch/name/loadable.rb

@@ -12,7 +12,6 @@ module Branch
       def load_options(defaults: {})
         options = {}
 
-        options.merge!(load_config(system_config_file))
         options.merge!(load_config(global_config_file))
         options.merge!(load_config(local_config_file))
 

data/lib/branch/name/locatable.rb

@@ -19,27 +19,12 @@ module Branch
         Dir.pwd
       end
 
-      def system_folder
-        system_folder = Pathname.new('/')
-        unless system_folder.exist? && system_folder.directory?
-          puts "WARNING: system folder #{system_folder} does not exist, " \
-               "using global folder instead (#{global_folder})".red
-
-          return global_folder
-        end
-        system_folder.to_s
-      end
-
       def project_folder(options: {})
         return home_folder if options.blank?
 
         home_folder
       end
 
-      def system_folder_equals_global_folder?
-        syetem_folder == global_folder
-      end
-
       def temp_folder
         Dir.tmpdir
       end

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

@@ -3,7 +3,9 @@
 require 'thor'
 require_relative '../configurable'
 require_relative '../exitable'
+require_relative 'delete'
 require_relative 'init'
+require_relative '../task_defaultable'
 
 module Branch
   module Name
@@ -11,8 +13,7 @@ module Branch
       class Config < ::Thor
         include Configurable
         include Exitable
-
-        default_task :info
+        include TaskDefaultable
 
         desc 'info', 'Displays information about this gem configuration'
         long_desc <<-LONG_DESC
@@ -36,46 +37,13 @@ module Branch
           else
             say "Local config file does not exist at: \"#{local_folder}\"", :yellow
           end
-
-          if system_config_file?
-            say "System config file exists: \"#{system_config_file}\"", :green
-          else
-            say "System config file does not exist at: \"#{system_folder}\"", :yellow
-          end
-        end
-
-        desc 'delete [OPTION]', 'Removes .branch-name file(s)'
-        long_desc <<-LONG_DESC
-          NAME
-          \x5
-          `branch-name config delete [OPTION]` -- will remove one or all .branch-name file(s)
-          depending on the OPTION.
-
-          SYNOPSIS
-          \x5
-          branch-name config delete [-a|-g|-l|-s]
-        LONG_DESC
-        method_option :all, type: :boolean, aliases: '-a'
-        method_option :global, type: :boolean, aliases: '-g'
-        method_option :local, type: :boolean, aliases: '-l'
-        method_option :system, type: :boolean, aliases: '-s'
-
-        def delete
-          if options[:all]
-            delete_global_config_file!
-            delete_local_config_file!
-            delete_system_config_file!
-          elsif options[:global]
-            delete_global_config_file!
-          elsif options[:local]
-            delete_local_config_file!
-          elsif options[:system]
-            delete_system_config_file!
-          end
         end
 
         desc 'init SUBCOMMAND', 'Sets up config files for this gem'
         subcommand :init, Branch::Name::Subcommands::Init
+
+        desc 'delete SUBCOMMAND', 'Deletes one of all config files for this gem'
+        subcommand :delete, Branch::Name::Subcommands::Delete
       end
     end
   end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative '../configurable'
+require_relative '../exitable'
+require_relative 'nestable'
+require_relative '../task_defaultable'
+
+module Branch
+  module Name
+    module Subcommands
+      class Delete < ::Thor
+        include Configurable
+        include Exitable
+        include Nestable
+        include TaskDefaultable
+
+        class << self
+          def ascestor_name
+            'config delete'
+          end
+        end
+
+        desc 'all', 'Deletes all config files (local and global) for this gem'
+        subcommand_help_override "#{ascestor_name} all"
+        long_desc <<-LONG_DESC
+          NAME
+          \x5
+          `branch-name config delete all` -- will remove the all .branch-name config files.
+
+          SYNOPSIS
+          \x5
+          branch-name config delete all
+        LONG_DESC
+        method_option :all, type: :boolean, aliases: '-a'
+
+        def all
+          delete_global_config_file!
+          delete_local_config_file!
+        end
+
+        desc 'global', 'Deletes the global config file for this gem'
+        subcommand_help_override "#{ascestor_name} global"
+        long_desc <<-LONG_DESC
+          NAME
+          \x5
+          `branch-name config delete global` -- will remove the global .branch-name config file.
+
+          SYNOPSIS
+          \x5
+          branch-name config delete global
+        LONG_DESC
+        method_option :global, type: :boolean, aliases: '-g'
+
+        def global
+          delete_global_config_file!
+        end
+
+        desc 'local', 'Deletes the local config file for this gem'
+        subcommand_help_override "#{ascestor_name} local"
+        long_desc <<-LONG_DESC
+          NAME
+          \x5
+          `branch-name config delete local` -- will remove the local .branch-name config file.
+
+          SYNOPSIS
+          \x5
+          branch-name config delete local
+        LONG_DESC
+        method_option :local, type: :boolean, aliases: '-l'
+
+        def local
+          delete_local_config_file!
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# 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.subcommand_help_override "config init help [SUBCOMMAND]"
+            def help(command = nil, subcommand = false)
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,63 +3,55 @@
 require 'thor'
 require_relative '../configurable'
 require_relative '../exitable'
+require_relative 'nestable'
+require_relative '../task_defaultable'
 
 module Branch
   module Name
     module Subcommands
-      # https://www.atlassian.com/git/tutorials/setting-up-a-repository/git-config
       class Init < ::Thor
         include Configurable
         include Exitable
+        include Nestable
+        include TaskDefaultable
 
-        default_task :global
+        class << self
+          def ascestor_name
+            'config init'
+          end
+        end
 
         desc 'global', 'Creates and initializes a .branch-name file in the global folder'
+        subcommand_help_override "#{ascestor_name} global"
         long_desc <<-LONG_DESC
           NAME
           \x5
-          `branch-name init global` -- will create and initialize a .branch-name file
+          `branch-name config init global` -- will create and initialize a .branch-name file
           in the "#{Locatable.global_folder}" folder.
 
           SYNOPSIS
           \x5
-          branch-name init global
+          branch-name config init global
         LONG_DESC
         def global
           create_global_config_file!
         end
 
         desc 'local', 'Creates and initializes a .branch-name file in the local folder'
+        subcommand_help_override "#{ascestor_name} local"
         long_desc <<-LONG_DESC
           NAME
           \x5
-          `branch-name init local` -- will create and initialize a .branch-name file
+          `branch-name config init local` -- will create and initialize a .branch-name file
           in the "#{Locatable.local_folder}" folder.
 
           SYNOPSIS
           \x5
-          branch-name init local
+          branch-name config init local
         LONG_DESC
         def local
           create_local_config_file!
         end
-
-        desc 'system', 'Creates and initializes a .branch-name file in the system folder'
-        long_desc <<-LONG_DESC
-          NAME
-          \x5
-          `branch-name init system` -- will create and initialize a .branch-name file
-          in the "#{Locatable.system_folder}" folder.
-
-          SYNOPSIS
-          \x5
-          branch-name init system
-        LONG_DESC
-        def system
-          # create_system_config_file!
-          say_error 'System initialization is not available at this time', :red
-          exit 1
-        end
       end
     end
   end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'help_nestable'
+
+module Branch
+  module Name
+    module Subcommands
+      # This module fixes 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.
+      module Nestable
+        class << self
+          def included(base)
+            base.extend ClassMethods
+            base.include HelpNestable
+          end
+        end
+
+        module ClassMethods
+          def ascestor_name
+            raise NotImplementedError
+          end
+
+          # Thor override
+          def banner(command, _namespace = nil, subcommand = false)
+            command.formatted_usage(self, $thor_runner, subcommand).split("\n").map do |_formatted_usage|
+              command_name = command.name.to_sym
+              "#{basename} #{@subcommand_help_override[command.usage]}"
+            end.join("\n")
+          end
+
+          def subcommand_help_override(help_string)
+            raise "Thor.desc must be called for \"#{help_string}\" " \
+              'prior to calling .subcommand_help_override' if @usage.blank?
+
+            @subcommand_help_override = {} unless defined? @subcommand_help_override
+            @subcommand_help_override[@usage] = help_string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/branch/name/task_defaultable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Branch
+  module Name
+    # Forces the default Thor task to be :help
+    module TaskDefaultable
+      class << self
+        def included(base)
+          base.default_command :help
+        end
+      end
+    end
+  end
+end

data/lib/branch/name/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-24 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,7 +118,11 @@ files:
 - lib/branch/name/option_error.rb
 - 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
 - lib/branch/name/version.rb
 - sig/branch/name.rbs
 homepage: https://github.com/gangelo/branch-name