natty-ui 0.33.0 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79e64cb2489dcf9efe4066e4f95252284f9227aafa4a77edd0d50f307b255cf2
-  data.tar.gz: 7ec6f014b300740062e816fa9c787ff79b3fb7ce68e4b1c2d6967ae6eb58b53d
+  metadata.gz: f193a0c86adab949f0d0c40d522e879d47f0a75a6a52ae9cf4f9ff39a7582e0e
+  data.tar.gz: 2841fcf9135c48ef2df17ffcea4f5ff7619fe51dc62a489e58a9b7fc21f2bc1d
 SHA512:
-  metadata.gz: 86abb66230c52bd8863aec983435b434e7272003a12db631cb0b46af9db938ffc16f3ba1f987dad53a10f9ff4393e5f4bf403d04b813bb68b4b189c5bf0b2860
-  data.tar.gz: 34afc008cdec26384f7f20b7be6830a5be511147cfaef831d8e6869f858219ffeaea394ec8718ceb7513cfa3aaee19a852bb70d2b2ef641bc5880ca79d8de38d
+  metadata.gz: 8d956fcf0d7cf2809bda3db9e82e84a02fe260e7646c54f1ba195dc04e3e8842677d6bb2c6e3dc95712c2da59580d6753e5218cccd2779408d10c1174cf96d12
+  data.tar.gz: 99c7fa8acd5d4f6c12db79b95e02da4a269ade5439a8d6918ca8b47a07ac2dce24cb2f91a146f23fe3b9d4554588b2e6f9b02be476cf725d9e058985f7ed763a

data/.yardopts

@@ -9,4 +9,3 @@
 lib/**/*.rb
 -
 README.md
-LICENSE

data/README.md

@@ -4,7 +4,7 @@ This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely, nat
 
 - Gem: [rubygems.org](https://rubygems.org/gems/natty-ui)
 - Source: [codeberg.org](https://codeberg.org/mblumtritt/natty-ui)
-- Help: [rubydoc.info](https://rubydoc.info/gems/natty-ui/index)
+- Help: [rubydoc.info](https://rubydoc.info/gems/natty-ui/NattyUI)
 
 ## Features
 
@@ -63,3 +63,7 @@ After that you only need one line of code to have everything together
 ```ruby
 require 'natty-ui'
 ```
+
+## Dependencies
+
+It uses only the fantastic [Terminal.rb](https://rubygems.org/gems/terminal_rb) gem.

data/examples/8bit-colors.rb

@@ -10,12 +10,14 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]8bit Color Support[/]' do
     [#ff]#{0.upto(7).map(&color).join}
     [#00]#{8.upto(15).map(&color).join}
   COLORS
+  ui.end
 
   ui.space
   ui.message 'Grayscale', <<~GRAYSCALE.chomp
     [#ff]#{0xe8.upto(0xf3).map(&color).join}
     [#ff]#{0xf4.upto(0xff).map(&color).join}
   GRAYSCALE
+  ui.end
 
   ui.space
   ui.message '6x6x6 Color Cube' do

data/examples/info.rb

@@ -19,8 +19,8 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Terminal Information[/]' do
     table.add 'Identifier', Terminal.application || 'unidentified'
     table.add 'ANSI support', Terminal.ansi? ? 'yes' : 'no'
     table.add 'Input mode', Terminal.input_mode
-    table.add 'Colors', colors
     table.add 'Screen size', Terminal.size.join(' x ')
+    table.add 'Colors', colors
     table.columns[0].assign(width: 15, padding_right: 2, align: :right)
     table.columns[1].style = %i[bold bright_yellow]
   end

data/examples/key-codes.rb

@@ -2,29 +2,24 @@
 
 require_relative '../lib/natty-ui'
 
-event = nil
-while true
-  ui.temporary do
-    ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Keyboard Key Codes[/]' do
-      ui.puts(
-        "
-        #{
-          if event
-            "#{event.to_a.size < 2 ? ' Key' : 'Keys'}: [bold bright_green]#{
-              event.to_a.map { "[\\#{_1}]" }.join(' ')
-            }[/]
-            Code: [bright_blue]#{event.raw.inspect}[/]"
-          else
-            "Your terminal uses [bright_blue]#{
-              Terminal.input_mode
-            }[/] mode. Press a key!"
-          end
-        }
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Keyboard Key Codes[/]' do
+  ui.space
+  ui.puts(
+    "Your terminal uses [bright_blue]#{Terminal.input_mode}[/] mode. Press a key!",
+    '[dim](Exit with ESC)'
+  )
 
-        [faint](Exit with ESC)"
-      )
-    end
-    event = Terminal.read_key_event
-    exit if event.nil? || event.name == 'Esc'
+  ui.space
+  # if you like to have mouse position changes reported then use
+  # 'mouse_move: true' in next line
+  Terminal.on_key_event(mouse: true, focus: true, mouse_move: false) do |event|
+    ui.puts(
+      "#{event.raw.inspect} [dim]→[/dim] [bold bright_green]#{
+        event.to_a.map { "[\\#{_1}]" }.join('+')
+      }#{" @ #{event.position.join(', ')}" if event.position}"
+    )
+    event.name != 'Esc'
   end
+
+  ui.space
 end

data/examples/sections.rb

@@ -10,17 +10,25 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Sections[/]' do
       means they may contain text, other sections, titles, horizontal rules,
       lists, progress bars and much more!
     TEXT
-  end
 
-  ui.space
-  ui.warning "Warning\nThis is a warning message example."
-
-  ui.space
-  ui.error 'Error Message' do
     ui.space
     ui.cols do |cc|
       cc.add "()-()\n \\\"/\n  `", width: 6, style: :yellow
       cc.add 'You can add all other elements to a section.', vertical: :middle
     end
+
+    ui.framed(<<~TEXT, align: :centered, eol: false).end
+      Sections and messages can be called with code blocks and will be
+      automatically closed when the block ends. Without a code block the
+      section or message needs to be closed.
+    TEXT
   end
+
+  ui.warning "Warning\nThis is a warning message example."
+  ui.end
+
+  ui.error('Error Message', <<~MSG, align: :right, prefix: '[b red]>[/] ').end
+    Error message text with
+    print options.
+  MSG
 end

data/lib/natty-ui/choice.rb

@@ -9,12 +9,12 @@ module NattyUI
       pin_line = NattyUI.lines_written
       draw
       last = @current
-      while (event = Terminal.read_key_event)
+      Terminal.on_key_event do |event|
         case event.name
         when 'Esc', 'Ctrl+c'
-          break nil if @abortable
+          return if @abortable
         when 'Enter', 'Space'
-          break @ret[@current]
+          return @ret[@current]
         when 'Home'
           @current = 0
         when 'End'
@@ -24,11 +24,11 @@ module NattyUI
         when 'Down', 'Tab', 'k', 's'
           @current = 0 if (@current += 1) == @texts.size
         else
-          next unless event.simple?
+          next true unless event.simple?
           c = event.key.ord
           @current = (c - 48).clamp(0, @texts.size - 1) if c.between?(48, 57)
         end
-        next if last == @current
+        next true if last == @current
         pin_line = NattyUI.back_to_line(pin_line, erase: false)
         draw
         last = @current

data/lib/natty-ui/dumb_choice.rb

@@ -7,15 +7,15 @@ module NattyUI
     def select
       yield(self) if block_given?
       draw
-      while (event = Terminal.read_key_event)
+      Terminal.on_key_event do |event|
         return if @abortable && %w[Esc Ctrl+c].include?(event.name)
-        next unless event.simple?
+        next true unless event.simple?
         code = event.raw.upcase
         if @ret.size <= 9
-          next unless ('1'..'9').include?(code)
-          code = @ret[code.ord - 49] and break code
+          next true unless ('1'..'9').include?(code)
+          code = @ret[code.ord - 49] and return code
         elsif ('A'..'Z').include?(code)
-          code = @ret[code.ord - 65] and break code
+          code = @ret[code.ord - 65] and return code
         end
       end
     end

data/lib/natty-ui/dumb_options.rb

@@ -7,20 +7,20 @@ module NattyUI
     def select
       yield(self) if block_given?
       draw
-      while (event = Terminal.read_key_event)
+      Terminal.on_key_event do |event|
         return if @abortable && %w[Esc Ctrl+c].include?(event.name)
         return @opts.transform_values(&:last) if event.name == 'Enter'
-        next unless event.simple?
+        next true unless event.simple?
         code = event.raw.upcase
         if @opts.size <= 9
-          next unless ('1'..'9').include?(code)
+          next true unless ('1'..'9').include?(code)
           offset = 49
         elsif ('A'..'Z').include?(code)
           offset = 65
         else
-          next
+          next true
         end
-        key = @opts.keys[code.ord - offset] or next
+        key = @opts.keys[code.ord - offset] or next true
         @opts[key][-1] = !@opts[key][-1]
         @parent.space
         draw

data/lib/natty-ui/element.rb

@@ -8,6 +8,11 @@ module NattyUI
   class Element
     include Features
 
+    # Close the element.
+    #
+    # @return [Features] current element
+    def end = NattyUI.__send__(:_end, self)
+
     # @private
     def columns = @parent.columns - @prefix_width - @suffix_width
 
@@ -71,13 +76,13 @@ module NattyUI
     # Close the element.
     #
     # @param [#to_s] text optional message
-    # @return [Element] itself
+    # @return [Features] current element
     def ok(*text)
       return self if @state
       text = [@title] if text.empty? && @title
       _done(text)
       @state = :ok
-      self
+      self.end
     end
     alias done ok
 
@@ -86,14 +91,17 @@ module NattyUI
     # @param text [#to_s] optional message
     # @yield optionally, when block is given
     # @yieldparam failed [Section] see {Features.failed}
-    # @return [Element] itself
+    # @return [Features] current element
     def failed(*text, &block)
       return self if @state
-      _failed
+      if text.empty?
+        super(@title, &block).ok if @title
+      else
+        super.ok
+      end
       @state = :failed
-      text = [@title] if text.empty? && @title
-      @parent.failed(*text, &block)
-      self
+      _failed
+      self.end
     end
   end
 end

data/lib/natty-ui/features.rb

@@ -2,7 +2,8 @@
 
 module NattyUI
   # These are all supported features by {NattyUI} or any other sub- element
-  # like {section}, {message}, {task}, ...
+  # like {#section}, {#message}, {#information}, {#warning}, {#error},
+  # {#failed}, {#framed}, {#task}, ...
   #
   # Any printed text can contain *BBCode*-like embedded ANSI attributes which
   # will be used when the output terminal supports attributes and colors.
@@ -26,8 +27,8 @@ module NattyUI
     #
     # @see #pin
     #
-    # @param text [#to_s]
-    #   one or more convertible objects to print line by line
+    # @param text [*#to_s]
+    #   one or more objects to print line by line
     # @param options [{Symbol => Object}]
     # @option options [:left, :right, :centered] :align (:left)
     #   text alignment
@@ -45,7 +46,7 @@ module NattyUI
         ignore_newline = options[:eol] == false || options[:ignore_newline]
 
         if (max_width = options[:max_width]).nil?
-          return self if (max_width = Terminal.columns).zero?
+          max_width = Terminal.columns
         elsif max_width < 1
           if max_width > 0
             max_width *= Terminal.columns
@@ -56,6 +57,8 @@ module NattyUI
           end
         end
 
+        return self if max_width <= 0
+
         prefix_width =
           if (prefix = options[:prefix])
             prefix = Ansi.bbcode(prefix) if bbcode
@@ -117,8 +120,7 @@ module NattyUI
       end
 
       unless options[:expand]
-        lines = lines.to_a
-        max_width = lines.max_by(&:last).last
+        max_width = (lines = lines.to_a).max_by(&:last)[-1]
       end
 
       case align
@@ -569,13 +571,14 @@ module NattyUI
     #   @return [Object]
     #     the result of the given block
     def progress(title, max: nil, pin: false, &block)
-      progress =
+      __with(
         if Terminal.ansi?
           Progress.new(self, title, max, pin)
         else
           DumbProgress.new(self, title, max)
-        end
-      block ? __with(progress, &block) : progress
+        end,
+        &block
+      )
     end
 
     # Execute a program.
@@ -648,101 +651,163 @@ module NattyUI
     #
 
     # Create a visually separated section for the output of text elements.
+    # Besides this simple sections there exist sections of different kinds:
+    # {#message}, {#information}, {#warning}, {#error}, {#failed}, {#framed}
+    #
     # Like any other {Element} sections support all {Features}.
     #
-    # @example
-    #   ui.section do |section|
+    # @overload section#
+    #   @example
+    #     ui.section do |section|
+    #       section.h1 'About Sections'
+    #       section.space
+    #       section.puts 'Sections are areas of text elements.'
+    #       section.puts 'You can use any other feature inside such an area.'
+    #     end
+    #     # => ╭────╶╶╶
+    #     # => │ ╴╶╴╶─═══ About Sections ═══─╴╶╴╶
+    #     # => │
+    #     # => │ Sections are areas of text elements.
+    #     # => │ You can use any other feature inside such an area.
+    #     # => ╰──── ─╶╶╶
+    #
+    #   @yieldparam section [Section]
+    #     itself
+    #   @return [Object]
+    #     the result of the given block
+    #
+    # @overload section(*text, **options)
+    #
+    #   @example
+    #     section = ui.section
     #     section.h1 'About Sections'
     #     section.space
     #     section.puts 'Sections are areas of text elements.'
-    #     section.puts 'You can use any other feature inside such an area.'
-    #   end
-    #   # => ╭────╶╶╶
-    #   # => │ ╴╶╴╶─═══ About Sections ═══─╴╶╴╶
-    #   # => │
-    #   # => │ Sections are areas of text elements.
-    #   # => │ You can use any other feature inside such an area.
-    #   # => ╰──── ─╶╶╶
-    #
-    # @param text [#to_s]
-    #   convertible objects to print line by line
-    #
-    # @yieldparam section [Section]
-    #   itself
+    #     section.end # close the section
     #
-    # @return [Object]
-    #   the result of the given block
-    def section(*text, &block) = __sec(:default, nil, text, &block)
-
-    # @!macro like_msg
-    #   @see section
-    #   @param title [#to_s]
-    #     title to print as section head
-    #   @param text (see section)
-    #   @yieldparam (see section)
-    #   @return (see section)
-
-    # Create a visually separated section with a title for the output of text
+    #   @param text [*#to_s]
+    #     optional objects to print line by line
+    #   @param options [{Symbol => Object}]
+    #     print options – see {puts}
+    #   @return [Section]
+    #     itself
+    def section(*text, **options, &block)
+      __sec(:default, false, nil, text, options, &block)
+    end
+    alias begin section
+
+    # @!macro msg_like
+    #
+    #   Like any other {Element} sections support all {Features}.
+    #
+    #   @overload $0(title)
+    #     @param title [#to_s]
+    #       section title
+    #     @yieldparam message [Section]
+    #       itself
+    #     @return [Object]
+    #       the result of the given block
+    #   @overload $0(title, *text, **options)
+    #     @param title [#to_s]
+    #       section title
+    #     @param text [*#to_s]
+    #       optional objects to print line by line
+    #     @param options [{Symbol => Object}]
+    #       print options – see {puts}
+    #     @return [Section]
+    #       itself
+
+    # Create a visually separated section with title for the output of text
     # elements.
-    #
-    # @macro like_msg
-    def message(title, *text, &block) = __sec(:message, title, text, &block)
+    # @macro msg_like
+    def message(title, *text, **options, &block)
+      __sec(:message, false, title, text, options, &block)
+    end
     alias msg message
 
-    # Create a visually separated section marked as informational with a title
-    # for the output of text elements.
+    # Create a visually separated section marked as informational with title for
+    # the output of text elements.
     #
-    # @macro like_msg
-    def information(title, *text, &block)
-      __tsec(:information, title, text, &block)
+    # @macro msg_like
+    def information(title, *text, **options, &block)
+      __sec(:information, true, title, text, options, &block)
     end
     alias info information
 
-    # Create a visually separated section marked as a warning with a title for
+    # Create a visually separated section marked as warning with title for
     # the output of text elements.
     #
-    # @macro like_msg
-    def warning(title, *text, &block) = __tsec(:warning, title, text, &block)
+    # @macro msg_like
+    def warning(title, *text, **options, &block)
+      __sec(:warning, true, title, text, options, &block)
+    end
     alias warn warning
 
-    # Create a visually separated section marked as an error with a title for
+    # Create a visually separated section marked as error with title for
     # the output of text elements.
     #
-    # @macro like_msg
-    def error(title, *text, &block) = __tsec(:error, title, text, &block)
+    # @macro msg_like
+    def error(title, *text, **options, &block)
+      __sec(:error, true, title, text, options, &block)
+    end
     alias err error
 
-    # Create a visually separated section marked as a failure with a title for
+    # Create a visually separated section marked as failure with title for
     # the output of text elements.
     #
-    # @macro like_msg
-    def failed(title, *text, &block) = __tsec(:failed, title, text, &block)
+    # @macro msg_like
+    def failed(title, *text, **options, &block)
+      __sec(:failed, true, title, text, options, &block)
+    end
 
     # Create a framed section.
+    # Like any other {Element} sections support all {Features}.
     #
-    # @param text (see section)
-    # @param align [:left, :right, :centered]
-    #   text alignment,
-    #   see {Attributes::Align}
-    # @param border [Symbol]
-    #   kind of border,
-    #   see {Attributes::Border}
-    # @param border_style [Enumerable<Symbol>]
-    #   style of border,
-    #   see {Attributes::BorderStyle}
-    #
-    # @yieldparam frame [Framed] itself
-    #
-    # @return (see section)
-    def framed(*text, align: :left, border: :default, border_style: nil, &block)
+    # @overload framed(align: :left, border: :default, border_style: nil)
+    #   @param align [:left, :right, :centered]
+    #     text alignment,
+    #     see {Attributes::Align}
+    #   @param border [Symbol]
+    #     kind of border,
+    #     see {Attributes::Border}
+    #   @param border_style [Enumerable<Symbol>]
+    #    style of border,
+    #    see {Attributes::BorderStyle}
+    #   @yieldparam framed [Element]
+    #     itself
+    #   @return [Object] the result of the given block
+    # @overload framed(*text, align: :left, border: :default, border_style: nil, **options)
+    #   @param text [*#to_s]
+    #     optional objects to print line by line
+    #   @param align [:left, :right, :centered]
+    #     text alignment,
+    #     see {Attributes::Align}
+    #   @param border [Symbol]
+    #     kind of border,
+    #     see {Attributes::Border}
+    #   @param border_style [Enumerable<Symbol>]
+    #     style of border,
+    #     see {Attributes::BorderStyle}
+    #   @param options [{Symbol => Object}]
+    #     print options – see {puts}
+    #   @return [Element] itself
+    def framed(
+      *text,
+      align: :left,
+      border: :default,
+      border_style: nil,
+      **options,
+      &block
+    )
       __with(
         Framed.new(
           self,
           Utils.align(align),
           Theme.current.border(border),
-          Utils.style(border_style),
-          text
+          Utils.style(border_style)
         ),
+        *text,
+        **options,
         &block
       )
     end
@@ -751,14 +816,17 @@ module NattyUI
     #
     # @param title [#to_s]
     #   task title text
-    # @param text (see section)
+    # @param text [*#to_s]
+    #   optional objects to print line by line
     # @param pin [true, false] whether to keep text "pinned"
+    # @param options [{Symbol => Object}]
+    #   print options – see {puts}
     #
     # @yieldparam task [Task] itself
     #
-    # @return (see section)
-    def task(title, *text, pin: false, &block)
-      __with(Task.new(self, title, text, pin), &block)
+    # @return [Task] itself
+    def task(title, *text, pin: false, **options, &block)
+      __with(Task.new(self, title, pin), *text, **options, &block)
     end
 
     #
@@ -971,9 +1039,18 @@ module NattyUI
     # Display some temporary content.
     # The content displayed in the block will be erased after the block ends.
     #
-    # @example Show tempoary information
+    # @example
+    #   ui.temporary(<<~MSG) { ui.await }
+    #     This is a [i]temporary[/i] displayed text.
+    #     It will disappear when you press [b]ENTER[/b].
+    #   MSG
+    #
+    # @example
     #   ui.temporary do
-    #     ui.info 'Information', 'This text will disappear when you pressed ENTER.'
+    #     ui.information 'Hint' do
+    #       ui.puts 'This is a [i]temporary[/i] displayed text.'
+    #       ui.puts 'It will disappear when you press [b]ENTER[/b].'
+    #     end
     #     ui.await
     #   end
     #
@@ -981,7 +1058,9 @@ module NattyUI
     #   itself
     #
     # @return (see section)
-    def temporary(&block) = __with(Temporary.new(self), &block)
+    def temporary(*text, **options, &block)
+      __with(Temporary.new(self), *text, **options, &block)
+    end
 
     #
     # @!endgroup
@@ -989,29 +1068,32 @@ module NattyUI
 
     private
 
-    def __with(element, &block) = NattyUI.__send__(:with, element, &block)
+    def __with(...) = NattyUI.__send__(:_with, ...)
 
-    def __sec(color, title, text, &block)
-      __with(Section.new(self, title, text, color), &block)
-    end
-
-    def __tsec(color, title, text, &block)
-      __sec(color, "#{Theme.current.mark(color)}#{title}", text, &block)
+    def __sec(color, mark, title, text, options, &block)
+      if title && !title.empty?
+        title, *rest =
+          Text.each_line(title, limit: columns - 9, ansi: Terminal.ansi?).to_a
+        text.unshift(rest.join("\n")) unless rest.empty?
+      end
+      __with(Section.new(self, color, mark, title), *text, **options, &block)
     end
 
     def __await(yes, no)
-      while (event = Terminal.read_key_event&.name)
+      Terminal.on_key_event do |event|
+        event = event.name
         if (no == event) || (no.is_a?(Enumerable) && no.include?(event))
           return false
         end
         if (yes == event) || (yes.is_a?(Enumerable) && yes.include?(event))
           return true
         end
+        true
       end
     end
   end
 
-  dir = __dir__ # call the function once
+  dir = __dir__
 
   autoload :Framed, "#{dir}/framed.rb"
   autoload :Section, "#{dir}/section.rb"

data/lib/natty-ui/framed.rb

@@ -29,7 +29,7 @@ module NattyUI
 
     private
 
-    def initialize(parent, align, chars, style, msg)
+    def initialize(parent, align, chars, style)
       super(parent)
       @align = align
       if style
@@ -45,7 +45,6 @@ module NattyUI
       line = chars[10] * (parent.columns - 2)
       parent.puts("#{style}#{chars[0]}#{line}#{chars[2]}")
       @bottom = "#{style}#{chars[6]}#{line}#{chars[8]}"
-      puts(*msg) unless msg.empty?
     end
   end
 end

data/lib/natty-ui/options.rb

@@ -9,7 +9,7 @@ module NattyUI
       pin_line = NattyUI.lines_written
       draw
       last = @current
-      while (event = Terminal.read_key_event)
+      Terminal.on_key_event do |event|
         case event.name
         when 'Esc', 'Ctrl+c'
           return if @abortable
@@ -34,7 +34,7 @@ module NattyUI
           keys = @opts.keys
           @current = keys[keys.index(@current) + 1] || keys[0]
         end
-        next if last == @current
+        next true if last == @current
         pin_line = NattyUI.back_to_line(pin_line, erase: false)
         draw
         last = @current

data/lib/natty-ui/progress.rb

@@ -55,6 +55,9 @@ module NattyUI
       self
     end
 
+    # @private
+    def end = NattyUI.__send__(:_end, self)
+
     alias _to_s to_s
     private :_to_s
 
@@ -82,7 +85,6 @@ module NattyUI
 
     def _done(text)
       NattyUI.back_to_line(@pin_line)
-      @pin_line = nil
       cm = Theme.current.mark(:checkmark)
       @parent.puts(
         *text,
@@ -94,7 +96,6 @@ module NattyUI
 
     def _failed
       NattyUI.back_to_line(NattyUI.lines_written - 1) if @last&.size == 2
-      @pin_line = nil
     end
 
     def initialize(parent, title, max, pin)
@@ -106,8 +107,8 @@ module NattyUI
       @style = Theme.current.task_style
       cm = Theme.current.mark(:current)
       @redraw_opts = {
-        first_line_prefix: "#{cm} #{@style}",
-        first_line_prefix_width: cm.width + 1
+        first_line_prefix: "#{cm}#{@style}",
+        first_line_prefix_width: cm.width
       }
       max ? self.max = max : redraw
     end
@@ -130,7 +131,6 @@ module NattyUI
       size = [@parent.columns, 72].min - 11
       percent = format('%5.2f', 100.0 * diff)
       return percent if size < 10
-      return if percent == '100.00'
       fill = '█' * (size * diff)
       "#{percent}% [bright_black]┃#{@style}#{fill}[bright_black]#{
         '░' * (size - fill.size)

data/lib/natty-ui/section.rb

@@ -3,7 +3,7 @@
 require_relative 'element'
 
 module NattyUI
-  # Display section used by
+  # Display section instance used by
   #
   # - {Features.section}
   # - {Features.message}
@@ -11,6 +11,7 @@ module NattyUI
   # - {Features.warning}
   # - {Features.error}
   # - {Features.failed}
+  # - {Features.framed}
   #
   class Section < Element
     include WithStatus
@@ -42,25 +43,13 @@ module NattyUI
       )
     end
 
-    def initialize(parent, title, msg, kind)
+    def initialize(parent, kind, mark, title)
       super(parent)
-      title, rest = split(title) if title && !title.empty?
       @border = Theme.current.section_border(kind)
-      show_title(title)
+      mark &&= Theme.current.mark(kind)
+      show_title(mark ? "#{mark}#{title}" : title)
       @prefix = @border.prefix
       @prefix_width = @prefix.width
-      puts(*rest) if rest && !rest.empty?
-      puts(*msg) unless msg.empty?
-    end
-
-    def split(title)
-      rest =
-        Text.each_line(
-          title,
-          limit: @parent.columns - 9,
-          ansi: Terminal.ansi?
-        ).to_a
-      [rest.shift, rest]
     end
   end
 end

data/lib/natty-ui/shell_renderer.rb

@@ -5,7 +5,7 @@ require_relative 'theme'
 module NattyUI
   module ShellRenderer
     def self.sh(parent, cmd, options, space)
-      opts_out, opts_err = opts_fom(Theme.current)
+      opts_out, opts_err = opts_from(Theme.current)
       Terminal.sh(*cmd, **options) do |line, kind|
         parent.puts(
           space ? line.gsub("\t", '    ').gsub(/[[:space:]]/, ' ') : line,
@@ -15,7 +15,7 @@ module NattyUI
     end
 
     if Terminal.ansi?
-      def self.opts_fom(theme)
+      def self.opts_from(theme)
         out = theme.mark(:sh_out)
         err = theme.mark(:sh_err)
         [
@@ -56,7 +56,7 @@ module NattyUI
         ]
       end
     else
-      def self.opts_fom(theme)
+      def self.opts_from(theme)
         out = theme.mark(:sh_out)
         err = theme.mark(:sh_err)
         [

data/lib/natty-ui/task.rb

@@ -3,7 +3,7 @@
 require_relative 'element'
 
 module NattyUI
-  # Task display section used by {Features.task}.
+  # Task section used by {Features.task}.
   #
   class Task < Temporary
     include WithStatus
@@ -27,7 +27,7 @@ module NattyUI
       @start_line = nil
     end
 
-    def initialize(parent, title, msg, pin)
+    def initialize(parent, title, pin)
       super(parent)
       @title = title
       @pin = pin
@@ -42,7 +42,6 @@ module NattyUI
         prefix: "#{@prefix}#{style}",
         prefix_width: cm.width
       )
-      puts(*msg) unless msg.empty?
     end
   end
 end

data/lib/natty-ui/theme.rb

@@ -163,6 +163,8 @@ module NattyUI
           current: '➔',
           choice: '◦',
           current_choice: '◉',
+          option: '[ ]',
+          option_selected: '[X]',
           sh_out: ':',
           sh_err: '𝙓'
         }
@@ -243,8 +245,8 @@ module NattyUI
       # [current?][selected?]
       c = @mark[:current_choice]
       n = @mark[:none]
-      sel = @mark[:checkmark]
-      uns = @mark[:choice]
+      uns = @mark[:option]
+      sel = @mark[:option_selected]
       {
         false => { false => n + uns, true => n + sel }.compare_by_identity,
         true => { false => c + uns, true => c + sel }.compare_by_identity
@@ -348,6 +350,8 @@ module NattyUI
         current: '[bright_green]➔[/fg]',
         choice: '[bright_white]◦[/fg]',
         current_choice: '[bright_green]➔[/fg]',
+        option: '[dim][ ][/dim]',
+        option_selected: '[dim][[/dim][green]X[/fg][dim]][/dim]',
         sh_out: '[bright_white]:[/fg]',
         sh_err: '[red]𝙓[/fg]'
       )
@@ -379,6 +383,8 @@ module NattyUI
         current: '➡️',
         choice: '[bright_white]•[/fg]',
         current_choice: '[bright_green]●[/fg]',
+        option: '[dim][ ][/dim] ',
+        option_selected: '[dim][[/dim][green]X[/fg][dim]][/dim]',
         sh_out: '[white b]:[/]',
         sh_err: '❗️'
       )

data/lib/natty-ui/version.rb

@@ -2,5 +2,5 @@
 
 module NattyUI
   # The version number of the gem.
-  VERSION = '0.33.0'
+  VERSION = '0.35.0'
 end

data/lib/natty-ui.rb

@@ -50,7 +50,7 @@ module NattyUI
     #   configured title
     # @return [nil]
     #   when no title was set
-    def title = @title_stack.last
+    def title = @title_stack[-1]
 
     # @attribute [w] title
     def title=(value)
@@ -85,32 +85,39 @@ module NattyUI
       @lines_written = number
     end
 
-    # @private
-    def alternate_screen
-      return yield unless Terminal.ansi?
-      begin
-        Terminal.raw_write(Ansi::SCREEN_ALTERNATE)
-        yield
-      ensure
-        Terminal.raw_write(Ansi::SCREEN_ALTERNATE_OFF)
-      end
-    end
-
     private
 
-    def with(element)
+    def _begin(element)
       Terminal.hide_cursor if @element == self
-      current, @element = @element, element
-      yield(element) if block_given?
-    ensure
-      element.done if element.respond_to?(:done)
-      Terminal.show_cursor if (@element = current) == self
+      @stack << element
+      @element = element
+    end
+
+    def _end(element)
+      idx = @stack.index(element) or return @element
+      @stack.drop(idx).each { _1.done if _1.respond_to?(:done) }
+      @stack = @stack.take(idx)
+      Terminal.show_cursor if (@element = @stack[-1]) == self
+      @element
+    end
+
+    def _with(element, *text, **options, &block)
+      _begin(element)
+      element.puts(*text, **options) unless text.empty?
+      return element unless block
+      begin
+        yield(element)
+      ensure
+        _end(element)
+      end
     end
   end
 
-  @element = self
+  @stack = [@element = self]
   @lines_written = 0
   @title_stack = []
+
+  autoload :VERSION, "#{__dir__}/natty-ui/version.rb"
 end
 
 unless defined?(Kernel.ui)

data/natty-ui.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/natty-ui/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'natty-ui'
+  spec.version = NattyUI::VERSION
+  spec.summary = <<~SUMMARY.tr("\n", ' ')
+    This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich,
+    lovely, natty user interface you like to have for your CLI.
+  SUMMARY
+  spec.description = <<~DESCRIPTION.tr("\n", ' ')
+    This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
+    natty user interface tool you like to have for your command line
+    applications. It contains elegant, simple and beautiful features that
+    enhance your command line interfaces functionally and aesthetically.
+  DESCRIPTION
+
+  spec.author = 'Mike Blumtritt'
+  spec.licenses = %w[MIT Ruby]
+  spec.homepage = 'https://codeberg.org/mblumtritt/natty-ui'
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/natty-ui'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['yard.run'] = 'yard'
+
+  spec.required_ruby_version = '>= 3.0'
+  spec.add_dependency 'terminal_rb', '>= 0.17.2'
+
+  spec.files = Dir['lib/**/*.rb'] + Dir['examples/*.rb']
+  spec.files << 'natty-ui.gemspec' << '.yardopts'
+  spec.extra_rdoc_files = %w[README.md]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.35.0
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -15,27 +15,24 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.17.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
-description: |
-  This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
-  natty user interface tool you like to have for your command line applications.
-  It contains elegant, simple and beautiful features that enhance your
-  command line interfaces functionally and aesthetically.
+        version: 0.17.2
+description: 'This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich,
+  lovely, natty user interface tool you like to have for your command line applications.
+  It contains elegant, simple and beautiful features that enhance your command line
+  interfaces functionally and aesthetically. '
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE
 - README.md
 files:
 - ".yardopts"
-- LICENSE
 - README.md
 - examples/24bit-colors.rb
 - examples/3bit-colors.rb
@@ -81,9 +78,11 @@ files:
 - lib/natty-ui/version.rb
 - lib/natty-ui/width_finder.rb
 - lib/natty_ui.rb
+- natty-ui.gemspec
 homepage: https://codeberg.org/mblumtritt/natty-ui
 licenses:
-- BSD-3-Clause
+- MIT
+- Ruby
 metadata:
   source_code_uri: https://codeberg.org/mblumtritt/natty-ui
   bug_tracker_uri: https://codeberg.org/mblumtritt/natty-ui/issues
@@ -104,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.1
 specification_version: 4
 summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
   natty user interface you like to have for your CLI.

data/LICENSE

@@ -1,28 +0,0 @@
-BSD 3-Clause License
-
-Copyright (c) 2017-2025, Mike Blumtritt. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.