tty-box 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66cd38e818e47ac372868586d8a76cdeb41a98aa9efc59430ec89acb84629410
-  data.tar.gz: d96e96b93e46a9ed8b7432632618af9c54e4da5f9575df820c6f77987104baf2
+  metadata.gz: b9509817a402d4b790c91be69e5d9c11947ba1374a32ba0df8a06a18c333d371
+  data.tar.gz: ea1322ac1cedabf28d34c52fb666386b97013feffc6319cd9c24356039831597
 SHA512:
-  metadata.gz: 6bc7bddb63b580b8430d3dcdf596801db37e2f5813c12b8512a89dc9aff4140ebf6478e91d828020ffb182c84ca81b990d3d346c27718491c420a5a0099deca7
-  data.tar.gz: 43756dd006eec4de539d4a802c69afa04ca1b56fdd29505725d7001418a9e37f94005fc4606daa6be2564a8a12d2b876cbfb4d2ff1f0b43254c7580a99961b48
+  metadata.gz: 78d7164d16610ae4fc585977880845b3bd83c2be04e5c417ec08ce1aa00d0a56d6ff90efa5a3229742e97ea4836faadd140d59aca936ed545dd3606d85bf27d4
+  data.tar.gz: 8c7af2b0bf020d0208065a6afdd2ad8a28edfe3ed731582fbf20f4f8b301b574ebd54b5f0c7d9f05db853a7f9e35a507e5092f8a18ab62feefcc0a84851472bb

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## [v0.7.0] - 2020-12-20
+
+### Added
+* Add :enable_color configuration to allow control over colouring
+
+### Changed
+* Change to ensure non-negative space filler size
+* Change to enforce private visibility for the private module methods
+
+### Fixed
+* Fix box width calculation to ignore colored text by @LainLayer
+* Fix drawing frame around multiline colored content
+
 ## [v0.6.0] - 2020-08-11
 
 ### Changed
@@ -62,6 +75,7 @@
 
 * Initial implementation and release
 
+[v0.7.0]: https://github.com/piotrmurach/tty-box/compare/v0.6.0...v0.7.0
 [v0.6.0]: https://github.com/piotrmurach/tty-box/compare/v0.5.0...v0.6.0
 [v0.5.0]: https://github.com/piotrmurach/tty-box/compare/v0.4.1...v0.5.0
 [v0.4.1]: https://github.com/piotrmurach/tty-box/compare/v0.4.0...v0.4.1

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Piotr Murach
+Copyright (c) 2018 Piotr Murach (https://piotrmurach.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,11 +1,11 @@
 <div align="center">
-  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://github.com/piotrmurach/tty/blob/master/images/tty.png" alt="tty logo" /></a>
+  <a href="https://ttytoolkit.org"><img width="130" src="https://github.com/piotrmurach/tty/blob/master/images/tty.png" alt="TTY Toolkit logo" /></a>
 </div>
 
 # TTY::Box [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-box.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-box.svg?branch=master)][travis]
+[![Actions CI](https://github.com/piotrmurach/tty-box/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
 [![Build status](https://ci.appveyor.com/api/projects/status/h9b88fk5xpya3fh1?svg=true)][appveyor]
 [![Maintainability](https://api.codeclimate.com/v1/badges/dfac05073e1549e9dbb6/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-box/badge.svg)][coverage]
@@ -13,7 +13,7 @@
 
 [gitter]: https://gitter.im/piotrmurach/tty
 [gem]: http://badge.fury.io/rb/tty-box
-[travis]: http://travis-ci.org/piotrmurach/tty-box
+[gh_actions_ci]: https://github.com/piotrmurach/tty-box/actions?query=workflow%3ACI
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-box
 [codeclimate]: https://codeclimate.com/github/piotrmurach/tty-box/maintainability
 [coverage]: https://coveralls.io/github/piotrmurach/tty-box
@@ -310,7 +310,7 @@ print box
 If you want to remove a given border element as a value use `false`. For example to remove bottom border do:
 
 ```ruby
-TTY::Box.new(
+TTY::Box.frame(
   width: 30, height: 10,
   border: {
     type: :thick,
@@ -335,6 +335,20 @@ style: {
 
 The above style configuration will produce the result similar to the top demo, a MS-DOS look & feel window.
 
+You can disable or force output styling regardless of the terminal using the `enable_color` keyword. By default, the color support is automatically detected.
+
+```ruby
+TTY::Box.frame({
+  enable_color: true, # force to always color output
+  style: {
+    border: {
+      fg: :bright_yellow,
+      bg: :blue
+    }
+  }
+})
+```
+
 ### 2.7 formatting
 
 You can use `:align` keyword to format content either to be `:left`, `:center` or `:right` aligned:

data/lib/tty-box.rb

@@ -1 +1 @@
-require_relative 'tty/box'
+require_relative "tty/box"

data/lib/tty/box.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
-require 'strings'
-require 'pastel'
-require 'tty-cursor'
+require "strings"
+require "pastel"
+require "tty-cursor"
 
-require_relative 'box/border'
-require_relative 'box/version'
+require_relative "box/border"
+require_relative "box/version"
 
 module TTY
   module Box
     module_function
 
     NEWLINE = "\n"
+    SPACE = " "
 
     LINE_BREAK = %r{\r\n|\r|\n}.freeze
 
@@ -69,8 +70,8 @@ module TTY
       TTY::Cursor
     end
 
-    def color
-      @color ||= Pastel.new
+    def color(enabled: nil)
+      @color ||= Pastel.new(enabled: enabled)
     end
 
     # A frame for info type message
@@ -135,7 +136,7 @@ module TTY
           bg: :bright_green,
           border: {
             fg: :black,
-            bg: :bright_green,
+            bg: :bright_green
           }
         }
       }.merge(opts)
@@ -187,37 +188,36 @@ module TTY
     #   the styling for the front and background
     #
     # @api public
-    def frame(*content, top: nil, left: nil, width: nil, height: nil, align: :left,
-              padding: 0, title: {}, border: :light, style: {})
+    def frame(*content, top: nil, left: nil, width: nil, height: nil,
+              align: :left, padding: 0, title: {}, border: :light, style: {},
+              enable_color: nil)
+      @color = nil
+      color(enabled: enable_color)
       output = []
       sep = NEWLINE
       position = top && left
 
       border = Border.parse(border)
-      top_size    = border.top? ? 1: 0
-      bottom_size = border.bottom? ? 1: 0
+      top_size    = border.top? ? 1 : 0
+      bottom_size = border.bottom? ? 1 : 0
       left_size   = border.left? ? 1 : 0
       right_size  = border.right ? 1 : 0
 
-      if block_given?
-        str = yield
-      else
-        str = case content.size
-        when 0 then ""
-        when 1 then content[0]
-        else content.join(NEWLINE)
-        end
-      end
-
+      str = block_given? ? yield : content_to_str(content)
       sep = str[LINE_BREAK] || NEWLINE # infer line break
-      lines = str.split(sep)
+      content_lines = str.split(sep)
+
       # infer dimensions
-      dimensions = infer_dimensions(lines, padding)
+      dimensions = infer_dimensions(content_lines, padding)
       width ||= left_size + dimensions[0] + right_size
-      width = [width, top_space_taken(title, border), bottom_space_taken(title, border)].max
-
+      width = [width,
+               top_space_taken(title, border),
+               bottom_space_taken(title, border)].max
       height ||= top_size + dimensions[1] + bottom_size
-      content = format(str, width, padding, align) # adjust content
+
+      # apply formatting to content
+      formatted_lines = format(content_lines, width, padding, align, sep)
+
       # infer styling
       fg, bg = *extract_style(style)
       border_fg, border_bg = *extract_style(style[:border] || {})
@@ -234,19 +234,22 @@ module TTY
           output << border_bg.(border_fg.(pipe_char(border.type)))
         end
 
-        content_size = width - left_size - right_size
-        unless content[i].nil?
-          output << bg.(fg.(content[i]))
-          size = Strings::ANSI.sanitize(content[i]).scan(/[[:print:]]/).join.size
-          content_size -= size
+        filler_size = width - left_size - right_size
+        if formatted_line = formatted_lines[i]
+          output << bg.(fg.(formatted_line))
+          line_content_size = Strings::ANSI.sanitize(formatted_line)
+                                           .scan(/[[:print:]]/).join.size
+          filler_size = [filler_size - line_content_size, 0].max
         end
+
         if style[:fg] || style[:bg] || !position # something to color
-          output << bg.(fg.(" " * content_size))
+          output << bg.(fg.(SPACE * filler_size))
         end
 
         if border.right?
           if position
-            output << cursor.move_to(left + width - right_size, top + i + top_size)
+            output << cursor.move_to(left + width - right_size,
+                                     top + i + top_size)
           end
           output << border_bg.(border_fg.(pipe_char(border.type)))
         end
@@ -262,6 +265,22 @@ module TTY
       output.join
     end
 
+    # Convert content array to string
+    #
+    # @param [Array<String>] content
+    #
+    # @return [String]
+    #
+    # @api private
+    def content_to_str(content)
+      case content.size
+      when 0 then ""
+      when 1 then content[0]
+      else content.join(NEWLINE)
+      end
+    end
+    private_class_method :content_to_str
+
     # Infer box dimensions based on content lines and padding
     #
     # @param [Array[String]] lines
@@ -272,30 +291,59 @@ module TTY
     # @api private
     def infer_dimensions(lines, padding)
       pad = Strings::Padder.parse(padding)
-      content_height = lines.size
-      content_width = lines.empty? ? 1 : lines.max_by(&:length).length
-      width = pad.left + content_width + pad.right
-      height = pad.top + content_height + pad.bottom
+      width = pad.left + content_width(lines) + pad.right
+      height = pad.top + lines.size + pad.bottom
       [width, height]
     end
+    private_class_method :infer_dimensions
 
-    # Format content
+    # The maximum content width for all the lines
+    #
+    # @param [Array<String>] lines
+    #
+    # @return [Integer]
+    #
+    # @api private
+    def content_width(lines)
+      return 1 if lines.empty?
+
+      lines.map(&Strings::ANSI.method(:sanitize)).max_by(&:length).length
+    end
+    private_class_method :content_width
+
+    # Format content by wrapping, aligning and padding out
+    #
+    # @param [Array<String>] lines
+    #   the lines to format
+    # @param [Integer] width
+    #   the maximum width
+    # @param [Integer, Array<Integer>] padding
+    #   the amount of padding
+    # @param [Symbol] align
+    #   the type of alignment
+    # @param [String] separator
+    #   the newline separator
     #
     # @return [Array[String]]
     #
     # @api private
-    def format(content, width, padding, align)
-      return "" if content.to_s.empty?
+    def format(lines, width, padding, align, separator)
+      return [] if lines.empty?
 
       pad = Strings::Padder.parse(padding)
       total_width = width - 2 - (pad.left + pad.right)
-      sep = content[LINE_BREAK] || NEWLINE # infer line break
 
-      wrapped = Strings.wrap(content, total_width)
-      aligned = Strings.align(wrapped, total_width, direction: align)
-      padded  = Strings.pad(aligned, padding)
-      padded.split(sep)
+      formatted = lines.each_with_object([]) do |line, acc|
+        wrapped = Strings::Wrap.wrap(line, total_width, separator: separator)
+        acc << Strings::Align.align(wrapped, total_width,
+                                    direction: align,
+                                    separator: separator)
+      end.join(separator)
+
+      Strings::Pad.pad(formatted, padding, separator: separator)
+                  .split(separator)
     end
+    private_class_method :format
 
     # Convert style keywords into styling
     #
@@ -303,10 +351,11 @@ module TTY
     #
     # @api private
     def extract_style(style)
-      fg = style[:fg] ? color.send(style[:fg]).detach : -> (c) { c }
-      bg = style[:bg] ? color.send(:"on_#{style[:bg]}").detach : -> (c) { c }
+      fg = style[:fg] ? color.send(style[:fg]).detach : ->(c) { c }
+      bg = style[:bg] ? color.send(:"on_#{style[:bg]}").detach : ->(c) { c }
       [fg, bg]
     end
+    private_class_method :extract_style
 
     # Top space taken by titles and corners
     #
@@ -314,26 +363,39 @@ module TTY
     #
     # @api private
     def top_space_taken(title, border)
-      top_titles_size(title) + top_left_corner(border).size + top_right_corner(border).size
+      top_titles_size(title) +
+        top_left_corner(border).size +
+        top_right_corner(border).size
     end
+    private_class_method :top_space_taken
 
     # Top left corner
     #
+    # @param [Border] border
+    #
     # @return [String]
     #
     # @api private
     def top_left_corner(border)
-      border.top_left? && border.left? ? send(:"#{border.top_left}_char", border.type) : ""
+      return "" unless border.top_left? && border.left?
+
+      send(:"#{border.top_left}_char", border.type)
     end
+    private_class_method :top_left_corner
 
     # Top right corner
     #
+    # @param [Border] border
+    #
     # @return [String]
     #
     # @api private
     def top_right_corner(border)
-      border.top_right? && border.right? ? send(:"#{border.top_right}_char", border.type) : ""
+      return "" unless border.top_right? && border.right?
+
+      send(:"#{border.top_right}_char", border.type)
     end
+    private_class_method :top_right_corner
 
     # Top titles size
     #
@@ -341,8 +403,11 @@ module TTY
     #
     # @api private
     def top_titles_size(title)
-      title[:top_left].to_s.size + title[:top_center].to_s.size + title[:top_right].to_s.size
+      color.strip(title[:top_left].to_s).size +
+        color.strip(title[:top_center].to_s).size +
+        color.strip(title[:top_right].to_s).size
     end
+    private_class_method :top_titles_size
 
     # Top border
     #
@@ -364,34 +429,49 @@ module TTY
         bg.(fg.(line_char(border.type) * top_space_after)),
         bg.(fg.(title[:top_right].to_s)),
         bg.(fg.(top_right_corner(border)))
-      ].join('')
+      ].join
     end
+    private_class_method :top_border
+
     # Bottom space taken by titles and corners
     #
     # @return [Integer]
     #
     # @api private
     def bottom_space_taken(title, border)
-      bottom_titles_size(title) + bottom_left_corner(border).size + bottom_right_corner(border).size
+      bottom_titles_size(title) +
+        bottom_left_corner(border).size +
+        bottom_right_corner(border).size
     end
+    private_class_method :bottom_space_taken
 
     # Bottom left corner
     #
+    # @param [Border] border
+    #
     # @return [String]
     #
     # @api private
     def bottom_left_corner(border)
-      border.bottom_left? && border.left? ? send(:"#{border.bottom_left}_char", border.type) : ""
+      return "" unless border.bottom_left? && border.left?
+
+      send(:"#{border.bottom_left}_char", border.type)
     end
+    private_class_method :bottom_left_corner
 
     # Bottom right corner
     #
+    # @param [Border] border
+    #
     # @return [String]
     #
     # @api private
     def bottom_right_corner(border)
-      border.bottom_right? && border.right? ? send(:"#{border.bottom_right}_char", border.type) : ""
+      return "" unless border.bottom_right? && border.right?
+
+      send(:"#{border.bottom_right}_char", border.type)
     end
+    private_class_method :bottom_right_corner
 
     # Bottom titles size
     #
@@ -399,8 +479,11 @@ module TTY
     #
     # @api private
     def bottom_titles_size(title)
-      title[:bottom_left].to_s.size + title[:bottom_center].to_s.size + title[:bottom_right].to_s.size
+      color.strip(title[:bottom_left].to_s).size +
+        color.strip(title[:bottom_center].to_s).size +
+        color.strip(title[:bottom_right].to_s).size
     end
+    private_class_method :bottom_titles_size
 
     # Bottom border
     #
@@ -422,7 +505,8 @@ module TTY
         bg.(fg.(line_char(border.type) * bottom_space_after)),
         bg.(fg.(title[:bottom_right].to_s)),
         bg.(fg.(bottom_right_corner(border)))
-      ].join('')
+      ].join
     end
+    private_class_method :bottom_border
   end # TTY
 end # Box

data/lib/tty/box/border.rb

@@ -6,18 +6,18 @@ module TTY
     #
     # @api private
     class Border
-      BORDER_VALUES = [
-        :corner_bottom_right,
-        :corner_top_right,
-        :corner_top_left,
-        :corner_bottom_left,
-        :divider_left,
-        :divider_up,
-        :divider_down,
-        :divider_right,
-        :line,
-        :pipe,
-        :cross
+      BORDER_VALUES = %i[
+        corner_bottom_right
+        corner_top_right
+        corner_top_left
+        corner_bottom_left
+        divider_left
+        divider_up
+        divider_down
+        divider_right
+        line
+        pipe
+        cross
       ].freeze
 
       def self.parse(border)
@@ -68,11 +68,17 @@ module TTY
       private
 
       # Check if border values name is allowed
+      #
+      # @raise [ArgumentError]
+      #
       # @api private
       def check_name(key, value)
-        unless (BORDER_VALUES.include?(:"#{value}") || [true, false].include?(value))
-          raise ArgumentError, "Invalid border value: '#{value}' for #{key.inspect}"
+        unless BORDER_VALUES.include?(:"#{value}") ||
+               [true, false].include?(value)
+          raise ArgumentError, "invalid #{key.inspect} border value: " \
+                              "#{value.inspect}"
         end
+
         value
       end
     end # Border

data/lib/tty/box/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module Box
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end # Box
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-box
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel