1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
require 'stringio'
require_relative '../test_helper'
module Optimist
class ParserEduateTest < ::Minitest::Test
def setup
end
def test_no_arguments_to_stdout
assert_stdout(/Options:/) do
parser.educate
end
end
def test_argument_to_stringio
assert_educates(/Options:/)
end
def test_no_headers
assert_educates(/^Options:/)
end
def test_usage
parser.usage("usage string")
assert_educates(/^Usage: \w* usage string\n\nOptions:/)
end
def test_usage_synopsis_version
end
# def test_banner
# def test_text
# width, legacy_width
# wrap
# wrap_lines
############
# convert these into multiple tests
# pulled out of optimist_test for now
def test_help_has_default_banner
@p = Parser.new
sio = StringIO.new
@p.parse []
@p.educate sio
help = sio.string.split "\n"
assert help[0] =~ /options/i
assert_equal 2, help.length # options, then -h
@p = Parser.new
@p.version "my version"
sio = StringIO.new
@p.parse []
@p.educate sio
help = sio.string.split "\n"
assert help[0] =~ /my version/i
assert_equal 4, help.length # version, options, -h, -v
@p = Parser.new
@p.banner "my own banner"
sio = StringIO.new
@p.parse []
@p.educate sio
help = sio.string.split "\n"
assert help[0] =~ /my own banner/i
assert_equal 2, help.length # banner, -h
@p = Parser.new
@p.text "my own text banner"
sio = StringIO.new
@p.parse []
@p.educate sio
help = sio.string.split "\n"
assert help[0] =~ /my own text banner/i
assert_equal 2, help.length # banner, -h
end
def test_help_has_optional_usage
@p = Parser.new
@p.usage "OPTIONS FILES"
sio = StringIO.new
@p.parse []
@p.educate sio
help = sio.string.split "\n"
assert help[0] =~ /OPTIONS FILES/i
assert_equal 4, help.length # line break, options, then -h
end
def test_help_has_optional_synopsis
@p = Parser.new
@p.synopsis "About this program"
sio = StringIO.new
@p.parse []
@p.educate sio
help = sio.string.split "\n"
assert help[0] =~ /About this program/i
assert_equal 4, help.length # line break, options, then -h
end
def test_help_has_specific_order_for_usage_and_synopsis
@p = Parser.new
@p.usage "OPTIONS FILES"
@p.synopsis "About this program"
sio = StringIO.new
@p.parse []
@p.educate sio
help = sio.string.split "\n"
assert help[0] =~ /OPTIONS FILES/i
assert help[1] =~ /About this program/i
assert_equal 5, help.length # line break, options, then -h
end
def test_help_preserves_positions
parser.opt :zzz, "zzz"
parser.opt :aaa, "aaa"
sio = StringIO.new
parser.educate sio
help = sio.string.split "\n"
assert help[1] =~ /zzz/
assert help[2] =~ /aaa/
end
def test_help_includes_option_types
parser.opt :arg1, 'arg', :type => :int
parser.opt :arg2, 'arg', :type => :ints
parser.opt :arg3, 'arg', :type => :string
parser.opt :arg4, 'arg', :type => :strings
parser.opt :arg5, 'arg', :type => :float
parser.opt :arg6, 'arg', :type => :floats
parser.opt :arg7, 'arg', :type => :io
parser.opt :arg8, 'arg', :type => :ios
parser.opt :arg9, 'arg', :type => :date
parser.opt :arg10, 'arg', :type => :dates
sio = StringIO.new
parser.educate sio
help = sio.string.split "\n"
assert help[1] =~ /<i>/
assert help[2] =~ /<i\+>/
assert help[3] =~ /<s>/
assert help[4] =~ /<s\+>/
assert help[5] =~ /<f>/
assert help[6] =~ /<f\+>/
assert help[7] =~ /<filename\/uri>/
assert help[8] =~ /<filename\/uri\+>/
assert help[9] =~ /<date>/
assert help[10] =~ /<date\+>/
end
def test_help_handles_boolean_flags
parser.opt :default_false, 'default-false', :default => false
parser.opt :default_true, 'default-true', :default => true
sio = StringIO.new
parser.educate sio
help = sio.string.split "\n"
assert help[1] =~ /--default-false/
assert help[2] =~ /--default-true, --no-default-true/
assert help[2] =~ /\(default: true\)/
end
def test_help_has_grammatical_default_text
parser.opt :arg1, 'description with period.', :default => 'hello'
parser.opt :arg2, 'description without period', :default => 'world'
sio = StringIO.new
parser.educate sio
help = sio.string.split "\n"
assert help[1] =~ /Default/
assert help[2] =~ /default/
end
def test_help_has_grammatical_permitted_text
parser.opt :arg1, 'description with period.', :type => :strings, :permitted => %w(foo bar)
parser.opt :arg2, 'description without period', :type => :strings, :permitted => %w(foo bar)
sio = StringIO.new
parser.educate sio
help = sio.string.split "\n"
assert help[1] =~ /Permitted/
assert help[2] =~ /permitted/
end
def test_help_with_permitted_range
parser.opt :rating, 'rating', permitted: 1..5
parser.opt :hex, 'hexadecimal', permitted: /^[0-9a-f]/i
sio = StringIO.new
parser.educate sio
help = sio.string.split "\n"
assert_match %r{rating \(permitted: 1\.\.5\)}, help[1]
assert_match %r{hexadecimal \(permitted: \/\^\[0-9a-f\]\/i\)}, help[2]
end
############
private
def parser
@p ||= Parser.new
end
def assert_educates(output)
str = StringIO.new
parser.educate str
assert_match output, str.string
end
end
end
|
