Class: Samovar::Split

Inherits:
Object
  • Object
show all
Defined in:
lib/samovar/split.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key, description, marker: '--', default: nil, required: false) ⇒ Split

Returns a new instance of Split.



23
24
25
26
27
28
29
 
# File 'lib/samovar/split.rb', line 23

def initialize(key, description, marker: '--', default: nil, required: false)
	@key = key
	@description = description
	@marker = marker
	@default = default
	@required = required
end

Instance Attribute Details

#default ⇒ Object (readonly)

Returns the value of attribute default.



34
35
36
 
# File 'lib/samovar/split.rb', line 34

def default
  @default
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



32
33
34
 
# File 'lib/samovar/split.rb', line 32

def description
  @description
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



31
32
33
 
# File 'lib/samovar/split.rb', line 31

def key
  @key
end

#marker ⇒ Object (readonly)

Returns the value of attribute marker.



33
34
35
 
# File 'lib/samovar/split.rb', line 33

def marker
  @marker
end

#required ⇒ Object (readonly)

Returns the value of attribute required.



35
36
37
 
# File 'lib/samovar/split.rb', line 35

def required
  @required
end

Instance Method Details

#parse(input, parent = nil, default = nil) ⇒ Object 



53
54
55
56
57
58
59
60
61
 
# File 'lib/samovar/split.rb', line 53

def parse(input, parent = nil, default = nil)
	if offset = input.index(@marker)
		input.pop(input.size - offset).tap(&:shift)
	elsif default ||= @default
		return default
	elsif @required
		raise MissingValueError.new(parent, self)
	end
end

#to_a ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/samovar/split.rb', line 41

def to_a
	usage = [to_s, @description]
	
	if @default
		usage << "(default: #{@default.inspect})"
	elsif @required
		usage << "(required)"
	end
	
	return usage
end

#to_s ⇒ Object 



37
38
39
 
# File 'lib/samovar/split.rb', line 37

def to_s
	"#{@marker} <#{@key}...>"
end