strings 0.1.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59762ac60270a0fa21a1989b6ec1bf8b98eac632fc9ff8c091ef7dd711a8baf8
-  data.tar.gz: 43276937aaef5a75cb43e8e29a6ea9f5f09b4488d22a84a03fa128de07840afb
+  metadata.gz: 763d67f8c555aab9f45587b8596a66f75d751b965fcf2782b1920bf5d5b97f6b
+  data.tar.gz: a894e46873337664f6a35863a6bffdbaa1603d1f9ddcacf448de9841226a43e8
 SHA512:
-  metadata.gz: 29244946de99fa208749f9ca7f88010b70b466f0d29583f76b9b982b9b299a69b14a1f76a43cd537f46e758f2f7e3e40f057d6506650b67fcd84d6e788f127c0
-  data.tar.gz: 6d8b306a59eaafb78308e293739dadaaded471ef2a97daffc3cf31681a490df05067845600faed4b2fdcf390aa307016934f07751a7d3aa5c5fff49363162812
+  metadata.gz: eddc0eb59fcf78d5d5c9d84246821cbf9559387d6c94f090bea855ec4928bb8648b464832c97b3c442b3a51748d41a51fc304fc4d5a38440d3889b4924e5ad65
+  data.tar.gz: 711fe7e35fa2c893a5e94f98e47674a16fc5e814c67d941101bead1e03d076ac6bf38e8e17a579c3a3353a3b30518214537fea040b45d7a149cd597d6a31134b

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Change log
 
+## [v0.2.1] - 2021-03-09
+
+### Changed
+* Change to relax unicode-display_width version constraint to allow 2.0 release
+
+## [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
@@ -30,6 +65,11 @@
 
 * Initial implementation and release
 
+[v0.2.1]: https://github.com/piotrmurach/strings/compare/v0.2.0...v0.2.1
+[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

data/README.md

@@ -1,24 +1,24 @@
 <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
 
 [![Gem Version](https://badge.fury.io/rb/strings.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/piotrmurach/strings.svg?branch=master)][travis]
+[![Actions CI](https://github.com/piotrmurach/strings/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
 [![Build status](https://ci.appveyor.com/api/projects/status/e11tn1fgjwnfwp3r?svg=true)][appveyor]
 [![Maintainability](https://api.codeclimate.com/v1/badges/4ca50e480f42af80678e/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/strings/badge.svg?branch=master)][coverage]
 [![Inline docs](http://inch-ci.org/github/piotrmurach/strings.svg?branch=master)][inchpages]
 
 [gem]: http://badge.fury.io/rb/strings
-[travis]: http://travis-ci.org/piotrmurach/strings
+[gh_actions_ci]: https://github.com/piotrmurach/strings/actions?query=workflow%3ACI
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/strings
 [codeclimate]: https://codeclimate.com/github/piotrmurach/strings/maintainability
 [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
 
@@ -43,6 +43,7 @@ Or install it yourself as:
 * Supports multibyte character encodings such as UTF-8, EUC-JP
 * 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
 
@@ -260,7 +261,7 @@ Strings::Truncate.truncate(text, 20) # => "for there is no fol…"
 If you want to split words on their boundaries use `:separator` option:
 
 ```ruby
-Strings.truncate(text, 20) # => "for there is no…"
+Strings.truncate(text, 20, separator: ' ') # => "for there is no…"
 ```
 
 Use `:trailing` option (by default `…`) to provide omission characters:
@@ -292,7 +293,7 @@ To wrap text into lines no longer than `wrap_at` argument length, the `wrap` met
 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:
@@ -368,13 +369,17 @@ require 'strings/extensions'
 using Strings::Extensions
 ```
 
-## 4. Utilities
+## 4. Components
 
-**Strings** aims to be flexible 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-ansi](https://github.com/piotrmurach/strings-ansi) | Handle ANSI escape codes in strings. | [docs](https://www.rubydoc.info/gems/strings-ansi) |
+| [strings-case](https://github.com/piotrmurach/strings-case) | Handle case transformations in strings. | [docs](https://www.rubydoc.info/gems/strings-case) |
+| [strings-inflection](https://github.com/piotrmurach/strings-inflection) | Inflects English nouns and verbs. | [docs](https://www.rubydoc.info/gems/strings-inflection) |
+| [strings-numeral](https://github.com/piotrmurach/strings-numeral) | Express numbers as word numerals. | [docs](https://www.rubydoc.info/gems/strings-numeral) |
+| [strings-truncation](https://github.com/piotrmurach/strings-truncation) | Truncate strings with fullwidth characters and ANSI codes. | [docs](https://www.rubydoc.info/gems/strings-truncation) |
 
 ## Development
 
@@ -386,7 +391,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/strings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-1. Fork it ( https://github.com/piotrmurach/verse/fork )
+1. Fork it ( https://github.com/piotrmurach/strings/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/strings.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
 

data/lib/strings/padder.rb

@@ -1,4 +1,4 @@
-# frozen_string_litera: true
+# frozen_string_literal: true
 
 module Strings
   # A class responsible for parsing padding value
@@ -45,7 +45,7 @@ module Strings
       elsif value.size == 4
         value
       else
-        raise ParseError, 'Wrong :padding parameter, must be an array'
+        raise ParseError, "Wrong :padding parameter, must be an array"
       end
     end
 
@@ -72,7 +72,7 @@ module Strings
 
     # Set top padding
     #
-    # @param [Integer] val
+    # @param [Integer] value
     #
     # @return [nil]
     #
@@ -92,7 +92,7 @@ module Strings
 
     # Set right padding
     #
-    # @param [Integer] val
+    # @param [Integer] value
     #
     # @api public
     def right=(value)