env_parser 0.8.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/.circleci/config.yml +7 -6
- data/.rubocop.yml +56 -57
- data/.ruby-version +1 -1
- data/Gemfile.lock +58 -28
- data/README.md +252 -176
- data/docs/EnvParser.html +305 -169
- data/docs/EnvParser/AutoregisterFileNotFound.html +143 -0
- data/docs/EnvParser/Error.html +9 -9
- data/docs/EnvParser/TypeAlreadyDefinedError.html +143 -0
- data/docs/EnvParser/Types.html +128 -0
- data/docs/EnvParser/Types/BaseTypes.html +177 -0
- data/docs/EnvParser/Types/ChronologyTypes.html +159 -0
- data/docs/EnvParser/Types/InternetTypes.html +159 -0
- data/docs/EnvParser/UnknownTypeError.html +143 -0
- data/docs/EnvParser/UnparseableAutoregisterSpec.html +143 -0
- data/docs/EnvParser/ValueNotAllowedError.html +143 -0
- data/docs/EnvParser/ValueNotConvertibleError.html +143 -0
- data/docs/EnvParserTypes.html +129 -0
- data/docs/EnvParserTypes/BaseTypes.html +178 -0
- data/docs/EnvParserTypes/ChronologyTypes.html +159 -0
- data/docs/EnvParserTypes/InternetTypes.html +159 -0
- data/docs/EnvParserTypes/TimeTypes.html +158 -0
- data/docs/_index.html +108 -9
- data/docs/class_list.html +3 -3
- data/docs/css/style.css +7 -9
- data/docs/file.README.html +215 -226
- data/docs/file_list.html +2 -2
- data/docs/frames.html +2 -2
- data/docs/index.html +215 -226
- data/docs/js/app.js +69 -3
- data/docs/method_list.html +13 -5
- data/docs/top-level-namespace.html +9 -9
- data/env_parser.gemspec +6 -2
- data/lib/env_parser.rb +111 -83
- data/lib/env_parser/autoregister.rb +3 -0
- data/lib/env_parser/errors.rb +40 -0
- data/lib/env_parser/types.rb +3 -0
- data/lib/env_parser/types/base_types.rb +99 -26
- data/lib/env_parser/types/chronology_types.rb +104 -0
- data/lib/env_parser/types/internet_types.rb +99 -0
- data/lib/env_parser/version.rb +1 -1
- metadata +85 -10
@@ -0,0 +1,159 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Module: EnvParserTypes::InternetTypes
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.20
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "EnvParserTypes::InternetTypes";
|
19
|
+
relpath = '../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../_index.html">Index (I)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../EnvParserTypes.html" title="EnvParserTypes (module)">EnvParserTypes</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">InternetTypes</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Module: EnvParserTypes::InternetTypes
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<dl>
|
80
|
+
<dt>Defined in:</dt>
|
81
|
+
<dd>lib/env_parser/types/internet.rb</dd>
|
82
|
+
</dl>
|
83
|
+
|
84
|
+
</div>
|
85
|
+
|
86
|
+
<h2>Overview</h2><div class="docstring">
|
87
|
+
<div class="discussion">
|
88
|
+
|
89
|
+
<p>Defines types for internet-related values, adding the following:</p>
|
90
|
+
<table>
|
91
|
+
<tbody>
|
92
|
+
<tr>
|
93
|
+
<th><code>:as</code> value</th>
|
94
|
+
<th>type returned</th>
|
95
|
+
<th>default</th>
|
96
|
+
<th>notes</th>
|
97
|
+
</tr>
|
98
|
+
</tbody>
|
99
|
+
<tbody>
|
100
|
+
<tr>
|
101
|
+
<td>:ipv4_address</td>
|
102
|
+
<td>String</td>
|
103
|
+
<td><code>nil</code></td>
|
104
|
+
<td>
|
105
|
+
An IPv4 address in 4-octet dot-decimal notation,
|
106
|
+
<br />
|
107
|
+
with no CIDR or subnet suffix (e.g. <code>'192.168.0.1'</code>).
|
108
|
+
</td>
|
109
|
+
</tr>
|
110
|
+
<tr>
|
111
|
+
<td>:ipv6_address</td>
|
112
|
+
<td>String</td>
|
113
|
+
<td><code>nil</code></td>
|
114
|
+
<td>An IPv6 address, in RFC5952 format.</td>
|
115
|
+
</tr>
|
116
|
+
<tr>
|
117
|
+
<td>:network_port / :port</td>
|
118
|
+
<td>Integer</td>
|
119
|
+
<td><code>nil</code></td>
|
120
|
+
<td></td>
|
121
|
+
</tr>
|
122
|
+
<tr>
|
123
|
+
<td>:email_address</td>
|
124
|
+
<td>String</td>
|
125
|
+
<td><code>nil</code></td>
|
126
|
+
<td>
|
127
|
+
A "simple" email address, containing only a username and a domain.
|
128
|
+
<br />
|
129
|
+
Note this does not guarantee RFC5322-conformity.
|
130
|
+
</td>
|
131
|
+
</tr>
|
132
|
+
</tbody>
|
133
|
+
</table>
|
134
|
+
|
135
|
+
</div>
|
136
|
+
</div>
|
137
|
+
<div class="tags">
|
138
|
+
|
139
|
+
|
140
|
+
</div>
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
</div>
|
150
|
+
|
151
|
+
<div id="footer">
|
152
|
+
Generated on Sun Oct 20 23:39:48 2019 by
|
153
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
154
|
+
0.9.20 (ruby-2.4.2).
|
155
|
+
</div>
|
156
|
+
|
157
|
+
</div>
|
158
|
+
</body>
|
159
|
+
</html>
|
@@ -0,0 +1,158 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Module: EnvParserTypes::TimeTypes
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.20
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "EnvParserTypes::TimeTypes";
|
19
|
+
relpath = '../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../_index.html">Index (T)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../EnvParserTypes.html" title="EnvParserTypes (module)">EnvParserTypes</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">TimeTypes</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Module: EnvParserTypes::TimeTypes
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<dl>
|
80
|
+
<dt>Defined in:</dt>
|
81
|
+
<dd>lib/env_parser/types/chronology.rb</dd>
|
82
|
+
</dl>
|
83
|
+
|
84
|
+
</div>
|
85
|
+
|
86
|
+
<h2>Overview</h2><div class="docstring">
|
87
|
+
<div class="discussion">
|
88
|
+
|
89
|
+
<p>Defines types for date/time-related values, adding the following:</p>
|
90
|
+
<table>
|
91
|
+
<tbody>
|
92
|
+
<tr>
|
93
|
+
<th><code>:as</code> value</th>
|
94
|
+
<th>type returned</th>
|
95
|
+
<th>default</th>
|
96
|
+
<th>notes</th>
|
97
|
+
</tr>
|
98
|
+
</tbody>
|
99
|
+
<tbody>
|
100
|
+
<tr>
|
101
|
+
<td>:date</td>
|
102
|
+
<td>Date</td>
|
103
|
+
<td><code>nil</code></td>
|
104
|
+
<td>
|
105
|
+
A natural language or ISO8601-parseable date.
|
106
|
+
<br />
|
107
|
+
Actual interpretation of the value is handled by the *chronic* gem.
|
108
|
+
</td>
|
109
|
+
</tr>
|
110
|
+
<tr>
|
111
|
+
<td>:time / :datetime</td>
|
112
|
+
<td>Time</td>
|
113
|
+
<td><code>nil</code></td>
|
114
|
+
<td>
|
115
|
+
A natural language or ISO8601-parseable date and time.
|
116
|
+
<br />
|
117
|
+
Actual interpretation of the value is handled by the *chronic* gem.
|
118
|
+
</td>
|
119
|
+
</tr>
|
120
|
+
<tr>
|
121
|
+
<td>:duration</td>
|
122
|
+
<td>Numeric</td>
|
123
|
+
<td><code>nil</code></td>
|
124
|
+
<td>
|
125
|
+
A natural language or ISO8601-parseable period. Value returns is number of seconds in
|
126
|
+
the given period.
|
127
|
+
<br />
|
128
|
+
Actual interpretation of the value is handled by the *chronic_duration* gem.
|
129
|
+
</td>
|
130
|
+
</tr>
|
131
|
+
</tbody>
|
132
|
+
</table>
|
133
|
+
|
134
|
+
</div>
|
135
|
+
</div>
|
136
|
+
<div class="tags">
|
137
|
+
|
138
|
+
|
139
|
+
</div>
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
</div>
|
149
|
+
|
150
|
+
<div id="footer">
|
151
|
+
Generated on Sun Oct 20 23:33:13 2019 by
|
152
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
153
|
+
0.9.20 (ruby-2.4.2).
|
154
|
+
</div>
|
155
|
+
|
156
|
+
</div>
|
157
|
+
</body>
|
158
|
+
</html>
|
data/docs/_index.html
CHANGED
@@ -4,15 +4,15 @@
|
|
4
4
|
<meta charset="utf-8">
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
|
-
Documentation by YARD 0.9.
|
7
|
+
Documentation by YARD 0.9.26
|
8
8
|
|
9
9
|
</title>
|
10
10
|
|
11
|
-
<link rel="stylesheet" href="css/style.css" type="text/css"
|
11
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="css/common.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
14
14
|
|
15
|
-
<script type="text/javascript"
|
15
|
+
<script type="text/javascript">
|
16
16
|
pathId = null;
|
17
17
|
relpath = '';
|
18
18
|
</script>
|
@@ -52,7 +52,7 @@
|
|
52
52
|
<div class="clear"></div>
|
53
53
|
</div>
|
54
54
|
|
55
|
-
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.
|
55
|
+
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.26</h1>
|
56
56
|
<div id="listing">
|
57
57
|
<h1 class="alphaindex">Alphabetic Index</h1>
|
58
58
|
|
@@ -78,6 +78,51 @@
|
|
78
78
|
<td valign='top' width="33%">
|
79
79
|
|
80
80
|
|
81
|
+
<ul id="alpha_A" class="alpha">
|
82
|
+
<li class="letter">A</li>
|
83
|
+
<ul>
|
84
|
+
|
85
|
+
<li>
|
86
|
+
<span class='object_link'><a href="EnvParser/AutoregisterFileNotFound.html" title="EnvParser::AutoregisterFileNotFound (class)">AutoregisterFileNotFound</a></span>
|
87
|
+
|
88
|
+
<small>(EnvParser)</small>
|
89
|
+
|
90
|
+
</li>
|
91
|
+
|
92
|
+
</ul>
|
93
|
+
</ul>
|
94
|
+
|
95
|
+
|
96
|
+
<ul id="alpha_B" class="alpha">
|
97
|
+
<li class="letter">B</li>
|
98
|
+
<ul>
|
99
|
+
|
100
|
+
<li>
|
101
|
+
<span class='object_link'><a href="EnvParser/Types/BaseTypes.html" title="EnvParser::Types::BaseTypes (module)">BaseTypes</a></span>
|
102
|
+
|
103
|
+
<small>(EnvParser::Types)</small>
|
104
|
+
|
105
|
+
</li>
|
106
|
+
|
107
|
+
</ul>
|
108
|
+
</ul>
|
109
|
+
|
110
|
+
|
111
|
+
<ul id="alpha_C" class="alpha">
|
112
|
+
<li class="letter">C</li>
|
113
|
+
<ul>
|
114
|
+
|
115
|
+
<li>
|
116
|
+
<span class='object_link'><a href="EnvParser/Types/ChronologyTypes.html" title="EnvParser::Types::ChronologyTypes (module)">ChronologyTypes</a></span>
|
117
|
+
|
118
|
+
<small>(EnvParser::Types)</small>
|
119
|
+
|
120
|
+
</li>
|
121
|
+
|
122
|
+
</ul>
|
123
|
+
</ul>
|
124
|
+
|
125
|
+
|
81
126
|
<ul id="alpha_E" class="alpha">
|
82
127
|
<li class="letter">E</li>
|
83
128
|
<ul>
|
@@ -98,12 +143,56 @@
|
|
98
143
|
</ul>
|
99
144
|
|
100
145
|
|
146
|
+
<ul id="alpha_I" class="alpha">
|
147
|
+
<li class="letter">I</li>
|
148
|
+
<ul>
|
149
|
+
|
150
|
+
<li>
|
151
|
+
<span class='object_link'><a href="EnvParser/Types/InternetTypes.html" title="EnvParser::Types::InternetTypes (module)">InternetTypes</a></span>
|
152
|
+
|
153
|
+
<small>(EnvParser::Types)</small>
|
154
|
+
|
155
|
+
</li>
|
156
|
+
|
157
|
+
</ul>
|
158
|
+
</ul>
|
159
|
+
|
160
|
+
|
101
161
|
<ul id="alpha_T" class="alpha">
|
102
162
|
<li class="letter">T</li>
|
103
163
|
<ul>
|
104
164
|
|
105
165
|
<li>
|
106
|
-
<span class='object_link'><a href="EnvParser/
|
166
|
+
<span class='object_link'><a href="EnvParser/TypeAlreadyDefinedError.html" title="EnvParser::TypeAlreadyDefinedError (class)">TypeAlreadyDefinedError</a></span>
|
167
|
+
|
168
|
+
<small>(EnvParser)</small>
|
169
|
+
|
170
|
+
</li>
|
171
|
+
|
172
|
+
<li>
|
173
|
+
<span class='object_link'><a href="EnvParser/Types.html" title="EnvParser::Types (module)">Types</a></span>
|
174
|
+
|
175
|
+
<small>(EnvParser)</small>
|
176
|
+
|
177
|
+
</li>
|
178
|
+
|
179
|
+
</ul>
|
180
|
+
</ul>
|
181
|
+
|
182
|
+
|
183
|
+
<ul id="alpha_U" class="alpha">
|
184
|
+
<li class="letter">U</li>
|
185
|
+
<ul>
|
186
|
+
|
187
|
+
<li>
|
188
|
+
<span class='object_link'><a href="EnvParser/UnknownTypeError.html" title="EnvParser::UnknownTypeError (class)">UnknownTypeError</a></span>
|
189
|
+
|
190
|
+
<small>(EnvParser)</small>
|
191
|
+
|
192
|
+
</li>
|
193
|
+
|
194
|
+
<li>
|
195
|
+
<span class='object_link'><a href="EnvParser/UnparseableAutoregisterSpec.html" title="EnvParser::UnparseableAutoregisterSpec (class)">UnparseableAutoregisterSpec</a></span>
|
107
196
|
|
108
197
|
<small>(EnvParser)</small>
|
109
198
|
|
@@ -113,12 +202,22 @@
|
|
113
202
|
</ul>
|
114
203
|
|
115
204
|
|
205
|
+
</td><td valign='top' width="33%">
|
206
|
+
|
207
|
+
|
116
208
|
<ul id="alpha_V" class="alpha">
|
117
209
|
<li class="letter">V</li>
|
118
210
|
<ul>
|
119
211
|
|
120
212
|
<li>
|
121
|
-
<span class='object_link'><a href="EnvParser/
|
213
|
+
<span class='object_link'><a href="EnvParser/ValueNotAllowedError.html" title="EnvParser::ValueNotAllowedError (class)">ValueNotAllowedError</a></span>
|
214
|
+
|
215
|
+
<small>(EnvParser)</small>
|
216
|
+
|
217
|
+
</li>
|
218
|
+
|
219
|
+
<li>
|
220
|
+
<span class='object_link'><a href="EnvParser/ValueNotConvertibleError.html" title="EnvParser::ValueNotConvertibleError (class)">ValueNotConvertibleError</a></span>
|
122
221
|
|
123
222
|
<small>(EnvParser)</small>
|
124
223
|
|
@@ -136,9 +235,9 @@
|
|
136
235
|
</div>
|
137
236
|
|
138
237
|
<div id="footer">
|
139
|
-
Generated on
|
238
|
+
Generated on Sat Jan 2 17:31:14 2021 by
|
140
239
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
141
|
-
0.9.
|
240
|
+
0.9.26 (ruby-2.7.2).
|
142
241
|
</div>
|
143
242
|
|
144
243
|
</div>
|