branch-name 2.0.0.pre.beta → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 166d6b67749f23a48cca5435c6b4b923d57b9e8f4e716ff61c5765da932b686a
-  data.tar.gz: e5c041c60834c56da210d0843e0bf099e62fa21adb120f46a1d58b07793f2cbb
+  metadata.gz: 56671e5fc00e4ad0045dad3658a70038a878d4352fb711c8aad559d5132516ff
+  data.tar.gz: 7317863bb70d45b73df3c64ff0e6a73251e6245a920b1e99f21fa7ffa9b31a95
 SHA512:
-  metadata.gz: 48334163ec2756cdebfd45344ec91b34e602d0b78573e52aa61418ff8915b77107513e3745cf0cd10c353cb84f669993ff0835c37b964500405c67b9b46cc9ce
-  data.tar.gz: f3ec35602f29a9edcd699383697fcb5aac3773122f9db42f82dc7748f646fa2c20bedf6fbaf0cb48d716b93a6d154ce2d5c1a5e34a657f0ea8d6c23265bff976
+  metadata.gz: 9078aa3f683ff648fcfe3a4d37ac4e0f39346d13f207a82c32e2c090c1549914626d225114985ff23190203daf101226af4aa4494e8ba340ef73f600f5b98ed3
+  data.tar.gz: cd69167ddb0f89e7e70e68d8c936ee9aa2c411445f31e46cd624cbc5ee7664247ecd0619d66d5e04fb50d3ef8a2f53e773411eecca96ab3a635b42e579be94e7

data/CHANGELOG.md

@@ -1,5 +1,5 @@
-## [Unreleased]
+## ['2.1.0'] - 2022-09-22
+* Enhancements: Add support for Windows clipboard. Branch names created are copied to the clibboard for macOS and Windows now.
 
-## [0.1.0] - 2022-09-15
-
-- Initial release
+## ['2.0.1-beta] - 2022-09-20
+* Bug fixes: ticket description was not joined properly (without token separator).

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    branch-name (2.0.0.pre.beta)
+    branch-name (2.1.0)
       activesupport (~> 7.0, >= 7.0.4)
       colorize (~> 0.8.1)
+      os (~> 1.1, >= 1.1.4)
       thor (~> 1.2, >= 1.2.1)
 
 GEM
@@ -27,6 +28,7 @@ GEM
     kwalify (0.7.2)
     method_source (1.0.0)
     minitest (5.16.3)
+    os (1.1.4)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)

data/README.md

@@ -8,9 +8,9 @@
 
 ## Caveats
 
-NOTE: This documentation assumes *macos* and any reference to `<username>` should be assumed to equal `$ whoami` unless otherwise noted.
+NOTE: This documentation assumes *macOS* and any reference to `<username>` should be assumed to equal `$ whoami` unless otherwise noted.
 
-NOTE: This documentation makes reference to *cards* and/or *tickets*; these terms should be considered synonymous, and are used to refer to *user stories*, *tasks*, *bugs*, etc.: work that is normally created against a software development team's [Jira](https://www.atlassian.com/software/jira) Project board while adhering to [Agile development methodology](https://www.atlassian.com/agile#:~:text=Agile%20is%20an%20iterative%20approach,small%2C%20but%20consumable%2C%20increments.). While `branch-name` was created to be used while practicing Agile, `branch-name` can be used outside the Agile context as well.
+NOTE: This documentation makes reference to *cards* and/or *tickets*; these terms should be considered synonymous, and are used to refer to *user stories*, *tasks*, *bugs*, etc.; that is, work that is normally created against a software development team's [Jira](https://www.atlassian.com/software/jira) Project board while adhering to [Agile development methodology](https://www.atlassian.com/agile#:~:text=Agile%20is%20an%20iterative%20approach,small%2C%20but%20consumable%2C%20increments.). While `branch-name` was created to be used while practicing Agile, `branch-name` can be used outside the Agile context as well.
 
 
 ## Installation
@@ -19,7 +19,7 @@ NOTE: This documentation makes reference to *cards* and/or *tickets*; these term
 
 ## Usage/Examples
 
-### `branch-name` help
+### `branch-name` Help
 ```shell
 # Display general branch-name help
 $ branch-name help
@@ -34,7 +34,7 @@ $ branch-name config help init
 $ branch-name config help delete
 ```
 
-### Initialize `branch-name` configuration files
+### Initialize `branch-name` Configuration Files
 Setting up *global* settings would be a good place to start:
 
 ```
@@ -42,7 +42,7 @@ $ branch-name config init global
 #=> Configuration file (/Users/<username>/.branch-name) created
 ```
 
-This creates a `.branch-name` .yaml configuration file the home folder of the current user (`$ whoami` on *macos*) with the following option defaults. The option defaults created will be used with their respective `branch-name` command indicated by the `branch-name` command name under which each option resides. You may manually alter any of the option values to suite your needs. To determine what options are available for each `branch-name` command, simply view help for that particular command. If a `brnch-name` command is *not* found in the `.branch-name` confg file when it is first initialized (e.g. `$ branch-name config init global #=> /Users/<username>/.branch-name`), default options for that particular `branch-name` command is not currently supported.
+This creates a `.branch-name` .yaml configuration file the home folder of the current user (`$ whoami` on *macOS*) with the following option defaults. The option defaults created will be used with their respective `branch-name` command indicated by the `branch-name` command name under which each option resides. You may manually alter any of the option values to suite your needs. To determine what options are available for each `branch-name` command, simply view help for that particular command. If a `brnch-name` command is *not* found in the `.branch-name` confg file when it is first initialized (e.g. `$ branch-name config init global #=> /Users/<username>/.branch-name`), default options for that particular `branch-name` command are not currently supported.
 
 For example, the following default options will be used whenever the `branch-name create` command is executed for the user "`<username>`":
 
@@ -59,7 +59,7 @@ create:
   - readme.txt
   ```
 
-NOTE: It is recommended that you change the default `create: project_location` to a more suitable location depending on your *os*. For example, on *macos* you might want to change this to `"/Users/<username>/Documents"`, `"/Users/<username>/Documents/features"`, or something similar.
+NOTE: It is recommended that you change the default `create: project_location` to a more suitable location depending on your *os*. For example, on *macOS* you might want to change this to `"/Users/<username>/Documents"`, `"/Users/<username>/Documents/features"`, or something similar.
 
 Any or all of these options can be overwritten on the command-line:
 
@@ -86,7 +86,7 @@ create:
   - snippets.rb
   ```
 
-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. This is convienient 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*. 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

data/branch-name.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '~> 7.0', '>= 7.0.4'
   spec.add_dependency 'colorize', '~> 0.8.1'
+  spec.add_dependency 'os', '~> 1.1', '>= 1.1.4'
   spec.add_dependency 'thor', '~> 1.2', '>= 1.2.1'
 
   # Remove this for now.

data/lib/branch/name/clipable.rb

@@ -1,16 +1,36 @@
 # frozen_string_literal: true
 
+require 'os'
+
 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 }
+        if OS.mac?
+          copy_to_clipboard_macos text
+          true
+        elsif OS.windows?
+          copy_to_clipboard_windows text
           true
+        else
+          false
         end
       end
+
+      def copy_to_clipboard_macos(text)
+        copy_to_clipboard_with(app: 'pbcopy', text: text)
+
+      end
+
+      def copy_to_clipboard_windows(text)
+        copy_to_clipboard_with(app: 'clip', text: text)
+      end
+
+      def copy_to_clipboard_with(app:, text:)
+        IO.popen(app, 'w') { |pipe| pipe.puts text }
+      end
     end
   end
 end

data/lib/branch/name/locatable.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/object/blank'
 require 'colorize'
 require 'pathname'
 

data/lib/branch/name/normalizable.rb

@@ -3,7 +3,7 @@
 module Branch
   module Name
     module Normalizable
-      NON_WORD_CHARS_REGEX = /[^\w]/
+      NON_WORD_CHARS_REGEX = /[\W_]/
 
       def normalize_branch_name(ticket_description, ticket)
         normalized_ticket_description = normalize_ticket_description ticket_description
@@ -26,10 +26,10 @@ module Branch
       end
 
       def normalize_token(token)
+        token = token.gsub(NON_WORD_CHARS_REGEX, ' ')
         token = token.strip
           .squeeze(' ')
           .split.join(options[:separator])
-        token = token.gsub(NON_WORD_CHARS_REGEX, '')
         token = token.squeeze(options[:separator])
         token = token.downcase if options[:downcase]
         token

data/lib/branch/name/version.rb

@@ -3,6 +3,6 @@
 module Branch
   module Name
     # branch-name version
-    VERSION = '2.0.0-beta'
+    VERSION = '2.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branch-name
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.beta
+  version: 2.1.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,6 +44,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !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
+  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
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -119,9 +139,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.22
 signing_key: