branch-name 3.5.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eaa01fba6e3bd5d848e9ddc6e349f9e9d1f4fd0261e181cc82e78cb68c3e286
-  data.tar.gz: 2abb17e38a16bc28fc8690ea1aa805fb04171982bba7e047250e88cad137088a
+  metadata.gz: 4b75833e2db0f7f5eeb6c662e83a46abac3740b6de855f41b120b4e48c5882a9
+  data.tar.gz: e291f3c4b834c1fa2e6c11b7225b1f2aa2c1f827306ae8cb9b7cbeda3225e460
 SHA512:
-  metadata.gz: 9b192d2562ca49009723cc1c1f7f6493ad7df71f35ec07ad47021c5ffa1f27a22fdcd2826ff39539437a0be87d7f6a4b33f1afd766a09d04f614a4dff8b3ec2f
-  data.tar.gz: 744f98d3f15956db6265aa560aa59ea3036060fd006141a08755b2c6b0b9746a54cc302013f4d3bc56a4c7dc161135c8cef41505c7e8b37f42426cfa6c855ad4
+  metadata.gz: 52ce1452b89586e01d82d1ad78c337cbe83a15ca48ddab80dee52f62a0a9330433bbd6845bc716234e1d656700389222fbcdab80f1337be07e7f282169aeb2db
+  data.tar.gz: f5604c5537195e20c17478382c161d4ca7bf29998fe6818d1e1a9f68071491d270e5e67a79fdf7f428907b0e649f1b9397dec74c0dcdfef7f76791fb6ca70b45

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## ['3.7.0'] - 2022-10-06
+* Changes
+  * Use thor_nested_subcommand to fix Thor nested subcommand help bug.
+  * Add missing global config option for create: :interactive.
+
+## ['3.6.0'] - 2022-10-06
+* Changes
+  * Added a `-i` (interactive) option to `branch-name create`. When used in conjunction with the `-p` option (project creation), if the `-i` option is used, the user will be prompted to create the project. If the `-i` option is NOT used, the user will NOT be prompted when creating the project.
+  * Update the README.md file accordign to the aforementioned.
+
 ## ['3.5.1'] - 2022-10-05
 * Bug Fixes
   * Fix bug that failed to remove underscore (_) characters in ticket and ticket descriptions from folder and branch name formulation.

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    branch-name (3.5.1)
+    branch-name (3.7.0)
       activesupport (~> 7.0, >= 7.0.4)
       colorize (~> 0.8.1)
       os (~> 1.1, >= 1.1.4)
       thor (~> 1.2, >= 1.2.1)
+      thor_nested_subcommand (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -74,6 +75,7 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     thor (1.2.1)
+    thor_nested_subcommand (1.0.0)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.8.0)

data/README.md

@@ -70,13 +70,14 @@ create:
   - readme.txt
   - scratch.rb
   - snippets.rb
+  interactive: true
   ```
 
 NOTE: You can manually change any of the options you wish. It is recommended that you change the default `create: project_location` to meet your needs, depending on your *os*. For example, on *macOS* you might want to change this to `"/Users/<username>/Documents"`, `"/Users/<username>/Documents/features"`, or something similar.
 
 The `create: project_location` option string also accepts any [`Time.strftime`](`https://apidock.com/ruby/Time/strftime`) format directives.
 
-The `create: format_string` option string can be used to position the *ticket* (`%t`) and *ticket description* (`%d`) within the branch name formulated. You can also include any other information you wish in the format string, for example: "`<username> %t %d`". However, non-word characters will be stripped (see `Branch::Name::Normalizable::NON_WORD_CHARS_REGEX` which equates to `/[\W_]/`)
+The `create: format_string` option string can be used to position the *ticket* (`%t`) and *ticket description* (`%d`) within the branch name formulated. You can also include any other information you wish in the format string, for example: "`<username> %t %d`". However, particular characters will be stripped to formulate the branch name (see `Branch::Name::Normalizable::BRANCH_NAME_REGEX` which equates to `%r{[^/\w\x20]|_}`).
 
 Any or all of these options can also be overwritten on the command-line. For more information:
 `$ branch-name config help init`
@@ -100,14 +101,17 @@ create:
   - readme.txt
   - scratch.rb
   - snippets.rb
+  interactive: true
   ```
 
-This example formulates feature a branch named *lg-12345-pay-down-tech-debt-on-user-model* by converting the ticket and ticket description to lowercase (`-d`) and delimiting the feature branch name tokens with a "-" character (`-s -`). The `-p` option instructs `branch-name create` to create the project folder */Users/<username>/feature-branches/2022/lg-12345-pay-down-tech-debt-on-user-model*. The aforementioned project folder will also contain the following files: readme.txt, scratch.rb and snippets.rb. In addition to this, `branch-name create` will also copy the feature brach name to the clipboard for you (macOS and Windows currently supported). This is convenient when you need to create a feature branch in github, or from the command-line.
+This example formulates feature a branch named *lg-12345-pay-down-tech-debt-on-user-model* by converting the ticket and ticket description to lowercase (`-d`) and delimiting the feature branch name tokens with a "-" character (`-s -`). The `-p` option instructs `branch-name create` to create the project folder */Users/<username>/feature-branches/2022/lg-12345-pay-down-tech-debt-on-user-model*, and finally, the `-i false` option instructs `branch-name` to *not* prompt the user when creating projects. The aforementioned project folder will also contain the following files: readme.txt, scratch.rb and snippets.rb. In addition to this, `branch-name create` will also copy the feature brach name to the clipboard for you (macOS and Windows currently supported). This is convenient when you need to create a feature branch in github, or from the command-line.
 
 ```shell
-$ branch-name create -p -d -s - "Pay down tech debt on User model" LG-12345
+$ branch-name create -i false -p -d -s - "Pay down tech debt on User model" LG-12345
 ```
 
+NOTE: When creating projects, `branch-name` will prompt you if the `interactive` option is true (`-i`).
+
 This example simply formulates feature a branch named *Add_create_and_destroy_session_controller_actions* and copies it to the clipboard.
 
 ```shell
@@ -133,7 +137,7 @@ $ branch-name create "<username>/UX-54321 Remove debug code"
 ...
 ```
 
-NOTE: Project folders created (`--project/-p`) will replace any forward-slash with the `create: :separator` option value.
+NOTE: Project folders that are formulated (`branch-name create [-p|--project] ...`), will have any tokens comprising the project folder name delimited according to the following rules: if the `options[:separator]` option (-s) is included in `Branch::Name::Normalizable::PROJECT_FOLDER_TOKEN_SEPARATORS`, `options[:separator]` (-s) will be used as the project folder token delimiter; otherwise, `Branch::Name::Normalizable::DEFAULT_PROJECT_FOLDER_TOKEN_SEPARATOR` will be used.
 
 ## Development
 

data/branch-name.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'colorize', '~> 0.8.1'
   spec.add_dependency 'os', '~> 1.1', '>= 1.1.4'
   spec.add_dependency 'thor', '~> 1.2', '>= 1.2.1'
+  spec.add_dependency 'thor_nested_subcommand', '~> 1.0'
 
   # Remove this for now.
   spec.metadata['rubygems_mfa_required'] = 'true'

data/lib/branch/name/cli.rb

@@ -44,42 +44,46 @@ module Branch
 
         SYNOPSIS
         \x5
-        branch-name create [-l|-f|-d|-s|-p|-x] DESCRIPTION [TICKET]
+        branch-name create [-i|-l|-f|-d|-s|-p|-x] DESCRIPTION [TICKET]
 
         \x5
         The following options are available:
 
         \x5 NOTE: Default option values will be overidden if .branch-name config files
-        are present. Run `branch-name config info` to determine what config files
-        are present.
+          are present. Run `branch-name config info` to determine what config files
+          are present.
 
         \x5 -d: Forces the branch name to lower case.
-                The default is: #{DEFAULT_BRANCH_NAME_OPTIONS['create']['downcase']}.
-
-        \x5\x5 -s SEPARATOR: Indicates the SEPARATOR that will be used to delimit tokens in the branch name.
-               The default SEPARATOR is: '#{DEFAULT_BRANCH_NAME_OPTIONS['create']['separator']}'.
-
-        \x5\x5 -p: Indicates that a project should be created.
-               The default is: #{DEFAULT_BRANCH_NAME_OPTIONS['create']['project']}.
+          The default is: #{DEFAULT_BRANCH_NAME_OPTIONS['create']['downcase']}.
 
         \x5 -f: Used with the -p option. If -f is specified, project files
-            will be created in the PROJECT_LOCATION specified by the -l option.
-            The default is: #{DEFAULT_BRANCH_NAME_OPTIONS['create']['project_files']}.
+          will be created in the PROJECT_LOCATION specified by the -l option.
+          The default is: #{DEFAULT_BRANCH_NAME_OPTIONS['create']['project_files']}.
+
+        \x5 -i: Interactive. Used with the -p option. If -i is specified, you will
+          be prompted when creating project folders. If -i is not specified, you will
+          NOT be prompted when creating project folders.
 
         \x5\x5 -l PROJECT_LOCATION: Indicates where the project should be created.
-            A "project" is a folder that is created in the PROJECT_LOCATION specified,
-            whose name is equivalent to the branch name that is formulated.
-            The default is: "#{Locatable.project_folder(options: options)}".
+          A "project" is a folder that is created in the PROJECT_LOCATION specified,
+          whose name is equivalent to the branch name that is formulated.
+          The default is: "#{Locatable.project_folder(options: options)}".
+
+        \x5\x5 -p: Indicates that a project should be created.
+          The default is: #{DEFAULT_BRANCH_NAME_OPTIONS['create']['project']}.
+
+        \x5\x5 -s SEPARATOR: Indicates the SEPARATOR that will be used to delimit tokens in the branch name.
+          The default SEPARATOR is: '#{DEFAULT_BRANCH_NAME_OPTIONS['create']['separator']}'.
 
         \x5 -x FORMAT_STRING: This is a string that determines the format of the branch name
-            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 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']}".
+          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 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'
@@ -87,6 +91,7 @@ module Branch
       method_option :project, type: :boolean, aliases: '-p'
       method_option :project_location, type: :string, aliases: '-l'
       method_option :project_files, type: :array, aliases: '-f'
+      method_option :interactive, type: :boolean, aliases: '-i'
 
       def create(ticket_description, ticket = nil)
         if ticket_description.blank?
@@ -108,11 +113,13 @@ module Branch
             say_error error.message
             exit 1
           end
-          project_folder = project_folder_for branch_name
-          unless yes? "Create project for branch \"#{branch_name}\" " \
-                      "in folder \"#{project_folder}\" (y/n)?", :cyan
-            say 'Aborted.', ABORTED
-            return
+          if options[:interactive]
+            project_folder = project_folder_for branch_name
+            unless yes? "Create project for branch \"#{branch_name}\" " \
+                        "in folder \"#{project_folder}\" (y/n)?", :cyan
+              say 'Aborted.', ABORTED
+              return
+            end
           end
 
           say "Project folder name: \"#{project_folder_name}\"", :cyan

data/lib/branch/name/configurable.rb

@@ -22,7 +22,8 @@ module Branch
           'format_string' => '%t %d',
           'project' => false,
           'project_location' => "#{Locatable.project_folder}/branch-name/projects/%Y/%m (%B)",
-          'project_files' => %w[readme.txt scratch.rb snippets.rb]
+          'project_files' => %w[readme.txt scratch.rb snippets.rb],
+          'interactive' => true
         }
       }.freeze
       # rubocop:enable Style/StringHashKeys

data/lib/branch/name/normalizable.rb

@@ -16,7 +16,7 @@ module Branch
       # Acceptable project folder token separators. If options[:separator]
       # returns one of these acceptable values, it will be used; otherwise
       # DEFAULT_PROJECT_FOLDER_TOKEN_SEPARATOR will be used.
-      PROJECT_FOLDER_TOKEN_SEPARATORS = %W[- _]
+      PROJECT_FOLDER_TOKEN_SEPARATORS = %w[- _].freeze
 
       # The default project folder token separator if options[:separator] is
       # not an acceptable project folder token separator

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'thor_nested_subcommand'
 require_relative '../configurable'
 require_relative '../exitable'
-require_relative 'nestable'
 require_relative '../task_defaultable'
 
 module Branch
@@ -12,8 +12,8 @@ module Branch
       class Delete < ::Thor
         include Configurable
         include Exitable
-        include Nestable
         include TaskDefaultable
+        include ThorNestedSubcommand
 
         class << self
           def base_usage

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'thor_nested_subcommand'
 require_relative '../configurable'
 require_relative '../exitable'
-require_relative 'nestable'
 require_relative '../task_defaultable'
 
 module Branch
@@ -12,8 +12,8 @@ module Branch
       class Init < ::Thor
         include Configurable
         include Exitable
-        include Nestable
         include TaskDefaultable
+        include ThorNestedSubcommand
 
         class << self
           def base_usage

data/lib/branch/name/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,6 +84,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: thor_nested_subcommand
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |2
     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:
 
@@ -126,7 +140,6 @@ files:
 - lib/branch/name/subcommands/config.rb
 - lib/branch/name/subcommands/delete.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

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

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-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
-          end
-        end
-
-        module ClassMethods
-          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} #{command.usage}"
-            end.join("\n")
-          end
-          # rubocop:enable Style/GlobalVars
-          # rubocop:enable Lint/UnusedMethodArgument
-          # rubocop:enable Style/OptionalBooleanParameter
-        end
-      end
-    end
-  end
-end