tty-box 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f4d14d40ab0bd1c8030ad5f1cbd706e2dd884ea9eb7f1a251e3b41b3839e7c6
-  data.tar.gz: 4236c0e2eca6dab6802360067eb31774abd70f9e82d0bb54e8d46d157338fc31
+  metadata.gz: 66cd38e818e47ac372868586d8a76cdeb41a98aa9efc59430ec89acb84629410
+  data.tar.gz: d96e96b93e46a9ed8b7432632618af9c54e4da5f9575df820c6f77987104baf2
 SHA512:
-  metadata.gz: e02a01c723e2d3daa1353a7ba5cec72cbd6f657d26e8e24fc1b7f209b0010a3fa8805292bd3129c4c64c23e857395356d51ada371d0005e8ec6c030e8eb20989
-  data.tar.gz: 57296652a8991121efdccdd00bb74c6d2ca5068cb765236ff3f787e05162505b0c63ed27c2ae0282dddef1883330cc809dd31300ed5a4361d9c648cfbe5c472c
+  metadata.gz: 6bc7bddb63b580b8430d3dcdf596801db37e2f5813c12b8512a89dc9aff4140ebf6478e91d828020ffb182c84ca81b990d3d346c27718491c420a5a0099deca7
+  data.tar.gz: 43756dd006eec4de539d4a802c69afa04ca1b56fdd29505725d7001418a9e37f94005fc4606daa6be2564a8a12d2b876cbfb4d2ff1f0b43254c7580a99961b48

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## [v0.6.0] - 2020-08-11
+
+### Changed
+* Change to preserve newline characters when wrapping content
+* Change gemspec to include metadata and remove test files
+* Change to update pastel & strings dependencies
+
+### Fixed
+* Fix Ruby 2.7 warnings
+
 ## [v0.5.0] - 2019-10-08
 
 ### Added
@@ -52,6 +62,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.4.0]: https://github.com/piotrmurach/tty-box/compare/v0.3.0...v0.4.0

data/README.md

@@ -19,7 +19,7 @@
 [coverage]: https://coveralls.io/github/piotrmurach/tty-box
 [inchpages]: http://inch-ci.org/github/piotrmurach/tty-box
 
-> Draw various frames and boxes in your terminal interface.
+> Draw various frames and boxes in the terminal window.
 
 **TTY::Box** provides box drawing component for [TTY](https://github.com/piotrmurach/tty) toolkit.
 
@@ -30,7 +30,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tty-box'
+gem "tty-box"
 ```
 
 And then execute:
@@ -122,9 +122,7 @@ print TTY::Box.frame "Hello\nworld!"
 Finally, you can use a block to specify content:
 
 ```ruby
-print TTY::Box.frame do
-  "Hello world!"
-end
+print TTY::Box.frame { "Hello world!" }
 # =>
 # ┌────────────┐
 # │Hello world!│
@@ -213,7 +211,7 @@ You can specify titles using the `:title` keyword and a hash value that contains
 
 
 ```ruby
-box = TTY::Box.frame(width: 30, height: 10, title: {top_left: 'TITLE', bottom_right: 'v1.0'})
+box = TTY::Box.frame(width: 30, height: 10, title: {top_left: "TITLE", bottom_right: "v1.0"})
 ```
 
 which when printed in console will render the following:

data/lib/tty/box.rb

@@ -214,6 +214,8 @@ module TTY
       # infer dimensions
       dimensions = infer_dimensions(lines, padding)
       width ||= left_size + dimensions[0] + right_size
+      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
       # infer styling
@@ -306,34 +308,99 @@ module TTY
       [fg, bg]
     end
 
+    # Top space taken by titles and corners
+    #
+    # @return [Integer]
+    #
+    # @api private
+    def top_space_taken(title, border)
+      top_titles_size(title) + top_left_corner(border).size + top_right_corner(border).size
+    end
+
+    # Top left corner
+    #
+    # @return [String]
+    #
+    # @api private
+    def top_left_corner(border)
+      border.top_left? && border.left? ? send(:"#{border.top_left}_char", border.type) : ""
+    end
+
+    # Top right corner
+    #
+    # @return [String]
+    #
+    # @api private
+    def top_right_corner(border)
+      border.top_right? && border.right? ? send(:"#{border.top_right}_char", border.type) : ""
+    end
+
+    # Top titles size
+    #
+    # @return [Integer]
+    #
+    # @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
+    end
+
     # Top border
     #
     # @return [String]
     #
     # @api private
     def top_border(title, width, border, style)
-      top_titles_size = title[:top_left].to_s.size +
-                        title[:top_center].to_s.size +
-                        title[:top_right].to_s.size
       fg, bg = *extract_style(style[:border] || {})
 
-      top_left = border.top_left? && border.left? ? send(:"#{border.top_left}_char", border.type) : ""
-      top_right = border.top_right? && border.right? ? send(:"#{border.top_right}_char", border.type) : ""
-
-      top_space_left   = width - top_titles_size - top_left.size - top_right.size
+      top_space_left = width - top_space_taken(title, border)
       top_space_before = top_space_left / 2
       top_space_after  = top_space_left / 2 + top_space_left % 2
 
       [
-        bg.(fg.(top_left)),
+        bg.(fg.(top_left_corner(border))),
         bg.(fg.(title[:top_left].to_s)),
         bg.(fg.(line_char(border.type) * top_space_before)),
         bg.(fg.(title[:top_center].to_s)),
         bg.(fg.(line_char(border.type) * top_space_after)),
         bg.(fg.(title[:top_right].to_s)),
-        bg.(fg.(top_right))
+        bg.(fg.(top_right_corner(border)))
       ].join('')
     end
+    # 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
+    end
+
+    # Bottom left corner
+    #
+    # @return [String]
+    #
+    # @api private
+    def bottom_left_corner(border)
+      border.bottom_left? && border.left? ? send(:"#{border.bottom_left}_char", border.type) : ""
+    end
+
+    # Bottom right corner
+    #
+    # @return [String]
+    #
+    # @api private
+    def bottom_right_corner(border)
+      border.bottom_right? && border.right? ? send(:"#{border.bottom_right}_char", border.type) : ""
+    end
+
+    # Bottom titles size
+    #
+    # @return [Integer]
+    #
+    # @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
+    end
 
     # Bottom border
     #
@@ -341,27 +408,20 @@ module TTY
     #
     # @api private
     def bottom_border(title, width, border, style)
-      bottom_titles_size = title[:bottom_left].to_s.size +
-                           title[:bottom_center].to_s.size +
-                           title[:bottom_right].to_s.size
       fg, bg = *extract_style(style[:border] || {})
 
-      bottom_left  = border.bottom_left? && border.left? ? send(:"#{border.bottom_left}_char", border.type) : ""
-      bottom_right = border.bottom_right? && border.right? ? send(:"#{border.bottom_right}_char", border.type) : ""
-
-      bottom_space_left = width - bottom_titles_size -
-                          bottom_left.size - bottom_right.size
+      bottom_space_left = width - bottom_space_taken(title, border)
       bottom_space_before = bottom_space_left / 2
       bottom_space_after = bottom_space_left / 2 + bottom_space_left % 2
 
       [
-        bg.(fg.(bottom_left)),
+        bg.(fg.(bottom_left_corner(border))),
         bg.(fg.(title[:bottom_left].to_s)),
         bg.(fg.(line_char(border.type) * bottom_space_before)),
         bg.(fg.(title[:bottom_center].to_s)),
         bg.(fg.(line_char(border.type) * bottom_space_after)),
         bg.(fg.(title[:bottom_right].to_s)),
-        bg.(fg.(bottom_right))
+        bg.(fg.(bottom_right_corner(border)))
       ].join('')
     end
   end # TTY

data/lib/tty/box/border.rb

@@ -23,7 +23,7 @@ module TTY
       def self.parse(border)
         case border
         when Hash
-          new(border)
+          new(**border)
         when *TTY::Box::BOX_CHARS.keys
           new(type: border)
         else

data/lib/tty/box/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-box
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,56 +70,43 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Draw various frames and boxes in your terminal interface.
+description: Draw various frames and boxes in the terminal window.
 email:
-- me@piotrmurach.com
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- examples/basic.rb
-- examples/commander.rb
-- examples/connected.rb
-- examples/messages.rb
-- examples/newline.rb
 - lib/tty-box.rb
 - lib/tty/box.rb
 - lib/tty/box/border.rb
 - lib/tty/box/version.rb
-- spec/spec_helper.rb
-- spec/unit/align_spec.rb
-- spec/unit/border/parse_spec.rb
-- spec/unit/border_spec.rb
-- spec/unit/custom_frame_spec.rb
-- spec/unit/frame_spec.rb
-- spec/unit/padding_spec.rb
-- spec/unit/position_spec.rb
-- spec/unit/style_spec.rb
-- spec/unit/title_spec.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-box.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-box/issues
+  changelog_uri: https://github.com/piotrmurach/tty-box/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-box
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-box
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -149,8 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Draw various frames and boxes in your terminal interface.
+summary: Draw various frames and boxes in the terminal window.
 test_files: []

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]
-
-task default: :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "tty/box"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/examples/basic.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../lib/tty-box"
-
-box = TTY::Box.frame "Drawing a box in", "terminal emulator",
-  padding: 3, align: :center
-
-puts box

data/examples/commander.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-box'
-
-print TTY::Cursor.clear_screen
-
-box_1 = TTY::Box.frame(
-  top: 2,
-  left: 10,
-  width: 30,
-  height: 10,
-  border: :thick,
-  align: :center,
-  padding: 3,
-  title: {
-    top_left: ' file1 '
-  },
-  style: {
-    fg: :bright_yellow,
-    bg: :blue,
-    border: {
-      fg: :bright_yellow,
-      bg: :blue
-    }
-  }
-) do
-  "Drawing a box in terminal emulator"
-end
-
-box_2 = TTY::Box.frame(
-  top: 8,
-  left: 34,
-  width: 30,
-  height: 10,
-  border: :thick,
-  align: :center,
-  padding: 3,
-  title: {
-    top_left: ' file2 '
-  },
-  style: {
-    fg: :bright_yellow,
-    bg: :blue,
-    border: {
-      fg: :bright_yellow,
-      bg: :blue
-    }
-  }
-) do
-  "Drawing a box in terminal emulator"
-end
-
-puts box_1 + box_2
-print "\n" * 5