ellipsized 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c05fb67e627a48333959a2e5939faf1ef73fec35c8bc3cb81f106452089797c
-  data.tar.gz: 4196eaefe1dbf1ba369d2c35248ae762653e842b8f371529241d9a730caa9773
+  metadata.gz: abc2bd33ae6083981ccec4e019ae59fb4b8f572201137b2cc2b0e34dbea907b7
+  data.tar.gz: 447f61c07ba3e232ee181c8ed4bd1ecfba632085e409230d816b5e524ceec940
 SHA512:
-  metadata.gz: 5b870d389d1f990a94af3a5f381c486eb144c7984704c97f75fd0ebd8fc66788583de8b58067e509ca9a3a4bc202d56b699125f336aaa04f5cb0254507536d9a
-  data.tar.gz: 39e19c22d146df6356ded9ebf56297fb9dadaf681eab7e4a15081c3ff04a1ab8d30a8035ca811a090e6c98faa9a129b72c2a8abb9f1058b4783e671033dc7b08
+  metadata.gz: 13a5933003e880a53970c9931d29be03d3ac985cc994261683e0876ad28a14900b8eb2423d000d68b7b601a6fa5a351c351903562b1b9430cb36b2ba005c21c3
+  data.tar.gz: 7d870cd017c7b628a23546bb62e724eaa357ec145ce5e4dd701158bf4984a76174448afc586868c045732edcc94df98e00e276ce70824ea757b2116cc5e31b83

data/.github/workflows/copyrights.yml

@@ -16,4 +16,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: yegor256/copyrights-action@0.0.8
+      - uses: yegor256/copyrights-action@0.0.12

data/.rubocop.yml

@@ -19,4 +19,10 @@ Layout/EndOfLine:
 Style/EvalWithLocation:
   Enabled: false
 Metrics/AbcSize:
-  Max: 25
+  Max: 30
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
+Metrics/MethodLength:
+  Max: 30

data/Gemfile.lock

@@ -10,7 +10,7 @@ GEM
     ast (2.4.3)
     builder (3.3.0)
     docile (1.4.1)
-    json (2.12.0)
+    json (2.12.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     minitest (5.25.5)
@@ -26,10 +26,10 @@ GEM
     prism (1.4.0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
+    rake (13.3.0)
     regexp_parser (2.10.0)
     rexml (3.4.1)
-    rubocop (1.75.6)
+    rubocop (1.75.8)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -43,7 +43,7 @@ GEM
     rubocop-ast (1.44.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
-    rubocop-minitest (0.38.0)
+    rubocop-minitest (0.38.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)

data/README.md

@@ -12,7 +12,7 @@
 [![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 a required length by replacing
-part of it in the middle with an ellipsis:
+part of it in the middle with an [ellipsis]:
 
 ```ruby
 require 'ellipsized'
@@ -25,10 +25,10 @@ Prints:
 Hello, ...world!
 ```
 
-You can also specify what to fill the gap with:
+You can also specify what to use to fill the gap:
 
 ```ruby
-puts 'How are you doing?'.ellipsized(14, gap: '.. skip ..')
+puts 'How are you doing?'.ellipsized(14, '.. skip ..')
 ```
 
 Prints:
@@ -37,6 +37,18 @@ Prints:
 Ho.. skip ..g?
 ```
 
+You can also specify alignment:
+
+```ruby
+puts 'How are you doing?'.ellipsized(14, '.. skip ..', :left)
+```
+
+Prints:
+
+```text
+.. skip ..ing?
+```
+
 That's it.
 
 ## How to contribute
@@ -54,3 +66,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/_typos.toml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+[default.extend-words]
+tring = "tring"
+ther = "ther"
+ather = "ather"

data/ellipsized.gemspec

@@ -9,7 +9,7 @@ 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.1.0'
+  s.version = '0.2.0'
   s.license = 'MIT'
   s.summary = 'A simple Ruby gem that adds a .ellipsized() method to String'
   s.description =

data/lib/ellipsized.rb

@@ -15,7 +15,9 @@ class String
   # 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: '...')
+  # @param [String] gap The string to use as a gap (default: '...')
+  # @param [Symbol] align The alignment can be :left, :center, or :right
+  #   (default: :center)
   # @return [String] The truncated string with gap in the middle if necessary
   #
   # @example Basic usage with default parameters
@@ -27,23 +29,46 @@ class String
   #   # => "This is...truncated"
   #
   # @example Custom gap
-  #   "Another very long string example".ellipsized(15, gap: "***")
+  #   "Another very long string example".ellipsized(15, '***')
   #   # => "Anoth***example"
   #
+  # @example Custom align
+  #   "Another very long string example".ellipsized(15, '...', :left)
+  #   # => "...tring example"
+  #
   # @example Edge cases
   #   "".ellipsized      # => ""
   #   "Short".ellipsized # => "Short"
   #   "xyz".ellipsized(0) # => ""
-  #   "xyz".ellipsized(2, gap: "...") # => "xy"
-  def ellipsized(max = 64, gap: '...')
+  #   "xyz".ellipsized(2, '...') # => "xy"
+  def ellipsized(max = 64, gap = '...', align = :center)
+    validate_arguments(max, gap, align)
     return '' if empty?
     return self if length <= max
     return '' if max.zero?
+
+    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..]}"
+    case align
+    when :left
+      "#{gap}#{self[length - max + gap.length..]}"
+    when :center
+      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..]}"
+    when :right
+      "#{self[0, max - gap.length]}#{gap}"
+    end
+  end
+
+  private
+
+  def validate_arguments(max, gap, align)
+    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?
+    raise "The gap doesn't implement to_s()" unless gap.respond_to?(:to_s)
+    raise "Unsupported align: #{align}" unless %i[left center right].include?(align)
   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

@@ -13,11 +13,27 @@ class TestEllipsized < Minitest::Test
   def test_simple
     assert_equal('', ''.ellipsized)
     assert_equal('apple', 'apple'.ellipsized)
-    assert_equal('Мо...а', 'Москва спаленная пожаром французу отдана'.ellipsized(6))
+    assert_equal('Мо...?', 'Москва, спалённая пожаром, французу отдана?'.ellipsized(6))
     assert_equal('app...na', 'apple and banana'.ellipsized(8))
     assert_equal('пр...г!', 'привет, друг!'.ellipsized(7))
   end
 
+  def test_simple_left
+    assert_equal('', ''.ellipsized(64, '...', :left))
+    assert_equal('apple', 'apple'.ellipsized(64, '...', :left))
+    assert_equal('...на?', 'Москва, спалённая пожаром, французу отдана?'.ellipsized(6, '...', :left))
+    assert_equal('...anana', 'apple and banana'.ellipsized(8, '...', :left))
+    assert_equal('...руг!', 'привет, друг!'.ellipsized(7, '...', :left))
+  end
+
+  def test_simple_right
+    assert_equal('', ''.ellipsized(64, '...', :right))
+    assert_equal('apple', 'apple'.ellipsized(64, '...', :right))
+    assert_equal('Мос...', 'Москва, спалённая пожаром, французу отдана?'.ellipsized(6, '...', :right))
+    assert_equal('apple...', 'apple and banana'.ellipsized(8, '...', :right))
+    assert_equal('прив...', 'привет, друг!'.ellipsized(7, '...', :right))
+  end
+
   def test_with_very_small_window
     assert_equal('', 'The Godfather'.ellipsized(0))
     assert_equal('T', 'The Godfather'.ellipsized(1))
@@ -30,10 +46,78 @@ class TestEllipsized < Minitest::Test
     assert_equal('The...er', 'The Godfather'.ellipsized(8))
   end
 
+  def test_with_very_small_window_left
+    assert_equal('', 'The Godfather'.ellipsized(0, '...', :left))
+    assert_equal('T', 'The Godfather'.ellipsized(1, '...', :left))
+    assert_equal('Th', 'The Godfather'.ellipsized(2, '...', :left))
+    assert_equal('The', 'The Godfather'.ellipsized(3, '...', :left))
+    assert_equal('...r', 'The Godfather'.ellipsized(4, '...', :left))
+    assert_equal('...er', 'The Godfather'.ellipsized(5, '...', :left))
+    assert_equal('...her', 'The Godfather'.ellipsized(6, '...', :left))
+    assert_equal('...ther', 'The Godfather'.ellipsized(7, '...', :left))
+    assert_equal('...ather', 'The Godfather'.ellipsized(8, '...', :left))
+  end
+
+  def test_with_very_small_window_right
+    assert_equal('', 'The Godfather'.ellipsized(0, '...', :right))
+    assert_equal('T', 'The Godfather'.ellipsized(1, '...', :right))
+    assert_equal('Th', 'The Godfather'.ellipsized(2, '...', :right))
+    assert_equal('The', 'The Godfather'.ellipsized(3, '...', :right))
+    assert_equal('T...', 'The Godfather'.ellipsized(4, '...', :right))
+    assert_equal('Th...', 'The Godfather'.ellipsized(5, '...', :right))
+    assert_equal('The...', 'The Godfather'.ellipsized(6, '...', :right))
+    assert_equal('The ...', 'The Godfather'.ellipsized(7, '...', :right))
+    assert_equal('The G...', 'The Godfather'.ellipsized(8, '...', :right))
+  end
+
+  def test_with_empty_gap
+    assert_equal('', 'Encapsulation'.ellipsized(0, ''))
+    assert_equal('E', 'Encapsulation'.ellipsized(1, ''))
+    assert_equal('En', 'Encapsulation'.ellipsized(2, ''))
+    assert_equal('Enn', 'Encapsulation'.ellipsized(3, ''))
+    assert_equal('Enon', 'Encapsulation'.ellipsized(4, ''))
+    assert_equal('Encon', 'Encapsulation'.ellipsized(5, ''))
+    assert_equal('Encion', 'Encapsulation'.ellipsized(6, ''))
+  end
+
+  def test_with_empty_gap_left
+    assert_equal('', 'Encapsulation'.ellipsized(0, '', :left))
+    assert_equal('n', 'Encapsulation'.ellipsized(1, '', :left))
+    assert_equal('on', 'Encapsulation'.ellipsized(2, '', :left))
+    assert_equal('ion', 'Encapsulation'.ellipsized(3, '', :left))
+    assert_equal('tion', 'Encapsulation'.ellipsized(4, '', :left))
+    assert_equal('ation', 'Encapsulation'.ellipsized(5, '', :left))
+    assert_equal('lation', 'Encapsulation'.ellipsized(6, '', :left))
+  end
+
+  def test_with_empty_gap_right
+    assert_equal('', 'Encapsulation'.ellipsized(0, '', :right))
+    assert_equal('E', 'Encapsulation'.ellipsized(1, '', :right))
+    assert_equal('En', 'Encapsulation'.ellipsized(2, '', :right))
+    assert_equal('Enc', 'Encapsulation'.ellipsized(3, '', :right))
+    assert_equal('Enca', 'Encapsulation'.ellipsized(4, '', :right))
+    assert_equal('Encap', 'Encapsulation'.ellipsized(5, '', :right))
+    assert_equal('Encaps', 'Encapsulation'.ellipsized(6, '', :right))
+  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 ..')
+      'This story is very long to fit into a small window'.ellipsized(20, '.. skip ..')
+    )
+  end
+
+  def test_with_replacement_left
+    assert_equal(
+      '.. skip ..all window',
+      'This story is very long to fit into a small window'.ellipsized(20, '.. skip ..', :left)
+    )
+  end
+
+  def test_with_replacement_right
+    assert_equal(
+      'This story.. skip ..',
+      'This story is very long to fit into a small window'.ellipsized(20, '.. skip ..', :right)
     )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ellipsized
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -42,6 +42,7 @@ files:
 - README.md
 - REUSE.toml
 - Rakefile
+- _typos.toml
 - ellipsized.gemspec
 - lib/ellipsized.rb
 - renovate.json