philiprehberger-cli_kit 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15240e9c9eb6ad374dafd6457c91e3d1514b34031ccb57f00b4283b266bf3575
-  data.tar.gz: 77fd549d9211ab095433cebe4938db8fd1188e1cffb124c19c91a77e5ce428a8
+  metadata.gz: c4606c83ce0c95c7b047c9db662457bce97852169987a96a44566d4811e78313
+  data.tar.gz: 907327c09e57175ca6e1c07d03369fdfe5f157534836e64acf348b79dc439a5e
 SHA512:
-  metadata.gz: b18bf81377d13116b703b5938d8e0b6c84e18272570d1f0eb2b598f125d80d0f603298735445873445882e073d504c25694313c7604157b907817c908b71417f
-  data.tar.gz: 636957466367093c8cdd87305abcffb8523633182e513223f50898d876e3c93e2d3dab4c0a1290350c344d8f6d04d53f66cce5b097b609990e4907f10a54d931
+  metadata.gz: '08bb60e7b9c05a9e6d5572a8a393f61b987c07a136f7cb1eaf6e6ac58168fea50230f5855d073c47bd0516b178d19e138d223ccc7ff4e529248b9aef16f08699'
+  data.tar.gz: 20864d8ed45d20aabe85d072ba1adcb44590c76f346329e51314b4163bce07951b2759327ef852112bccaec05f82705e28b5534502d5b5dde6e2b0efaddb4733

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-04-18
+
+### Added
+- `option :name, required: true` — DSL flag that raises `CliKit::Error` at parse time when the option is omitted; help output appends `(required)` to the option's description
+
+## [0.3.1] - 2026-04-15
+
+### Changed
+- Compliance audit against Ruby package, gemspec, and README guides — no blocking issues found; reaffirmed gemspec metadata (5 URIs, `rubygems_mfa_required`, `required_ruby_version >= 3.1.0`, `Dir['lib/**/*.rb', 'LICENSE', 'README.md', 'CHANGELOG.md']`), README structure (10 sections with 3 badges and emoji Support list), Keep a Changelog format, full `.github/` scaffolding (issue templates, dependabot, PR template, CI matrix with publish job), and config files (`.rubocop.yml`, `.gitignore`, `Gemfile`, `Rakefile`)
+
 ## [0.3.0] - 2026-04-15
 
 ### Added
@@ -58,7 +68,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Animated spinner for long-running operations
 - Positional argument collection
 
-[Unreleased]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.2.1...v0.3.0
 [0.2.1]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.1.2...v0.2.0

data/README.md

@@ -105,6 +105,20 @@ port = Philiprehberger::CliKit.ask('Port:', error: 'Must be a number') do |answe
 end
 ```
 
+### Required options
+
+```ruby
+result = Philiprehberger::CliKit.parse(ARGV) do
+  option :env, short: :e, required: true, desc: 'Target environment'
+end
+
+# Invoked without --env raises Philiprehberger::CliKit::Error:
+#   Missing required option(s): --env
+#
+# Help text appends "(required)" to the option's description:
+#   -e, --env VALUE     Target environment (required)
+```
+
 ### Repeatable Options
 
 ```ruby
@@ -176,6 +190,7 @@ end
 | `.multi_select(message, choices, defaults:)` | Present numbered menu and return multiple selections |
 | `.spinner(message) { ... }` | Show spinner during block execution |
 | `Parser#option(name, multi: true)` | Collect repeated option values into an array |
+| `Parser#option(name, required: true)` | Raise `CliKit::Error` at parse time when the option is omitted |
 | `Parser#flags` | Hash of boolean flag values |
 | `Parser#options` | Hash of option values (arrays when `multi: true`) |
 | `Parser#arguments` | Array of positional arguments |

data/lib/philiprehberger/cli_kit/parser.rb

@@ -13,6 +13,7 @@ module Philiprehberger
         @flags = {}
         @options = {}
         @arguments = []
+        @supplied_options = []
         @command_name = nil
         @program_name = nil
       end
@@ -35,9 +36,12 @@ module Philiprehberger
       # @param default [Object, nil] default value
       # @param desc [String, nil] description for help text
       # @param multi [Boolean] when true, collect repeated values into an array
+      # @param required [Boolean] when true, raise if the option is not supplied at parse time
       # @return [void]
-      def option(name, short: nil, default: nil, desc: nil, multi: false)
-        @option_definitions[name] = { short: short, default: default, desc: desc, multi: multi }
+      def option(name, short: nil, default: nil, desc: nil, multi: false, required: false)
+        @option_definitions[name] = {
+          short: short, default: default, desc: desc, multi: multi, required: required
+        }
         @options[name] = multi ? [] : default
       end
 
@@ -131,6 +135,7 @@ module Philiprehberger
             @arguments << arg
           end
         end
+        validate_required_options!
         self
       end
 
@@ -172,6 +177,7 @@ module Philiprehberger
 
       def assign_option(name, value)
         defn = @option_definitions[name]
+        @supplied_options << name
         if defn && defn[:multi]
           @options[name] = [] unless @options[name].is_a?(Array)
           @options[name] << value unless value.nil?
@@ -180,6 +186,16 @@ module Philiprehberger
         end
       end
 
+      def validate_required_options!
+        missing = @option_definitions.each_with_object([]) do |(name, defn), acc|
+          acc << name if defn[:required] && !@supplied_options.include?(name)
+        end
+        return if missing.empty?
+
+        names = missing.map { |n| "--#{n.to_s.tr('_', '-')}" }.join(', ')
+        raise Error, "Missing required option(s): #{names}"
+      end
+
       def format_flag_help(name, defn)
         long = "--#{name.to_s.tr('_', '-')}"
         if defn[:short]
@@ -204,8 +220,10 @@ module Philiprehberger
         else
           label = "      #{long}"
         end
-        if defn[:desc]
-          "#{label.ljust(24)}#{defn[:desc]}"
+        desc = defn[:desc]
+        desc = desc ? "#{desc} (required)" : '(required)' if defn[:required]
+        if desc
+          "#{label.ljust(24)}#{desc}"
         else
           label
         end

data/lib/philiprehberger/cli_kit/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module CliKit
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-cli_kit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-15 00:00:00.000000000 Z
+date: 2026-04-19 00:00:00.000000000 Z
 dependencies: []
 description: Lightweight CLI toolkit combining argument parsing with flags and options,
   interactive prompts with confirmation, and animated spinners for long-running operations.