natty-ui 0.12.0 → 0.25.0

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

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'section'
-
-module NattyUI
-  module Features
-    # Creates a section with a highlighted `title` and prints given additional
-    # arguments as lines into the section.
-    #
-    # @param [#to_s] title object to print as section title
-    # @param [Array<#to_s>] args more objects to print
-    # @param [Symbol, #to_s] glyph used for the title; see {NattyUI::Glyph}
-    # @yieldparam [Wrapper::Message] message the created section
-    # @return [Object] the result of the code block
-    # @return [Wrapper::Message] itself, when no code block is given
-    def message(title, *args, glyph: :default, &block)
-      _section(:Message, args, title: title, glyph: glyph, &block)
-    end
-    alias msg message
-
-    # Creates a informational message section with a highlighted `title`  and
-    # prints given additional arguments as lines into the section.
-    #
-    # @param [#to_s] title object to print as section title
-    # @param [Array<#to_s>] args more objects to print
-    # @yieldparam (see #message)
-    # @return (see #message)
-    def information(title, *args, &block)
-      _section(:Message, args, title: title, glyph: :information, &block)
-    end
-    alias info information
-
-    # Creates a warning message section with a highlighted `title`  and
-    # prints given additional arguments as lines into the section.
-    #
-    # @param (see #information)
-    # @yieldparam (see #message)
-    # @return (see #message)
-    def warning(title, *args, &block)
-      _section(:Message, args, title: title, glyph: :warning, &block)
-    end
-    alias warn warning
-
-    # Creates a error message section with a highlighted `title`  and
-    # prints given additional arguments as lines into the section.
-    #
-    # @param (see #information)
-    # @yieldparam (see #message)
-    # @return (see #message)
-    def error(title, *args, &block)
-      _section(:Message, args, title: title, glyph: :error, &block)
-    end
-    alias err error
-
-    # Creates a completion message section with a highlighted `title`  and
-    # prints given additional arguments as lines into the section.
-    #
-    # When used for a {#task} section it closes this section with status `:ok`.
-    #
-    # @param (see #information)
-    # @yieldparam (see #message)
-    # @return (see #message)
-    def completed(title, *args, &block)
-      _section(:Message, args, title: title, glyph: :completed, &block)
-    end
-    alias done completed
-    alias ok completed
-
-    # Creates a failure message section with a highlighted `title` and
-    # prints given additional arguments as lines into the section.
-    #
-    # When used for a {#task} section it closes this section with status
-    # `:failed`.
-    #
-    # @param (see #information)
-    # @yieldparam (see #message)
-    # @return (see #message)
-    def failed(title, *args, &block)
-      _section(:Message, args, title: title, glyph: :failed, &block)
-    end
-  end
-
-  class Wrapper
-    #
-    # A {Section} with a highlighted title.
-    #
-    # @see Features#message
-    # @see Features#information
-    # @see Features#warning
-    # @see Features#error
-    # @see Features#completed
-    # @see Features#failed
-    class Message < Section
-      protected
-
-      def initialize(parent, title:, glyph:)
-        glyph = NattyUI::Glyph[glyph]
-        prefix_width = Text.width(glyph) + 1
-        super(
-          parent,
-          prefix: ' ' * prefix_width,
-          prefix_width: prefix_width,
-          suffix_width: 0
-        )
-        parent.puts(title, prefix: "#{glyph} ", prefix_width: prefix_width)
-      end
-    end
-  end
-end

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

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module NattyUI
-  #
-  # Additional attributes for progression elements.
-  #
-  # Progression elements have additional states ({#completed?}, {#failed?}) and
-  # can be closed with calling {Features#completed} or {Features#failed}.
-  #
-  # @see Wrapper::Progress
-  # @see Wrapper::Task
-  #
-  module ProgressAttributes
-    # @attribute [r] completed?
-    # @return [Boolean] whether the task completed successfully
-    def completed? = (@status == :completed)
-
-    # @attribute [r] failed?
-    # @return [Boolean] whether the task failed
-    def failed? = (@status == :failed)
-
-    # @!visibility private
-    def completed(*args)
-      @final_text = args unless args.empty?
-      _close(:completed)
-    end
-    alias done completed
-    alias ok completed
-
-    # @!visibility private
-    def failed(*args)
-      @final_text = args unless args.empty?
-      _close(:failed)
-    end
-  end
-
-  #
-  # Additional attributes for progression elements.
-  #
-  # @see Wrapper::Progress
-  #
-  module ValueAttributes
-    # @return [Float] current value
-    attr_reader :value
-
-    def value=(val)
-      @value = [0, val.to_f].max
-      @max_value = @value if @max_value&.< 0
-      redraw
-    end
-
-    # Maximum value.
-    #
-    # @return [Float] maximum value
-    # @return [nil] when no max_value was configured
-    attr_reader :max_value
-
-    # Increase the value by given amount.
-    #
-    # @param increment [#to_f] value increment
-    # @return [Wrapper::Element] itself
-    def step(increment = 1)
-      self.value = @value + increment.to_f
-      self
-    end
-  end
-end

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

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'element'
-require_relative 'mixins'
-
-module NattyUI
-  module Features
-    # Creates progress element implementing additional {ProgressAttributes}.
-    #
-    # When a `max_value` is given, the progress will by displayed as a bar.
-    # Otherwise the `spinner` is used for a little animation.
-    #
-    # When no pre-defined spinner is specified then spinner will be
-    # used char-wise as a string for the progress animation.
-    #
-    # A progress element has additional states and can be closed with
-    # {#completed} or {#failed}.
-    #
-    # @param [#to_s] title object to print as progress title
-    # @param [#to_f] max_value maximum value of the progress
-    # @param [Symbol, #to_a, #to_s] spinner spinner type; see {NattyUI::Spinner}
-    # @return [Wrapper::Progress] the created progress element
-    def progress(title, max_value: nil, spinner: :default)
-      _element(:Progress, title, max_value, spinner)
-    end
-  end
-
-  class Wrapper
-    #
-    # An {Element} displaying a progression.
-    #
-    # @see Features#progress
-    class Progress < Element
-      include ProgressAttributes
-      include ValueAttributes
-
-      protected
-
-      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
-      end
-
-      def end_draw = (wrapper.stream << "\n")
-
-      def redraw
-        return (wrapper.stream << '.').flush unless @max_value
-        cn = (20 * @value / @max_value).to_i
-        return if @progress == cn
-        (wrapper.stream << ('.' * (cn - @progress))).flush
-        @progress = cn
-      end
-
-      def finish
-        end_draw
-        return @parent.failed(*@final_text) if failed?
-        _section(
-          :Message,
-          @final_text,
-          owner: @parent,
-          title: @final_text.shift,
-          glyph: @status = :completed
-        )
-      end
-    end
-  end
-end

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

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'element'
-
-module NattyUI
-  module Features
-    # Request a choice from user.
-    #
-    # @example Select by Index
-    #   choice = ui.query(
-    #     'Which fruits do you prefer?',
-    #     'Apples',
-    #     'Bananas',
-    #     'Cherries'
-    #   )
-    #   # => '1' or '2' or '3' or nil if user aborted
-    #
-    # @example Select by given char
-    #   choice = ui.query(
-    #     'Which fruits do you prefer?',
-    #     a: 'Apples',
-    #     b: 'Bananas',
-    #     c: 'Cherries'
-    #   )
-    #   # => 'a' or 'b' or 'c' or nil if user aborted
-    #
-    # @see NattyUI.in_stream
-    #
-    # @param question [#to_s] Question to display
-    # @param choices [#to_s] choices selectable via index (0..9)
-    # @param result  [Symbol] defines how the result will be returned
-    # @param display  [Symbol] display choices as `:list` or `:compact`
-    # @param kw_choices [{Char => #to_s}] choices selectable with given char
-    # @return [Char] when `result` is configured as `:char`
-    # @return [#to_s] when `result` is configured as `:choice`
-    # @return [[Char, #to_s]] when `result` is configured as `:both`
-    # @return [nil] when input was aborted with `^C` or `^D`
-    def query(question, *choices, result: :char, display: :list, **kw_choices)
-      _element(:Query, question, choices, kw_choices, result, display)
-    end
-  end
-
-  class Wrapper
-    #
-    # An {Element} to request a user choice.
-    #
-    # @see Features#query
-    class Query < Element
-      protected
-
-      def call(question, choices, kw_choices, result, display)
-        return if choices.empty? && kw_choices.empty?
-        choices = as_choices(choices, kw_choices)
-        text = choices.map { |k, v| "⦗#{CHOICE_MARK}#{k}#{Ansi::RESET}⦘ #{v}" }
-        @parent.wrapper.temporary do
-          if display == :compact
-            @parent.msg(question, glyph: :query).ls(text)
-          else
-            @parent.msg(question, *text, glyph: :query)
-          end
-          read(choices, result)
-        end
-      end
-
-      def as_choices(choices, kw_choices)
-        choices
-          .take(9)
-          .each_with_index
-          .to_h { |str, i| [i + 1, str] }
-          .merge!(kw_choices)
-          .transform_keys!(&:to_s)
-      end
-
-      def read(choices, result)
-        while true
-          char = NattyUI.read_key
-          return if char == 'Ctrl+C'
-          next unless choices.key?(char)
-          return char if result == :char
-          return choices[char] if result == :title
-          return char, choices[char]
-        end
-      end
-
-      CHOICE_MARK = Ansi[:bold, 34]
-      private_constant :CHOICE_MARK
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'element'
-
-module NattyUI
-  module Features
-    # Creates a quotation section and prints given arguments as lines
-    # into the section.
-    #
-    # @param (see #section)
-    # @yieldparam (see #section)
-    # @return [Object] the result of the code block
-    # @return [Wrapper::Quote] itself, when no code block is given
-    def quote(*args, &block) = _section(:Quote, args, prefix: '▍ ', &block)
-  end
-
-  class Wrapper
-    #
-    # A quotation {Section}.
-    #
-    # @see Features#quote
-    class Quote < Section
-    end
-  end
-end

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

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'element'
-
-module NattyUI
-  module Features
-    # Request user input.
-    #
-    # @param question [#to_s] Question to display
-    # @param password [Boolean] whether to hide the input
-    # @return [String] the user input
-    # @return [nil] when input was aborted with `^C` or `^D`
-    def request(question, password: false)
-      _element(:Request, question, password)
-    end
-  end
-
-  class Wrapper
-    #
-    # An {Element} to request user input.
-    #
-    # @see Features#request
-    class Request < Element
-      protected
-
-      def call(question, password)
-        draw(question)
-        return NattyUI.in_stream.getpass if password
-        NattyUI.in_stream.gets(chomp: true)
-      rescue Interrupt, SystemCallError
-        nil
-      ensure
-        (wrapper = @parent.wrapper).ansi? and
-          (wrapper.stream << ANSI_FINISH).flush
-      end
-
-      def draw(question)
-        wrapper = @parent.wrapper
-        glyph = NattyUI :Glyph[:query]
-        @parent.print(
-          question,
-          prefix: "#{glyph} #{Ansi[255]}",
-          prefix_width: Text.width(glyph) + 1,
-          suffix_width: 0
-        )
-        (wrapper.stream << ANSI_PREFIX).flush if wrapper.ansi?
-      end
-
-      ANSI_PREFIX = Ansi::RESET + Ansi::ITALIC
-      ANSI_FINISH = Ansi::RESET + Ansi::LINE_PREVIOUS + Ansi::LINE_ERASE
-      private_constant :ANSI_PREFIX, :ANSI_FINISH
-    end
-  end
-end

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

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'element'
-
-module NattyUI
-  module Features
-    # Creates a default section and prints given arguments as lines
-    # into the section.
-    #
-    # @param [Array<#to_s>] args optional objects to print
-    # @param [String] prefix used for each printed line
-    # @param [String] suffix used for each printed line
-    # @yieldparam [Wrapper::Section] section the created section
-    # @return [Object] the result of the code block
-    # @return [Wrapper::Section] itself, when no code block is given
-    def section(*args, prefix: '  ', suffix: '  ', &block)
-      _section(:Section, args, prefix: prefix, suffix: suffix, &block)
-    end
-    alias sec section
-  end
-
-  class Wrapper
-    #
-    # Visual {Element} to keep text lines together.
-    #
-    # A section can contain other elements and sections.
-    #
-    # @see Features#section
-    class Section < Element
-      # @return [Integer] available columns count within the section
-      def available_width
-        @available_width ||=
-          @parent.available_width - @prefix_width - @suffix_width
-      end
-
-      # Print given arguments line-wise into the section.
-      #
-      # @param [#to_s] args objects to print
-      # @option options [:left, :right, :center] :align text alignment
-      # @return [Section] itself
-      def puts(*args, **options)
-        return self if @status
-        @parent.puts(
-          *args,
-          **options.merge!(
-            prefix: "#{@prefix}#{options[:prefix]}",
-            prefix_width: @prefix_width + options[:prefix_width].to_i,
-            suffix: "#{options[:suffix]}#{@suffix}",
-            suffix_width: @suffix_width + options[:suffix_width].to_i
-          )
-        )
-        self
-      end
-
-      # Print given arguments into the section.
-      #
-      # @param [#to_s] args objects to print
-      # @option options [:left, :right, :center] :align text alignment
-      # @return [Section] itself
-      def print(*args, **options)
-        return self if @status
-        @parent.print(
-          *args,
-          **options.merge!(
-            prefix: "#{@prefix}#{options[:prefix]}",
-            prefix_width: @prefix_width + options[:prefix_width].to_i,
-            suffix: "#{options[:suffix]}#{@suffix}",
-            suffix_width: @suffix_width + options[:suffix_width].to_i
-          )
-        )
-        self
-      end
-
-      # Add at least one empty line
-      #
-      # @param [#to_i] lines count of lines
-      # @return [Section] itself
-      def space(lines = 1) = puts("\n" * [1, lines.to_i].max)
-
-      # @note The screen manipulation is only available in ANSI mode see {#ansi?}
-      #
-      # Resets the part of the screen written below the current output line when
-      # the given block ended.
-      #
-      # @example
-      #   section.temporary do |temp|
-      #     temp.info('This message will disappear in 5 seconds!')
-      #     sleep 5
-      #   end
-      #
-      # @yield [Section] itself
-      # @return [Object] block result
-      def temporary = block_given? ? yield(self) : self
-
-      # @!visibility private
-      def inspect = @status ? "#{_to_s[..-2]} status=#{@status}>" : _to_s
-
-      # @!visibility private
-      def rcol = @parent.rcol - @suffix_width
-
-      protected
-
-      def initialize(
-        parent,
-        prefix:,
-        prefix_width: Text.width(prefix),
-        suffix: nil,
-        suffix_width: Text.width(suffix)
-      )
-        super(parent)
-        @prefix = prefix
-        @suffix = suffix
-        @prefix_width = prefix_width
-        @suffix_width = suffix_width
-      end
-    end
-  end
-end