string-utility 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2defc994ee582faf5c459b3be066bbbf9bc590f
-  data.tar.gz: f72122ba8058fe44ab3146f0840bbb411faa78c8
+  metadata.gz: 65f4ab68c518d824992c9a23668fff43c9cc059b
+  data.tar.gz: e7daf05079663691b8ae629b715c68a4101b8fe7
 SHA512:
-  metadata.gz: e316fd265940f7c7088d991149a049b1e3db5382b514aea73a0bf435504708092ec50008626bb6501b8124766d3963cbf584f6d3594d8588f0f77b0ae2d69379
-  data.tar.gz: 6198e97f447abfca20894832817b29ebebe7d8e74b24ad6f8affa93cb97dfdc9bfda4afc1c40a1d4698cb7c4d6688215c75a4eff1062863e7db10f08fe16c701
+  metadata.gz: 481e28a768310e5e4926a1b7bacb3d76a02dc88962abe2efe595298a595f9a6866017c1ed5a864232f3181d3e9f15d3528a45034294b6751ad58b3357a304fb9
+  data.tar.gz: fb0a4e78fa9ef435947020a9f9f9e798f616a601d0f792dacf5283dc84053212aa873206feddb82b35f55199cb3d481929dc20112565520994b12740f83248fc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 ## Version 2
+### Version 2.7.0
+* Improve random_line by not dividing by 0.
+* Add safely_gsub! refinement method for an easier, more readable version of `str.gsub!(pattern, replace) || str`.
+
 ### Version 2.6.1
 * Fix issue where to_i_separated, underscorify, and spacify returned nil, due to tr! and gsub! returning nil (#2).
 

data/lib/utils.rb

@@ -6,9 +6,9 @@ module StringUtility
     # @param separator [String] The string to use as a separator. Can only be
     #   1 character long. Will use the first character if it is greater than
     #   1 character long. Defaults to a comma.
-    # @return [String] Formatted version of the provided string.
+    # @return [String] A new formatted version of the provided string.
     def separate(count = 3, separator = ',')
-      separator = separator[0] if separator.length > 1
+      separator = separator[0]
       string = self
       string.reverse!
       string = string.scan(/.{1,#{count}}/).join(separator)
@@ -19,22 +19,28 @@ module StringUtility
     #   of #separate.
     # @return [Int] The integer version of the separated string.
     def to_i_separated
-      self.gsub!(/\D/, '') if self =~ /\D/
-      to_i
+      safely_gsub!(/\D/, '').to_i
     end
 
     # Replaces all whitespace with underscores.
     # @return [String] The string with replaced whitespace.
     def underscorify
-      self.gsub!(/\s/, '_') if self =~ /\s/
-      self
+      safely_gsub!(/\s/, '_')
     end
 
     # Replaces all underscores with whitespace.
     # @return [String] The string with replaced underscores.
     def spacify
-      self.tr!('_', ' ') if self.include?('_')
-      self
+      safely_gsub!('_', ' ')
+    end
+
+    # Readable shorthand for the only safe, fast way to use gsub! using || operators. Unlike gsub!, safely_gsub! will
+    # NEVER return nil. This method should not be used instead of gsub! when the string replacement is predictable, as
+    # this method is somewhat slower than gsub! (see spec/benchmark).
+    # @see #{String#gsub!} for parameters and other information.
+    # @return [String] Exactly what gsub! would return, or self. Never nil.
+    def safely_gsub!(pattern, replace)
+      gsub!(pattern, replace) || self
     end
   end
 
@@ -47,20 +53,21 @@ module StringUtility
     file = open(path)
     selected = nil
     file.each_with_index do |line, num|
-      selected = line if !line.nil? && rand < 1.0 / num
+      int = num == 0 ? 1.0 : 1.0 / num
+      selected = line if !line.nil? && rand < int
     end
     file.close
     selected
   end
 
-  # Gets a random three-digit hexidecimal web color string.
-  # @return [String] A random hexidecimal.
+  # Gets a random three-digit hexadecimal web color string.
+  # @return [String] A random hexadecimal.
   def self.random_color_three
     string = random_color(0..2)
     "##{string}"
   end
 
-  # Gets a random six-digit hexidecimal web color string.
+  # Gets a random six-digit hexadecimal web color string.
   # @return [String] See #random_color_three
   def self.random_color_six
     string = random_color(0..5)

data/spec/benchmark.rb

@@ -46,3 +46,36 @@ Benchmark.bm do |b|
     end
   end
 end
+
+Benchmark.bm do |b|
+  b.report('gsub! success') do
+    TIMES.times do
+      'ABC'.gsub!('ABC', '123')
+    end
+  end
+
+  b.report('safely_gsub! success') do
+    TIMES.times do
+      'ABC'.safely_gsub!('ABC', '123')
+    end
+  end
+
+  b.report('gsub! fail') do
+    TIMES.times do
+      'ABC'.gsub!('DEF', '456')
+    end
+  end
+
+  b.report('gsub! fail safe') do
+    TIMES.times do
+      str = 'ABC'
+      str.gsub!('DEF', '456') || str
+    end
+  end
+
+  b.report('safely_gsub! fail') do
+    TIMES.times do
+      'ABC'.safely_gsub!('DEF', '456')
+    end
+  end
+end

data/spec/testcases.rb

@@ -8,6 +8,7 @@ class TestStringUtility < Test::Unit::TestCase
     assert_equal('10,00', '1000'.separate(2))
     assert_equal('1:000', '1000'.separate(3, ':'))
     assert_equal('10:00', '1000'.separate(2, ':'))
+    assert_equal('100', '100'.separate)
   end
 
   def test_to_i_sparated
@@ -37,4 +38,10 @@ class TestStringUtility < Test::Unit::TestCase
   def test_random_color_six
     assert_instance_of(String, StringUtility.random_color_six)
   end
+
+  def test_safely_gsub
+    assert_equal('b', 'b'.safely_gsub!('a', '1'))
+    assert_not_nil('b'.safely_gsub!('a', '1'))
+    assert_equal('bb', 'ab'.safely_gsub!('a', 'b'))
+  end
 end

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: string-utility
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies: []
-description: |2
-      Some simple but handy methods to interact with string objects.
+description: "    Some simple but handy methods to interact with string objects.\n"
 email: elifosterwy@gmail.com
 executables: []
 extensions: []
@@ -43,9 +42,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provides some basic utilities for interacting with Strings
 test_files: []
-has_rdoc: