natty-ui 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53cd6e051da19fb57efdfe448cfdb6ede5e7bdae3c8d59db5690ea32bb9bcd39
-  data.tar.gz: 39a38e0d1c1314e881b72aa7a6d74fdba47225ffadb110a47fd0db305095a564
+  metadata.gz: 0cf1f1c1bbe16142b1a5dde311305de0f3caa3d67bff7ff2886000b0838dc85e
+  data.tar.gz: b3ae72c58b04e347098a43a96093429e79acb210a218f9250e9e1e258c6f9d50
 SHA512:
-  metadata.gz: cb080dd1ea872a74f1ad1db42be94020cea77892c1fcab5a4b7850f78c2624d9a5bb9576442b352975644f66de3bc9e2d446e2a73c5dad9390b85b0c187da1ee
-  data.tar.gz: c2c5ee5cfbfcc1481ab842470f654176836b962d0ffc6cc3019c5e2e45b3c50cfd0613b9c7c6a82d9800e2b84e3cc26f538a959095101a512d33947be8d8d684
+  metadata.gz: 34ffe4f15d6094e8edd2bc84606787531f1545391d4d7dbc0178d756c4edddc1afe2c9bcec41dbe033bd2af8337f7cfdfa6b0c40d3c229eff062b5a33f013c83
+  data.tar.gz: af06c7464620b0a8012fcd835a1304fce821b7194866b0be7f51af92b3f1c553a89ca9b4f00d98bbf6c7cc99ca1bba7dbef947718a24ddc874afd8d7e349e5f1

data/examples/3bit-colors.rb

@@ -6,9 +6,9 @@ ui.space
 ui.h1 'NattyUI: 3/4-bit Color Support'
 ui.space
 
-color = ->(n) { "[[#{n}]]#{n.ljust(14)}[[/]] [[on_#{n}]] sample text [[/]]" }
+color = ->(n, j) { "[[#{n}]]#{n.ljust(j)}[[/]] [[on_#{n}]] sample text [[/]]" }
 %w[black red green yellow blue magenta cyan white].each do |name|
-  ui.puts "#{color[name]}    #{color["bright_#{name}"]}"
+  ui.puts "#{color[name, 7]}    #{color["bright_#{name}", 14]}"
 end
 
 ui.space

data/examples/demo.rb

@@ -42,7 +42,7 @@ ui.page do
   loop do
     choice =
       ui.query(
-        'Which example do you like to watch?',
+        'Which example do you like to run?',
         display: :compact,
         **choices
       ) or break

data/examples/illustration.rb

@@ -7,8 +7,10 @@ ui.framed do
     This is the [[c4]]beautiful[[/]], [[c5]]nice[[/]], [[c6]]nifty[[/]],
     [[c7]]fancy[[/]], [[c8]]neat[[/]], [[c9]]pretty[[/]],  [[ca]]cool[[/]],
     [[cb]]lovely[[/]], [[cc]]natty[[/]] [[bold]]user interface[[/]] you like to
-    have for your command line applications. It contains [[italic]]elegant[[/]],
-    [[italic]]simple[[/]] and [[italic]]beautiful[[/]] tools that enhance your
+    have for your command line applications. It contains
+    [[italic curly_underline ulc4]]elegant[[/]],
+    [[italic underline ulc7]]simple[[/]] and
+    [[italic dotted_underline ulca]]beautiful[[/]] tools that enhance your
     command line interfaces functionally and aesthetically.
   TEXT
 

data/examples/table.rb

@@ -7,6 +7,8 @@ ui.h1 'NattyUI: Tables'
 ui.space
 
 ui.message 'Constructed Table' do
+  ui.space
+
   ui.table type: :heavy do |table|
     table.add 'X', 'O'
     table.add 'O', 'O', 'X'
@@ -17,20 +19,23 @@ end
 ui.space
 
 User = Struct.new(:id, :name, :mail, :notes)
-USERS = [
-  User.new(
-    1,
-    'Henry',
-    'henry@some.test',
-    'This is fill text to generate a wide column which maybe rendered as multi line.'
-  ),
-  User.new(2, 'Sam', 'sam-sam@some.test', "enforced\nmulti-line"),
-  User.new(3, 'Taylor', 'taylor@some.test'),
-  User.new(3, 'Max', 'maxxx@some.test')
-].freeze
 
 ui.message 'Data Table' do
-  ui.table(User.members, *USERS)
+  ui.space
+
+  users = [
+    User.new(
+      1,
+      'Henry',
+      'henry@some.test',
+      'This is fill text to generate a wide column which maybe rendered as multi line.'
+    ),
+    User.new(2, 'Sam', 'sam-sam@some.test', "enforced\nmulti-line"),
+    User.new(3, 'Taylor', 'taylor@some.test'),
+    User.new(4, 'Max', 'maxxx@some.test')
+  ]
+  header = User.members.map { "[[bold green]]#{_1.capitalize}[[/]]" }
+  ui.table(header, *users)
 end
 
 ui.space

data/lib/natty-ui/ansi/constants.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module NattyUI::Ansi
+  CURSOR_SHOW = "\e[?25h"
+  CURSOR_HIDE = "\e[?25l"
+
+  CURSOR_HOME = cursor_pos(nil, nil)
+  CURSOR_FIRST_ROW = cursor_pos(1).freeze
+  CURSOR_FIRST_COLUMN = cursor_column(1).freeze
+
+  CURSOR_SAFE_POS_SCO = "\e[s"
+  CURSOR_SAFE_POS_DEC = "\e7"
+  CURSOR_SAFE_POS = CURSOR_SAFE_POS_DEC
+
+  CURSOR_RESTORE_POS_SCO = "\e[u"
+  CURSOR_RESTORE_POS_DEC = "\e8"
+  CURSOR_RESTORE_POS = CURSOR_RESTORE_POS_DEC
+
+  SCREEN_ERASE = screen_erase(:entire)
+
+  SCREEN_SAVE = "\e[?47h"
+  SCREEN_RESTORE = "\e[?47l"
+
+  SCREEN_ALTERNATE = "\e[?1049h"
+  SCREEN_ALTERNATE_OFF = "\e[?1049l"
+
+  LINE_PREVIOUS = cursor_previous_line(1).freeze
+  LINE_NEXT = cursor_next_line(1).freeze
+  LINE_ERASE = line_erase(:entire)
+
+  RESET = self[:reset].freeze
+
+  BOLD = self[:bold].freeze
+  BOLD_OFF = self[:bold_off].freeze
+
+  FAINT = self[:faint].freeze
+  FAINT_OFF = self[:faint_off].freeze
+
+  ITALIC = self[:italic].freeze
+  ITALIC_OFF = self[:italic_off].freeze
+
+  STRIKE = self[:strike].freeze
+  STRIKE_OFF = self[:strike_off].freeze
+
+  UNDERLINE = self[:underline].freeze
+  DOUBLE_UNDERLINE = self[:double_underline].freeze
+  UNDERLINE_OFF = self[:underline_off].freeze
+
+  CURLY_UNDERLINE = self[:curly_underline].freeze
+  CURLY_UNDERLINE_OFF = self[:curly_underline_off].freeze
+
+  BLINK = self[:blink].freeze
+  BLINK_OFF = self[:blink_off].freeze
+
+  INVERT = self[:invert].freeze
+  INVERT_OFF = self[:invert_off].freeze
+
+  HIDE = self[:hide].freeze
+  REVEAL = self[:reveal].freeze
+
+  # @!visibility private
+  CLS = (CURSOR_HOME + SCREEN_ERASE).freeze
+
+  # @!visibility private
+  CLL = (CURSOR_FIRST_COLUMN + LINE_ERASE).freeze
+
+  # @!visibility private
+  SCREEN_BLANK =
+    (
+      CURSOR_SAFE_POS + SCREEN_ALTERNATE + CURSOR_HOME + SCREEN_ERASE + RESET
+    ).freeze
+
+  # @!visibility private
+  SCREEN_UNBLANK = (RESET + SCREEN_ALTERNATE_OFF + CURSOR_RESTORE_POS).freeze
+end

data/lib/natty-ui/ansi.rb

@@ -260,7 +260,7 @@ module NattyUI
         return if (attributes = attributes.to_s.split).empty?
         "\e[#{
           attributes
-            .map! { |a| ATTR[a] || CLR[a] || color(a) || return }
+            .map! { ATTR[_1] || CLR[_1] || color(_1) || return }
             .join(';')
         }m"
       end
@@ -331,12 +331,13 @@ module NattyUI
       end
     end
 
+    # @!visibility private
     CSI = /\e\[[\d;:]*[ABCDEFGHJKSTfminsuhl]/
-    OSC = /\e\]\d+(?:;[^;\a\e]+)*(?:\a|\e\\)/
-    ESC = /(#{CSI})|(#{OSC})/
 
     # @!visibility private
-    WIDTH_SCANNER = /\G(?:(\1)|(\2)|(#{CSI})|(#{OSC})|(\X))/
+    OSC = /\e\]\d+(?:;[^;\a\e]+)*(?:\a|\e\\)/
+
+    ESC = /(#{CSI})|(#{OSC})/
 
     CLR_PREFIX = {
       'fg' => '38',
@@ -485,8 +486,6 @@ module NattyUI
     SCLR = CLR.transform_keys(&:to_sym).compare_by_identity.freeze
 
     private_constant(
-      :CSI,
-      :OSC,
       :ESC,
       :CLR_PREFIX,
       :PI2_THIRD,
@@ -499,4 +498,4 @@ module NattyUI
   end
 end
 
-require_relative 'ansi_constants'
+require_relative 'ansi/constants'

data/lib/natty-ui/ansi_wrapper.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'ansi'
 require_relative 'wrapper'
-require_relative 'line_animation'
 
 module NattyUI
   class AnsiWrapper < Wrapper
@@ -13,8 +11,8 @@ module NattyUI
 
       prefix = kwargs[:prefix]
       if prefix && !prefix.empty?
-        prefix = NattyUI.embellish(prefix)
-        prefix_width = kwargs[:prefix_width] || NattyUI.display_width(prefix)
+        prefix = Text.embellish(prefix)
+        prefix_width = kwargs[:prefix_width] || Text.width(prefix)
       else
         prefix = nil
         prefix_width = 0
@@ -23,12 +21,12 @@ module NattyUI
       kwargs[:prefix_width] = prefix_width
 
       suffix = kwargs[:suffix]
-      suffix = suffix.empty? ? nil : NattyUI.embellish(suffix) if suffix
+      suffix = suffix.empty? ? nil : Texct.embellish(suffix) if suffix
 
       mw = kwargs[:max_width]
       unless mw
         mw = screen_columns - prefix_width
-        mw -= kwargs[:suffix_width] || NattyUI.display_width(suffix) if suffix
+        mw -= kwargs[:suffix_width] || Text.(suffix) if suffix
       end
       kwargs[:max_width] = mw
 
@@ -36,17 +34,16 @@ module NattyUI
       animation = LineAnimation[animation].new(@stream, kwargs)
       prefix = "#{Ansi::RESET}#{Ansi::CLL}#{prefix}"
 
-      NattyUI
-        .each_line(
-          *args.map! { NattyUI.embellish(Ansi.blemish(_1)) },
-          max_width: mw
-        )
-        .each do |line|
-          @stream << prefix
-          animation.print(line)
-          (@stream << "#{prefix}#{line}#{suffix}\n").flush
-          @lines_written += 1
-        end
+      Text.each_line(
+        args.map! { Text.embellish(Ansi.blemish(_1)) },
+        mw
+      ) do |line|
+        @stream << prefix
+        animation.print(line)
+        (@stream << "#{prefix}#{line}#{suffix}\n").flush
+        @lines_written += 1
+      end
+
       (@stream << Ansi::CURSOR_SHOW).flush
       self
     end
@@ -72,16 +69,18 @@ module NattyUI
     protected
 
     def prepare_print(args, kwargs)
-      _prepare_print(args, kwargs) { NattyUI.embellish(_1) }
+      Text.prepare_print(args, kwargs, -> { screen_columns }) do |str|
+        Text.embellish(str)
+      end
     end
 
     def temp_func
       count = @lines_written
       lambda do
-        count = @lines_written - count
-        if count.nonzero?
-          @stream << Ansi.cursor_prev_line(count) << Ansi.screen_erase(:below)
-          @lines_written -= count
+        if (c = @lines_written - count).nonzero?
+          @stream << Ansi.cursor_prev_line(c) << Ansi.screen_erase(:below) <<
+            Ansi::CURSOR_FIRST_COLUMN
+          @lines_written -= c
         end
         @stream.flush
         self
@@ -107,9 +106,7 @@ module NattyUI
         (wrapper.stream << @msg << (@max_value ? fullbar : @spinner.next)).flush
       end
 
-      def end_draw
-        (wrapper.stream << Ansi::CLL << Ansi::CURSOR_SHOW).flush
-      end
+      def end_draw = (wrapper.stream << Ansi::CLL << Ansi::CURSOR_SHOW).flush
 
       def fullbar
         percent = @value / @max_value
@@ -124,7 +121,6 @@ module NattyUI
       BAR_BACK = Ansi[236, 492].freeze
       BAR_INK = Ansi[:bold, 255, :on_default].freeze
     end
-    private_constant :Progress
 
     module Temporary
       def temporary
@@ -145,12 +141,10 @@ module NattyUI
         end
       end
     end
-    private_constant :Temporary
 
     class Section < Section
       include Temporary
     end
-    private_constant :Section
 
     class Quote < Quote
       include Temporary
@@ -160,7 +154,6 @@ module NattyUI
         @prefix = "#{Ansi[39]}#{@prefix}#{Ansi::RESET}"
       end
     end
-    private_constant :Quote
 
     class Framed < Framed
       def color(str) = "#{Ansi[39]}#{str}#{Ansi::RESET}"
@@ -173,7 +166,6 @@ module NattyUI
         @finish = color("#{deco[5]}#{deco[6] * aw}#{deco[7]}")
       end
     end
-    private_constant :Framed
 
     class Message < Section
       protected
@@ -182,7 +174,7 @@ module NattyUI
         wrapper = parent.wrapper
         color = COLORS[glyph] || COLORS[:default]
         glyph = wrapper.glyph(glyph) || glyph
-        prefix_width = NattyUI.display_width(glyph) + 1
+        prefix_width = Text.width(glyph) + 1
         parent.puts(
           title,
           prefix: "#{glyph} #{color}",
@@ -204,13 +196,11 @@ module NattyUI
         query: Ansi[255]
       }.compare_by_identity.freeze
     end
-    private_constant :Message
 
     class Task < Message
       include ProgressAttributes
       include TaskMethods
     end
-    private_constant :Task
   end
 
   private_constant :AnsiWrapper