natty-ui 0.11.2 → 0.12.1

data/lib/natty-ui/glyph.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'text'
+
+module NattyUI
+  # Helper class to select glyph types.
+  # @see Features#message
+  module Glyph
+    # Define glyph type used by default.
+    # @attribute [w] self.default
+    # @param value [Symbol] type name
+    # @return [Symbol] type name
+    def self.default=(value)
+      @default = self[value.nil? || value == :default ? :point : value]
+    end
+
+    # Defined glyph type names.
+    # @see []
+    #
+    # @attribute [r] self.names
+    # @return [Array<Symbol>] supported attribute names
+    def self.names = @all.keys
+
+    # @param name [Symbol, #to_s]
+    #   defined type name (see {.names})
+    #   or glyph
+    # @return [String] glyph definition
+    def self.[](name)
+      return @default if name == :default
+      Text.embellish(
+        if name.is_a?(Symbol)
+          @all[name] or raise(ArgumentError, "invalid glyph type - #{name}")
+        else
+          name.to_s
+        end
+      )
+    end
+
+    @all = {
+      completed: '[b 52]✓',
+      dot: '[27]•',
+      error: '[b d0]𝙓',
+      failed: '[b c4]𝑭',
+      information: '[b 77]𝒊',
+      point: '[27]◉',
+      query: '[b 27]▸',
+      task: '[b 27]➔',
+      warning: '[b dd]!'
+    }.compare_by_identity
+
+    # GLYPH = {
+    #   default: '●',
+    #   information: '🅸 ',
+    #   warning: '🆆 ',
+    #   error: '🅴 ',
+    #   completed: '✓',
+    #   failed: '🅵 ',
+    #   task: '➔',
+    #   query: '🆀 '
+    # }.compare_by_identity.freeze
+
+    self.default = nil
+  end
+end

data/lib/natty-ui/preload.rb

@@ -3,7 +3,10 @@
 require_relative '../natty-ui'
 
 module NattyUI
-  Animation.defined?(:matrix)
-  Text::EastAsianWidth[0]
+  Animation[nil]
+  Frame[:default]
+  Glyph[:default]
   KEY_MAP[0]
+  Spinner[:default]
+  Text.width("\u1100")
 end

data/lib/natty-ui/spinner.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require_relative 'ansi'
+
+module NattyUI
+  # Helper class to select spinner types.
+  # @see Features#progress
+  module Spinner
+    class << self
+      # Define spinner type used by default.
+      # @attribute [w] self.default
+      # @param value [Symbol] type name
+      # @return [Symbol] type name
+      def default=(value)
+        @default = self[value.nil? || value == :default ? :pulse : value]
+      end
+
+      # Defined spinner type names.
+      # @see []
+      #
+      # @attribute [r] self.names
+      # @return [Array<Symbol>] supported attribute names
+      def names = @all.keys
+
+      # @param name [Symbol, #to_a, #to_s]
+      #   defined type name (see {.names})
+      #   or spinner elements
+      # @return [Enumerator] spinner definition
+      def [](name)
+        return @default if name == :default
+        parts =
+          if name.is_a?(Symbol)
+            @all[name] or raise(ArgumentError, "invalid spinner type - #{name}")
+          else
+            name
+          end
+        parts =
+          (parts.respond_to?(:map) ? parts : parts.to_s.chars).map do |part|
+            "#{@style}#{part}#{Ansi::RESET}"
+          end
+        raise(ArgumentError, "invalid spinner type - #{name}") if parts.empty?
+        parts = parts.zip(parts).flatten(1) while parts.size < 6
+        Enumerator.new { |y| parts.each { y << _1 } while true }
+      end
+
+      private
+
+      def slide(a, b, size, prefix = nil, suffix = prefix)
+        Enumerator.new do |y|
+          fn =
+            lambda do |i|
+              y << "#{prefix}#{a * (i += 1)}#{b * (size - i)}#{suffix}"
+            end
+          size.times(&fn)
+          a, b = b, a
+          size.times(&fn)
+        end
+      end
+
+      def bounce(a, b, size, prefix = nil, suffix = prefix)
+        Enumerator.new do |y|
+          fn =
+            lambda do |i|
+              y << "#{prefix}#{a * (i += 1)}#{b * (size - i)}#{suffix}"
+            end
+          size.times(&fn)
+          a, b = b, a
+          (size - 1).times(&fn)
+          fn = ->(i) { y << "#{prefix}#{a * i}#{b * (size - i)}#{suffix}" }
+          (size - 2).downto(0, &fn)
+          a, b = b, a
+          (size - 1).downto(0, &fn)
+        end
+      end
+
+      def move(a, b, size, prefix = nil, suffix = prefix)
+        Enumerator.new do |y|
+          size.times do |i|
+            y << "#{prefix}#{b * i}#{a}#{b * (size - i - 1)}#{suffix}"
+          end
+          y << "#{prefix}#{b * size}#{suffix}"
+        end
+      end
+    end
+
+    @style = Ansi[:bold, 220]
+    @all = {
+      bar: '▁▂▃▄▅▆▇█▇▆▅▄▃▂',
+      blink: '■□▪▫',
+      blocks: '▖▘▝▗',
+      bounce: bounce('◼︎', '◻︎', 7),
+      bounce2: bounce('▰', '▱', 7),
+      bounce3: bounce('● ', '◌ ', 7),
+      bounce4: bounce('=', ' ', 5, '[', ']'),
+      circle: '◐◓◑◒',
+      colors: '🟨🟨🟧🟧🟥🟥🟦🟦🟪🟪🟩🟩',
+      dots: '⣷⣯⣟⡿⢿⣻⣽⣾',
+      dots2: '⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏',
+      dots3: '⠋⠙⠚⠞⠖⠦⠴⠲⠳⠓',
+      dots4: '⠄⠆⠇⠋⠙⠸⠰⠠⠰⠸⠙⠋⠇⠆',
+      dots5: '⠋⠙⠚⠒⠂⠂⠒⠲⠴⠦⠖⠒⠐⠐⠒⠓⠋',
+      move: move('◼︎', '◻︎', 7),
+      move2: move('▰', '▱', 7),
+      move3: move('● ', '◌ ', 7),
+      move4: move('=', ' ', 5, '[', ']'),
+      pulse: '•✺◉●◉✺',
+      slide: slide('◼︎', '◻︎', 7),
+      slide2: slide('▰', '▱', 7),
+      slide3: slide('● ', '◌ ', 7),
+      slide4: slide('=', ' ', 5, '[', ']'),
+      slide5: slide('.', ' ', 3),
+      snake: '⠁⠉⠙⠸⢰⣠⣄⡆⠇⠃',
+      stod: '⡿⣟⣯⣷⣾⣽⣻⢿',
+      swap: '㊂㊀㊁',
+      vintage: '-\\|/'
+    }.compare_by_identity
+
+    self.default = nil
+  end
+end

data/lib/natty-ui/text/east_asian_width.rb

@@ -1168,7 +1168,7 @@ module NattyUI
         0x1f190,
         0x1f19a,
         0x1f1ac,
-        0x1f1ff,
+        0x1f1e5,
         0x1f202,
         0x1f20f,
         0x1f23b,

data/lib/natty-ui/version.rb

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

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

@@ -56,7 +56,7 @@ module NattyUI
       end
 
       def draw(question)
-        glyph = NattyUI.glyph(:query)
+        glyph = NattyUI::Glyph[:query]
         @parent.print(
           question,
           prefix: "#{glyph} #{Ansi[255]}",

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

@@ -11,12 +11,12 @@ module NattyUI
     # {Wrapper::Element#close}.
     #
     # @param [Array<#to_s>] args more objects to print
-    # @param [:double, :heavy, :rounded, :semi, :simple] type frame type
+    # @param [Symbol, String] type frame type; see {NattyUI::Frame}
     # @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
-    def framed(*args, type: :rounded, &block)
-      _section(:Framed, args, type: NattyUI.frame(type), &block)
+    def framed(*args, type: :default, &block)
+      _section(:Framed, args, type: NattyUI::Frame[type], &block)
     end
   end
 

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

@@ -7,32 +7,33 @@ module NattyUI
     # Prints a H1 title.
     #
     # @param [#to_s] title text
+    # @param [#to_i] space space around the heading
     # @return [Wrapper::Section, Wrapper] it's parent object
-    def h1(title) = _element(:Heading, title, '═══════')
+    def h1(title, space: 0) = _element(:Heading, title, space, '═══════')
 
     # Prints a H2 title.
     #
     # @param (see #h1)
     # @return (see #h1)
-    def h2(title) = _element(:Heading, title, '━━━━━')
+    def h2(title, space: 0) = _element(:Heading, title, space, '━━━━━')
 
     # Prints a H3 title.
     #
     # @param (see #h1)
     # @return (see #h1)
-    def h3(title) = _element(:Heading, title, '━━━')
+    def h3(title, space: 0) = _element(:Heading, title, space, '━━━')
 
     # Prints a H4 title.
     #
     # @param (see #h1)
     # @return (see #h1)
-    def h4(title) = _element(:Heading, title, '───')
+    def h4(title, space: 0) = _element(:Heading, title, space, '───')
 
     # Prints a H5 title.
     #
     # @param (see #h1)
     # @return (see #h1)
-    def h5(title) = _element(:Heading, title, '──')
+    def h5(title, space: 0) = _element(:Heading, title, space, '──')
   end
 
   class Wrapper
@@ -47,13 +48,16 @@ module NattyUI
     class Heading < Element
       protected
 
-      def call(title, enclose)
+      def call(title, space, enclose)
+        (space = space.to_i).positive? and (before = space / 2).positive? and
+          @parent.space(before)
         @parent.puts(
           title,
           prefix: "#{Ansi[39]}#{enclose} #{Ansi[:bold, 255]}",
           suffix: " #{Ansi[:bold_off, 39]}#{enclose}#{Ansi::RESET}",
           max_width: available_width - 2 - (enclose.size * 2)
         )
+        @parent.space(space - before) if before
       end
     end
   end

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

@@ -89,7 +89,7 @@ module NattyUI
             } #{Text.embellish(s)}"
           end
         else
-          ->(s) { "#{glyph} #{Text.embellish(s)}" }
+          ->(s) { "#{Text.embellish(glyph)} #{Text.embellish(s)}" }
         end
       end
 

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

@@ -9,7 +9,7 @@ module NattyUI
     #
     # @param [#to_s] title object to print as section title
     # @param [Array<#to_s>] args more objects to print
-    # @param [#to_s] glyph glyph/prefix used for the title
+    # @param [Symbol, #to_s] glyph used for the title; see {NattyUI::Glyph}
     # @yieldparam [Wrapper::Message] message the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Message] itself, when no code block is given
@@ -94,7 +94,7 @@ module NattyUI
       protected
 
       def initialize(parent, title:, glyph:)
-        glyph = NattyUI.glyph(glyph) || glyph
+        glyph = NattyUI::Glyph[glyph]
         prefix_width = Text.width(glyph) + 1
         super(
           parent,

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

@@ -43,9 +43,17 @@ module NattyUI
     # @return [Float] current value
     attr_reader :value
 
-    def value=(val)
-      @value = [0, val.to_f].max
-      @max_value = @value if @max_value&.< 0
+    def value=(value)
+      @value = [0, value.to_f].max
+      @max_value = @value if @max_value&.< @value
+      redraw
+    end
+
+    # @return [String, nil] current information
+    attr_reader :info
+
+    def info=(value)
+      @info = value
       redraw
     end
 

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

@@ -18,11 +18,9 @@ module NattyUI
     #
     # @param [#to_s] title object to print as progress title
     # @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
+    # @param [Symbol, #to_a, #to_s] spinner spinner type; see {NattyUI::Spinner}
     # @return [Wrapper::Progress] the created progress element
-    def progress(title, max_value: nil, spinner: :pulse)
+    def progress(title, max_value: nil, spinner: :default)
       _element(:Progress, title, max_value, spinner)
     end
   end
@@ -38,37 +36,16 @@ module NattyUI
 
       protected
 
-      def call(title, max_value, spinner)
+      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, SPINNER[spinner] || spinner.to_s)
-        self
-      end
-
-      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
+        self
       end
 
-      def end_draw = (wrapper.stream << "\n")
-
       def redraw
+        return if @status
         return (wrapper.stream << '.').flush unless @max_value
         cn = (20 * @value / @max_value).to_i
         return if @progress == cn
@@ -77,15 +54,9 @@ module NattyUI
       end
 
       def finish
-        end_draw
+        wrapper.stream << "\n"
         return @parent.failed(*@final_text) if failed?
-        _section(
-          :Message,
-          @final_text,
-          owner: @parent,
-          title: @final_text.shift,
-          glyph: @status = :completed
-        )
+        @parent.message(*@final_text, glyph: @status = :completed)
       end
     end
   end

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

@@ -36,7 +36,7 @@ module NattyUI
 
       def draw(question)
         wrapper = @parent.wrapper
-        glyph = NattyUI.glyph(:query)
+        glyph = NattyUI :Glyph[:query]
         @parent.print(
           question,
           prefix: "#{glyph} #{Ansi[255]}",

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

@@ -7,14 +7,11 @@ module NattyUI
     #
     # Table view of data.
     #
-    # Defined values for `type` are
-    # :double, :heavy, :semi, :simple
-    #
-    # @overload table(*args, type: simple, expand: false)
+    # @overload table(*args, type: :default, expand: false)
     #   Display the given arrays as rows of a table.
     #
     #   @param [#map<#map<#to_s>>] args one or more arrays representing rows of the table
-    #   @param [Symbol] type frame type
+    #   @param [Symbol, String] type frame type; see {NattyUI::Frame}
     #   @param [false, true. :equal] expand
     #
     #   @example
@@ -33,10 +30,10 @@ module NattyUI
     #     # ───────┼───────┼───────────
     #     # kiwi   │ 1.5$  │ Newzeeland
     #
-    # @overload table(type: simple, expand: false)
+    # @overload table(type: :default, expand: false)
     #   Construct and display a table.
     #
-    #   @param [Symbol] type frame type
+    #   @param [Symbol, String] type frame type; see {NattyUI::Frame}
     #   @param [false, true. :equal] expand
     #
     #   @example
@@ -58,8 +55,8 @@ module NattyUI
     #
     # @yield [Table] table construction helper
     # @return [Wrapper::Section, Wrapper] it's parent object
-    def table(*table, type: :simple, expand: false)
-      type = NattyUI.frame(type)
+    def table(*table, type: :default, expand: false)
+      type = NattyUI::Frame[type]
       table = Table.create(*table)
       yield(table) if block_given?
       _element(:Table, table, type, expand)
@@ -162,8 +159,7 @@ module NattyUI
         if columns.size == 1 && columns[0].respond_to?(:map)
           columns = columns[0]
         end
-        columns =
-          columns.map { |cell| as_cell(cell, align, style) if cell }.to_a
+        columns = columns.map { as_cell(_1, align, style) if _1 }.to_a
         @rows << (columns.empty? ? nil : columns)
         self
       end
@@ -370,7 +366,7 @@ module NattyUI
           @parent.available_width - 1,
           frame,
           enlarge
-        ) { |line| @parent.puts(line) }
+        ) { @parent.puts(_1) }
         @parent
       end
     end

data/lib/natty-ui/wrapper.rb

@@ -31,6 +31,15 @@ module NattyUI
     # @return [Boolean] whether ANSI is supported
     def ansi? = false
 
+    # Cursor visibility
+    # @attribute [r] cursor
+    def cursor = @cursor.zero?
+
+    # @attribute [w] cursor
+    def cursor=(value)
+      # nop
+    end
+
     # @attribute [r] screen_size
     # @return [[Integer, Integer]] screen size as rows and columns
     def screen_size = (@screen_size ||= determine_screen_size)
@@ -43,6 +52,10 @@ module NattyUI
     # @return [Integer] number of screen columns
     def screen_columns = screen_size[1]
 
+    # @attribute [r] wrapper
+    # @return [Wrapper] self
+    alias wrapper itself
+
     # @!group Tool functions
 
     # Print given arguments line-wise to the output stream.
@@ -144,10 +157,6 @@ module NattyUI
     # @!visibility private
     alias inspect to_s
 
-    # @attribute [r] wrapper
-    # @return [Wrapper] self
-    alias wrapper itself
-
     # @!visibility private
     alias available_width screen_columns
 
@@ -198,7 +207,7 @@ module NattyUI
 
     def initialize(stream)
       @stream = stream
-      @lines_written = 0
+      @lines_written = @cursor = 0
     end
 
     private_class_method :new

data/lib/natty-ui.rb

@@ -5,8 +5,8 @@ require_relative 'natty-ui/wrapper'
 require_relative 'natty-ui/ansi_wrapper'
 
 #
-# Module to create beautiful, nice, nifty, fancy, neat, pretty, cool, lovely,
-# natty user interfaces for your CLI application.
+# Module to create beautiful, nice, nifty, fancy, neat, pretty, cool, rich,
+# lovely, natty user interfaces for your CLI application.
 #
 # It creates {Wrapper} instances which can optionally support ANSI. The UI
 # consists of {Wrapper::Element}s and {Wrapper::Section}s for different
@@ -135,34 +135,6 @@ module NattyUI
       nil
     end
 
-    # @return [Array<Symbol>] available glyph names
-    def glyph_names = GLYPH.keys
-
-    # Get a pre-defined glyph.
-    #
-    # @param [Symbol] name glyph name
-    # @return [String] the glyph
-    # @return [nil] when glyph is not defined
-    def glyph(name) = GLYPH[name]
-
-    # @return [Array<Symbol>] available frame names
-    def frame_names = FRAME.keys
-
-    # Get a frame definition.
-    #
-    # @param [Symbol] name frame type name
-    # @return [String] the frame definition
-    # @raise [ArgumentError] when an invalid name is specified
-    def frame(name)
-      if name.is_a?(Symbol)
-        ret = FRAME[name] and return ret
-      elsif name.is_a?(String)
-        return name if name.size == 11
-        return name * 11 if name.size == 1
-      end
-      raise(ArgumentError, "invalid frame type - #{name.inspect}")
-    end
-
     private
 
     def wrapper_class(stream, ansi)
@@ -188,44 +160,12 @@ module NattyUI
 
   dir = __dir__
   autoload(:Animation, File.join(dir, 'natty-ui', 'animation'))
+  autoload(:Frame, File.join(dir, 'natty-ui', 'frame'))
+  autoload(:Glyph, File.join(dir, 'natty-ui', 'glyph'))
   autoload(:KEY_MAP, File.join(dir, 'natty-ui', 'key_map'))
+  autoload(:Spinner, File.join(dir, 'natty-ui', 'spinner'))
 
-  GLYPH = {
-    default: "#{Ansi[:bold, 255]}•#{Ansi::RESET}",
-    point: "#{Ansi[0x27]}◉#{Ansi::RESET}",
-    information: "#{Ansi[:bold, 119]}𝒊#{Ansi::RESET}",
-    warning: "#{Ansi[:bold, 221]}!#{Ansi::RESET}",
-    error: "#{Ansi[:bold, 208]}𝙓#{Ansi::RESET}",
-    completed: "#{Ansi[:bold, 82]}✓#{Ansi::RESET}",
-    failed: "#{Ansi[:bold, 196]}𝑭#{Ansi::RESET}",
-    task: "#{Ansi[:bold, 39]}➔#{Ansi::RESET}",
-    query: "#{Ansi[:bold, 39]}▸#{Ansi::RESET}"
-  }.compare_by_identity.freeze
-
-  # GLYPH = {
-  #   default: '●',
-  #   information: '🅸 ',
-  #   warning: '🆆 ',
-  #   error: '🅴 ',
-  #   completed: '✓',
-  #   failed: '🅵 ',
-  #   task: '➔',
-  #   query: '🆀 '
-  # }.compare_by_identity.freeze
-
-  FRAME = {
-    rounded: '╭╮╰╯│─┼┬┴├┤',
-    simple: '┌┐└┘│─┼┬┴├┤',
-    heavy: '┏┓┗┛┃━╋┳┻┣┫',
-    double: '╔╗╚╝║═╬╦╩╠╣',
-    semi: '╒╕╘╛│═╪╤╧╞╡',
-    semi2: '╓╖╙╜│─╫╥╨╟╢',
-    rows: '     ──    ',
-    cols: '    │ │    ',
-    undecorated: '           '
-  }.compare_by_identity.freeze
-
-  private_constant :Animation, :KEY_MAP, :GLYPH, :FRAME
+  private_constant :Animation, :KEY_MAP
 
   @element = StdOut
   self.in_stream = STDIN

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.1
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2024-08-18 00:00:00.000000000 Z
 dependencies: []
 description: |
-  This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely,
+  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.
@@ -49,8 +49,11 @@ files:
 - lib/natty-ui/ansi.rb
 - lib/natty-ui/ansi/constants.rb
 - lib/natty-ui/ansi_wrapper.rb
+- lib/natty-ui/frame.rb
+- lib/natty-ui/glyph.rb
 - lib/natty-ui/key_map.rb
 - lib/natty-ui/preload.rb
+- lib/natty-ui/spinner.rb
 - lib/natty-ui/text.rb
 - lib/natty-ui/text/east_asian_width.rb
 - lib/natty-ui/version.rb
@@ -99,6 +102,6 @@ requirements: []
 rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
-summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely, natty
-  user interface you like to have for your CLI.
+summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
+  natty user interface you like to have for your CLI.
 test_files: []