prompts 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00154e514a6a247088b47d92dd842df0628e33a7b9abf56f31d8a402f6174a16
-  data.tar.gz: 65a2a890904ef991dd55e042081efad7762106d63f0039f3db566e9df262c800
+  metadata.gz: 40fa96bdb16258c1e9612971eeea11a1757e82cdbc68e6084000c26c96f2d86c
+  data.tar.gz: b7a7daee831ca3473aa043bfe0b1f94aff8f12a9aa8e2fa4acdb6a4a75fb0634
 SHA512:
-  metadata.gz: 609f6e7c90beb7732f2b7853f25dbc44bce3e79ca5acdadd186a1455babea98e1364d2fff40dd380372974702f392774c8fd69b17e14241df8312ebc422e0e44
-  data.tar.gz: aec86323aa427982ad95a58e9d4ab2fc73dfa0df358a4b8d88919fbf1c851321a25491a80b49b6618ed44af61ac24f819fc9f9fc55a9691858a41bc349587357
+  metadata.gz: fb8c9184e577f2e7b9f6c003407e028ee1613db35ee288c0ac914d5a8464f3c2135e22d4e280aab7233aa52418f60fed3ca6cf05c37d4c6907ef5937099f1445
+  data.tar.gz: cd5e4cb5512224d68c825b28f67398f5366d0d8a5a1026523c3cc431b44efea1ddef5fdb969832af49b2158dc1bb3e94b6a98cb8781c9422c324f02ebbce16c3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [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`

data/README.md

@@ -256,6 +256,32 @@ which generates a terminal screen like this (this representation doesn't show co
    <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:
+
+```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
+```
+
+The `submit` method will return an array containing all of the responses from the form's prompts.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/prompts/box.rb

@@ -4,10 +4,10 @@ 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
+    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
@@ -15,11 +15,11 @@ module Prompts
       @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
+      when :solid then SOLID_BORDER
+      when :double then DOUBLE_BORDER
+      when :heavy then HEAVY_BORDER
+      else ROUNDED_BORDER
+      end
       @content = []
     end
 
@@ -53,19 +53,19 @@ module Prompts
 
     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 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 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
+    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
+end

data/lib/prompts/confirm_prompt.rb

@@ -3,7 +3,7 @@
 module Prompts
   class ConfirmPrompt < Prompt
     def initialize(...)
-      super(...)
+      super
 
       @prompt = if @default == false
         "Choose [y/N]:"
@@ -20,12 +20,12 @@ module Prompts
 
     private
 
-      def resolve_choice_from(response)
-        case response
-        when "y", "Y" then true
-        when "n", "N" then false
-        when "" then @default_boolean
-        end
+    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

@@ -43,28 +43,28 @@ module Prompts
 
     private
 
-      def clear_screen
-        jump_cursor_to_top
-        erase_down
-      end
+    def clear_screen
+      jump_cursor_to_top
+      erase_down
+    end
 
-      def render_frame
-        @frame_stack << @slots.dup
-        OUTPUT.puts SPACE
+    def render_frame
+      @frame_stack << @slots.dup
+      OUTPUT.puts SPACE
 
-        return if @slots.empty?
+      return if @slots.empty?
 
-        OUTPUT.puts @slots.join("\n")
-        OUTPUT.puts SPACE
-        @slots.clear
-      end
+      OUTPUT.puts @slots.join("\n")
+      OUTPUT.puts SPACE
+      @slots.clear
+    end
 
-      def jump_cursor_to_top
-        OUTPUT.print "\033[H"
-      end
+    def jump_cursor_to_top
+      OUTPUT.print "\033[H"
+    end
 
-      def erase_down
-        OUTPUT.print "\e[J"
-      end
+    def erase_down
+      OUTPUT.print "\e[J"
+    end
   end
-end
+end

data/lib/prompts/form.rb

@@ -2,47 +2,52 @@
 
 module Prompts
   class Form
-    def initialize()
-      @content = nil
+    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)
-      @content = Prompts::Content.new
       yield @content
       @content
     end
 
-    def text(&block)
-      prompt = TextPrompt.new
-      yield(prompt)
+    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(&block)
-      prompt = SelectPrompt.new
-      yield(prompt)
+    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(&block)
-      prompt = PausePrompt.new
-      yield(prompt)
+    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(&block)
-      prompt = ConfirmPrompt.new
-      yield(prompt)
+    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 start
+    def submit
       @prompts.each do |prompt|
         @results << prompt.ask
       end
@@ -51,10 +56,10 @@ module Prompts
 
     private
 
-      def prepend_form_content_to_prompt(prompt)
-        prompt.prepare_content
-        @content.gap
-        prompt.prepend_content(*@content.slots)
-      end
+    def prepend_form_content_to_prompt(prompt)
+      prompt.prepare_content
+      @content.gap
+      prompt.prepend_content(*@content.slots)
+    end
   end
-end
+end

data/lib/prompts/paragraph.rb

@@ -16,4 +16,4 @@ module Prompts
       wrap_text(@text, width: @width, line_prefix: @line_padding, alignment: :none)
     end
   end
-end
+end

data/lib/prompts/pause_prompt.rb

@@ -3,7 +3,7 @@
 module Prompts
   class PausePrompt < Prompt
     def initialize(...)
-      super(...)
+      super
 
       @prompt = "Press Enter ⏎ to continue..."
     end

data/lib/prompts/prompt.rb

@@ -33,6 +33,7 @@ module Prompts
       @content
     end
 
+    # standard:disable Style/TrivialAccessors
     def label(label)
       @label = label
     end
@@ -44,6 +45,7 @@ module Prompts
     def default(default)
       @default = default
     end
+    # standard:enable Style/TrivialAccessors
 
     def ask
       prepare_content if !@content_prepared
@@ -54,7 +56,7 @@ module Prompts
         @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
+        response = Reline.readline(last_prompt_line, _history = false).chomp
         @choice = resolve_choice_from(response)
 
         if (@error = ensure_validity(response))
@@ -87,53 +89,53 @@ module Prompts
 
     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
+    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
+    def prepare_validations
+      if @required
+        error_message = @required.is_a?(String) ? @required : "Value cannot be empty."
+        @validations << ->(input) { error_message if input.empty? }
       end
 
-      def resolve_choice_from(response)
-        response
+      if @validate
+        @validations << @validate
       end
+    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 resolve_choice_from(response)
+      response
+    end
 
-      def formatted_label
-        Fmt("%{label}cyan|bold %{instructions}faint|italic", label: @label, instructions: @instructions ? "(#{@instructions})" : "")
-      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_hint
-        Fmt("%{hint}faint|bold", hint: @hint)
-      end
+    def formatted_label
+      Fmt("%{label}cyan|bold %{instructions}faint|italic", label: @label, instructions: @instructions ? "(#{@instructions})" : "")
+    end
 
-      def formatted_error
-        Fmt("%{error}red|bold", error: @error + " Try again (×#{@attempts})...")
-      end
+    def formatted_hint
+      Fmt("%{hint}faint|bold", hint: @hint)
+    end
 
-      def ensure_validity(response)
-        @validations.each do |validation|
-          result = validation.call(response)
-          return result if result
-        end
-        nil
+    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

@@ -12,19 +12,19 @@ module Prompts
       super(**kwargs)
 
       @options = options.is_a?(Array) ? options.to_h { |item| [item, item] } : options
-      if (index = @options.keys.index(@default))
-        @default = index + 1
-      else
-        @default = nil
+      @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
@@ -36,10 +36,10 @@ module Prompts
 
     private
 
-      def resolve_choice_from(response)
-        choice = response.to_i
-        key, value = @options.to_a[choice - 1]
-        value
-      end
+    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

@@ -3,7 +3,7 @@
 module Prompts
   class TextPrompt < Prompt
     def initialize(...)
-      super(...)
+      super
 
       @instructions = "Press Enter to submit"
       @hint ||= "Type your response and press Enter ⏎"

data/lib/prompts/text_utils.rb

@@ -5,7 +5,7 @@ require "unicode/emoji"
 
 module Prompts
   module TextUtils
-    ANSI_REGEX = /\e\[[0-9;]*[a-zA-Z]/.freeze
+    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))
@@ -55,4 +55,4 @@ module Prompts
       text.gsub(ANSI_REGEX, EMPTY)
     end
   end
-end
+end

data/lib/prompts/version.rb

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

data/lib/prompts.rb

@@ -20,8 +20,8 @@ require_relative "prompts/select_prompt"
 require_relative "prompts/form"
 
 module Prompts
-  EMPTY = "".freeze
-  SPACE = " ".freeze
+  EMPTY = ""
+  SPACE = " "
   MAX_WIDTH = 80
   OUTPUT = $stdout
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prompts
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-20 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode-display_width