branch-name 3.2.2 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 589277a07c2a1a873385e77be6276f7b0f2aaecbe6d5047b4f6e56e436ffcf8a
-  data.tar.gz: a185c55be39afb5611b25cecd50d39a761c0fedef40bf96b4927fd3e410ac3a2
+  metadata.gz: b538070d81c24a53a841d1502a2e846fde4c9349df8f627be5ec21cc133f3446
+  data.tar.gz: 26db98632c66f0d0a020219c4e0f34877d22a71ba741fcabbb42b63f2be5a131
 SHA512:
-  metadata.gz: 5418d3f1ad7aa1cdc5ab523fb1824ffcf022c5c16ad54d3f9be773eaa4f02b3ba5f040ab2b3b5f5a8f7c0aecbe58dc2be848464f5409f68468cfb0059b222e49
-  data.tar.gz: eb1fc297bdd508848208e8b95a389d0ac8ff37e9c2310a865a209587ea42377206c17543595790ac7dabb8f90ac73171a0160c7fd4e3d3359ac963e7dc2679cd
+  metadata.gz: 9534c3a6f80ed67115a2e7c2c44651212d7c32e7b7b41d6319ab90da0e978f063faa8f22940d84c6da139237a3a01dcad176eca49a618ee2d9b2673295add1b2
+  data.tar.gz: d8d9a7ac27d35525a0981e85b094c45841893f3c6a70f1fd2eccaabbac8345a50726e456b53e6942f0f45eee31392ffffb495813963f50b4530c690106831418

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## ['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.
+  * Various changes in information printed to stdout when (for example) creating projects.
+
+## ['3.3.0'] - 2022-09-27
+* Enhancements:
+  * `branch-name config info` now displays the contents of both the Global and the local config files.
+
 ## ['3.2.2'] - 2022-09-27
 * Changes:
   * Refactor code that patches Thor incorrect display of nested commands (subcommangs).

data/Gemfile.lock

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

data/lib/branch/name/cli.rb

@@ -90,7 +90,7 @@ module Branch
 
       def create(ticket_description, ticket = nil)
         if ticket_description.blank?
-          say_error 'description is required', :red
+          say_error 'description is required', ERROR
           exit 1
         end
 
@@ -100,18 +100,24 @@ module Branch
           say_error error.message
           exit 1
         end
-        say "Branch name: #{branch_name}", :cyan
+        say "Branch name: \"#{branch_name}\"", :cyan
+        say "Branch name \"#{branch_name}\" has been copied to the clipboard!", SUCCESS if copy_to_clipboard branch_name
 
         if options[:project]
-          project_folder = project_folder_from(branch_name) do |error|
+          project_folder_name = project_folder_name_from(branch_name) do |error|
             say_error error.message
             exit 1
           end
-          say "Project folder name: #{project_folder}", :cyan
-          create_project!(project_folder)
-        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
+          end
 
-        say "Branch name \"#{branch_name}\" has been copied to the clipboard!", :green if copy_to_clipboard branch_name
+          say "Project folder name: \"#{project_folder_name}\"", :cyan
+          create_project!(project_folder_name)
+        end
       end
 
       desc 'config SUBCOMMAND', 'Manages config files for this gem'

data/lib/branch/name/colorizable.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Branch
+  module Name
+    module Colorizable
+      SUCCESS = :green
+      WARNING = :yellow
+      ERROR = :red
+      ABORTED = :red
+    end
+  end
+end

data/lib/branch/name/configurable.rb

@@ -3,14 +3,17 @@
 require 'colorize'
 require 'fileutils'
 require 'yaml'
+require_relative 'colorizable'
 require_relative 'locatable'
 
 module Branch
   module Name
     module Configurable
+      include Colorizable
       include Locatable
 
       CONFIG_FILENAME = '.branch-name'
+
       # rubocop:disable Style/StringHashKeys - YAML writing/loading necessitates this
       DEFAULT_BRANCH_NAME_OPTIONS = {
         'create' => {
@@ -44,10 +47,12 @@ module Branch
 
       def create_global_config_file!
         create_config_file global_config_file
+        print_global_config_file
       end
 
       def create_local_config_file!
         create_config_file local_config_file
+        print_local_config_file
       end
 
       def delete_global_config_file!
@@ -58,37 +63,62 @@ module Branch
         delete_config_file local_config_file
       end
 
+      def print_global_config_file
+        config_file = global_config_file
+        if global_config_file?
+          say "Global config file (#{config_file}) contents:", SUCCESS
+          print_config_file config_file
+        else
+          say "Global config file (#{config_file}) does not exist.", WARNING
+        end
+      end
+
+      def print_local_config_file
+        config_file = local_config_file
+        if local_config_file?
+          say "Local config file (#{config_file}) contents:", SUCCESS
+          print_config_file config_file
+        else
+          say "Local config file (#{config_file}) does not exist.", WARNING
+        end
+      end
+
       private
 
       def create_config_file(config_file)
         folder = File.dirname(config_file)
         unless Dir.exist?(folder)
-          say "Destination folder for configuration file (#{folder}) does not exist".red
+          say "Destination folder for configuration file (#{folder}) does not exist", ERROR
           return false
         end
 
         if File.exist?(config_file)
-          puts "Configuration file (#{config_file}) already exists".yellow
+          say "Configuration file (#{config_file}) already exists", WARNING
           return false
         end
 
         File.write(config_file, DEFAULT_BRANCH_NAME_OPTIONS.to_yaml)
-        puts "Configuration file (#{config_file}) created".green
+        say "Configuration file (#{config_file}) created.", SUCCESS
 
         true
       end
 
       def delete_config_file(config_file)
         unless File.exist?(config_file)
-          puts "Configuration file (#{config_file}) does not exist".yellow
+          say "Configuration file (#{config_file}) does not exist", WARNING
           return false
         end
 
         File.delete config_file
-        puts "Configuration file (#{config_file}) deleted".green
+        say "Configuration file (#{config_file}) deleted", SUCCESS
 
         true
       end
+
+      def print_config_file(config_file)
+        hash = YAML.safe_load(File.open(config_file))
+        say hash.to_yaml.gsub("\n-", "\n\n-"), SUCCESS
+      end
     end
   end
 end

data/lib/branch/name/normalizable.rb

@@ -25,7 +25,10 @@ module Branch
         yield e
       end
 
-      def project_folder_from(normalized_branch_name)
+      # Returns a project folder name from a normalized branch name.
+      # 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
       rescue Branch::Name::OptionError => e
         raise unless block_given?

data/lib/branch/name/projectable.rb

@@ -11,8 +11,7 @@ module Branch
       def create_project!(branch_name)
         raise 'options[:project] is false' unless options[:project]
 
-        project_location = Time.new.strftime(options[:project_location])
-        project_folder = "#{project_location}/#{branch_name}"
+        project_folder = project_folder_for branch_name
 
         if Dir.exist? project_folder
           puts "Project folder \"#{project_folder}\" already exists"
@@ -23,7 +22,15 @@ module Branch
         FileUtils.mkdir_p(project_folder)
         create_project_files!(project_folder)
 
-        puts "Project folder \"#{project_folder}\" with project files #{options[:project_files]} was created".green
+        project_files = options[:project_files]
+        if project_files.blank?
+          puts "Project folder \"#{project_folder}\" was created.".green
+        else
+          puts "Project folder \"#{project_folder}\" was created with project files:".green
+          project_files.each do |project_file|
+            puts "- #{project_file}".green
+          end
+        end
       end
 
       def create_project_files!(project_folder)
@@ -40,9 +47,14 @@ module Branch
           next if File.exist? full_file_name
 
           FileUtils.touch full_file_name
-          puts "Created project file \"#{full_file_name}\""
+          puts "Created project file \"#{full_file_name}\"" if options[:verbose]
         end
       end
+
+      def project_folder_for(branch_name)
+        project_location = Time.new.strftime(options[:project_location])
+        "#{project_location}/#{branch_name}"
+      end
     end
   end
 end

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

@@ -26,17 +26,9 @@ module Branch
           branch-name config info
         LONG_DESC
         def info
-          if global_config_file?
-            say "Global config file exists: \"#{global_config_file}\"", :green
-          else
-            say "Global config file does not exist at: \"#{global_folder}\"", :yellow
-          end
-
-          if local_config_file?
-            say "Local config file exists: \"#{local_config_file}\"", :green
-          else
-            say "Local config file does not exist at: \"#{local_folder}\"", :yellow
-          end
+          print_global_config_file
+          say ''
+          print_local_config_file
         end
 
         desc 'init SUBCOMMAND', 'Sets up config files for this gem'

data/lib/branch/name/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.4.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,6 +110,7 @@ files:
 - lib/branch/name/cli.rb
 - lib/branch/name/cli/thor_ext/shell/basic/say_error.rb
 - lib/branch/name/clipable.rb
+- lib/branch/name/colorizable.rb
 - lib/branch/name/configurable.rb
 - lib/branch/name/exitable.rb
 - lib/branch/name/loadable.rb