natty-ui 0.34.0 → 1.0.2

data/lib/natty-ui/section.rb

@@ -1,66 +1,167 @@
 # frozen_string_literal: true
 
 require_relative 'element'
+require_relative 'utils/border'
 
 module NattyUI
-  # Display section used by
+  # An {Element} that draws a bordered container with an optional title.
   #
-  # - {Features.section}
-  # - {Features.message}
-  # - {Features.information}
-  # - {Features.warning}
-  # - {Features.error}
-  # - {Features.failed}
+  # Instances are created by {#section} and its typed shorthand variants:
+  # {#message}, {#information}, {#warning}, {#error}, and {#fatal}.
+  # The visual style (border colour, prefix mark) is determined by the `type:`
+  # argument.
   #
+  # All {Features} methods are available on this element.
+  #
+  # @example Via block (auto-close)
+  #   ui.section 'Summary', type: :information do
+  #     ui.puts '3 files processed.'
+  #   end
+  #
+  # @example Manual close
+  #   sec = ui.warning 'Disk space low'
+  #   ui.puts 'Only 500 MB remaining.'
+  #   sec.end
   class Section < Element
-    include WithStatus
+    # @private
+    def puts(...) = @done == 0 ? super : self
+
+    # @private
+    def hr(kind = nil)
+      return self if @done != 0
+      width = @parent.columns
+      return _hr_border(width, @type.border) if kind.nil?
+      return _hr_border(width, Border[kind]) if kind.is_a?(Symbol)
+      kind = StrConst[kind]
+      return _hr_border(width, @type.border) if kind.width == 0
+      width -= 2
+      puts(
+        "#{@type.style}#{
+          if kind.width > width
+            kind.to_str[0, width]
+          elsif kind.width == width
+            kind
+          else
+            kind.to_str * (width / kind.width)
+          end
+        }"
+      )
+    end
 
     # @private
-    def puts(*objects, **options) = @state ? self : super
+    def heading(level, title)
+      return self if @done != 0
+      width = @parent.columns
+      hr =
+        @type.border.horoe(
+          Border[level == 1 ? :double : :single],
+          width,
+          @type.style
+        )
+      @parent.puts(hr) if level < 3 && @start_line != NattyUI.lines_written
+      puts(title, padding: [0, 1])
+      @parent.puts(hr)
+      self
+    end
 
     private
 
-    def _done(text)
-      puts(*text) unless text.empty?
-      @parent.puts(@border.bottom)
+    def done
+      @parent.puts(@type.bottom) if (@done += 1) == 1
     end
 
-    def _failed
-      @parent.puts(@border.bottom)
+    def _hr_border(width, border)
+      @parent.puts(@type.border.horoe(border, width, @type.style))
+      self
     end
 
-    def show_title(title)
-      return @parent.puts(@border.top) unless title
-      prefix = @border.top_left
-      suffix = @border.top_right
-      @parent.puts(
-        title,
-        prefix: prefix,
-        prefix_width: prefix.width,
-        suffix: suffix,
-        suffix_width: suffix.width
+    def initialize(parent, title, kind, border)
+      super(parent)
+      @type = Type[border, kind]
+      @prefix = @type.left
+      title = normalize(title) or return parent.puts(@type.top)
+      parent.puts(
+        "#{@type.title_left}#{title}#{@type.title_right}",
+        bbcode: false
       )
     end
 
-    def initialize(parent, title, msg, kind)
-      super(parent)
-      title, rest = split(title) if title && !title.empty?
-      @border = Theme.current.section_border(kind)
-      show_title(title)
-      @prefix = @border.prefix
-      @prefix_width = @prefix.width
-      puts(*rest) if rest && !rest.empty?
-      puts(*msg) unless msg.empty?
+    def normalize(title)
+      return if title.nil? || title.empty?
+      title =
+        Text::Formatter[
+          title,
+          eol: false,
+          width:
+            @parent.columns - @type.title_left.width - @type.title_right.width
+        ].first
+      title.nil? || title.empty? ? nil : title
     end
 
-    def split(title)
-      rest =
-        Text.each_line(
-          title,
-          limit: @parent.columns - 9,
-          ansi: Terminal.ansi?
-        ).to_a
-      [rest.shift, rest]
+    # @private
+    class Type
+      def self.[](border, kind) = @defined.dig(border, kind)
+
+      attr_reader :border,
+                  :style,
+                  :top,
+                  :title_left,
+                  :title_right,
+                  :left,
+                  :bottom
+
+      private
+
+      def initialize(border, style, mark)
+        @border = border
+        @style = Ansi[*style]
+        @top =
+          StrConst[
+            "#{@style}#{border.top_left}#{border.top}#{border.extra}#{
+              Ansi::RESET
+            }"
+          ]
+        @title_left =
+          StrConst[
+            "#{@style}#{
+              border.top_left
+            }#{border.top}#{border.end}#{Ansi::RESET} #{mark}"
+          ]
+        @title_right =
+          StrConst[
+            "#{Ansi::RESET} #{@style}#{
+              border.begin
+            }#{border.top}#{border.extra}#{Ansi::RESET}"
+          ]
+        @left = StrConst["#{@style}#{border.left}#{Ansi::RESET} "]
+        @bottom =
+          StrConst[
+            "#{@style}#{border.bottom_left}#{
+              border.bottom
+            }#{border.extra}#{Ansi::RESET}"
+          ]
+      end
+
+      @kind = {
+        default: [:bright_blue, ''],
+        message: [:bright_blue, '[bright_blue]•[/fg] '],
+        information: [:bright_blue, '[bright_blue]𝒊[/fg] '],
+        warning: [:yellow, '[bright_yellow]![/fg] '],
+        error: [:red, '[bright_red]𝙓[/fg] '],
+        fatal: [:red, '[bright_red i]𝒊[/fg /i] ']
+      }.compare_by_identity
+      @kind.default = @kind[:default]
+
+      @defined =
+        Hash
+          .new do |h1, border|
+            h1[border] = Hash
+              .new { |h2, kind| h2[kind] = new(Border[border], *@kind[kind]) }
+              .compare_by_identity
+          end
+          .compare_by_identity
     end
+
+    private_constant :Type
   end
 end

data/lib/natty-ui/task.rb

@@ -1,48 +1,60 @@
 # frozen_string_literal: true
 
-require_relative 'element'
+require_relative 'temporary'
 
 module NattyUI
-  # Task display section used by {Features.task}.
+  # A {Temporary} element that represents a single labelled step.
   #
+  # Instances are created by {#task}. Any content printed inside
+  # a `Task` block disappears when the element is closed.  Content printed
+  # with {#pin} is exempt — it is collected and reprinted after the
+  # erasure so it remains visible.
+  #
+  # All {Features} methods are available on this element, making it easy to
+  # nest sub-tasks or progress indicators inside a task block.
+  #
+  # @example Simple task with a block
+  #   ui.task 'Installing dependencies' do
+  #     run_install
+  #   end
+  #
+  # @example Nested tasks
+  #   ui.task 'Deploy' do
+  #     ui.task('Build') { compile }
+  #     ui.task('Upload') { upload }
+  #     ui.pin 'Deployed to production', mark: :checkmark
+  #   end
   class Task < Temporary
-    include WithStatus
+    # @private
+    def fatal(...)
+      return self if (@done += 1) != 1
+      @start_line = nil
+      self.end
+      @parent.fatal(...)
+    end
 
     private
 
-    def _done(text)
+    def done
+      return self if (@done += 1) != 1 || @start_line.nil?
       NattyUI.back_to_line(@start_line)
-      @start_line = nil
-      cm = Theme.current.mark(:checkmark)
       @parent.puts(
-        *text,
-        first_line_prefix: cm,
-        first_line_prefix_width: cm.width,
+        @title,
+        prefix: @prefix,
+        cprefix: Utils.mark[:checkmark],
         pin: @pin
       )
-      @pins&.each { |objects, options| puts(*objects, **options) }
+      @pins&.each { |objects, opts| @parent.puts(*objects, **opts) }
     end
 
-    def _failed
-      @start_line = nil
-    end
-
-    def initialize(parent, title, msg, pin)
+    def initialize(parent, title, pin)
       super(parent)
-      @title = title
-      @pin = pin
-      style = Theme.current.task_style
-      cm = Theme.current.mark(:current)
-      @prefix = ' ' * cm.width
-      @prefix_width = cm.width
       parent.puts(
-        title,
-        first_line_prefix: "#{cm}#{style}",
-        first_line_prefix_width: cm.width,
-        prefix: "#{@prefix}#{style}",
-        prefix_width: cm.width
+        @title = title,
+        cprefix: Utils.mark[:current],
+        prefix: @prefix = Utils.mark[:none]
       )
-      puts(*msg) unless msg.empty?
+      @pin = pin
     end
   end
 end

data/lib/natty-ui/temporary.rb

@@ -3,32 +3,45 @@
 require_relative 'element'
 
 module NattyUI
-  # Temporary display section used by {Features.temporary}.
+  # An {Element} whose output is erased from the terminal when it is closed.
   #
+  # Instances are created by {#temporary}.  Any content printed inside
+  # a `Temporary` block disappears when the element is closed.
+  # Content printed with {#pin} is exempt — it is collected and reprinted after
+  # the erasure so it remains visible.
+  #
+  # All {Features} methods are available on this element.
+  #
+  # @example Via block (auto-close)
+  #   ui.temporary do
+  #     ui.puts 'Thinking…'
+  #     sleep 2
+  #   end  # "Thinking…" is erased here
+  #
+  # @example Manual close
+  #   ui.temporary
+  #   ui.puts 'Loading…'
+  #   do_work
+  #   ui.end   # erases "Loading…"
   class Temporary < Element
     # @private
     def puts(*objects, **opts)
-      return self if @state
-      if opts.delete(:pin)
-        (@pins ||= []) << [objects, opts.except(:prefix_width, :suffix_width)]
-      end
+      return self if @done != 0
+      (@pins ||= []) << [objects, opts.dup] if opts.delete(:pin)
       super
     end
 
-    # @private
+    private
+
     def done
-      return self if @state
-      NattyUI.back_to_line(@start_line) if @start_line
-      @pins&.each { |objects, opts| puts(*objects, **opts) }
-      @state = :ok
-      self
+      return self if (@done += 1) != 1
+      NattyUI.back_to_line(@start_line)
+      @pins&.each { |objects, opts| @parent.puts(*objects, **opts) }
     end
 
-    private
-
     def initialize(parent)
-      @start_line = NattyUI.lines_written
       super
+      @start_line = NattyUI.lines_written
     end
   end
 end

data/lib/natty-ui/utils/border.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module NattyUI
+  # @private
+  class Border
+    def self.defined = @defined.keys
+    def self.[](name) = @defined[name]
+    def self.connections(kind) = @connections[kind]
+
+    attr_reader :to_str, :extra
+
+    def left = @to_str[0]
+    def right = @to_str[0]
+    def top = @to_str[1]
+    def bottom = @to_str[1]
+    def top_left = @to_str[2]
+    def top_right = @to_str[3]
+    def bottom_left = @to_str[4]
+    def bottom_right = @to_str[5]
+
+    def vert_for(other) = @vert[select(other)]
+    def hor_for(other) = @hor[select(other)]
+    def inter_for(other) = @inter[select(other)]
+
+    def build(width, title, style)
+      return StrConst.empty, StrConst.empty if width < 3
+      elyts = style.empty? ? '' : Ansi::RESET
+      line = @to_str[1] * (width - 2)
+      if title && width > 8
+        title, size =
+          Text::Formatter[
+            title,
+            with_size: true,
+            eol: false,
+            width: width - 7
+          ].first
+        if size&.nonzero?
+          top =
+            "#{style}#{@to_str[2]}#{@to_str[1] * 2}#{elyts} #{
+              title
+            } #{style}#{@to_str[1] * (width - 6 - size)}#{@to_str[3]}#{elyts}"
+        end
+      end
+      [
+        lur = StrConst.new("#{style}#{@to_str[0]}#{elyts}", 1),
+        lur,
+        top || "#{style}#{@to_str[2]}#{line}#{@to_str[3]}#{elyts}",
+        "#{style}#{@to_str[4]}#{line}#{@to_str[5]}#{elyts}"
+      ]
+    end
+
+    def hor(other, width, style)
+      return if width < 3
+      hor = @hor[select(other)]
+      ret = "#{hor[1]}#{hor[0] * (width - 2)}#{hor[2]}"
+      style.empty? ? ret : "#{style}#{ret}#{Ansi::RESET}"
+    end
+
+    def horoe(other, width, style)
+      return if width < 2
+      hor = @hor[select(other)]
+      ret = "#{hor[1]}#{hor[0] * (width - 1)}"
+      style.empty? ? ret : "#{style}#{ret}#{Ansi::RESET}"
+    end
+
+    def vert(other, style)
+      vert = @vert[select(other)].chars
+      style.empty? ? vert : vert.map! { "#{style}#{it}#{Ansi::RESET}" }
+    end
+
+    def begin = (@begin ||= @hor[@to_str[1]][1])
+    def end = (@end ||= @hor[@to_str[1]][2])
+
+    def intersection(other, style)
+      ret = @inter[select(other)]
+      style.empty? ? ret : "#{style}#{ret}#{Ansi::RESET}"
+    end
+
+    private
+
+    def initialize(to_str)
+      @to_str = to_str
+      @vert, @hor, @inter, @extra = Border.connections(to_str[0])
+    end
+
+    def select(other)
+      case other
+      when Border
+        other.top
+      when Symbol
+        Border[other].top
+      when String
+        other[0]
+      else
+        @to_str[1]
+      end
+    end
+
+    def_hwd = ->(hs) do
+      hs.default = hs[hs.keys.first]
+      hs.freeze
+    end
+
+    @connections = {
+      '│' => [
+        def_hwd['─' => '│┬┴', '═' => '│╤╧', '━' => '│┯┷'],
+        def_hwd['─' => '─├┤', '═' => '═╞╡', '━' => '━┝┥'],
+        def_hwd['─' => '┼', '═' => '╪', '━' => '┿'],
+        '╴╴╴'
+      ],
+      '║' => [
+        def_hwd['═' => '║╦╩', '─' => '║╥╨'],
+        def_hwd['═' => '═╠╣', '─' => '─╟╢'],
+        def_hwd['═' => '╬', '─' => '╫'],
+        ' ═ '
+      ],
+      '┃' => [
+        def_hwd['━' => '┃┳┻', '─' => '┃┰┸'],
+        def_hwd['━' => '━┣┫', '─' => '─┠┨'],
+        def_hwd['━' => '╋', '─' => '╂'],
+        '╸╸╸'
+      ]
+    }
+
+    @defined = {
+      rounded: new('│─╭╮╰╯'),
+      single: new('│─┌┐└┘'),
+      double: new('║═╔╗╚╝'),
+      heavy: new('┃━┏┓┗┛'),
+      single_double: new('│═╒╕╘╛'),
+      double_single: new('║─╓╖╙╜'),
+      single_heavy: new('│━┍┑┕┙'),
+      heavy_single: new('┃─┎┒┖┚')
+    }.compare_by_identity
+    @defined.default = @defined[:rounded]
+  end
+
+  private_constant :Border
+end

data/lib/natty-ui/utils/str_const.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module NattyUI
+  # @private
+  class StrConst
+    class << self
+      attr_reader :empty
+
+      def from_str(str)
+        str, width = Text::Formatter.new(str, eol: false).lines_with_size[0]
+        width == 0 ? @empty : new(str, width)
+      end
+      alias [] from_str
+
+      def spacer(size = 1)
+        size < 1 ? @empty : new((' ' * size).freeze, size)
+      end
+
+      def join(*other)
+        other.map! { ::StrConst === it ? it : from_str(it) }
+        new(other.join.freeze, other.sum(&:width))
+      end
+    end
+
+    attr_reader :to_s, :width
+    def empty? = (@width == 0)
+    def inspect = "<#{@to_s.inspect}, width:#{@width}>"
+    alias to_str to_s
+
+    def ljust(width)
+      return '' if (space = width - @width) < 0
+      space == 0 ? @to_s : "#{@to_s}#{' ' * space}"
+    end
+
+    def rjust(width)
+      return '' if (space = width - @width) < 0
+      space == 0 ? @to_s : "#{' ' * space}#{@to_s}"
+    end
+
+    def +(other)
+      other = StrConst[other] unless StrConst === other
+      StrConst.new((@to_s + other.to_s).freeze, @width + other.width)
+    end
+
+    def initialize(str, width)
+      @to_s =
+        if str.frozen?
+          str.encoding == ENCODING ? str : str.encode(ENCODING).freeze
+        else
+          str = str.dup
+          str.encode!(ENCODING) if str.encoding != ENCODING
+          str.freeze
+        end
+      @width = width
+    end
+
+    ENCODING = Encoding::UTF_8
+    @empty = new('', 0)
+  end
+
+  private_constant :StrConst
+end

data/lib/natty-ui/utils/utils.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module NattyUI
+  # @private
+  module Utils
+    class << self
+      attr_reader :mark
+
+      def affix(style)
+        return '', '' unless Terminal.ansi?
+        return '', '' if (style &&= Ansi[*style]).nil? || style.empty?
+        [style, Ansi::RESET]
+      end
+
+      def as_width(value, max)
+        return max if value == :auto
+        (Float === value ? (max * value).round : value.to_int).clamp(0, max)
+      end
+
+      def as_mark(mark)
+        case mark
+        when nil
+          @mark.default
+        when Symbol
+          @mark[mark]
+        else
+          "#{mark} "
+        end
+      end
+    end
+
+    @mark = {
+      default: StrConst['[bright_blue]•[/fg] '],
+      current: StrConst['[b bright_green]→ '],
+      active: StrConst['[b bright_green]→[/b /fg] '],
+      checkmark: StrConst['[b bright_green]✓[/b /fg] '],
+      item: StrConst['[d]•[/d] '],
+      current_item: StrConst['[b bright_green]●[/b /fg] '],
+      output: StrConst['[d]>[/d] '],
+      error: StrConst['[red]𝙓[/fg] ']
+    }.compare_by_identity
+    @mark.default = @mark[:default]
+    @mark[:none] = StrConst.spacer(@mark.default.width)
+  end
+
+  private_constant :Utils
+end

data/lib/natty-ui/version.rb

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