natty-ui 0.33.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79e64cb2489dcf9efe4066e4f95252284f9227aafa4a77edd0d50f307b255cf2
-  data.tar.gz: 7ec6f014b300740062e816fa9c787ff79b3fb7ce68e4b1c2d6967ae6eb58b53d
+  metadata.gz: 0c61c16b1c5d1611a98f1505bb9eb86b71a0289021a9332f41e2095f7810b144
+  data.tar.gz: e8acc6fdf67bd259fd671defd80533f5de0fa9aa7b005cef9f092b7ebf097606
 SHA512:
-  metadata.gz: 86abb66230c52bd8863aec983435b434e7272003a12db631cb0b46af9db938ffc16f3ba1f987dad53a10f9ff4393e5f4bf403d04b813bb68b4b189c5bf0b2860
-  data.tar.gz: 34afc008cdec26384f7f20b7be6830a5be511147cfaef831d8e6869f858219ffeaea394ec8718ceb7513cfa3aaee19a852bb70d2b2ef641bc5880ca79d8de38d
+  metadata.gz: a38c19bc286fff4f5776fde2bb1a1de897ea3cdc8498c774691c449de6c2614b229f50a84d6eaf3a89c90af8a99500f6fc8e9237fea9dea7c8234370d4629399
+  data.tar.gz: 9d74ccf3a7202619718e8dd67e19cf53534996738c2e04522e3ba6b67aac51323167e7989577c9ace0c793e729130e984eeffb2eae9d98b8458e5f401249b7cc

data/README.md

@@ -63,3 +63,7 @@ After that you only need one line of code to have everything together
 ```ruby
 require 'natty-ui'
 ```
+
+## Dependencies
+
+It uses only the fantastic [Terminal.rb](https://rubygems.org/gems/terminal_rb) gem.

data/examples/info.rb

@@ -19,8 +19,8 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Terminal Information[/]' do
     table.add 'Identifier', Terminal.application || 'unidentified'
     table.add 'ANSI support', Terminal.ansi? ? 'yes' : 'no'
     table.add 'Input mode', Terminal.input_mode
-    table.add 'Colors', colors
     table.add 'Screen size', Terminal.size.join(' x ')
+    table.add 'Colors', colors
     table.columns[0].assign(width: 15, padding_right: 2, align: :right)
     table.columns[1].style = %i[bold bright_yellow]
   end

data/examples/key-codes.rb

@@ -2,29 +2,24 @@
 
 require_relative '../lib/natty-ui'
 
-event = nil
-while true
-  ui.temporary do
-    ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Keyboard Key Codes[/]' do
-      ui.puts(
-        "
-        #{
-          if event
-            "#{event.to_a.size < 2 ? ' Key' : 'Keys'}: [bold bright_green]#{
-              event.to_a.map { "[\\#{_1}]" }.join(' ')
-            }[/]
-            Code: [bright_blue]#{event.raw.inspect}[/]"
-          else
-            "Your terminal uses [bright_blue]#{
-              Terminal.input_mode
-            }[/] mode. Press a key!"
-          end
-        }
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Keyboard Key Codes[/]' do
+  ui.space
+  ui.puts(
+    "Your terminal uses [bright_blue]#{Terminal.input_mode}[/] mode. Press a key!",
+    '[dim](Exit with ESC)'
+  )
 
-        [faint](Exit with ESC)"
-      )
-    end
-    event = Terminal.read_key_event
-    exit if event.nil? || event.name == 'Esc'
+  ui.space
+  # if you like to have mouse position changes reported then use
+  # 'mouse_move: true' in next line
+  Terminal.on_key_event(mouse: true, focus: true, mouse_move: false) do |event|
+    ui.puts(
+      "#{event.raw.inspect} [dim]→[/dim] [bold bright_green]#{
+        event.to_a.map { "[\\#{_1}]" }.join('+')
+      }#{" @ #{event.position.join(', ')}" if event.position}"
+    )
+    event.name != 'Esc'
   end
+
+  ui.space
 end

data/lib/natty-ui/choice.rb

@@ -9,12 +9,12 @@ module NattyUI
       pin_line = NattyUI.lines_written
       draw
       last = @current
-      while (event = Terminal.read_key_event)
+      Terminal.on_key_event do |event|
         case event.name
         when 'Esc', 'Ctrl+c'
-          break nil if @abortable
+          return if @abortable
         when 'Enter', 'Space'
-          break @ret[@current]
+          return @ret[@current]
         when 'Home'
           @current = 0
         when 'End'
@@ -24,11 +24,11 @@ module NattyUI
         when 'Down', 'Tab', 'k', 's'
           @current = 0 if (@current += 1) == @texts.size
         else
-          next unless event.simple?
+          next true unless event.simple?
           c = event.key.ord
           @current = (c - 48).clamp(0, @texts.size - 1) if c.between?(48, 57)
         end
-        next if last == @current
+        next true if last == @current
         pin_line = NattyUI.back_to_line(pin_line, erase: false)
         draw
         last = @current

data/lib/natty-ui/dumb_choice.rb

@@ -7,15 +7,15 @@ module NattyUI
     def select
       yield(self) if block_given?
       draw
-      while (event = Terminal.read_key_event)
+      Terminal.on_key_event do |event|
         return if @abortable && %w[Esc Ctrl+c].include?(event.name)
-        next unless event.simple?
+        next true unless event.simple?
         code = event.raw.upcase
         if @ret.size <= 9
-          next unless ('1'..'9').include?(code)
-          code = @ret[code.ord - 49] and break code
+          next true unless ('1'..'9').include?(code)
+          code = @ret[code.ord - 49] and return code
         elsif ('A'..'Z').include?(code)
-          code = @ret[code.ord - 65] and break code
+          code = @ret[code.ord - 65] and return code
         end
       end
     end

data/lib/natty-ui/dumb_options.rb

@@ -7,20 +7,20 @@ module NattyUI
     def select
       yield(self) if block_given?
       draw
-      while (event = Terminal.read_key_event)
+      Terminal.on_key_event do |event|
         return if @abortable && %w[Esc Ctrl+c].include?(event.name)
         return @opts.transform_values(&:last) if event.name == 'Enter'
-        next unless event.simple?
+        next true unless event.simple?
         code = event.raw.upcase
         if @opts.size <= 9
-          next unless ('1'..'9').include?(code)
+          next true unless ('1'..'9').include?(code)
           offset = 49
         elsif ('A'..'Z').include?(code)
           offset = 65
         else
-          next
+          next true
         end
-        key = @opts.keys[code.ord - offset] or next
+        key = @opts.keys[code.ord - offset] or next true
         @opts[key][-1] = !@opts[key][-1]
         @parent.space
         draw

data/lib/natty-ui/features.rb

@@ -45,7 +45,7 @@ module NattyUI
         ignore_newline = options[:eol] == false || options[:ignore_newline]
 
         if (max_width = options[:max_width]).nil?
-          return self if (max_width = Terminal.columns).zero?
+          max_width = Terminal.columns
         elsif max_width < 1
           if max_width > 0
             max_width *= Terminal.columns
@@ -56,6 +56,8 @@ module NattyUI
           end
         end
 
+        return self if max_width <= 0
+
         prefix_width =
           if (prefix = options[:prefix])
             prefix = Ansi.bbcode(prefix) if bbcode
@@ -117,8 +119,7 @@ module NattyUI
       end
 
       unless options[:expand]
-        lines = lines.to_a
-        max_width = lines.max_by(&:last).last
+        max_width = (lines = lines.to_a).max_by(&:last)[-1]
       end
 
       case align
@@ -1000,13 +1001,15 @@ module NattyUI
     end
 
     def __await(yes, no)
-      while (event = Terminal.read_key_event&.name)
+      Terminal.on_key_event do |event|
+        event = event.name
         if (no == event) || (no.is_a?(Enumerable) && no.include?(event))
           return false
         end
         if (yes == event) || (yes.is_a?(Enumerable) && yes.include?(event))
           return true
         end
+        true
       end
     end
   end

data/lib/natty-ui/options.rb

@@ -9,7 +9,7 @@ module NattyUI
       pin_line = NattyUI.lines_written
       draw
       last = @current
-      while (event = Terminal.read_key_event)
+      Terminal.on_key_event do |event|
         case event.name
         when 'Esc', 'Ctrl+c'
           return if @abortable
@@ -34,7 +34,7 @@ module NattyUI
           keys = @opts.keys
           @current = keys[keys.index(@current) + 1] || keys[0]
         end
-        next if last == @current
+        next true if last == @current
         pin_line = NattyUI.back_to_line(pin_line, erase: false)
         draw
         last = @current

data/lib/natty-ui/progress.rb

@@ -82,7 +82,6 @@ module NattyUI
 
     def _done(text)
       NattyUI.back_to_line(@pin_line)
-      @pin_line = nil
       cm = Theme.current.mark(:checkmark)
       @parent.puts(
         *text,
@@ -94,7 +93,6 @@ module NattyUI
 
     def _failed
       NattyUI.back_to_line(NattyUI.lines_written - 1) if @last&.size == 2
-      @pin_line = nil
     end
 
     def initialize(parent, title, max, pin)
@@ -106,8 +104,8 @@ module NattyUI
       @style = Theme.current.task_style
       cm = Theme.current.mark(:current)
       @redraw_opts = {
-        first_line_prefix: "#{cm} #{@style}",
-        first_line_prefix_width: cm.width + 1
+        first_line_prefix: "#{cm}#{@style}",
+        first_line_prefix_width: cm.width
       }
       max ? self.max = max : redraw
     end
@@ -130,7 +128,6 @@ module NattyUI
       size = [@parent.columns, 72].min - 11
       percent = format('%5.2f', 100.0 * diff)
       return percent if size < 10
-      return if percent == '100.00'
       fill = '█' * (size * diff)
       "#{percent}% [bright_black]┃#{@style}#{fill}[bright_black]#{
         '░' * (size - fill.size)

data/lib/natty-ui/shell_renderer.rb

@@ -5,7 +5,7 @@ require_relative 'theme'
 module NattyUI
   module ShellRenderer
     def self.sh(parent, cmd, options, space)
-      opts_out, opts_err = opts_fom(Theme.current)
+      opts_out, opts_err = opts_from(Theme.current)
       Terminal.sh(*cmd, **options) do |line, kind|
         parent.puts(
           space ? line.gsub("\t", '    ').gsub(/[[:space:]]/, ' ') : line,
@@ -15,7 +15,7 @@ module NattyUI
     end
 
     if Terminal.ansi?
-      def self.opts_fom(theme)
+      def self.opts_from(theme)
         out = theme.mark(:sh_out)
         err = theme.mark(:sh_err)
         [
@@ -56,7 +56,7 @@ module NattyUI
         ]
       end
     else
-      def self.opts_fom(theme)
+      def self.opts_from(theme)
         out = theme.mark(:sh_out)
         err = theme.mark(:sh_err)
         [

data/lib/natty-ui/theme.rb

@@ -163,6 +163,8 @@ module NattyUI
           current: '➔',
           choice: '◦',
           current_choice: '◉',
+          option: '[ ]',
+          option_selected: '[X]',
           sh_out: ':',
           sh_err: '𝙓'
         }
@@ -243,8 +245,8 @@ module NattyUI
       # [current?][selected?]
       c = @mark[:current_choice]
       n = @mark[:none]
-      sel = @mark[:checkmark]
-      uns = @mark[:choice]
+      uns = @mark[:option]
+      sel = @mark[:option_selected]
       {
         false => { false => n + uns, true => n + sel }.compare_by_identity,
         true => { false => c + uns, true => c + sel }.compare_by_identity
@@ -348,6 +350,8 @@ module NattyUI
         current: '[bright_green]➔[/fg]',
         choice: '[bright_white]◦[/fg]',
         current_choice: '[bright_green]➔[/fg]',
+        option: '[dim][ ][/dim]',
+        option_selected: '[dim][[/dim][green]X[/fg][dim]][/dim]',
         sh_out: '[bright_white]:[/fg]',
         sh_err: '[red]𝙓[/fg]'
       )
@@ -379,6 +383,8 @@ module NattyUI
         current: '➡️',
         choice: '[bright_white]•[/fg]',
         current_choice: '[bright_green]●[/fg]',
+        option: '[dim][ ][/dim] ',
+        option_selected: '[dim][[/dim][green]X[/fg][dim]][/dim]',
         sh_out: '[white b]:[/]',
         sh_err: '❗️'
       )

data/lib/natty-ui/version.rb

@@ -2,5 +2,5 @@
 
 module NattyUI
   # The version number of the gem.
-  VERSION = '0.33.0'
+  VERSION = '0.34.0'
 end

data/lib/natty-ui.rb

@@ -50,7 +50,7 @@ module NattyUI
     #   configured title
     # @return [nil]
     #   when no title was set
-    def title = @title_stack.last
+    def title = @title_stack[-1]
 
     # @attribute [w] title
     def title=(value)
@@ -85,17 +85,6 @@ module NattyUI
       @lines_written = number
     end
 
-    # @private
-    def alternate_screen
-      return yield unless Terminal.ansi?
-      begin
-        Terminal.raw_write(Ansi::SCREEN_ALTERNATE)
-        yield
-      ensure
-        Terminal.raw_write(Ansi::SCREEN_ALTERNATE_OFF)
-      end
-    end
-
     private
 
     def with(element)
@@ -111,6 +100,8 @@ module NattyUI
   @element = self
   @lines_written = 0
   @title_stack = []
+
+  autoload :VERSION, "#{__dir__}/natty-ui/version.rb"
 end
 
 unless defined?(Kernel.ui)

data/natty-ui.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/natty-ui/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'natty-ui'
+  spec.version = NattyUI::VERSION
+  spec.summary = <<~SUMMARY.tr("\n", ' ')
+    This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich,
+    lovely, natty user interface you like to have for your CLI.
+  SUMMARY
+  spec.description = <<~DESCRIPTION.tr("\n", ' ')
+    This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
+    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.
+  DESCRIPTION
+
+  spec.author = 'Mike Blumtritt'
+  spec.licenses = %w[MIT Ruby]
+  spec.homepage = 'https://codeberg.org/mblumtritt/natty-ui'
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/natty-ui'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['yard.run'] = 'yard'
+
+  spec.required_ruby_version = '>= 3.0'
+  spec.add_dependency 'terminal_rb', '>= 0.17.0'
+
+  spec.files = Dir['lib/**/*.rb'] + Dir['examples/*.rb']
+  spec.files << 'natty-ui.gemspec' << '.yardopts'
+  spec.extra_rdoc_files = %w[README.md]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -15,27 +15,24 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
-description: |
-  This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
-  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.
+        version: 0.17.0
+description: 'This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich,
+  lovely, 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. '
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE
 - README.md
 files:
 - ".yardopts"
-- LICENSE
 - README.md
 - examples/24bit-colors.rb
 - examples/3bit-colors.rb
@@ -81,9 +78,11 @@ files:
 - lib/natty-ui/version.rb
 - lib/natty-ui/width_finder.rb
 - lib/natty_ui.rb
+- natty-ui.gemspec
 homepage: https://codeberg.org/mblumtritt/natty-ui
 licenses:
-- BSD-3-Clause
+- MIT
+- Ruby
 metadata:
   source_code_uri: https://codeberg.org/mblumtritt/natty-ui
   bug_tracker_uri: https://codeberg.org/mblumtritt/natty-ui/issues
@@ -104,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
   natty user interface you like to have for your CLI.

data/LICENSE

@@ -1,28 +0,0 @@
-BSD 3-Clause License
-
-Copyright (c) 2017-2025, Mike Blumtritt. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.