natty-ui 0.34.0 → 1.0.2

data/lib/natty-ui/frame.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative 'element'
+require_relative 'utils/border'
+
+module NattyUI
+  # An {Element} that draws a Unicode border box around its content.
+  #
+  # Instances are created by {Features#frame}.  An optional title can be
+  # embedded in the top border line.  The border style and ANSI colour are
+  # configurable.
+  #
+  # All {Features} methods are available on this element.
+  #
+  # @example Via block (auto-close)
+  #   ui.frame 'Results', border: :double do
+  #     ui.puts 'All checks passed.'
+  #   end
+  #
+  # @example Manual close
+  #   frm = ui.frame 'Preview'
+  #   ui.puts 'Content inside the frame.'
+  #   frm.end
+  class Frame < Element
+    # @private
+    def puts(*, **options)
+      return self if @done != 0
+      options[:width] = @parent.columns - @prefix.width - @suffix.width
+      options[:align] ||= :left
+      super
+    end
+
+    # @private
+    def hr(kind = nil)
+      return self if @done != 0
+      width = @parent.columns
+      return _hr_border(width, @border) if kind.nil?
+      return _hr_border(width, Border[kind]) if kind.is_a?(Symbol)
+      kind = StrConst[kind]
+      return _hr_border(width, @border) if kind.width == 0
+      width -= 2
+      puts(
+        "#{@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 heading(level, title)
+      return self if @done != 0
+      width = @parent.columns
+      hr = @border.hor(Border[level == 1 ? :double : :single], width, @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
+      @parent.puts(@bottom) if (@done += 1) == 1 && @bottom
+    end
+
+    def initialize(parent, title, kind, style)
+      super(parent)
+      @start_line = NattyUI.lines_written
+      @border = Border[kind]
+      @style = Ansi[*(style || :bright_blue)]
+      @prefix, @suffix, top, @bottom =
+        @border.build(parent.columns, title, @style)
+      parent.puts(top, bbcode: false) if top
+    end
+
+    def _hr_border(width, border)
+      @parent.puts(@border.hor(border, width, @style))
+      self
+    end
+  end
+end