ellipsized 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbad7a5c29c4eef2b37c75324de9750fa344640d0997e4bf3269c39031d48031
-  data.tar.gz: a0eee5de3a754f5abf342fa949b45ac378f416f0b208be741457bc61a1e2969e
+  metadata.gz: 8e4185354881717b62aaf4170c011968eb50b5a7dd4fcc0947cb0a7192677c69
+  data.tar.gz: d36e583d3c9c31f57b00766e6441be34bcb93a4073fa3f38bba82d4170d25f94
 SHA512:
-  metadata.gz: 203bcbacf09f2e295b875003e117215562d6d6f7fec75de1d47055f9f975874a53c46c500d4cfe9539d9d03bde2458c60b64ebac71e7348cfe1658f89d67b89e
-  data.tar.gz: bc98ff7b40d005c9779a309635eeff534d9c203974dbc19201bfef1e116be704f5d2f2fadb0db7bc0a7ebf9103ca4c3e0f670a498358a97450988d3fba275f87
+  metadata.gz: adf0564a1ba5e3cbd27e4627a61e82e32f1d6f065c4b6a51de22c37b8942b1da8b0d0e8106334e327f49b4d1f39073038cc899f798b7e24deb381ad984ffc0f6
+  data.tar.gz: 2832a6bfa7f841f49fd83e4ca7a2150809cf7ffa800a914214f6dbebed5da9411e11433a955832f510039a4aaf1e85fb575f549a82c562e7634f658db21378ca

data/.rubocop.yml

@@ -19,10 +19,12 @@ Layout/EndOfLine:
 Style/EvalWithLocation:
   Enabled: false
 Metrics/AbcSize:
-  Max: 40
+  Max: 50
+Metrics/ClassLength:
+  Max: 112
 Metrics/CyclomaticComplexity:
-  Max: 14
+  Max: 22
 Metrics/PerceivedComplexity:
-  Max: 12
+  Max: 18
 Metrics/MethodLength:
-  Max: 30
+  Max: 38

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

data/lib/ellipsized.rb

@@ -14,10 +14,26 @@ class String
   # 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 a gap (default: '...')
-  # @param [Symbol] align The alignment can be :left, :center, or :right
-  #   (default: :center)
+  # @param [Array] args The mix of possible arguments passed to the method:
+  #  [Integer] max The maximum length of the resulting string (default: 64)
+  #  [String] gap The string to use as a gap (default: '...')
+  #  [Symbol] align The alignment can be :left, :center, or :right
+  #    (default: :center)
+  #  Since the three arguments have different types, we can distinguish them by
+  #  type. Based on that, the following permutations can be defined, 3! = 6:
+  #    s.ellipsized(10, '...', :right)
+  #    s.ellipsized(10, :right, '...')
+  #    s.ellipsized('...', 10, :right)
+  #    s.ellipsized('...', :right, 10)
+  #    s.ellipsized(:right, '...', 10)
+  #    s.ellipsized(:right, 10, '...')
+  #  Keep in mind, any argument may be omitted:
+  #    s.ellipsized(10, '...', :right)
+  #    s.ellipsized(10, :right)
+  #    s.ellipsized('...')
+  #    s.ellipsized(10)
+  #    s.ellipsized(:right)
+  #  All of the above are valid use cases.
   # @return [String] The truncated string with gap in the middle if necessary
   #
   # @example Basic usage with default parameters
@@ -41,16 +57,36 @@ class String
   #   "Short".ellipsized # => "Short"
   #   "xyz".ellipsized(0) # => ""
   #   "xyz".ellipsized(2, '...') # => "xy"
-  def ellipsized(max = 64, gap = '...', align = :center)
-    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)
+  def ellipsized(*args)
+    raise "Unsupported number of arguments: #{args.length}" if args.length > 3
+
+    max = gap = align = nil
+    args.each do |arg|
+      raise "Unsupported argument type: #{arg}" unless [
+        Integer,
+        String,
+        Symbol
+      ].include?(arg.class)
+
+      case arg
+      when Integer
+        max = arg
+        raise "Max length (#{max}) is negative" if max.negative?
+        return '' if max.zero?
+      when String
+        gap = arg
+      when Symbol
+        align = arg
+        raise "Unsupported align: #{align}" unless
+          %i[left center right].include?(align) # rubocop:disable Performance/CollectionLiteralInLoop
+      end
+    end
+    max ||= 64
+    gap ||= '...'
+    align ||= :center
+
     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
 
     case align

data/test/test_ellipsized.rb

@@ -120,4 +120,18 @@ class TestEllipsized < Minitest::Test
       'This story is very long to fit into a small window'.ellipsized(20, '.. skip ..', :right)
     )
   end
+
+  def test_arguments_permutations
+    assert_equal('app...na', 'apple and banana'.ellipsized(8))
+    assert_equal('app...na', 'apple and banana'.ellipsized(8, '...'))
+    assert_equal('app...na', 'apple and banana'.ellipsized('...', 8))
+    assert_equal('app...na', 'apple and banana'.ellipsized(8, :center))
+    assert_equal('app...na', 'apple and banana'.ellipsized(:center, 8))
+    assert_equal('app...na', 'apple and banana'.ellipsized(8, '...', :center))
+    assert_equal('app...na', 'apple and banana'.ellipsized(8, :center, '...'))
+    assert_equal('app...na', 'apple and banana'.ellipsized('...', 8, :center))
+    assert_equal('app...na', 'apple and banana'.ellipsized('...', :center, 8))
+    assert_equal('app...na', 'apple and banana'.ellipsized(:center, 8, '...'))
+    assert_equal('app...na', 'apple and banana'.ellipsized(:center, '...', 8))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ellipsized
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Yegor Bugayenko