cli_class_tool 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79f28a830c3277c28e747b142fb6a12d40c8a69e5b868c4fef7f58e296f79dce
-  data.tar.gz: ca5b3535463ee163b56c2cdda397dd925111ea325d6695268c78acf5091b19cc
+  metadata.gz: 26a3ec0d29127e28be8a7f8d5cdeccf36dbe19fa2ef06d7cd11f82caf4963dd8
+  data.tar.gz: 8a210596d6735be7f3a5f41df93b43c023b46315055f5c5622c833e0de743da8
 SHA512:
-  metadata.gz: 467252b31976d4fcb70cc795dc5ceaa06d2ad24576cd75a8b5ffaef3c3d5ef93f945da0f45414dfa40a80aeb7e3f5f882308ac8e48f5b2d4629267a6254eb078
-  data.tar.gz: 8abc7831b9c862d928ca3632a7b9d9f99e289b5058af2fe7c095cec6845a617de7d6111f8357f879b95c79711733ede70a93e86127abaa65e3e43e0861605bb9
+  metadata.gz: 72e72cbdcbaf6eac25b87f57ae63f628e4ea28b7e7093d7473fc5324751b459de25a6f49986c10ae7ded00390f57b0534c502e49a80471340d9cf54bd22600fb
+  data.tar.gz: 18df3b843eae58f00e46eddcc24b3c38183c57dfcf835a57bc21f0ec12ecca967d1e4712c100810b80c4e4dba3fa2b6f1c2de4ceb5e6dda49ea08e48b5ce8f4d

data/CHANGELOG

@@ -1,3 +1,9 @@
+------------------
+1.0.0  (2026-09-09)
+------------------
+
+* Switch confirm to optional hash-style arguments (:ignored_default, :allowed_reps, :usage), dropping legacy positional arguments
+
 ------------------
 0.5.1  (2026-09-07)
 ------------------

data/README.md

@@ -179,6 +179,34 @@ By inheriting from `CLIClassTool::Common`, your action classes have access to a
 
 ---
 
+## User Confirmation (`confirm`)
+
+`CLIClassTool::Common` provides an inherited `confirm(opts, msg, confirm_opts = {})` helper method to prompt the user for interactive confirmation or automatically reply when `-y`/`--yes` or `-n`/`--no` CLI flags are set.
+
+```ruby
+# Basic confirmation
+confirm(opts, "delete this branch")
+# => Do you wish to delete this branch ? (y/n):
+
+# Custom usage string printed in the prompt
+confirm(opts, "apply changes", usage: "y/N")
+# => Do you wish to apply changes ? (y/N):
+
+# Custom allowed responses and custom usage
+confirm(opts, "select conflict resolution", allowed_reps: ["y", "n", "a"], usage: "y/n/all")
+# => Do you wish to select conflict resolution ? (y/n/all):
+
+# Ignore CLI -y/--yes and -n/--no options to force interactive input
+confirm(opts, "format the disk", ignored_default: true)
+```
+
+### Supported Options:
+- `:usage` (`String` or `Array<String>`): Custom usage string to display instead of `#{allowed_reps.join("/")}`.
+- `:ignored_default` / `:ignore_default` (`Boolean`, default: `false`): If `true`, ignores `opts[:yn_default]` set by `--yes` or `--no`.
+- `:allowed_reps` (`Array<String>`, default: `["y", "n"]`): List of acceptable user responses.
+
+---
+
 ## Dynamic Class Overrides (Addons)
 
 `CLIClassTool` natively supports dynamic class overrides (addons). This allows projects to load repository-specific or custom subclasses that extend or override base action behaviors without modifying the core codebase.

data/lib/cli_class_tool/common.rb

@@ -77,14 +77,29 @@ module CLIClassTool
         #
         # @param opts [Hash] Options hash
         # @param msg [String] Confirmation message
-        # @param ignore_default [Boolean] Ignore default yes/no options
-        # @param allowed_reps [Array<String>] Allowed responses
+        # @param confirm_opts [Hash] Optional confirmation options
+        # @option confirm_opts [Boolean] :ignored_default (false) Ignore default yes/no options
+        # @option confirm_opts [Boolean] :ignore_default (false) Alias for :ignored_default
+        # @option confirm_opts [Array<String>] :allowed_reps (["y", "n"]) Allowed responses
+        # @option confirm_opts [String, Array<String>] :usage Custom usage string or list to display instead of allowed_reps.join("/")
         # @return [String] User response
-        def confirm(opts, msg, ignore_default=false, allowed_reps=[ "y", "n" ])
-            rep = 't'
+        def confirm(opts, msg, confirm_opts = {})
+            raise ArgumentError, "confirm options must be a Hash" unless confirm_opts.is_a?(Hash)
+
+            conf_opts = confirm_opts.transform_keys(&:to_sym)
+
+            ignored_default = conf_opts[:ignored_default]
+            ignored_default = conf_opts[:ignore_default] if ignored_default.nil?
+            ignored_default = false if ignored_default.nil?
+
+            allowed_reps = (conf_opts[:allowed_reps] || [ "y", "n" ]).map(&:to_s)
+            usage = conf_opts[:usage]
+            usage_str = usage ? (usage.is_a?(Array) ? usage.join("/") : usage.to_s) : allowed_reps.join("/")
+
+            rep = nil
             while allowed_reps.index(rep) == nil && rep != '' do
-                puts "Do you wish to #{msg} ? (#{allowed_reps.join("/")}): "
-                case (ignore_default == true ? nil : opts[:yn_default])
+                puts "Do you wish to #{msg} ? (#{usage_str}): "
+                case (ignored_default == true ? nil : opts&.[](:yn_default))
                 when :no
                     puts "Auto-replying no due to --no option"
                     rep = 'n'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cli_class_tool
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Nicolas Morey
 bindir: bin
 cert_chain: []
-date: 2026-09-07 00:00:00.000000000 Z
+date: 2026-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake