prompts 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e372e3b7b11291f493908b8b18d2430e9b49d11d9807e4db768326717a1890c4
-  data.tar.gz: accd4c59fc36421be3561c18ad42f45f65d521fe4c21195a7e886e68a1be3e8b
+  metadata.gz: 40fa96bdb16258c1e9612971eeea11a1757e82cdbc68e6084000c26c96f2d86c
+  data.tar.gz: b7a7daee831ca3473aa043bfe0b1f94aff8f12a9aa8e2fa4acdb6a4a75fb0634
 SHA512:
-  metadata.gz: 10e4d017de9d2854bd059427db91c193fd1b1c5c7a9c6a901552150bdfa82934469ae00bd0397de49db715e53de0dae1208f65692f17219d389884bdcddb9d1b
-  data.tar.gz: df6f62ffb22cdd98c29e52b55c5ab02fc2e468828ebea09a41e926f3c800a62a1994e59982ad4ff1a98d1305ea50a0b7fe5bdcd315952996660c5c128d01b99c
+  metadata.gz: fb8c9184e577f2e7b9f6c003407e028ee1613db35ee288c0ac914d5a8464f3c2135e22d4e280aab7233aa52418f60fed3ca6cf05c37d4c6907ef5937099f1445
+  data.tar.gz: cd5e4cb5512224d68c825b28f67398f5366d0d8a5a1026523c3cc431b44efea1ddef5fdb969832af49b2158dc1bb3e94b6a98cb8781c9422c324f02ebbce16c3

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.2.1] - 2024-08-22
+
+- Add `Form.submit` method
+- All passing keyword arguments to `Form` prompt methods
+- Return the key of the options hash when using `SelectPrompt`
+
+## [0.2.0] - 2024-08-20
+
+- Add `TextPrompt`
+- Add `SelectPrompt`
+- Add `ConfirmPrompt`
+- Add `PausePrompt`
+- Add `Form`
+
 ## [0.1.0] - 2024-08-07
 
 - Initial release

data/README.md

@@ -1,24 +1,286 @@
 # Prompts
 
-TODO: Delete this and the text below, and describe your gem
+Prompts helps you to add beautiful and user-friendly forms to your command-line applications, with browser-like features including label text, help text, validation, and inline errors.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/prompts`. To experiment with that code, run `bin/console` for an interactive prompt.
+It was originally inspired by the [Laravel Prompts](https://laravel.com/docs/11.x/prompts) package.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+bundle add prompts
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+gem install prompts
+```
+
+## Philosophy
+
+Prompts aims to provide beautiful and user-friendly forms for your command-line applications while keeping both the API and the implementation simple. This means Prompts is built with constraints in mind.
+
+In order to minimize complexity, we build on top of the excellent [`reline`](https://github.com/ruby/reline) gem to provide a full-featured text input. Similarly, the text input is **always** rendered at the bottom of the screen. And inputing text is the **only** way to interact with the form.
+
+In this way, this new library is similar to [Charm's Huh library](https://github.com/charmbracelet/huh) when used in "accessible" mode. But, with some UX improvements added to this interaction. Instead of simply appending new fields to the screen, Prompts' forms act like wizards 🧙‍♂️. Each field gets its own screen, and on each render loop, the screen is reset and repainted.
+
+Finally, to keep internals simple, Prompts expects users to build and provide their own ANSI-formatted strings. However, we do make available the [`fmt`](https://github.com/hopsoft/fmt) gem as the recommended way to generate well formatted ANSI strings.
+
+## Available Prompts
+
+### Text
+
+A `Text` prompt will prompt the user with the given question, accept their input, and then return it:
+
+```ruby
+name = Prompts::TextPrompt.ask(label: "What is your name?")
+```
+
+which generates a terminal screen like this (this representation doesn't show color):
+<pre>
+
+   <b>What is your name?</b> <em>(Press Enter to submit)</em>
+   <b>Type your response and press Enter ⏎</b>
+
+   <b>></b> |
+</pre>
+
+You may also include a default value and an informational hint:
+
+```ruby
+name = Prompts::TextPrompt.ask(
+  label: "What is your name?",
+  default: "John Doe",
+  hint: "This will be displayed on your profile."
+)
+```
+
+which generates a terminal screen like this (this representation doesn't show color):
+<pre>
+
+   <b>What is your name?</b> <em>(Press Enter to submit)</em>
+   <b>This will be displayed on your profile.</b>
+
+   <b>></b> John Doe|
+</pre>
+
+#### Required values
+
+If you require a value to be entered, you may pass the `required` argument:
+
+```ruby
+name = Prompts::TextPrompt.ask(
+  label: "What is your name?",
+  required: true
+)
+```
+
+If you would like to customize the validation message, you may also pass a string:
+
+```ruby
+name = Prompts::TextPrompt.ask(
+  label: "What is your name?",
+  required: "Your name is required."
+)
+```
+
+#### Additional Validation
+
+Finally, if you would like to perform additional validation logic, you may pass a block/proc to the validate argument:
+
+```ruby
+name = Prompts::TextPrompt.ask(
+  label: "What is your name?",
+  validate: ->(value) do
+    if value.length < 3
+      "The name must be at least 3 characters."
+    elsif value.length > 255
+      "The name must not exceed 255 characters."
+    end
+  end
+)
+```
+
+The block will receive the value that has been entered and may return an error message, or `nil` if the validation passes.
+
+### Select
+
+If you need the user to select from a predefined set of choices, you may use the `Select` prompt:
+
+```ruby
+role = Prompts::SelectPrompt.ask(
+  label: "What role should the user have?",
+  options: ["Member", "Contributor", "Owner"]
+)
+```
+
+which generates a terminal screen like this (this representation doesn't show color):
+<pre>
+
+   <b>What role should the user have?</b> <em>(Enter the number of your choice)</em>
+   <b>Type your response and press Enter ⏎</b>
+   <b>1.</b> Member
+   <b>2.</b> Contributor
+   <b>3.</b> Owner
+
+   <b>></b> |
+</pre>
+
+You may also include a default value and an informational hint:
+
+```ruby
+role = Prompts::SelectPrompt.ask(
+  label: "What role should the user have?",
+  options: ["Member", "Contributor", "Owner"],
+  default: "Owner",
+  hint: "The role may be changed at any time."
+)
+```
+
+which generates a terminal screen like this (this representation doesn't show color):
+<pre>
+
+   <b>What role should the user have?</b> <em>(Enter the number of your choice)</em>
+   <b>The role may be changed at any time.</b>
+   <b>1.</b> Member
+   <b>2.</b> Contributor
+   <b>3.</b> Owner
+
+   <b>></b> 3|
+</pre>
+
+You may also pass a hash to the `options` argument to have the selected key returned instead of its value:
+
+```ruby
+role = Prompts::SelectPrompt.ask(
+  label: "What role should the user have?",
+  options: {
+    member: "Member",
+    contributor: "Contributor",
+    owner: "Owner",
+  },
+  default: "owner"
+)
+```
+
+#### Additional Validation
+
+Unlike other prompt classes, the `SelectPrompt` doesn't accept the `required` argument because it is not possible to select nothing. However, you may pass a block/proc to the `validate` argument if you need to present an option but prevent it from being selected:
+
+```ruby
+role = Prompts::SelectPrompt.ask(
+  label: "What role should the user have?",
+  options: {
+    member: "Member",
+    contributor: "Contributor",
+    owner: "Owner",
+  },
+  validate: ->(value) do
+    if value == "owner" && User.where(role: "owner").exists?
+      "An owner already exists."
+    end
+  end
+)
+```
+
+If the `options` argument is a hash, then the block will receive the selected key, otherwise it will receive the selected value. The block may return an error message, or `nil` if the validation passes.
+
+### Confirm
+
+If you need to ask the user for a "yes or no" confirmation, you may use the `ConfirmPrompt`. Users may press `y` or `n` (or `Y` or `N`) to select their response. This function will return either `true` or `false`.
+
+```ruby
+confirmed = Prompts::ConfirmPrompt.ask(label: "Do you accept the terms?")
+```
+
+which generates a terminal screen like this (this representation doesn't show color):
+<pre>
+
+   <b>Do you accept the terms?</b> <em>(Press Enter to submit)</em>
+
+   <b>Choose [y/n]:</b> |
+</pre>
+
+You may also include a default value and an informational hint:
+
+```ruby
+confirmed = Prompts::ConfirmPrompt.ask(
+  label: "Do you accept the terms?",
+  default: false,
+  hint: "The terms must be accepted to continue.",
+)
+```
+
+which generates a terminal screen like this (this representation doesn't show color):
+<pre>
+
+   <b>Do you accept the terms?</b> <em>(Press Enter to submit)</em>
+   <b>The terms must be accepted to continue.</b>
+
+   <b>Choose [y/N]:</b> |
+</pre>
+
+#### Requiring "Yes"
+
+If necessary, you may require your users to select "Yes" by passing the `required` argument:
+
+```ruby
+confirmed = Prompts::ConfirmPrompt.ask(
+  label: "Do you accept the terms?",
+  required: true
+)
+```
+
+If you would like to customize the validation message, you may also pass a string:
+
+```ruby
+confirmed = Prompts::ConfirmPrompt.ask(
+  label: "Do you accept the terms?",
+  required: "You must accept the terms to continue."
+)
+```
+
+### Pause
+
+The `PausePrompt` may be used to display informational text to the user and wait for them to confirm their desire to proceed by pressing the Enter / Return key:
+
+```ruby
+Prompts::PausePrompt.ask
+```
+
+which generates a terminal screen like this (this representation doesn't show color):
+<pre>
+
+   <b>Press Enter ⏎ to continue...</b> |
+</pre>
+
+## Forms
+
+Often, you will have multiple prompts that will be displayed in sequence to collect information before performing additional actions. You may use the `Prompts::Form` class to create a grouped set of prompts for the user to complete:
 
-## Usage
+```ruby
+responses = Prompts::Form.submit do |form|
+  form.text(
+    label: "What is your name?",
+    required: true
+  )
+  form.select(
+    label: "What role should the user have?",
+    options: {
+      member: "Member",
+      contributor: "Contributor",
+      owner: "Owner",
+    }
+  )
+  form.confirm(
+    label: 'Do you accept the terms?'
+  )
+end
+```
 
-TODO: Write usage instructions here
+The `submit` method will return an array containing all of the responses from the form's prompts.
 
 ## Development
 
@@ -28,7 +290,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/prompts. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/prompts/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/fractaledmind/prompts. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/fractaledmind/prompts/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +298,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Prompts project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/prompts/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Prompts project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fractaledmind/prompts/blob/main/CODE_OF_CONDUCT.md).

data/lib/prompts/box.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Prompts
+  class Box
+    include TextUtils
+
+    SOLID_BORDER = {top_left: "┌", top_right: "┐", bottom_left: "└", bottom_right: "┘", horizontal: "─", vertical: "│"}.freeze
+    DOUBLE_BORDER = {top_left: "╔", top_right: "╗", bottom_left: "╚", bottom_right: "╝", horizontal: "═", vertical: "║"}.freeze
+    HEAVY_BORDER = {top_left: "┏", top_right: "┓", bottom_left: "┗", bottom_right: "┛", horizontal: "━", vertical: "┃"}.freeze
+    ROUNDED_BORDER = {top_left: "╭", top_right: "╮", bottom_left: "╰", bottom_right: "╯", horizontal: "─", vertical: "│"}.freeze
+
+    def initialize(width: MAX_WIDTH, padded: false, border_color: nil, border_style: :rounded)
+      @width = width
+      @padded = padded
+      @border_color = border_color
+      @line_padding = SPACE * 1
+      @border_parts = case border_style
+      when :solid then SOLID_BORDER
+      when :double then DOUBLE_BORDER
+      when :heavy then HEAVY_BORDER
+      else ROUNDED_BORDER
+      end
+      @content = []
+    end
+
+    def centered(text)
+      @content.concat align(text, :center)
+    end
+
+    def left(text)
+      @content.concat align(text, :left)
+    end
+
+    def right(text)
+      @content.concat align(text, :right)
+    end
+
+    def gap
+      @content.concat align(EMPTY, :center)
+    end
+
+    def lines
+      [].tap do |output|
+        output << top_border
+        align(EMPTY, :center).each { |line| output << @line_padding + line } if @padded
+        @content.each do |line|
+          output << @line_padding + line
+        end
+        align(EMPTY, :center).each { |line| output << @line_padding + line } if @padded
+        output << bottom_border
+      end
+    end
+
+    private
+
+    def top_border
+      border = @border_parts[:top_left] + @border_parts[:horizontal] * (@width - 2) + @border_parts[:top_right]
+      Fmt("#{@line_padding}%{border}#{@border_color}", border: border)
+    end
+
+    def bottom_border
+      border = @border_parts[:bottom_left] + @border_parts[:horizontal] * (@width - 2) + @border_parts[:bottom_right]
+      Fmt("#{@line_padding}%{border}#{@border_color}", border: border)
+    end
+
+    def align(text, alignment, between: @border_parts[:vertical])
+      formatted_boundary = Fmt("%{boundary}#{@border_color}", boundary: between)
+      wrap_text(text, width: @width, line_prefix: formatted_boundary + SPACE, line_suffix: SPACE + formatted_boundary, alignment: alignment)
+    end
+  end
+end

data/lib/prompts/confirm_prompt.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Prompts
+  class ConfirmPrompt < Prompt
+    def initialize(...)
+      super
+
+      @prompt = if @default == false
+        "Choose [y/N]:"
+      elsif @default == true
+        "Choose [Y/n]:"
+      else
+        "Choose [y/n]:"
+      end
+      @default_boolean = @default
+      @default = nil
+      @instructions = "Press Enter to submit"
+      @validations << ->(choice) { "Invalid choice." if !["y", "n", "Y", "N", ""].include?(choice) }
+    end
+
+    private
+
+    def resolve_choice_from(response)
+      case response
+      when "y", "Y" then true
+      when "n", "N" then false
+      when "" then @default_boolean
+      end
+    end
+  end
+end

data/lib/prompts/content.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: false
+
+module Prompts
+  class Content
+    attr_reader :slots
+
+    def initialize(width: MAX_WIDTH)
+      @slots = []
+      @frame_stack = []
+      @width = width
+    end
+
+    def paragraph(text)
+      paragraph = Paragraph.new(text, width: @width)
+      @slots.concat paragraph.lines
+      self
+    end
+
+    def gap
+      @slots << SPACE
+      self
+    end
+
+    def box(padded: false, border_color: nil, &block)
+      box = Box.new(width: @width, padded: padded, border_color: border_color)
+      yield(box)
+      @slots.concat box.lines
+      self
+    end
+
+    def render
+      clear_screen
+      render_frame
+    end
+
+    def reset!
+      @slots = @frame_stack.first.dup
+    end
+
+    def prepend(*lines)
+      @slots.unshift(*lines)
+    end
+
+    private
+
+    def clear_screen
+      jump_cursor_to_top
+      erase_down
+    end
+
+    def render_frame
+      @frame_stack << @slots.dup
+      OUTPUT.puts SPACE
+
+      return if @slots.empty?
+
+      OUTPUT.puts @slots.join("\n")
+      OUTPUT.puts SPACE
+      @slots.clear
+    end
+
+    def jump_cursor_to_top
+      OUTPUT.print "\033[H"
+    end
+
+    def erase_down
+      OUTPUT.print "\e[J"
+    end
+  end
+end

data/lib/prompts/form.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Prompts
+  class Form
+    def self.submit(&block)
+      instance = new()
+      yield instance if block_given?
+      instance.submit
+    end
+
+    def initialize
+      @content = Prompts::Content.new
+      @prompts = []
+      @results = []
+    end
+
+    def content(&block)
+      yield @content
+      @content
+    end
+
+    def text(label: nil, prompt: "> ", hint: nil, default: nil, required: false, validate: nil, &block)
+      prompt = TextPrompt.new(label: label, prompt: prompt, hint: hint, default: default, required: required, validate: validate)
+      yield(prompt) if block_given?
+      prepend_form_content_to_prompt(prompt)
+      @prompts << prompt
+    end
+
+    def select(label: nil, options: nil, prompt: "> ", hint: nil, default: nil, validate: nil, &block)
+      prompt = SelectPrompt.new(label: label, options: options, prompt: prompt, hint: hint, default: default, validate: validate)
+      yield(prompt) if block_given?
+      prepend_form_content_to_prompt(prompt)
+      @prompts << prompt
+    end
+
+    def pause(label: nil, prompt: "> ", hint: nil, default: nil, required: false, validate: nil, &block)
+      prompt = PausePrompt.new(label: label, prompt: prompt, hint: hint, default: default, required: required, validate: validate)
+      yield(prompt) if block_given?
+      prepend_form_content_to_prompt(prompt)
+      @prompts << prompt
+    end
+
+    def confirm(label: nil, prompt: "> ", hint: nil, default: nil, required: false, validate: nil, &block)
+      prompt = ConfirmPrompt.new(label: label, prompt: prompt, hint: hint, default: default, required: required, validate: validate)
+      yield(prompt) if block_given?
+      prepend_form_content_to_prompt(prompt)
+      @prompts << prompt
+    end
+
+    def submit
+      @prompts.each do |prompt|
+        @results << prompt.ask
+      end
+      @results
+    end
+
+    private
+
+    def prepend_form_content_to_prompt(prompt)
+      prompt.prepare_content
+      @content.gap
+      prompt.prepend_content(*@content.slots)
+    end
+  end
+end

data/lib/prompts/paragraph.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Prompts
+  class Paragraph
+    include TextUtils
+
+    LINE_PADDING = 3
+
+    def initialize(text, width: 60)
+      @text = text
+      @width = width - (LINE_PADDING + 1)
+      @line_padding = SPACE * LINE_PADDING
+    end
+
+    def lines
+      wrap_text(@text, width: @width, line_prefix: @line_padding, alignment: :none)
+    end
+  end
+end

data/lib/prompts/pause_prompt.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Prompts
+  class PausePrompt < Prompt
+    def initialize(...)
+      super
+
+      @prompt = "Press Enter ⏎ to continue..."
+    end
+
+    def resolve_choice_from(response)
+      true
+    end
+  end
+end

data/lib/prompts/prompt.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "reline"
+
+module Prompts
+  class Prompt
+    def self.ask(label: nil, prompt: "> ", hint: nil, default: nil, required: false, validate: nil)
+      instance = new(label: label, prompt: prompt, hint: hint, default: default, required: required, validate: validate)
+      yield instance if block_given?
+      instance.ask
+    end
+
+    def initialize(label: nil, prompt: "> ", hint: nil, default: nil, required: false, validate: nil)
+      @label = label
+      @prompt = prompt
+      @hint = hint
+      @default = default
+      @required = required
+      @validate = validate
+
+      @content = nil
+      @error = nil
+      @attempts = 0
+      @instructions = nil
+      @validations = []
+      @choice = nil
+      @content_prepared = false
+    end
+
+    def content(&block)
+      @content ||= Prompts::Content.new
+      yield @content
+      @content
+    end
+
+    # standard:disable Style/TrivialAccessors
+    def label(label)
+      @label = label
+    end
+
+    def hint(hint)
+      @hint = hint
+    end
+
+    def default(default)
+      @default = default
+    end
+    # standard:enable Style/TrivialAccessors
+
+    def ask
+      prepare_content if !@content_prepared
+      prepare_default if @default
+      prepare_validations
+
+      loop do
+        @content.render
+        *initial_prompt_lines, last_prompt_line = formatted_prompt
+        puts initial_prompt_lines.join("\n") if initial_prompt_lines.any?
+        response = Reline.readline(last_prompt_line, _history = false).chomp
+        @choice = resolve_choice_from(response)
+
+        if (@error = ensure_validity(response))
+          @content.reset!
+          @content.paragraph Fmt("%{error}red|bold", error: @error + " Try again (×#{@attempts})...")
+          @attempts += 1
+          next
+        else
+          break @choice
+        end
+      end
+
+      @choice
+    rescue Interrupt
+      exit 0
+    end
+
+    def prepend_content(*lines)
+      @content.prepend(*lines)
+    end
+
+    def prepare_content
+      @content ||= Prompts::Content.new
+      @content.paragraph formatted_label if @label
+      @content.paragraph formatted_hint if @hint
+      @content.paragraph formatted_error if @error
+      @content_prepared = true
+      @content
+    end
+
+    private
+
+    def prepare_default
+      Reline.pre_input_hook = -> do
+        Reline.insert_text @default.to_s
+        # Remove the hook right away.
+        Reline.pre_input_hook = nil
+      end
+    end
+
+    def prepare_validations
+      if @required
+        error_message = @required.is_a?(String) ? @required : "Value cannot be empty."
+        @validations << ->(input) { error_message if input.empty? }
+      end
+
+      if @validate
+        @validations << @validate
+      end
+    end
+
+    def resolve_choice_from(response)
+      response
+    end
+
+    def formatted_prompt
+      prompt_with_space = @prompt.end_with?(SPACE) ? @prompt : @prompt + SPACE
+      ansi_prompt = Fmt("%{prompt}faint|bold", prompt: prompt_with_space)
+      @formatted_prompt ||= Paragraph.new(ansi_prompt, width: MAX_WIDTH).lines
+    end
+
+    def formatted_label
+      Fmt("%{label}cyan|bold %{instructions}faint|italic", label: @label, instructions: @instructions ? "(#{@instructions})" : "")
+    end
+
+    def formatted_hint
+      Fmt("%{hint}faint|bold", hint: @hint)
+    end
+
+    def formatted_error
+      Fmt("%{error}red|bold", error: @error + " Try again (×#{@attempts})...")
+    end
+
+    def ensure_validity(response)
+      @validations.each do |validation|
+        result = validation.call(response)
+        return result if result
+      end
+      nil
+    end
+  end
+end

data/lib/prompts/select_prompt.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Prompts
+  class SelectPrompt < Prompt
+    def self.ask(options: nil, **kwargs)
+      instance = new(options: options, **kwargs)
+      yield instance if block_given?
+      instance.ask
+    end
+
+    def initialize(options: nil, **kwargs)
+      super(**kwargs)
+
+      @options = options.is_a?(Array) ? options.to_h { |item| [item, item] } : options
+      @default = if (index = @options.keys.index(@default))
+        index + 1
+      end
+      @instructions = "Enter the number of your choice"
+      @hint ||= "Type your response and press Enter ⏎"
+      @validations << ->(choice) { "Invalid choice." if !choice.to_i.between?(1, @options.size) }
+    end
+
+    # standard:disable Style/TrivialAccessors
+    def options(options)
+      @options = options
+    end
+    # standard:enable Style/TrivialAccessors
+
+    def prepare_content
+      super
+      @options.each_with_index do |(key, value), index|
+        @content.paragraph Fmt("%{prefix}faint|bold %{option}", prefix: "#{index + 1}.", option: value)
+      end
+      @content
+    end
+
+    private
+
+    def resolve_choice_from(response)
+      choice = response.to_i
+      key, _value = @options.to_a[choice - 1]
+      key
+    end
+  end
+end

data/lib/prompts/text_prompt.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Prompts
+  class TextPrompt < Prompt
+    def initialize(...)
+      super
+
+      @instructions = "Press Enter to submit"
+      @hint ||= "Type your response and press Enter ⏎"
+    end
+  end
+end

data/lib/prompts/text_utils.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "unicode/display_width"
+require "unicode/emoji"
+
+module Prompts
+  module TextUtils
+    ANSI_REGEX = /\e\[[0-9;]*[a-zA-Z]/
+
+    def wrap_text(text, width:, line_prefix: EMPTY, line_suffix: EMPTY, alignment: :left)
+      words = text.scan(Regexp.union(/\S+/, ANSI_REGEX))
+      lines = []
+      line = +EMPTY
+      line_width = 0
+      prefix_width = Unicode::DisplayWidth.of(strip_ansi(line_prefix), 1, {}, emoji: true)
+      suffix_width = Unicode::DisplayWidth.of(strip_ansi(line_suffix), 1, {}, emoji: true)
+      available_width = width - prefix_width - suffix_width
+
+      words.each do |word|
+        word_width = Unicode::DisplayWidth.of(strip_ansi(word), 1, {}, emoji: true)
+
+        if (line_width + word_width) > available_width
+          lines << format_line(line.rstrip, available_width, alignment, line_prefix, line_suffix)
+          line = +EMPTY
+          line_width = 0
+        end
+
+        line << word + SPACE
+        line_width += word_width + 1
+      end
+
+      lines << format_line(line.rstrip, available_width, alignment, line_prefix, line_suffix)
+      lines
+    end
+
+    def format_line(line, available_width, alignment, prefix, suffix)
+      line_width = Unicode::DisplayWidth.of(strip_ansi(line), 1, {}, emoji: true)
+      padding = [available_width - line_width, 0].max
+
+      case alignment
+      when :none
+        prefix + line + suffix
+      when :left
+        prefix + line + (SPACE * padding) + suffix
+      when :right
+        prefix + (SPACE * padding) + line + suffix
+      when :center
+        left_padding = padding / 2
+        right_padding = padding - left_padding
+        prefix + (SPACE * left_padding) + line + (SPACE * right_padding) + suffix
+      end
+    end
+
+    def strip_ansi(text)
+      text.gsub(ANSI_REGEX, EMPTY)
+    end
+  end
+end

data/lib/prompts/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prompts
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/prompts.rb

@@ -1,8 +1,37 @@
 # frozen_string_literal: true
 
+require "io/console"
+require "reline"
+require "fmt"
+require "rainbow"
+
+Fmt.add_rainbow_filters
+
 require_relative "prompts/version"
+require_relative "prompts/prompt"
+require_relative "prompts/text_utils"
+require_relative "prompts/content"
+require_relative "prompts/paragraph"
+require_relative "prompts/box"
+require_relative "prompts/pause_prompt"
+require_relative "prompts/confirm_prompt"
+require_relative "prompts/text_prompt"
+require_relative "prompts/select_prompt"
+require_relative "prompts/form"
 
 module Prompts
+  EMPTY = ""
+  SPACE = " "
+  MAX_WIDTH = 80
+  OUTPUT = $stdout
+
   class Error < StandardError; end
-  # Your code goes here...
+
+  class << self
+    def Form(&block)
+      form = Prompts::Form.new
+      yield(form)
+      form.start
+    end
+  end
 end

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: prompts
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
-dependencies: []
+date: 2024-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicode-emoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fmt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Inspired by the Laravel Prompts project
 email:
 - stephen.margheim@gmail.com
@@ -24,6 +94,16 @@ files:
 - README.md
 - Rakefile
 - lib/prompts.rb
+- lib/prompts/box.rb
+- lib/prompts/confirm_prompt.rb
+- lib/prompts/content.rb
+- lib/prompts/form.rb
+- lib/prompts/paragraph.rb
+- lib/prompts/pause_prompt.rb
+- lib/prompts/prompt.rb
+- lib/prompts/select_prompt.rb
+- lib/prompts/text_prompt.rb
+- lib/prompts/text_utils.rb
 - lib/prompts/version.rb
 - sig/prompts.rbs
 homepage: https://github.com/fractaledmind/prompts