lib/lotus/utils/path_prefix.rb in lotus-utils-0.3.1 vs lib/lotus/utils/path_prefix.rb in lotus-utils-0.3.2
- old
+ new
@@ -7,11 +7,11 @@
#
# @since 0.1.0
class PathPrefix < Lotus::Utils::String
# Path separator
#
- # @since x.x.x
+ # @since 0.3.1
# @api private
DEFAULT_SEPARATOR = '/'.freeze
# Initialize the path prefix
#
@@ -29,11 +29,11 @@
end
# Joins self with the given token.
# It cleans up all the `separator` repetitions.
#
- # @param string [::String] the token we want to join
+ # @param strings [::String] the token(s) we want to join
#
# @return [Lotus::Utils::PathPrefix] the joined string
#
# @since 0.1.0
#
@@ -59,11 +59,11 @@
end
# Joins self with the given token, without prefixing it with `separator`.
# It cleans up all the `separator` repetitions.
#
- # @param string [::String] the token we want to join
+ # @param strings [::String] the tokens we want to join
# @param separator [::String] the separator used between tokens
#
# @return [Lotus::Utils::PathPrefix] the joined string
#
# @raise [TypeError] if one of the argument can't be treated as a
@@ -91,11 +91,11 @@
# Modifies the path prefix to have a prepended separator.
#
# @return [self]
#
- # @since x.x.x
+ # @since 0.3.1
# @api private
#
# @see #absolute
def absolute!
@string.prepend(separator) unless absolute?
@@ -105,11 +105,11 @@
# Returns whether the path prefix starts with its separator.
#
# @return [TrueClass,FalseClass]
#
- # @since x.x.x
+ # @since 0.3.1
# @api private
#
# @example
# require 'lotus/utils/path_prefix'
#
@@ -121,10 +121,10 @@
# Modifies the path prefix to remove the leading separator.
#
# @return [self]
#
- # @since x.x.x
+ # @since 0.3.1
# @api private
#
# @see #relative
def relative!
@string.gsub!(%r{(?<!:)#{ separator * 2 }}, separator)