class Thor::Arguments
:nodoc: # rubocop:disable ClassLength
def self.parse(*args)
def self.parse(*args) to_parse = args.pop new(*args).parse(to_parse) end
def self.split(args)
and one with switches.
Receives an array of args and returns two arrays, one with arguments
def self.split(args) arguments = [] args.each do |item| break if item =~ /^-/ arguments << item end [arguments, args[Range.new(arguments.size, -1)]] end
def check_requirement!
Raises an error if @non_assigned_required array is not empty.
def check_requirement! unless @non_assigned_required.empty? names = @non_assigned_required.map do |o| o.respond_to?(:switch_name) ? o.switch_name : o.human_name end.join("', '") class_name = self.class.name.split('::').last.downcase fail RequiredArgumentMissingError, "No value provided for required #{class_name} '#{names}'" end end
def current_is_value?
def current_is_value? peek && peek.to_s !~ /^-/ end
def initialize(arguments = [])
Takes an array of Thor::Argument objects.
def initialize(arguments = []) @assigns, @non_assigned_required = {}, [] @switches = arguments arguments.each do |argument| if !argument.default.nil? @assigns[argument.human_name] = argument.default elsif argument.required? @non_assigned_required << argument end end end
def last?
def last? @pile.empty? end
def no_or_skip?(arg)
def no_or_skip?(arg) arg =~ /^--(no|skip)-([-\w]+)$/ $2 end
def parse(args)
def parse(args) @pile = args.dup @switches.each do |argument| break unless peek @non_assigned_required.delete(argument) @assigns[argument.human_name] = send(:"parse_#{argument.type}", argument.human_name) end check_requirement! @assigns end
def parse_array(name)
["a", "b", "c"]
And returns it as an array:
["a", "b", "c"]
found or a switch is found.
Runs through the argument array getting all strings until no string is
def parse_array(name) return shift if peek.is_a?(Array) array = [] array << shift while current_is_value? array end
def parse_hash(name)
{ "name" => "string", "age" => "integer" }
Becomes:
[ "name:string", "age:integer" ]
mark it as a hash:
Runs through the argument array getting strings that contains ":" and
def parse_hash(name) return shift if peek.is_a?(Hash) hash = {} while current_is_value? && peek.include?(':') key, value = shift.split(':', 2) hash[key] = value end hash end
def parse_numeric(name)
Otherwise raises an error.
Check if the peek is included in enum if enum is provided.
Check if the peek is numeric format and return a Float or Integer.
def parse_numeric(name) return shift if peek.is_a?(Numeric) unless peek =~ NUMERIC && $& == peek fail MalformattedArgumentError, "Expected numeric value for '#{name}'; got #{peek.inspect}" end value = $&.index('.') ? shift.to_f : shift.to_i if @switches.is_a?(Hash) && switch = @switches[name] if switch.enum && !switch.enum.include?(value) raise MalformattedArgumentError, "Expected '#{name}' to be one of #{switch.enum.join(', ')}; got #{value}" end end value end
def parse_string(name)
Check if the peek is included in enum if enum is provided. Otherwise raises an error.
for --no-string-arg, nil
for --string-arg, just return the current value in the pile
Parse string:
def parse_string(name) if no_or_skip?(name) nil else value = shift if @switches.is_a?(Hash) && switch = @switches[name] # rubocop:disable AssignmentInCondition if switch.enum && !switch.enum.include?(value) fail MalformattedArgumentError, "Expected '#{name}' to be one of #{switch.enum.join(', ')}; got #{value}" end end value end end
def peek
def peek @pile.first end
def remaining # rubocop:disable TrivialAccessors
def remaining # rubocop:disable TrivialAccessors @pile end
def shift
def shift @pile.shift end
def unshift(arg)
def unshift(arg) if arg.kind_of?(Array) @pile = arg + @pile else @pile.unshift(arg) end end