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.



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

def initialize param
  @param = param
end

Instance Attribute Details

#param ⇒ Object (readonly)

Returns the value of attribute param.



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

def param
  @param
end

Class Method Details

.evaluate(param, &block) ⇒ Object 



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

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

Instance Method Details

#argument(arg) ⇒ Object 



581
582
583
 
# File 'lib/main/parameter.rb', line 581

def argument arg 
  param.argument arg 
end

#argument_optional(bool = true) ⇒ Object 



595
596
597
598
599
600
601
 
# File 'lib/main/parameter.rb', line 595

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

#argument_optional? ⇒ Boolean

Returns:

  • (Boolean) 


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

def argument_optional?
  param.argument_optional?
end

#argument_required(bool = true) ⇒ Object 



584
585
586
587
588
589
590
 
# File 'lib/main/parameter.rb', line 584

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

#argument_required? ⇒ Boolean

Returns:

  • (Boolean) 


591
592
593
 
# File 'lib/main/parameter.rb', line 591

def argument_required?
  param.argument_required?
end

#arity(value) ⇒ Object

Raises:



663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/main/parameter.rb', line 663

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) 


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

def arity?
  param.arity?
end

#attr(*a, &b) ⇒ Object 



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

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

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



624
625
626
 
# File 'lib/main/parameter.rb', line 624

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

#cast? ⇒ Boolean

Returns:

  • (Boolean) 


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

def cast?
  param.cast?
end

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



646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/main/parameter.rb', line 646

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) 


659
660
661
 
# File 'lib/main/parameter.rb', line 659

def defaults?
  param.defaults?
end

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



638
639
640
 
# File 'lib/main/parameter.rb', line 638

def description s 
  param.description = s.to_s
end

#description? ⇒ Boolean

Returns:

  • (Boolean) 


641
642
643
 
# File 'lib/main/parameter.rb', line 641

def description?
  param.description?
end

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



678
679
680
 
# File 'lib/main/parameter.rb', line 678

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

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



562
563
564
565
566
 
# File 'lib/main/parameter.rb', line 562

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 



545
546
547
548
549
550
 
# File 'lib/main/parameter.rb', line 545

def fattr a = nil, &block
  name = param.name
  a ||= name
  b = fattr_block_for name, &block 
  @param.main.module_eval{ fattr(*a, &b) }
end

#fattr_block_for(name, &block) ⇒ Object 



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

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 



613
614
615
616
617
618
619
 
# File 'lib/main/parameter.rb', line 613

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

#optional? ⇒ Boolean

Returns:

  • (Boolean) 


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

def optional?
  param.optional?
end

#required(bool = true) ⇒ Object 



606
607
608
 
# File 'lib/main/parameter.rb', line 606

def required bool = true 
  param.required = bool 
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


609
610
611
 
# File 'lib/main/parameter.rb', line 609

def required?
  param.required?
end

#synopsis(*arg) ⇒ Object 



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

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

#type(*sym) ⇒ Object 



570
571
572
 
# File 'lib/main/parameter.rb', line 570

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

#type? ⇒ Boolean

Returns:

  • (Boolean) 


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

def type?
  param.type?
end

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



631
632
633
 
# File 'lib/main/parameter.rb', line 631

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

#validate? ⇒ Boolean

Returns:

  • (Boolean) 


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

def validate?
  param.validate?
end