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.



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

def initialize param
  @param = param
end

Instance Attribute Details

#param ⇒ Object (readonly)

Returns the value of attribute param.



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

def param
  @param
end

Class Method Details

.evaluate(param, &block) ⇒ Object 



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

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

Instance Method Details

#argument(arg) ⇒ Object 



576
577
578
 
# File 'lib/main/parameter.rb', line 576

def argument arg 
  param.argument arg 
end

#argument_optional(bool = true) ⇒ Object 



590
591
592
593
594
595
596
 
# File 'lib/main/parameter.rb', line 590

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

#argument_optional? ⇒ Boolean

Returns:

  • (Boolean) 


597
598
599
 
# File 'lib/main/parameter.rb', line 597

def argument_optional?
  param.argument_optional?
end

#argument_required(bool = true) ⇒ Object 



579
580
581
582
583
584
585
 
# File 'lib/main/parameter.rb', line 579

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

#argument_required? ⇒ Boolean

Returns:

  • (Boolean) 


586
587
588
 
# File 'lib/main/parameter.rb', line 586

def argument_required?
  param.argument_required?
end

#arity(value) ⇒ Object

Raises:



658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/main/parameter.rb', line 658

def arity value
  raise Arity if value.nil?
  value = -1 if value.to_s == '*'
  value = Integer value
  raise Arity if value.zero?
  param.arity = value
  if param.arity == -1
    optional true
  end
  value
end

#arity? ⇒ Boolean

Returns:

  • (Boolean) 


669
670
671
 
# File 'lib/main/parameter.rb', line 669

def arity?
  param.arity?
end

#attr(*a, &b) ⇒ Object 



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

def attr *a, &b
  fattr *a, &b
end

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



619
620
621
 
# File 'lib/main/parameter.rb', line 619

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

#cast? ⇒ Boolean

Returns:

  • (Boolean) 


622
623
624
 
# File 'lib/main/parameter.rb', line 622

def cast?
  param.cast?
end

#default(*values, &block) ⇒ Object Also known as: defaults 



641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/main/parameter.rb', line 641

def default *values, &block
  if block.nil? and values.empty?
    raise ArgumentError, 'no default'
  end
  unless values.empty?
    param.defaults.push *values
  end
  unless block.nil?
    param.defaults.push block
  end
  param.defaults
end

#defaults? ⇒ Boolean

Returns:

  • (Boolean) 


654
655
656
 
# File 'lib/main/parameter.rb', line 654

def defaults?
  param.defaults?
end

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



633
634
635
 
# File 'lib/main/parameter.rb', line 633

def description s 
  param.description = s.to_s
end

#description? ⇒ Boolean

Returns:

  • (Boolean) 


636
637
638
 
# File 'lib/main/parameter.rb', line 636

def description?
  param.description?
end

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



673
674
675
 
# File 'lib/main/parameter.rb', line 673

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

#example(*list) ⇒ Object Also known as: examples 



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

def example *list
  list.flatten.compact.each do |elem|
    param.examples << elem.to_s
  end
end

#fattr(a = nil, &block) ⇒ Object Also known as: attribute 



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

def fattr a = nil, &block
  name = param.name
  a ||= name
  b = fattr_block_for name, &block 
  Main.current.module_eval{ fattr *a, &b }
end

#fattr_block_for(name, &block) ⇒ Object 



548
549
550
551
 
# File 'lib/main/parameter.rb', line 548

def fattr_block_for name, &block
  block ||= lambda{|param| [0,1].include?(param.arity) ? param.value : param.values }
  lambda{ block.call self.param[name] }
end

#optional(bool = true) ⇒ Object 



608
609
610
611
612
613
614
 
# File 'lib/main/parameter.rb', line 608

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

#optional? ⇒ Boolean

Returns:

  • (Boolean) 


615
616
617
 
# File 'lib/main/parameter.rb', line 615

def optional?
  param.optional?
end

#required(bool = true) ⇒ Object 



601
602
603
 
# File 'lib/main/parameter.rb', line 601

def required bool = true 
  param.required = bool 
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


604
605
606
 
# File 'lib/main/parameter.rb', line 604

def required?
  param.required?
end

#synopsis(*arg) ⇒ Object 



572
573
574
 
# File 'lib/main/parameter.rb', line 572

def synopsis *arg 
  arg.size == 0 ? param.synopsis : (param.synopsis arg.first)
end

#type(*sym) ⇒ Object 



565
566
567
 
# File 'lib/main/parameter.rb', line 565

def type *sym
  sym.size == 0 ? param.type : (param.type = sym.first)
end

#type? ⇒ Boolean

Returns:

  • (Boolean) 


568
569
570
 
# File 'lib/main/parameter.rb', line 568

def type?
  param.type?
end

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



626
627
628
 
# File 'lib/main/parameter.rb', line 626

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

#validate? ⇒ Boolean

Returns:

  • (Boolean) 


629
630
631
 
# File 'lib/main/parameter.rb', line 629

def validate?
  param.validate?
end