strings 0.1.4 → 0.2.0

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)

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
 
@@ -27,15 +27,15 @@ module Strings
     #   text = "The sovereignest thing on earth is parmacetti for an inward bruise."
     #
     #   Strings::Truncate.truncate(text)
-    #   # => "The sovereignest thing on ear…"
+    #   # => "The sovereignest thing on ea…"
     #
     #   Strings::Truncate.truncate(text, 20)
-    #   # => "The sovereignest th…"
+    #   # => "The sovereignest t…"
     #
-    #   Strings::Truncate.truncate(text, 20, separator: ' ' )
+    #   Strings::Truncate.truncate(text, 20, separator: " " )
     #   # => "The sovereignest…"
     #
-    #   Strings::Truncate.truncate(40, trailing: '... (see more)' )
+    #   Strings::Truncate.truncate(text, 40, trailing: "... (see more)" )
     #   # => "The sovereignest thing on... (see more)"
     #
     # @api public
@@ -70,6 +70,7 @@ module Strings
     # @api private
     def shorten(original_chars, chars, length_without_trailing)
       truncated = []
+      return truncated if length_without_trailing.zero?
       char_width = display_width(chars[0])
       while length_without_trailing - char_width > 0
         orig_char = original_chars.shift

data/lib/strings/version.rb

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

data/lib/strings/wrap.rb

@@ -1,55 +1,49 @@
 # 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
-
-    LINE_BREAK = "\r\n+|\r+|\n+".freeze
+    NEWLINE = "\n"
+    SPACE = " "
+    LINE_BREAK = %r{\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.
     #
     # @example
     #   Strings::Wrap.wrap("Some longish text", 8)
-    #   # => >Some
-    #        >longish
-    #        >text
+    #   # => "Some \nlongish \ntext"
     #
     # @api public
-    def wrap(text, wrap_at = DEFAULT_WIDTH)
-      if text.length < wrap_at.to_i || wrap_at.to_i.zero?
+    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 = []
-      text.split(%r{#{LINE_BREAK}}, -1).map do |paragraph|
-        format_paragraph(paragraph, wrap_at, ansi_stack)
-      end * NEWLINE
+      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  = []
@@ -58,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
@@ -70,7 +64,12 @@ module Strings
           elsif ansi_matched
             ansi_stack << [ansi[0...-1].join, line_length + word_length]
             ansi_matched = false
-            ansi = []
+
+            if ansi.last == Strings::ANSI::CSI
+              ansi = [ansi.last]
+            else
+              ansi = []
+            end
           end
           next if ansi.length > 0
         end
@@ -91,65 +90,76 @@ module Strings
         end
 
         if char == SPACE # ends with space
-          lines << insert_ansi(ansi_stack, line.join)
+          lines << insert_ansi(line.join, ansi_stack)
           line = []
           line_length = 0
           word << char
           word_length += char_length
         elsif word_length + char_length <= wrap_at
-          lines << insert_ansi(ansi_stack, line.join)
+          lines << insert_ansi(line.join, ansi_stack)
           line = [word.join + char]
           line_length = word_length + char_length
           word = []
           word_length = 0
         else # hyphenate word - too long to fit a line
-          lines << insert_ansi(ansi_stack, word.join)
+          lines << insert_ansi(word.join, ansi_stack)
           line_length = 0
           word = [char]
           word_length = char_length
         end
       end
-      lines << insert_ansi(ansi_stack, line.join) unless line.empty?
-      lines << insert_ansi(ansi_stack, word.join) unless word.empty?
+      lines << insert_ansi(line.join, ansi_stack) unless line.empty?
+      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
     #
     # Check if there are any ANSI states, if present
     # insert ANSI codes at given positions unwinding the stack.
     #
-    # @param [Array[Array[String, Integer]]] ansi_stack
-    #   the ANSI codes to apply
-    #
     # @param [String] string
     #   the string to insert ANSI codes into
     #
+    # @param [Array[Array[String, Integer]]] ansi_stack
+    #   the ANSI codes to apply
+    #
     # @return [String]
     #
     # @api private
-    def insert_ansi(ansi_stack, string)
+    def insert_ansi(string, ansi_stack = [])
       return string if ansi_stack.empty?
-      to_remove = 0
-      reset_index = -1
-      output = string.dup
-      resetting = false
-      ansi_stack.reverse_each do |state|
-        if state[0] =~ /#{Regexp.quote(Strings::ANSI::RESET)}/
-          resetting = true
-          reset_index = state[1]
-          to_remove += 2
+      return string if string.empty?
+
+      new_stack = []
+      output          = string.dup
+      length          = string.size
+      matched_reset   = false
+      ansi_reset      = Strings::ANSI::RESET
+
+      # Reversed so that string index don't count ansi
+      ansi_stack.reverse_each do |ansi|
+        if ansi[0] =~ /#{Regexp.quote(ansi_reset)}/
+          matched_reset = true
+          output.insert(ansi[1], ansi_reset)
           next
-        elsif !resetting
-          reset_index = -1
-          resetting = false
+        elsif !matched_reset # ansi without reset
+          matched_reset = false
+          new_stack << ansi # keep the ansi
+          next if ansi[1] == length
+          if output.end_with?(NEWLINE)
+            output.insert(-2, ansi_reset)
+          else
+            output.insert(-1, ansi_reset) # add reset at the end
+          end
         end
 
-        color, color_index = *state
-        output.insert(reset_index, Strings::ANSI::RESET).insert(color_index, color)
+        output.insert(ansi[1], ansi[0])
       end
-      ansi_stack.pop(to_remove) # remove used states
+
+      ansi_stack.replace(new_stack)
+
       output
     end
     module_function :insert_ansi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strings
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strings-ansi
@@ -16,98 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: unicode_utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !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:
-- ''
+- 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,31 +103,15 @@ 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/wrap_spec.rb
-- spec/unit/wrap_spec.rb
-- strings.gemspec
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-homepage: ''
+homepage: https://github.com/piotrmurach/strings
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/piotrmurach/strings/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/strings
+  homepage_uri: https://github.com/piotrmurach/strings
+  source_code_uri: https://github.com/piotrmurach/strings
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -150,16 +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: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+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: []