natty-ui 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa4b9f0f1b20297ceb096bcdc684ddc419fce1e2f4e9cbe415320f240ae4860a
-  data.tar.gz: 91de55924ad0098435405f6d1c17bf88efe0310ad9688f6ac1d4485a5c91b5bb
+  metadata.gz: e92abc0c7952b3470af1cee08261712ecf8468b05944dd3967c46ee95c040806
+  data.tar.gz: a1b277e69f56f58c5dc1668565cc4cf763f17c5242d42d1f79b4590c432cb8da
 SHA512:
-  metadata.gz: 651f40f3944c45389331a3f99f987d3cf5b774bd3f0132c94004d169406c6500d12dff9c102f652dd4f47a016b04717a90a42d239fcb2a747f2b5109f002f29c
-  data.tar.gz: c29b0ac2c9959f6151c7801534f7c1bde4c6f9f42d1f13499f362752557e184f5a1a24561fd2c12b8be133a9478b9570d99c4a34b9d6c53a0f0815d58295434c
+  metadata.gz: 47aa3f7076379258e10a78592ca2375146c15850f234f2f69085ef41e88a168855bcd8e19fa1d21c09aad0917e872d3fd2d1941b2dc10bb0e74aa17e47ee1608
+  data.tar.gz: 79e91c8b88e746064393df5b1d46f355184983ce9ff821f786a9452c99f5b5c40d2980226ff055e6fe8a51e18d18617a78a35535d514cf8d7cd1234dca098ce1

data/README.md

@@ -13,7 +13,7 @@ Here you find elegant, simple and beautiful tools that enhance your command line
 You can simply decorate your text with named ANSI attributes and colors
 
 ```ruby
-ui.puts "[[bold]]Hello [[ff7bfd]]World[[/]]!"
+ui.puts '[[bold underline]]Hello [[ff7bfd]]World[[/]]!'
 ```
 
 or use different types of messages

data/lib/natty-ui/ansi_wrapper.rb

@@ -26,7 +26,7 @@ module NattyUI
       mw = kwargs[:max_width]
       unless mw
         mw = screen_columns - prefix_width
-        mw -= kwargs[:suffix_width] || Text.(suffix) if suffix
+        mw -= kwargs[:suffix_width] || Text.width(suffix) if suffix
       end
       kwargs[:max_width] = mw
 
@@ -34,10 +34,7 @@ module NattyUI
       animation = LineAnimation[animation].new(@stream, kwargs)
       prefix = "#{Ansi::RESET}#{Ansi::CLL}#{prefix}"
 
-      Text.each_line(
-        args.map! { Text.embellish(Ansi.blemish(_1)) },
-        mw
-      ) do |line|
+      Text.each_embellished_line(args.map! { Ansi.blemish(_1) }, mw) do |line|
         @stream << prefix
         animation.print(line)
         (@stream << "#{prefix}#{line}#{suffix}\n").flush
@@ -68,10 +65,17 @@ module NattyUI
 
     protected
 
-    def prepare_print(args, kwargs)
-      Text.prepare_print(args, kwargs, -> { screen_columns }) do |str|
-        Text.embellish(str)
-      end
+    def pprint(args, kwargs)
+      prefix = kwargs[:prefix] and prefix = Text.embellish(prefix)
+      suffix = kwargs[:suffix] and suffix = Text.embellish(suffix)
+      return yield("#{prefix}#{suffix}") if args.empty?
+      Text.each_embellished_line(
+        args,
+        kwargs.fetch(:max_width) do
+          screen_columns - kwargs.fetch(:prefix_width) { Text.width(prefix) } -
+            kwargs.fetch(:suffix_width) { Text.width(suffix) }
+        end
+      ) { yield("#{prefix}#{_1}#{suffix}") }
     end
 
     def temp_func
@@ -158,12 +162,12 @@ module NattyUI
     class Framed < Framed
       def color(str) = "#{Ansi[39]}#{str}#{Ansi::RESET}"
 
-      def init(deco)
-        @prefix = "#{color(deco[0])} "
-        @suffix = "#{Ansi.cursor_column(parent.rcol)}#{color(deco[4])}"
+      def init(type)
+        @prefix = "#{color(type[0])} "
+        @suffix = "#{Ansi.cursor_column(parent.rcol)}#{color(type[4])}"
         aw = @parent.available_width - 2
-        parent.puts(color("#{deco[1]}#{deco[2] * aw}#{deco[3]}"))
-        @finish = color("#{deco[5]}#{deco[6] * aw}#{deco[7]}")
+        parent.puts(color("#{type[1]}#{type[2] * aw}#{type[3]}"))
+        @finish = color("#{type[5]}#{type[6] * aw}#{type[7]}")
       end
     end
 
@@ -171,9 +175,8 @@ module NattyUI
       protected
 
       def initialize(parent, title:, glyph:)
-        wrapper = parent.wrapper
         color = COLORS[glyph] || COLORS[:default]
-        glyph = wrapper.glyph(glyph) || glyph
+        glyph = NattyUI.glyph(glyph) || glyph
         prefix_width = Text.width(glyph) + 1
         parent.puts(
           title,

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

@@ -31,5 +31,6 @@ module NattyUI
     end
 
     define default: Default
+    private_constant :Default
   end
 end

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

@@ -24,5 +24,6 @@ module NattyUI
     end
 
     define matrix: Matrix
+    private_constant :Matrix
   end
 end

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

@@ -26,5 +26,6 @@ module NattyUI
     end
 
     define rainbow: Rainbow
+    private_constant :Rainbow
   end
 end

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

@@ -40,5 +40,6 @@ module NattyUI
     end
 
     define type_writer: TypeWriter
+    private_constant :TypeWriter
   end
 end

data/lib/natty-ui/line_animation.rb

@@ -36,6 +36,7 @@ module NattyUI
 
       SPACE = /[[:space:]]/
     end
+    private_constant :None
 
     dir = __dir__
     @defined = {

data/lib/natty-ui/text.rb

@@ -68,99 +68,115 @@ module NattyUI
         nil
       end
 
-      def each_line(strs, max_width)
+      def each_plain_line(strs, max_width)
         return if (max_width = max_width.to_i) <= 0
         strs.each do |str|
-          str
-            .to_s
-            .each_line(chomp: true) do |line|
-              next yield(line) if line.empty?
-              current = String.new(encoding: line.encoding)
-              seq = current.dup
-              width = 0
-              in_zero_width = false
-              line = line.encode(UTF_8) if line.encoding != UTF_8
-              line.scan(WIDTH_SCANNER) do |np_start, np_end, csi, osc, gc|
-                next in_zero_width = (current << "\1") if np_start
-                next in_zero_width = !(current << "\2") if np_end
-                next (current << osc) && (seq << osc) if osc
-                if csi
-                  current << csi
-                  next if in_zero_width
-                  next seq.clear if csi == "\e[m" || csi == "\e[0m"
-                  next seq << csi
-                end
-                next current << gc if in_zero_width
-                cw = char_width(gc)
-                if (width += cw) > max_width
-                  yield(current)
-                  width = cw
-                  current = seq.dup
-                end
-                current << gc
+          plain_but_ansi(str).each_line(chomp: true) do |line|
+            next yield(line, 0) if line.empty?
+            empty = String.new(encoding: line.encoding)
+            current = empty.dup
+            width = 0
+            in_zero_width = false
+            line = line.encode(UTF_8) if line.encoding != UTF_8
+            line.scan(WIDTH_SCANNER) do |np_start, np_end, csi, osc, gc|
+              next in_zero_width = (current << "\1") if np_start
+              next in_zero_width = !(current << "\2") if np_end
+              next if osc || csi
+              next current << gc if in_zero_width
+              cw = char_width(gc)
+              if (width += cw) > max_width
+                yield(current, width - cw)
+                width = cw
+                current = empty.dup
               end
-              yield(current)
+              current << gc
             end
+            yield(current, width)
+          end
         end
         nil
       end
 
-      def each_line_with_size(strs, max_width)
+      def first_plain_line(str, max_width)
         return if (max_width = max_width.to_i) <= 0
-        strs.each do |str|
-          str
-            .to_s
-            .each_line(chomp: true) do |line|
-              next yield(line, 0) if line.empty?
-              current = String.new(encoding: line.encoding)
-              seq = current.dup
-              width = 0
-              in_zero_width = false
-              line = line.encode(UTF_8) if line.encoding != UTF_8
-              line.scan(WIDTH_SCANNER) do |np_start, np_end, csi, osc, gc|
-                next in_zero_width = (current << "\1") if np_start
-                next in_zero_width = !(current << "\2") if np_end
-                next (current << osc) && (seq << osc) if osc
-                if csi
-                  current << csi
-                  next if in_zero_width
-                  next seq.clear if csi == "\e[m" || csi == "\e[0m"
-                  next seq << csi
-                end
-                next current << gc if in_zero_width
-                cw = char_width(gc)
-                if (width += cw) > max_width
-                  yield(current, width - cw)
-                  width = cw
-                  current = seq.dup
-                end
-                current << gc
-              end
-              yield(current, width)
-            end
+        plain_but_ansi(str).each_line(chomp: true) do |line|
+          return line, 0 if line.empty?
+          current = String.new(encoding: line.encoding)
+          width = 0
+          in_zero_width = false
+          line = line.encode(UTF_8) if line.encoding != UTF_8
+          line.scan(WIDTH_SCANNER) do |np_start, np_end, csi, osc, gc|
+            next in_zero_width = (current << "\1") if np_start
+            next in_zero_width = !(current << "\2") if np_end
+            next if osc || csi
+            next current << gc if in_zero_width
+            cw = char_width(gc)
+            return current, width - cw if (width += cw) > max_width
+            current << gc
+          end
+          return current, width
         end
-        nil
+        [+'', 0]
       end
 
-      def as_lines(strs, max_width)
+      def as_plain_lines(strs, width, height)
         ret = []
-        each_line(strs, max_width) { ret << _1 }
+        each_plain_line(strs, width) do |*info|
+          ret << info
+          break if ret.size == height
+        end
         ret
       end
 
-      def prepare_print(args, kwargs, screen_columns, &cvt)
-        prefix = kwargs[:prefix] and prefix = prefix.empty? ? '' : cvt[prefix]
-        suffix = kwargs[:suffix] and suffix = suffix.empty? ? '' : cvt[suffix]
-        return ["#{prefix}#{suffix}"] if args.empty?
+      def each_embellished_line(strs, max_width)
+        return if (max_width = max_width.to_i) <= 0
+        simple_each_line(strs) do |line|
+          line = embellish(line)
+          next yield(line, 0) if line.empty?
+          current = String.new(encoding: line.encoding)
+          seq = current.dup
+          width = 0
+          in_zero_width = false
+          line = line.encode(UTF_8) if line.encoding != UTF_8
+          line.scan(WIDTH_SCANNER) do |np_start, np_end, csi, osc, gc|
+            next in_zero_width = (current << "\1") if np_start
+            next in_zero_width = !(current << "\2") if np_end
+            next (current << osc) && (seq << osc) if osc
+            if csi
+              current << csi
+              next if in_zero_width
+              next seq.clear if csi == "\e[m" || csi == "\e[0m"
+              next seq << csi
+            end
+            next current << gc if in_zero_width
+            cw = char_width(gc)
+            if (width += cw) > max_width
+              yield(current, width - cw)
+              width = cw
+              current = seq.dup
+            end
+            current << gc
+          end
+          yield(current, width)
+        end
+      end
+
+      def as_embellished_lines(strs, width, height = nil)
         ret = []
-        each_line(
-          args.map!(&cvt),
-          kwargs.fetch(:max_width) do
-            screen_columns.call -
-              kwargs.fetch(:prefix_width) { width(prefix) } -
-              kwargs.fetch(:suffix_width) { width(suffix) }
+        if height
+          each_embellished_line(strs, width) do |*info|
+            ret << info
+            break if ret.size == height
           end
-        ) { ret << "#{prefix}#{_1}#{suffix}" }
+        else
+          each_embellished_line(strs, width) { |*info| ret << info }
+        end
+        ret
+      end
+
+      def as_embellished_lines_min(strs, width)
+        ret = []
+        each_embellished_line(strs, width) { ret << _1 }
         ret
       end
     end
@@ -205,6 +221,7 @@ module NattyUI
     }.compare_by_identity.freeze
 
     autoload(:EastAsianWidth, File.join(__dir__, 'text', 'east_asian_width'))
+    private_constant :EastAsianWidth
 
     @ambiguous_char_width = 1
   end

data/lib/natty-ui/version.rb

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

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

@@ -56,7 +56,7 @@ module NattyUI
       end
 
       def draw(question)
-        glyph = wrapper.glyph(:query)
+        glyph = NattyUI.glyph(:query)
         @parent.print(
           question,
           prefix: "#{glyph} #{Ansi[255]}",

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

@@ -16,7 +16,7 @@ module NattyUI
     # @return [Object] the result of the code block
     # @return [Wrapper::Framed] itself, when no code block is given
     def framed(*args, type: :rounded, &block)
-      _section(:Framed, args, type: type, &block)
+      _section(:Framed, args, type: NattyUI.frame(type), &block)
     end
   end
 
@@ -29,37 +29,17 @@ module NattyUI
       protected
 
       def initialize(parent, type:)
-        deco = as_deco(type)
-        super(parent, prefix: "#{deco[0]} ", prefix_width: 2, suffix_width: 2)
-        init(deco)
+        super(parent, prefix: "#{type[0]} ", prefix_width: 2, suffix_width: 2)
+        init(type)
       end
 
-      def as_deco(type)
-        if type.is_a?(Symbol)
-          ret = DECO[type] and return ret
-        elsif type.is_a?(String)
-          return type if type.size == 8
-          return type * 8 if type.size == 1
-        end
-        raise(ArgumentError, "invalid frame type - #{type.inspect}")
-      end
-
-      def init(deco)
+      def init(type)
         aw = @parent.available_width - 1
-        parent.puts("#{deco[1]}#{deco[2] * aw}")
-        @finish = "#{deco[5]}#{deco[6] * aw}"
+        parent.puts("#{type[1]}#{type[2] * aw}")
+        @finish = "#{type[5]}#{type[6] * aw}"
       end
 
       def finish = @parent.puts(@finish)
-
-      DECO = {
-        rounded: '│╭─╮│╰─╯',
-        simple: '│┌─┐│└─┘',
-        heavy: '┃┏━┓┃┗━┛',
-        double: '║╔═╗║╚═╝',
-        semi: '│╒═╕│╘═╛',
-        block: '▌▛▀▜▐▙▄▟'
-      }.compare_by_identity.freeze
     end
   end
 end

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

@@ -94,7 +94,7 @@ module NattyUI
       protected
 
       def initialize(parent, title:, glyph:)
-        glyph = parent.wrapper.glyph(glyph) || glyph
+        glyph = NattyUI.glyph(glyph) || glyph
         prefix_width = Text.width(glyph) + 1
         super(
           parent,

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

@@ -36,7 +36,7 @@ module NattyUI
 
       def draw(question)
         wrapper = @parent.wrapper
-        glyph = wrapper.glyph(:query)
+        glyph = NattyUI.glyph(:query)
         @parent.print(
           question,
           prefix: "#{glyph} #{Ansi[255]}",

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

@@ -235,7 +235,10 @@ module NattyUI
           diff.each do |col_idx|
             adjust_to = adjusted[col_idx]
             next if matrix[row_idx][col_idx] <= adjust_to
-            row[col_idx] = Text.as_lines(row[col_idx], adjust_to)
+            row[col_idx] = Text.as_embellished_lines_min(
+              row[col_idx],
+              adjust_to
+            )
           end
         end
         adjusted

data/lib/natty-ui/wrapper.rb

@@ -51,8 +51,10 @@ module NattyUI
     #   @param [#to_s] ... objects to print
     #   @return [Wrapper] itself
     def puts(*args, **kwargs)
-      @stream.puts(args = prepare_print(args, kwargs))
-      @lines_written += args.size
+      pprint(args, kwargs) do |line|
+        @stream.puts(line)
+        @lines_written += 1
+      end
       @stream.flush
       self
     end
@@ -63,8 +65,11 @@ module NattyUI
     #   @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
+      pprint(args, kwargs) do |line|
+        @stream.print(line)
+        @lines_written += 1
+      end
+      @lines_written -= 1
       @stream.flush
       self
     end
@@ -152,21 +157,19 @@ 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(args, kwargs)
+      prefix = kwargs[:prefix] and prefix = Text.plain(prefix)
+      suffix = kwargs[:suffix] and suffix = Text.plain(suffix)
+      return yield("#{prefix}#{suffix}") if args.empty?
+      Text.each_plain_line(
+        args,
+        kwargs.fetch(:max_width) do
+          screen_columns - kwargs.fetch(:prefix_width) { Text.width(prefix) } -
+            kwargs.fetch(:suffix_width) { Text.width(suffix) }
+        end
+      ) { yield("#{prefix}#{_1}#{suffix}") }
     end
 
     def temp_func
@@ -206,28 +209,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 == 8
+        return name * 8 if name.size == 1
+      end
+      raise(ArgumentError, "invalid frame type - #{name.inspect}")
+    end
+
     private
 
     def wrapper_class(stream, ansi)
@@ -162,7 +190,38 @@ module NattyUI
   autoload(:LineAnimation, File.join(dir, 'natty-ui', 'line_animation'))
   autoload(:KEY_MAP, File.join(dir, 'natty-ui', 'key_map'))
 
-  private_constant :LineAnimation, :KEY_MAP
+  GLYPH = {
+    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
+
+  # GLYPH = {
+  #   default: '●',
+  #   information: '🅸 ',
+  #   warning: '🆆 ',
+  #   error: '🅴 ',
+  #   completed: '✓',
+  #   failed: '🅵 ',
+  #   task: '➔',
+  #   query: '🆀 '
+  # }.compare_by_identity.freeze
+
+  FRAME = {
+    rounded: '│╭─╮│╰─╯',
+    simple: '│┌─┐│└─┘',
+    heavy: '┃┏━┓┃┗━┛',
+    double: '║╔═╗║╚═╝',
+    semi: '│╒═╕│╘═╛',
+    block: '▌▛▀▜▐▙▄▟'
+  }.compare_by_identity.freeze
+
+  private_constant :LineAnimation, :KEY_MAP, :GLYPH, :FRAME
 
   @element = StdOut
   self.in_stream = STDIN

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Mike Blumtritt