natty-ui 0.6.0 → 0.8.0

data/lib/natty-ui/ansi_wrapper.rb

@@ -12,19 +12,31 @@ module NattyUI
         @stream.flush
         return self
       end
-      (@stream << PAGE_BEGIN).flush
+      (@stream << Ansi::BLANK_SLATE).flush
       begin
         yield(self)
       ensure
-        (@stream << PAGE_END).flush
+        (@stream << Ansi::UNBLANK_SLATE).flush
       end
     end
 
+    def cls
+      (@stream << Ansi::CURSOR_HOME << Ansi::SCREEN_ERASE).flush
+      self
+    end
+
     protected
 
-    def embellish(obj)
-      obj = NattyUI.embellish(obj)
-      obj.empty? ? nil : obj
+    def prepare_print(args, kwargs)
+      prefix = kwargs[:prefix] and prefix = NattyUI.embellish(prefix)
+      suffix = kwargs[:suffix] and suffix = NattyUI.embellish(suffix)
+      return ["#{prefix}#{suffix}"] if args.empty?
+      NattyUI
+        .each_line(
+          *args.map! { NattyUI.embellish(_1) },
+          max_width: max_with(prefix, suffix, kwargs)
+        )
+        .map { "#{prefix}#{_1}#{suffix}" }
     end
 
     def temp_func
@@ -32,7 +44,7 @@ module NattyUI
       lambda do
         count = @lines_written - count
         if count.nonzero?
-          @stream << Ansi.cursor_line_up(count) << Ansi.screen_erase_below
+          @stream << Ansi.cursor_line_up(count) << Ansi::SCREEN_ERASE_BELOW
           @lines_written -= count
         end
         @stream.flush
@@ -40,40 +52,47 @@ module NattyUI
       end
     end
 
-    class Message < Message
-      protected
+    class Progress < Progress
+      def draw(title)
+        @msg =
+          "#{@parent.prefix}#{Ansi[:bold, 39]}➔#{Ansi[:reset, 39]} " \
+            "#{title}#{Ansi::RESET} "
+        (wrapper.stream << @msg << Ansi::CURSOR_HIDE).flush
+        @msg = "#{Ansi::LINE_CLEAR}#{@msg}"
+        return @msg << BAR_COLOR if @max_value
+        @msg << Ansi[:bold, 220]
+        @indicator = 0
+      end
 
-      def title_attr(str, symbol)
-        color = COLORS[symbol]
-        {
-          prefix:
-            if color
-              "#{Ansi[:bold, :italic, color]}#{str}" \
-                "#{Ansi[:reset, :bold, color]} "
-            else
-              "#{Ansi[:bold, 231]}#{str} "
-            end,
-          suffix: Ansi.reset
-        }
+      def redraw
+        (wrapper.stream << @msg << (@max_value ? fullbar : indicator)).flush
       end
 
-      COLORS = {
-        default: 231,
-        information: 117,
-        warning: 220,
-        error: 196,
-        completed: 46,
-        failed: 198,
-        query: 220,
-        task: 117
-      }.compare_by_identity.freeze
+      def end_draw
+        (wrapper.stream << Ansi::LINE_CLEAR << Ansi::CURSOR_SHOW).flush
+      end
+
+      def indicator = '◐◓◑◒'[(@indicator += 1) % 4]
+
+      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)})"
+      end
+
+      BAR_COLOR = Ansi[39, 295].freeze
+      BAR_BACK = Ansi[236, 492].freeze
+      BAR_INK = Ansi[:bold, 255, :on_default].freeze
     end
+    private_constant :Progress
 
-    class Section < Section
+    module Temporary
       def temporary
-        stream = wrapper.stream
         unless block_given?
-          stream.flush
+          wrapper.stream.flush
           return self
         end
         count = wrapper.lines_written
@@ -82,158 +101,71 @@ module NattyUI
         ensure
           count = wrapper.lines_written - count
           if count.nonzero?
-            stream << Ansi.cursor_line_up(count) << Ansi.screen_erase_below
+            wrapper.stream << Ansi.cursor_line_up(count) <<
+              Ansi::SCREEN_ERASE_BELOW
           end
-          stream.flush
+          wrapper.stream.flush
         end
       end
+    end
+    private_constant :Temporary
 
-      protected
-
-      def initialize(parent, prefix_attr: nil, **opts)
-        super
-        return unless @prefix && prefix_attr
-        @prefix = Ansi.embellish(@prefix, *prefix_attr)
-      end
+    class Section < Section
+      include Temporary
     end
+    private_constant :Section
 
-    class Heading < Heading
-      protected
+    class Quote < Quote
+      include Temporary
 
-      def enclose(weight)
-        prefix, suffix = super
-        ["#{PREFIX}#{prefix}#{MSG}", "#{PREFIX}#{suffix}#{Ansi.reset}"]
+      def initialize(...)
+        super
+        @prefix = "#{Ansi[39]}#{@prefix}#{Ansi::RESET}"
       end
+    end
+    private_constant :Quote
 
-      PREFIX = Ansi[39].freeze
-      MSG = Ansi[:bold, 231].freeze
+    class Framed < Framed
+      def color(str) = "#{Ansi[39]}#{str}#{Ansi::RESET}"
     end
+    private_constant :Framed
 
-    class Framed < Section
+    class Message < Section
       protected
 
-      def initialize(parent, title:, type:, **opts)
-        @parent = parent
-        title = title.to_s.tr("\r\n", '')
-        topl, topr, botl, botr, hor, vert = *components(type)
-        width = available_width
-        rcount = [width - _plain_width(title) - 6, 0].max
+      def initialize(parent, title:, glyph:)
+        wrapper = parent.wrapper
+        color = COLORS[glyph] || COLORS[:default]
+        glyph = wrapper.glyph(glyph) || glyph
+        prefix_width = NattyUI.display_width(glyph) + 1
         parent.puts(
-          "#{COLOR}#{topl}#{hor}#{hor}#{Ansi.reset} " \
-            "#{TITLE_ATTR}#{title}#{Ansi.reset} " \
-            "#{COLOR}#{hor * rcount}#{topr}#{Ansi.reset}"
+          title,
+          prefix: "#{glyph} #{color}",
+          prefix_width: prefix_width,
+          suffix: Ansi::RESET,
+          suffix_width: 0
         )
-        @bottom = "#{COLOR}#{botl}#{hor * (width - 2)}#{botr}#{Ansi.reset}"
-        vert = "#{COLOR}#{vert}#{Ansi.reset}"
-        super(
-          parent,
-          prefix: "#{vert} ",
-          suffix:
-            "#{Ansi.cursor_right_aligned}" \
-              "#{Ansi.cursor_left(suffix_width)}#{vert}",
-          **opts
-        )
-      end
-
-      def suffix = "#{super} "
-      def finish = parent.puts(@bottom)
-
-      def components(type)
-        COMPONENTS[type] || raise(ArgumentError, "invalid frame type - #{type}")
+        super(parent, prefix: ' ' * prefix_width, prefix_width: prefix_width)
       end
 
-      COLOR = Ansi[39].freeze
-      TITLE_ATTR = Ansi[:bold, 231].freeze
-      COMPONENTS = {
-        rounded: %w[╭ ╮ ╰ ╯ ─ │],
-        simple: %w[┌ ┐ └ ┘ ─ │],
-        heavy: %w[┏ ┓ ┗ ┛ ━ ┃],
-        semi: %w[┍ ┑ ┕ ┙ ━ │],
-        double: %w[╔ ╗ ╚ ╝ ═ ║]
+      COLORS = {
+        default: Ansi[255],
+        information: Ansi[255],
+        warning: Ansi[221],
+        error: Ansi[208],
+        completed: Ansi[82],
+        failed: Ansi[196],
+        task: Ansi[39],
+        query: Ansi[255]
       }.compare_by_identity.freeze
     end
-
-    class Ask < Ask
-      protected
-
-      def query(question)
-        (wrapper.stream << "#{prefix}#{PREFIX} #{question}#{Ansi.reset} ").flush
-      end
-
-      def finish = (wrapper.stream << Ansi.line_clear).flush
-
-      PREFIX = "#{Ansi[:bold, :italic, 220]}▶︎#{Ansi[:reset, 220]}".freeze
-    end
-
-    class Request < Request
-      def prompt(question) = "#{prefix}#{PREFIX} #{question}#{Ansi.reset} "
-      def finish = (wrapper.stream << FINISH).flush
-
-      PREFIX = "#{Ansi[:bold, :italic, 220]}▶︎#{Ansi[:reset, 220]}".freeze
-      FINISH = (Ansi.cursor_line_up + Ansi.line_erase_to_end).freeze
-    end
-
-    class Query < Query
-      protected
-
-      def read(choices, result_typye)
-        wrapper.stream << "#{prefix}#{PROMPT} "
-        super
-      end
-
-      PROMPT = Ansi.embellish(':', :bold, 220).freeze
-    end
+    private_constant :Message
 
     class Task < Message
       include ProgressAttributes
       include TaskMethods
     end
-
-    class Progress < Progress
-      protected
-
-      def draw(title)
-        @prefix = "#{prefix}#{TITLE_PREFIX}#{title}#{Ansi.reset} "
-        (wrapper.stream << @prefix << Ansi.cursor_hide).flush
-        @prefix = "#{Ansi.line_clear}#{@prefix}"
-        if @max_value
-          @prefix << BAR_COLOR
-        else
-          @prefix << INDICATOR_ATTRIBUTE
-          @indicator = 0
-        end
-      end
-
-      def redraw
-        (wrapper.stream << @prefix << (@max_value ? fullbar : indicator)).flush
-      end
-
-      def end_draw = (wrapper.stream << ERASE).flush
-      def indicator = '─╲│╱'[(@indicator += 1) % 4]
-      # def indicator = '⣷⣯⣟⡿⢿⣻⣽⣾'[(@indicator += 1) % 8]
-
-      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)})"
-      end
-
-      TITLE_PREFIX = "#{Ansi[:bold, :italic, 117]}➔#{Ansi[:reset, 117]} ".freeze
-      INDICATOR_ATTRIBUTE = Ansi[:bold, 220].freeze
-      BAR_COLOR = Ansi[39, 295].freeze
-      BAR_BACK = Ansi[236, 492].freeze
-      BAR_INK = Ansi[:bold, 255, :on_default].freeze
-      ERASE = (Ansi.line_clear + Ansi.cursor_show).freeze
-    end
-
-    PAGE_BEGIN =
-      "#{Ansi.reset}#{Ansi.cursor_save_pos}#{Ansi.screen_save}" \
-        "#{Ansi.cursor_home}#{Ansi.screen_erase}".freeze
-    PAGE_END =
-      "#{Ansi.screen_restore}#{Ansi.cursor_restore_pos}#{Ansi.reset}".freeze
+    private_constant :Task
   end
 
   private_constant :AnsiWrapper

data/lib/natty-ui/features.rb

@@ -5,32 +5,25 @@ module NattyUI
   # Features of {NattyUI} - methods to display natty elements.
   #
   module Features
-    # Print a horizontal rule
-    #
-    # @param [#to_s] symbol string to build the horizontal rule
-    # @return [Wrapper, Wrapper::Element] itself
-    def hr(symbol = '═')
-      symbol = symbol.to_s
-      size = _plain_width(symbol)
-      return self if size.zero?
-      msg = symbol * ((available_width - 1) / size)
-      return puts(msg, prefix: Ansi[39], suffix: Ansi.reset) if wrapper.ansi?
-      puts(msg)
+    # @return [Wrapper] assigned output stream wrapper
+    def wrapper
+      return @wrapper if @wrapper
+      @wrapper = @parent
+      @wrapper = @wrapper.parent until @wrapper.is_a?(Wrapper)
+      @wrapper
     end
 
     protected
 
-    def _plain_width(str) = NattyUI.display_width(NattyUI.plain(str))
-    def _blemish_width(str) = NattyUI.display_width(Ansi.blemish(str))
-
-    def _element(type, *args)
-      wrapper.class.const_get(type).__send__(:new, self).__send__(:_call, *args)
+    def _element(type, ...)
+      wrapper.class.const_get(type).__send__(:new, self).__send__(:call, ...)
     end
 
-    def _section(owner, type, args, **opts, &block)
-      sec = wrapper.class.const_get(type).__send__(:new, owner, **opts)
+    def _section(type, args = nil, owner: nil, **opts, &block)
+      sec = wrapper.class.const_get(type).__send__(:new, owner || self, **opts)
       sec.puts(*args) if args && !args.empty?
-      block ? sec.__send__(:_call, &block) : sec
+      sec.__send__(:call, &block) if block
+      sec
     end
   end
 end

data/lib/natty-ui/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NattyUI
-  # @return [String] the version number of the gem
-  VERSION = '0.6.0'
+  # The version number of the gem.
+  VERSION = '0.8.0'
 end

data/lib/natty-ui/wrapper/ask.rb

@@ -13,13 +13,13 @@ module NattyUI
     # The default for `yes` includes `ENTER` and `RETURN` key
     #
     # @example
-    #   case sec.ask('Do you like the NattyUI gem?')
+    #   case ui.ask('Do you like the NattyUI gem?')
     #   when true
-    #     sec.info('Yeah!!')
+    #     ui.info('Yeah!!')
     #   when false
-    #     sec.write("That's pity!")
+    #     ui.write("That's pity!")
     #   else
-    #     sec.failed('You should have an opinion!')
+    #     ui.failed('You should have an opinion!')
     #   end
     #
     # @see NattyUI.in_stream
@@ -28,7 +28,7 @@ module NattyUI
     # @param yes [#to_s] chars which will be used to answer 'Yes'
     # @param no [#to_s] chars which will be used to answer 'No'
     # @return [Boolean] whether the answer is yes or no
-    # @return [nil] when input was aborted with `ESC`, `^C` or `^D`
+    # @return [nil] when input was aborted with `^C` or `^D`
     def ask(question, yes: "jotsyd\r\n", no: 'n')
       _element(:Ask, question, yes, no)
     end
@@ -42,27 +42,33 @@ module NattyUI
     class Ask < Element
       protected
 
-      def _call(question, yes, no)
+      def call(question, yes, no)
         yes, no = grab(yes, no)
-        query(question)
-        read(yes, no)
-      ensure
-        finish
-      end
-
-      def query(question)
-        (wrapper.stream << prefix << "▶︎ #{question} ").flush
-      end
-
-      def finish = (wrapper.stream << "\n").flush
-
-      def read(yes, no)
+        draw(question)
         while true
           char = NattyUI.in_stream.getch
-          return if "\u0003\u0004\e".include?(char)
+          return if "\3\4".include?(char)
           return true if yes.include?(char)
           return false if no.include?(char)
         end
+      rescue Interrupt, SystemCallError
+        nil
+      ensure
+        if @parent.ansi?
+          (wrapper.stream << Ansi::LINE_CLEAR).flush
+        else
+          @parent.puts
+        end
+      end
+
+      def draw(question)
+        glyph = wrapper.glyph(:query)
+        @parent.print(
+          question,
+          prefix: "#{glyph} #{Ansi[255]}",
+          prefix_width: NattyUI.display_width(glyph) + 1,
+          suffix_width: 0
+        )
       end
 
       def grab(yes, no)

data/lib/natty-ui/wrapper/element.rb

@@ -10,7 +10,7 @@ module NattyUI
     class Element
       include Features
 
-      # @return [Section] when embedded in a section
+      # @return [Element] when embedded in a section
       # @return [Wrapper] when not embedded in a section
       attr_reader :parent
 
@@ -22,6 +22,9 @@ module NattyUI
       # @return [Boolean] whether its closed or not
       def closed? = (@status != nil)
 
+      # @return [Integer] available columns count within the element
+      def available_width = @parent.available_width
+
       # Close the element.
       #
       # @return [Element] itself
@@ -29,28 +32,11 @@ module NattyUI
 
       alias _to_s to_s
       private :_to_s
-
       # @!visibility private
-      def inspect = "#{_to_s[..-2]} status=#{@status}}}>"
+      def inspect = _to_s
 
       protected
 
-      def prefix = "#{@parent.__send__(:prefix)}#{@prefix}"
-      def suffix = "#{@suffix}#{@parent.__send__(:suffix)}"
-      def prefix_width = _blemish_width(prefix)
-      def suffix_width = _blemish_width(suffix)
-      def available_width = wrapper.screen_columns - prefix_width - suffix_width
-      def finish = nil
-
-      def wrapper
-        return @wrapper if @wrapper
-        @wrapper = self
-        @wrapper = @wrapper.parent until @wrapper.is_a?(Wrapper)
-        @wrapper
-      end
-
-      def initialize(parent) = (@parent = parent)
-
       def _close(state)
         return self if @status
         @status = state
@@ -58,18 +44,28 @@ module NattyUI
         @raise ? raise(BREAK) : self
       end
 
-      def _call
+      def call
+        NattyUI.instance_variable_set(:@element, self)
         @raise = true
         yield(self)
-        close unless closed?
+        closed? ? self : close
       rescue BREAK
         nil
+      ensure
+        NattyUI.instance_variable_set(:@element, @parent)
       end
 
-      BREAK = Class.new(StandardError)
-      private_constant :BREAK
+      def finish = nil
+      def prefix = "#{@parent.instance_variable_get(:@prefix)}#{@prefix}"
+
+      def initialize(parent)
+        @parent = parent
+      end
 
       private_class_method :new
+
+      BREAK = Class.new(StandardError)
+      private_constant :BREAK
     end
   end
 end

data/lib/natty-ui/wrapper/framed.rb

@@ -10,15 +10,14 @@ module NattyUI
     # When no block is given, the section must be closed, see
     # {Wrapper::Element#close}.
     #
-    # @param [#to_s] title object to print as section title
     # @param [Array<#to_s>] args more objects to print
     # @param [Symbol] type frame type;
     #   valid types are `:rounded`, `:simple`, `:heavy`, `:semi`, `:double`
     # @yieldparam [Wrapper::Framed] framed the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Framed] itself, when no code block is given
-    def framed(title, *args, type: :rounded, &block)
-      _section(self, :Framed, args, title: title, type: type, &block)
+    def framed(*args, type: :rounded, &block)
+      _section(:Framed, args, type: type, &block)
     end
   end
 
@@ -30,25 +29,31 @@ module NattyUI
     class Framed < Section
       protected
 
-      def initialize(parent, title:, type:, **opts)
-        top_start, top_suffix, left, bottom = components(type)
-        parent.puts(" #{title} ", prefix: top_start, suffix: top_suffix)
-        @bottom = bottom
-        super(parent, prefix: "#{left} ", **opts)
+      def initialize(parent, type:)
+        @type = FRAME_PARTS[type] or
+          raise(ArgumentError, "invalid frame type - #{type.inspect}")
+        parent.puts(
+          color("#{@type[0]}#{@type[1] * (parent.available_width - 2)}")
+        )
+        super(parent, prefix: "#{color(@type[4])} ", prefix_width: 2)
+        @suffix = ' '
+        @suffix_width = 1
       end
 
-      def finish = parent.puts(@bottom)
-
-      def components(type)
-        COMPONENTS[type] || raise(ArgumentError, "invalid frame type - #{type}")
+      def finish
+        @parent.puts(
+          color("#{@type[3]}#{@type[1] * (@parent.available_width - 2)}")
+        )
       end
 
-      COMPONENTS = {
-        rounded: %w[╭── ───── │ ╰──────────],
-        simple: %w[┌── ───── │ └──────────],
-        heavy: %w[┏━━ ━━━━━ ┃ ┗━━━━━━━━━━],
-        semi: %w[┍━━ ━━━━━ │ ┕━━━━━━━━━━],
-        double: %w[╔══ ═════ ║ ╚══════════]
+      def color(str) = str
+
+      FRAME_PARTS = {
+        rounded: '╭─╮╰│╯',
+        simple: '┌─┐└│┘',
+        heavy: '┏━┓┗┃┛',
+        double: '╔═╗╚║╝',
+        semi: '╒═╕╘│╛'
       }.compare_by_identity.freeze
     end
   end