Module: OptionParser::Completion

Included in:
CompletingHash, OptionMap
Defined in:
lib/optparse.rb

Overview

Keyword completion module. This allows partial arguments to be specified and resolved against a list of acceptable values.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.candidate(key, icase = false, pat = nil, &block) ⇒ Object 



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/optparse.rb', line 410

def self.candidate(key, icase = false, pat = nil, &block)
  pat ||= Completion.regexp(key, icase)
  candidates = []
  block.call do |k, *v|
    (if Regexp === k
       kn = nil
       k === key
     else
       kn = defined?(k.id2name) ? k.id2name : k
       pat === kn
     end) or next
    v << k if v.empty?
    candidates << [k, v, kn]
  end
  candidates
end

.regexp(key, icase) ⇒ Object 



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

def self.regexp(key, icase)
  Regexp.new('\A' + Regexp.quote(key).gsub(/\w+\b/, '\&\w*'), icase)
end

Instance Method Details

#candidate(key, icase = false, pat = nil) ⇒ Object 



427
428
429
 
# File 'lib/optparse.rb', line 427

def candidate(key, icase = false, pat = nil)
  Completion.candidate(key, icase, pat, &method(:each))
end

#complete(key, icase = false, pat = nil) ⇒ Object 



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/optparse.rb', line 432

def complete(key, icase = false, pat = nil)
  candidates = candidate(key, icase, pat, &method(:each)).sort_by {|k, v, kn| kn.size}
  if candidates.size == 1
    canon, sw, * = candidates[0]
  elsif candidates.size > 1
    canon, sw, cn = candidates.shift
    candidates.each do |k, v, kn|
      next if sw == v
      if String === cn and String === kn
        if cn.rindex(kn, 0)
          canon, sw, cn = k, v, kn
          next
        elsif kn.rindex(cn, 0)
          next
        end
      end
      throw :ambiguous, key
    end
  end
  if canon
    block_given? or return key, *sw
    yield(key, *sw)
  end
end

#convert(opt = nil, val = nil) ⇒ Object 



457
458
459
 
# File 'lib/optparse.rb', line 457

def convert(opt = nil, val = nil, *)
  val
end