natty-ui 0.8.0 → 0.9.0

data/lib/natty-ui/wrapper/framed.rb

@@ -11,8 +11,7 @@ module NattyUI
     # {Wrapper::Element#close}.
     #
     # @param [Array<#to_s>] args more objects to print
-    # @param [Symbol] type frame type;
-    #   valid types are `:rounded`, `:simple`, `:heavy`, `:semi`, `:double`
+    # @param [:block, :double, :heavy, :rounded, :semi, :simple] type frame type
     # @yieldparam [Wrapper::Framed] framed the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Framed] itself, when no code block is given
@@ -30,30 +29,36 @@ module NattyUI
       protected
 
       def initialize(parent, type:)
-        @type = FRAME_PARTS[type] or
-          raise(ArgumentError, "invalid frame type - #{type.inspect}")
-        parent.puts(
-          color("#{@type[0]}#{@type[1] * (parent.available_width - 2)}")
-        )
-        super(parent, prefix: "#{color(@type[4])} ", prefix_width: 2)
-        @suffix = ' '
-        @suffix_width = 1
+        deco = as_deco(type)
+        super(parent, prefix: "#{deco[0]} ", prefix_width: 2, suffix_width: 2)
+        init(deco)
       end
 
-      def finish
-        @parent.puts(
-          color("#{@type[3]}#{@type[1] * (@parent.available_width - 2)}")
-        )
+      def as_deco(type)
+        if type.is_a?(Symbol)
+          ret = DECO[type] and return ret
+        elsif type.is_a?(String)
+          return type if type.size == 8
+          return type * 8 if type.size == 1
+        end
+        raise(ArgumentError, "invalid frame type - #{type.inspect}")
       end
 
-      def color(str) = str
+      def init(deco)
+        aw = @parent.available_width - 1
+        parent.puts("#{deco[1]}#{deco[2] * aw}")
+        @finish = "#{deco[5]}#{deco[6] * aw}"
+      end
+
+      def finish = @parent.puts(@finish)
 
-      FRAME_PARTS = {
-        rounded: '╭─╮╰│╯',
-        simple: '┌─┐└│┘',
-        heavy: '┏━┓┗┃┛',
-        double: '╔═╗╚║╝',
-        semi: '╒═╕╘│╛'
+      DECO = {
+        rounded: '│╭─╮│╰─╯',
+        simple: '│┌─┐│└─┘',
+        heavy: '┃┏━┓┃┗━┛',
+        double: '║╔═╗║╚═╝',
+        semi: '│╒═╕│╘═╛',
+        block: '▌▛▀▜▐▙▄▟'
       }.compare_by_identity.freeze
     end
   end

data/lib/natty-ui/wrapper/heading.rb

@@ -51,7 +51,7 @@ module NattyUI
         @parent.puts(
           title,
           prefix: "#{Ansi[39]}#{enclose} #{Ansi[:bold, 255]}",
-          suffix: " #{Ansi[:normal, 39]}#{enclose}#{Ansi::RESET}",
+          suffix: " #{Ansi[:bold_off, 39]}#{enclose}#{Ansi::RESET}",
           max_width: available_width - 2 - (enclose.size * 2)
         )
       end

data/lib/natty-ui/wrapper/horizontal_rule.rb

@@ -8,7 +8,7 @@ module NattyUI
     #
     # @param [#to_s] symbol string to build the horizontal rule
     # @return [Wrapper::Section, Wrapper] it's parent object
-    def hr(symbol = '=') = _element(:HorizontalRule, symbol)
+    def hr(symbol = '─') = _element(:HorizontalRule, symbol)
   end
 
   class Wrapper
@@ -23,8 +23,8 @@ module NattyUI
         size = NattyUI.display_width(symbol = symbol.to_s)
         return @parent.puts if size == 0
         max_width = available_width
-        @parent.puts(
-          symbol * ((max_width / size) - 1),
+        @parent.print(
+          symbol * ((max_width / size)),
           max_width: max_width,
           prefix: Ansi[39],
           prefix_width: 0,

data/lib/natty-ui/wrapper/list_in_columns.rb

@@ -25,7 +25,7 @@ module NattyUI
     #
     # @example ordered list, start at 100
     #   ui.ls('apple', 'banana', 'blueberry', 'pineapple', 'strawberry', glyph: 100)
-    #   # => 1 apple   2 banana   3 blueberry   4 pineapple   5 strawberry
+    #   # => 100 apple   101 banana   102 blueberry   103 pineapple   104 strawberry
     #
     # @example ordered list using, uppercase characters
     #   ui.ls('apple', 'banana', 'blueberry', 'pineapple', 'strawberry', glyph: :A)
@@ -84,7 +84,11 @@ module NattyUI
           ->(s) { "#{(glyph += 1).to_s.rjust(pad)} #{NattyUI.embellish(s)}" }
         when Symbol
           lambda do |s|
-            "#{t = glyph; glyph = glyph.succ; t} #{NattyUI.embellish(s)}"
+            "#{
+              t = glyph
+              glyph = glyph.succ
+              t
+            } #{NattyUI.embellish(s)}"
           end
         else
           ->(s) { "#{glyph} #{NattyUI.embellish(s)}" }
@@ -122,8 +126,7 @@ module NattyUI
       end
 
       def fill(ary, size)
-        diff = size - ary.size
-        ary.fill(nil, ary.size, diff) if diff.positive?
+        (diff = size - ary.size).positive? && ary.fill(nil, ary.size, diff)
       end
 
       Item =

data/lib/natty-ui/wrapper/message.rb

@@ -96,13 +96,13 @@ module NattyUI
       def initialize(parent, title:, glyph:)
         glyph = parent.wrapper.glyph(glyph) || glyph
         prefix_width = NattyUI.display_width(glyph) + 1
-        parent.puts(
-          title,
-          prefix: "#{glyph} ",
+        super(
+          parent,
+          prefix: ' ' * prefix_width,
           prefix_width: prefix_width,
           suffix_width: 0
         )
-        super(parent, prefix: ' ' * prefix_width, prefix_width: prefix_width)
+        parent.puts(title, prefix: "#{glyph} ", prefix_width: prefix_width)
       end
     end
   end

data/lib/natty-ui/wrapper/progress.rb

@@ -7,14 +7,23 @@ module NattyUI
   module Features
     # Creates progress element implementing additional {ProgressAttributes}.
     #
-    # A progress element has additional states and can be closed with {#completed}
-    # or {#failed}.
+    # When a `max_value` is given, the progress will by displayed as a bar.
+    # Otherwise the `spinner` is used for a little animation.
+    #
+    # When no pre-defined spinner is specified then spinner will be
+    # used char-wise as a string for the progress animation.
+    #
+    # A progress element has additional states and can be closed with
+    # {#completed} or {#failed}.
     #
     # @param [#to_s] title object to print as progress title
-    # @param [##to_f] max_value maximum value of the progress
+    # @param [#to_f] max_value maximum value of the progress
+    # @param [:bar, :blink, :blocks, :braile, :circle, :colors, :pulse,
+    #   :snake, :swap, :triangles, :vintage, #to_s] spinner type of spinner or
+    #   spinner elements
     # @return [Wrapper::Progress] the created progress element
-    def progress(title, max_value: nil)
-      _element(:Progress, title, max_value)
+    def progress(title, max_value: nil, spinner: :pulse)
+      _element(:Progress, title, max_value, spinner)
     end
   end
 
@@ -29,15 +38,31 @@ module NattyUI
 
       protected
 
-      def call(title, max_value)
+      def call(title, max_value, spinner)
         @final_text = [title]
         @max_value = [0, max_value.to_f].max if max_value
         @value = @progress = 0
-        draw(title)
+        draw(title, SPINNER[spinner] || spinner.to_s)
         self
       end
 
-      def draw(title)
+      SPINNER = {
+        bar: '▁▂▃▄▅▆▇█▇▆▅▄▃▂',
+        blink: '■□▪▫',
+        blocks: '▖▘▝▗',
+        braile: '⣷⣯⣟⡿⢿⣻⣽⣾',
+        braile_reverse: '⡿⣟⣯⣷⣾⣽⣻⢿',
+        circle: '◐◓◑◒',
+        colors: '🟨🟧🟥🟦🟪🟩',
+        pulse: '•✺◉●◉✺',
+        snake: '⠁⠉⠙⠸⢰⣠⣄⡆⠇⠃',
+        swap: '㊂㊀㊁',
+        triangles: '◢◣◤◥',
+        vintage: '-\\|/'
+      }.compare_by_identity.freeze
+      private_constant :SPINNER
+
+      def draw(title, _spinner)
         (wrapper.stream << @parent.prefix << "➔ #{title} ").flush
       end
 

data/lib/natty-ui/wrapper/query.rb

@@ -63,28 +63,24 @@ module NattyUI
       end
 
       def as_choices(choices, kw_choices)
-        ret = {}
-        choices.each_with_index do |title, i|
-          (i += 1) == 10 ? break : ret[i.to_s] = title.to_s.tr("\r\n\t", ' ')
-        end
-        ret.merge!(
-          kw_choices
-            .transform_keys! { [' ', _1.to_s[0]].max }
-            .transform_values! { _1.to_s.tr("\r\n\t", ' ') }
-        )
+        choices
+          .take(9)
+          .each_with_index
+          .to_h { |str, i| [i + 1, str] }
+          .merge!(kw_choices)
+          .transform_keys!(&:to_s)
+          .transform_values! { _1.to_s.gsub(/[[:space:]]/, ' ') }
       end
 
       def read(choices, result)
         while true
-          char = NattyUI.in_stream.getch
-          return if "\3\4".include?(char)
+          char = NattyUI.read_key
+          return if char == 'Ctrl+C'
           next unless choices.key?(char)
           return char if result == :char
           return choices[char] if result == :title
           return char, choices[char]
         end
-      rescue Interrupt, SystemCallError
-        nil
       end
 
       CHOICE_MARK = Ansi[:bold, 34]

data/lib/natty-ui/wrapper/request.rb

@@ -46,8 +46,8 @@ module NattyUI
         (wrapper.stream << ANSI_PREFIX).flush if wrapper.ansi?
       end
 
-      ANSI_PREFIX = Ansi::RESET + Ansi[:italic]
-      ANSI_FINISH = Ansi::RESET + Ansi::CURSOR_UP + Ansi::LINE_ERASE
+      ANSI_PREFIX = Ansi::RESET + Ansi::ITALIC
+      ANSI_FINISH = Ansi::RESET + Ansi::LINE_PREVIOUS + Ansi::LINE_ERASE
       private_constant :ANSI_PREFIX, :ANSI_FINISH
     end
   end

data/lib/natty-ui/wrapper/section.rb

@@ -8,10 +8,14 @@ module NattyUI
     # into the section.
     #
     # @param [Array<#to_s>] args optional objects to print
+    # @param [String] prefix used for each printed line
+    # @param [String] suffix used for each printed line
     # @yieldparam [Wrapper::Section] section the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Section] itself, when no code block is given
-    def section(*args, &block) = _section(:Section, args, prefix: '  ', &block)
+    def section(*args, prefix: '  ', suffix: '  ', &block)
+      _section(:Section, args, prefix: prefix, suffix: suffix, &block)
+    end
     alias sec section
   end
 
@@ -38,10 +42,12 @@ module NattyUI
         return self if @status
         @parent.puts(
           *args,
-          prefix: "#{@prefix}#{kwargs[:prefix]}",
-          prefix_width: @prefix_width + kwargs[:prefix_width].to_i,
-          suffix: "#{kwargs[:suffix]}#{@suffix}",
-          suffix_width: @suffix_width + kwargs[:suffix_width].to_i
+          **kwargs.merge!(
+            prefix: "#{@prefix}#{kwargs[:prefix]}",
+            prefix_width: @prefix_width + kwargs[:prefix_width].to_i,
+            suffix: "#{kwargs[:suffix]}#{@suffix}",
+            suffix_width: @suffix_width + kwargs[:suffix_width].to_i
+          )
         )
         self
       end
@@ -55,10 +61,12 @@ module NattyUI
         return self if @status
         @parent.print(
           *args,
-          prefix: "#{@prefix}#{kwargs[:prefix]}",
-          prefix_width: @prefix_width + kwargs[:prefix_width].to_i,
-          suffix: "#{kwargs[:suffix]}#{@suffix}",
-          suffix_width: @suffix_width + kwargs[:suffix_width].to_i
+          **kwargs.merge!(
+            prefix: "#{@prefix}#{kwargs[:prefix]}",
+            prefix_width: @prefix_width + kwargs[:prefix_width].to_i,
+            suffix: "#{kwargs[:suffix]}#{@suffix}",
+            suffix_width: @suffix_width + kwargs[:suffix_width].to_i
+          )
         )
         self
       end
@@ -87,17 +95,23 @@ module NattyUI
       # @!visibility private
       def inspect = @status ? "#{_to_s[..-2]} status=#{@status}>" : _to_s
 
+      # @!visibility private
+      def rcol = @parent.rcol - @suffix_width
+
       protected
 
       def initialize(
         parent,
         prefix:,
-        prefix_width: NattyUI.display_width(prefix)
+        prefix_width: NattyUI.display_width(prefix),
+        suffix: nil,
+        suffix_width: NattyUI.display_width(suffix)
       )
         super(parent)
         @prefix = prefix
+        @suffix = suffix
         @prefix_width = prefix_width
-        @suffix_width = 0
+        @suffix_width = suffix_width
       end
     end
   end

data/lib/natty-ui/wrapper/table.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'element'
 
 module NattyUI
@@ -10,11 +11,13 @@ module NattyUI
     #   construction. This means table features are not complete defined and
     #   may change in near future.
     #
+    # Defined values for `type` are
+    # :double, :heavy, :semi, :simple
+    #
     # @overload table(type: simple)
     #   Construct and display a table.
     #
-    #   @param [Symbol] type frame type;
-    #     valid types are `:simple`, `:heavy`, `:semi`, `:double`
+    #   @param [Symbol] type frame type
     #   @yieldparam [Table] table construction helper
     #   @return [Wrapper::Section, Wrapper] it's parent object
     #
@@ -39,8 +42,7 @@ module NattyUI
     #   Display the given arrays as rows of a table.
     #
     #   @param [Array<#to_s>] args one or more arrays representing rows of the table
-    #   @param [Symbol] type frame type;
-    #     valid types are `:simple`, `:heavy`, `:semi`, `:double`
+    #   @param [Symbol] type frame type
     #   @return [Wrapper::Section, Wrapper] it's parent object
     #
     #   @example
@@ -115,7 +117,7 @@ module NattyUI
             raise(ArgumentError, "invalid table type - #{type.inspect}"),
           Ansi[39],
           Ansi::RESET
-        ) { |line| @parent.puts(line) }
+        ) { @parent.puts(_1) }
         @parent
       end
 
@@ -142,7 +144,7 @@ module NattyUI
           @parent.available_width - 1,
           seperator,
           NattyUI.plain(seperator, ansi: false)[-1] == ' '
-        ) { |line| @parent.puts(line) }
+        ) { @parent.puts(_1) }
         @parent
       end
     end
@@ -217,7 +219,7 @@ module NattyUI
 
       def align(str, width, alignment)
         return str unless (width -= NattyUI.display_width(str)).positive?
-        return str << (' ' * width) if alignment == :left
+        return str + (' ' * width) if alignment == :left
         (' ' * width) << str
       end
 
@@ -268,10 +270,8 @@ module NattyUI
 
       def adjusted_widths(col_widths)
         ret = col_widths.dup
-        if ret.sum <=
-             (left = @max_width - (@col_div_size * (col_widths.size - 1)))
-          return ret
-        end
+        left = @max_width - (@col_div_size * (col_widths.size - 1))
+        return ret if ret.sum <= left
         indexed = ret.each_with_index.to_a
         # TODO: optimize this!
         until ret.sum <= left

data/lib/natty-ui/wrapper.rb

@@ -2,6 +2,7 @@
 
 require 'io/console'
 require_relative 'ansi'
+require_relative 'wrapper/animate'
 require_relative 'wrapper/ask'
 require_relative 'wrapper/framed'
 require_relative 'wrapper/heading'
@@ -65,7 +66,7 @@ module NattyUI
     def print(*args, **kwargs)
       args = prepare_print(args, kwargs).to_a
       @lines_written += args.size - 1
-      @stream.print(args.join("\n"))
+      @stream.print(*args)
       @stream.flush
       self
     end
@@ -148,7 +149,10 @@ module NattyUI
     alias available_width screen_columns
 
     # @!visibility private
-    def prefix = ''
+    alias rcol screen_columns
+
+    # @!visibility private
+    def prefix = nil
 
     # @return [Array<Symbol>] available glyph names
     def glyph_names = GLYPHS.keys
@@ -164,25 +168,26 @@ module NattyUI
     protected
 
     def prepare_print(args, kwargs)
-      prefix = kwargs[:prefix] and prefix = NattyUI.plain(prefix, ansi: false)
-      suffix = kwargs[:suffix] and suffix = NattyUI.plain(suffix, ansi: false)
+      _prepare_print(args, kwargs) { NattyUI.plain(_1, ansi: false) }
+    end
+
+    def _prepare_print(args, kwargs, &cvt)
+      prefix = kwargs[:prefix] and prefix = prefix.empty? ? '' : cvt[prefix]
+      suffix = kwargs[:suffix] and suffix = suffix.empty? ? '' : cvt[suffix]
       return ["#{prefix}#{suffix}"] if args.empty?
       NattyUI
         .each_line(
-          *args.map! { NattyUI.plain(_1, ansi: false) },
-          max_width: max_with(prefix, suffix, kwargs)
+          *args.map!(&cvt),
+          max_width:
+            kwargs.fetch(:max_width) do
+              screen_columns -
+                kwargs.fetch(:prefix_width) { NattyUI.display_width(prefix) } -
+                kwargs.fetch(:suffix_width) { NattyUI.display_width(suffix) }
+            end
         )
         .map { "#{prefix}#{_1}#{suffix}" }
     end
 
-    def max_with(prefix, suffix, kwargs)
-      mw = kwargs[:max_width] and return mw
-      mw = screen_columns
-      mw -= kwargs[:prefix_width] || NattyUI.display_width(prefix) if prefix
-      mw -= kwargs[:suffix_width] || NattyUI.display_width(suffix) if suffix
-      mw
-    end
-
     def temp_func
       lambda do
         @stream.flush

data/lib/natty-ui.rb

@@ -149,9 +149,12 @@ module NattyUI
         str
           .to_s
           .each_line(chomp: true) do |line|
-            Reline::Unicode.split_by_width(line, max_width)[0].each do |part|
-              yield(part) if part
-            end
+            next yield(line) if line.empty?
+            lines, _height = Reline::Unicode.split_by_width(line, max_width)
+            lines.compact!
+            next if lines.empty?
+            lines.pop if lines[-1].empty?
+            lines.each(&block)
           end
       end
       nil
@@ -159,23 +162,35 @@ module NattyUI
 
     # Read next raw key (keyboard input) from {in_stream}.
     #
+    # The input will be returned as named key codes like "Ctrl+C" by default.
+    # This can be changed by the `mode` parameter:
+    #
+    # - `:named` - name if available (fallback to raw)
+    # - `:raw` - key code "as is"
+    # - `:both` - key code and name if available
+    #
+    # @param [:named, :raw, :both] mode modfies the result
     # @return [String] read key
-    def read_key
+    def read_key(mode: :named)
       return @in_stream.getch unless defined?(@in_stream.getc)
       return @in_stream.getc unless defined?(@in_stream.raw)
-      @in_stream.raw do |raw|
-        key = raw.getc
-        while (nc = raw.read_nonblock(1, exception: false))
+      @in_stream.raw do |raw_stream|
+        key = raw_stream.getc
+        while (nc = raw_stream.read_nonblock(1, exception: false))
           nc.is_a?(String) ? key += nc : break
         end
-        key
+        return key if mode == :raw
+        return key, KEY_MAP[key]&.dup if mode == :both
+        KEY_MAP[key]&.dup || key
       end
+    rescue Interrupt, SystemCallError
+      nil
     end
 
     private
 
     def wrapper_class(stream, ansi)
-      return AnsiWrapper if ansi == true
+      return AnsiWrapper if ansi == true || ENV['ANSI'] == '1'
       if ansi == false || ENV.key?('NO_COLOR') || ENV['TERM'] == 'dumb'
         return Wrapper
       end
@@ -197,8 +212,14 @@ module NattyUI
 
   @element = StdOut
   self.in_stream = STDIN
+
+  autoload(:KEY_MAP, File.join(__dir__, 'natty-ui', 'key_map'))
+  private_constant :KEY_MAP
 end
 
-# @see NattyUI.element
-# @return [NattyUI::Wrapper, NattyUI::Wrapper::Element] active UI element
-def ui = NattyUI.element unless defined?(ui)
+# @!visibility private
+module Kernel
+  # @see NattyUI.element
+  # @return [NattyUI::Wrapper, NattyUI::Wrapper::Element] active UI element
+  def ui = NattyUI.element unless defined?(ui)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-07-07 00:00:00.000000000 Z
 dependencies: []
 description: |
   This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely,
@@ -28,20 +28,32 @@ files:
 - examples/24bit-colors.rb
 - examples/3bit-colors.rb
 - examples/8bit-colors.rb
+- examples/animate.rb
 - examples/attributes.rb
 - examples/demo.rb
 - examples/illustration.png
 - examples/illustration.rb
-- examples/list_in_columns.rb
+- examples/ls.rb
+- examples/message.rb
 - examples/progress.rb
 - examples/query.rb
+- examples/read_key.rb
 - examples/table.rb
 - lib/natty-ui.rb
 - lib/natty-ui/ansi.rb
+- lib/natty-ui/ansi_constants.rb
 - lib/natty-ui/ansi_wrapper.rb
 - lib/natty-ui/features.rb
+- lib/natty-ui/key_map.rb
+- lib/natty-ui/line_animation.rb
+- lib/natty-ui/line_animation/default.rb
+- lib/natty-ui/line_animation/matrix.rb
+- lib/natty-ui/line_animation/rainbow.rb
+- lib/natty-ui/line_animation/test.rb
+- lib/natty-ui/line_animation/type_writer.rb
 - lib/natty-ui/version.rb
 - lib/natty-ui/wrapper.rb
+- lib/natty-ui/wrapper/animate.rb
 - lib/natty-ui/wrapper/ask.rb
 - lib/natty-ui/wrapper/element.rb
 - lib/natty-ui/wrapper/framed.rb
@@ -81,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.13
+rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
 summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely, natty