verse 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bcfae40dd0a5d6e2cfe144f7ea30d7e7ee9519b
-  data.tar.gz: 0b661d9f8b3850dae81afbd029eb0cd9082ab369
+  metadata.gz: 7531f5a29482d44a943c00b361f49e6673bdd9c7
+  data.tar.gz: 1bc1d1680d157e66faf7a44ba9c3ed0a804e7828
 SHA512:
-  metadata.gz: c48ef20fbcc3013a71f92059007022d1c37a7be054710af812540e2fbb3ed5bb73b05b966eb96cf9d58fa8473ff7bc1cf3467b3b8d2aabf0df230b2dcdd3162d
-  data.tar.gz: 077b69e6bad26f16c461ae1f9b903cec2789f5c6f0c15c9005b2854f24c017cf3aa637c1055729d1cc2c0b570796f17ca9316cefcb7977ef1d9797af5e1fde7b
+  metadata.gz: 5348385613bff73636e6b5993ebcafbba3ce1093a0b15e01c7c089248b61c09175c1793c0af5e8fdf482b2c149a0e9d6ea5b3d190c4246c689d5deba220b0d8a
+  data.tar.gz: f1605d77c8ffaf24695739ca4df6bb646834b0ccfd3c2b3a51641cd0a48ab1729fafb57a079bc08a86522ace2f3c419991f1ee44c9826fbbcb1a2ea7899ce4f7

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.3.0 (Feb 28, 2015)
+
+* Add Sanitizer#replace for substitutiong linebreaks
+* Add Padder for parsing padding values
+* Add Padding for padding content around
+* Change Wrapping#wrap to preserve whitespace characters
+
 0.2.1 (Feb 15, 2015)
 
 * Fix empty string alignment

data/README.md

@@ -16,6 +16,7 @@
 ## Features
 
 * No monkey-patching String class
+* Simple API that can be easily wrapped by other objects
 * Supports multibyte character encodings such as UTF-8, EUC-JP
 * Handles languages without whitespaces between words (like Chinese and Japanese)
 
@@ -43,8 +44,10 @@ $ gem install verse
 
 * [1. Usage](#1-usage)
   * [1.1 Align](#11-align)
-  * [1.2 Truncate](#12-truncate)
-  * [1.3 Wrap](#13-wrap)
+  * [1.2 Pad](#12-pad)
+  * [1.3 Replace](#13-replace)
+  * [1.4 Truncate](#14-truncate)
+  * [1.5 Wrap](#15-wrap)
 
 ## 1 Usage
 
@@ -84,7 +87,68 @@ alignment.center(20) # =>
     "     場にも含み     "
 ```
 
-### 1.2 Truncate
+### 1.2 Pad
+
+**Verse::Padding** provides facility to pad around text with a given padding.
+
+The padding value needs to be one of the following values corresponding with CSS padding property:
+
+```ruby
+[1,1,1,1]  # => pad text left & right with 1 character and add 1 line above & below
+[1,1]      # => as above
+1          # => as above
+```
+
+You can pad around a single line of text with `pad` method like so:
+
+```ruby
+padding = Verse::Padding.new("Ignorance is the parent of fear.")
+
+padding.pad([1,1,1,1]) # =>
+  "                                  \n" +
+  " Ignorance is the parent of fear. \n" +
+  "                                  "
+```
+
+In addition, you can `pad` multiline content:
+
+```ruby
+padding = Verse::Padding.new "It is the easiest thing\n" +
+                             "in the world for a man\n" +
+                             "to look as if he had \n" +
+                             "a great secret in him."
+
+padding.pad([1,1,1,1]) # =>
+  "                         \n" +
+  " It is the easiest thing \n" +
+  " in the world for a man \n" +
+  " to look as if he had  \n" +
+  " a great secret in him. \n" +
+  "                         "
+```
+
+You can also specify `UTF-8` text as well:
+
+```ruby
+padding = Verse::Padding.new "ラドクリフ、マラソン"
+
+padding.pad([1,1,1,1]) # =>
+  "                      \n" +
+  " ラドクリフ、マラソン \n" +
+  "                      "
+```
+
+### 1.3 Replace
+
+**Verse::Sanitizer** provides ability to sanitize text with unwanted characters. Given a text with line break characters, `replace` will remove or substitute all occurances of line breaks depending on surrounding context.
+
+```ruby
+sanitizer = Verse::Sanitizer.new
+sanitizer.replace("It is not down on any map;\r\n true places never are.")
+# => "It is not down on any map; true places never are."
+```
+
+### 1.4 Truncate
 
 Using **Verse::Truncation** you can truncate a given text after a given length.
 
@@ -114,7 +178,7 @@ truncation = Verse::Truncation.new 'ラドクリフ、マラソン五輪代表
 truncation.truncate(12)   # => "ラドクリフ…"
 ```
 
-### 1.3 Wrap
+### 1.5 Wrap
 
 **Verse::Wrapping** allows you to wrap text into lines no longer than `wrap_at` argument length. The `wrap` method will break either on whitespace character or in case of east Asian characters on character boundaries.
 

data/lib/verse.rb

@@ -4,6 +4,8 @@ require 'unicode_utils/display_width'
 require 'unicode_utils/each_grapheme'
 
 require 'verse/alignment'
+require 'verse/padder'
+require 'verse/padding'
 require 'verse/sanitizer'
 require 'verse/truncation'
 require 'verse/wrapping'
@@ -26,6 +28,15 @@ module Verse
     Alignment.align(text, width, direction, options)
   end
 
+  # Pad a text around with a given padding
+  #
+  # @see Verse::Padding#pad
+  #
+  # @api public
+  def self.pad(text, padding, options = {})
+    Padding.pad(text, padding, options)
+  end
+
   # Truncate a text at a given length
   #
   # @see Verse::Truncation#truncate

data/lib/verse/padder.rb

@@ -0,0 +1,176 @@
+# coding: utf-8
+
+module Verse
+  # A class responsible for parsing padding value
+  #
+  # Used internally by {Verse::Padding}
+  #
+  # @api private
+  class Padder
+    # Padding
+    #
+    # @return [Array[Integer]]
+    attr_reader :padding
+
+    # Initialize a Padder
+    #
+    # @api public
+    def initialize(padding)
+      @padding = padding
+    end
+
+    # Parse padding options
+    #
+    # Turn possible values into 4 element array
+    #
+    # @example
+    #   padder = TTY::Table::Padder.parse(5)
+    #   padder.padding # => [5, 5, 5, 5]
+    #
+    # @param [Object] value
+    #
+    # @return [TTY::Padder]
+    #   the new padder with padding values
+    #
+    # @api public
+    def self.parse(value = nil)
+      return value if value.is_a?(self)
+
+      new(convert_to_ary(value))
+    end
+
+    # Convert value to 4 element array
+    #
+    # @return [Array[Integer]]
+    #   the 4 element padding array
+    #
+    # @api private
+    def self.convert_to_ary(value)
+      if value.class <= Numeric
+        [value, value, value, value]
+      elsif value.nil?
+        []
+      elsif value.size == 2
+        [value[0], value[1], value[0], value[1]]
+      elsif value.size == 4
+        value
+      else
+        fail ArgumentError, 'Wrong :padding parameter, must be an array'
+      end
+    end
+
+    # Top padding
+    #
+    # @return [Integer]
+    #
+    # @api public
+    def top
+      @padding[0].to_i
+    end
+
+    # Set top padding
+    #
+    # @param [Integer] val
+    #
+    # @return [nil]
+    #
+    # @api public
+    def top=(value)
+      @padding[0] = value
+    end
+
+    # Right padding
+    #
+    # @return [Integer]
+    #
+    # @api public
+    def right
+      @padding[1].to_i
+    end
+
+    # Set right padding
+    #
+    # @param [Integer] val
+    #
+    # @api public
+    def right=(value)
+      @padding[1] = value
+    end
+
+    # Bottom padding
+    #
+    # @return [Integer]
+    #
+    # @api public
+    def bottom
+      @padding[2].to_i
+    end
+
+    # Set bottom padding
+    #
+    # @param [Integer] value
+    #
+    # @return [nil]
+    #
+    # @api public
+    def bottom=(value)
+      @padding[2] = value
+    end
+
+    # Left padding
+    #
+    # @return [Integer]
+    #
+    # @api public
+    def left
+      @padding[3].to_i
+    end
+
+    # Set left padding
+    #
+    # @param [Integer] value
+    #
+    # @return [nil]
+    #
+    # @api public
+    def left=(value)
+      @padding[3] = value
+    end
+
+    # Check if padding is set
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def empty?
+      padding.empty?
+    end
+
+    # Check if vertical padding is applied
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def vertical?
+      top.nonzero? || bottom.nonzero?
+    end
+
+    # Check if horizontal padding is applied
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def horizontal?
+      left.nonzero? || right.nonzero?
+    end
+
+    # String represenation of this padder with padding values
+    #
+    # @return [String]
+    #
+    # @api public
+    def to_s
+      inspect
+    end
+  end # Padder
+end # Verse

data/lib/verse/padding.rb

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+module Verse
+  # A class responsible for text indentation
+  class Padding
+    # Initialize a Padding
+    #
+    # @api public
+    def initialize(text, options = {})
+      @text = text
+      @padding = Padder.parse(options[:padding])
+    end
+
+    # Pad content out
+    #
+    # @see Verse::Padding#pad
+    #
+    # @api public
+    def self.pad(text, padding, options)
+      new(text, options).pad(padding, options)
+    end
+
+    # Apply padding to text
+    #
+    # @param [String] text
+    #
+    # @return [String]
+    #
+    # @api private
+    def pad(padding = (not_set = true), options = {})
+      return text if @padding.empty? && not_set
+      if !not_set
+        @padding = Padder.parse(padding)
+      end
+      text_copy = text.dup
+      column_width = maximum_length(text)
+      elements = []
+      if @padding.top > 0
+        elements << (SPACE * column_width + NEWLINE) * @padding.top
+      end
+      elements << text_copy
+      if @padding.bottom > 0
+        elements << (SPACE * column_width + NEWLINE) * @padding.bottom
+      end
+      elements.map { |el| pad_multi_line(el) }.join(NEWLINE)
+    end
+
+    protected
+
+    # The text to pad
+    #
+    # @api private
+    attr_reader :text
+
+    # Apply padding to multi line text
+    #
+    # @param [String] text
+    #
+    # @return [String]
+    #
+    # @api private
+    def pad_multi_line(text)
+      text.split(NEWLINE).map { |part| pad_around(part) }
+    end
+
+    # Apply padding to left and right side of string
+    #
+    # @param [String] text
+    #
+    # @return [String]
+    #
+    # @api private
+    def pad_around(text)
+      text.insert(0, SPACE * @padding.left).
+           insert(-1, SPACE * @padding.right)
+    end
+
+    # Determine maximum length for all multiline content
+    #
+    # @params [String] text
+    #
+    # @return [Integer]
+    #
+    # @api private
+    def maximum_length(text)
+      lines = text.split(/\n/, -1)
+      display_width(lines.max_by { |line| display_width(line) } || '')
+    end
+
+    def display_width(string)
+      UnicodeUtils.display_width(string)
+    end
+  end # Padding
+end # Verse

data/lib/verse/sanitizer.rb

@@ -4,15 +4,36 @@ module Verse
   class Sanitizer
     ANSI_MATCHER = /(\[)?\033(\[)?[;?\d]*[\dA-Za-z](\])?/.freeze
 
+    LINE_BREAK = "(\r\n+|\r+|\n+|\t+)".freeze
+
     # Strip ANSI characters from the text
     #
     # @param [String] text
     #
     # @return [String]
     #
-    # @api private
+    # @api public
     def sanitize(text)
       text.gsub(ANSI_MATCHER, '')
     end
+
+    # Replace separator with whitespace
+    #
+    # @example
+    #   replace(" \n ") # => "  "
+    #   replace("\n")   # => " "
+    #
+    # @param [String] text
+    #
+    # @param [String] separator
+    #
+    # @return [String]
+    #
+    # @api public
+    def replace(text, separator = LINE_BREAK)
+      text.gsub(/([ ]+)#{separator}/, "\\1").
+           gsub(/#{separator}(?<space>[ ]+)/, "\\k<space>").
+           gsub(/#{separator}/, ' ')
+    end
   end # Sanitizer
 end # Verse

data/lib/verse/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 
 module Verse
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end # Verse

data/lib/verse/wrapping.rb

@@ -60,7 +60,7 @@ module Verse
     #
     # @api private
     def format_paragraph(paragraph, wrap_at)
-      cleared_para = paragraph.strip.gsub(NEWLINE_RE, SPACE).squeeze(SPACE)
+      cleared_para = @sanitizer.replace(paragraph)
       lines = []
       line = ''
       word  = ''
@@ -73,7 +73,7 @@ module Verse
         char_length = display_width(char)
         total_length += char_length
         if line_length + word_length + char_length <= wrap_at
-          if SPACE_RE =~ char || total_length == text_length
+          if char == SPACE || total_length == text_length
             line << word + char
             line_length += word_length + char_length
             word = ''
@@ -85,26 +85,26 @@ module Verse
           next
         end
 
-        if SPACE_RE =~ char # ends with space
-          lines << line.strip
+        if char == SPACE # ends with space
+          lines << line
           line = ''
           line_length = 0
-          word = ''
-          word_length = 0
+          word = word + char
+          word_length = word_length + char_length
         elsif word_length + char_length <= wrap_at
-          lines << line.strip
+          lines << line
           line = word + char
           line_length = word_length + char_length
           word = ''
           word_length = 0
         else # hyphenate word - too long to fit a line
-          lines << word.strip
+          lines << word
           line_length = 0
           word = char
           word_length = char_length
         end
       end
-      lines << line.strip unless line.empty?
+      lines << line unless line.empty?
       lines << word unless word.empty?
       lines
     end

data/spec/unit/pad_spec.rb

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

data/spec/unit/padder/accessors_spec.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Verse::Padder, 'accessors' do
+  subject(:padder) { described_class }
+
+  it "allows to set padding through accessors" do
+    instance = padder.parse([1,2,3,4])
+    instance.top = 5
+    expect(instance.padding).to eq([5,2,3,4])
+  end
+end
+

data/spec/unit/padder/parse_spec.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Verse::Padder, '#parse' do
+  subject(:padder) { described_class }
+
+  it "parses nil" do
+    instance = padder.parse(nil)
+    expect(instance.padding).to eq([])
+  end
+
+  it 'parses self' do
+    value = described_class.new([])
+    instance = padder.parse(value)
+    expect(instance.padding).to eq([])
+  end
+
+  it "parses digit" do
+    instance = padder.parse(5)
+    expect(instance.padding).to eq([5,5,5,5])
+  end
+
+  it "parses 2-element array" do
+    instance = padder.parse([2,3])
+    expect(instance.padding).to eq([2,3,2,3])
+  end
+
+  it "parses 4-element array" do
+    instance = padder.parse([1,2,3,4])
+    expect(instance.padding).to eq([1,2,3,4])
+  end
+
+  it "fails to parse unknown value" do
+    expect {
+      padder.parse(:unknown)
+    }.to raise_error
+  end
+end

data/spec/unit/padding/pad_spec.rb

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Verse::Padding, '.pad' do
+  it "doesn't pad without padding option" do
+    text = "Ignorance is the parent of fear."
+    padding = Verse::Padding.new(text)
+    expect(padding.pad).to eq(text)
+  end
+
+  it "pads content with specific padding" do
+    text = "Ignorance is the parent of fear."
+    padding = Verse::Padding.new(text)
+    expect(padding.pad([1,1,1,1])).to eq([
+      "                                  ",
+      " Ignorance is the parent of fear. ",
+      "                                  ",
+    ].join("\n"))
+  end
+
+  it "pads content with global padding" do
+    text = "Ignorance is the parent of fear."
+    padding = Verse::Padding.new(text, padding: [1,1,1,1])
+    expect(padding.pad).to eq([
+      "                                  ",
+      " Ignorance is the parent of fear. ",
+      "                                  ",
+    ].join("\n"))
+  end
+
+  it "pads unicode content" do
+    text = "ラドクリフ、マラソン"
+    padding = Verse::Padding.new(text)
+    expect(padding.pad([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."
+    padding = Verse::Padding.new(text, padding: [1,1,1,1])
+    expect(padding.pad()).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
+end

data/spec/unit/sanitizer/replace_spec.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe Verse::Sanitizer, '.replace' do
+  subject(:sanitizer) { described_class.new }
+
+  {
+    "  \n"      => '  ',
+    "\n  "      => '  ',
+    "\n"        => ' ',
+    "\n\n\n"    => ' ',
+    " \n "      => '  ',
+    " \n \n \n" => '   '
+  }.each do |string, expected|
+    it "replaces '#{string.gsub(/\n/, '\\n')}' with whitespace" do
+      expect(sanitizer.replace(string)).to eq(expected)
+    end
+  end
+
+  {
+    "  \r\n" => '  ',
+    "\r\n  " => '  ',
+    "\r\n"   => ' ',
+    " \r\n " => '  ',
+  }.each do |string, expected|
+    it "replaces '#{string.gsub(/\r\n/, '\\r\\n')}' with whitespace" do
+      expect(sanitizer.replace(string, "\r\n")).to eq(expected)
+    end
+  end
+end

data/spec/unit/wrapping/wrap_spec.rb

@@ -34,13 +34,13 @@ RSpec.describe Verse::Wrapping, '.wrap' do
       text = "for there is no folly of the beast of the earth which is not infinitely outdone by the madness of men "
       wrapping = Verse::Wrapping.new(text)
       expect(wrapping.wrap(16)).to eq([
-        "for there is no",
-        "folly of the",
-        "beast of the",
-        "earth which is",
-        "not infinitely",
-        "outdone by the",
-        "madness of men"
+        "for there is no ",
+        "folly of the ",
+        "beast of the ",
+        "earth which is ",
+        "not infinitely ",
+        "outdone by the ",
+        "madness of men "
       ].join("\n"))
     end
 
@@ -55,30 +55,34 @@ RSpec.describe Verse::Wrapping, '.wrap' do
         "にも含み"
       ].join("\n"))
     end
+
+    it 'preserves whitespace' do
+     # text = "  As for me,   I am    tormented"
+      text = "  As for me,   I am    tormented with   an everlasting   itch for   things remote.  "
+      wrapping = Verse::Wrapping.new(text)
+      expect(wrapping.wrap(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;
-      "
+      "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;"
       wrapping = Verse::Wrapping.new(text)
       expect(wrapping.wrap(45)).to eq unindent <<-EOS
-    What of it, if some old hunks of a\n sea-captain orders me to get a broom
-    and sweep down the decks? What does that\n indignity amount to, weighed,
-    I mean, in the scales of the New Testament?\n Do you think the archangel
-    Gabriel thinks anything the less of me,\n because I promptly and
-    respectfully obey that old hunks in that\nparticular instance? Who ain't
-    a slave? Tell me that. Well, then, however\n the old sea-captains may
-    order me about--however they may thump and\n punch me about, I have the
-    satisfaction of knowing that it is all right;\n
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verse
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2015-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_utils
@@ -57,6 +57,8 @@ files:
 - Rakefile
 - lib/verse.rb
 - lib/verse/alignment.rb
+- lib/verse/padder.rb
+- lib/verse/padding.rb
 - lib/verse/sanitizer.rb
 - lib/verse/truncation.rb
 - lib/verse/version.rb
@@ -66,6 +68,11 @@ files:
 - spec/unit/alignment/align_spec.rb
 - spec/unit/alignment/left_spec.rb
 - spec/unit/alignment/right_spec.rb
+- spec/unit/pad_spec.rb
+- spec/unit/padder/accessors_spec.rb
+- spec/unit/padder/parse_spec.rb
+- spec/unit/padding/pad_spec.rb
+- spec/unit/sanitizer/replace_spec.rb
 - spec/unit/sanitizer/sanitize_spec.rb
 - spec/unit/truncate_spec.rb
 - spec/unit/truncation/new_spec.rb
@@ -107,6 +114,11 @@ test_files:
 - spec/unit/alignment/align_spec.rb
 - spec/unit/alignment/left_spec.rb
 - spec/unit/alignment/right_spec.rb
+- spec/unit/pad_spec.rb
+- spec/unit/padder/accessors_spec.rb
+- spec/unit/padder/parse_spec.rb
+- spec/unit/padding/pad_spec.rb
+- spec/unit/sanitizer/replace_spec.rb
 - spec/unit/sanitizer/sanitize_spec.rb
 - spec/unit/truncate_spec.rb
 - spec/unit/truncation/new_spec.rb