branch-name 3.0.0 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecf9d15cb3f6a7be37ca9d39377e9d8c103b71557ae26a01dbf19670ce3c9548
-  data.tar.gz: 2ee162f10d1bd5bf48cde5e2d7611241600030098b9e50331472eef08077bbad
+  metadata.gz: 589277a07c2a1a873385e77be6276f7b0f2aaecbe6d5047b4f6e56e436ffcf8a
+  data.tar.gz: a185c55be39afb5611b25cecd50d39a761c0fedef40bf96b4927fd3e410ac3a2
 SHA512:
-  metadata.gz: d7dd261862332096d9dd74d38ade8fd517b72ea07fe867a8d2b2b6cbf367b13e296ce2f8fc35cd9bd2a697e53a51d39edc842ca9ad644a6ece15dcd4e0c0b3ac
-  data.tar.gz: cba46ce2945c423427d1e39930d9695841a0153fa041d61899f90b396a156162a4dcce047f1c04d1b131ce7573aa497b3f351538d8d12f6bc7820fcf2fe39b6e
+  metadata.gz: 5418d3f1ad7aa1cdc5ab523fb1824ffcf022c5c16ad54d3f9be773eaa4f02b3ba5f040ab2b3b5f5a8f7c0aecbe58dc2be848464f5409f68468cfb0059b222e49
+  data.tar.gz: eb1fc297bdd508848208e8b95a389d0ac8ff37e9c2310a865a209587ea42377206c17543595790ac7dabb8f90ac73171a0160c7fd4e3d3359ac963e7dc2679cd

data/CHANGELOG.md

@@ -1,5 +1,19 @@
-## ['3.0.0'] - 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.
+* Bug Fixes: Fix bug that displayed subcommand help incorrectly.
+
+## ['3.1.0'] - 2022-09-26
 * Enhancements:
+  * Branch names may now be created using a forward-slash (/). See the README.md file for more information.
+  * The `branch-name create :format_string` option string now accepts a %u placeholder which will be replaced with the currently logged in username. See `$ branch-name help create` for more information.
+
+## ['3.0.0'] - 2022-09-26
 * 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.

data/Gemfile.lock

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

data/README.md

@@ -93,6 +93,7 @@ NOTE: The below examples will assume the following `global` config file defaults
 create:
   downcase: false
   separator: _
+  format_string: "%t %d"
   project: false
   project_location: "/Users/<username>/feature-branches/%Y"
   project_files:
@@ -112,6 +113,27 @@ This example simply formulates feature a branch named *Add_create_and_destroy_se
 ```shell
 $ branch-name create "Add #create and #destroy session controller actions"
 ```
+#### Creating a Branch Name that Contains Forward-Slashes (`/`)
+
+This can be accomplished in different ways; here are some examples:
+
+Embed the forward-slashes using the `--format-string/-x` option:
+
+```shell
+$ branch-name create -x "%u/%t %d" "Remove debug code" UX-54321
+#=> Branch name: <username>/ux-54321-remove-debug-code
+...
+```
+
+Embed the forward-slashes in the ticket description itself. Depending on *where* you want your forward-slashes to appear, you'll have to place them appropriately:
+
+```shell
+$ branch-name create "<username>/UX-54321 Remove debug code"
+#=> Branch name: <username>/ux-54321-remove-debug-code
+...
+```
+
+NOTE: Project folders created (`--project/-p`) will replace any forward-slash with the `create: :separator` option value.
 
 ## Development
 

data/lib/branch/name/cli.rb

@@ -72,11 +72,14 @@ module Branch
             The default is: "#{Locatable.project_folder(options: options)}".
 
         \x5 -x FORMAT_STRING: This is a string that determines the format of the branch name
-            that is formulated. The following are a list of required placeholders you must put
-            in your format string to format the brach name: [%t, %d].
+            that is formulated. The following is a list of required placeholders you must put
+            in your format string to format the branch name: [%t, %d].
             \x5Where %t will be replaced by the ticket.
             \x5Where %d will be replaced by the ticket description.
-            \x5The default is: "#{DEFAULT_BRANCH_NAME_OPTIONS['create']['format_string']}".
+            \x5The following is a list of optional placeholders you may put
+            in your format string to format the branch name: [%u].
+            \x5Where %u will be replaced with your username (`Etc.getlogin`, https://rubygems.org/gems/etc).
+            \x5The default format string is: "#{DEFAULT_BRANCH_NAME_OPTIONS['create']['format_string']}".
       LONG_DESC
       method_option :downcase, type: :boolean, aliases: '-d'
       method_option :separator, type: :string, aliases: '-s'
@@ -97,12 +100,18 @@ module Branch
           say_error error.message
           exit 1
         end
-
         say "Branch name: #{branch_name}", :cyan
 
-        say "\"#{branch_name}\" has been copied to the clipboard!", :green if copy_to_clipboard branch_name
+        if options[:project]
+          project_folder = project_folder_from(branch_name) do |error|
+            say_error error.message
+            exit 1
+          end
+          say "Project folder name: #{project_folder}", :cyan
+          create_project!(project_folder)
+        end
 
-        create_project!(branch_name) if options[:project]
+        say "Branch name \"#{branch_name}\" has been copied to the clipboard!", :green if copy_to_clipboard branch_name
       end
 
       desc 'config SUBCOMMAND', 'Manages config files for this gem'

data/lib/branch/name/normalizable.rb

@@ -5,13 +5,28 @@ require_relative 'option_error'
 module Branch
   module Name
     module Normalizable
-      NON_WORD_CHARS_REGEX = /[\W_]/
+      # The regex used to split ticket and ticket description tokens
+      # to formulate a source control branch name.
+      BRANCH_NAME_REGEX = %r{[^/\w\x20]}
+
+      # The regex used to split ticket and ticket description tokens
+      # to formulate a project folder based on the branch name formulated.
+      PROJECT_FOLDER_REGEX = /[\W_]/
 
       def normalize_branch_name(ticket_description, ticket)
         formatted_branch_name = format_string_or_default
         formatted_branch_name = formatted_branch_name.gsub('%t', ticket || '')
         formatted_branch_name = formatted_branch_name.gsub('%d', ticket_description)
-        formatted_branch_name = normalize_token formatted_branch_name
+        formatted_branch_name = formatted_branch_name.gsub('%u', Etc.getlogin)
+        normalize_token formatted_branch_name, BRANCH_NAME_REGEX
+      rescue Branch::Name::OptionError => e
+        raise unless block_given?
+
+        yield e
+      end
+
+      def project_folder_from(normalized_branch_name)
+        normalize_token normalized_branch_name, PROJECT_FOLDER_REGEX
       rescue Branch::Name::OptionError => e
         raise unless block_given?
 
@@ -34,20 +49,8 @@ module Branch
         format_string
       end
 
-      def normalize_ticket_description(ticket_description)
-        normalize_token ticket_description
-      end
-
-      def normalize_ticket(ticket)
-        return if ticket.blank?
-
-        ticket.split(NON_WORD_CHARS_REGEX).filter_map do |token|
-          normalize_token(token)
-        end.join(options[:separator])
-      end
-
-      def normalize_token(token)
-        token = token.gsub(NON_WORD_CHARS_REGEX, ' ')
+      def normalize_token(token, regex)
+        token = token.gsub(regex, ' ')
         token = token.strip
           .squeeze(' ')
           .split.join(options[:separator])

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

@@ -16,13 +16,12 @@ module Branch
         include TaskDefaultable
 
         class << self
-          def ascestor_name
+          def base_usage
             '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
@@ -32,15 +31,12 @@ module Branch
           \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
@@ -50,14 +46,11 @@ module Branch
           \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
@@ -67,8 +60,6 @@ module Branch
           \x5
           branch-name config delete local
         LONG_DESC
-        method_option :local, type: :boolean, aliases: '-l'
-
         def local
           delete_local_config_file!
         end

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

@@ -16,13 +16,12 @@ module Branch
         include TaskDefaultable
 
         class << self
-          def ascestor_name
+          def base_usage
             '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
@@ -38,7 +37,6 @@ module Branch
         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

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'help_nestable'
-
 module Branch
   module Name
     module Subcommands
@@ -13,30 +11,33 @@ module Branch
         class << self
           def included(base)
             base.extend ClassMethods
-            base.include HelpNestable
           end
         end
 
         module ClassMethods
-          def ascestor_name
+          def base_usage
             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")
+          # rubocop:disable Style/OptionHash
+          def desc(usage, description, options = {})
+            super "#{base_usage} #{usage} ", description, options
           end
+          # rubocop:enable Style/OptionHash
 
-          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
+          # 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} #{command.usage}"
+            end.join("\n")
           end
+          # rubocop:enable Style/GlobalVars
+          # rubocop:enable Lint/UnusedMethodArgument
+          # rubocop:enable Style/OptionalBooleanParameter
         end
       end
     end

data/lib/branch/name/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.2
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2022-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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,24 +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.subcommand_help_override "config init help [SUBCOMMAND]"
-            def help(command = nil, subcommand = false)
-              super
-            end
-          end
-        end
-      end
-    end
-  end
-end