branch-name 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3591154bdf0c66a468e6d3d9d6fc06eab5a6a26f1d08abd193c0d9edbdec38c
-  data.tar.gz: b07809b34114ec1ac53a36934d1e2c81530e9ab3f8f7c08bdfb6c1353d99b86d
+  metadata.gz: ab4e1d2055038b5a1dc390420951edc3a1b359f359804b10b8699d67548a0dd2
+  data.tar.gz: d002928e6ede613707e119f3703f7724444e443a607eea8729cd15fda7c9636a
 SHA512:
-  metadata.gz: 0d66fb0d787e92b8747bc8d3defbe1bba52930118e03a8eef7eeb910632239a046825876ef3a1bde27e65943767792b72925dab6281601c95208d99746619564
-  data.tar.gz: 0772f605b9f5995a442c970199011ebdbe73da4a92b6521e6d92b7d7b62fbe4f7861d868bdd8ab91c71870378373b1caa4759e2caf91ae6cdb37c459579f7e38
+  metadata.gz: 7e20a24062daf1a3707fddbb6f809e1753c22e5ab61e8309a394a729f083e93147316b7b8e5fa07e611f82cbb117e41aacc198266fc979169e1b4de74249fd6a
+  data.tar.gz: 3d760194ca03920161ddef676b2d0f12c2519e9350fb5221d6fe667bf79a6965e6bb3c3e3b1e4e24be586d47e8d88acccb63069c87883f07e7990e90476c376d

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## ['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.
+  * Fix bug that allowed unacceptable project folder token separators in the project folder name (-p option). The rule is now: for `branch-name create`, 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 separator; otherwise, `Branch::Name::Normalizable::DEFAULT_PROJECT_FOLDER_TOKEN_SEPARATOR` will be used.
+* Changes
+  * Add test coverage for the above scenarios.
+  * Use File.join to join paths and files safely where appropriate.
+  * Update .gemspec gem description with more detail.
+
 ## ['3.5.0'] - 2022-10-04
 * Changes
   * Fix broken link to CHANGELOG.md in .gemspec file.

data/Gemfile.lock

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

data/README.md

@@ -76,7 +76,7 @@ NOTE: You can manually change any of the options you wish. It is recommended tha
 
 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 +100,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 +136,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

@@ -9,7 +9,13 @@ Gem::Specification.new do |spec|
   spec.email        = ['public.gma@gmail.com']
 
   spec.summary      = 'Generates a branch name based on a JIRA ticket/ticket number.'
-  spec.description  = 'Generates a branch name based on a JIRA ticket/ticket number.'
+  spec.description  = <<-EOF
+  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 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.
+  2. Optionally create a "project" based on the branch name (formulated in step 1 above). Why? Because I'm constantly having to create folders to manage files associated with the feature branches I am working on.
+  3. Optionally use and manage default options that determine the git feature branch name formulated, project greated, and default files associated with the project.Why? Because I routinely have to create files to support the feature I am working on and associate them with the feature I am working on. For example: scratch.rb to hold scratch code, snippets.rb to hold code to execute to perform redundant tasks, and readme.txt files to document things I need to remember.
+  EOF
   spec.homepage     = 'https://github.com/gangelo/branch-name'
   spec.license      = 'MIT'
 

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

@@ -7,18 +7,28 @@ module Branch
     module Normalizable
       # The regex used to split ticket and ticket description tokens
       # to formulate a source control branch name.
-      BRANCH_NAME_REGEX = %r{[^/\w\x20]}
+      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_]/
 
+      # 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[- _].freeze
+
+      # The default project folder token separator if options[:separator] is
+      # not an acceptable project folder token separator
+      # (i.e. PROJECT_FOLDER_TOKEN_SEPARATORS).
+      DEFAULT_PROJECT_FOLDER_TOKEN_SEPARATOR = PROJECT_FOLDER_TOKEN_SEPARATORS.first
+
       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 = formatted_branch_name.gsub('%u', Etc.getlogin)
-        normalize_token formatted_branch_name, BRANCH_NAME_REGEX
+        normalize_token formatted_branch_name, BRANCH_NAME_REGEX, options[:separator]
       rescue Branch::Name::OptionError => e
         raise unless block_given?
 
@@ -29,7 +39,7 @@ module Branch
       # The location of the folder is not included; that is, the
       # folder returned is not fully qualified.
       def project_folder_name_from(normalized_branch_name)
-        normalize_token normalized_branch_name, PROJECT_FOLDER_REGEX
+        normalize_token normalized_branch_name, PROJECT_FOLDER_REGEX, project_folder_separator
       rescue Branch::Name::OptionError => e
         raise unless block_given?
 
@@ -52,15 +62,22 @@ module Branch
         format_string
       end
 
-      def normalize_token(token, regex)
+      def normalize_token(token, regex, separator)
         token = token.gsub(regex, ' ')
         token = token.strip
           .squeeze(' ')
-          .split.join(options[:separator])
-        token = token.squeeze(options[:separator])
+          .split.join(separator)
+        token = token.squeeze(separator)
         token = token.downcase if options[:downcase]
         token
       end
+
+      def project_folder_separator
+        separator = options[:separator]
+        return options[:separator] if PROJECT_FOLDER_TOKEN_SEPARATORS.include? separator
+
+        DEFAULT_PROJECT_FOLDER_TOKEN_SEPARATOR
+      end
     end
   end
 end

data/lib/branch/name/projectable.rb

@@ -2,11 +2,13 @@
 
 require 'fileutils'
 require_relative 'locatable'
+require_relative 'normalizable'
 
 module Branch
   module Name
     module Projectable
       include Locatable
+      include Normalizable
 
       def create_project!(branch_name)
         raise 'options[:project] is false' unless options[:project]
@@ -52,8 +54,9 @@ module Branch
       end
 
       def project_folder_for(branch_name)
+        branch_name = project_folder_name_from branch_name
         project_location = Time.new.strftime(options[:project_location])
-        "#{project_location}/#{branch_name}"
+        File.join(project_location, branch_name)
       end
     end
   end

data/lib/branch/name/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-04 00:00:00.000000000 Z
+date: 2022-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,7 +84,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.1
-description: Generates a branch name based on a JIRA ticket/ticket number.
+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:
+
+    1. Formulate a git feature branch name, given a 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.
+    2. Optionally create a "project" based on the branch name (formulated in step 1 above). Why? Because I'm constantly having to create folders to manage files associated with the feature branches I am working on.
+    3. Optionally use and manage default options that determine the git feature branch name formulated, project greated, and default files associated with the project.Why? Because I routinely have to create files to support the feature I am working on and associate them with the feature I am working on. For example: scratch.rb to hold scratch code, snippets.rb to hold code to execute to perform redundant tasks, and readme.txt files to document things I need to remember.
 email:
 - public.gma@gmail.com
 executables: