firespring_dev_commands 2.1.13.pre.alpha.2 → 2.1.13.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '028cf722c7499e53e14594214f69d2f18ee73e84382ba3001176aac54c4dba7e'
-  data.tar.gz: 2320579264ff63f2defed4959c66d33c609d83d962526b9d4ddcba71d93f11bc
+  metadata.gz: 8f84e05f66ceae5becece425cea392a8f1e0bb7e4f6c7f8ef6d6c7bfe068405e
+  data.tar.gz: 3367ff552bdea261d9612f1a92e10a1f69031e932173ff6e3ae783fa386de968
 SHA512:
-  metadata.gz: 628bfca98898c318750a64182938250285456d6eea834b700a53173ab01810399e2b255e93c8d520e66f7f754cc32d2f4a8f10308589a1f0a9fc3d011cf9a79b
-  data.tar.gz: 70d6f8be02edcdee76def1902378d86106b8bec904e3fd4975a36c7cdcf03e9b0e966b75ca5bbd3f9dd2f0702149e24244968d2dcceab092f14d47fcd70f7dde
+  metadata.gz: 9bea1ed2293666af0990773ad2a38c9c5fe38d37a17773ab8c256a4bf08560f90d7fe7c1c4ecf3048fb3c3e08e9596a352ab9541ad2f587bb573bfdee97315b9
+  data.tar.gz: 3a91544429995e944f13fb12e66e969725614d076a23ee50cac2dacab475b04fe6fc0bffd1ae970773b95db2e79c1b800a9ba0892b774c3ec79ac13943c153e2

data/lib/firespring_dev_commands/common.rb

@@ -40,7 +40,8 @@ module Dev
     # Wraps a block of code in a y/n question.
     # If the user answers 'y' then the block is executed.
     # If the user answers 'n' then the block is skipped.
-    def with_confirmation(message, default = 'y', color_message: true, exit_unconfirmed: true)
+    # @deprecated Please use {Common#when_confirmed} instead
+    def with_confirmation(message, default = 'y', color_message: true)
       message = "\n  #{message}" << '? '.light_green
       message = message.light_green if color_message
       print message
@@ -49,15 +50,89 @@ module Dev
       answer = default
       answer = $stdin.gets unless ENV['NON_INTERACTIVE'] == 'true'
 
-      if answer.strip.casecmp('y').zero?
-        puts
-        yield
-      elsif exit_unconfirmed
+      unless answer.strip.casecmp('y').zero?
         puts "\n  Cancelled.\n".light_yellow
         exit 1
-      else
-        puts
       end
+      puts
+
+      yield
+    end
+
+    # Exits unless the user confirms they want to continue
+    # If the user answers 'y' then the code will continue
+    # All other inputs cause the code to exit
+    def exit_unless_confirmed(message, default: nil, colorize: true)
+      # If a default is given, it must be y or n
+      raise 'invalid default' if default && !%w(y n).include?(default)
+
+      # print the colorized message (if requested) with the default (if given)
+      print(confirmation_message(message, default:, colorize:))
+
+      # Default to the default
+      # Read from stdin unless non_interactive is set to true
+      answer = gather_input(default:)
+
+      return if answer.casecmp('y').zero?
+
+      puts "\n  Cancelled.\n".light_yellow
+      exit 1
+    end
+
+    # Wraps a block of code in a y/n question
+    # If the user answers 'y' then the block is executed
+    # All other inputs cause the block to be skipped
+    def when_confirmed(message, default: nil, colorize: true)
+      # If a default is given, it must be y or n
+      raise 'invalid default' if default && !%w(y n).include?(default)
+
+      # print the colorized message (if requested) with the default (if given)
+      print(confirmation_message(message, default:, colorize:))
+
+      # Default to the default
+      # Read from stdin unless non_interactive is set to true
+      answer = gather_input(default:)
+
+      # Yield to the block if confirmed
+      yield if answer.casecmp('y').zero?
+    end
+
+    # Receive a string from the user on stdin unless non_interactive is set to true
+    # If a default value was specified and no answer was given, return the default
+    def gather_input(default: nil)
+      answer = $stdin.gets.to_s.strip unless ENV['NON_INTERACTIVE'] == 'true'
+      answer.to_s.strip
+      return default if default && answer.empty?
+
+      answer
+    end
+
+    # Build a confirmation message, colorizing each individual part appropriately
+    # Include the default value in the message if one was specified
+    def confirmation_message(question, default:, colorize:)
+      message = conditional_colorize(question, colorize:, color: :light_green)
+      options = conditional_colorize('(', colorize:, color: :light_green)
+      options << conditional_colorize('y', colorize:, color: :light_yellow)
+      options << conditional_colorize('/', colorize:, color: :light_green)
+      options << conditional_colorize('n', colorize:, color: :light_yellow)
+      options << conditional_colorize(')', colorize:, color: :light_green)
+
+      unless default.to_s.strip.empty?
+        options << ' '
+        options << conditional_colorize('[', colorize:, color: :light_green)
+        options << conditional_colorize(default.to_s.strip, colorize:, color: :light_yellow)
+        options << conditional_colorize(']', colorize:, color: :light_green)
+      end
+
+      options << conditional_colorize(':', colorize:, color: :light_green)
+      "#{message} #{options} "
+    end
+
+    # Colorize the string if it has been requested
+    def conditional_colorize(string, colorize:, color:)
+      return string.send(color) if colorize
+
+      string
     end
 
     # Asks for user input using the given message and returns it

data/lib/firespring_dev_commands/version.rb

@@ -6,6 +6,6 @@ module Dev
     # Use 'v.v.v.pre.alpha.v' for pre-release vesions
     # Use 'v.v.v.beta.v for beta versions
     # Use semantic versioning for any releases (https://semver.org/)
-    VERSION = '2.1.13.pre.alpha.2'.freeze
+    VERSION = '2.1.13.pre.alpha.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.13.pre.alpha.2
+  version: 2.1.13.pre.alpha.3
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-11 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport