natty-ui 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9531c1f73a1d9ca8f9a09f279eb3939f8ed0f37bc940d5f50aa479edc1b38ca
-  data.tar.gz: d380394514fb92fe411cfbfcf1c7ba6bd95c9388ecfcdb31752ea47df8efeb9b
+  metadata.gz: 6a717eec681b358c4979684881f16d5217dea7ebacca3baf46f84edfc318d39b
+  data.tar.gz: 2829903b6bf15aa81d33259bf77633d6ed6b9e5f88a598bc858b881be94da4cc
 SHA512:
-  metadata.gz: '086c5832e6c811a5fab7f2e4866018d4cd6cc898af2866283e19b71330f4d6d05a5f17089bf5ac383cb26e5006bce66ca37ba63baef4e9ff7444bb1e44ca0cc7'
-  data.tar.gz: 4d13067a100b10d09565fa2cf95bdd39d40c5c31e25fa5971d666e272d2e7ebbfd73b7188f12e6bc41bfc168b1a8864da6705636f70204185b8daf34ef614e00
+  metadata.gz: 274f008deb82e73ba4a6c0b93d2a4e4cea3afdd60284d8fdc8e462e56cf04f6e5bda8a25af1c1707cd5a8c92612d48f445f5d127fb5c6531d183b3b8ac424279
+  data.tar.gz: 770c07b0085ac1efd565b141fae6f704899a89b7e8b648fd27e687166a13676edd3a38039d8f4aeae7c490849cf39a5d2d22daed25d6a1c0b9540340b21483f4

data/README.md

@@ -44,7 +44,7 @@ or use progression displays like progress bars.
 
 🚀 There are much more [features](https://rubydoc.info/gems/natty-ui/NattyUI/Features)!
 
-📕 See the [online help](https://rubydoc.info/gems/natty-ui/NattyUI) for more details or have a look at the [examples](./examples/) directory to get an impression of the current feature set (see also XXX).
+📕 See the [online help](https://rubydoc.info/gems/natty-ui/NattyUI) for more details or have a look at the [examples](./examples/) directory to get an impression of the current feature set.
 
 ![illustration](https://raw.githubusercontent.com/mblumtritt/natty-ui/main/examples/illustration.svg)
 

data/lib/natty-ui/version.rb

@@ -2,5 +2,5 @@
 
 module NattyUI
   # @return [String] the version number of the gem
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

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

@@ -22,6 +22,8 @@ module NattyUI
     #     sec.failed('You should have an opinion!')
     #   end
     #
+    # @see NattyUI.in_stream
+    #
     # @param question [#to_s] Question to display
     # @param yes [#to_s] chars which will be used to answer 'Yes'
     # @param no [#to_s] chars which will be used to answer 'No'

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

@@ -24,8 +24,7 @@ module NattyUI
 
       # Close the element.
       #
-      # @return [Element] itself when used without a code block
-      # @return [nil] when used with a code block
+      # @return [Element] itself
       def close = _close(:closed)
 
       alias _to_s to_s

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

@@ -14,7 +14,7 @@ module NattyUI
     # @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] section the created section
+    # @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)

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

@@ -7,7 +7,7 @@ module NattyUI
     # Creates section with a H1 title.
     #
     # @param (see #information)
-    # @yieldparam [Wrapper::Heading] section the created section
+    # @yieldparam [Wrapper::Heading] heading the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Heading] itself, when no code block is given
     def h1(title, *args, &block)

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

@@ -10,7 +10,7 @@ module NattyUI
     # @param [#to_s] title object to print as section title
     # @param [Array<#to_s>] args more objects to print
     # @param [#to_s] symbol symbol/prefix used for the title
-    # @yieldparam [Wrapper::Message] section the created section
+    # @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, symbol: :default, &block)

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

@@ -24,6 +24,8 @@ module NattyUI
     #   )
     #   # => '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 ist returned

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

@@ -29,7 +29,7 @@ module NattyUI
 
   class Wrapper
     #
-    # Visual element to keep text lines together.
+    # Visual {Element} to keep text lines together.
     #
     # A section can contain other elements and sections.
     #
@@ -38,21 +38,23 @@ module NattyUI
     class Section < Element
       # Close the section.
       #
-      # @return [Section] itself when used without a code block
-      # @return [nil] when used with a code block
+      # @return [Section] itself
       def close = _close(:closed)
 
       # Print given arguments as lines into the section.
+      # Optionally limit the line width to given `max_width`.
       #
-      # @overload puts(...)
+      # @overload puts(..., max_width: nil)
       #   @param [#to_s] ... objects to print
+      #   @param [Integer, nil] max_width maximum line width
       #   @comment @param [#to_s, nil] prefix line prefix
       #   @comment @param [#to_s, nil] suffix line suffix
       #   @return [Section] itself
-      def puts(*args, prefix: nil, suffix: nil)
+      def puts(*args, max_width: nil, prefix: nil, suffix: nil)
         return self if @status
         @parent.puts(
           *args,
+          max_width: max_width,
           prefix: prefix ? "#{@prefix}#{prefix}" : @prefix,
           suffix: suffix ? "#{@suffix}#{suffix}" : @suffix
         )

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

@@ -11,7 +11,7 @@ module NattyUI
     # or {#failed}.
     #
     # @param (see #information)
-    # @yieldparam [Wrapper::Task] section the created section
+    # @yieldparam [Wrapper::Task] task the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Task] itself, when no code block is given
     def task(title, *args, &block)

data/lib/natty-ui/wrapper.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'stringio'
 require_relative 'wrapper/ask'
 require_relative 'wrapper/framed'
 require_relative 'wrapper/heading'
@@ -28,13 +27,13 @@ module NattyUI
     # @return [[Integer, Integer]] screen size as rows and columns
     def screen_size
       return @stream.winsize if @ws
-      [ENV['LINES'].to_i.nonzero? || 25, ENV['COLUMNS'].to_i.nonzero? || 80]
+      [ENV['LINES'].to_i.nonzero? || 24, ENV['COLUMNS'].to_i.nonzero? || 80]
     end
 
     # @attribute [r] screen_rows
     # @return [Integer] number of screen rows
     def screen_rows
-      @ws ? @stream.winsize[0] : (ENV['LINES'].to_i.nonzero? || 25)
+      @ws ? @stream.winsize[0] : (ENV['LINES'].to_i.nonzero? || 24)
     end
 
     # @attribute [r] screen_columns
@@ -46,24 +45,22 @@ module NattyUI
     # @!group Tool functions
 
     # Print given arguments as lines to the output stream.
+    # Optionally limit the line width to given `max_width`.
     #
-    # @overload puts(...)
+    # @overload puts(..., max_width: nil)
     #   @param [#to_s] ... objects to print
+    #   @param [Integer, nil] max_width maximum line width
     #   @comment @param [#to_s, nil] prefix line prefix
     #   @comment @param [#to_s, nil] suffix line suffix
     #   @return [Wrapper] itself
-    def puts(*args, prefix: nil, suffix: nil)
+    def puts(*args, max_width: nil, prefix: nil, suffix: nil)
       if args.empty?
         @stream.puts(embellish("#{prefix}#{suffix}"))
         @lines_written += 1
       else
-        StringIO.open do |io|
-          io.puts(*args)
-          io.rewind
-          io.each(chomp: true) do |line|
-            @stream.puts(embellish("#{prefix}#{line}#{suffix}"))
-            @lines_written += 1
-          end
+        NattyUI.each_line(*args, max_width: max_width) do |line|
+          @stream.puts(embellish("#{prefix}#{line}#{suffix}"))
+          @lines_written += 1
         end
       end
       @stream.flush
@@ -154,7 +151,7 @@ module NattyUI
     def initialize(stream)
       @stream = stream
       @lines_written = 0
-      @ws = stream.respond_to?(:winsize) && stream.winsize&.size == 2
+      @ws = stream.respond_to?(:winsize) && stream.winsize&.all?(&:positive?)
     rescue Errno::ENOTTY
       @ws = false
     end

data/lib/natty-ui.rb

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 
-require 'reline'
+require 'readline'
+unless defined?(Reline)
+  # only load the Reline::Unicode part
+  # @!visibility private
+  module Reline
+    def self.ambiguous_width = 1
+  end
+  require 'reline/unicode'
+end
 require_relative 'natty-ui/wrapper'
 require_relative 'natty-ui/ansi_wrapper'
 
@@ -114,6 +122,55 @@ module NattyUI
       str.empty? ? 0 : Reline::Unicode.calculate_width(str)
     end
 
+    # Convert given arguments into strings and yield each line.
+    # Optionally limit the line width to given `max_width`.
+    #
+    # @overload each_line(..., max_width: nil)
+    #   @param [#to_s] ... objects to print
+    #   @param [#to_i, nil] max_width maximum line width
+    #   @yieldparam [String] line string line
+    #   @return [nil]
+    # @overload each_line(..., max_width: nil)
+    #   @param [#to_s] ... objects to print
+    #   @param [#to_i, nil] max_width maximum line width
+    #   @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) }
+        return nil
+      end
+      max_width = max_width.to_i
+      return if max_width <= 0
+      strs.each do |str|
+        str
+          .to_s
+          .each_line(chomp: true) do |line|
+            Reline::Unicode.split_by_width(line, max_width)[0].each do |part|
+              yield(part) if part
+            end
+          end
+      end
+      nil
+    end
+
+    # Read user input line from {.in_stream}.
+    #
+    # @see .valid_out?
+    #
+    # @param [#to_s] prompt input prompt
+    # @param [IO] stream writeable IO used to display output
+    # @return [String] user input line
+    # @return [nil] when user interrputed input with `^C` or `^D`
+    def readline(prompt = nil, stream: StdOut.stream)
+      Readline.output = stream
+      Readline.input = @in_stream
+      Readline.readline(prompt.to_s)
+    rescue Interrupt
+      stream.puts
+      nil
+    end
+
     private
 
     def wrapper_class(stream, ansi)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2023-11-11 00:00:00.000000000 Z
 dependencies: []
 description: |
   This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely,