Class: CLASP::Arguments

Inherits:
Object
  • Object
show all
Defined in:
lib/clasp/arguments.rb

Overview

The main class for processing command-line arguments

Defined Under Namespace

Classes: Flag, ImmutableArray, Option

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv = ARGV, aliases = nil, options = {}) ⇒ Arguments

Constructs an instance of the class, according to the given parameters

See the documentation for the ::CLASP module for examples

Signature

  • Parameters:

    • argv

      (Array) The arguments array. May not be nil. Defaults to ARGV.

    • aliases

      (Array) The aliases array. Defaults to nil. If none supplied, no aliasing will be performed.

    • options

      An options hash, containing any of the following options.

  • Options:

    • mutate_arg:

      (Boolean) Determines if the library should mutate argv. Defaults to true. This is essential when using CLASP in conjunction with $<.



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/clasp/arguments.rb', line 219

def initialize(argv = ARGV, aliases = nil, options = {})

	# have to do this name-swap, as 'options' has CLASP-specific
	# meaning
	init_opts, options	=	options.dup, nil

	init_opts[:mutate_argv] = true unless init_opts.has_key? :mutate_argv


	@argv				=	argv
	@argv_original_copy	=	ImmutableArray.new(argv.dup)

	@aliases	=	aliases

	aliases		=	nil if aliases and aliases.empty?

	flags, options, values = Arguments.parse(argv, aliases)

	@flags		=	ImmutableArray.new(flags)
	@options	=	ImmutableArray.new(options)
	@values		=	ImmutableArray.new(values)


	# do argv-mutation, if required
	if init_opts[:mutate_argv]

		while not argv.empty?

			argv.shift
		end

		@values.each do |v|

			argv << v
		end
	end
end

Instance Attribute Details

#aliases ⇒ Object (readonly)

an immutable array of aliases



394
395
396
 
# File 'lib/clasp/arguments.rb', line 394

def aliases
  @aliases
end

#argv ⇒ Object (readonly)

the (possibly mutated) array of arguments instance passed to new



406
407
408
 
# File 'lib/clasp/arguments.rb', line 406

def argv
  @argv
end

#argv_original_copy ⇒ Object (readonly)

unchanged copy of the original array of arguments passed to new



409
410
411
 
# File 'lib/clasp/arguments.rb', line 409

def argv_original_copy
  @argv_original_copy
end

#flags ⇒ Object (readonly)

an immutable array of flags



397
398
399
 
# File 'lib/clasp/arguments.rb', line 397

def flags
  @flags
end

#options ⇒ Object (readonly)

an immutable array of options



400
401
402
 
# File 'lib/clasp/arguments.rb', line 400

def options
  @options
end

#values ⇒ Object (readonly)

an immutable array of values



403
404
405
 
# File 'lib/clasp/arguments.rb', line 403

def values
  @values
end

Instance Method Details

#find_first_unknown(options = {}) ⇒ Object

finds the first unknown flag or option; nil if all used

Raises:

  • (ArgumentError) 


413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/clasp/arguments.rb', line 413

def find_first_unknown options = {}

	option	=	{} if options.nil?

	raise ArgumentError, "options must be nil or Hash - #{option.class} given" unless options.is_a? ::Hash

	aliases	=	options[:aliases] || @aliases

	raise ArgumentError, "aliases may not be nil" if aliases.nil?

	flags.each do |f|

		return f unless aliases.any? { |al| al.is_a?(::CLASP::Flag) && al.name == f.name }
	end

	options.each do |o|

		return o unless aliases.any? { |al| al.is_a?(::CLASP::Option) && al.name == o.name }
	end

	nil
end