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.



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

def initialize param
  @param = param
end

Instance Attribute Details

#param ⇒ Object (readonly)

Returns the value of attribute param.



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

def param
  @param
end

Class Method Details

.evaluate(param, &block) ⇒ Object 



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

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

Instance Method Details

#argument(arg) ⇒ Object 



579
580
581
 
# File 'lib/main/parameter.rb', line 579

def argument arg 
  param.argument arg 
end

#argument_optional(bool = true) ⇒ Object 



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

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

#argument_optional? ⇒ Boolean

Returns:

  • (Boolean) 


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

def argument_optional?
  param.argument_optional?
end

#argument_required(bool = true) ⇒ Object 



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

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

#argument_required? ⇒ Boolean

Returns:

  • (Boolean) 


589
590
591
 
# File 'lib/main/parameter.rb', line 589

def argument_required?
  param.argument_required?
end

#arity(value) ⇒ Object

Raises:



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

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) 


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

def arity?
  param.arity?
end

#attr(*a, &b) ⇒ Object 



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

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

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



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

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

#cast? ⇒ Boolean

Returns:

  • (Boolean) 


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

def cast?
  param.cast?
end

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



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

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) 


657
658
659
 
# File 'lib/main/parameter.rb', line 657

def defaults?
  param.defaults?
end

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



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

def description s 
  param.description = s.to_s
end

#description? ⇒ Boolean

Returns:

  • (Boolean) 


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

def description?
  param.description?
end

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



676
677
678
 
# File 'lib/main/parameter.rb', line 676

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

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



560
561
562
563
564
 
# File 'lib/main/parameter.rb', line 560

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 



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

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 



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

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 



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

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

#optional? ⇒ Boolean

Returns:

  • (Boolean) 


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

def optional?
  param.optional?
end

#required(bool = true) ⇒ Object 



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

def required bool = true 
  param.required = bool 
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


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

def required?
  param.required?
end

#synopsis(*arg) ⇒ Object 



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

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

#type(*sym) ⇒ Object 



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

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

#type? ⇒ Boolean

Returns:

  • (Boolean) 


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

def type?
  param.type?
end

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



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

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

#validate? ⇒ Boolean

Returns:

  • (Boolean) 


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

def validate?
  param.validate?
end