natty-ui 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4e46711be1871e4ad647f6fec2312d81473cd52d660c3a157120a6884144936
-  data.tar.gz: a58d2ffef5ff47034d3c1582e18a6e469ac39784d10a30292ac85c4134444ea6
+  metadata.gz: b9531c1f73a1d9ca8f9a09f279eb3939f8ed0f37bc940d5f50aa479edc1b38ca
+  data.tar.gz: d380394514fb92fe411cfbfcf1c7ba6bd95c9388ecfcdb31752ea47df8efeb9b
 SHA512:
-  metadata.gz: 9b1640b52328b2d55ba8568dfe99bca63fba659300bcd11fcc0f05e46dadfa5096cd2d01d97d8f2cd33330e67eca311722587441d60da38ac75db97ddfd32d8d
-  data.tar.gz: 2ba0659ba2823d47c2d8b33f09ec5d0be967c0bcef7354cea2e79d9c7bd68795d0995c8faeb9c762079739332b5835c89703f360290a712120aac67afd05a097
+  metadata.gz: '086c5832e6c811a5fab7f2e4866018d4cd6cc898af2866283e19b71330f4d6d05a5f17089bf5ac383cb26e5006bce66ca37ba63baef4e9ff7444bb1e44ca0cc7'
+  data.tar.gz: 4d13067a100b10d09565fa2cf95bdd39d40c5c31e25fa5971d666e272d2e7ebbfd73b7188f12e6bc41bfc168b1a8864da6705636f70204185b8daf34ef614e00

data/README.md

@@ -1,14 +1,10 @@
-# NattyUI
+# NattyUI ![version](https://img.shields.io/gem/v/natty-ui?label=)
 
 This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely, natty user interface you like to have for your command line interfaces (CLI).
 
-<!-- TODO: ![version](https://img.shields.io/gem/v/natty-ui?label=) -->
-
-<!-- TODO:
 - Gem: [rubygems.org](https://rubygems.org/gems/natty-ui)
 - Source: [github.com](https://github.com/mblumtritt/natty-ui)
 - Help: [rubydoc.info](https://rubydoc.info/gems/natty-ui/NattyUI)
--->
 
 ## Description
 
@@ -44,31 +40,13 @@ UI.framed 'Text Below In Frame' do |framed|
 end
 ```
 
-or use progression displays like progress bars and much much more!
-
-![illustration](https://raw.githubusercontent.com/mblumtritt/natty-ui/main/examples/illustration.svg)
-
-### But there is more!
-
-Have a look at the [examples](./examples/) directory to get an impression of the current feature set.
-
-```sh
-ruby ./examples/basic.rb
-```
-
-or see the non-ANSI version
+or use progression displays like progress bars.
 
-```sh
-NO_COLOR=1 ruby ./examples/basic.rb
-```
+🚀 There are much more [features](https://rubydoc.info/gems/natty-ui/NattyUI/Features)!
 
-<!-- TODO:
-link to NattyUI Features for more 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).
 
-### NO_COLOR Convention
-
-NattyUI follows the [NO_COLOR convention](https://no-color.org).
+![illustration](https://raw.githubusercontent.com/mblumtritt/natty-ui/main/examples/illustration.svg)
 
 ## Installation
 
@@ -90,32 +68,28 @@ After that you only need one line of code to have everything together
 require 'natty-ui'
 ```
 
-## Unicode Support
-
-Unicode is generally supported. This means that for the calculation of screen outputs the different width of characters is considered. For this the wonderful Gem [unicode/display_width](https://github.com/janlelis/unicode-display_width) is used.
+## Run Examples
 
-To be able to use Unicode characters that consist of multiple combinations (like some emoji), you have to explicitly load the Gem unicode/emoji _before_ NattyUI. It is not included automatically, because in most cases it is not needed (and we can save the overhead most of the time).
+You can execute the examples by
 
-If you need the full beauty of Unicode just load it in that order:
-
-```ruby
-require 'unicode/emoji'
-require 'natty-ui'
+```sh
+ruby ./examples/basic.rb
 ```
 
-**Hint**: The compromise of not automatically supporting emojis results from the fact that not all terminals can output all emojis correctly. You can easily check this yourself by
+or see the non-ANSI version
 
 ```sh
-echo "👨‍👩‍👦 👩‍❤️‍👨"
+NO_COLOR=1 ruby ./examples/basic.rb
 ```
 
-in your terminal window.
+## NO_COLOR Convention
+
+NattyUI follows the [NO_COLOR convention](https://no-color.org).
 
 ## TODO
 
 Since I did not complete the tests and not all my ideas are already implemented I have this Todo list:
 
-- add samples to README
 - add more samples to help
 - add more tests
 - simple prompt

data/examples/basic.rb

@@ -5,6 +5,8 @@ require_relative '../lib/natty-ui'
 
 UI = NattyUI::StdOut
 
+UI.space
+
 UI.h1 'NattyUI Basic Feature Demo', <<~TEXT
 
   This is a short demo of the basic features of [[i117 bold]]NattyUI[[/]].

data/examples/colors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require 'natty-ui'
 require_relative '../lib/natty-ui'
 

data/lib/natty-ui/ansi_wrapper.rb

@@ -46,16 +46,16 @@ module NattyUI
 
       def title_attr(str, symbol)
         color = COLORS[symbol]
-        if color
-          {
-            prefix:
+        {
+          prefix:
+            if color
               "#{Ansi[:bold, :italic, color]}#{str}" \
-                "#{Ansi[:reset, :bold, color]} ",
-            suffix: Ansi.reset
-          }
-        else
-          { prefix: "#{Ansi[:bold, 231]}#{str} ", suffix: Ansi.reset }
-        end
+                "#{Ansi[:reset, :bold, color]} "
+            else
+              "#{Ansi[:bold, 231]}#{str} "
+            end,
+          suffix: Ansi.reset
+        }
       end
 
       COLORS = {
@@ -167,12 +167,6 @@ module NattyUI
         end
       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
-
       def draw_final = (wrapper.stream << Ansi.line_clear).flush
 
       def redraw
@@ -194,6 +188,12 @@ module NattyUI
             )
           }"
       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
     end
 
     PAGE_BEGIN =

data/lib/natty-ui/version.rb

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

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

@@ -32,9 +32,7 @@ module NattyUI
       private :_to_s
 
       # @!visibility private
-      def inspect
-        "#{_to_s[..-2]} status=#{@status}}}>"
-      end
+      def inspect = "#{_to_s[..-2]} status=#{@status}}}>"
 
       protected
 
@@ -49,9 +47,7 @@ module NattyUI
         @wrapper
       end
 
-      def initialize(parent)
-        @parent = parent
-      end
+      def initialize(parent) = (@parent = parent)
 
       def _close(state)
         return self if @status

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

@@ -11,11 +11,7 @@ module NattyUI
       wrapper.class.const_get(type).__send__(:new, self).__send__(:_call, *args)
     end
 
-    def _section(type, args, **opts, &block)
-      __section(self, type, args, **opts, &block)
-    end
-
-    def __section(owner, type, args, **opts, &block)
+    def _section(owner, type, args, **opts, &block)
       sec = wrapper.class.const_get(type).__send__(:new, owner, **opts)
       sec.puts(*args) if args && !args.empty?
       block ? sec.__send__(:_call, &block) : sec

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

@@ -7,7 +7,8 @@ module NattyUI
     # Creates frame-enclosed section with a highlighted `title` and
     # prints given additional arguments as lines into the section.
     #
-    # When no block is given, the section must be closed, see {Section#close}.
+    # 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
@@ -17,7 +18,7 @@ module NattyUI
     # @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(:Framed, args, title: title, type: type, &block)
+      _section(self, :Framed, args, title: title, type: type, &block)
     end
   end
 

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

@@ -11,7 +11,7 @@ module NattyUI
     # @return [Object] the result of the code block
     # @return [Wrapper::Heading] itself, when no code block is given
     def h1(title, *args, &block)
-      _section(:Heading, args, title: title, weight: 1, &block)
+      _section(self, :Heading, args, title: title, weight: 1, &block)
     end
 
     # Creates section with a H2 title.
@@ -20,7 +20,7 @@ module NattyUI
     # @yieldparam (see #h1)
     # @return (see #h1)
     def h2(title, *args, &block)
-      _section(:Heading, args, title: title, weight: 2, &block)
+      _section(self, :Heading, args, title: title, weight: 2, &block)
     end
 
     # Creates section with a H3 title.
@@ -29,7 +29,7 @@ module NattyUI
     # @yieldparam (see #h1)
     # @return (see #h1)
     def h3(title, *args, &block)
-      _section(:Heading, args, title: title, weight: 3, &block)
+      _section(self, :Heading, args, title: title, weight: 3, &block)
     end
 
     # Creates section with a H4 title.
@@ -38,7 +38,7 @@ module NattyUI
     # @yieldparam (see #h1)
     # @return (see #h1)
     def h4(title, *args, &block)
-      _section(:Heading, args, title: title, weight: 4, &block)
+      _section(self, :Heading, args, title: title, weight: 4, &block)
     end
 
     # Creates section with a H5 title.
@@ -47,7 +47,7 @@ module NattyUI
     # @yieldparam (see #h1)
     # @return (see #h1)
     def h5(title, *args, &block)
-      _section(:Heading, args, title: title, weight: 5, &block)
+      _section(self, :Heading, args, title: title, weight: 5, &block)
     end
   end
 

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

@@ -14,7 +14,7 @@ module NattyUI
     # @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)
-      _section(:Message, args, title: title, symbol: symbol, &block)
+      _section(self, :Message, args, title: title, symbol: symbol, &block)
     end
     alias msg message
 
@@ -26,7 +26,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def information(title, *args, &block)
-      _section(:Message, args, title: title, symbol: :information, &block)
+      _section(self, :Message, args, title: title, symbol: :information, &block)
     end
     alias info information
 
@@ -37,7 +37,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def warning(title, *args, &block)
-      _section(:Message, args, title: title, symbol: :warning, &block)
+      _section(self, :Message, args, title: title, symbol: :warning, &block)
     end
     alias warn warning
 
@@ -48,7 +48,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def error(title, *args, &block)
-      _section(:Message, args, title: title, symbol: :error, &block)
+      _section(self, :Message, args, title: title, symbol: :error, &block)
     end
     alias err error
 
@@ -61,7 +61,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def completed(title, *args, &block)
-      _section(:Message, args, title: title, symbol: :completed, &block)
+      _section(self, :Message, args, title: title, symbol: :completed, &block)
     end
     alias done completed
     alias ok completed
@@ -76,7 +76,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def failed(title, *args, &block)
-      _section(:Message, args, title: title, symbol: :failed, &block)
+      _section(self, :Message, args, title: title, symbol: :failed, &block)
     end
   end
 

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

@@ -14,7 +14,7 @@ module NattyUI
     # @param [##to_f] max_value maximum value of the progress
     # @return [Wrapper::Progress] the created progress element
     def progress(title, max_value: nil)
-      _section(:Progress, nil, title: title, max_value: max_value)
+      _section(self, :Progress, nil, title: title, max_value: max_value)
     end
   end
 

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

@@ -49,7 +49,7 @@ module NattyUI
         choices = grab(choices, kw_choices)
         return if choices.empty?
         wrapper.temporary do
-          __section(
+          _section(
             @parent,
             :Message,
             choices.map { |k, v| "#{k} #{v}" },

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

@@ -12,7 +12,7 @@ module NattyUI
     # @return [Object] the result of the code block
     # @return [Wrapper::Section] itself, when no code block is given
     def section(*args, &block)
-      _section(:Section, args, prefix: '  ', suffix: '  ', &block)
+      _section(self, :Section, args, prefix: '  ', suffix: '  ', &block)
     end
     alias sec section
 
@@ -23,7 +23,7 @@ module NattyUI
     # @yieldparam (see #section)
     # @return (see #section)
     def quote(*args, &block)
-      _section(:Section, args, prefix: '▍ ', prefix_attr: 39, &block)
+      _section(self, :Section, args, prefix: '▍ ', prefix_attr: 39, &block)
     end
   end
 
@@ -66,7 +66,7 @@ module NattyUI
       # @return [Section] itself
       def space(lines = 1)
         @parent.puts(
-          *Array.new([lines.to_i, 1].max),
+          "\n" * ([lines.to_i, 1].max - 1),
           prefix: @prefix,
           suffix: @suffix
         )
@@ -86,9 +86,7 @@ module NattyUI
       #
       # @yield [Section] itself
       # @return [Object] block result
-      def temporary
-        block_given? ? yield(self) : self
-      end
+      def temporary = block_given? ? yield(self) : self
 
       protected
 

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

@@ -15,7 +15,7 @@ module NattyUI
     # @return [Object] the result of the code block
     # @return [Wrapper::Task] itself, when no code block is given
     def task(title, *args, &block)
-      _section(:Task, args, title: title, &block)
+      _section(self, :Task, args, title: title, &block)
     end
   end
 
@@ -34,7 +34,7 @@ module NattyUI
         @status = :completed if @status == :closed
         @temp.call
       end
-      __section(
+      _section(
         @parent,
         :Message,
         @final_text,

data/lib/natty-ui/wrapper.rb

@@ -77,7 +77,7 @@ module NattyUI
     # @return [Wrapper] itself
     def space(lines = 1)
       lines = [lines.to_i, 1].max
-      @stream.puts(*Array.new(lines))
+      @stream << ("\n" * lines)
       @lines_written += lines
       @stream.flush
       self

data/lib/natty-ui.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'unicode/display_width'
+require 'reline'
 require_relative 'natty-ui/wrapper'
 require_relative 'natty-ui/ansi_wrapper'
 
@@ -71,7 +71,7 @@ module NattyUI
     # @return ]String] edited string
     def embellish(str)
       str = str.to_s
-      return '' if str.empty?
+      return +'' if str.empty?
       reset = false
       ret =
         str.gsub(/(\[\[((?~\]\]))\]\])/) do
@@ -111,10 +111,7 @@ module NattyUI
     # @return [Integer] the display size
     def display_width(str)
       str = str.to_s
-      return 0 if str.empty?
-      ret = Unicode::DisplayWidth.of(str, 1)
-      ret -= emoji_extra_width_of(str) if defined?(Unicode::Emoji)
-      [ret, 0].max
+      str.empty? ? 0 : Reline::Unicode.calculate_width(str)
     end
 
     private
@@ -125,17 +122,6 @@ module NattyUI
       stream.tty? ? AnsiWrapper : Wrapper
     end
 
-    def emoji_extra_width_of(string)
-      ret = 0
-      string.scan(Unicode::Emoji::REGEX) do |emoji|
-        ret += 2 * emoji.scan(EMOJI_MODIFIER_REGEX).size
-        emoji.scan(EMOKI_ZWJ_REGEX) do |zwj_succ|
-          ret += Unicode::DisplayWidth.of(zwj_succ, 1, {})
-        end
-      end
-      ret
-    end
-
     def stderr_is_stdout?
       STDOUT.tty? && STDERR.tty? && STDOUT.pos == STDERR.pos
     rescue IOError, SystemCallError
@@ -143,12 +129,6 @@ module NattyUI
     end
   end
 
-  if defined?(Unicode::Emoji)
-    EMOJI_MODIFIER_REGEX = /[#{Unicode::Emoji::EMOJI_MODIFIERS.pack('U*')}]/
-    EMOKI_ZWJ_REGEX = /(?<=#{[Unicode::Emoji::ZWJ].pack('U')})./
-    private_constant :EMOJI_MODIFIER_REGEX, :EMOKI_ZWJ_REGEX
-  end
-
   # Instance for standard output.
   StdOut = new(STDOUT)
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: unicode-display_width
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.5'
+date: 2023-11-10 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