env_parser 0.8.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (22) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +102 -115
  4. data/docs/EnvParser.html +128 -123
  5. data/docs/EnvParser/Error.html +4 -4
  6. data/docs/EnvParser/TypeAlreadyDefinedError.html +143 -0
  7. data/docs/EnvParser/UnknownTypeError.html +143 -0
  8. data/docs/EnvParser/ValueNotAllowedError.html +145 -0
  9. data/docs/EnvParser/ValueNotConvertibleError.html +144 -0
  10. data/docs/EnvParserTypes.html +127 -0
  11. data/docs/EnvParserTypes/BaseTypes.html +160 -0
  12. data/docs/_index.html +45 -3
  13. data/docs/class_list.html +1 -1
  14. data/docs/file.README.html +121 -132
  15. data/docs/index.html +121 -132
  16. data/docs/top-level-namespace.html +6 -4
  17. data/lib/env_parser.rb +66 -79
  18. data/lib/env_parser/errors.rb +28 -0
  19. data/lib/env_parser/types.rb +3 -0
  20. data/lib/env_parser/types/base_types.rb +80 -26
  21. data/lib/env_parser/version.rb +1 -1
  22. metadata +10 -2
data/docs/EnvParser/ValueNotConvertibleError.html ADDED
@@ -0,0 +1,144 @@
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
+ Exception: EnvParser::ValueNotConvertibleError
8
+
9
+ &mdash; Documentation by YARD 0.9.11
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 = "EnvParser::ValueNotConvertibleError";
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 (V)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span>
41
+ &raquo;
42
+ <span class="title">ValueNotConvertibleError</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>Exception: EnvParser::ValueNotConvertibleError
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="Error.html" title="EnvParser::Error (class)">Error</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">StandardError</li>
78
+
79
+ <li class="next"><span class='object_link'><a href="Error.html" title="EnvParser::Error (class)">Error</a></span></li>
80
+
81
+ <li class="next">EnvParser::ValueNotConvertibleError</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/env_parser/errors.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>Error class used to indicate value given is not convertible to the
110
+ requested type.</p>
111
+
112
+
113
+ </div>
114
+ </div>
115
+ <div class="tags">
116
+
117
+
118
+ </div>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ </div>
135
+
136
+ <div id="footer">
137
+ Generated on Mon Dec 25 19:13:03 2017 by
138
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
139
+ 0.9.11 (ruby-2.4.2).
140
+ </div>
141
+
142
+ </div>
143
+ </body>
144
+ </html>
data/docs/EnvParserTypes.html ADDED
@@ -0,0 +1,127 @@
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
8
+
9
+ &mdash; Documentation by YARD 0.9.11
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";
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 (E)</a> &raquo;
40
+
41
+
42
+ <span class="title">EnvParserTypes</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
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/base_types.rb</dd>
82
+ </dl>
83
+
84
+ </div>
85
+
86
+ <h2>Overview</h2><div class="docstring">
87
+ <div class="discussion">
88
+
89
+ <p>The parent module for all EnvParser type definition modules. Exists only
90
+ for documentation&#39;s sake.</p>
91
+
92
+
93
+ </div>
94
+ </div>
95
+ <div class="tags">
96
+
97
+
98
+ </div><h2>Defined Under Namespace</h2>
99
+ <p class="children">
100
+
101
+
102
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="EnvParserTypes/BaseTypes.html" title="EnvParserTypes::BaseTypes (module)">BaseTypes</a></span>
103
+
104
+
105
+
106
+
107
+ </p>
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+ </div>
118
+
119
+ <div id="footer">
120
+ Generated on Mon Dec 25 19:13:02 2017 by
121
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
122
+ 0.9.11 (ruby-2.4.2).
123
+ </div>
124
+
125
+ </div>
126
+ </body>
127
+ </html>
data/docs/EnvParserTypes/BaseTypes.html ADDED
@@ -0,0 +1,160 @@
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::BaseTypes
8
+
9
+ &mdash; Documentation by YARD 0.9.11
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::BaseTypes";
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 (B)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../EnvParserTypes.html" title="EnvParserTypes (module)">EnvParserTypes</a></span></span>
41
+ &raquo;
42
+ <span class="title">BaseTypes</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::BaseTypes
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/base_types.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 primitive classes, adding the following:</p>
90
+ <table>
91
+ <tbody>
92
+ <tr>
93
+ <th><code>:as</code> value</th>
94
+ <th>type returned</th>
95
+ </tr>
96
+ </tbody>
97
+ <tbody>
98
+ <tr>
99
+ <td>:string</td>
100
+ <td>String</td>
101
+ </tr>
102
+ <tr>
103
+ <td>:symbol</td>
104
+ <td>Symbol</td>
105
+ </tr>
106
+ <tr>
107
+ <td>:boolean</td>
108
+ <td>TrueValue / FalseValue</td>
109
+ </tr>
110
+ <tr>
111
+ <td>:int / :integer</td>
112
+ <td>Integer</td>
113
+ </tr>
114
+ <tr>
115
+ <td>:float / :decimal / :number</td>
116
+ <td>Float</td>
117
+ </tr>
118
+ <tr>
119
+ <td>:json</td>
120
+ <td>&lt; depends on JSON given &gt;</td>
121
+ </tr>
122
+ <tr>
123
+ <td>:array</td>
124
+ <td>Array</td>
125
+ </tr>
126
+ <tr>
127
+ <td>:hash</td>
128
+ <td>Hash</td>
129
+ </tr>
130
+ </tbody>
131
+ </table>
132
+ <p>Note JSON is parsed using <em>quirks-mode</em> (meaning &#39;true&#39;,
133
+ &#39;25&#39;, and &#39;null&#39; are all considered valid, parseable JSON).</p>
134
+
135
+
136
+ </div>
137
+ </div>
138
+ <div class="tags">
139
+
140
+
141
+ </div>
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ </div>
151
+
152
+ <div id="footer">
153
+ Generated on Mon Dec 25 19:13:02 2017 by
154
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
155
+ 0.9.11 (ruby-2.4.2).
156
+ </div>
157
+
158
+ </div>
159
+ </body>
160
+ </html>
data/docs/_index.html CHANGED
@@ -78,6 +78,21 @@
78
78
  <td valign='top' width="33%">
79
79
 
80
80
 
81
+ <ul id="alpha_B" class="alpha">
82
+ <li class="letter">B</li>
83
+ <ul>
84
+
85
+ <li>
86
+ <span class='object_link'><a href="EnvParserTypes/BaseTypes.html" title="EnvParserTypes::BaseTypes (module)">BaseTypes</a></span>
87
+
88
+ <small>(EnvParserTypes)</small>
89
+
90
+ </li>
91
+
92
+ </ul>
93
+ </ul>
94
+
95
+
81
96
  <ul id="alpha_E" class="alpha">
82
97
  <li class="letter">E</li>
83
98
  <ul>
@@ -87,6 +102,11 @@
87
102
 
88
103
  </li>
89
104
 
105
+ <li>
106
+ <span class='object_link'><a href="EnvParserTypes.html" title="EnvParserTypes (module)">EnvParserTypes</a></span>
107
+
108
+ </li>
109
+
90
110
  <li>
91
111
  <span class='object_link'><a href="EnvParser/Error.html" title="EnvParser::Error (class)">Error</a></span>
92
112
 
@@ -103,7 +123,22 @@
103
123
  <ul>
104
124
 
105
125
  <li>
106
- <span class='object_link'><a href="EnvParser/TypeAlreadyDefined.html" title="EnvParser::TypeAlreadyDefined (class)">TypeAlreadyDefined</a></span>
126
+ <span class='object_link'><a href="EnvParser/TypeAlreadyDefinedError.html" title="EnvParser::TypeAlreadyDefinedError (class)">TypeAlreadyDefinedError</a></span>
127
+
128
+ <small>(EnvParser)</small>
129
+
130
+ </li>
131
+
132
+ </ul>
133
+ </ul>
134
+
135
+
136
+ <ul id="alpha_U" class="alpha">
137
+ <li class="letter">U</li>
138
+ <ul>
139
+
140
+ <li>
141
+ <span class='object_link'><a href="EnvParser/UnknownTypeError.html" title="EnvParser::UnknownTypeError (class)">UnknownTypeError</a></span>
107
142
 
108
143
  <small>(EnvParser)</small>
109
144
 
@@ -118,7 +153,14 @@
118
153
  <ul>
119
154
 
120
155
  <li>
121
- <span class='object_link'><a href="EnvParser/ValueNotAllowed.html" title="EnvParser::ValueNotAllowed (class)">ValueNotAllowed</a></span>
156
+ <span class='object_link'><a href="EnvParser/ValueNotAllowedError.html" title="EnvParser::ValueNotAllowedError (class)">ValueNotAllowedError</a></span>
157
+
158
+ <small>(EnvParser)</small>
159
+
160
+ </li>
161
+
162
+ <li>
163
+ <span class='object_link'><a href="EnvParser/ValueNotConvertibleError.html" title="EnvParser::ValueNotConvertibleError (class)">ValueNotConvertibleError</a></span>
122
164
 
123
165
  <small>(EnvParser)</small>
124
166
 
@@ -136,7 +178,7 @@
136
178
  </div>
137
179
 
138
180
  <div id="footer">
139
- Generated on Sun Dec 24 19:33:34 2017 by
181
+ Generated on Mon Dec 25 19:13:01 2017 by
140
182
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
141
183
  0.9.11 (ruby-2.4.2).
142
184
  </div>