natty-ui 0.6.0 → 0.8.0

data/lib/natty-ui.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'readline'
 unless defined?(Reline)
   # load the Reline::Unicode part only
   # @!visibility private
@@ -15,7 +14,7 @@ require_relative 'natty-ui/ansi_wrapper'
 
 #
 # Module to create beautiful, nice, nifty, fancy, neat, pretty, cool, lovely,
-# natty user interfaces for your CLI.
+# 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
@@ -25,9 +24,12 @@ module NattyUI
   class << self
     # @see .valid_in?
     # @return [IO] IO stream used to read input
-    # @raise TypeError when a non-readable stream will be assigned
+    # @raise [TypeError] when a non-readable stream will be assigned
     attr_reader :in_stream
 
+    # @return [Wrapper, Wrapper::Element] active UI element
+    attr_reader :element
+
     # @param [IO] stream to read input
     def in_stream=(stream)
       unless valid_in?(stream)
@@ -44,7 +46,7 @@ module NattyUI
     # @param [Boolean, :auto] ansi whether ANSI should be supported
     #   or automatically selected
     # @return [Wrapper] wrapper for the given `stream`
-    # @raise TypeError when `stream` is not a writable stream
+    # @raise [TypeError] when `stream` is not a writable stream
     def new(stream, ansi: :auto)
       unless valid_out?(stream)
         raise(TypeError, "writable IO required  - #{stream.inspect}")
@@ -77,10 +79,9 @@ module NattyUI
     # Translate embedded attribute descriptions into ANSI control codes.
     #
     # @param [#to_s] str string to edit
-    # @return ]String] edited string
+    # @return [String] edited string
     def embellish(str)
-      str = str.to_s
-      return +'' if str.empty?
+      return +'' if (str = str.to_s).empty?
       reset = false
       ret =
         str.gsub(/(\[\[((?~\]\]))\]\])/) do
@@ -91,26 +92,28 @@ module NattyUI
           end
           match.empty? or next "[[#{match}]]"
           reset = false
-          Ansi.reset
+          Ansi::RESET
         end
-      reset ? "#{ret}#{Ansi.reset}" : ret
+      reset ? "#{ret}#{Ansi::RESET}" : ret
     end
 
     # Remove embedded attribute descriptions from given string.
     #
     # @param [#to_s] str string to edit
-    # @return ]String] edited string
-    def plain(str)
-      str
-        .to_s
-        .gsub(/(\[\[((?~\]\]))\]\])/) do
-          match = Regexp.last_match[2]
-          unless match.delete_prefix!('/')
-            ansi = Ansi.try_convert(match)
-            next ansi ? nil : "[[#{match}]]"
+    # @param [:keep,:remove] ansi keep or remove ANSI codes too
+    # @return [String] edited string
+    def plain(str, ansi: :keep)
+      str =
+        str
+          .to_s
+          .gsub(/(\[\[((?~\]\]))\]\])/) do
+            match = Regexp.last_match[2]
+            if match.delete_prefix!('/')
+              next match.empty? ? nil : "[[#{match}]]"
+            end
+            Ansi.try_convert(match) ? nil : "[[#{match}]]"
           end
-          match.empty? ? nil : "[[#{match}]]"
-        end
+      ansi == :keep ? str : Ansi.blemish(str)
     end
 
     # Calculate monospace (display) width of given String.
@@ -119,8 +122,8 @@ module NattyUI
     # @param [#to_s] str string to calculate
     # @return [Integer] the display size
     def display_width(str)
-      str = str.to_s
-      str.empty? ? 0 : Reline::Unicode.calculate_width(str)
+      return 0 if (str = str.to_s).empty?
+      Reline::Unicode.calculate_width(plain(str), true)
     end
 
     # Convert given arguments into strings and yield each line.
@@ -137,12 +140,11 @@ module NattyUI
     #   @return [Enumerator] line enumerator
     def each_line(*strs, max_width: nil, &block)
       return to_enum(__method__, *strs, max_width: max_width) unless block
-      unless max_width
-        strs.each { |str| str.to_s.each_line(chomp: true, &block) }
+      if max_width.nil?
+        strs.each { _1.to_s.each_line(chomp: true, &block) }
         return nil
       end
-      max_width = max_width.to_i
-      return if max_width <= 0
+      return if (max_width = max_width.to_i) <= 0
       strs.each do |str|
         str
           .to_s
@@ -155,37 +157,28 @@ module NattyUI
       nil
     end
 
-    # Read user input line from {.in_stream}.
+    # Read next raw key (keyboard input) from {in_stream}.
     #
-    # This method uses Ruby's Readline implementation (default gem). See there
-    # for more information.
-    #
-    # @see .valid_out?
-    #
-    # @param [#to_s] prompt input prompt
-    # @param [false, nil, #call] completion disable autocompletion, use default
-    #   autocompletion or use given completion proc
-    # @param [IO] stream writeable IO used to display output
-    # @return [String] user input line
-    # @return [nil] when user interrupted input with `^C` or `^D`
-    def readline(prompt = nil, completion: false, stream: StdOut.stream)
-      cp = Readline.completion_proc
-      Readline.completion_proc = completion == false ? ->(*_) {} : completion
-      Readline.output = stream
-      Readline.input = @in_stream
-      Readline.readline(prompt.to_s)
-    rescue Interrupt
-      stream.puts
-      nil
-    ensure
-      Readline.completion_proc = cp
+    # @return [String] read key
+    def read_key
+      return @in_stream.getch unless defined?(@in_stream.getc)
+      return @in_stream.getc unless defined?(@in_stream.raw)
+      @in_stream.raw do |raw|
+        key = raw.getc
+        while (nc = raw.read_nonblock(1, exception: false))
+          nc.is_a?(String) ? key += nc : break
+        end
+        key
+      end
     end
 
     private
 
     def wrapper_class(stream, ansi)
       return AnsiWrapper if ansi == true
-      return Wrapper if ansi == false || ENV.key?('NO_COLOR')
+      if ansi == false || ENV.key?('NO_COLOR') || ENV['TERM'] == 'dumb'
+        return Wrapper
+      end
       stream.tty? ? AnsiWrapper : Wrapper
     end
 
@@ -202,5 +195,10 @@ module NattyUI
   # Instance for standard error output.
   StdErr = stderr_is_stdout? ? StdOut : new(STDERR)
 
+  @element = StdOut
   self.in_stream = STDIN
 end
+
+# @see NattyUI.element
+# @return [NattyUI::Wrapper, NattyUI::Wrapper::Element] active UI element
+def ui = NattyUI.element unless defined?(ui)

data/lib/natty_ui.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'natty-ui'

metadata

@@ -1,21 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-17 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies: []
 description: |
   This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely,
-  natty user interface you like to have for your command line interfaces
-  (CLI).
-  Here you find elegant, simple and beautiful tools that enhance your
-  command line application functionally and aesthetically.
+  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.
 email:
 executables: []
 extensions: []
@@ -23,32 +22,42 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- ".yardopts"
 - LICENSE
 - README.md
+- examples/24bit-colors.rb
+- examples/3bit-colors.rb
+- examples/8bit-colors.rb
 - examples/attributes.rb
-- examples/basic.rb
+- examples/demo.rb
 - examples/illustration.png
+- examples/illustration.rb
 - examples/list_in_columns.rb
 - examples/progress.rb
 - examples/query.rb
+- examples/table.rb
 - lib/natty-ui.rb
 - lib/natty-ui/ansi.rb
 - lib/natty-ui/ansi_wrapper.rb
 - lib/natty-ui/features.rb
-- lib/natty-ui/mixins.rb
 - lib/natty-ui/version.rb
 - lib/natty-ui/wrapper.rb
 - lib/natty-ui/wrapper/ask.rb
 - lib/natty-ui/wrapper/element.rb
 - lib/natty-ui/wrapper/framed.rb
 - lib/natty-ui/wrapper/heading.rb
+- lib/natty-ui/wrapper/horizontal_rule.rb
 - lib/natty-ui/wrapper/list_in_columns.rb
 - lib/natty-ui/wrapper/message.rb
+- lib/natty-ui/wrapper/mixins.rb
 - lib/natty-ui/wrapper/progress.rb
 - lib/natty-ui/wrapper/query.rb
+- lib/natty-ui/wrapper/quote.rb
 - lib/natty-ui/wrapper/request.rb
 - lib/natty-ui/wrapper/section.rb
+- lib/natty-ui/wrapper/table.rb
 - lib/natty-ui/wrapper/task.rb
+- lib/natty_ui.rb
 homepage: https://github.com/mblumtritt/natty-ui
 licenses:
 - BSD-3-Clause
@@ -72,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.13
 signing_key:
 specification_version: 4
 summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely, natty

data/examples/basic.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'natty-ui'
-
-UI = NattyUI::StdOut
-
-UI.space
-
-UI.h1 'NattyUI Basic Feature Demo', <<~TEXT
-
-  This is a short demo of the basic features of [[75 bold]]NattyUI[[/]].
-
-TEXT
-
-UI.h2 'Feature: ANSI Colors and Attributes', <<~TEXT
-
-  Like you might noticed you can [[57]]color [[d7]]text[[/]] for terminals supporting this
-  feature. You can enforece the non-ANSI version by setting the environment
-  variable [[75 italic]]NO_COLOR[[/]] to '[[75]]1[[/]]'. (see also [[underline]]https://no-color.org[[/]])
-
-  You can not only color your text but also [[italic]]modify[[/]], [[underline]]decorate[[/]] and [[strike]]manipulate[[/]]
-  it. The attributes are direct embedded into the text like '[[/bold red]]'
-  and can be resetted with '[[//]]' or at the line end.
-
-TEXT
-
-UI.h2 'Feature: Sections' do |sec|
-  sec.puts <<~TEXT
-
-    Sections group text lines together and/or define their style. There are
-    several section types which all can be stacked.
-
-    Have a look at the different types of sections:
-
-  TEXT
-  sec.message 'Generic Message'
-  sec.information 'Informational Message'
-  sec.warning 'Warning Message'
-  sec.error 'Error Message'
-  sec.completed 'Completion Message'
-  sec.failed 'Failure Message'
-  sec.msg '[[d5]]Customized Message', symbol: '◉'
-  sec.space
-
-  sec.puts 'You can stack all kinds of sections together:'
-  sec.space
-  sec.framed('Rouned Frame') do |f1|
-    f1.framed('Heavy Framed', type: :heavy) do |f2|
-      f2.framed('Simple Frame', type: :simple) do |f3|
-        f3.framed('Double Framed Section', type: :double) do |f4|
-          f4.message(
-            '[[fff400]]Frames are nice',
-            "Just to show you that all sections\ncan be stacked...",
-            symbol: '💛'
-          )
-        end
-      end
-    end
-  end
-end
-
-UI.space