branch-name 0.1.0.pre.alpha → 1.0.0.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d882d8879ddec14bdc35c55ef3dbe8248f8015354fc2f80e9facd910340422b5
-  data.tar.gz: f55756f320579898d41e13a9f27200886a4ed2715eabdf5aa80929ff79637d33
+  metadata.gz: b7dad0772990843cd87dc265aa42d9ddd8fc91c0c50db1c8d0e7d48be3ca7129
+  data.tar.gz: 6b64ae358a4105d1495f10a5d5d4e24997ee0c45fbdb9e10135e295d3ff686ae
 SHA512:
-  metadata.gz: d3e87289c12232e36def910161ed1fe58f6129bf780a18bc4a6e65210fc1169f8f448aef6217b67fa51ab1e30fafb19c02721d6d17528d63f2b470a401e6a352
-  data.tar.gz: fb33ef5ca18c7c55ceb31d5f7bf32c1159093c590d715b35763eb4331cd3de7fa4a4bea1c88476810dd9bc7eac32ff2d8c96fc8f869f37a33cb054c73f4a6203
+  metadata.gz: b90aa2baa2030cd11a7ded0189f3efc273d923e42dad82f6150b670570cf95375930948fb05aaa5a7348429e32a53f2de8a91fbc5f9dfdabf5315851c7078db4
+  data.tar.gz: ca83be22b65d2174bfb88ab3cf971306008179856557f4c39870cd427b0cbcfcda921646cb78cd51110b8b0b3eee8e97d54868f61567848fe52cb8d964962668

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    branch-name (0.1.0.pre.alpha)
+    branch-name (1.0.0.pre.beta)
       activesupport (~> 7.0, >= 7.0.4)
       colorize (~> 0.8.1)
       thor (~> 1.2, >= 1.2.1)

data/branch-name.gemspec

@@ -37,5 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor', '~> 1.2', '>= 1.2.1'
 
   # Remove this for now.
-  # spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/branch/name/cli.rb

@@ -3,13 +3,15 @@
 require 'active_support'
 require 'active_support/core_ext/object/blank'
 require 'bundler'
-require 'colorize'
 require 'thor'
+require_relative 'clipable'
 require_relative 'configurable'
 require_relative 'exitable'
+require_relative 'loadable'
 require_relative 'locatable'
+require_relative 'nameable'
+require_relative 'projectable'
 require_relative 'subcommands/config'
-require_relative 'subcommands/init'
 require_relative 'version'
 
 module Branch
@@ -18,8 +20,15 @@ module Branch
     # The `branch-name` command.
     #
     class CLI < ::Thor
-      include Locatable
+      include Clipable
       include Exitable
+      include Loadable
+      include Locatable
+      include Nameable
+      include Projectable
+
+      class_option :debug, type: :boolean, default: false
+      class_option :verbose, type: :boolean, default: false
 
       default_task :create
       map %w[--version -v] => :version
@@ -32,7 +41,7 @@ module Branch
 
         SYNOPSIS
         \x5
-        branch-name create [-dsp] TICKET [DESCRIPTION]
+        branch-name create [-d|-s|-p|-pL|-pF] TICKET [DESCRIPTION]
 
         \x5
         The following options are available:
@@ -40,54 +49,64 @@ module Branch
         \x5 -d: Forces the branch name to lower case.
                 The default is --no-downcase
 
-        \x5\x5 -s DELIMITER: Indicates the DELIMITER that will be used to delimit tokens in the branch name.
-               The default DELIMITER is the '_' (underscore) character.
+        \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']}.
 
-        \x5\x5 -p LOCATION: Indicates that a project should be created.
-               A "project" is a folder that is created in the LOCATION specified
-               whose name is equivalent to the branch name that is formulated.
-               The default LOCATION is #{Locatable.project_folder(options: options)}.
+        \x5 -pF: Used with the -p option. If -pF is specified, project files
+            will be created in the PROJECT_LOCATION specified by the -pL option.
+            The default is: #{DEFAULT_BRANCH_NAME_OPTIONS['create']['project_files']}.
 
-        \x5 -f: Used with the -p option. If -f is specified, scratch.rb and readme.txt files
-            will be created in the project folder created.
-            The default is --project-files
+        \x5\x5 -pL 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)}".
       LONG_DESC
       method_option :downcase, type: :boolean, aliases: '-d'
-      method_option :separator, type: :string, aliases: '-s', default: '_'
-      method_option :project, type: :string, aliases: '-p', default: "#{Locatable.project_folder(options: options)}"
-      method_option :project_files, type: :boolean, aliases: '-f', default: true
+      method_option :separator, type: :string, aliases: '-s'
+      method_option :project, type: :boolean, aliases: '-p'
+      method_option :project_location, type: :string, aliases: '-pL'
+      method_option :project_files, type: :array, aliases: '-pF'
 
       def create(ticket, ticket_description = nil)
-        if ticket.blank? && ticket_description.blank?
-          say_error 'ticket and/or ticket_description is required', :red
+        if ticket.blank?
+          say_error 'ticket is required', :red
           exit 1
         end
 
-        branch_name = "#{ticket} #{ticket_description}".strip
-        branch_name = branch_name.split.join options[:separator]
-        branch_name = branch_name.downcase if options[:downcase]
-        branch_name = branch_name.tr('_', '-') if options[:separator] == '-'
-        branch_name = branch_name.tr('-', '_') if options[:separator] == '_'
-        branch_name = branch_name.squeeze('-') if options[:separator] == '-'
-        branch_name = branch_name.squeeze('_') if options[:separator] == '_'
+        init_options_for! command: :create
+
+        branch_name = "#{ticket} #{ticket_description}"
+        branch_name = normalize_branch_name branch_name
 
         say "Branch name: #{branch_name}", :cyan
 
-        if /darwin/ =~ RUBY_PLATFORM
-          IO.popen('pbcopy', 'w') { |pipe| pipe.puts branch_name }
-          say "\"#{branch_name}\" has been copied to the clipboard!", :green
-        end
-      end
+        say "\"#{branch_name}\" has been copied to the clipboard!", :green if copy_to_clipboard branch_name
 
-      desc 'init SUBCOMMAND', 'Sets up config files for this gem'
-      subcommand :init, Branch::Name::Subcommands::Init
+        create_project!(branch_name) if options[:project]
+      end
 
       desc 'config SUBCOMMAND', 'Manages config files for this gem'
       subcommand :config, Branch::Name::Subcommands::Config
 
       desc '--version, -v', 'Displays this gem version'
       def version
-        puts Branch::Name::VERSION
+        say Branch::Name::VERSION
+      end
+
+      private
+
+      def init_options_for!(command:)
+        say "Options before config file merge: #{options}" if options[:debug]
+
+        load_options = load_options(defaults: DEFAULT_BRANCH_NAME_OPTIONS)[command.to_s] || {}
+        say "No options loaded from config file(s): #{load_options}" if options[:debug] && load_options.blank?
+        say "Options loaded from config file(s): #{load_options}" if options[:debug]
+
+        self.options = Thor::CoreExt::HashWithIndifferentAccess.new(load_options.merge(options))
+        say "Options after config file merge: #{options}" if options[:debug]
       end
     end
   end

data/lib/branch/name/clipable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Branch
+  module Name
+    module Clipable
+      module_function
+
+      def copy_to_clipboard(text)
+        if /darwin/.match?(RUBY_PLATFORM)
+          IO.popen('pbcopy', 'w') { |pipe| pipe.puts text }
+          true
+        end
+      end
+    end
+  end
+end

data/lib/branch/name/configurable.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'colorize'
+require 'fileutils'
+require 'yaml'
 require_relative 'locatable'
 
 module Branch
@@ -8,7 +10,18 @@ module Branch
     module Configurable
       include Locatable
 
-      CONFIG_FILENAME = '.branch-nameconfig'
+      CONFIG_FILENAME = '.branch-name'
+      # rubocop:disable Style/StringHashKeys - YAML writing/loading necessitates this
+      DEFAULT_BRANCH_NAME_OPTIONS = {
+        'create' => {
+          'downcase' => false,
+          'separator' => '_',
+          'project' => false,
+          'project_location' => Locatable.project_folder,
+          'project_files' => %w[scratch.rb readme.txt]
+        }
+      }.freeze
+      # rubocop:enable Style/StringHashKeys
 
       module_function
 
@@ -25,33 +38,71 @@ module Branch
       end
 
       def global_config_file?
-        Dir.exist? global_config_file
+        File.exist? global_config_file
       end
 
       def local_config_file?
-        Dir.exist? local_config_file
+        File.exist? local_config_file
       end
 
       def system_config_file?
-        Dir.exist? system_config_file
+        File.exist? system_config_file
       end
 
       def create_global_config_file!
-        return false if Dir.exist? global_config_file
-
-        Dir.mkdir(global_config_file) == 0
+        create_config_file global_config_file
       end
 
       def create_local_config_file!
-        return false if Dir.exist? local_config_file
-
-        Dir.mkdir(local_config_file) == 0
+        create_config_file local_config_file
       end
 
       def create_system_config_file!
-        return false if Dir.exist? system_config_file
+        create_config_file system_config_file
+      end
+
+      def delete_global_config_file!
+        delete_config_file global_config_file
+      end
+
+      def delete_local_config_file!
+        delete_config_file local_config_file
+      end
+
+      def delete_system_config_file!
+        delete_config_file system_config_file
+      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
+          return false
+        end
+
+        if File.exist?(config_file)
+          puts "Configuration file (#{config_file}) already exists".yellow
+          return false
+        end
+
+        File.write(config_file, DEFAULT_BRANCH_NAME_OPTIONS.to_yaml)
+        puts "Configuration file (#{config_file}) created".green
+
+        true
+      end
+
+      def delete_config_file(config_file)
+        unless File.exist?(config_file)
+          puts "Configuration file (#{config_file}) does not exist".yellow
+          return false
+        end
+
+        File.delete config_file
+        puts "Configuration file (#{config_file}) deleted".green
 
-        Dir.mkdir(system_config_file) == 0
+        true
       end
     end
   end

data/lib/branch/name/exitable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Branch
   module Name
     module Exitable

data/lib/branch/name/loadable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'yaml'
+require_relative 'configurable'
+
+module Branch
+  module Name
+    module Loadable
+      include Configurable
+
+      def load_options(defaults: {})
+        options = {}
+
+        options.merge!(load_config(system_config_file))
+        options.merge!(load_config(global_config_file))
+        options.merge!(load_config(local_config_file))
+
+        options.presence || defaults
+      end
+
+      def load_config(config_file)
+        return {} unless File.exist? config_file
+
+        yaml_options = File.read(config_file)
+        YAML.safe_load ERB.new(yaml_options).result
+      end
+    end
+  end
+end

data/lib/branch/name/locatable.rb

@@ -11,7 +11,7 @@ module Branch
       def home_folder
         Dir.home
       end
-      alias_method :global_folder, :home_folder
+      alias global_folder home_folder
       singleton_class.alias_method :global_folder, :home_folder
 
       def local_folder
@@ -22,7 +22,7 @@ module Branch
         system_folder = Pathname.new('/')
         unless system_folder.exist? && system_folder.directory?
           puts "WARNING: system folder #{system_folder} does not exist, " \
-            "using global folder instead (#{global_folder})".red
+               "using global folder instead (#{global_folder})".red
 
           return global_folder
         end

data/lib/branch/name/nameable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Branch
+  module Name
+    module Nameable
+      def normalize_branch_name(branch_name)
+        branch_name.strip!
+        branch_name = branch_name.split.join options[:separator]
+        branch_name.downcase! if options[:downcase]
+        branch_name.tr!('_', '-') if options[:separator] == '-'
+        branch_name.tr!('-', '_') if options[:separator] == '_'
+        branch_name.squeeze!('-') if options[:separator] == '-'
+        branch_name.squeeze!('_') if options[:separator] == '_'
+        branch_name
+      end
+    end
+  end
+end

data/lib/branch/name/projectable.rb

@@ -0,0 +1,46 @@
+
+require 'fileutils'
+require_relative 'locatable'
+
+module Branch
+  module Name
+    module Projectable
+      include Locatable
+
+      def create_project!(branch_name)
+        raise 'options[:project] is false' unless options[:project]
+
+        project_folder = "#{options[:project_location]}/#{branch_name}"
+
+        if Dir.exist? project_folder
+          puts "Project folder \"#{project_folder}\" already exists"
+          create_project_files!(project_folder)
+          return
+        end
+
+        Dir.mkdir project_folder
+        create_project_files!(project_folder)
+
+        puts "Project folder \"#{project_folder}\" with project files #{options[:project_files]} was created".green
+      end
+
+      def create_project_files!(project_folder)
+        raise 'options[:project] is false' unless options[:project]
+        raise "Project folder \"#{project_folder}\" does not exist" unless Dir.exist? project_folder
+
+        project_files = options[:project_files]
+
+        return if project_files.blank?
+
+        project_files.each do |project_file|
+          full_file_name = File.join(project_folder, project_file)
+
+          next if File.exist? full_file_name
+
+          FileUtils.touch full_file_name
+          puts "Created project file \"#{full_file_name}\""
+        end
+      end
+    end
+  end
+end

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'colorize'
 require 'thor'
 require_relative '../configurable'
 require_relative '../exitable'
+require_relative 'init'
 
 module Branch
   module Name
@@ -43,6 +43,39 @@ module Branch
             say "System config file does not exist at: \"#{system_folder}\"", :yellow
           end
         end
+
+        desc 'delete [OPTION]', 'Removes .branch-name file(s)'
+        long_desc <<-LONG_DESC
+          NAME
+          \x5
+          `branch-name config delete [OPTION]` -- will remove one or all .branch-name file(s)
+          depending on the OPTION.
+
+          SYNOPSIS
+          \x5
+          branch-name config delete [-a|-g|-l|-s]
+        LONG_DESC
+        method_option :all, type: :boolean, aliases: '-a'
+        method_option :global, type: :boolean, aliases: '-g'
+        method_option :local, type: :boolean, aliases: '-l'
+        method_option :system, type: :boolean, aliases: '-s'
+
+        def delete
+          if options[:all]
+            delete_global_config_file!
+            delete_local_config_file!
+            delete_system_config_file!
+          elsif options[:global]
+            delete_global_config_file!
+          elsif options[:local]
+            delete_local_config_file!
+          elsif options[:system]
+            delete_system_config_file!
+          end
+        end
+
+        desc 'init SUBCOMMAND', 'Sets up config files for this gem'
+        subcommand :init, Branch::Name::Subcommands::Init
       end
     end
   end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'colorize'
 require 'thor'
 require_relative '../configurable'
 require_relative '../exitable'
@@ -15,11 +14,11 @@ module Branch
 
         default_task :global
 
-        desc 'global', 'Creates and initializes a .branch-nameconfig file in the global folder'
+        desc 'global', 'Creates and initializes a .branch-name file in the global folder'
         long_desc <<-LONG_DESC
           NAME
           \x5
-          `branch-name init global` -- will create and initialize a .branch-nameconfig file
+          `branch-name init global` -- will create and initialize a .branch-name file
           in the "#{Locatable.global_folder}" folder.
 
           SYNOPSIS
@@ -27,18 +26,14 @@ module Branch
           branch-name init global
         LONG_DESC
         def global
-          if create_global_config_file!
-            say "Global config file created \"#{global_config_file}\"", :green
-          else
-            say "Global config file already exists \"#{global_config_file}\"", :yellow
-          end
+          create_global_config_file!
         end
 
-        desc 'local', 'Creates and initializes a .branch-nameconfig file in the local folder'
+        desc 'local', 'Creates and initializes a .branch-name file in the local folder'
         long_desc <<-LONG_DESC
           NAME
           \x5
-          `branch-name init local` -- will create and initialize a .branch-nameconfig file
+          `branch-name init local` -- will create and initialize a .branch-name file
           in the "#{Locatable.local_folder}" folder.
 
           SYNOPSIS
@@ -46,18 +41,14 @@ module Branch
           branch-name init local
         LONG_DESC
         def local
-          if create_local_config_file!
-            say "Local config file created \"#{local_config_file}\"", :green
-          else
-            say "Local config file already exists \"#{local_config_file}\"", :yellow
-          end
+          create_local_config_file!
         end
 
-        desc 'system', 'Creates and initializes a .branch-nameconfig file in the system folder'
+        desc 'system', 'Creates and initializes a .branch-name file in the system folder'
         long_desc <<-LONG_DESC
           NAME
           \x5
-          `branch-name init system` -- will create and initialize a .branch-nameconfig file
+          `branch-name init system` -- will create and initialize a .branch-name file
           in the "#{Locatable.system_folder}" folder.
 
           SYNOPSIS
@@ -65,11 +56,7 @@ module Branch
           branch-name init system
         LONG_DESC
         def system
-          # if create_system_config_file!
-          #   say "System config file created \"#{system_config_file}\"", :green
-          # else
-          #   say "System config file already exists \"#{system_config_file}\"", :yellow
-          # end
+          # create_system_config_file!
           say_error 'System initialization is not available at this time', :red
           exit 1
         end

data/lib/branch/name/version.rb

@@ -3,6 +3,6 @@
 module Branch
   module Name
     # branch-name version
-    VERSION = '0.1.0-alpha'
+    VERSION = '1.0.0-beta'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha
+  version: 1.0.0.pre.beta
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,9 +89,13 @@ files:
 - lib/branch/name.rb
 - lib/branch/name/cli.rb
 - lib/branch/name/cli/thor_ext/shell/basic/say_error.rb
+- lib/branch/name/clipable.rb
 - lib/branch/name/configurable.rb
 - lib/branch/name/exitable.rb
+- lib/branch/name/loadable.rb
 - lib/branch/name/locatable.rb
+- lib/branch/name/nameable.rb
+- lib/branch/name/projectable.rb
 - lib/branch/name/subcommands/config.rb
 - lib/branch/name/subcommands/init.rb
 - lib/branch/name/version.rb
@@ -103,6 +107,7 @@ 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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: