ellipsized 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6aecc397c82b24e3704bb3c017ff811e04034bc08b250b638226e797aa6e8921
-  data.tar.gz: 4800637798c1d81eb8fe49ee6b298654b3241e64ab4d75e22bd3af245a34abc9
+  metadata.gz: f3e00b5825661c9c4fd7a4dc9d98f1ba2e2bee79287ee92dc500577a822b640d
+  data.tar.gz: a36bd9c135be5d2aeb1831e6673059c4d1d3ad0e55de4ae560200316a49209c1
 SHA512:
-  metadata.gz: 10e2415e492615df00a82d62b48b84f9fb2498c8961460228595113f558b0e5f5186d4d02a8a193d6a73120119516c5b215792b023560103b3fb3f64e61ed036
-  data.tar.gz: 65745ccea3fbbb71d6b40a0eb36c0a17b4cf0dca816e0756c77c611677d86bdf56d5e033ac7ccf634284153466d8b8503888c1908ea9b65fef7d12ae7a13fbc2
+  metadata.gz: 63dd527b450d3bda6eed773830ddcf1296a5dbaddc2f7ffccf2d51a85e06b3eb3d3800de614be24aca7e5c8b2c1c4a3251c99bbbecd9e425e7ad469adbfe202b
+  data.tar.gz: df4702c055f20d2020cd053a10d9765149828d29c9fd966dd4c5252ad7c183faab75b0f786577c54996fdcc53ba735c544faf3d57c43753d5d242c55dca46590

data/.rubocop.yml

@@ -18,4 +18,11 @@ Layout/EndOfLine:
   EnforcedStyle: lf
 Style/EvalWithLocation:
   Enabled: false
-require: []
+Metrics/AbcSize:
+  Max: 30
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
+Metrics/MethodLength:
+  Max: 30

data/README.md

@@ -11,8 +11,8 @@
 [![Hits-of-Code](https://hitsofcode.com/github/yegor256/ellipsized)](https://hitsofcode.com/view/github/yegor256/ellipsized)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/ellipsized/blob/master/LICENSE.txt)
 
-It makes a string fit into required length, replacing
-part of it, in the middle, with ellipsis:
+It makes a string fit into a required length by replacing
+part of it in the middle with an [ellipsis]:
 
 ```ruby
 require 'ellipsized'
@@ -25,6 +25,18 @@ Prints:
 Hello, ...world!
 ```
 
+You can also specify what to fill the gap with:
+
+```ruby
+puts 'How are you doing?'.ellipsized(14, gap: '.. skip ..')
+```
+
+Prints:
+
+```text
+Ho.. skip ..g?
+```
+
 That's it.
 
 ## How to contribute
@@ -34,7 +46,7 @@ Read
 Make sure your build is green before you contribute
 your pull request. You will need to have
 [Ruby](https://www.ruby-lang.org/en/) 3.0+ and
-[Bundler](https://bundler.io/) installed. Then:
+[Bundler](https://bundler.io/) installed. Then run:
 
 ```bash
 bundle update
@@ -42,3 +54,5 @@ bundle exec rake
 ```
 
 If it's clean and you don't see any error messages, submit your pull request.
+
+[ellipsis]: https://en.wikipedia.org/wiki/Ellipsis

data/ellipsized.gemspec

@@ -9,15 +9,15 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.2'
   s.name = 'ellipsized'
-  s.version = '0.0.1'
+  s.version = '0.1.1'
   s.license = 'MIT'
-  s.summary = 'A simple Ruby gem that adds a .ellipsized() method to Array'
+  s.summary = 'A simple Ruby gem that adds a .ellipsized() method to String'
   s.description =
-    'It makes a string fit into required length, replacing ' \
-    'part of it, in the middle, with ellipsis.'
+    'It makes a string fit into a required length by replacing ' \
+    'part of it in the middle with an ellipsis.'
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
-  s.homepage = 'http://github.com/yegor256/ellipsized'
+  s.homepage = 'https://github.com/yegor256/ellipsized'
   s.files = `git ls-files`.split($RS)
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.rdoc_options = ['--charset=UTF-8']

data/lib/ellipsized.rb

@@ -3,20 +3,52 @@
 # SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
-# Replaces part of the text with ellipsis.
+# Replaces part of the text with a gap.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2025 Yegor Bugayenko
 # License:: MIT
 class String
-  # @param [Integer] max The maximum length of the string, expected
-  # @return [String] The text with ellipsis inside (if necessary)
-  def ellipsized(max = 64)
+  # Truncates a string to specified maximum length, inserting a gap in the middle
+  # if necessary. The resulting string will never be longer than the specified
+  # maximum length. The original string is returned if it is already shorter than
+  # or equal to the maximum length.
+  #
+  # @param [Integer] max The maximum length of the resulting string
+  # @param [String] gap The string to use as gap (default: '...')
+  # @return [String] The truncated string with gap in the middle if necessary
+  #
+  # @example Basic usage with default parameters
+  #   "Hello, world!".ellipsized
+  #   # => "Hello, world!"
+  #
+  # @example Truncate a long string
+  #   "This is a very long string that needs to be truncated".ellipsized(20)
+  #   # => "This is...truncated"
+  #
+  # @example Custom gap
+  #   "Another very long string example".ellipsized(15, gap: "***")
+  #   # => "Anoth***example"
+  #
+  # @example Edge cases
+  #   "".ellipsized      # => ""
+  #   "Short".ellipsized # => "Short"
+  #   "xyz".ellipsized(0) # => ""
+  #   "xyz".ellipsized(2, gap: "...") # => "xy"
+  def ellipsized(max = 64, gap: '...')
+    raise "Max length must be an Integer, while #{max.class.name} provided" unless max.is_a?(Integer)
+    raise "Max length (#{max}) is negative" if max.negative?
     return '' if empty?
     return self if length <= max
+    return '' if max.zero?
+    raise "The gap doesn't implement to_s()" unless gap.respond_to?(:to_s)
 
-    head = tail = (max - 3) / 2
-    head += 1 if head + tail + 3 < max
-    "#{self[0, head]}...#{self[length - tail..]}"
+    gap = gap.to_s
+    return self[0..max - 1] if gap.length >= max
+
+    head = tail = (max - gap.length) / 2
+    head += 1 if head + tail + gap.length < max
+    head = max if head > max
+    "#{self[0, head]}#{gap}#{self[length - tail..]}"
   end
 end

data/test/test__helper.rb

@@ -15,8 +15,8 @@ unless SimpleCov.running || ENV['PICKS']
       SimpleCov::Formatter::CoberturaFormatter
     ]
   )
-  SimpleCov.minimum_coverage 95
-  SimpleCov.minimum_coverage_by_file 90
+  SimpleCov.minimum_coverage 100
+  SimpleCov.minimum_coverage_by_file 100
   SimpleCov.start do
     add_filter 'test/'
     add_filter 'vendor/'

data/test/test_ellipsized.rb

@@ -17,4 +17,33 @@ class TestEllipsized < Minitest::Test
     assert_equal('app...na', 'apple and banana'.ellipsized(8))
     assert_equal('пр...г!', 'привет, друг!'.ellipsized(7))
   end
+
+  def test_with_very_small_window
+    assert_equal('', 'The Godfather'.ellipsized(0))
+    assert_equal('T', 'The Godfather'.ellipsized(1))
+    assert_equal('Th', 'The Godfather'.ellipsized(2))
+    assert_equal('The', 'The Godfather'.ellipsized(3))
+    assert_equal('T...', 'The Godfather'.ellipsized(4))
+    assert_equal('T...r', 'The Godfather'.ellipsized(5))
+    assert_equal('Th...r', 'The Godfather'.ellipsized(6))
+    assert_equal('Th...er', 'The Godfather'.ellipsized(7))
+    assert_equal('The...er', 'The Godfather'.ellipsized(8))
+  end
+
+  def test_with_empty_gap
+    assert_equal('', 'Encapsulation'.ellipsized(0, gap: ''))
+    assert_equal('E', 'Encapsulation'.ellipsized(1, gap: ''))
+    assert_equal('En', 'Encapsulation'.ellipsized(2, gap: ''))
+    assert_equal('Enn', 'Encapsulation'.ellipsized(3, gap: ''))
+    assert_equal('Enon', 'Encapsulation'.ellipsized(4, gap: ''))
+    assert_equal('Encon', 'Encapsulation'.ellipsized(5, gap: ''))
+    assert_equal('Encion', 'Encapsulation'.ellipsized(6, gap: ''))
+  end
+
+  def test_with_replacement
+    assert_equal(
+      'This .. skip ..indow',
+      'This story is very long to fit into a small window'.ellipsized(20, gap: '.. skip ..')
+    )
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ellipsized
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -9,8 +9,8 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: It makes a string fit into required length, replacing part of it, in
-  the middle, with ellipsis.
+description: It makes a string fit into a required length by replacing part of it
+  in the middle with an ellipsis.
 email: yegor256@gmail.com
 executables: []
 extensions: []
@@ -47,7 +47,7 @@ files:
 - renovate.json
 - test/test__helper.rb
 - test/test_ellipsized.rb
-homepage: http://github.com/yegor256/ellipsized
+homepage: https://github.com/yegor256/ellipsized
 licenses:
 - MIT
 metadata:
@@ -69,5 +69,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: A simple Ruby gem that adds a .ellipsized() method to Array
+summary: A simple Ruby gem that adds a .ellipsized() method to String
 test_files: []