natty-ui 0.11.1 → 0.12.0

data/lib/natty-ui/text.rb

@@ -42,8 +42,8 @@ module NattyUI
       # works for UTF-8 chars only!
       def char_width(char)
         ord = char.ord
-        return SPECIAL_CHARS[ord] || 2 if ord <= 0x1f
-        return 1 if ord <= 0x7e
+        return WIDTH_CONTROL_CHARS[ord] || 2 if ord < 0x20
+        return 1 if ord < 0xa1
         size = EastAsianWidth[ord]
         return @ambiguous_char_width if size == -1
         if size == 1 && char.size >= 2
@@ -158,7 +158,7 @@ module NattyUI
     UTF_8 = Encoding::UTF_8
     BBCODE = /(?:\[((?~[\[\]]))\])/
     WIDTH_SCANNER = /\G(?:(\1)|(\2)|(#{Ansi::CSI})|(#{Ansi::OSC})|(\X))/
-    SPECIAL_CHARS = {
+    WIDTH_CONTROL_CHARS = {
       0x00 => 0,
       0x01 => 1,
       0x02 => 1,

data/lib/natty-ui/version.rb

@@ -2,5 +2,5 @@
 
 module NattyUI
   # The version number of the gem.
-  VERSION = '0.11.1'
+  VERSION = '0.12.0'
 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/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/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
@@ -42,26 +40,10 @@ module NattyUI
         @final_text = [title]
         @max_value = [0, max_value.to_f].max if max_value
         @value = @progress = 0
-        draw(title, SPINNER[spinner] || spinner.to_s)
+        draw(title, spinner)
         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
       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)

data/lib/natty-ui.rb

@@ -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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-08-03 00:00:00.000000000 Z
 dependencies: []
 description: |
   This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely,
@@ -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
@@ -96,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely, natty