tty-box 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22f794bf37522fed08b625102db5d264f79aca278567b6b1c1963d7c51e13d81
-  data.tar.gz: 5bc28c0eb6c16fc60d5325987c5f03e7a68e608c0cb1bea6671bee08733c4f33
+  metadata.gz: 5f6930141848be48d0af21960b3db9857af6aa5b22fa4bab1f3163406c9c1c54
+  data.tar.gz: c05ed307504d3a16fc4f1aa00d4d622fd7566a27b65ed22a1309397e596d2bb6
 SHA512:
-  metadata.gz: ffe110f742b307902689234d61eee012709dac09b5723dc08617a5f605c0585e01c7d4e65282ab888a62719e8ca8a9b3d7f1d7e726e8d854ae84caf6d322c3d6
-  data.tar.gz: 6d966972cbd28e03edd08c6e80ef96db438ccdb2ac3343fb8cd4c6eea0db7bb125e510ed0b1b4d20864b6f252f590a9d8abf3e36a7cb0eae1d2b7f5b36b6c0f8
+  metadata.gz: 3c493c40374897de1b34b1295101ce33ff3ce401005c3fe300c314d31d413ff1b93fdbb1af29a1352fa6cebb12c5f45f46032b58ef68d4f9afe9b6d8892561df
+  data.tar.gz: db800e05bef214944f5e2d6aff324b9cf9700de701652004ac90113148764079364f4457eed82df1cf7c28f322ff28d9b282a111f6cb9c0578c8ecde57b06008

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## [v0.4.1] - 2019-08-28
+
+### Added
+* Add example to demonstrate different line endings
+
+### Fixed
+* Fix to handle different line endings
+
 ## [v0.4.0] - 2019-06-05
 
 ### Changed
@@ -34,6 +42,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.3.0]: https://github.com/piotrmurach/tty-box/compare/v0.2.1...v0.3.0
 [v0.2.1]: https://github.com/piotrmurach/tty-box/compare/v0.2.0...v0.2.1

data/examples/newline.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "../lib/tty-box"
+
+box = TTY::Box.frame(
+  width: 29,
+  height: 7,
+  align: :center,
+  padding: 1
+) do
+  "Closes #360\r\n\r\nCloses !217"
+end
+
+puts box

data/lib/tty/box.rb

@@ -11,6 +11,10 @@ module TTY
   module Box
     module_function
 
+    NEWLINE = "\n"
+
+    LINE_BREAK = %r{\r\n|\r|\n}.freeze
+
     BOX_CHARS = {
       ascii: %w[+ + + + + + + + - | +],
       light: %w[┘ ┐ ┌ └ ┤ ┴ ┬ ├ ─ │ ┼],
@@ -76,6 +80,7 @@ module TTY
               title: {}, border: :light, style: {})
       output = []
       content = []
+      sep = NEWLINE
       position = top && left
 
       border = Border.parse(border)
@@ -85,7 +90,9 @@ module TTY
       right_size  = border.right ? 1 : 0
 
       if block_given?
-        content = format(yield, width, padding, align)
+        str = yield
+        sep = str[LINE_BREAK] || NEWLINE # infer line break
+        content = format(str, width, padding, align)
       end
 
       fg, bg = *extract_style(style)
@@ -94,7 +101,7 @@ module TTY
       if border.top?
         output << cursor.move_to(left, top) if position
         output << top_border(title, width, border, style)
-        output << "\n" unless position
+        output << sep unless position
       end
 
       (height - top_size - bottom_size).times do |i|
@@ -106,7 +113,8 @@ module TTY
         content_size = width - left_size - right_size
         unless content[i].nil?
           output << bg.(fg.(content[i]))
-          content_size -= Strings::ANSI.sanitize(content[i]).size
+          size = Strings::ANSI.sanitize(content[i]).scan(/[[:print:]]/).join.size
+          content_size -= size
         end
         if style[:fg] || style[:bg] || !position # something to color
           output << bg.(fg.(' ' * content_size))
@@ -118,13 +126,13 @@ module TTY
           end
           output << border_bg.(border_fg.(pipe_char(border.type)))
         end
-        output << "\n" unless position
+        output << sep unless position
       end
 
       if border.bottom?
         output << cursor.move_to(left, top + height - bottom_size) if position
         output << bottom_border(title, width, border, style)
-        output << "\n" unless position
+        output << sep unless position
       end
 
       output.join
@@ -138,11 +146,12 @@ module TTY
     def format(content, width, padding, align)
       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("\n")
+      padded.split(sep)
     end
 
     # Convert style keywords into styling

data/lib/tty/box/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module Box
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end # Box
 end # TTY

data/spec/unit/frame_spec.rb

@@ -1,4 +1,6 @@
-RSpec.describe TTY::Box, '#frame' do
+# frozen_string_literal: true
+
+RSpec.describe TTY::Box, "#frame" do
   it "creates frame with only  width & height values" do
     output = TTY::Box.frame(width: 35, height: 4)
 
@@ -58,4 +60,23 @@ RSpec.describe TTY::Box, '#frame' do
       "└─────────────────────────────────┘\n"
     ].join)
   end
+
+  it "handles \r\n line breaks" do
+    box = TTY::Box.frame(
+          width: 29,
+          height: 7
+        ) do
+      "Closes #360\r\n\r\nCloses !217"
+    end
+
+    expect(box).to eq([
+      "┌───────────────────────────┐\r\n",
+      "│Closes #360                │\r\n",
+      "│                           │\r\n",
+      "│Closes !217                │\r\n",
+      "│                           │\r\n",
+      "│                           │\r\n",
+      "└───────────────────────────┘\r\n"
+    ].join)
+  end
 end

data/spec/unit/padding_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe TTY::Box, ':padding option' do
   it "padds internal content without position arguments" do
     box = TTY::Box.frame(width: 30, height: 6, padding: 1) do
@@ -43,4 +45,24 @@ RSpec.describe TTY::Box, ':padding option' do
       "\e[6;1H└────────────────────────────┘"
     ].join)
   end
+
+  it "handles \r\n line breaks when padding" do
+    box = TTY::Box.frame(
+          width: 29,
+          height: 7,
+          padding: 1
+        ) do
+      "Closes #360\r\n\r\nCloses !217"
+    end
+
+    expect(box).to eq([
+      "┌───────────────────────────┐\r\n",
+      "│                           │\r\n",
+      "│ Closes #360               │\r\n",
+      "│                           │\r\n",
+      "│ Closes !217               │\r\n",
+      "│                           │\r\n",
+      "└───────────────────────────┘\r\n"
+    ].join)
+  end
 end

data/tty-box.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'pastel', '~> 0.7.2'
-  spec.add_dependency 'tty-cursor', '~> 0.7'
-  spec.add_dependency 'strings', '~> 0.1.5'
+  spec.add_dependency "pastel", "~> 0.7.2"
+  spec.add_dependency "tty-cursor", "~> 0.7"
+  spec.add_dependency "strings", "~> 0.1.6"
 
   spec.add_development_dependency "bundler", ">= 1.5"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-box
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +109,7 @@ files:
 - bin/setup
 - examples/commander.rb
 - examples/connected.rb
+- examples/newline.rb
 - lib/tty-box.rb
 - lib/tty/box.rb
 - lib/tty/box/border.rb