verse 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91a9c0b0722656e5b2b160a14e68f9d228830120
-  data.tar.gz: 9397441752523d44ac885b7e5ad4b0e8faffbead
+  metadata.gz: b480b85987f2de41f4570f5a0522d2acb3f7e78d
+  data.tar.gz: 030f669b31afcf4329a79d906d4bb630ee447ad3
 SHA512:
-  metadata.gz: aa1fb93fb455d0d141616c0a0dd08886486331a92b5b165a3ec1852f228b89e8002fb078d9329b0c9325a758725004ebb14f74c5ba618145de9c29990b2b0519
-  data.tar.gz: bf4deb4d61427c35aab5d4522b31003a49e1b93388e176fd19533dfe3177e618126beee94893de210b14f64b5c51555b707cb7b39b1d17dd168ead985af54c6d
+  metadata.gz: 1944945843174ee5c0e2c91c7698c1b1ef7ea06759c2a1cca1917740bbffc3a77dc828bcc547218c30a40a127bf64360e423563b11f379d9af65de5b93bbd8a3
+  data.tar.gz: 6e48975ef2b03f0aacbfddb9bb7c01da0a04c588ffb74aa2e3e8d569d9ec15bc7bc4b7ea2b9e627c675eebcc320d1a30a35831f69560f321ce30576a6fe66450

data/.travis.yml

@@ -1,22 +1,24 @@
+---
 language: ruby
-bundler_args: --without yard benchmarks
+sudo: false
+cache: bundler
+language: ruby
+bundler_args: --without benchmarks
 script: "bundle exec rake ci"
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
-  - 2.2.0
+  - 2.2.5
+  - 2.3.1
+  - jruby-9.1.1.0
+  - jruby-head
   - ruby-head
 matrix:
-  include:
-    - rvm: jruby-19mode
-    - rvm: jruby-20mode
-    - rvm: jruby-21mode
-    - rvm: jruby-head
-    - rvm: rbx-2
   allow_failures:
-    - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: ruby-head
   fast_finish: true
 branches:
   only: master
+notifications:
+  email: false

data/CHANGELOG.md

@@ -1,25 +1,59 @@
-0.4.0 (Mar 28, 2015)
+# Change log
 
+## [v0.5.0] - 2016-10-25
+
+### Added
+* Add ParseError to Padder
+
+### Changed
+* Change Sanitizer to module
+* Replaces UnicodeUtils.display_width with Unicode::DisplayWidth.of by @MichaelBaker
+
+## [v0.4.0] - 2015-03-28
+
+### Added
 * Add Sanitizer#ansi? to check for ANSI codes
+
+### Changed
 * Change Alignment to work with ANSI codes
 * Change Truncation to work with ANSI codes
 * Change Wrapping to work with ANSI codes
 * Chnage Padding to work with ANSI codes
 
-0.3.0 (Feb 28, 2015)
+## [v0.3.0] - 2015-02-28
 
+### Added
 * Add Sanitizer#replace for substitutiong linebreaks
 * Add Padder for parsing padding values
 * Add Padding for padding content around
+
+### Changed
 * Change Wrapping#wrap to preserve whitespace characters
 
-0.2.1 (Feb 15, 2015)
+## [v0.2.1] - 2015-02-15
 
+### Fixed
 * Fix empty string alignment
 * Fix alignment to stop modifying original content
 
-0.2.0 (Feb 15, 2015)
+## [v0.2.0] - 2015-02-15
 
+### Added
 * Add unicode support
+
+### Changed
 * Change wrap, truncate and align to work with unicode characters
+
+### Removed
 * Remove padding and indent from Verse::Wrapping
+
+## [v0.1.0] - 2015-02-07
+
+* Inital implementation and release
+
+[v0.5.0]: https://github.com/piotrmurach/verse/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/piotrmurach/verse/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/verse/compare/v0.2.1...v0.3.0
+[v0.2.1]: https://github.com/piotrmurach/verse/compare/v0.2.0...v0.2.1
+[v0.2.0]: https://github.com/piotrmurach/verse/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/verse/compare/v0.1.0

data/Gemfile

@@ -3,13 +3,17 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rake',    '~> 10.3.2'
-  gem 'rspec',   '~> 3.1.0'
+  gem 'rake',    '~> 11.1.1'
+  gem 'rspec',   '~> 3.5.0'
   gem 'yard',    '~> 0.8.7'
 end
 
 group :metrics do
-  gem 'coveralls', '~> 0.7.0'
-  gem 'simplecov', '~> 0.8.2'
+  gem 'coveralls', '~> 0.8.2'
+  gem 'simplecov', '~> 0.10.0'
   gem 'yardstick', '~> 0.9.9'
 end
+
+group :benchmarks do
+  gem 'benchmark-ips'
+end

data/README.md

@@ -1,15 +1,15 @@
 # Verse
-[![Gem Version](https://badge.fury.io/rb/verse.png)][gem]
-[![Build Status](https://secure.travis-ci.org/peter-murach/verse.png?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/peter-murach/verse.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/peter-murach/verse/badge.png)][coverage]
-[![Inline docs](http://inch-ci.org/github/peter-murach/verse.png)][inchpages]
+[![Gem Version](https://badge.fury.io/rb/verse.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/verse.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/piotrmurach/verse/badges/gpa.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/piotrmurach/verse/badge.svg)][coverage]
+[![Inline docs](http://inch-ci.org/github/piotrmurach/verse.svg)][inchpages]
 
 [gem]: http://badge.fury.io/rb/verse
-[travis]: http://travis-ci.org/peter-murach/verse
-[codeclimate]: https://codeclimate.com/github/peter-murach/verse
-[coverage]: https://coveralls.io/r/peter-murach/verse
-[inchpages]: http://inch-ci.org/github/peter-murach/verse
+[travis]: http://travis-ci.org/piotrmurach/verse
+[codeclimate]: https://codeclimate.com/github/piotrmurach/verse
+[coverage]: https://coveralls.io/r/piotrmurach/verse
+[inchpages]: http://inch-ci.org/github/piotrmurach/verse
 
 > Text transformations such as truncation, wrapping, aligning, indentation and grouping of words.
 
@@ -66,7 +66,7 @@ alignment = Verse::Alignment.new "for there is no folly of the beast\n" +
 Then using direction out of `:right`, `:left` or `:center` methods and passing width you can align the text:
 
 ```ruby
-alignemnt.align(40, :right) # =>
+alignment.align(40, :right) # =>
     "      for there is no folly of the beast\n" +
     "                      of the earth which\n" +
     "                       is not infinitely\n" +
@@ -245,7 +245,7 @@ Verse.wrap(text, wrap_at)
 
 ## Contributing
 
-1. Fork it ( https://github.com/peter-murach/verse/fork )
+1. Fork it ( https://github.com/piotrmurach/verse/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`)
@@ -253,4 +253,4 @@ Verse.wrap(text, wrap_at)
 
 ## Copyright
 
-Copyright (c) 2015 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2015-2016 Piotr Murach. See LICENSE for further details.

data/benchmarks/speed_profile.rb

@@ -0,0 +1,26 @@
+require 'benchmark/ips'
+require 'verse'
+
+text = "Ignorance is the parent of fear."
+
+Benchmark.ips do |x|
+  x.report('wrap') do
+    Verse::Wrapping.wrap(text, 10)
+  end
+
+  x.report('truncate') do
+    Verse::Truncation.truncate(text, 10)
+  end
+
+  x.compare!
+end
+
+# Warming up --------------------------------------
+#                 wrap   178.000  i/100ms
+#             truncate   262.000  i/100ms
+# Calculating -------------------------------------
+#                 wrap      1.812k (± 1.9%) i/s -      9.078k in   5.010776s
+#             truncate      2.625k (± 1.9%) i/s -     13.362k in   5.092305s
+# Comparison:
+#             truncate:     2624.9 i/s
+#                 wrap:     1812.3 i/s - 1.45x  slower

data/lib/verse.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-require 'unicode_utils/display_width'
+require 'unicode/display_width'
 require 'unicode_utils/each_grapheme'
 
 require 'verse/alignment'
@@ -14,7 +14,6 @@ require 'verse/version'
 module Verse
   SPACE   = ' '.freeze
   NEWLINE = "\n".freeze
-  TAB     = "\n".freeze
   RESET   = "\e[0m".freeze
   ANSI    = "\033".freeze
 

data/lib/verse/alignment.rb

@@ -3,7 +3,6 @@
 module Verse
   # A class responsible for text alignment
   class Alignment
-
     attr_reader :fill
 
     attr_reader :direction
@@ -13,7 +12,6 @@ module Verse
     # @api public
     def initialize(text, options = {})
       @text      = text
-      @sanitizer = Sanitizer.new
       @fill      = options.fetch(:fill) { SPACE }
       @direction = options.fetch(:direction) { :left }
     end
@@ -82,6 +80,11 @@ module Verse
 
     protected
 
+    # The text to align
+    #
+    # @ api private
+    attr_reader :text
+
     # @api private
     def convert_to_method(direction)
       case direction.to_sym
@@ -89,7 +92,7 @@ module Verse
       when :right  then :right_justify
       when :center then :center_justify
       else
-        fail ArgumentError, "Unknown alignment `#{direction}`."
+        raise ArgumentError, "Unknown alignment `#{direction}`."
       end
     end
 
@@ -104,7 +107,7 @@ module Verse
 
     # @api private
     def left_justify(text, width, filler)
-      width_diff = width - actual_width(text)
+      width_diff = width - display_width(text)
       if width_diff > 0
         text + filler * width_diff
       else
@@ -114,7 +117,7 @@ module Verse
 
     # @api private
     def right_justify(text, width, filler)
-      width_diff = width - actual_width(text)
+      width_diff = width - display_width(text)
       if width_diff > 0
         filler * width_diff + text
       else
@@ -124,7 +127,7 @@ module Verse
 
     # @api private
     def center_justify(text, width, filler)
-      text_width = actual_width(text)
+      text_width = display_width(text)
       width_diff = width - text_width
       if width_diff > 0
         right_count = (width_diff.to_f / 2).ceil
@@ -136,10 +139,8 @@ module Verse
     end
 
     # @api private
-    def actual_width(text)
-      UnicodeUtils.display_width(@sanitizer.sanitize(text))
+    def display_width(text)
+      Unicode::DisplayWidth.of(Sanitizer.sanitize(text))
     end
-
-    attr_reader :text
   end # Alignment
 end # Verse

data/lib/verse/padder.rb

@@ -1,6 +1,8 @@
 # coding: utf-8
 
 module Verse
+  ParseError = Class.new(ArgumentError)
+
   # A class responsible for parsing padding value
   #
   # Used internally by {Verse::Padding}
@@ -55,7 +57,7 @@ module Verse
       elsif value.size == 4
         value
       else
-        fail ArgumentError, 'Wrong :padding parameter, must be an array'
+        fail ParseError, 'Wrong :padding parameter, must be an array'
       end
     end
 

data/lib/verse/padding.rb

@@ -9,7 +9,6 @@ module Verse
     def initialize(text, options = {})
       @text      = text
       @padding   = Padder.parse(options[:padding])
-      @sanitizer = Sanitizer.new
     end
 
     # Pad content out
@@ -89,7 +88,7 @@ module Verse
     end
 
     def display_width(string)
-      UnicodeUtils.display_width(@sanitizer.sanitize(string))
+      Unicode::DisplayWidth.of(Sanitizer.sanitize(string))
     end
   end # Padding
 end # Verse

data/lib/verse/sanitizer.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 
 module Verse
-  class Sanitizer
-    ANSI_MATCHER = /(\[)?\033(\[)?[;?\d]*[\dA-Za-z](\])?/.freeze
+  module Sanitizer
+    ANSI_MATCHER = /(\[)?\033(\[)?[;?\d]*[\dA-Za-z](\])?/
 
     LINE_BREAK = "(\r\n+|\r+|\n+|\t+)".freeze
 
@@ -16,6 +16,7 @@ module Verse
     def sanitize(text)
       text.gsub(ANSI_MATCHER, '')
     end
+    module_function :sanitize
 
     # Check if string is an ANSI code
     #
@@ -28,6 +29,7 @@ module Verse
     def ansi?(string)
       !!(string =~ /^(\[)?\033(\[)?[;?\d]*[\dA-Za-z]([\];])?$/)
     end
+    module_function :ansi?
 
     # Replace separator with whitespace
     #
@@ -43,9 +45,10 @@ module Verse
     #
     # @api public
     def replace(text, separator = LINE_BREAK)
-      text.gsub(/([ ]+)#{separator}/, "\\1").
-           gsub(/#{separator}(?<space>[ ]+)/, "\\k<space>").
-           gsub(/#{separator}/, ' ')
+      text.gsub(/([ ]+)#{separator}/, "\\1")
+          .gsub(/#{separator}(?<space>[ ]+)/, "\\k<space>")
+          .gsub(/#{separator}/, ' ')
     end
+    module_function :replace
   end # Sanitizer
 end # Verse

data/lib/verse/truncation.rb

@@ -5,7 +5,7 @@ module Verse
   class Truncation
     DEFAULT_TRAILING = '…'.freeze
 
-    DEFAULT_LENGTH = 30.freeze
+    DEFAULT_LENGTH = 30
 
     attr_reader :separator
 
@@ -23,7 +23,6 @@ module Verse
     # @api public
     def initialize(text, options = {})
       @text      = text.dup.freeze
-      @sanitizer = Sanitizer.new
       @separator = options.fetch(:separator) { nil }
       @trailing  = options.fetch(:trailing) { DEFAULT_TRAILING }
     end
@@ -63,7 +62,7 @@ module Verse
       trail      = options.fetch(:trailing) { trailing }
       separation = options.fetch(:separator) { separator }
       width      = display_width(text)
-      sanitized_text = @sanitizer.sanitize(text)
+      sanitized_text = Sanitizer.sanitize(text)
 
       return text if width <= truncate_at
 
@@ -107,12 +106,12 @@ module Verse
 
     # @api private
     def to_chars(text)
-      UnicodeUtils.each_grapheme(text).to_a
+      UnicodeUtils.each_grapheme(text)
     end
 
     # @api private
     def display_width(string)
-      UnicodeUtils.display_width(@sanitizer.sanitize(string))
+      Unicode::DisplayWidth.of(Sanitizer.sanitize(string))
     end
   end # Truncation
 end # Verse

data/lib/verse/version.rb

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

data/lib/verse/wrapping.rb

@@ -3,7 +3,7 @@
 module Verse
   # A class responsible for text wrapping
   class Wrapping
-    DEFAULT_WIDTH = 80.freeze
+    DEFAULT_WIDTH = 80
 
     # Initialize a Wrapping
     #
@@ -15,9 +15,8 @@ module Verse
     #
     # @api public
     def initialize(text, options = {})
-      @text    = text
+      @text       = text
       @line_width = options.fetch(:line_width) { DEFAULT_WIDTH }
-      @sanitizer = Sanitizer.new
     end
 
     # Wrap a text into lines no longer than wrap_at
@@ -68,10 +67,10 @@ module Verse
     #
     # @api private
     def format_paragraph(paragraph, wrap_at, ansi_stack)
-      cleared_para = @sanitizer.replace(paragraph)
+      cleared_para = Sanitizer.replace(paragraph)
       lines = []
       line = ''
-      word  = ''
+      word = ''
       word_length = 0
       line_length = 0
       char_length = 0 # visible char length
@@ -79,14 +78,14 @@ module Verse
       total_length = 0
       ansi = ''
       matched = nil
-      UnicodeUtils.each_grapheme(cleared_para) do |char|
+      to_chars(cleared_para) do |char|
         if char == ANSI # found ansi
           ansi << char && next
         end
 
         if ansi.length > 0
           ansi << char
-          if @sanitizer.ansi?(ansi) # we found ansi let's consume
+          if Sanitizer.ansi?(ansi) # we found ansi let's consume
             matched = ansi
           elsif matched
             ansi_stack << [matched[0...-1], line_length + word_length]
@@ -173,11 +172,20 @@ module Verse
       output
     end
 
+    # @api private
+    def to_chars(text, &block)
+      if block_given?
+        UnicodeUtils.each_grapheme(text, &block)
+      else
+        UnicodeUtils.each_grapheme(text)
+      end
+    end
+
     # Visible width of string
     #
     # @api private
     def display_width(string)
-      UnicodeUtils.display_width(@sanitizer.sanitize(string))
+      Unicode::DisplayWidth.of(Sanitizer.sanitize(string))
     end
   end # Wrapping
 end # Verse

data/spec/unit/padder/parse_spec.rb

@@ -34,6 +34,6 @@ RSpec.describe Verse::Padder, '#parse' do
   it "fails to parse unknown value" do
     expect {
       padder.parse(:unknown)
-    }.to raise_error
+    }.to raise_error(Verse::ParseError)
   end
 end

data/spec/unit/sanitizer/ansi_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Verse::Sanitizer, '.ansi?' do
-  subject(:sanitizer) { described_class.new }
+  subject(:sanitizer) { described_class }
 
   it "checks if code is ansi" do
     expect(sanitizer.ansi?("\e[0;33m")).to eq(true)

data/spec/unit/sanitizer/replace_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Verse::Sanitizer, '.replace' do
-  subject(:sanitizer) { described_class.new }
+  subject(:sanitizer) { described_class }
 
   {
     "  \n"      => '  ',

data/spec/unit/sanitizer/sanitize_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Verse::Sanitizer, '.sanitize' do
-  subject(:sanitizer) { described_class.new }
+  subject(:sanitizer) { described_class }
 
   {
     "\e[20h" => '',

data/verse.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = [""]
   spec.summary       = %q{Text transformations such as truncation, wrapping, aligning, indentation and grouping of words.}
   spec.description   = %q{Text transformations such as truncation, wrapping, aligning, indentation and grouping of words.}
-  spec.homepage      = "https://github.com/peter-murach/verse"
+  spec.homepage      = "https://github.com/piotrmurach/verse"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'unicode_utils',     '~> 1.4.0'
+  spec.add_dependency 'unicode_utils',        '~> 1.4.0'
+  spec.add_dependency 'unicode-display_width','~> 1.1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
 end

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: verse
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2016-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !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'
 description: Text transformations such as truncation, wrapping, aligning, indentation
@@ -46,15 +60,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/speed_profile.rb
 - lib/verse.rb
 - lib/verse/alignment.rb
 - lib/verse/padder.rb
@@ -84,7 +98,7 @@ files:
 - tasks/coverage.rake
 - tasks/spec.rake
 - verse.gemspec
-homepage: https://github.com/peter-murach/verse
+homepage: https://github.com/piotrmurach/verse
 licenses:
 - MIT
 metadata: {}
@@ -94,17 +108,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Text transformations such as truncation, wrapping, aligning, indentation

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0