strings 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f0c1f1d9734d9a20fa740876e47ab98722911deb76c564199562a70ec02459d
-  data.tar.gz: 625b86584afb6a40eccca247e4bf2caf8ef4fcabc6aaeb38808c20d3566383a0
+  metadata.gz: 2c169560954048d363eb109d4c2098c122d2882d3a4f52ba41065cf9ec14411e
+  data.tar.gz: 051f5e21eb97227609ccc87f4e46b13c9ab48d9bf181435599872f335756b74e
 SHA512:
-  metadata.gz: 278e68155478185904c5ce9348f1d364e78a40108a05c58302f54210a43973e058b4e8ceec7b1b82bc03ee8b67bbf600c065cdb1c8e308fb55a4a42383e6ffb6
-  data.tar.gz: c3605edfbc62617c18e7de90c1efe773cbee290b335c29fb43dd30164265fcadac5ec4ed58acffd3d9850214ce99629f1a8a58ab401ef3448d8352c21597b566
+  metadata.gz: 27f4263a2874d1b3cee622a31254cf63dcd92d88c19208339f984ddbb3193088ff7fab4a5d0768114c262a57c70320c11534ef4e5eb1eb75521e677c58505776
+  data.tar.gz: ec8ee3980d43c8a7e7481c5e6b1c3d60d4423e7fa3eaaebffc49b2dfd558a019e073a4267283e1ef6008bf5fa2699ef9e1f86f45e538445f99e337dbccd8ee54

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## [v0.1.3] - 2018-08-28
+
+### Changed
+* Change to extract Strings::ANSI to strings-ansi gem
+
 ## [v0.1.2] - 2018-08-10
 
 ### Changed
@@ -14,6 +19,7 @@
 
 * Inital implementation and release
 
-[v0.1.2]: https://github.com/piotrmurach/verse/compare/v0.1.1...v0.1.2
-[v0.1.1]: https://github.com/piotrmurach/verse/compare/v0.1.0...v0.1.1
-[v0.1.0]: https://github.com/piotrmurach/verse/compare/v0.1.0
+[v0.1.3]: https://github.com/piotrmurach/strings/compare/v0.1.1...v0.1.3
+[v0.1.2]: https://github.com/piotrmurach/strings/compare/v0.1.1...v0.1.2
+[v0.1.1]: https://github.com/piotrmurach/strings/compare/v0.1.0...v0.1.1
+[v0.1.0]: https://github.com/piotrmurach/strings/compare/v0.1.0

data/README.md

@@ -56,6 +56,7 @@ Or install it yourself as:
   * [2.6 truncate](#26-truncate)
   * [2.7 wrap](#27-wrap)
 * [3. Extending String class](#3-extending-string-class)
+* [4. Utilities](#4-utilities)
 
 ## 1. Usage
 
@@ -367,6 +368,14 @@ require 'strings/extensions'
 using Strings::Extensions
 ```
 
+## 4. Utilities
+
+**Strings** aims to be fleaxible and allow you to choose only the utilities that you need. Currently you can choose from:
+
+|  Utility     | Description | API docs |
+| ------------ | ----------- | -------- |
+| [strings-ansi](https://github.com/piotrmurach/strings-ansi) | Handle ANSI escape codes in strings. | [docs](http://www.rubydoc.info/gems/strings-ansi) |
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/strings.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
+require 'strings-ansi'
+
 require_relative 'strings/align'
-require_relative 'strings/ansi'
 require_relative 'strings/fold'
 require_relative 'strings/pad'
 require_relative 'strings/truncate'
@@ -84,8 +85,8 @@ module Strings
   # @see Strings::ANSI#sanitize
   #
   # @api public
-  def sanitize(text)
-    ANSI.sanitize(text)
+  def sanitize(string)
+    ANSI.sanitize(string)
   end
   module_function :sanitize
 

data/lib/strings/align.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
+require 'strings-ansi'
 require 'unicode/display_width'
 
-require_relative 'ansi'
-
 module Strings
   # Responsible for text alignment
   module Align

data/lib/strings/pad.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
+require 'strings-ansi'
 require 'unicode/display_width'
 
-require_relative 'ansi'
 require_relative 'padder'
 
 module Strings

data/lib/strings/truncate.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
+require 'strings-ansi'
 require 'unicode/display_width'
 require 'unicode_utils/each_grapheme'
 
-require_relative 'ansi'
-
 module Strings
   # A module responsible for text truncation
   module Truncate

data/lib/strings/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Strings
-  VERSION = '0.1.2'.freeze
-end
+  VERSION = '0.1.3'
+end # Strings

data/lib/strings/wrap.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
+require 'strings-ansi'
 require 'unicode/display_width'
 require 'unicode_utils/each_grapheme'
 
-require_relative 'ansi'
 require_relative 'fold'
 
 module Strings

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+if ENV['COVERAGE'] || ENV['TRAVIS']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require "bundler/setup"
+require "strings"
+
+module Helpers
+  def unindent(text)
+    text.gsub(/^[ \t]*/, '').chomp
+  end
+end
+
+RSpec.configure do |config|
+  config.include(Helpers)
+
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/unit/align/align_left_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings::Align, '#align_left' do
+  it "aligns line to left" do
+    text = "the madness of men"
+    expect(Strings::Align.align_left(text, 22)).to eq("the madness of men    ")
+  end
+
+  it "fills empty" do
+    expect(Strings::Align.align_left('', 22)).to eq("                      ")
+  end
+
+  it "left justifies string with unicode characters" do
+    text = "こんにちは"
+    expect(Strings::Align.align(text, 20, direction: :left)).to eq("こんにちは          ")
+  end
+
+  it "left justifies string with ansi codes" do
+    text = "\e[32mthe madness of men\e[0m"
+    expect(Strings::Align.align(text, 22, direction: :left)).to eq("\e[32mthe madness of men\e[0m    ")
+  end
+
+  it "aligns multiline text to left" do
+    text = "for there is no folly of the beast\nof the earth which\nis not infinitely\noutdone by the madness of men"
+    expect(Strings::Align.align_left(text, 40)).to eq([
+     "for there is no folly of the beast      \n",
+     "of the earth which                      \n",
+     "is not infinitely                       \n",
+     "outdone by the madness of men           "
+    ].join)
+  end
+
+  it "left justifies multiline utf text" do
+    text = "ラドクリフ\n、マラソン五輪\n代表に1万m出\n場にも含み"
+    expect(Strings::Align.align_left(text, 20)).to eq([
+      "ラドクリフ          \n",
+      "、マラソン五輪      \n",
+      "代表に1万m出        \n",
+      "場にも含み          "
+    ].join)
+  end
+
+  it "left justifies ansi text" do
+    text = "for \e[35mthere\e[0m is no folly of the beast\nof the \e[33mearth\e0m which\nis \e[34mnot infinitely\e[0m\n\e[33moutdone\e[0m by the madness of men"
+    expect(Strings::Align.align_left(text, 40)).to eq([
+     "for \e[35mthere\e[0m is no folly of the beast      \n",
+     "of the \e[33mearth\e0m which                      \n",
+     "is \e[34mnot infinitely\e[0m                       \n",
+     "\e[33moutdone\e[0m by the madness of men           "
+    ].join)
+  end
+
+  it "left justifies multiline text with fill of '*'" do
+    text = "for there is no folly of the beast\nof the earth which\nis not infinitely\noutdone by the madness of men"
+    expect(Strings::Align.align_left(text, 40, fill: '*')).to eq([
+     "for there is no folly of the beast******\n",
+     "of the earth which**********************\n",
+     "is not infinitely***********************\n",
+     "outdone by the madness of men***********"
+    ].join)
+  end
+end

data/spec/unit/align/align_right_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings::Align, '#align_right' do
+  it "aligns line to right" do
+    text = "the madness of men"
+    expect(Strings::Align.align_right(text, 22)).to eq("    the madness of men")
+  end
+
+  it "fills empty" do
+    expect(Strings::Align.align_right('', 22)).to eq("                      ")
+  end
+
+  it "aligns string to the right with unicode characters" do
+    text = "こんにちは"
+    expect(Strings::Align.align(text, 20, direction: :right)).to eq("          こんにちは")
+  end
+
+  it "aligns string to the right with ansi codees" do
+    text = "\e[32mthe madness of men\e[0m"
+    expect(Strings::Align.align(text, 22, direction: :right)).to eq("    \e[32mthe madness of men\e[0m")
+  end
+
+  it "aligns multiline text to the right" do
+    text = "for there is no folly of the beast\n of the earth which\n is not infinitely\n outdone by the madness of men"
+    expect(Strings::Align.align_right(text, 40)).to eq([
+     "      for there is no folly of the beast\n",
+     "                      of the earth which\n",
+     "                       is not infinitely\n",
+     "           outdone by the madness of men"
+    ].join)
+  end
+
+  it "aligns multiline text to right with unicode characters" do
+    text = "ラドクリフ\n、マラソン五輪\n代表に1万m出\n場にも含み"
+    expect(Strings::Align.align_right(text, 20)).to eq([
+      "          ラドクリフ\n",
+      "      、マラソン五輪\n",
+      "        代表に1万m出\n",
+      "          場にも含み"
+    ].join)
+  end
+
+  it "right justfies ansi text" do
+    text = "for \e[35mthere\e[0m is no folly of the beast\nof the \e[33mearth\e0m which\nis \e[34mnot infinitely\e[0m\n\e[33moutdone\e[0m by the madness of men"
+    expect(Strings::Align.align_right(text, 40)).to eq([
+     "      for \e[35mthere\e[0m is no folly of the beast\n",
+     "                      of the \e[33mearth\e0m which\n",
+     "                       is \e[34mnot infinitely\e[0m\n",
+     "           \e[33moutdone\e[0m by the madness of men"
+    ].join)
+  end
+
+  it "right justifies multiline text with fill of '*'" do
+    text = "for there is no folly of the beast\nof the earth which\nis not infinitely\noutdone by the madness of men"
+    expect(Strings::Align.align_right(text, 40, fill: '*')).to eq([
+     "******for there is no folly of the beast\n",
+     "**********************of the earth which\n",
+     "***********************is not infinitely\n",
+     "***********outdone by the madness of men"
+    ].join)
+  end
+end

data/spec/unit/align/align_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings::Align, '#align' do
+  it "doesn't align unrecognized direction" do
+    text = "the madness of men"
+    expect {
+      Strings::Align.align(text, 22, direction: :unknown)
+    }.to raise_error(ArgumentError, /Unknown alignment/)
+  end
+
+  it "fills empty" do
+    expect(Strings::Align.align('', 22, direction: :center)).to eq("                      ")
+  end
+
+  it "centers line" do
+    text = "the madness of men"
+    expect(Strings::Align.align_center(text, 22)).to eq("  the madness of men  ")
+  end
+
+  it "centers unicode characters" do
+    text = "こんにちは"
+    expect(Strings::Align.align_center(text, 20)).to eq("     こんにちは     ")
+  end
+
+  it "centers string with ansi codes" do
+    text = "\e[32mthe madness of men\e[0m"
+    expect(Strings::Align.align_center(text, 22)).to eq("  \e[32mthe madness of men\e[0m  ")
+  end
+
+  it "centers multiline text" do
+    text = "for there is no folly of the beast\nof the earth which\nis not infinitely\noutdone by the madness of men"
+    expect(Strings::Align.align_center(text, 40)).to eq([
+     "   for there is no folly of the beast   \n",
+     "           of the earth which           \n",
+     "           is not infinitely            \n",
+     "     outdone by the madness of men      "
+    ].join)
+  end
+
+  it "centers multiline unicode text" do
+    text = "ラドクリフ\n、マラソン五輪\n代表に1万m出\n場にも含み"
+    expect(Strings::Align.align_center(text, 20)).to eq([
+      "     ラドクリフ     \n",
+      "   、マラソン五輪   \n",
+      "    代表に1万m出    \n",
+      "     場にも含み     "
+    ].join)
+  end
+
+  it "centers text with ansi codes" do
+    text = "for \e[35mthere\e[0m is no folly of the beast\nof the \e[33mearth\e0m which\nis \e[34mnot infinitely\e[0m\n\e[33moutdone\e[0m by the madness of men"
+    expect(Strings::Align.align_center(text, 40)).to eq([
+     "   for \e[35mthere\e[0m is no folly of the beast   \n",
+     "           of the \e[33mearth\e0m which           \n",
+     "           is \e[34mnot infinitely\e[0m            \n",
+     "     \e[33moutdone\e[0m by the madness of men      "
+    ].join)
+  end
+
+  it "centers multiline text with fill character '*'" do
+    text = "for there is no folly of the beast\nof the earth which\nis not infinitely\noutdone by the madness of men"
+    expect(Strings::Align.align(text, 40, direction: :center, fill: '*')).to eq([
+     "***for there is no folly of the beast***\n",
+     "***********of the earth which***********\n",
+     "***********is not infinitely************\n",
+     "*****outdone by the madness of men******"
+    ].join)
+  end
+end

data/spec/unit/align_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings, '#align' do
+  it "aligns text" do
+    text = "the madness of men"
+    expect(Strings.align(text, 22, direction: :center)).to eq("  the madness of men  ")
+  end
+
+  it "aligns text to left" do
+    text = "the madness of men"
+    expect(Strings.align_left(text, 22)).to eq("the madness of men    ")
+  end
+
+  it "aligns text to right" do
+    text = "the madness of men"
+    expect(Strings.align_right(text, 22)).to eq("    the madness of men")
+  end
+end

data/spec/unit/ansi_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings, '#ansi?' do
+  it "checks if string has any ansi codes" do
+    expect(Strings.ansi?("\e[33mfoo\e[0m")).to eq(true)
+  end
+end

data/spec/unit/extensions_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'strings/extensions'
+
+using Strings::Extensions
+
+RSpec.describe Strings::Extensions do
+  let(:text) { "the madness of men" }
+
+  it "aligns a line in the center" do
+    expect(text.align(22, direction: :center)).to eq("  the madness of men  ")
+  end
+
+  it "aligns a line to the left" do
+    expect(text.align_left(22)).to eq("the madness of men    ")
+  end
+
+  it "aligns a line to the right" do
+    expect(text.align_right(22)).to eq("    the madness of men")
+  end
+
+  it "checks for ansi" do
+    expect("\e[33mfoo\e[0m".ansi?).to eq(true)
+  end
+
+  it "removes ansi codes" do
+    expect("\e[33mfoo\e[0m".sanitize).to eq('foo')
+  end
+
+  it "folds a line" do
+    expect("foo\n\nbar\n".fold).to eq('foo bar ')
+  end
+
+  it "pads a line" do
+    expect(text.pad(1)).to eq([
+      " " * (text.size + 2),
+      " #{text} ",
+      " " * (text.size + 2),
+    ].join("\n"))
+  end
+
+  it "truncates a line" do
+    text = "the madness of men"
+    expect(text.truncate(10)).to eq('the madn…')
+  end
+
+  it "wraps a line" do
+    expect('foobar1'.wrap(3)).to eq("foo\nbar\n1")
+  end
+end
+

data/spec/unit/fold/fold_spec.rb

@@ -0,0 +1,28 @@
+# unicode: utf-8
+# frozen_string_literals: true
+
+RSpec.describe Strings, '#fold' do
+  {
+    "  \n"      => '  ',
+    "\n  "      => '  ',
+    "\n"        => ' ',
+    "\n\n\n"    => ' ',
+    " \n "      => '  ',
+    " \n \n \n" => '   '
+  }.each do |actual, expected|
+    it "removes newline '#{actual.gsub(/\n/, '\\n')}' to '#{expected}'" do
+      expect(Strings::Fold.fold(actual)).to eq(expected)
+    end
+  end
+
+  {
+    "  \r\n" => '  ',
+    "\r\n  " => '  ',
+    "\r\n"   => ' ',
+    " \r\n " => '  ',
+  }.each do |actual, expected|
+    it "squashes '#{actual.gsub(/\r\n/, '\\r\\n')}' to '#{expected}'" do
+      expect(Strings::Fold.fold(actual, "\r\n")).to eq(expected)
+    end
+  end
+end

data/spec/unit/fold_spec.rb

@@ -0,0 +1,7 @@
+# fronzen_string_literal: true
+
+RSpec.describe Strings, '#fold' do
+  it "folds a multiline text into a single line" do
+    expect(Strings.fold("\tfoo \r\n\n\n bar")).to eq(" foo  bar")
+  end
+end

data/spec/unit/pad/pad_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings::Pad, '#pad' do
+  it "pads content with padding as a single value" do
+    text = "Ignorance is the parent of fear."
+    expect(Strings::Pad.pad(text, 1)).to eq([
+      "                                  ",
+      " Ignorance is the parent of fear. ",
+      "                                  ",
+    ].join("\n"))
+  end
+
+  it "pads content with specific padding as an array" do
+    text = "Ignorance is the parent of fear."
+    expect(Strings::Pad.pad(text, [1,1,1,1])).to eq([
+      "                                  ",
+      " Ignorance is the parent of fear. ",
+      "                                  ",
+    ].join("\n"))
+  end
+
+  it "pads with custom character" do
+    text = "Ignorance is the parent of fear."
+    expect(Strings::Pad.pad(text, [1, 2], fill: "*")).to eq([
+      "************************************",
+      "**Ignorance is the parent of fear.**",
+      "************************************",
+    ].join("\n"))
+  end
+
+  it "pads unicode content" do
+    text = "ラドクリフ、マラソン"
+    expect(Strings::Pad.pad(text, [1,1,1,1])).to eq([
+      "                      ",
+      " ラドクリフ、マラソン ",
+      "                      "
+    ].join("\n"))
+  end
+
+  it "pads multiline content" do
+    text = "It is the easiest thing\nin the world for a man\nto look as if he had \na great secret in him."
+    expect(Strings::Pad.pad(text, [1,2])).to eq([
+      "                           ",
+      "  It is the easiest thing  ",
+      "  in the world for a man  ",
+      "  to look as if he had   ",
+      "  a great secret in him.  ",
+      "                           ",
+    ].join("\n"))
+  end
+
+  it "pads ANSI codes inside content" do
+    text = "It is \e[35mthe easiest\e[0m thing\nin the \e[34mworld\e[0m for a man\nto look as if he had \na great \e[33msecret\e[0m in him."
+    expect(Strings::Pad.pad(text, [1,1,1,1])).to eq([
+      "                         ",
+      " It is \e[35mthe easiest\e[0m thing ",
+      " in the \e[34mworld\e[0m for a man ",
+      " to look as if he had  ",
+      " a great \e[33msecret\e[0m in him. ",
+      "                         ",
+    ].join("\n"))
+  end
+end

data/spec/unit/pad_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings, '#pad' do
+  it "pads text" do
+    text = 'ラドクリフ、マラソン五輪代表に1万m出場にも含み'
+    expect(Strings.pad(text, [1,1,1,1])).to eql([
+      '                                                ',
+      ' ラドクリフ、マラソン五輪代表に1万m出場にも含み ',
+      '                                                '
+    ].join("\n"))
+  end
+end

data/spec/unit/padder/parse_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal:true
+
+RSpec.describe Strings::Padder, '#parse' do
+  it "parses nil" do
+    instance = Strings::Padder.parse(nil)
+    expect(instance.padding).to eq([])
+  end
+
+  it 'parses self' do
+    value = Strings::Padder.new([])
+    instance = Strings::Padder.parse(value)
+    expect(instance.padding).to eq([])
+  end
+
+  it "parses digit" do
+    instance = Strings::Padder.parse(5)
+    expect(instance.padding).to eq([5,5,5,5])
+  end
+
+  it "parses 2-element array" do
+    instance = Strings::Padder.parse([2,3])
+    expect(instance.padding).to eq([2,3,2,3])
+  end
+
+  it "parses 4-element array" do
+    instance = Strings::Padder.parse([1,2,3,4])
+    expect(instance.padding).to eq([1,2,3,4])
+  end
+
+  it "fails to parse unknown value" do
+    expect {
+      Strings::Padder.parse(:unknown)
+    }.to raise_error(Strings::Padder::ParseError)
+  end
+end

data/spec/unit/sanitize_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings, '#sanitize' do
+  it "removes ansi codes" do
+    expect(Strings.sanitize("\e[33mfoo\e[0m")).to eq('foo')
+  end
+end

data/spec/unit/truncate/truncate_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings::Truncate, '#truncate' do
+  let(:text) { 'ラドクリフ、マラソン五輪代表に1万m出場にも含み' }
+
+  it "doesn't change text for 0 length" do
+    expect(Strings::Truncate.truncate(text, 0)).to eq(text)
+  end
+
+  it "doensn't change text for nil length" do
+    expect(Strings::Truncate.truncate(text, nil)).to eq(text)
+  end
+
+  it "doesn't change text for equal length" do
+    truncation = Strings::Truncate.truncate(text, text.length * 2)
+    expect(truncation).to eq(text)
+  end
+
+  it 'truncates text and displays omission' do
+    trailing = '…'
+    expect(Strings::Truncate.truncate(text, 12)).to eq("ラドクリフ#{trailing}")
+  end
+
+  it "estimates total width correctly " do
+    text = '太丸ゴシック体'
+    trailing = '…'
+    expect(Strings::Truncate.truncate(text, 8)).to eq("太丸ゴ#{trailing}")
+  end
+
+  it "doesn't truncate text when length exceeds content" do
+    expect(Strings::Truncate.truncate(text, 100)).to eq(text)
+  end
+
+  it "doesn't truncate whole words" do
+    text = "I know not all that may be coming, but be it what it will, I'll go to it laughing."
+    trailing = '…'
+    truncation = Strings::Truncate.truncate(text, separator: ' ')
+    expect(truncation).to eq("I know not all that may be#{trailing}")
+  end
+
+  it 'truncates text with string separator' do
+    trailing = '…'
+    truncation = Strings::Truncate.truncate(text, 12, separator: '')
+    expect(truncation).to eq("ラドクリフ#{trailing}")
+  end
+
+  it 'truncates text with regex separator' do
+    trailing = '…'
+    truncation = Strings::Truncate.truncate(text, 12, separator: /\s/)
+    expect(truncation).to eq("ラドクリフ#{trailing}")
+  end
+
+  it 'truncates text with custom trailing' do
+    trailing = '... (see more)'
+    truncation = Strings::Truncate.truncate(text, 20, trailing: trailing)
+    expect(truncation).to eq("ラド#{trailing}")
+  end
+
+  it 'correctly truncates with ANSI characters' do
+    text = "I try \e[34mall things\e[0m, I achieve what I can"
+    truncation = Strings::Truncate.truncate(text, 18)
+    expect(truncation).to eq("I try \e[34mall things\e[0m…")
+  end
+
+  it "finishes on word boundary" do
+    text = "for there is no folly of the beast of the earth"
+    truncation = Strings::Truncate.truncate(text, 20, separator: ' ')
+    expect(truncation).to eq('for there is no…')
+  end
+end

data/spec/unit/truncate_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings, '#truncate' do
+  it "truncates text" do
+    text = 'ラドクリフ、マラソン五輪代表に1万m出場にも含み'
+    expect(Strings.truncate(text, 12)).to eq('ラドクリフ…')
+  end
+end

data/spec/unit/wrap/wrap_spec.rb

@@ -0,0 +1,155 @@
+# encoding: utf-8
+
+RSpec.describe Strings::Wrap, '.wrap' do
+  context 'when unicode' do
+    let(:text) { 'ラドクリフ、マラソン五輪代表に1万m出場にも含み' }
+
+    it "doesn't wrap at zero length" do
+      expect(Strings::Wrap.wrap(text, 0)).to eq(text)
+    end
+
+    it "doesn't wrap at nil length" do
+      expect(Strings::Wrap.wrap(text, nil)).to eq(text)
+    end
+
+    it "doesn't wrap at length exceeding content length" do
+      expect(Strings::Wrap.wrap(text, 100)).to eq(text)
+    end
+
+    it "wraps correctly unbreakable words" do
+      expect(Strings::Wrap.wrap('foobar1', 3)).to eq([
+        "foo",
+        "bar",
+        "1"
+      ].join("\n"))
+    end
+
+    it "collapses multiple line breaks " do
+      text = "some \r\n\n\n\nunbreakable\n\n\n\n  \r\r\rcontent \t"
+      expect(Strings::Wrap.wrap(text, 5)).to eq([
+        "some ",
+        "unbre",
+        "akabl",
+        "e",
+        "  ",
+        "conte",
+        "nt "
+      ].join("\n"))
+    end
+
+    it "preserves newlines" do
+      text = "It is not down\n on any map;\n true places never are."
+      expect(Strings::Wrap.wrap(text, 10)).to eq([
+        "It is not ",
+        "down",
+        " on any ",
+        "map;",
+        " true ",
+        "places ",
+        "never are."
+      ].join("\n"))
+    end
+
+    it "wraps ascii text" do
+      text = "for there is no folly of the beast of the earth which is not infinitely outdone by the madness of men "
+      expect(Strings::Wrap.wrap(text, 16)).to eq([
+        "for there is no ",
+        "folly of the ",
+        "beast of the ",
+        "earth which is ",
+        "not infinitely ",
+        "outdone by the ",
+        "madness of men "
+      ].join("\n"))
+    end
+
+    it 'wraps at 8 characters' do
+      expect(Strings::Wrap.wrap(text, 8)).to eq([
+        "ラドクリ",
+        "フ、マラ",
+        "ソン五輪",
+        "代表に1",
+        "万m出場",
+        "にも含み"
+      ].join("\n"))
+    end
+
+    it 'preserves whitespace' do
+      text = "  As for me,   I am    tormented with   an everlasting   itch for   things remote.  "
+      expect(Strings::Wrap.wrap(text, 10)).to eq([
+        "  As for ",
+        "me,   I ",
+        "am    ",
+        "tormented ",
+        "with   an ",
+        "e",
+        "verlasting",
+        "   itch ",
+        "for   ",
+        "things ",
+        "remote.  "
+      ].join("\n"))
+    end
+  end
+
+  context 'when long text' do
+    it "wraps long text at 45 characters" do
+      text =
+      "What of it, if some old hunks of a sea-captain orders me to get a broom and sweep down the decks? What does that indignity amount to, weighed, I mean, in the scales of the New Testament? Do you think the archangel Gabriel thinks anything the less of me, because I promptly and respectfully obey that old hunks in that particular instance? Who ain't a slave? Tell me that. Well, then, however the old sea-captains may order me about--however they may thump and punch me about, I have the satisfaction of knowing that it is all right;"
+      expect(Strings::Wrap.wrap(text, 45)).to eq unindent <<-EOS
+    What of it, if some old hunks of a \nsea-captain orders me to get a broom and \n sweep down the decks? What does that \nindignity amount to, weighed, I mean, in the \n scales of the New Testament? Do you think \nthe archangel Gabriel thinks anything the \nless of me, because I promptly and \nrespectfully obey that old hunks in that \nparticular instance? Who ain't a slave? Tell \nme that. Well, then, however the old \nsea-captains may order me about--however \nthey may thump and punch me about, I have \nthe satisfaction of knowing that it is all \nright;
+      EOS
+    end
+  end
+
+  context 'with newlines' do
+    it "preserves newlines for both prefix and postfix" do
+      text = "\n\nラドクリフ、マラソン五輪代表に1万m出場にも含み\n\n\n"
+      expect(Strings::Wrap.wrap(text, 10)).to eq([
+        "\nラドクリフ",
+        "、マラソン",
+        "五輪代表に",
+        "1万m出場に",
+        "も含み\n"
+      ].join("\n"))
+    end
+  end
+
+  context 'with ANSI codes' do
+    it "wraps ANSI chars" do
+      text = "\e[32;44mIgnorance is the parent of fear.\e[0m"
+      expect(Strings::Wrap.wrap(text, 14)).to eq([
+        "\e[32;44mIgnorance is \e[0m",
+        "\e[32;44mthe parent of \e[0m",
+        "\e[32;44mfear.\e[0m",
+      ].join("\n"))
+    end
+
+    it "wraps ANSI in the middle of text" do
+      text = "Ignorance is the \e[32mparent\e[0m of fear."
+      expect(Strings::Wrap.wrap(text, 14)).to eq([
+        "Ignorance is ",
+        "the \e[32mparent\e[0m of ",
+        "fear.",
+      ].join("\n"))
+    end
+
+    it "wraps multline ANSI codes" do
+      text = "\e32;44mMulti\nLine\nContent.\e[0m"
+      expect(Strings::Wrap.wrap(text, 14)).to eq([
+        "\e32;44mMulti\e[0m",
+        "\e32;44mLine\e[0m",
+        "\e32;44mContent.\e[0m",
+      ].join("\n"))
+    end
+
+    it "wraps multiple ANSI codes in a single line" do
+      text = "Talk \e[32mnot\e[0m to me of \e[33mblasphemy\e[0m, man; I'd \e[35mstrike the sun\e[0m if it insulted me."
+      expect(Strings::Wrap.wrap(text, 30)).to eq([
+        "Talk \e[32mnot\e[0m to me of \e[33mblasphemy\e[0m, ",
+        "man; I'd \e[35mstrike the sun\e[0m if it ",
+        "insulted me."
+      ].join("\n"))
+    end
+  end
+end

data/spec/unit/wrap_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+RSpec.describe Strings, '#wrap' do
+  it "wraps text" do
+    text = 'ラドクリフ、マラソン五輪代表に1万m出場にも含み'
+    expect(Strings.wrap(text, 8)).to eql([
+      "ラドクリ",
+      "フ、マラ",
+      "ソン五輪",
+      "代表に1",
+      "万m出場",
+      "にも含み"
+    ].join("\n"))
+  end
+end

data/strings.gemspec

@@ -14,13 +14,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = ""
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files         = Dir['{lib,spec}/**/*.rb', '{bin,tasks}/*', 'strings.gemspec']
+  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'strings-ansi',         '~> 0.1.0'
   spec.add_dependency 'unicode_utils',        '~> 1.4.0'
   spec.add_dependency 'unicode-display_width','~> 1.4.0'
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: strings
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-10 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: strings-ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: unicode_utils
   requirement: !ruby/object:Gem::Requirement
@@ -88,23 +102,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
-- assets/strings_logo.png
-- benchmarks/speed_profile.rb
 - bin/console
 - bin/setup
 - lib/strings.rb
 - lib/strings/align.rb
-- lib/strings/ansi.rb
 - lib/strings/extensions.rb
 - lib/strings/fold.rb
 - lib/strings/pad.rb
@@ -112,6 +117,23 @@ files:
 - lib/strings/truncate.rb
 - lib/strings/version.rb
 - lib/strings/wrap.rb
+- spec/spec_helper.rb
+- spec/unit/align/align_left_spec.rb
+- spec/unit/align/align_right_spec.rb
+- spec/unit/align/align_spec.rb
+- spec/unit/align_spec.rb
+- spec/unit/ansi_spec.rb
+- spec/unit/extensions_spec.rb
+- spec/unit/fold/fold_spec.rb
+- spec/unit/fold_spec.rb
+- spec/unit/pad/pad_spec.rb
+- spec/unit/pad_spec.rb
+- spec/unit/padder/parse_spec.rb
+- spec/unit/sanitize_spec.rb
+- spec/unit/truncate/truncate_spec.rb
+- spec/unit/truncate_spec.rb
+- spec/unit/wrap/wrap_spec.rb
+- spec/unit/wrap_spec.rb
 - strings.gemspec
 - tasks/console.rake
 - tasks/coverage.rake

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,4 +0,0 @@
---format documentation
---color
---require spec_helper
---warnings

data/.travis.yml

@@ -1,23 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-before_install: "gem update bundler"
-script: "bundle exec rake ci"
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.4
-  - 2.5.1
-  - ruby-head
-  - jruby-9.1.5.0
-  - jruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-  fast_finish: true
-branches:
-  only: master

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,15 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-gemspec
-
-group :metrics do
-  gem 'coveralls', '~> 0.8.22'
-  gem 'simplecov', '~> 0.16.1'
-  gem 'yardstick', '~> 0.9.9'
-end
-
-group :benchmarks do
-  gem 'benchmark-ips', '~> 2.7.2'
-end

data/appveyor.yml

@@ -1,23 +0,0 @@
----
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle install
-build: off
-test_script:
-  - bundle exec rake ci
-environment:
-  matrix:
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
-    - ruby_version: "22"
-    - ruby_version: "22-x64"
-    - ruby_version: "23"
-    - ruby_version: "23-x64"
-    - ruby_version: "24"
-    - ruby_version: "24-x64"
-    - ruby_version: "25"
-    - ruby_version: "25-x64"

data/benchmarks/speed_profile.rb

@@ -1,30 +0,0 @@
-require 'benchmark/ips'
-require 'strings'
-
-text = "Ignorance is the parent of fear."
-
-Benchmark.ips do |x|
-  x.report('wrap') do
-    Strings::Wrap.wrap(text, 10)
-  end
-
-  x.report('truncate') do
-    Strings::Truncate.truncate(text, 10)
-  end
-
-  x.compare!
-end
-
-# (2017-12-09)
-#
-# Calculating -------------------------------------
-#                 wrap       186 i/100ms
-#             truncate       295 i/100ms
-# -------------------------------------------------
-#                 wrap     1917.2 (±2.2%) i/s -       9672 in   5.047297s
-#             truncate     3020.6 (±3.0%) i/s -      15340 in   5.083516s
-#
-# Comparison:
-#             truncate:     3020.6 i/s
-#                 wrap:     1917.2 i/s - 1.58x slower
-#

data/lib/strings/ansi.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module Strings
-  # Helper functions for handling ANSI escape sequences
-  module ANSI
-    # The control sequence indicator
-    CSI = "\033".freeze
-
-    # The code for reseting styling
-    RESET = "\e[0m".freeze
-
-    # The regex to match ANSI codes
-    ANSI_MATCHER = '(\[)?\033(\[)?[;?\d]*[\dA-Za-z]([\];])?'.freeze
-
-    # Remove ANSI characters from the text
-    #
-    # @param [String] text
-    #
-    # @example
-    #   Strings::ANSI.sanitize("\e[33mfoo\[e0m")
-    #   # => "foo"
-    #
-    # @return [String]
-    #
-    # @api public
-    def sanitize(text)
-      text.gsub(/#{ANSI_MATCHER}/, '')
-    end
-    module_function :sanitize
-
-    # Check if string contains ANSI codes
-    #
-    # @param [String] string
-    #   the string to check
-    #
-    # @example
-    #   Strings::ANSI.ansi?("\e[33mfoo\[e0m")
-    #   # => true
-    #
-    # @return [Boolean]
-    #
-    # @api public
-    def ansi?(string)
-      !!(string =~ /#{ANSI_MATCHER}/)
-    end
-    module_function :ansi?
-
-    # Check if string contains only ANSI codes
-    #
-    # @param [String] string
-    #   the string to check
-    #
-    # @example
-    #   Strings::ANSI.only_ansi?("\e[33mfoo\[e0m")
-    #   # => false
-    #
-    #   Strings::ANSI.only_ansi?("\e[33m")
-    #   # => false
-    #
-    # @return [Boolean]
-    #
-    # @api public
-    def only_ansi?(string)
-      !!(string =~ /^#{ANSI_MATCHER}$/)
-    end
-    module_function :only_ansi?
-  end # Sanitizer
-end # Strings