strings 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59762ac60270a0fa21a1989b6ec1bf8b98eac632fc9ff8c091ef7dd711a8baf8
-  data.tar.gz: 43276937aaef5a75cb43e8e29a6ea9f5f09b4488d22a84a03fa128de07840afb
+  metadata.gz: 921f81ef625130227be2240cdd40e00a88db1f902abd30af157833b31fc9e57c
+  data.tar.gz: f26a6ca02ea2a3fb59cd81c4347ee2381f7b745c1b80975ce8e3262d33b91a9e
 SHA512:
-  metadata.gz: 29244946de99fa208749f9ca7f88010b70b466f0d29583f76b9b982b9b299a69b14a1f76a43cd537f46e758f2f7e3e40f057d6506650b67fcd84d6e788f127c0
-  data.tar.gz: 6d8b306a59eaafb78308e293739dadaaded471ef2a97daffc3cf31681a490df05067845600faed4b2fdcf390aa307016934f07751a7d3aa5c5fff49363162812
+  metadata.gz: 03de4bc3bc330b62ea283a86904edf9a67d2921c1c42c12e12168f5b4d1d306cabd2bee7bbfc519e70bdbfc5f2a93f356aa99a47b830e1b28135d1f07b42ec36
+  data.tar.gz: 547a0b7849b8fa00db911f2e066cb0157f64cb5b169f64d5f62068f0e34be387b86bf862edefee08c6d98598d7f37f37416ea480bd58e2cff0338b1fb8ab31cc

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## [v0.1.6] - 2019-08-28
+
+### Changed
+* Change Wrap#wrap, Align#align & Pad#pad to handle different line endings
+* Change Pad#pad to pad empty lines
+
+### Fixed
+* Fix Wrap#wrap to handle adjacent ANSI codes
+* Fix Wrap#insert_ansi to handle nested ANSI codes
+
 ## [v0.1.5] - 2019-03-29
 
 ### Changed
@@ -30,6 +40,7 @@
 
 * Initial implementation and release
 
+[v0.1.6]: https://github.com/piotrmurach/strings/compare/v0.1.4...v0.1.5
 [v0.1.5]: https://github.com/piotrmurach/strings/compare/v0.1.4...v0.1.5
 [v0.1.4]: https://github.com/piotrmurach/strings/compare/v0.1.3...v0.1.4
 [v0.1.3]: https://github.com/piotrmurach/strings/compare/v0.1.2...v0.1.3

data/README.md

@@ -386,7 +386,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/strings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-1. Fork it ( https://github.com/piotrmurach/verse/fork )
+1. Fork it ( https://github.com/piotrmurach/strings/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/strings/align.rb

@@ -7,8 +7,8 @@ module Strings
   # Responsible for text alignment
   module Align
     NEWLINE = "\n".freeze
-
-    SPACE = ' '.freeze
+    SPACE = " ".freeze
+    LINE_BREAK = %r{\r\n|\r|\n}.freeze
 
     # Aligns text within the width.
     #
@@ -62,9 +62,11 @@ module Strings
     # @return [String]
     #
     # @api public
-    def align_left(text, width, fill: SPACE, separator: NEWLINE)
+    def align_left(text, width, fill: SPACE, separator: nil)
       return if width.nil?
-      each_line(text, separator) do |line|
+      sep = separator || text[LINE_BREAK] || NEWLINE
+
+      each_line(text, sep) do |line|
         width_diff = width - display_width(line)
         if width_diff > 0
           line + fill * width_diff
@@ -80,9 +82,11 @@ module Strings
     # @return [String]
     #
     # @api public
-    def align_center(text, width, fill: SPACE, separator: NEWLINE)
+    def align_center(text, width, fill: SPACE, separator: nil)
       return text if width.nil?
-      each_line(text, separator) do |line|
+      sep = separator || text[LINE_BREAK] || NEWLINE
+
+      each_line(text, sep) do |line|
         width_diff = width - display_width(line)
         if width_diff > 0
           right_count = (width_diff.to_f / 2).ceil
@@ -100,9 +104,11 @@ module Strings
     # @return [String]
     #
     # @api public
-    def align_right(text, width, fill: SPACE, separator: NEWLINE)
+    def align_right(text, width, fill: SPACE, separator: nil)
       return text if width.nil?
-      each_line(text, separator) do |line|
+      sep = separator || text[LINE_BREAK] || NEWLINE
+
+      each_line(text, sep) do |line|
         width_diff = width - display_width(line)
         if width_diff > 0
           fill * width_diff + line

data/lib/strings/pad.rb

@@ -9,8 +9,8 @@ module Strings
   # Responsible for text padding
   module Pad
     NEWLINE = "\n".freeze
-
-    SPACE = ' '.freeze
+    SPACE = " ".freeze
+    LINE_BREAK =  %r{\r\n|\r|\n}.freeze
 
     # Apply padding to multiline text with ANSI codes
     #
@@ -31,10 +31,11 @@ module Strings
     # @return [String]
     #
     # @api private
-    def pad(text, padding, fill: SPACE, separator: NEWLINE)
+    def pad(text, padding, fill: SPACE, separator: nil)
       padding   = Strings::Padder.parse(padding)
       text_copy = text.dup
-      line_width = max_line_length(text, separator)
+      sep = separator || text[LINE_BREAK] || NEWLINE
+      line_width = max_line_length(text, sep)
       output = []
 
       filler_line = fill * line_width
@@ -43,7 +44,8 @@ module Strings
         output << pad_around(filler_line, padding, fill: fill)
       end
 
-      text_copy.split(separator).each do |line|
+      text_copy.split(sep).each do |line|
+        line = line.empty? ? filler_line : line
         output << pad_around(line, padding, fill: fill)
       end
 
@@ -51,7 +53,7 @@ module Strings
         output << pad_around(filler_line, padding, fill: fill)
       end
 
-      output.join(separator)
+      output.join(sep)
     end
     module_function :pad
 

data/lib/strings/padder.rb

@@ -72,7 +72,7 @@ module Strings
 
     # Set top padding
     #
-    # @param [Integer] val
+    # @param [Integer] value
     #
     # @return [nil]
     #
@@ -92,7 +92,7 @@ module Strings
 
     # Set right padding
     #
-    # @param [Integer] val
+    # @param [Integer] value
     #
     # @api public
     def right=(value)

data/lib/strings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Strings
-  VERSION = '0.1.5'
+  VERSION = "0.1.6"
 end # Strings

data/lib/strings/wrap.rb

@@ -9,12 +9,10 @@ require_relative 'fold'
 module Strings
   module Wrap
     DEFAULT_WIDTH = 80
-
     NEWLINE = "\n".freeze
-
-    SPACE = ' '.freeze
-
-    LINE_BREAK = "\r\n+|\r+|\n+".freeze
+    SPACE = " ".freeze
+    LINE_BREAK = %r{\r\n|\r|\n}.freeze
+    LINE_BREAKS = "\r\n+|\r+|\n+".freeze
 
     # Wrap a text into lines no longer than wrap_at length.
     # Preserves existing lines and existing word boundaries.
@@ -26,14 +24,15 @@ module Strings
     #        >text
     #
     # @api public
-    def wrap(text, wrap_at = DEFAULT_WIDTH)
-      if text.length < wrap_at.to_i || wrap_at.to_i.zero?
+    def wrap(text, wrap_at = DEFAULT_WIDTH, separator: nil)
+      if text.scan(/[[:print:]]/).length < wrap_at.to_i || wrap_at.to_i.zero?
         return text
       end
       ansi_stack = []
-      text.split(%r{#{LINE_BREAK}}, -1).map do |paragraph|
+      sep = separator || text[LINE_BREAK] || NEWLINE
+      text.split(%r{#{LINE_BREAKS}}, -1).map do |paragraph|
         format_paragraph(paragraph, wrap_at, ansi_stack)
-      end * NEWLINE
+      end * sep
     end
     module_function :wrap
 
@@ -70,7 +69,12 @@ module Strings
           elsif ansi_matched
             ansi_stack << [ansi[0...-1].join, line_length + word_length]
             ansi_matched = false
-            ansi = []
+
+            if ansi.last == Strings::ANSI::CSI
+              ansi = [ansi.last]
+            else
+              ansi = []
+            end
           end
           next if ansi.length > 0
         end
@@ -91,26 +95,26 @@ module Strings
         end
 
         if char == SPACE # ends with space
-          lines << insert_ansi(ansi_stack, line.join)
+          lines << insert_ansi(line.join, ansi_stack)
           line = []
           line_length = 0
           word << char
           word_length += char_length
         elsif word_length + char_length <= wrap_at
-          lines << insert_ansi(ansi_stack, line.join)
+          lines << insert_ansi(line.join, ansi_stack)
           line = [word.join + char]
           line_length = word_length + char_length
           word = []
           word_length = 0
         else # hyphenate word - too long to fit a line
-          lines << insert_ansi(ansi_stack, word.join)
+          lines << insert_ansi(word.join, ansi_stack)
           line_length = 0
           word = [char]
           word_length = char_length
         end
       end
-      lines << insert_ansi(ansi_stack, line.join) unless line.empty?
-      lines << insert_ansi(ansi_stack, word.join) unless word.empty?
+      lines << insert_ansi(line.join, ansi_stack) unless line.empty?
+      lines << insert_ansi(word.join, ansi_stack) unless word.empty?
       lines
     end
     module_function :format_paragraph
@@ -120,36 +124,43 @@ module Strings
     # Check if there are any ANSI states, if present
     # insert ANSI codes at given positions unwinding the stack.
     #
-    # @param [Array[Array[String, Integer]]] ansi_stack
-    #   the ANSI codes to apply
-    #
     # @param [String] string
     #   the string to insert ANSI codes into
     #
+    # @param [Array[Array[String, Integer]]] ansi_stack
+    #   the ANSI codes to apply
+    #
     # @return [String]
     #
     # @api private
-    def insert_ansi(ansi_stack, string)
+    def insert_ansi(string, ansi_stack = [])
       return string if ansi_stack.empty?
-      to_remove = 0
-      reset_index = -1
-      output = string.dup
-      resetting = false
-      ansi_stack.reverse_each do |state|
-        if state[0] =~ /#{Regexp.quote(Strings::ANSI::RESET)}/
-          resetting = true
-          reset_index = state[1]
-          to_remove += 2
+      return string if string.empty?
+
+      new_stack = []
+      output          = string.dup
+      length          = string.size
+      matched_reset   = false
+      ansi_reset      = Strings::ANSI::RESET
+
+      # Reversed so that string index don't count ansi
+      ansi_stack.reverse_each do |ansi|
+        if ansi[0] =~ /#{Regexp.quote(ansi_reset)}/
+          matched_reset = true
+          output.insert(ansi[1], ansi_reset)
           next
-        elsif !resetting
-          reset_index = -1
-          resetting = false
+        elsif !matched_reset # ansi without reset
+          matched_reset = false
+          new_stack << ansi # keep the ansi
+          next if ansi[1] == length
+          output.insert(-1, ansi_reset) # add reset at the end
         end
 
-        color, color_index = *state
-        output.insert(reset_index, Strings::ANSI::RESET).insert(color_index, color)
+        output.insert(ansi[1], ansi[0])
       end
-      ansi_stack.pop(to_remove) # remove used states
+
+      ansi_stack.replace(new_stack)
+
       output
     end
     module_function :insert_ansi

data/spec/spec_helper.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 if ENV['COVERAGE'] || ENV['TRAVIS']
   require 'simplecov'
   require 'coveralls'
 
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
     SimpleCov::Formatter::HTMLFormatter,
     Coveralls::SimpleCov::Formatter
-  ]
+  ])
 
   SimpleCov.start do
     command_name 'spec'

data/spec/unit/align/align_left_spec.rb

@@ -59,4 +59,13 @@ RSpec.describe Strings::Align, '#align_left' do
      "outdone by the madness of men***********"
     ].join)
   end
+
+  it "handles \r\n line separator" do
+    text = "Closes #360\r\n\r\nCloses !217"
+    expect(Strings::Align.align_left(text, 27)).to eq([
+      "Closes #360                ",
+      "                           ",
+      "Closes !217                "
+    ].join("\r\n"))
+  end
 end

data/spec/unit/align/align_right_spec.rb

@@ -59,4 +59,13 @@ RSpec.describe Strings::Align, '#align_right' do
      "***********outdone by the madness of men"
     ].join)
   end
+
+  it "handles \r\n line separator" do
+    text = "Closes #360\r\n\r\nCloses !217"
+    expect(Strings::Align.align_right(text, 27)).to eq([
+      "                Closes #360",
+      "                           ",
+      "                Closes !217"
+    ].join("\r\n"))
+  end
 end

data/spec/unit/align/align_spec.rb

@@ -74,4 +74,22 @@ RSpec.describe Strings::Align, '#align' do
       "*****outdone by the madness of men******"
     ].join)
   end
+
+  it "handles \r\n line separator" do
+    text = "Closes #360\r\n\r\nCloses !217"
+    expect(Strings::Align.align(text, 27)).to eq([
+      "Closes #360                ",
+      "                           ",
+      "Closes !217                "
+    ].join("\r\n"))
+  end
+
+  it "handles \r\n line separator and centers" do
+    text = "Closes #360\r\n\r\nCloses !217"
+    expect(Strings::Align.align_center(text, 27)).to eq([
+      "        Closes #360        ",
+      "                           ",
+      "        Closes !217        "
+    ].join("\r\n"))
+  end
 end

data/spec/unit/pad/pad_spec.rb

@@ -60,4 +60,15 @@ RSpec.describe Strings::Pad, '#pad' do
       "                         ",
     ].join("\n"))
   end
+
+  it "handles \r\n line separator" do
+    text = "Closes #360\r\n\r\nCloses !217"
+    expect(Strings::Pad.pad(text, [1,1,1,1])).to eq([
+      "             ",
+      " Closes #360 ",
+      "             ",
+      " Closes !217 ",
+      "             "
+    ].join("\r\n"))
+  end
 end

data/spec/unit/wrap/insert_ansi_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+RSpec.describe "#insert_ansi" do
+  it "doesn't do anything when empty stack" do
+    text = "Ignorance is the parent of fear."
+
+    val = Strings::Wrap.insert_ansi(text, [])
+
+    expect(val).to eq(text)
+  end
+
+  it "inserts ANSI strings in a single line" do
+    text = "Ignorance is the parent of fear."
+    stack = [["\e[32;44m", 0], ["\e[0m", text.size]]
+
+    val = Strings::Wrap.insert_ansi(text, stack)
+
+    expect(val).to eq("\e[32;44mIgnorance is the parent of fear.\e[0m")
+    expect(stack).to eq([])
+  end
+
+  it "inserts ANSI strings with missing reset in a single line" do
+    text = "Ignorance is the parent of fear."
+    stack = [["\e[32;44m", 0]]
+
+    val = Strings::Wrap.insert_ansi(text, stack)
+
+    expect(val).to eq("\e[32;44mIgnorance is the parent of fear.\e[0m")
+    expect(stack).to eq([["\e[32;44m", 0]])
+  end
+
+  it "inserts 3 ansi strings in a single line" do
+    text = "Ignorance is the parent of fear."
+    stack = [
+      ["\e[32m", 0], ["\e[0m", 9],
+      ["\e[33m", 13], ["\e[0m", 16],
+      ["\e[34m", 27], ["\e[0m", 31]
+    ]
+
+    val = Strings::Wrap.insert_ansi(text, stack)
+
+    expect(val).to eq("\e[32mIgnorance\e[0m is \e[33mthe\e[0m parent of \e[34mfear\e[0m.")
+    expect(stack).to eq([])
+  end
+
+  it "inserts nested ANSI strings in a single line" do
+    text = "Ignorance is the parent of fear."
+    stack = [["\e[32m", 10], ["\e[33m", 17], ["\e[0m", 23], ["\e[0m", 26]]
+
+    val = Strings::Wrap.insert_ansi(text, stack)
+
+    expect(val).to eq("Ignorance \e[32mis the \e[33mparent\e[0m of\e[0m fear.")
+    expect(stack).to eq([])
+  end
+
+  it "removes matching pairs of ANSI codes only" do
+    text = "one"
+    stack =  [["\e[32m", 0], ["\e[0m", 3], ["\e[33m", 3]]
+
+    val = Strings::Wrap.insert_ansi(text, stack)
+
+    expect(val).to eq("\e[32mone\e[0m")
+    expect(stack).to eq([["\e[33m", 3]])
+  end
+end

data/spec/unit/wrap/wrap_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe Strings::Wrap, '.wrap' do
   context 'when unicode' do
@@ -16,6 +16,18 @@ RSpec.describe Strings::Wrap, '.wrap' do
       expect(Strings::Wrap.wrap(text, 100)).to eq(text)
     end
 
+    it "wraps minimal width" do
+      str = "#?%"
+
+      val = Strings::Wrap.wrap(str, 1)
+
+      expect(val).to eq([
+        "#",
+        "?",
+        "%"
+      ].join("\n"))
+    end
+
     it "wraps correctly unbreakable words" do
       expect(Strings::Wrap.wrap('foobar1', 3)).to eq([
         "foo",
@@ -34,7 +46,7 @@ RSpec.describe Strings::Wrap, '.wrap' do
         "  ",
         "conte",
         "nt "
-      ].join("\n"))
+      ].join("\r\n"))
     end
 
     it "preserves newlines" do
@@ -113,6 +125,11 @@ RSpec.describe Strings::Wrap, '.wrap' do
         "も含み\n"
       ].join("\n"))
     end
+
+    it "handles \r\n line separator" do
+      text = "Closes #360\r\n\r\nCloses !217"
+      expect(Strings::Wrap.wrap(text, 15)).to eq(text)
+    end
   end
 
   context 'with ANSI codes' do
@@ -151,5 +168,40 @@ RSpec.describe Strings::Wrap, '.wrap' do
         "insulted me."
       ].join("\n"))
     end
+
+    it "applies ANSI codes when below wrap width" do
+      str = "\e[32mone\e[0m\e[33mtwo\e[0m"
+
+      val = Strings::Wrap.wrap(str, 6)
+
+      expect(val).to eq("\e[32mone\e[0m\e[33mtwo\e[0m")
+    end
+
+    xit "splits ANSI codes matching wrap width with space between codes" do
+      str = "\e[32mone\e[0m \e[33mtwo\e[0m"
+
+      val = Strings::Wrap.wrap(str, 3)
+
+      expect(val).to eq("\e[32mone\e[0m\n\e[33mtwo\e[0m")
+    end
+
+    xit "splits ANSI codes matching wrap width" do
+      str = "\e[32mone\e[0m\e[33mtwo\e[0m"
+
+      val = Strings::Wrap.wrap(str, 3)
+
+      expect(val).to eq("\e[32mone\e[0m\n\e[33mtwo\e[0m")
+    end
+
+    xit "wraps deeply nested ANSI codes correctly" do
+      str = "\e[32mone\e[33mtwo\e[0m\e[0m"
+
+      val = Strings::Wrap.wrap(str, 3)
+
+      expect(val).to eq([
+        "\e[32mone\e[0m",
+        "\e[33mtwo\e[0m",
+      ].join("\n"))
+    end
   end
 end

data/tasks/console.rake

@@ -1,10 +1,8 @@
-# encoding: utf-8
-
-desc 'Load gem inside irb console'
+desc "Load gem inside irb console"
 task :console do
-  require 'irb'
-  require 'irb/completion'
-  require File.join(__FILE__, '../../lib/tty-reader')
+  require "irb"
+  require "irb/completion"
+  require File.join(__FILE__, "../../lib/strings")
   ARGV.clear
   IRB.start
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strings
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strings-ansi
@@ -132,6 +132,7 @@ files:
 - spec/unit/sanitize_spec.rb
 - spec/unit/truncate/truncate_spec.rb
 - spec/unit/truncate_spec.rb
+- spec/unit/wrap/insert_ansi_spec.rb
 - spec/unit/wrap/wrap_spec.rb
 - spec/unit/wrap_spec.rb
 - strings.gemspec