strings 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8111a8f94d474b08df2f71900bbd8f39ead7aabc0e3dbfff6917b249bd3322f
-  data.tar.gz: e86f201edd293da81d6d82210cd4a2cf40ab6098e65edc3a8bb8d0e14849ddb7
+  metadata.gz: 4d112bf8f896e770e61346f4f64c2dff39c1d5ec630321d811fadbcf4a96cb0b
+  data.tar.gz: 58242b6240dc5400dd1262a4e7692574d60fe2415e6957db8bf7ec0fd52d861c
 SHA512:
-  metadata.gz: b16670dfae47bb27c8b7ab2464831fda91baed37d721ae88e5c5a9787a2db5ec888b500922bbd111107cee8d91823e70c7d3111818aed2adf419af524a6313dc
-  data.tar.gz: 3b6daf8eb6a5ed06ee0d1688b8fd688a3ec21527525db103132cd933f28b25576c55b4b530062f9f88bb0d097f618048eff45dee71a1abe5866e21eb8c74cbd9
+  metadata.gz: 68e35d997825c8f3f5349236688db5be5b7c1fc8f5b560f53321e666a4e7dc7dd94c837fe6bf13d97c13d22d34010f0201d3a697956b212c157d835a3549fb15
+  data.tar.gz: '087381e615bfa11ddeeacdeca1fbfb866ca4c70977f60df1ad4d02e7fd25b12154e32158e32ada3fe4815ce122288a097112877e85c3ac0cbe4e6bf284b878c0'

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Change log
 
+## [v0.2.0] - 2020-08-11
+
+### Changed
+* Change String#wrap to preserve newline character breaks
+* Change gemspec to remove test artefacts and bundler dev dependency
+* Change gemspec to require Ruby >= 2.0.0
+
+## [v0.1.8] - 2019-11-24
+
+### Fixed
+* Fix Ruby 2.7 warnings by Ryan Davis(@zenspider)
+
+## [v0.1.7] - 2019-11-14
+
+### Added
+* Add metadata to gemspec
+
+### Fixed
+* Fix Truncate#truncate to accept length of 1 by Katelyn Schiesser(@slowbro)
+
+## [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
+* Change to update unicode-display_width to the latest version
+* Change to relax development dependencies versions
+
 ## [v0.1.4] - 2018-09-10
 
 ### Fixed
@@ -22,8 +58,13 @@
 
 ## [v0.1.0] - 2018-01-07
 
-* Inital implementation and release
+* Initial implementation and release
 
+[v0.2.0]: https://github.com/piotrmurach/strings/compare/v0.1.8...v0.2.0
+[v0.1.8]: https://github.com/piotrmurach/strings/compare/v0.1.7...v0.1.8
+[v0.1.7]: https://github.com/piotrmurach/strings/compare/v0.1.6...v0.1.7
+[v0.1.6]: https://github.com/piotrmurach/strings/compare/v0.1.5...v0.1.6
+[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
 [v0.1.2]: https://github.com/piotrmurach/strings/compare/v0.1.1...v0.1.2

data/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <img width="225" src="https://cdn.rawgit.com/piotrmurach/strings/master/assets/strings_logo.png" alt="strings logo" />
+  <img width="225" src="https://github.com/piotrmurach/strings/blob/master/assets/strings_logo.png" alt="strings logo" />
 </div>
 
 # Strings
@@ -18,7 +18,7 @@
 [coverage]: https://coveralls.io/github/piotrmurach/strings?branch=master
 [inchpages]: http://inch-ci.org/github/piotrmurach/strings
 
-> The `Strings` is a set of useful functions such as fold, truncate, wrap, and many more for transforming strings.
+> A set of useful methods for working with strings such as align, truncate, wrap, and many more.
 
 ## Installation
 
@@ -41,8 +41,9 @@ Or install it yourself as:
 * No monkey-patching String class
 * Functional 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)
+* Handles languages without white-spaces between words (like Chinese and Japanese)
 * Supports ANSI escape codes
+* Flexible by nature, split into [components](#4-components)
 
 ## Contents
 
@@ -56,7 +57,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)
+* [4. Components](#4-components)
 
 ## 1. Usage
 
@@ -132,14 +133,14 @@ Strings.align_left(text, 20)
 
 ### 2.2 ansi?
 
-To check if a string includes ANSI escape codes use `ansi?` like so:
+To check if a string includes ANSI escape codes use `ansi?` method like so:
 
 ```ruby
 Strings.ansi?("\e[33;44mfoo\e[0m")
 # => true
 ```
 
-or
+Or fully qualified name:
 
 ```ruby
 Strings::ANSI.ansi?("\e[33;44mfoo\e[0m")
@@ -148,7 +149,7 @@ Strings::ANSI.ansi?("\e[33;44mfoo\e[0m")
 
 ### 2.3 fold
 
-To fold a multiline text into a single line preserving whitespace characters use `fold`:
+To fold a multiline text into a single line preserving white-space characters use `fold`:
 
 ```ruby
 Strings.fold("\tfoo \r\n\n bar")
@@ -277,7 +278,7 @@ text = 'ラドクリフ、マラソン五輪代表に1万m出場にも含み'
 Strings.truncate(text, 12)   # => "ラドクリフ…"
 ```
 
-**Strings::Truncate** works with ANSI escape codoes:
+**Strings::Truncate** works with ANSI escape codes:
 
 ```ruby
 text = "I try \e[34mall things\e[0m, I achieve what I can"
@@ -287,12 +288,12 @@ Strings.truncate(text, 18)
 
 ### 2.7 wrap
 
-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.
+To wrap text into lines no longer than `wrap_at` argument length, the `wrap` method will break either on white-space character or in case of east Asian characters on character boundaries.
 
 Given the following text:
 
 ```ruby
-text "Think not, is my eleventh commandment; and sleep when you can, is my twelfth."
+text = "Think not, is my eleventh commandment; and sleep when you can, is my twelfth."
 ```
 
 Then to wrap the text to given length do:
@@ -338,7 +339,7 @@ Strings::Wrap.wrap(text, wrap_at)
 
 ## 3. Extending String class
 
-Though it is highly discouraged to polute core Ruby classes, you can add the required methods to `String` class by using refinements.
+Though it is highly discouraged to pollute core Ruby classes, you can add the required methods to `String` class by using refinements.
 
 For example, if you wish to only extend strings with `wrap` method do:
 
@@ -352,7 +353,7 @@ module MyStringExt
 end
 ```
 
-then `wrap` method will be available for any strings where refinement is applied:
+Then `wrap` method will be available for any strings where refinement is applied:
 
 ```ruby
 using MyStringExt
@@ -368,13 +369,16 @@ require 'strings/extensions'
 using Strings::Extensions
 ```
 
-## 4. Utilities
+## 4. Components
 
-**Strings** aims to be fleaxible and allow you to choose only the utilities that you need. Currently you can choose from:
+**Strings** aims to be flexible and allow you to choose only the components that you need. Currently you can choose from:
 
-|  Utility     | Description | API docs |
+|  Component   | 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) |
+| [strings-case](https://github.com/piotrmurach/strings-case) | Handle case transformations in strings. | [docs](http://www.rubydoc.info/gems/strings-case) |
+| [strings-inflection](https://github.com/piotrmurach/strings-inflection) | Inflects English nouns and verbs. | [docs](http://www.rubydoc.info/gems/strings-inflection) |
+| [strings-numeral](https://github.com/piotrmurach/strings-numeral) | Express numbers as word numerals. | [docs](http://www.rubydoc.info/gems/strings-numeral) |
 
 ## Development
 
@@ -386,7 +390,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`)
@@ -402,4 +406,4 @@ Everyone interacting in the Strings project’s codebases, issue trackers, chat
 
 ## Copyright
 
-Copyright (c) 2017-2018 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2017 Piotr Murach. See LICENSE for further details.

data/lib/strings.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'strings-ansi'
+require "strings-ansi"
 
-require_relative 'strings/align'
-require_relative 'strings/fold'
-require_relative 'strings/pad'
-require_relative 'strings/truncate'
-require_relative 'strings/wrap'
-require_relative 'strings/version'
+require_relative "strings/align"
+require_relative "strings/fold"
+require_relative "strings/pad"
+require_relative "strings/truncate"
+require_relative "strings/wrap"
+require_relative "strings/version"
 
 module Strings
   # Align text within the width.
@@ -15,8 +15,8 @@ module Strings
   # @see Strings::Align#align
   #
   # @api public
-  def align(*args)
-    Align.align(*args)
+  def align(*args, **kws)
+    Align.align(*args, **kws)
   end
   module_function :align
 

data/lib/strings/align.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'strings-ansi'
-require 'unicode/display_width'
+require "strings-ansi"
+require "unicode/display_width"
 
 module Strings
   # Responsible for text alignment
   module Align
-    NEWLINE = "\n".freeze
-
-    SPACE = ' '.freeze
+    NEWLINE = "\n"
+    SPACE = " "
+    LINE_BREAK = %r{\r\n|\r|\n}.freeze
 
     # Aligns text within the width.
     #
@@ -23,23 +23,24 @@ module Strings
     # @example
     #   text = "the madness of men"
     #
-    #   Strings::Align.align(22, :left)
+    #   Strings::Align.align(text, 22, direction: :left)
     #   # => "the madness of men      "
     #
-    #   Strings::Align.align(22, :center)
+    #   Strings::Align.align(text, 22, direction: :center)
     #   # => "   the madness of men   "
     #
-    #   Strings::Align(22, :right)
+    #   Strings::Align(text, 22, direction: :right)
     #   # => "      the madness of men"
     #
-    #   Strings::Align.align(22, :center, fill: '*)
+    #   Strings::Align.align(text, 22, direction: :center, fill: "*")
     #   # => "***the madness of men***"
     #
     # @api public
     def align(text, width, direction: :left, **options)
       return text if width.nil?
+
       method = to_alignment(direction)
-      send(method, text, width, options)
+      send(method, text, width, **options)
     end
     module_function :align
 
@@ -62,9 +63,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 +83,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 +105,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/extensions.rb

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
 
-require_relative '../strings'
+require_relative "../strings"
 
 module Strings
   module Extensions
     refine String do
-      def align(*args)
-        Align.align(self, *args)
+      def align(*args, **kws)
+        Align.align(self, *args, **kws)
       end
 
-      def align_left(*args)
-        Align.align_left(self, *args)
+      def align_left(*args, **kws)
+        Align.align_left(self, *args, **kws)
       end
 
-      def align_right(*args)
-        Align.align_right(self, *args)
+      def align_center(*args, **kws)
+        Align.align_center(self, *args, **kws)
+      end
+
+      def align_right(*args, **kws)
+        Align.align_right(self, *args, **kws)
       end
 
       def ansi?
@@ -25,8 +29,8 @@ module Strings
         Fold.fold(self, *args)
       end
 
-      def pad(*args)
-        Pad.pad(self, *args)
+      def pad(*args, **kws)
+        Pad.pad(self, *args, **kws)
       end
 
       def sanitize
@@ -37,8 +41,8 @@ module Strings
         Truncate.truncate(self, *args)
       end
 
-      def wrap(*args)
-        Wrap.wrap(self, *args)
+      def wrap(*args, **kws)
+        Wrap.wrap(self, *args, **kws)
       end
     end
   end # Extensions

data/lib/strings/fold.rb

@@ -7,7 +7,7 @@ module Strings
     # Fold a multiline text into a single line string
     #
     # @example
-    #   fold("\tfoo \r\n\n bar") # => "foo  bar"
+    #   fold("\tfoo \r\n\n bar") # => " foo  bar"
     #
     # @param [String] text
     #
@@ -20,7 +20,7 @@ module Strings
     def fold(text, separator = LINE_BREAK)
       text.gsub(/([ ]+)#{separator}/, "\\1")
           .gsub(/#{separator}(?<space>[ ]+)/, "\\k<space>")
-          .gsub(/#{separator}/, ' ')
+          .gsub(/#{separator}/, " ")
     end
     module_function :fold
   end # Fold

data/lib/strings/pad.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'strings-ansi'
-require 'unicode/display_width'
+require "strings-ansi"
+require "unicode/display_width"
 
-require_relative 'padder'
+require_relative "padder"
 
 module Strings
   # Responsible for text padding
   module Pad
-    NEWLINE = "\n".freeze
-
-    SPACE = ' '.freeze
+    NEWLINE = "\n"
+    SPACE = " "
+    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
 
@@ -77,7 +79,7 @@ module Strings
     # @api private
     def max_line_length(text, separator)
       lines = text.split(separator, -1)
-      display_width(lines.max_by { |line| display_width(line) } || '')
+      display_width(lines.max_by { |line| display_width(line) } || "")
     end
     module_function :max_line_length