Class: Main::Parameter::DSL

Inherits:
Object show all
Defined in:
lib/main/parameter.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(param) ⇒ DSL

Returns a new instance of DSL.



454
455
456
# File 'lib/main/parameter.rb', line 454

def initialize param
  @p = param
end

Instance Attribute Details

#pObject (readonly)

Returns the value of attribute p.



452
453
454
# File 'lib/main/parameter.rb', line 452

def p
  @p
end

Class Method Details

.evaluate(param, &block) ⇒ Object



449
450
451
# File 'lib/main/parameter.rb', line 449

def self.evaluate param, &block
  new(param).evaluate(&block)
end

Instance Method Details

#argument(arg) ⇒ Object



469
470
471
# File 'lib/main/parameter.rb', line 469

def argument arg 
  p.argument arg 
end

#argument_optional(bool = true) ⇒ Object



483
484
485
486
487
488
489
# File 'lib/main/parameter.rb', line 483

def argument_optional bool = true
  if bool
    p.argument :optional
  else
    p.argument false 
  end
end

#argument_optional?Boolean

Returns:

  • (Boolean)


490
491
492
# File 'lib/main/parameter.rb', line 490

def argument_optional?
  p.argument_optional?
end

#argument_required(bool = true) ⇒ Object



472
473
474
475
476
477
478
# File 'lib/main/parameter.rb', line 472

def argument_required bool = true
  if bool
    p.argument :required
  else
    p.argument false 
  end
end

#argument_required?Boolean

Returns:

  • (Boolean)


479
480
481
# File 'lib/main/parameter.rb', line 479

def argument_required?
  p.argument_required?
end

#arity(value) ⇒ Object



551
552
553
554
# File 'lib/main/parameter.rb', line 551

def arity value
  value = -1 if value.to_s == '*'
  p.arity = Integer value
end

#arity?Boolean

Returns:

  • (Boolean)


555
556
557
# File 'lib/main/parameter.rb', line 555

def arity?
  p.arity?
end

#cast(sym = nil, &b) ⇒ Object



512
513
514
# File 'lib/main/parameter.rb', line 512

def cast sym=nil, &b 
  p.cast = sym || b 
end

#cast?Boolean

Returns:

  • (Boolean)


515
516
517
# File 'lib/main/parameter.rb', line 515

def cast?
  p.cast?
end

#default(value, *values) ⇒ Object



534
535
536
537
538
# File 'lib/main/parameter.rb', line 534

def default value, *values
  p.defaults.push value 
  p.defaults.push *values
  p.defaults
end

#defaults(value, *values) ⇒ Object



542
543
544
545
546
# File 'lib/main/parameter.rb', line 542

def defaults value, *values 
  p.defaults.push value 
  p.defaults.push *values
  p.defaults
end

#defaults?Boolean

Returns:

  • (Boolean)


539
540
541
# File 'lib/main/parameter.rb', line 539

def defaults?
  p.defaults?
end

#description(s) ⇒ Object Also known as: desc



526
527
528
# File 'lib/main/parameter.rb', line 526

def description s 
  p.description = s.to_s
end

#description?Boolean

Returns:

  • (Boolean)


529
530
531
# File 'lib/main/parameter.rb', line 529

def description?
  p.description?
end

#error(which = :instead, &block) ⇒ Object



559
560
561
# File 'lib/main/parameter.rb', line 559

def error which = :instead, &block
  p.send "error_handler_#{ which }=", block
end

#optional(bool = true) ⇒ Object



501
502
503
504
505
506
507
# File 'lib/main/parameter.rb', line 501

def optional bool = true 
  if bool 
    p.required !bool  
  else
    p.required bool  
  end
end

#optional?Boolean

Returns:

  • (Boolean)


508
509
510
# File 'lib/main/parameter.rb', line 508

def optional?
  p.optional?
end

#required(bool = true) ⇒ Object



494
495
496
# File 'lib/main/parameter.rb', line 494

def required bool = true 
  p.required = bool 
end

#required?Boolean

Returns:

  • (Boolean)


497
498
499
# File 'lib/main/parameter.rb', line 497

def required?
  p.required?
end

#synopsis(arg) ⇒ Object



465
466
467
# File 'lib/main/parameter.rb', line 465

def synopsis arg 
  p.synopsis arg 
end

#type(sym) ⇒ Object



458
459
460
# File 'lib/main/parameter.rb', line 458

def type sym
  p.type = sym
end

#type?Boolean

Returns:

  • (Boolean)


461
462
463
# File 'lib/main/parameter.rb', line 461

def type?
  p.type?
end

#validate(sym = nil, &b) ⇒ Object



519
520
521
# File 'lib/main/parameter.rb', line 519

def validate sym=nil, &b 
  p.validate = sym || b 
end

#validate?Boolean

Returns:

  • (Boolean)


522
523
524
# File 'lib/main/parameter.rb', line 522

def validate?
  p.validate?
end