123456789_123456789_123456789_123456789_123456789_

Class: Bundler::Thor::Options

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Arguments
Instance Chain:
self, Arguments
Inherits: Bundler::Thor::Arguments
Defined in: lib/bundler/vendor/thor/lib/thor/parser/options.rb

Overview

rubocop:disable ClassLength

Constant Summary

Arguments - Inherited

NUMERIC

Class Method Summary

Arguments - Inherited

.new

Takes an array of Argument objects.
.parse,
.split

Receives an array of args and returns two arrays, one with arguments and one with switches.

Instance Attribute Summary

Arguments - Inherited

#current_is_value?, #last?

Instance Method Summary

Arguments - Inherited

#parse, #remaining,
#check_requirement!

Raises an error if @non_assigned_required array is not empty.
#no_or_skip?,
#parse_array

Runs through the argument array getting all strings until no string is found or a switch is found.
#parse_hash

Runs through the argument array getting strings that contains “:” and mark it as a hash:
#parse_numeric

Check if the peek is numeric format and return a Float or Integer.
#parse_string

Parse string: for –string-arg, just return the current value in the pile for –no-string-arg, nil Check if the peek is included in enum if enum is provided.
#peek, #shift, #unshift

Constructor Details

.new(hash_options = {}, defaults = {}, stop_on_unknown = false, disable_required_check = false) ⇒ Options

Takes a hash of Option and a hash with defaults.

If stop_on_unknown is true, #parse will stop as soon as it encounters an unknown option or a regular argument.

[ GitHub ] 

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 32



def initialize(hash_options = {}, defaults = {}, stop_on_unknown = false, disable_required_check = false)
  @stop_on_unknown = stop_on_unknown
  @disable_required_check = disable_required_check
  options = hash_options.values
  super(options)

  # Add defaults
  defaults.each do |key, value|
    @assigns[key.to_s] = value
    @non_assigned_required.delete(hash_options[key])
  end

  @shorts = {}
  @switches = {}
  @extra = []
  @stopped_parsing_after_extra_index = nil
  @is_treated_as_value = false

  options.each do |option|
    @switches[option.switch_name] = option

    option.aliases.each do |short|
      name = short.to_s.sub(/^(?!\-)/, "-")
      @shorts[name] ||= option.switch_name
    end
  end
end


  







Class Method Details



  

    .to_switches(options)  
  



  

    

Receives a hash and makes it switches.


  



  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 11



def self.to_switches(options)
  options.map do |key, value|
    case value
    when true
      "--#{key}"
    when Array
      "--#{key} #{value.map(&:inspect).join(' ')}"
    when Hash
      "--#{key} #{value.map { |k, v| "#{k}:#{v}" }.join(' ')}"
    when nil, false
      nil
    else
      "--#{key} #{value.inspect}"
    end
  end.compact.join(" ")
end


  







Instance Attribute Details



  

    #current_is_switch?  ⇒ Boolean  (readonly, protected)
  



  

    

Check if the current value in peek is a registered switch.



Two booleans are returned.  The first is true if the current value starts with a hyphen; the second is true if it is a registered switch.


  





  


  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 165



def current_is_switch?
  return [false, false] if @is_treated_as_value
  case peek
  when LONG_RE, SHORT_RE, EQ_RE, SHORT_NUM
    [true, switch?($1)]
  when SHORT_SQ_RE
    [true, $1.split("").any? { |f| switch?("-#{f}") }]
  else
    [false, false]
  end
end


  








  

    #current_is_switch_formatted?  ⇒ Boolean  (readonly, protected)
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 177



def current_is_switch_formatted?
  return false if @is_treated_as_value
  case peek
  when LONG_RE, SHORT_RE, EQ_RE, SHORT_NUM, SHORT_SQ_RE
    true
  else
    false
  end
end


  








  

    #current_is_value?  ⇒ Boolean  (readonly, protected)
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 187



def current_is_value?
  return true if @is_treated_as_value
  peek && (!parsing_options? || super)
end


  








  

    #parsing_options?  ⇒ Boolean  (readonly, protected)
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 210



def parsing_options?
  peek
  @parsing_options
end


  







Instance Method Details



  

    #assign_result!(option, result)   (protected)
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 151



def assign_result!(option, result)
  if option.repeatable && option.type == :hash
    (@assigns[option.human_name] ||= {}).merge!(result)
  elsif option.repeatable
    (@assigns[option.human_name] ||= []) << result
  else
    @assigns[option.human_name] = result
  end
end


  








  

    #check_unknown!  
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 141



def check_unknown!
  to_check = @stopped_parsing_after_extra_index ? @extra[0...@stopped_parsing_after_extra_index] : @extra

  # an unknown option starts with - or -- and has no more --'s afterward.
  unknown = to_check.select { |str| str =~ /^--?(?:(?!--).)*$/ }
  raise UnknownArgumentError.new(@switches.keys, unknown) unless unknown.empty?
end


  








  

    #normalize_switch(arg)   (protected)
  



  

    

Check if the given argument is actually a shortcut.


  



  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 206



def normalize_switch(arg)
  (@shorts[arg] || arg).tr("_", "-")
end


  








  

    #parse(args)  
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 88



def parse(args) # rubocop:disable MethodLength
  @pile = args.dup
  @is_treated_as_value = false
  @parsing_options = true

  while peek
    if parsing_options?
      match, is_switch = current_is_switch?
      shifted = shift

      if is_switch
        case shifted
        when SHORT_SQ_RE
          unshift($1.split("").map { |f| "-#{f}" })
          next
        when EQ_RE
          unshift($2, is_value: true)
          switch = $1
        when SHORT_NUM
          unshift($2)
          switch = $1
        when LONG_RE, SHORT_RE
          switch = $1
        end

        switch = normalize_switch(switch)
        option = switch_option(switch)
        result = parse_peek(switch, option)
        assign_result!(option, result)
      elsif @stop_on_unknown
        @parsing_options = false
        @extra << shifted
        @stopped_parsing_after_extra_index ||= @extra.size
        @extra << shift while peek
        break
      elsif match
        @extra << shifted
        @extra << shift while peek && peek !~ /^-/
      else
        @extra << shifted
      end
    else
      @extra << shift
    end
  end

  check_requirement! unless @disable_required_check

  assigns = Bundler::Thor::CoreExt::HashWithIndifferentAccess.new(@assigns)
  assigns.freeze
  assigns
end


  








  

    #parse_boolean(switch)   (protected)
  



  

    

Parse boolean values which can be given as –foo=true, –foo or –no-foo.


  



  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 217



def parse_boolean(switch)
  if current_is_value?
    if ["true", "TRUE", "t", "T", true].include?(peek)
      shift
      true
    elsif ["false", "FALSE", "f", "F", false].include?(peek)
      shift
      false
    else
      @switches.key?(switch) || !no_or_skip?(switch)
    end
  else
    @switches.key?(switch) || !no_or_skip?(switch)
  end
end


  








  

    #parse_peek(switch, option)   (protected)
  



  

    

Parse the value at the peek analyzing if it requires an input or not.


  



  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 235



def parse_peek(switch, option)
  if parsing_options? && (current_is_switch_formatted? || last?)
    if option.boolean?
      # No problem for boolean types
    elsif no_or_skip?(switch)
      return nil # User set value to nil
    elsif option.string? && !option.required?
      # Return the default if there is one, else the human name
      return option.lazy_default || option.default || option.human_name
    elsif option.lazy_default
      return option.lazy_default
    else
      raise MalformattedArgumentError, "No value provided for option '#{switch}'"
    end
  end

  @non_assigned_required.delete(option)
  send(:"parse_#{option.type}", switch)
end


  








  

    #peek  
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 64



def peek
  return super unless @parsing_options

  result = super
  if result == OPTS_END
    shift
    @parsing_options = false
    @stopped_parsing_after_extra_index ||= @extra.size
    super
  else
    result
  end
end


  








  

    #remaining  
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 60



def remaining
  @extra
end


  








  

    #shift  
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 78



def shift
  @is_treated_as_value = false
  super
end


  








  

    #switch?(arg)  ⇒ Boolean  (protected)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 192



def switch?(arg)
  !switch_option(normalize_switch(arg)).nil?
end


  








  

    #switch_option(arg)   (protected)
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 196



def switch_option(arg)
  if match = no_or_skip?(arg) # rubocop:disable AssignmentInCondition
    @switches[arg] || @switches["--#{match}"]
  else
    @switches[arg]
  end
end


  








  

    #unshift(arg, is_value: false)  
  

  [ GitHub ]


  

  


# File 'lib/bundler/vendor/thor/lib/thor/parser/options.rb', line 83



def unshift(arg, is_value: false)
  @is_treated_as_value = is_value
  super(arg)
end