natty-ui 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23eed1ba95aaecb2555dfeed5a6fedbcd827299d1e4a64c91952953b3d36d787
-  data.tar.gz: 53380e5ebe647a96abbc24baecd1f24a7a3290544ac10e34e3aa8b1e8dba1e17
+  metadata.gz: 93595f761b9be11457f8c8eac967c87f6c91f55d1145aca2f9aa3f35c81a442c
+  data.tar.gz: fe3fa5b6844e6513ed9e03cbfdb5338bebf9a1f955f61611053b0b3807771aab
 SHA512:
-  metadata.gz: 56c829ee249c7cecce24bb9b88c131e8fdaaec20aff2f0340b16d701c77907805f7595d38cfe0e122d4f7365d6ae6babfccdd680b9754de283c7e63c944e78ea
-  data.tar.gz: 9964afa255fe3a76d59727f13edcafa31429768729e3b14408f6142f6af17236c7831836857897a0e860044732ad5a347c6bc4efb06ef277412d73d67167519d
+  metadata.gz: f19f64cc3898a51bffe330505ddf015790c456dfc765f078b4798fe06584ae803e20fade81f3981d07a25342598ecfbc4ce1ee525866cbc865a7ab5a21706c96
+  data.tar.gz: 96ff67e741b3caf88472547c0c205d403fdaa2bb9f21f01d4d8c0eff5c984cb0c1e6c0a12fc70c17bbf7a5fda5cc764693e15de07093c617e889517c0f57a368

data/examples/24bit-colors.rb

@@ -3,12 +3,12 @@
 require_relative '../lib/natty-ui'
 
 ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]24-bit Color Support[/]' do
-  ui.space
   bar = '█' * ui.columns
   rainbow =
     (7..17).map do |i|
       NattyUI::Ansi.rainbow(bar, seed: 3, spread: 3.25, frequency: i / 100.0)
     end
 
+  ui.space
   ui.puts(*rainbow)
 end

data/examples/key-codes.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+raw = name = :start
+while name != 'Esc'
+  ui.temporary do
+    ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Keyboard Key Codes[/]' do
+      ui.puts(
+        "\n#{
+          case name
+          when :start
+            "Your terminal uses [i]#{
+              Terminal.input_mode
+            }[/i] mode. Press a key!"
+          when nil
+            "[green]#{raw.inspect}[/fg] → [bold bright_green][\\#{raw}]"
+          else
+            "[green]#{raw.inspect}[/fg] → [bold bright_green]#{
+              name.split('+').map! { "[\\#{_1}]" }.join(' ')
+            }"
+          end
+        }\n\n[bright_black](Exit with ESC)"
+      )
+    end
+    raw, name = Terminal.read_key(mode: :both)
+  end
+end

data/examples/ls.rb

@@ -31,4 +31,20 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Lists[/]' do
   ui.space
   ui.h2 'Compact Display'
   ui.ls lorem, glyph: 1
+
+  ui.space
+  ui.h2 'Latin Char Glyph'
+  ui.ls lorem.take(5), glyph: :a
+
+  ui.space
+  ui.h2 'Hex Numbers'
+  ui.ls lorem.take(5), glyph: '0x08'
+
+  ui.space
+  ui.h2 'Chapter Numbering'
+  ui.ls lorem.take(5), glyph: :'1.8'
+
+  ui.space
+  ui.h2 'Custom Glyph'
+  ui.ls lorem.take(5), glyph: '[b bright_yellow]→[/]'
 end

data/examples/named-colors.rb

@@ -18,6 +18,6 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Named Colors Support[/]' do
     NattyUI::Ansi
       .named_colors
       .delete_if { /\d/.match?(_1) }
-      .map! { "[bg_#{_1}] [/bg] [#{_1}]#{_1.to_s.ljust(22)}[/fg]" }
+      .map! { "[bg_#{_1}] [/bg] [#{_1}]#{_1}[/fg]" }
   )
 end

data/examples/sections.rb

@@ -13,7 +13,7 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Sections[/]' do
   end
 
   ui.space
-  ui.warning 'Warning', 'This is a warning message example.'
+  ui.warning "Warning\nThis is a warning message example."
 
   ui.space
   ui.error 'Error Message' do
@@ -23,7 +23,4 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Sections[/]' do
       cc.add 'You can add all other elements to a section.', vertical: :middle
     end
   end
-
-  ui.space
-  ui.failed "Fail Message\nA sad failure message."
 end

data/lib/natty-ui/element.rb

@@ -33,10 +33,10 @@ module NattyUI
     end
 
     alias _to_s to_s
+    private :_to_s
 
     # @!visibility private
     alias to_s inspect
-    private :_to_s
 
     private
 
@@ -46,33 +46,30 @@ module NattyUI
     end
   end
 
-  module StateMixin
-    attr_reader :state
+  module WithStatus
+    attr_reader :status
 
-    def closed? = @state ? true : false
+    def active? = @status.nil?
+    def closed? = !active?
     def ok? = @state == :ok
     def failed? = @state == :failed
 
-    # @return [Element] itself
-    def done(*text) = @state ? self : finish_ok(text)
-    alias ok done
-
-    # @!visibility private
-    def failed(title, *msg)
-      return if @state
-      super
-      finish_failed
+    def ok(*text)
+      return self if @state
+      text = [@title] if text.empty? && @title
+      _done(text)
+      @state = :ok
+      self
     end
+    alias done ok
 
-    # @!visibility private
-    def inspect = "#{_to_s.chop} state=#{@state.inspect}>"
-
-    protected
-
-    def finish_failed
+    def failed(*text, &block)
+      return self if @state
+      _failed
       @state = :failed
+      text = [@title] if text.empty? && @title
+      @parent.failed(*text, &block)
       self
     end
   end
-  private_constant :StateMixin
 end

data/lib/natty-ui/features.rb

@@ -292,7 +292,7 @@ module NattyUI
     #
     # @return (see puts)
     def space(count = 1)
-      (count = count.to_i).positive? ? puts(*Array.new(count, "\n")) : self
+      puts("\n" * count) if (count = count.to_i).positive?
     end
 
     # Print given items as list (like 'ls' command).
@@ -327,7 +327,7 @@ module NattyUI
     # Generate and print a table.
     # See {Table} for much more details about table generation.
     #
-    # @example Draw a very simple table with three rows, four columns, complete borders
+    # @example Draw a very simple 3x4 table with complete borders
     #   ui.table(border: :default, border_around: true, padding: [0, 1]) do |table|
     #     table.add 1, 2, 3, 4
     #     table.add 5, 6, 7, 8
@@ -444,7 +444,7 @@ module NattyUI
     #   @param pin [true, false]
     #     whether the final progress state should be "pinned" to parent element
     #
-    #   @return [Progress]
+    #   @return [ProgressHelper]
     #     itself
     #
     # @overload progress(title, max: nil, pin: false, &block)
@@ -455,7 +455,7 @@ module NattyUI
     #   @param pin [true, false]
     #     whether the final progress state should be "pinned" to parent element
     #
-    #   @yieldparam progress [Progress]
+    #   @yieldparam progress [ProgressHelper]
     #     itself
     #
     #   @return [Object]
@@ -555,7 +555,7 @@ module NattyUI
     # @param align [:left, :right, :centered]
     #   text alignment,
     #   see {Attributes::Align}
-    # @param border: [Symbol]
+    # @param border [Symbol]
     #   kind of border,
     #   see {Attributes::Border}
     # @param border_style [Enumerable<Symbol>]

data/lib/natty-ui/ls_renderer.rb

@@ -19,7 +19,7 @@ module NattyUI
       def as_items(items, glyph)
         items.flatten!
         glyph = as_glyph(glyph, items.size)
-        items.map! { |item| Item.new(item = glyph[item], Text.width(item)) }
+        items.map! { Item.new(glyph[_1]) }
       end
 
       def as_glyph(glyph, size)
@@ -27,30 +27,34 @@ module NattyUI
         when nil, false
           lambda(&:itself)
         when :hex
-          pad = size.to_s(16).size
+          pad = [2, size.to_s(16).size].max
           glyph = 0
           ->(s) { "#{(glyph += 1).to_s(16).rjust(pad, '0')} #{s}" }
+        when /\A0x(\h+)\z/
+          glyph = Regexp.last_match(1).hex - 1
+          pad = [2, (glyph + size).to_s(16).size].max
+          ->(s) { "0x#{(glyph += 1).to_s(16).rjust(pad, '0')} #{s}" }
         when Integer
           pad = (glyph + size).to_s.size
           glyph -= 1
-          ->(s) { "#{(glyph += 1).to_s.rjust(pad)} #{s}" }
+          ->(s) { "#{(glyph += 1).to_s.rjust(pad, ' ')} #{s}" }
         when Symbol
-          lambda do |s|
-            "#{
-              t = glyph
-              glyph = glyph.succ
-              t
-            } #{s}[/]"
-          end
+          ->(s) { "#{[glyph, glyph = glyph.succ][0]} #{s}" }
         else
           ->(s) { "#{glyph} #{s}" }
         end
       end
 
-      Item =
-        Struct.new(:str, :width) do
-          def to_s(in_width) = "#{str}#{' ' * (in_width - width)}"
+      class Item
+        attr_reader :width
+
+        def to_s(in_width) = "#{@str}#{' ' * (in_width - @width)}"
+
+        def initialize(str)
+          @str = str
+          @width = Text.width(str)
         end
+      end
       private_constant :Item
     end
   end

data/lib/natty-ui/progress.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require_relative 'element'
+
 module NattyUI
   # @todo This chapter needs more documentation.
   #
   # Progress indictaor helper used by {Features.progress}.
   #
   module ProgressHelper
+    include WithStatus
+
     # @return [String]
     attr_reader :title
 
@@ -40,21 +44,12 @@ module NattyUI
       redraw
     end
 
-    def active? = @status.nil?
-    def ok? = @status == :ok
-    def failed? = @status == :failed
-
     def step(count: 1, title: nil)
       @title = title if title
       self.value += count
       self
     end
 
-    def done(title = nil) = finish(:ok, title)
-    alias ok done
-
-    def failed(title = nil) = finish(:failed, title)
-
     alias _to_s to_s
     private :_to_s
 
@@ -80,27 +75,26 @@ module NattyUI
 
     private
 
-    def finish(status, title)
-      return if @status
-      @status = status
+    def _done(text)
       NattyUI.back_to_line(@pin_line)
-      if status == :failed
-        @parent.failed(title || @title)
-      else
-        cm = Theme.current.mark(:checkmark)
-        @parent.puts(
-          title || @title,
-          pin: @pin,
-          first_line_prefix: cm,
-          first_line_prefix_width: cm.width
-        )
-      end
-      self
+      @pin_line = nil
+      cm = Theme.current.mark(:checkmark)
+      @parent.puts(
+        *text,
+        pin: @pin,
+        first_line_prefix: cm,
+        first_line_prefix_width: cm.width
+      )
+    end
+
+    def _failed
+      NattyUI.back_to_line(NattyUI.lines_written - 1) if @last&.size == 2
+      @pin_line = nil
     end
 
     def initialize(parent, title, max, pin)
       @parent = parent
-      @value = 0.0
+      @value = 0
       @title = title
       @pin = pin
       @pin_line = NattyUI.lines_written
@@ -123,7 +117,7 @@ module NattyUI
     end
 
     def moving_bar
-      "#{@style}#{'·' * @value}" if @value >= 1
+      "#{@style}#{'•' * @value}" if @value >= 1
     end
 
     def bar(diff)
@@ -143,20 +137,18 @@ module NattyUI
 
     private
 
-    def finish(status, title)
-      return if @status
-      @status = status
-      if status == :failed
-        @parent.failed(title || @title)
-      else
-        cm = Theme.current.mark(:checkmark)
-        @parent.puts(
-          title || @title,
-          first_line_prefix: cm,
-          first_line_prefix_width: cm.width
-        )
-      end
-      self
+    def _done(text)
+      cm = Theme.current.mark(:checkmark)
+      @parent.puts(
+        *text,
+        pin: @pin,
+        first_line_prefix: cm,
+        first_line_prefix_width: cm.width
+      )
+    end
+
+    def _failed
+      # nop
     end
 
     def initialize(parent, title, max)

data/lib/natty-ui/section.rb

@@ -3,7 +3,7 @@
 require_relative 'element'
 
 module NattyUI
-  # {Element} implemting a display section used by
+  # Display section used by
   #
   # - {Features.section}
   # - {Features.message}
@@ -13,23 +13,20 @@ module NattyUI
   # - {Features.failed}
   #
   class Section < Element
-    include StateMixin
+    include WithStatus
 
     # @!visibility private
     def puts(*objects, **options) = @state ? self : super
 
     private
 
-    def finish_ok(text)
+    def _done(text)
       puts(*text) unless text.empty?
-      @state = :ok
       @parent.puts(@border.bottom)
-      self
     end
 
-    def finish_failed
+    def _failed
       @parent.puts(@border.bottom)
-      super
     end
 
     def show_title(title)

data/lib/natty-ui/table_renderer.rb

@@ -25,12 +25,19 @@ module NattyUI
       @max_width, @columns = WidthFinder.find(columns, max_width)
       init_borders(attributes)
       @columns = @columns.each.with_index
+
       @lines = render(rows.shift)
       @lines.unshift(@b_top) if @b_top
-      rows.each do |row|
-        @lines << @b_between if @b_between
-        @lines += render(row)
+
+      if @b_between
+        rows.each do |row|
+          @lines << @b_between
+          @lines += render(row)
+        end
+      else
+        rows.each { |row| @lines += render(row) }
       end
+
       @lines << @b_bottom if @b_bottom
     end
 
@@ -47,6 +54,7 @@ module NattyUI
       chars = attributes.border_chars or return
       style = border_style(attributes)
       @b_inner = style[chars[9]]
+      return if chars[10] == ' '
       return init_borders_around(chars, style) if attributes.border_around
       @b_between = chars[10] * (@max_width + @columns.size - 1)
       i = -1

data/lib/natty-ui/task.rb

@@ -3,25 +3,28 @@
 require_relative 'element'
 
 module NattyUI
-  # {Element} implemting a task display section used by {Features.task}.
+  # Task display section used by {Features.task}.
   #
   class Task < Temporary
-    include StateMixin
+    include WithStatus
 
     private
 
-    def finish_ok(text)
-      NattyUI.back_to_line(@start_line)
+    def _done(text)
+      NattyUI.back_to_line(@start_line, erase: :all)
       @start_line = nil
       cm = Theme.current.mark(:checkmark)
-      text << @title if text.empty?
       @parent.puts(
         *text,
         first_line_prefix: cm,
         first_line_prefix_width: cm.width,
         pin: @pin
       )
-      super()
+      @pins&.each { |objects, options| puts(*objects, **options) }
+    end
+
+    def _failed
+      @start_line = nil
     end
 
     def initialize(parent, title, msg, pin)

data/lib/natty-ui/temporary.rb

@@ -3,7 +3,7 @@
 require_relative 'element'
 
 module NattyUI
-  # {Element} implemting a temprary display section used by
+  # Temprary display section used by
   # {Features.temporary}.
   #
   class Temporary < Element
@@ -20,7 +20,7 @@ module NattyUI
     # @!visibility private
     def done
       return self if @state
-      NattyUI.back_to_line(@start_line) if @start_line
+      NattyUI.back_to_line(@start_line, erase: :all) if @start_line
       @pins&.each { |objects, options| puts(*objects, **options) }
       @state = :ok
       self
@@ -28,8 +28,6 @@ module NattyUI
 
     private
 
-    alias finish_ok done
-
     def initialize(parent)
       @start_line = NattyUI.lines_written
       super

data/lib/natty-ui/version.rb

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

data/lib/natty-ui.rb

@@ -58,12 +58,12 @@ module NattyUI
     def title=(value)
       if value
         title = Ansi.plain(value).gsub(/\s+/, ' ')
-        _write(Ansi.tab_title(title)) if Terminal.ansi?
+        _write(Ansi.title(title)) if Terminal.ansi?
         @title_stack << title
       else
         @title_stack.pop
         last = @title_stack[-1]
-        _write(Ansi.tab_title(last)) if last && Terminal.ansi?
+        _write(Ansi.title(last)) if last && Terminal.ansi?
       end
     end
 
@@ -74,7 +74,13 @@ module NattyUI
     def back_to_line(number, erase: true)
       return @lines_written if (c = @lines_written - number) <= 0
       if Terminal.ansi?
-        _write(erase ? (Ansi::LINE_ERASE_PREV * c) : Ansi.cursor_prev_line(c))
+        _write(
+          if erase == :all
+            Ansi.cursor_prev_line(c) + Ansi::SCREEN_ERASE_BELOW
+          else
+            erase ? (Ansi::LINE_ERASE_PREV * c) : Ansi.cursor_prev_line(c)
+          end
+        )
       end
       @lines_written = number
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -13,16 +13,16 @@ dependencies:
   name: terminal_rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.11.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.
@@ -45,6 +45,7 @@ files:
 - examples/elements.rb
 - examples/examples.rb
 - examples/illustration.rb
+- examples/key-codes.rb
 - examples/ls.rb
 - examples/named-colors.rb
 - examples/sections.rb
@@ -76,7 +77,7 @@ metadata:
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/mblumtritt/natty-ui
   bug_tracker_uri: https://github.com/mblumtritt/natty-ui/issues
-  documentation_uri: https://rubydoc.info/gems/natty-ui/0.25.0/NattyUI/
+  documentation_uri: https://rubydoc.info/gems/natty-ui/0.26.0/NattyUI
 rdoc_options: []
 require_paths:
 - lib
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.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.