branch-name 3.4.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b538070d81c24a53a841d1502a2e846fde4c9349df8f627be5ec21cc133f3446
-  data.tar.gz: 26db98632c66f0d0a020219c4e0f34877d22a71ba741fcabbb42b63f2be5a131
+  metadata.gz: 6eaa01fba6e3bd5d848e9ddc6e349f9e9d1f4fd0261e181cc82e78cb68c3e286
+  data.tar.gz: 2abb17e38a16bc28fc8690ea1aa805fb04171982bba7e047250e88cad137088a
 SHA512:
-  metadata.gz: 9534c3a6f80ed67115a2e7c2c44651212d7c32e7b7b41d6319ab90da0e978f063faa8f22940d84c6da139237a3a01dcad176eca49a618ee2d9b2673295add1b2
-  data.tar.gz: d8d9a7ac27d35525a0981e85b094c45841893f3c6a70f1fd2eccaabbac8345a50726e456b53e6942f0f45eee31392ffffb495813963f50b4530c690106831418
+  metadata.gz: 9b192d2562ca49009723cc1c1f7f6493ad7df71f35ec07ad47021c5ffa1f27a22fdcd2826ff39539437a0be87d7f6a4b33f1afd766a09d04f614a4dff8b3ec2f
+  data.tar.gz: 744f98d3f15956db6265aa560aa59ea3036060fd006141a08755b2c6b0b9746a54cc302013f4d3bc56a4c7dc161135c8cef41505c7e8b37f42426cfa6c855ad4

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## ['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.
+
 ## ['3.4.0'] - 2022-10-04
 * Changes
   * `branch-name create` when creating projects prompts to confirm creating of projects by clicking 'y'. This change was prompted because projects were being created when users were attempting to display help for `branch-name create`; for example, users were incorrectly attempting to display help using `branch-name create help`, when, infact, `branch-name help create` should have been entered. Incorrectly executing `branch-name create help` would create a project with the name "help". Prompting the user to verify project creation solves this problem.

data/Gemfile.lock

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

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'
 
@@ -19,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/gangelo/branch-name'
-  spec.metadata['changelog_uri'] = 'https://github.com/gangelo/branch-name/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/gangelo/branch-name/blob/main/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

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[- _]
+
+      # 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.4.0'
+    VERSION = '3.5.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.1
 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:
@@ -131,7 +136,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/gangelo/branch-name
   source_code_uri: https://github.com/gangelo/branch-name
-  changelog_uri: https://github.com/gangelo/branch-name/CHANGELOG.md
+  changelog_uri: https://github.com/gangelo/branch-name/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []