module StringUtility

Gets a random six-digit hexadecimal web color string. @return [String] See random_color_three

# File lib/string_utility.rb, line 76
def self.random_color_six
  random_color(6)
end

Gets a random three-digit hexadecimal web color string. @return [String] A random hexadecimal.

# File lib/string_utility.rb, line 70
def self.random_color_three
  random_color(3)
end

Gets a random line in a file. This will include newlines and similar characters, so you may want to chomp the result. @param path [String] The path to the file. @return [String] A random line in the file.

# File lib/string_utility.rb, line 63
def self.random_line(path)
  lines = File.readlines(path)
  lines[rand(lines.count)]
end

Separates the string by another string. Useful for converting integers

into human-readable numbers.

@param count [Int] The number of integers to separate by. Defaults to 3. @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] A new formatted version of the provided string.

# File lib/string_utility.rb, line 10
def separate(count = 3, separator = ',')
  chars.reverse!.each_slice(count).map(&:join).join(separator[0]).reverse!
end

In-place version of separate. This is about two times slower than the non-destructive variant. This is because

the destructive version (this one) uses regular expressions to insert the string.

see separate

# File lib/string_utility.rb, line 17
def separate!(count = 3, separator = ',')
  reverse!
  gsub!(/(.{#{count}})/, "\\1#{separator[0]}")
  # Because of that regular expression, sometimes a separator character will be inserted at the end.
  # For example, '1000'.separate!(2) would result in ,10,00.
  # This is not ideal, but it works.
  chomp!(separator[0])
  reverse!
end

Replaces all underscores with whitespace. Does not modify the source string. @return [String] A new string with replaced underscores.

# File lib/string_utility.rb, line 47
def spacify
  gsub('_', ' ')
end

Replaces all underscores with whitespace. Modifies the source string in-place.

# File lib/string_utility.rb, line 52
def spacify!
  gsub!('_', ' ')
end

Converts a separated string into an integer. This is basically the reverse of separate. Does not modify the

source string.

@return [Integer] The integer version of the separated string.

# File lib/string_utility.rb, line 30
def to_i_separated
  gsub(/\D/, '').to_i
end

Replaces all whitespace with underscores. Does not modify the source string. @return [String] A new string with replaced whitespace.

# File lib/string_utility.rb, line 36
def underscorify
  gsub(/\s/, '_')
end

Replaces all whitespace with underscores. Modifies the source string in-place.

# File lib/string_utility.rb, line 41
def underscorify!
  gsub!(/\s/, '_')
end