branch-name 3.10.4 → 3.10.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e4530135fd14912b126a23e3db17710d647c80b97b38b7320c3d93c385c16fb
-  data.tar.gz: d87d2863a7999bb093630e013c94959bfa2351947ac696be448e59d71853a5b0
+  metadata.gz: '0578a4f2c431daabe0d6de987fc512f6fd08484bfb1bc3c69be72b48bdc9d610'
+  data.tar.gz: 7888b0ff8f0db646740779e3813ed29b8f27203b0ebdfa0255155cbd442a88eb
 SHA512:
-  metadata.gz: 1641bc9f6cd8d9b98a0fd80d910af2c59f332dcd2df6d1bc87b8f2dbde98d9aedf810a4cdea0d53982789afd20a242c8ef5c7c7c7b3aa4911876f1872560cd4b
-  data.tar.gz: 858eb02458c7324a8c9020e7dd8dfe0236e6c865dee2c5577c35fdeb20feb5cde0c8ae4b70e09aa9368d7d6aa2e3581a92a29130d75a534f164e711cf69711e1
+  metadata.gz: 2946f11df45515c6a49d6dafa1a35d162735dc2ffedadc9a52d282ce08c6a8890bbccaea02ef0c8f795f7dacf346f9f3f9c7a2f916d67d7601258a48e81e9e1d
+  data.tar.gz: 28e378e1513c22d839b49387c44fd5cc5329bd7cfe2148ec55703a23591f66e4df52e57159d361e3a4294037d9bc7be70a3222949851028abf17ddb11843c6c0

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## ['3.10.6'] - 2023-12-02
+
+Changes
+
+- Update gems.
+
+## ['3.10.5'] - 2023-11-03
+
+Changes
+
+- Various code refactors.
+- Update gems.
+
 ## ['3.10.4'] - 2023-11-01
 
 Changes

data/Gemfile

@@ -5,11 +5,14 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in branch-name.gemspec
 gemspec
 
+gem 'dotenv', '~> 2.8', '>= 2.8.1'
 gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
 gem 'rake', '~> 13.0', '>= 13.0.6'
 gem 'reek', '~> 6.1', '>= 6.1.4'
 gem 'rspec', '~> 3.12'
+gem 'rspec-activemodel-mocks', '~> 1.1'
 gem 'rubocop', '~> 1.56.0'
 gem 'rubocop-performance', '~> 1.19'
 gem 'rubocop-rspec', '~> 2.23', '>= 2.23.2'
+gem 'shoulda-matchers', '~> 5.3'
 gem 'simplecov', '~> 0.22.0'

data/Gemfile.lock

@@ -1,36 +1,49 @@
 PATH
   remote: .
   specs:
-    branch-name (3.10.4)
-      activesupport (~> 7.0.8)
-      colorize (>= 0.8.1, < 1.2.0)
-      os (~> 1.1, >= 1.1.4)
-      thor (~> 1.2, >= 1.2.2)
-      thor_nested_subcommand (~> 1.0, >= 1.0.1)
+    branch-name (3.10.6)
+      activesupport (>= 7.0.8, < 8.0.0)
+      colorize (>= 1.1.0, < 2.0)
+      os (>= 1.1, < 2.0)
+      thor (>= 1.2, < 2.0)
+      thor_nested_subcommand (>= 1.0, < 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.8)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.1.1)
+    bigdecimal (3.1.4)
     byebug (11.1.3)
     coderay (1.1.3)
     colorize (1.1.0)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    dotenv (2.8.1)
+    drb (2.2.0)
+      ruby2_keywords
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
+    json (2.7.0)
     kwalify (0.7.2)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
     minitest (5.20.0)
+    mutex_m (0.2.0)
     os (1.1.4)
     parallel (1.23.0)
     parser (3.2.2.4)
@@ -42,7 +55,7 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    racc (1.7.2)
+    racc (1.7.3)
     rainbow (3.1.1)
     rake (13.1.0)
     reek (6.1.4)
@@ -55,6 +68,10 @@ GEM
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
+    rspec-activemodel-mocks (1.1.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      rspec-mocks (>= 2.99, < 4.0)
     rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
     rspec-expectations (3.12.3)
@@ -90,6 +107,9 @@ GEM
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    shoulda-matchers (5.3.0)
+      activesupport (>= 5.2.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -97,7 +117,7 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     thor (1.3.0)
-    thor_nested_subcommand (1.0.2)
+    thor_nested_subcommand (1.0.4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
@@ -109,13 +129,16 @@ PLATFORMS
 
 DEPENDENCIES
   branch-name!
+  dotenv (~> 2.8, >= 2.8.1)
   pry-byebug (~> 3.10, >= 3.10.1)
   rake (~> 13.0, >= 13.0.6)
   reek (~> 6.1, >= 6.1.4)
   rspec (~> 3.12)
+  rspec-activemodel-mocks (~> 1.1)
   rubocop (~> 1.56.0)
   rubocop-performance (~> 1.19)
   rubocop-rspec (~> 2.23, >= 2.23.2)
+  shoulda-matchers (~> 5.3)
   simplecov (~> 0.22.0)
 
 BUNDLED WITH

data/bin/console

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'pry-byebug'
 require 'bundler/setup'
 require 'branch/name/cli'
 

data/exe/branch-name

@@ -6,6 +6,6 @@ require 'rubygems'
 lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-require 'branch/name/cli'
+require 'branch/name'
 
 Branch::Name::CLI.start

data/lib/.env.development

@@ -0,0 +1 @@
+BRANCH_NAME_ENV=development

data/lib/branch/name/cli.rb

@@ -11,6 +11,7 @@ require_relative 'loadable'
 require_relative 'locatable'
 require_relative 'normalizable'
 require_relative 'projectable'
+require_relative 'services/branch_name_service'
 require_relative 'subcommands/config'
 require_relative 'task_defaultable'
 require_relative 'version'
@@ -25,10 +26,15 @@ module Branch
       include Exitable
       include Loadable
       include Locatable
-      include Normalizable
       include Projectable
       include TaskDefaultable
 
+      class << self
+        def exit_on_failure?
+          true
+        end
+      end
+
       class_option :debug, type: :boolean, default: false
       class_option :verbose, type: :boolean, default: false
 
@@ -93,11 +99,9 @@ module Branch
       method_option :interactive, type: :boolean, optional: true, aliases: '-i'
 
       def create(ticket_description, ticket = nil)
-        validate_ticket_description! ticket_description
         original_options, altered_options = init_options_for! command: :create
         self.options = altered_options
-
-        branch_name = validate_and_normalize_branch_name(ticket_description, ticket)
+        branch_name = BranchNameService.new(description: ticket_description, ticket: ticket, options: options).call
         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 original_options[:interactive] && !options[:project]
@@ -121,6 +125,9 @@ module Branch
           say "Project folder name: \"#{project_folder_name}\"", :cyan
           create_project!(project_folder_name)
         end
+      rescue ArgumentError => e
+        say_error e.message, ERROR
+        exit 1
       end
 
       desc 'config SUBCOMMAND', 'Manages config files for this gem'
@@ -133,20 +140,6 @@ module Branch
 
       private
 
-      def validate_ticket_description!(ticket_description)
-        return unless ticket_description.blank?
-
-        say_error 'description is required', ERROR
-        exit 1
-      end
-
-      def validate_and_normalize_branch_name(ticket_description, ticket)
-        normalize_branch_name(ticket_description, ticket) do |error|
-          say_error error.message
-          exit 1
-        end
-      end
-
       def validate_and_create_project_folder_name_from!(branch_name)
         project_folder_name_from(branch_name) do |error|
           say_error error.message

data/lib/branch/name/models/branch.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module Branch
+  module Name
+    module Models
+      attr_reader :description, :ticket
+
+      class Branch
+        include ActiveModel::Model
+
+        attr_accessor :description, :ticket
+
+        validates :description, presence: true
+
+        def initialize(description:, ticket: nil, options: {})
+          @description  = description
+          @ticket       = ticket
+          @options      = options
+
+          super(description: description, ticket: ticket)
+        end
+
+        def branch_name
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/branch/name/services/branch_name_service.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../colorizable'
+require_relative '../normalizable'
+
+module Branch
+  module Name
+    class BranchNameService
+      include Colorizable
+      include Normalizable
+
+      def initialize(description:, ticket: nil, options: {})
+        @description  = description
+        @ticket       = ticket
+        @options      = options
+      end
+
+      def call
+        validate_description!
+        @branch_name = normalize_branch_name!
+        validate_banch_name!
+        @branch_name
+      end
+
+      private
+
+      attr_reader :options
+
+      def normalize_branch_name!
+        normalize_branch_name(@description, @ticket) do |error|
+          raise ArgumentError, error.message
+        end
+      end
+
+      def validate_description!
+        return unless @description.blank?
+
+        raise ArgumentError, 'description is required'
+      end
+
+      def validate_banch_name!
+        return unless @branch_name.blank?
+
+        raise ArgumentError, invalid_branch_name_message
+      end
+
+      def invalid_branch_name_message
+        'the combination of description/ticket resulted in an empty branch name'
+      end
+    end
+  end
+end

data/lib/branch/name/version.rb

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

data/lib/branch/name.rb

@@ -1,3 +1,15 @@
 # frozen_string_literal: true
 
-require_relative 'name/version'
+require 'active_support/core_ext/object/blank'
+
+if File.exist?("#{__dir__}/lib/.env.development")
+  # This loads our development environment when running dev.
+  require 'dotenv'
+  Dotenv.load('.env.development')
+end
+
+require 'pry-byebug' if ENV['BRANCH_NAME_ENV'] == 'development'
+
+Dir.glob("#{__dir__}/name/**/*.rb").each do |file|
+  require file
+end

metadata

@@ -1,109 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 3.10.4
+  version: 3.10.6
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2023-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 1.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 1.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: thor_nested_subcommand
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.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:
 
@@ -130,6 +136,7 @@ files:
 - bin/console
 - bin/setup
 - exe/branch-name
+- lib/.env.development
 - lib/branch/name.rb
 - lib/branch/name/cli.rb
 - lib/branch/name/cli/thor_ext/shell/basic/say_error.rb
@@ -139,9 +146,11 @@ files:
 - lib/branch/name/exitable.rb
 - lib/branch/name/loadable.rb
 - lib/branch/name/locatable.rb
+- lib/branch/name/models/branch.rb
 - lib/branch/name/normalizable.rb
 - lib/branch/name/option_error.rb
 - lib/branch/name/projectable.rb
+- lib/branch/name/services/branch_name_service.rb
 - lib/branch/name/subcommands/config.rb
 - lib/branch/name/subcommands/delete.rb
 - lib/branch/name/subcommands/init.rb