class R10K::Environment::Name

Handle environment name validation and modification.

@api private

Constants

INVALID_CHARACTERS

Attributes

name[R]

@!attribute [r] name

@return [String] The functional name of the environment derived from inputs and options.

original_name[R]

@!attribute [r] original_name

@return [String] The unmodified name originally given to create the object.

Public Class Methods

new(original_name, opts) click to toggle source

# File lib/r10k/environment/name.rb, line 18
def initialize(original_name, opts)
  @source  = opts[:source]
  @prefix  = opts[:prefix]
  @invalid = opts[:invalid]

  @name = derive_name(original_name, opts[:strip_component])
  @original_name = original_name
  @opts = opts

  case @invalid
  when 'correct_and_warn'
    @validate = true
    @correct  = true
  when 'correct'
    @validate = false
    @correct  = true
  when 'error'
    @validate = true
    @correct  = false
  when NilClass
    @validate = opts[:validate]
    @correct = opts[:correct]
  end
end

Public Instance Methods

correct?() click to toggle source

Should the environment name have invalid characters removed?

# File lib/r10k/environment/name.rb, line 44
def correct?
  @correct
end

dirname() click to toggle source

The directory name for the environment, modified as necessary to remove invalid characters.

@return [String]

# File lib/r10k/environment/name.rb, line 64
def dirname
  dir = @name.dup

  prefix = derive_prefix(@source,@prefix)

  if @correct
    dir.gsub!(INVALID_CHARACTERS, '_')
  end

  "#{prefix}#{dir}"
end

valid?() click to toggle source

# File lib/r10k/environment/name.rb, line 52
def valid?
  if @validate
    ! @name.match(INVALID_CHARACTERS)
  else
    true
  end
end

validate?() click to toggle source

# File lib/r10k/environment/name.rb, line 48
def validate?
  @validate
end

Private Instance Methods

derive_name(original_name, strip_component) click to toggle source

# File lib/r10k/environment/name.rb, line 79
def derive_name(original_name, strip_component)
  return original_name unless strip_component

  unless strip_component.is_a?(String)
    raise _('Improper configuration value given for strip_component setting in %{src} source. ' \
            'Value must be a string, a /regex/, false, or omitted. Got "%{val}" (%{type})' \
            % {src: @source, val: strip_component, type: strip_component.class})
  end

  if %r{^/.*/$}.match(strip_component)
    regex = Regexp.new(strip_component[1..-2])
    original_name.gsub(regex, '')
  elsif original_name.start_with?(strip_component)
    original_name[strip_component.size..-1]
  else
    original_name
  end
end

derive_prefix(source,prefix) click to toggle source

# File lib/r10k/environment/name.rb, line 98
def derive_prefix(source,prefix)
  if prefix == true
    "#{source}_"
  elsif prefix.is_a? String
    "#{prefix}_"
  else
    nil
  end
end