natty-ui 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa357f7937c367ecc77396e7241f33a774973d773b99c6923cc975199755a14
-  data.tar.gz: '060778aaca552a23c57e39e4efd8adf3eff07658e6a712708b6c8e46c5077bc1'
+  metadata.gz: b7b5e669e50f25432d17c55b8cbcc0e9a1c2c181982c08771b03160180586673
+  data.tar.gz: da124f705a984042e805c83b33565bc5c43e1a97c891ad95abccc5d2e8c62e62
 SHA512:
-  metadata.gz: c79a14e0f8b02181a19268958c8784e306f66853e0e09f40ae630043a3f89b699aaaaee72622d06fff43df0eab9814908b5d692f748df0c7ff5f67d4cac1b460
-  data.tar.gz: 7b27b83b5592b3ec556e640d7d583983ec42615ac036c40a0f5b2a305616e3df846f292aae191952e312aeaf6d9e4be99ab84ed123c1853acbf055c515b9335f
+  metadata.gz: 4be6c711b6b5cc7d3b6b6800f35e9e5450c44f6b57d139325a4afeeec3b350f26f0719a8909ee9d5d335e26803761bf3d2b31bbd672f47656d70b86ee2dbc465
+  data.tar.gz: 5b889460d57e3d92bb6bed0ce83fd8c4c6e7fecd8001fcd70674c6f7210550b259fcb4299d61d6a1a1ea376e96704670984a27c8471e07cb427a7fb62059de44

data/README.md

@@ -1,6 +1,6 @@
 # NattyUI ![version](https://img.shields.io/gem/v/natty-ui?label=)
 
-This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely, natty user interface you like to have for your command line applications. It contains elegant, simple and beautiful tools that enhance your command line interfaces functionally and aesthetically.
+This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely, natty user interface you like to have for your command line applications. It contains elegant, simple and beautiful tools that enhance your command line interfaces functionally and aesthetically.
 
 - Gem: [rubygems.org](https://rubygems.org/gems/natty-ui)
 - Source: [github.com](https://github.com/mblumtritt/natty-ui)
@@ -13,7 +13,10 @@ Here you find elegant, simple and beautiful tools that enhance your command line
 You can style your text using a [BBCode](https://en.wikipedia.org/wiki/BBCode)-like syntax
 
 ```ruby
- ui.puts '[bold underline bright_white]Hello [ff7bfd]World!'
+ ui.puts '[b]Hello World![/b]' # bold
+ ui.puts '[i]Hello World![/i]' # italic
+ ui.puts '[u]Hello World![/u]' # underline
+ ui.puts '[yellow on_blue]Hello World![/]'
 ```
 
 which supports all ANSI attributes, colors in 3/4-bit, 8-bit and Truecolor. There are headers, rulers, diverse message types, framed blocks and tables to layout your text. You can organize the output of tasks, use progress bars and request and handle user input. And there are text animations for fame and fun!

data/examples/24bit-colors.rb

@@ -2,9 +2,7 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: 24-bit Color Support'
-ui.space
+ui.h1 'NattyUI: 24-bit Color Support', space: 2
 
 ui.section do
   bar = '█' * ui.available_width

data/examples/3bit-colors.rb

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

data/examples/8bit-colors.rb

@@ -2,9 +2,7 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: 8-bit Color Support'
-ui.space
+ui.h1 'NattyUI: 8-bit Color Support', space: 2
 
 color = ->(i) { "[bg#{i = i.to_s(16).rjust(2, '0')}] #{i} " }
 ui.msg 'System Colors' do

data/examples/animate.rb

@@ -2,9 +2,7 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: Text Line Animation'
-ui.space
+ui.h1 'NattyUI: Text Line Animation', space: 2
 
 TEXT = <<~TEXT.tr("\n", ' ')
   Lorem [yellow]ipsum[/] dolor sit amet, consectetur adipisicing elit, sed

data/examples/attributes.rb

@@ -2,20 +2,17 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h2 'NattyUI: ANSI Attributes'
-ui.space
+ui.h2 'NattyUI: ANSI Attributes', space: 2
 
 ui.puts <<~PARA1.tr("\n", ' ')
   Some attributes are widely supported, such as [b]bold[/b],
-  [i]italic[/i], [u]underline[/u], [blink]blink[/blink],
-  [invert]invert[/invert] and [strike]strike[/strike], while others are rarely
-  complete or correctly implemented, like [faint]faint[/faint],
-  [double_underline]double underline[/], [curly_underline]curly
-  underline[/], [dotted_underline]dotted underline[/],
+  [i]italic[/i], [u]underline[/u], [bl]blink[/bl], [inv]invert[/inv] and
+  [s]strike[/s], while others are rarely complete or correctly implemented, like
+  [faint]faint[/faint], [double_underline]double underline[/],
+  [curly_underline]curly underline[/], [dotted_underline]dotted underline[/],
   [dashed_underline]dashed underline[/], [rapid_blink]rapid_blink[/],
-  [framed]framed[/], [encircled]encircled[/],
-  [overlined]overlined[/] and [proportional]proportional[/].
+  [framed]framed[/], [encircled]encircled[/], [overlined]overlined[/] and
+  [proportional]proportional[/].
 PARA1
 
 ui.puts <<~PARA2.tr("\n", ' ')

data/examples/attributes_list.rb

@@ -2,13 +2,11 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h2 'NattyUI: All Attribute and Defined Color Names'
-ui.space
+ui.h2 'NattyUI: All Attribute and Defined Color Names', space: 2
 
 ui.ls(
   (NattyUI::Ansi.attribute_names + NattyUI::Ansi.color_names)
     .sort!
-    .map! { |name| "[#{name}]#{name}[/]" }
+    .map! { |name| "[#{name}]#{name}" }
 )
 ui.space

data/examples/demo.rb

@@ -3,9 +3,7 @@
 require_relative '../lib/natty-ui'
 
 ui.page do
-  ui.space
-  ui.h1 'NattyUI: Examples'
-  ui.space
+  ui.h1 'NattyUI: Examples', space: 2
 
   ruby =
     ENV.fetch('RUBY') do

data/examples/ls.rb

@@ -2,9 +2,7 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: Print In Columns'
-ui.space
+ui.h1 'NattyUI: Print In Columns', space: 2
 
 LOREM = <<~IPSUM.lines(chomp: true)
   Lorem ipsum dolor sit

data/examples/message.rb

@@ -2,9 +2,7 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: Message Types'
-ui.space
+ui.h1 'NattyUI: Message Types', space: 2
 
 TEXT = <<~TEXT.tr("\n", ' ')
   Lorem [yellow]ipsum[/fg] dolor sit amet, consectetur adipisicing elit, sed

data/examples/progress.rb

@@ -2,9 +2,7 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: Progress Indication'
-ui.space
+ui.h1 'NattyUI: Progress Indication', space: 2
 
 # just simulate some work
 if ENV.key?('NO_WAIT')

data/examples/query.rb

@@ -2,9 +2,7 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: User Queries'
-ui.space
+ui.h1 'NattyUI: User Queries', space: 2
 
 # little helper
 def abort!

data/examples/read_key.rb

@@ -4,7 +4,7 @@ require_relative '../lib/natty-ui'
 
 ui.puts '⌨️ Display Keyboard Input [bright_black](Exit with Ctrl+C)'
 
-ui.section prefix: '[blue]:[/] ' do
+ui.section prefix: '[blue]:[/fg] ' do
   while true
     raw, name = NattyUI.read_key(mode: :both)
     ui.puts "[yellow]#{raw.inspect}[/] [bold bright_green]#{name}[/]"

data/examples/table.rb

@@ -2,9 +2,7 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: Tables'
-ui.space
+ui.h1 'NattyUI: Tables', space: 2
 
 User = Struct.new(:id, :name, :mail, :notes)
 users = [

data/lib/natty-ui/ansi.rb

@@ -373,16 +373,7 @@ module NattyUI
               'dashed_underline_off' => '4:0',
               'curly_underline' => '4:3',
               'dotted_underline' => '4:4',
-              'dashed_underline' => '4:5',
-              # aliases
-              'b' => 1, # bold
-              '/b' => 22, # bold_off
-              'i' => 3, # italic
-              '/i' => 23, # italic_off
-              'u' => 4, # underline
-              '/u' => 24, # underline_off
-              'h' => 8, # hide
-              '/h' => 28 # reveal
+              'dashed_underline' => '4:5'
             }
             add = ->(s, n) { n.each_with_index { |a, idx| map[a] = s + idx } }
             add[
@@ -432,6 +423,24 @@ module NattyUI
             ]
             add[73, %w[superscript subscript superscript_off]]
 
+            add_alias =
+              proc do |name, org_name|
+                map[name] = map[org_name] or
+                  raise("undefined value - #{org_name}")
+                map["/#{name}"] = map["#{org_name}_off"] or
+                  raise("undefined value - #{org_name}_off")
+              end
+            add_alias['b', 'bold']
+            add_alias['i', 'italic']
+            add_alias['u', 'underline']
+            add_alias['bl', 'blink']
+            add_alias['inv', 'invert']
+            add_alias['s', 'strike']
+            add_alias['sup', 'superscript']
+            add_alias['sub', 'subscript']
+            add_alias['prop', 'proportional']
+            add_alias['sp', 'spacing']
+
             map.merge!(
               map
                 .filter_map do |name, att|

data/lib/natty-ui/ansi_wrapper.rb

@@ -6,13 +6,23 @@ module NattyUI
   class AnsiWrapper < Wrapper
     def ansi? = true
 
+    def cursor=(value)
+      if value
+        (@stream << Ansi::CURSOR_SHOW).flush if @cursor == 1
+        @cursor -= 1 if @cursor.positive?
+        return
+      end
+      (@stream << Ansi::CURSOR_HIDE).flush if @cursor.zero?
+      @cursor += 1
+    end
+
     def puts(*args, **kwargs)
       return super if args.empty? || (animation = kwargs[:animation]).nil?
       animation = Animation[animation].new(wrapper, args, kwargs)
-      @stream << Ansi::CURSOR_HIDE
+      self.cursor = false
       animation.perform(@stream)
       @lines_written += animation.lines_written
-      (@stream << Ansi::CURSOR_SHOW).flush
+      self.cursor = true
       self
     end
 
@@ -77,35 +87,58 @@ module NattyUI
       end
     end
 
-    class Progress < Progress
-      def draw(title, spinner)
-        @msg =
-          "#{@parent.prefix}#{Ansi[:bold, 39]}➔#{Ansi[:reset, 39]} " \
-            "#{title}#{Ansi::RESET} "
-        (wrapper.stream << @msg << Ansi::CURSOR_HIDE).flush
-        @msg = "#{Ansi::CLL}#{@msg}"
-        return @msg << BAR_COLOR if @max_value
-        @spinner = NattyUI::Spinner[spinner]
+    class Progress < Element
+      include ProgressAttributes
+      include ValueAttributes
+
+      protected
+
+      def call(title, max_value, spinner)
+        @title = "[b 27]➔[/b] #{title}"
+        @info = nil
+        @final_text = [title]
+        if max_value
+          @max_value = [0, max_value.to_f].max
+        else
+          @spinner = NattyUI::Spinner[spinner]
+        end
+        @value = 0
+        @pos = wrapper.lines_written
+        wrapper.cursor = false
+        @parent.puts(@last_render = render)
+        @height = wrapper.lines_written - @pos
+        self
       end
 
       def redraw
-        (wrapper.stream << @msg << (@max_value ? fullbar : @spinner.next)).flush
+        return if @status
+        current = render
+        return if @last_render == current
+        wrapper.stream << Ansi.cursor_previous_line(@height) << Ansi::LINE_ERASE
+        cl = wrapper.lines_written
+        @parent.puts(@last_render = current)
+        @height = wrapper.lines_written - cl
       end
 
-      def end_draw = (wrapper.stream << Ansi::CLL << Ansi::CURSOR_SHOW).flush
-
-      def fullbar
-        percent = @value / @max_value
-        count = (30 * percent).to_i
-        mv = max_value.to_i.to_s
-        "#{'█' * count}#{BAR_BACK}#{'▁' * (30 - count)}" \
-          "#{BAR_INK} #{value.to_i.to_s.rjust(mv.size)}/#{mv} " \
-          "(#{(percent * 100).round(2).to_s.rjust(6)})"
+      def render
+        return "#{@title} #{@spinner.next}#{" #{@info}" if @info}" if @spinner
+        percent = @max_value.zero? ? 100.0 : @value / @max_value
+        count = [(30 * percent).round, 30].min
+        mv = @max_value.round.to_s
+        "#{@title} [27 on27]#{'█' * count}[ec onec]#{
+          '▁' * (30 - count)
+        }[/bg] [e2 b]#{(percent * 100).round.to_s.rjust(3)}%[/b] [f6](#{
+          @value.round.to_s.rjust(mv.size)
+        }/#{mv})[/]#{" #{@info}" if @info}"
       end
 
-      BAR_COLOR = Ansi[39, 295].freeze
-      BAR_BACK = Ansi[236, 492].freeze
-      BAR_INK = Ansi[:bold, 255, :on_default].freeze
+      def finish
+        wrapper.stream << Ansi.cursor_previous_line(@height) << Ansi::LINE_ERASE
+        wrapper.instance_variable_set(:@lines_written, @pos)
+        wrapper.cursor = true
+        return @parent.failed(*@final_text) if failed?
+        @parent.message(*@final_text, glyph: @status = :completed)
+      end
     end
 
     module Temporary

data/lib/natty-ui/spinner.rb

@@ -36,7 +36,7 @@ module NattyUI
           end
         parts =
           (parts.respond_to?(:map) ? parts : parts.to_s.chars).map do |part|
-            "#{@style}#{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

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.12.0'
+  VERSION = '0.12.1'
 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/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

@@ -36,21 +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)
-        self
-      end
-
-      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
@@ -59,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/table.rb

@@ -159,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
@@ -367,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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-03 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.
@@ -102,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: []