philiprehberger-cli_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f8c44f068b8daee68d4a4f0e2d862a27b8cc9d068ed0c13f1d00c8bca158555
+  data.tar.gz: 8a28c59097b7b571375e39f955d7513d1b94f8f193a1f0d9a319086ed085daad
+SHA512:
+  metadata.gz: 0bafa11c4295d54dacdfb375b98869763d4f39f71dec7dbd30577176c52a77673fb53bcae5f4497b700ea566d5029bdf03f680749496edc851c5e4c82c27c09e
+  data.tar.gz: cd0591f45daddb536940b7398d6d768856ed05b83f185474095af37b6c59d9c0d5c1204cb4dae41fefcbb1c420a6581dc9f22e1f594438f0c1f005fb61c2b76e

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-22
+
+### Added
+- Initial release
+- DSL-based argument parser with flags and options
+- Short and long option aliases
+- Interactive prompt for text input
+- Yes/no confirmation prompt
+- Animated spinner for long-running operations
+- Positional argument collection

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# philiprehberger-cli_kit
+
+[![Tests](https://github.com/philiprehberger/rb-cli-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-cli-kit/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-cli_kit.svg)](https://rubygems.org/gems/philiprehberger-cli_kit)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-cli-kit)](LICENSE)
+
+All-in-one CLI toolkit with argument parsing, prompts, and spinners
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "philiprehberger-cli_kit"
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-cli_kit
+```
+
+## Usage
+
+```ruby
+require "philiprehberger/cli_kit"
+
+result = Philiprehberger::CliKit.parse(ARGV) do
+  flag :verbose, short: :v
+  option :output, short: :o, default: 'out.txt'
+end
+
+result.flags[:verbose]    # => true/false
+result.options[:output]   # => 'out.txt' or user-provided value
+result.arguments          # => remaining positional args
+```
+
+### Prompts
+
+```ruby
+name = Philiprehberger::CliKit.prompt('What is your name?')
+# What is your name? _
+
+confirmed = Philiprehberger::CliKit.confirm('Continue?')
+# Continue? [y/n] _
+```
+
+### Spinners
+
+```ruby
+data = Philiprehberger::CliKit.spinner('Loading data...') do
+  # long-running operation
+  fetch_remote_data
+end
+```
+
+### Argument Parsing Details
+
+```ruby
+# Given: mytool --verbose -o report.csv input.txt
+result = Philiprehberger::CliKit.parse(%w[--verbose -o report.csv input.txt]) do
+  flag :verbose, short: :v
+  option :output, short: :o, default: 'out.txt'
+end
+
+result.flags[:verbose]    # => true
+result.options[:output]   # => 'report.csv'
+result.arguments          # => ['input.txt']
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `.parse(args) { ... }` | Parse arguments with flag/option DSL |
+| `.prompt(message)` | Display prompt and read input |
+| `.confirm(message)` | Display yes/no confirmation |
+| `.spinner(message) { ... }` | Show spinner during block execution |
+| `Parser#flags` | Hash of boolean flag values |
+| `Parser#options` | Hash of option values |
+| `Parser#arguments` | Array of positional arguments |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec
+bundle exec rubocop
+```
+
+## License
+
+MIT

data/lib/philiprehberger/cli_kit/parser.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CliKit
+    # DSL-based argument parser for CLI applications.
+    class Parser
+      attr_reader :flags, :options, :arguments
+
+      def initialize
+        @flag_definitions = {}
+        @option_definitions = {}
+        @flags = {}
+        @options = {}
+        @arguments = []
+      end
+
+      # Define a boolean flag.
+      #
+      # @param name [Symbol] the flag name
+      # @param short [Symbol, nil] short alias (single character)
+      # @return [void]
+      def flag(name, short: nil)
+        @flag_definitions[name] = { short: short }
+        @flags[name] = false
+      end
+
+      # Define a value option.
+      #
+      # @param name [Symbol] the option name
+      # @param short [Symbol, nil] short alias (single character)
+      # @param default [Object, nil] default value
+      # @return [void]
+      def option(name, short: nil, default: nil)
+        @option_definitions[name] = { short: short, default: default }
+        @options[name] = default
+      end
+
+      # Parse the given argument array.
+      #
+      # @param args [Array<String>] command-line arguments
+      # @return [self]
+      def parse(args)
+        args = args.dup
+        while args.any?
+          arg = args.shift
+          if arg.start_with?('--')
+            parse_long(arg, args)
+          elsif arg.start_with?('-') && arg.length > 1
+            parse_short(arg, args)
+          else
+            @arguments << arg
+          end
+        end
+        self
+      end
+
+      private
+
+      def parse_long(arg, args)
+        name = arg.sub(/\A--/, '').tr('-', '_').to_sym
+        if @flag_definitions.key?(name)
+          @flags[name] = true
+        elsif @option_definitions.key?(name)
+          @options[name] = args.shift
+        end
+      end
+
+      def parse_short(arg, args)
+        char = arg.sub(/\A-/, '').to_sym
+
+        @flag_definitions.each do |name, defn|
+          if defn[:short] == char
+            @flags[name] = true
+            return
+          end
+        end
+
+        @option_definitions.each do |name, defn|
+          if defn[:short] == char
+            @options[name] = args.shift
+            return
+          end
+        end
+      end
+    end
+  end
+end

data/lib/philiprehberger/cli_kit/prompt.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CliKit
+    # Interactive prompt utilities for CLI applications.
+    module Prompt
+      # Display a prompt and read user input.
+      #
+      # @param message [String] the prompt message
+      # @param input [IO] input stream (default: $stdin)
+      # @param output [IO] output stream (default: $stdout)
+      # @return [String] the user's input, stripped of whitespace
+      def self.prompt(message, input: $stdin, output: $stdout)
+        output.print "#{message} "
+        output.flush
+        input.gets&.strip || ''
+      end
+
+      # Display a yes/no confirmation prompt.
+      #
+      # @param message [String] the confirmation message
+      # @param input [IO] input stream (default: $stdin)
+      # @param output [IO] output stream (default: $stdout)
+      # @return [Boolean] true if user answered yes
+      def self.confirm(message, input: $stdin, output: $stdout)
+        output.print "#{message} [y/n] "
+        output.flush
+        answer = input.gets&.strip&.downcase || ''
+        %w[y yes].include?(answer)
+      end
+    end
+  end
+end

data/lib/philiprehberger/cli_kit/spinner.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CliKit
+    # Animated spinner for long-running CLI operations.
+    module Spinner
+      FRAMES = %w[| / - \\].freeze
+
+      # Display a spinner while executing a block.
+      #
+      # @param message [String] the message to display alongside the spinner
+      # @param output [IO] output stream (default: $stderr)
+      # @yield the block to execute
+      # @return [Object] the return value of the block
+      def self.spinner(message, output: $stderr, &block)
+        done = false
+        result = nil
+
+        thread = Thread.new do
+          frame = 0
+          until done
+            output.print "\r#{FRAMES[frame % FRAMES.length]} #{message}"
+            output.flush
+            frame += 1
+            sleep 0.1
+          end
+          output.print "\r\e[K"
+          output.flush
+        end
+
+        begin
+          result = block.call
+        ensure
+          done = true
+          thread.join
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/philiprehberger/cli_kit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CliKit
+    VERSION = '0.1.0'
+  end
+end

data/lib/philiprehberger/cli_kit.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'cli_kit/version'
+require_relative 'cli_kit/parser'
+require_relative 'cli_kit/prompt'
+require_relative 'cli_kit/spinner'
+
+module Philiprehberger
+  module CliKit
+    class Error < StandardError; end
+
+    # Parse command-line arguments using a DSL block.
+    #
+    # @param args [Array<String>] command-line arguments
+    # @yield [Parser] the parser for defining flags and options
+    # @return [Parser] the parsed result with flags, options, and arguments
+    def self.parse(args, &block)
+      parser = Parser.new
+      parser.instance_eval(&block)
+      parser.parse(args)
+    end
+
+    # Display a prompt and read user input.
+    #
+    # @param message [String] the prompt message
+    # @param input [IO] input stream
+    # @param output [IO] output stream
+    # @return [String] the user's input
+    def self.prompt(message, input: $stdin, output: $stdout)
+      Prompt.prompt(message, input: input, output: output)
+    end
+
+    # Display a yes/no confirmation prompt.
+    #
+    # @param message [String] the confirmation message
+    # @param input [IO] input stream
+    # @param output [IO] output stream
+    # @return [Boolean] true if user answered yes
+    def self.confirm(message, input: $stdin, output: $stdout)
+      Prompt.confirm(message, input: input, output: output)
+    end
+
+    # Display a spinner while executing a block.
+    #
+    # @param message [String] the spinner message
+    # @param output [IO] output stream
+    # @yield the block to execute
+    # @return [Object] the return value of the block
+    def self.spinner(message, output: $stderr, &block)
+      Spinner.spinner(message, output: output, &block)
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-cli_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-22 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.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/cli_kit.rb
+- lib/philiprehberger/cli_kit/parser.rb
+- lib/philiprehberger/cli_kit/prompt.rb
+- lib/philiprehberger/cli_kit/spinner.rb
+- lib/philiprehberger/cli_kit/version.rb
+homepage: https://github.com/philiprehberger/rb-cli-kit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-cli-kit
+  source_code_uri: https://github.com/philiprehberger/rb-cli-kit
+  changelog_uri: https://github.com/philiprehberger/rb-cli-kit/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-cli-kit/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: All-in-one CLI toolkit with argument parsing, prompts, and spinners
+test_files: []