strings 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8598a1eef564d4250363a7d49402bd1fe2e45880488042749c55fb4675ac090
-  data.tar.gz: c33aba524285885f8c9872bc4bea15a1242ebda47b532aaabe864975475ce9a1
+  metadata.gz: 4d112bf8f896e770e61346f4f64c2dff39c1d5ec630321d811fadbcf4a96cb0b
+  data.tar.gz: 58242b6240dc5400dd1262a4e7692574d60fe2415e6957db8bf7ec0fd52d861c
 SHA512:
-  metadata.gz: 5fa16d822454ebc169d6edb15b07e0db169bd5992d29ed00e6a00dc83ba06ce0dba04135cb3eabea5015d48ef41d043f61f8cd98f2afd2d079e4a99d7c981536
-  data.tar.gz: c4a24318dd99910246a3b047dddfd2e0e04186426d2ae39842ec9f6a6c84a008b5cb3697036dd62c5646fe49b5e50b602c853e76ccf5fbc354b0dae392ac7bf4
+  metadata.gz: 68e35d997825c8f3f5349236688db5be5b7c1fc8f5b560f53321e666a4e7dc7dd94c837fe6bf13d97c13d22d34010f0201d3a697956b212c157d835a3549fb15
+  data.tar.gz: '087381e615bfa11ddeeacdeca1fbfb866ca4c70977f60df1ad4d02e7fd25b12154e32158e32ada3fe4815ce122288a097112877e85c3ac0cbe4e6bf284b878c0'

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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
@@ -53,6 +60,7 @@
 
 * 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

data/README.md

@@ -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
 
@@ -293,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:
@@ -377,6 +377,8 @@ using Strings::Extensions
 | ------------ | ----------- | -------- |
 | [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
 

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.

data/lib/strings/align.rb

@@ -1,13 +1,13 @@
 # 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.
@@ -32,12 +32,13 @@ module Strings
     #   Strings::Align(text, 22, direction: :right)
     #   # => "      the madness of men"
     #
-    #   Strings::Align.align(text, 22, direction: :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)
     end

data/lib/strings/extensions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../strings'
+require_relative "../strings"
 
 module Strings
   module Extensions

data/lib/strings/fold.rb

@@ -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
-    LINE_BREAK =  %r{\r\n|\r|\n}.freeze
+    NEWLINE = "\n"
+    SPACE = " "
+    LINE_BREAK = %r{\r\n|\r|\n}.freeze
 
     # Apply padding to multiline text with ANSI codes
     #
@@ -79,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
 

data/lib/strings/truncate.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'strings-ansi'
-require 'unicode/display_width'
-require 'unicode_utils/each_grapheme'
+require "strings-ansi"
+require "unicode/display_width"
+require "unicode_utils/each_grapheme"
 
 module Strings
   # A module responsible for text truncation
   module Truncate
-    DEFAULT_TRAILING = '…'.freeze
+    DEFAULT_TRAILING = "…".freeze
 
     DEFAULT_LENGTH = 30
 
@@ -32,10 +32,10 @@ module Strings
     #   Strings::Truncate.truncate(text, 20)
     #   # => "The sovereignest t…"
     #
-    #   Strings::Truncate.truncate(text, 20, separator: ' ' )
+    #   Strings::Truncate.truncate(text, 20, separator: " " )
     #   # => "The sovereignest…"
     #
-    #   Strings::Truncate.truncate(text, 40, trailing: '... (see more)' )
+    #   Strings::Truncate.truncate(text, 40, trailing: "... (see more)" )
     #   # => "The sovereignest thing on... (see more)"
     #
     # @api public

data/lib/strings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Strings
-  VERSION = "0.1.8"
+  VERSION = "0.2.0"
 end # Strings

data/lib/strings/wrap.rb

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
-require 'strings-ansi'
-require 'unicode/display_width'
-require 'unicode_utils/each_grapheme'
-
-require_relative 'fold'
+require "strings-ansi"
+require "unicode/display_width"
+require "unicode_utils/each_grapheme"
 
 module Strings
   module Wrap
     DEFAULT_WIDTH = 80
-    NEWLINE = "\n".freeze
-    SPACE = " ".freeze
+    NEWLINE = "\n"
+    SPACE = " "
     LINE_BREAK = %r{\r\n|\r|\n}.freeze
-    LINE_BREAKS = "\r\n+|\r+|\n+".freeze
+    LINE_BREAKS = "\r\n+|\r+|\n+"
 
     # Wrap a text into lines no longer than wrap_at length.
     # Preserves existing lines and existing word boundaries.
@@ -22,31 +20,30 @@ module Strings
     #   # => "Some \nlongish \ntext"
     #
     # @api public
-    def wrap(text, wrap_at = DEFAULT_WIDTH, separator: nil)
+    def wrap(text, wrap_at = DEFAULT_WIDTH, separator: NEWLINE)
       if text.scan(/[[:print:]]/).length < wrap_at.to_i || wrap_at.to_i.zero?
         return text
       end
+
       ansi_stack = []
-      sep = separator || text[LINE_BREAK] || NEWLINE
-      text.split(%r{#{LINE_BREAKS}}, -1).map do |paragraph|
-        format_paragraph(paragraph, wrap_at, ansi_stack)
-      end * sep
+      text.lines.map do |line|
+        format_line(line, wrap_at, ansi_stack).join(separator)
+      end.join
     end
     module_function :wrap
 
-    # Format paragraph to be maximum of wrap_at length
+    # Format line to be maximum of wrap_at length
     #
-    # @param [String] paragraph
-    #   the paragraph to format
+    # @param [String] text_line
+    #   the line to format
     # @param [Integer] wrap_at
-    #   the maximum length to wrap the paragraph
+    #   the maximum length to wrap the line
     #
     # @return [Array[String]]
     #   the wrapped lines
     #
     # @api private
-    def format_paragraph(paragraph, wrap_at, ansi_stack)
-      cleared_para = Fold.fold(paragraph)
+    def format_line(text_line, wrap_at, ansi_stack)
       lines = []
       line  = []
       word  = []
@@ -55,10 +52,10 @@ module Strings
       word_length = 0
       line_length = 0
       char_length = 0 # visible char length
-      text_length = display_width(cleared_para)
+      text_length = display_width(text_line)
       total_length = 0
 
-      UnicodeUtils.each_grapheme(cleared_para) do |char|
+      UnicodeUtils.each_grapheme(text_line) do |char|
         # we found ansi let's consume
         if char == Strings::ANSI::CSI || ansi.length > 0
           ansi << char
@@ -115,7 +112,7 @@ module Strings
       lines << insert_ansi(word.join, ansi_stack) unless word.empty?
       lines
     end
-    module_function :format_paragraph
+    module_function :format_line
 
     # Insert ANSI code into string
     #
@@ -151,7 +148,11 @@ module Strings
           matched_reset = false
           new_stack << ansi # keep the ansi
           next if ansi[1] == length
-          output.insert(-1, ansi_reset) # add reset at the end
+          if output.end_with?(NEWLINE)
+            output.insert(-2, ansi_reset)
+          else
+            output.insert(-1, ansi_reset) # add reset at the end
+          end
         end
 
         output.insert(ansi[1], ansi[0])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strings
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-11-24 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strings-ansi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: unicode_utils
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-- !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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: A set of useful functions such as fold, truncate, wrap and more for transoforming
-  strings.
+description: A set of methods for working with strings such as align, truncate, wrap
+  and many more.
 email:
-- me@piotrmurach.com
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/strings.rb
 - lib/strings/align.rb
 - lib/strings/extensions.rb
@@ -117,28 +103,6 @@ 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/insert_ansi_spec.rb
-- spec/unit/wrap/wrap_spec.rb
-- spec/unit/wrap_spec.rb
-- strings.gemspec
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
 homepage: https://github.com/piotrmurach/strings
 licenses:
 - MIT
@@ -156,15 +120,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A set of useful functions for transforming strings.
+summary: A set of methods for working with strings.
 test_files: []