natty-ui 0.9.4 → 0.11.0

data/lib/natty-ui/wrapper.rb

@@ -47,24 +47,29 @@ module NattyUI
 
     # Print given arguments line-wise to the output stream.
     #
-    # @overload puts(...)
-    #   @param [#to_s] ... objects to print
-    #   @return [Wrapper] itself
-    def puts(*args, **kwargs)
-      @stream.puts(args = prepare_print(args, kwargs))
-      @lines_written += args.size
+    # @param [#to_s] args objects to print
+    # @option options [:left, :right, :center] :align text alignment
+    # @return [Wrapper] itself
+    def puts(*args, **options)
+      pprint(args, options) do |line|
+        @stream.puts(line)
+        @lines_written += 1
+      end
       @stream.flush
       self
     end
 
     # Print given arguments to the output stream.
     #
-    # @overload print(...)
-    #   @param [#to_s] ... objects to print
-    #   @return [Wrapper] itself
-    def print(*args, **kwargs)
-      @stream.print(*(args = prepare_print(args, kwargs)))
-      @lines_written += args.size - 1
+    # @param [#to_s] args objects to print
+    # @option options [:left, :right, :center] :align text alignment
+    # @return [Wrapper] itself
+    def print(*args, **options)
+      pprint(args, options) do |line|
+        @stream.print(line)
+        @lines_written += 1
+      end
+      @lines_written -= 1
       @stream.flush
       self
     end
@@ -152,21 +157,36 @@ module NattyUI
     # @!visibility private
     def prefix = nil
 
-    # @return [Array<Symbol>] available glyph names
-    def glyph_names = GLYPHS.keys
-
-    #
-    # Get a pre-defined glyph
-    #
-    # @param [Symbol] name glyph name
-    # @return [String] the named glyph
-    # @return [nil] when glyph is not defined
-    def glyph(name) = GLYPHS[name]
-
     protected
 
-    def prepare_print(args, kwargs)
-      Text.prepare_print(args, kwargs, -> { screen_columns }) { Text.plain(_1) }
+    def pprint(strs, opts)
+      prefix = opts[:prefix] and prefix = Text.plain(prefix)
+      suffix = opts[:suffix] and suffix = Text.plain(suffix)
+      return yield("#{prefix}#{suffix}") if strs.empty?
+      max_width =
+        opts.fetch(:max_width) do
+          screen_columns - (opts[:prefix_width] || Text.width(prefix)) -
+            (opts[:suffix_width] || Text.width(suffix))
+        end
+      case opts[:align]
+      when :right
+        Text.each_line_plain(strs, max_width) do |line, width|
+          width = max_width - width
+          yield("#{prefix}#{' ' * width}#{line}#{suffix}")
+        end
+      when :center
+        Text.each_line_plain(strs, max_width) do |line, width|
+          width = max_width - width
+          right = width / 2
+          yield(
+            "#{prefix}#{' ' * (width - right)}#{line}#{' ' * right}#{suffix}"
+          )
+        end
+      else
+        Text.each_line_plain(strs, max_width) do |line|
+          yield("#{prefix}#{line}#{suffix}")
+        end
+      end
     end
 
     def temp_func
@@ -206,28 +226,5 @@ module NattyUI
     rescue SystemCallError
       nil
     end
-
-    GLYPHS = {
-      default: "#{Ansi[:bold, 255]}•#{Ansi::RESET}",
-      information: "#{Ansi[:bold, 119]}𝒊#{Ansi::RESET}",
-      warning: "#{Ansi[:bold, 221]}!#{Ansi::RESET}",
-      error: "#{Ansi[:bold, 208]}𝙓#{Ansi::RESET}",
-      completed: "#{Ansi[:bold, 82]}✓#{Ansi::RESET}",
-      failed: "#{Ansi[:bold, 196]}𝑭#{Ansi::RESET}",
-      task: "#{Ansi[:bold, 39]}➔#{Ansi::RESET}",
-      query: "#{Ansi[:bold, 39]}▸#{Ansi::RESET}"
-    }.compare_by_identity.freeze
-
-    # GLYPHS = {
-    #   default: '●',
-    #   information: '🅸 ',
-    #   warning: '🆆 ',
-    #   error: '🅴 ',
-    #   completed: '✓',
-    #   failed: '🅵 ',
-    #   task: '➔',
-    #   query: '🆀 '
-    # }.compare_by_identity.freeze
-    private_constant :GLYPHS
   end
 end

data/lib/natty-ui.rb

@@ -135,6 +135,34 @@ module NattyUI
       nil
     end
 
+    # @return [Array<Symbol>] available glyph names
+    def glyph_names = GLYPH.keys
+
+    # Get a pre-defined glyph.
+    #
+    # @param [Symbol] name glyph name
+    # @return [String] the glyph
+    # @return [nil] when glyph is not defined
+    def glyph(name) = GLYPH[name]
+
+    # @return [Array<Symbol>] available frame names
+    def frame_names = FRAME.keys
+
+    # Get a frame definition.
+    #
+    # @param [Symbol] name frame type name
+    # @return [String] the frame definition
+    # @raise [ArgumentError] when an invalid name is specified
+    def frame(name)
+      if name.is_a?(Symbol)
+        ret = FRAME[name] and return ret
+      elsif name.is_a?(String)
+        return name if name.size == 11
+        return name * 11 if name.size == 1
+      end
+      raise(ArgumentError, "invalid frame type - #{name.inspect}")
+    end
+
     private
 
     def wrapper_class(stream, ansi)
@@ -159,10 +187,45 @@ module NattyUI
   StdErr = stderr_is_stdout? ? StdOut : new(STDERR)
 
   dir = __dir__
-  autoload(:LineAnimation, File.join(dir, 'natty-ui', 'line_animation'))
+  autoload(:Animation, File.join(dir, 'natty-ui', 'animation'))
   autoload(:KEY_MAP, File.join(dir, 'natty-ui', 'key_map'))
 
-  private_constant :LineAnimation, :KEY_MAP
+  GLYPH = {
+    default: "#{Ansi[:bold, 255]}•#{Ansi::RESET}",
+    point: "#{Ansi[0x27]}◉#{Ansi::RESET}",
+    information: "#{Ansi[:bold, 119]}𝒊#{Ansi::RESET}",
+    warning: "#{Ansi[:bold, 221]}!#{Ansi::RESET}",
+    error: "#{Ansi[:bold, 208]}𝙓#{Ansi::RESET}",
+    completed: "#{Ansi[:bold, 82]}✓#{Ansi::RESET}",
+    failed: "#{Ansi[:bold, 196]}𝑭#{Ansi::RESET}",
+    task: "#{Ansi[:bold, 39]}➔#{Ansi::RESET}",
+    query: "#{Ansi[:bold, 39]}▸#{Ansi::RESET}"
+  }.compare_by_identity.freeze
+
+  # GLYPH = {
+  #   default: '●',
+  #   information: '🅸 ',
+  #   warning: '🆆 ',
+  #   error: '🅴 ',
+  #   completed: '✓',
+  #   failed: '🅵 ',
+  #   task: '➔',
+  #   query: '🆀 '
+  # }.compare_by_identity.freeze
+
+  FRAME = {
+    rounded: '╭╮╰╯│─┼┬┴├┤',
+    simple: '┌┐└┘│─┼┬┴├┤',
+    heavy: '┏┓┗┛┃━╋┳┻┣┫',
+    double: '╔╗╚╝║═╬╦╩╠╣',
+    semi: '╒╕╘╛│═╪╤╧╞╡',
+    semi2: '╓╖╙╜│─╫╥╨╟╢',
+    rows: '     ──    ',
+    cols: '    │ │    ',
+    undecorated: '           '
+  }.compare_by_identity.freeze
+
+  private_constant :Animation, :KEY_MAP, :GLYPH, :FRAME
 
   @element = StdOut
   self.in_stream = STDIN

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.11.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-13 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies: []
 description: |
   This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely,
@@ -30,6 +30,7 @@ files:
 - examples/8bit-colors.rb
 - examples/animate.rb
 - examples/attributes.rb
+- examples/attributes_list.rb
 - examples/demo.rb
 - examples/illustration.rb
 - examples/ls.rb
@@ -39,15 +40,16 @@ files:
 - examples/read_key.rb
 - examples/table.rb
 - lib/natty-ui.rb
+- lib/natty-ui/animation.rb
+- lib/natty-ui/animation/binary.rb
+- lib/natty-ui/animation/default.rb
+- lib/natty-ui/animation/matrix.rb
+- lib/natty-ui/animation/rainbow.rb
+- lib/natty-ui/animation/type_writer.rb
 - lib/natty-ui/ansi.rb
 - lib/natty-ui/ansi/constants.rb
 - lib/natty-ui/ansi_wrapper.rb
 - lib/natty-ui/key_map.rb
-- lib/natty-ui/line_animation.rb
-- lib/natty-ui/line_animation/default.rb
-- lib/natty-ui/line_animation/matrix.rb
-- lib/natty-ui/line_animation/rainbow.rb
-- lib/natty-ui/line_animation/type_writer.rb
 - lib/natty-ui/preload.rb
 - lib/natty-ui/text.rb
 - lib/natty-ui/text/east_asian_width.rb
@@ -94,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely, natty

data/lib/natty-ui/line_animation/default.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module NattyUI
-  module LineAnimation
-    class Default < None
-      def initialize(*_)
-        super
-        @column = @options[:prefix_width] + 1
-        @color = color
-        @num = 0
-      end
-
-      def print(line)
-        line = Text.plain(line)
-        time = 0.5 / line.size
-        @stream << @color
-        if (@num += 1).odd?
-          line.each_char do |char|
-            (@stream << char).flush
-            sleep(time)
-          end
-        else
-          pos = @column + line.size
-          line.reverse!
-          line.each_char do |char|
-            (@stream << Ansi.cursor_column(pos -= 1) << char).flush
-            sleep(time)
-          end
-        end
-      end
-    end
-
-    define default: Default
-  end
-end

data/lib/natty-ui/line_animation/matrix.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module NattyUI
-  module LineAnimation
-    class Matrix < None
-      def initialize(*_)
-        super
-        @prefix = "#{to_column}#{color}"
-      end
-
-      def print(line)
-        line = Text.plain(line)
-        str = Array.new(line.size) { CHARS.sample }.join
-        pos = Array.new(line.size, &:itself).shuffle
-        until pos.size < 4
-          pos.shift(pos.size / 4).each { str[_1] = line[_1] }
-          pos.sample(pos.size / 2).each { str[_1] = CHARS.sample }
-          (@stream << "#{@prefix}#{str}").flush
-          sleep(0.08)
-        end
-      end
-
-      CHARS = '2598Z*):.\=+-¦|_ｦｱｳｴｵｶｷｹｺｻｼｽｾｿﾀﾂﾃﾅﾆﾇﾈﾊﾋﾎﾏﾐﾑﾒﾓﾔﾕﾗﾘﾜ'.chars
-    end
-
-    define matrix: Matrix
-  end
-end

data/lib/natty-ui/line_animation/rainbow.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module NattyUI
-  module LineAnimation
-    class Rainbow < None
-      def initialize(*_)
-        super
-        @prefix = to_column
-      end
-
-      def print(line)
-        line = Text.plain(line)
-        11.upto(200) do |spread|
-          (
-            @stream << @prefix <<
-              Ansi.rainbow(
-                line,
-                frequence: 0.1,
-                spread: spread / 100.0,
-                seed: 0
-              )
-          ).flush
-          sleep(0.01)
-        end
-      end
-    end
-
-    define rainbow: Rainbow
-  end
-end

data/lib/natty-ui/line_animation/type_writer.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module NattyUI
-  module LineAnimation
-    class TypeWriter < None
-      def initialize(*_)
-        super
-        @color = color
-        @cursor_color = attribute(:cursor_color, 0x2e)
-        @column = @options[:prefix_width] + 1
-        @num = 0
-      end
-
-      def print(line)
-        line = Text.plain(line)
-        if (@num += 1).odd?
-          line.each_char { (@stream << cursor(_1)).flush }
-        else
-          pos = @column + line.size
-          line.reverse!
-          line.each_char do |char|
-            @stream << Ansi.cursor_column(pos -= 1)
-            (@stream << cursor(char)).flush
-          end
-        end
-      end
-
-      def cursor(char)
-        @stream << @cursor_color
-        (SPACE.match?(char) ? '▁' : '▁▂▃▄▅▆▇█').each_char do |cursor|
-          (@stream << cursor).flush
-          sleep(0.002)
-          @stream << CURSOR_BACK
-        end
-        @stream << @color
-        char
-      end
-
-      CURSOR_BACK = Ansi.cursor_back(1)
-    end
-
-    define type_writer: TypeWriter
-  end
-end

data/lib/natty-ui/line_animation.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module NattyUI
-  module LineAnimation
-    def self.defined = @defined.keys
-    def self.defined?(name) = @defined.key?(name)
-    def self.define(**kwargs) = @defined.merge!(kwargs)
-
-    def self.[](name)
-      return if name.nil?
-      klass = @defined[name] || @defined[:default]
-      return klass unless klass.is_a?(String)
-      require(klass)
-      klass = @defined[name] and return klass
-      raise(LoadError, "unknown animation - #{name}")
-    end
-
-    class None
-      def initialize(stream, options)
-        @stream = stream
-        @options = options
-      end
-
-      def print(_line) = raise(NotImplementedError)
-
-      protected
-
-      def to_column = Ansi.cursor_column(@options[:prefix_width] + 1)
-      def color = attribute(:color, :default)
-
-      def attribute(name, *default)
-        att = @options[name] or return Ansi[*default]
-        return Ansi[*att] if att.is_a?(Enumerable)
-        Ansi.try_convert(att.to_s) || Ansi[*default]
-      end
-
-      SPACE = /[[:space:]]/
-    end
-
-    dir = __dir__
-    @defined = {
-      default: "#{dir}/line_animation/default",
-      matrix: "#{dir}/line_animation/matrix",
-      rainbow: "#{dir}/line_animation/rainbow",
-      type_writer: "#{dir}/line_animation/type_writer"
-    }.compare_by_identity
-  end
-end