env_parser 1.6.2 → 1.7.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.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +3 -2
  3. data/Gemfile.lock +73 -30
  4. data/README.md +2 -2
  5. data/docs/EnvParser/AutoregisterFileNotFound.html +12 -9
  6. data/docs/EnvParser/Error.html +10 -8
  7. data/docs/EnvParser/TypeAlreadyDefinedError.html +11 -8
  8. data/docs/EnvParser/Types/BaseTypes.html +11 -11
  9. data/docs/EnvParser/Types/ChronologyTypes.html +10 -9
  10. data/docs/EnvParser/Types/InternetTypes.html +10 -9
  11. data/docs/EnvParser/Types.html +12 -10
  12. data/docs/EnvParser/UnknownTypeError.html +12 -9
  13. data/docs/EnvParser/UnparseableAutoregisterSpec.html +12 -9
  14. data/docs/EnvParser/ValueNotAllowedError.html +12 -9
  15. data/docs/EnvParser/ValueNotConvertibleError.html +11 -8
  16. data/docs/EnvParser.html +67 -113
  17. data/docs/_index.html +9 -7
  18. data/docs/class_list.html +5 -5
  19. data/docs/css/common.css +1 -1
  20. data/docs/css/full_list.css +201 -53
  21. data/docs/css/style.css +988 -402
  22. data/docs/file.README.html +242 -327
  23. data/docs/file_list.html +5 -5
  24. data/docs/frames.html +1 -1
  25. data/docs/index.html +242 -327
  26. data/docs/js/app.js +800 -343
  27. data/docs/js/full_list.js +332 -240
  28. data/docs/method_list.html +5 -5
  29. data/docs/top-level-namespace.html +8 -6
  30. data/env_parser.gemspec +3 -3
  31. data/lib/env_parser/types/internet_types.rb +2 -2
  32. data/lib/env_parser/version.rb +1 -1
  33. data/lib/env_parser.rb +1 -3
  34. metadata +4 -9
  35. data/spec/env_parser/types/base_types_spec.rb +0 -98
  36. data/spec/env_parser/types/chronology_types_spec.rb +0 -49
  37. data/spec/env_parser/types/internet_types_spec.rb +0 -95
  38. data/spec/env_parser_spec.rb +0 -214
  39. data/spec/spec_helper.rb +0 -14
data/docs/EnvParser.html CHANGED
@@ -6,13 +6,13 @@
6
6
  <title>
7
7
  Class: EnvParser
8
8
 
9
- &mdash; Documentation by YARD 0.9.37
9
+ &mdash; Documentation by YARD 0.9.44
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="css/style.css" type="text/css" />
13
+ <link rel="stylesheet" href="css/style.css" type="text/css">
14
14
 
15
- <link rel="stylesheet" href="css/common.css" type="text/css" />
15
+ <link rel="stylesheet" href="css/common.css" type="text/css">
16
16
 
17
17
  <script type="text/javascript">
18
18
  pathId = "EnvParser";
@@ -27,6 +27,8 @@
27
27
 
28
28
  </head>
29
29
  <body>
30
+ <div id="main_progress" aria-hidden="true"></div>
31
+
30
32
  <div class="nav_wrap">
31
33
  <iframe id="nav" src="class_list.html?1"></iframe>
32
34
  <div id="resizer"></div>
@@ -94,8 +96,9 @@
94
96
 
95
97
  <dl>
96
98
  <dt>Defined in:</dt>
97
- <dd>lib/env_parser.rb<span class="defines">,<br />
98
- lib/env_parser/errors.rb,<br /> lib/env_parser/version.rb</span>
99
+ <dd>lib/env_parser.rb<span class="defines">,<br>
100
+ lib/env_parser/errors.rb,<br> lib/env_parser/version.rb</span>
101
+
99
102
  </dd>
100
103
  </dl>
101
104
 
@@ -105,7 +108,6 @@
105
108
  <div class="discussion">
106
109
  <p>The EnvParser class simplifies parsing of environment variables as different data types.</p>
107
110
 
108
-
109
111
  </div>
110
112
  </div>
111
113
  <div class="tags">
@@ -137,7 +139,6 @@
137
139
  <div class="discussion">
138
140
  <p>The default filename to use for <span class='object_link'><a href="#autoregister-class_method" title="EnvParser.autoregister (method)">autoregister</a></span> requests.</p>
139
141
 
140
-
141
142
  </div>
142
143
  </div>
143
144
  <div class="tags">
@@ -150,7 +151,7 @@
150
151
  <dt id="VERSION-constant" class="">VERSION =
151
152
 
152
153
  </dt>
153
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.6.2</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
154
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.7.1</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
154
155
 
155
156
  </dl>
156
157
 
@@ -186,8 +187,7 @@
186
187
 
187
188
 
188
189
 
189
- <span class="summary_desc"><div class='inline'><p>Creates ENV bindings for <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">EnvParser.parse</a></span> and <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">EnvParser.register</a></span> proxy methods.</p>
190
- </div></span>
190
+ <span class="summary_desc"><div class='inline'><p>Creates ENV bindings for <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">EnvParser.parse</a></span> and <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">EnvParser.register</a></span> proxy methods.</p></div></span>
191
191
 
192
192
  </li>
193
193
 
@@ -209,8 +209,7 @@
209
209
 
210
210
 
211
211
 
212
- <span class="summary_desc"><div class='inline'><p>Reads an “autoregister” file and registers the ENV constants defined therein.</p>
213
- </div></span>
212
+ <span class="summary_desc"><div class='inline'><p>Reads an &quot;autoregister&quot; file and registers the ENV constants defined therein.</p></div></span>
214
213
 
215
214
  </li>
216
215
 
@@ -232,8 +231,7 @@
232
231
 
233
232
 
234
233
 
235
- <span class="summary_desc"><div class='inline'><p>Defines a new type for use as the “as” option on a subsequent <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">EnvParser.parse</a></span> or <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">EnvParser.register</a></span> call.</p>
236
- </div></span>
234
+ <span class="summary_desc"><div class='inline'><p>Defines a new type for use as the &quot;as&quot; option on a subsequent <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">EnvParser.parse</a></span> or <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">EnvParser.register</a></span> call.</p></div></span>
237
235
 
238
236
  </li>
239
237
 
@@ -255,8 +253,7 @@
255
253
 
256
254
 
257
255
 
258
- <span class="summary_desc"><div class='inline'><p>Interprets the given value as the specified type.</p>
259
- </div></span>
256
+ <span class="summary_desc"><div class='inline'><p>Interprets the given value as the specified type.</p></div></span>
260
257
 
261
258
  </li>
262
259
 
@@ -278,13 +275,13 @@
278
275
 
279
276
 
280
277
 
281
- <span class="summary_desc"><div class='inline'><p>Parses the referenced value and creates a matching constant in the requested context.</p>
282
- </div></span>
278
+ <span class="summary_desc"><div class='inline'><p>Parses the referenced value and creates a matching constant in the requested context.</p></div></span>
283
279
 
284
280
  </li>
285
281
 
286
282
 
287
283
  </ul>
284
+
288
285
 
289
286
 
290
287
 
@@ -305,11 +302,9 @@
305
302
  </h3><div class="docstring">
306
303
  <div class="discussion">
307
304
  <p>Creates ENV bindings for <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span> and <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span> proxy methods.</p>
308
-
309
305
  <p>The sole difference between these proxy methods and their EnvParser counterparts is that
310
306
  ENV.parse will interpret any value given as an ENV key (as a String), not the given value
311
- itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘XYZ’], …)</p>
312
-
307
+ itself. i.e. ENV.parse('XYZ', ...) is equivalent to EnvParser.parse(<a href="'XYZ'">ENV</a>, ...)</p>
313
308
 
314
309
  </div>
315
310
  </div>
@@ -326,8 +321,7 @@ itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘
326
321
 
327
322
 
328
323
  &mdash;
329
- <div class='inline'><p>This generates no usable value.</p>
330
- </div>
324
+ <div class='inline'><p>This generates no usable value.</p></div>
331
325
 
332
326
  </li>
333
327
 
@@ -385,13 +379,11 @@ itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘
385
379
 
386
380
  </h3><div class="docstring">
387
381
  <div class="discussion">
388
- <p>Reads an “autoregister” file and registers the ENV constants defined therein.</p>
389
-
390
- <p>The “autoregister” file is read, parsed as YAML, sanitized for use as a parameter to
382
+ <p>Reads an &quot;autoregister&quot; file and registers the ENV constants defined therein.</p>
383
+ <p>The &quot;autoregister&quot; file is read, parsed as YAML, sanitized for use as a parameter to
391
384
  <span class='object_link'>register_all</span>, and then passed along for processing. The return value from that
392
385
  <span class='object_link'>register_all</span> call is passed through.</p>
393
386
 
394
-
395
387
  </div>
396
388
  </div>
397
389
  <div class="tags">
@@ -411,8 +403,7 @@ itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘
411
403
 
412
404
  &mdash;
413
405
  <div class='inline'><p>A path for the autoregister file to parse and process. Defaults to
414
- <span class='object_link'><a href="#AUTOREGISTER_FILE-constant" title="EnvParser::AUTOREGISTER_FILE (constant)">AUTOREGISTER_FILE</a></span> if unset.</p>
415
- </div>
406
+ <span class='object_link'><a href="#AUTOREGISTER_FILE-constant" title="EnvParser::AUTOREGISTER_FILE (constant)">AUTOREGISTER_FILE</a></span> if unset.</p></div>
416
407
 
417
408
  </li>
418
409
 
@@ -429,8 +420,7 @@ itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘
429
420
 
430
421
 
431
422
  &mdash;
432
- <div class='inline'><p>The return value from the <span class='object_link'>register_all</span> call that handles the actual registration.</p>
433
- </div>
423
+ <div class='inline'><p>The return value from the <span class='object_link'>register_all</span> call that handles the actual registration.</p></div>
434
424
 
435
425
  </li>
436
426
 
@@ -525,8 +515,7 @@ itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘
525
515
 
526
516
  </h3><div class="docstring">
527
517
  <div class="discussion">
528
- <p>Defines a new type for use as the “as” option on a subsequent <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span> or <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span> call.</p>
529
-
518
+ <p>Defines a new type for use as the &quot;as&quot; option on a subsequent <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span> or <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span> call.</p>
530
519
 
531
520
  </div>
532
521
  </div>
@@ -544,8 +533,7 @@ itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘
544
533
 
545
534
 
546
535
  &mdash;
547
- <div class='inline'><p>The name to assign to the type.</p>
548
- </div>
536
+ <div class='inline'><p>The name to assign to the type.</p></div>
549
537
 
550
538
  </li>
551
539
 
@@ -561,8 +549,7 @@ itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘
561
549
 
562
550
 
563
551
  &mdash;
564
- <div class='inline'><p>a customizable set of options</p>
565
- </div>
552
+ <div class='inline'><p>a customizable set of options</p></div>
566
553
 
567
554
  </li>
568
555
 
@@ -583,8 +570,7 @@ itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘
583
570
 
584
571
  </span>
585
572
 
586
- &mdash; <div class='inline'><p>An array of additional names you’d like to see refer to this same type.</p>
587
- </div>
573
+ &mdash; <div class='inline'><p>An array of additional names you'd like to see refer to this same type.</p></div>
588
574
 
589
575
  </li>
590
576
 
@@ -598,10 +584,9 @@ itself. i.e. ENV.parse(‘XYZ’, …) is equivalent to EnvParser.parse(ENV[‘
598
584
 
599
585
  </span>
600
586
 
601
- &mdash; <div class='inline'><p>Specifies a “sensible default” to return for this type if the value being parsed (via
587
+ &mdash; <div class='inline'><p>Specifies a &quot;sensible default&quot; to return for this type if the value being parsed (via
602
588
  <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span> or <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span>) is either unset (<code>nil</code>) or blank (<code>''</code>). Note this may be
603
- overridden by the user via the <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>/<span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span> “if_unset” option.</p>
604
- </div>
589
+ overridden by the user via the <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>/<span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span> &quot;if_unset&quot; option.</p></div>
605
590
 
606
591
  </li>
607
592
 
@@ -621,15 +606,12 @@ overridden by the user via the <span class='object_link'><a href="#parse-class_m
621
606
  &mdash;
622
607
  <div class='inline'><p>A block to act as the parser for the this type. If no block is given, an ArgumentError is
623
608
  raised.</p>
624
-
625
609
  <p>When the type defined is used via a <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>/<span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span> call, this block is invoked with
626
- the value to be parsed. Said value is guaranteed to be a non-empty String (the “if_unset”
610
+ the value to be parsed. Said value is guaranteed to be a non-empty String (the &quot;if_unset&quot;
627
611
  check will have already run), but no other assurances as to content are given. The block
628
612
  should return the final output of parsing the given String value as the type being defined.</p>
629
-
630
613
  <p>If the value given cannot be sensibly parsed into the type defined, the block should raise
631
- an <span class='object_link'><a href="EnvParser/ValueNotConvertibleError.html" title="EnvParser::ValueNotConvertibleError (class)">ValueNotConvertibleError</a></span>.</p>
632
- </div>
614
+ an <span class='object_link'><a href="EnvParser/ValueNotConvertibleError.html" title="EnvParser::ValueNotConvertibleError (class)">ValueNotConvertibleError</a></span>.</p></div>
633
615
 
634
616
  </li>
635
617
 
@@ -645,8 +627,7 @@ an <span class='object_link'><a href="EnvParser/ValueNotConvertibleError.html" t
645
627
 
646
628
 
647
629
  &mdash;
648
- <div class='inline'><p>This generates no usable value.</p>
649
- </div>
630
+ <div class='inline'><p>This generates no usable value.</p></div>
650
631
 
651
632
  </li>
652
633
 
@@ -723,7 +704,6 @@ an <span class='object_link'><a href="EnvParser/ValueNotConvertibleError.html" t
723
704
  <div class="discussion">
724
705
  <p>Interprets the given value as the specified type.</p>
725
706
 
726
-
727
707
  </div>
728
708
  </div>
729
709
  <div class="tags">
@@ -741,8 +721,7 @@ an <span class='object_link'><a href="EnvParser/ValueNotConvertibleError.html" t
741
721
 
742
722
  &mdash;
743
723
  <div class='inline'><p>The value to parse/interpret. If a String is given, the value will be used as-is. If a
744
- Symbol is given, the ENV value for the matching string key will be used.</p>
745
- </div>
724
+ Symbol is given, the ENV value for the matching string key will be used.</p></div>
746
725
 
747
726
  </li>
748
727
 
@@ -758,8 +737,7 @@ Symbol is given, the ENV value for the matching string key will be used.</p>
758
737
 
759
738
 
760
739
  &mdash;
761
- <div class='inline'><p>a customizable set of options</p>
762
- </div>
740
+ <div class='inline'><p>a customizable set of options</p></div>
763
741
 
764
742
  </li>
765
743
 
@@ -782,11 +760,9 @@ Symbol is given, the ENV value for the matching string key will be used.</p>
782
760
 
783
761
  &mdash; <div class='inline'><p>The expected return type. A best-effort attempt is made to convert the source String to the
784
762
  requested type.</p>
785
-
786
- <p>If no “as” option is given, an ArgumentError is raised. If the “as” option given is unknown
763
+ <p>If no &quot;as&quot; option is given, an ArgumentError is raised. If the &quot;as&quot; option given is unknown
787
764
  (the given type has not been previously defined via <span class='object_link'><a href="#define_type-class_method" title="EnvParser.define_type (method)">define_type</a></span>), an
788
- <span class='object_link'><a href="EnvParser/UnknownTypeError.html" title="EnvParser::UnknownTypeError (class)">UnknownTypeError</a></span> is raised.</p>
789
- </div>
765
+ <span class='object_link'><a href="EnvParser/UnknownTypeError.html" title="EnvParser::UnknownTypeError (class)">UnknownTypeError</a></span> is raised.</p></div>
790
766
 
791
767
  </li>
792
768
 
@@ -797,11 +773,10 @@ requested type.</p>
797
773
 
798
774
  </span>
799
775
 
800
- &mdash; <div class='inline'><p>Specifies the default value to return if the given “value” is either unset (<code>nil</code>) or blank
801
- (<code>''</code>). Any “if_unset” value given will be returned as-is, with no type conversion or other
802
- change having been made. If unspecified, the “default” value for <code>nil</code>/<code>''</code> input will
803
- depend on the “as” type.</p>
804
- </div>
776
+ &mdash; <div class='inline'><p>Specifies the default value to return if the given &quot;value&quot; is either unset (<code>nil</code>) or blank
777
+ (<code>''</code>). Any &quot;if_unset&quot; value given will be returned as-is, with no type conversion or other
778
+ change having been made. If unspecified, the &quot;default&quot; value for <code>nil</code>/<code>''</code> input will
779
+ depend on the &quot;as&quot; type.</p></div>
805
780
 
806
781
  </li>
807
782
 
@@ -813,16 +788,13 @@ depend on the “as” type.</p>
813
788
  </span>
814
789
 
815
790
  &mdash; <div class='inline'><p>Gives a limited set of allowed values (after type conversion). If, after parsing, the final
816
- value is not included in the “from_set” list/range, an <span class='object_link'><a href="EnvParser/ValueNotAllowedError.html" title="EnvParser::ValueNotAllowedError (class)">ValueNotAllowedError</a></span> is
791
+ value is not included in the &quot;from_set&quot; list/range, an <span class='object_link'><a href="EnvParser/ValueNotAllowedError.html" title="EnvParser::ValueNotAllowedError (class)">ValueNotAllowedError</a></span> is
817
792
  raised.</p>
818
-
819
- <p>Note that if the “if_unset” option is given and the value to parse is <code>nil</code>/<code>''</code>, the
820
- “if_unset” value will be returned, even if it is not part of the “from_set” list/range.</p>
821
-
822
- <p>Also note that, due to the nature of the lookup, the “from_set” option is only available
793
+ <p>Note that if the &quot;if_unset&quot; option is given and the value to parse is <code>nil</code>/<code>''</code>, the
794
+ &quot;if_unset&quot; value will be returned, even if it is not part of the &quot;from_set&quot; list/range.</p>
795
+ <p>Also note that, due to the nature of the lookup, the &quot;from_set&quot; option is only available
823
796
  for scalar values (i.e. not arrays, hashes, or other enumerables). An attempt to use the
824
- “from_set” option with a non-scalar value will raise an ArgumentError.</p>
825
- </div>
797
+ &quot;from_set&quot; option with a non-scalar value will raise an ArgumentError.</p></div>
826
798
 
827
799
  </li>
828
800
 
@@ -833,16 +805,14 @@ for scalar values (i.e. not arrays, hashes, or other enumerables). An attempt to
833
805
 
834
806
  </span>
835
807
 
836
- &mdash; <div class='inline'><p>If given, the “validated_by” Proc is called with the parsed value (after type conversion)
808
+ &mdash; <div class='inline'><p>If given, the &quot;validated_by&quot; Proc is called with the parsed value (after type conversion)
837
809
  as its sole argument. This allows for user-defined validation of the parsed value beyond
838
- what can be enforced by use of the “from_set” option alone. If the Proc’s return value is
810
+ what can be enforced by use of the &quot;from_set&quot; option alone. If the Proc's return value is
839
811
  <code>#blank?</code>, an <span class='object_link'><a href="EnvParser/ValueNotAllowedError.html" title="EnvParser::ValueNotAllowedError (class)">ValueNotAllowedError</a></span> is raised. To accomodate your syntax of
840
812
  choice, this validation Proc may be given as a block instead.</p>
841
-
842
- <p>Note that this option is intended to provide an inspection mechanism only – no mutation
813
+ <p>Note that this option is intended to provide an inspection mechanism only -- no mutation
843
814
  of the parsed value should occur within the given Proc. To that end, the argument passed is
844
- a <em>frozen</em> duplicate of the parsed value.</p>
845
- </div>
815
+ a <em>frozen</em> duplicate of the parsed value.</p></div>
846
816
 
847
817
  </li>
848
818
 
@@ -860,12 +830,10 @@ a <em>frozen</em> duplicate of the parsed value.</p>
860
830
 
861
831
 
862
832
  &mdash;
863
- <div class='inline'><p>A block (if given) is treated exactly as the “validated_by” Proc would.</p>
864
-
865
- <p>Although there is no compelling reason to provide both a “validated_by” Proc <em>and</em> a
833
+ <div class='inline'><p>A block (if given) is treated exactly as the &quot;validated_by&quot; Proc would.</p>
834
+ <p>Although there is no compelling reason to provide both a &quot;validated_by&quot; Proc <em>and</em> a
866
835
  validation block, there is no technical limitation preventing this. <strong>If both are given,
867
- both validation checks must pass.</strong></p>
868
- </div>
836
+ both validation checks must pass.</strong></p></div>
869
837
 
870
838
  </li>
871
839
 
@@ -943,10 +911,8 @@ both validation checks must pass.</strong></p>
943
911
  </h3><div class="docstring">
944
912
  <div class="discussion">
945
913
  <p>Parses the referenced value and creates a matching constant in the requested context.</p>
946
-
947
914
  <p>Multiple calls to <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span> may be shortcutted by passing in a Hash whose keys are the
948
- variable names and whose values are the options set for each variable’s <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span> call.</p>
949
-
915
+ variable names and whose values are the options set for each variable's <span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span> call.</p>
950
916
  <pre class="code ruby"><code class="ruby">
951
917
  # Example shortcut usage:
952
918
 
@@ -961,7 +927,6 @@ variable names and whose values are the options set for each variable’s <span
961
927
  )
962
928
  </code></pre>
963
929
 
964
-
965
930
  </div>
966
931
  </div>
967
932
  <div class="tags">
@@ -978,9 +943,8 @@ variable names and whose values are the options set for each variable’s <span
978
943
 
979
944
 
980
945
  &mdash;
981
- <div class='inline'><p>The name of the value to parse/interpret from the “from” Hash. If the “from” value is
982
- <code>ENV</code>, you may give a Symbol and the corresponding String key will be used instead.</p>
983
- </div>
946
+ <div class='inline'><p>The name of the value to parse/interpret from the &quot;from&quot; Hash. If the &quot;from&quot; value is
947
+ <code>ENV</code>, you may give a Symbol and the corresponding String key will be used instead.</p></div>
984
948
 
985
949
  </li>
986
950
 
@@ -996,8 +960,7 @@ variable names and whose values are the options set for each variable’s <span
996
960
 
997
961
 
998
962
  &mdash;
999
- <div class='inline'><p>a customizable set of options</p>
1000
- </div>
963
+ <div class='inline'><p>a customizable set of options</p></div>
1001
964
 
1002
965
  </li>
1003
966
 
@@ -1021,8 +984,7 @@ variable names and whose values are the options set for each variable’s <span
1021
984
 
1022
985
  </span>
1023
986
 
1024
- &mdash; <div class='inline'><p>The source Hash from which to pull the value referenced by the “name” key.</p>
1025
- </div>
987
+ &mdash; <div class='inline'><p>The source Hash from which to pull the value referenced by the &quot;name&quot; key.</p></div>
1026
988
 
1027
989
  </li>
1028
990
 
@@ -1033,18 +995,16 @@ variable names and whose values are the options set for each variable’s <span
1033
995
 
1034
996
  </span>
1035
997
 
1036
- &mdash; <div class='inline'><p>The name the constant should be given. Valid only when a “within” value is <em>explicitly</em>
998
+ &mdash; <div class='inline'><p>The name the constant should be given. Valid only when a &quot;within&quot; value is <em>explicitly</em>
1037
999
  given. This allows for decoupling ENV variable names from the constant name defined
1038
1000
  within its target class or module, allowing for the ENV variables to be namespaced in
1039
1001
  some way.</p>
1040
-
1041
1002
  <pre class="code ruby"><code class="ruby">
1042
1003
  <span class='const'><span class='object_link'><a href="" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span>
1043
1004
  <span class='label'>CUSTOM_CLIENT_DEFAULT_HOSTNAME:</span> <span class='lbrace'>{</span> <span class='label'>as:</span> <span class='symbol'>:string</span><span class='comma'>,</span> <span class='label'>named:</span> <span class='symbol'>:DEFAULT_HOSTNAME</span><span class='comma'>,</span> <span class='label'>within:</span> <span class='const'>CustomClient</span> <span class='rbrace'>}</span><span class='comma'>,</span>
1044
1005
  <span class='label'>CUSTOM_CLIENT_DEFAULT_PORT:</span> <span class='lbrace'>{</span> <span class='label'>as:</span> <span class='symbol'>:integer</span><span class='comma'>,</span> <span class='label'>named:</span> <span class='symbol'>:DEFAULT_PORT</span><span class='comma'>,</span> <span class='label'>within:</span> <span class='const'>CustomClient</span> <span class='rbrace'>}</span>
1045
1006
  <span class='rparen'>)</span>
1046
- </code></pre>
1047
- </div>
1007
+ </code></pre></div>
1048
1008
 
1049
1009
  </li>
1050
1010
 
@@ -1059,8 +1019,7 @@ some way.</p>
1059
1019
  </span>
1060
1020
 
1061
1021
  &mdash; <div class='inline'><p>The module or class in which the constant should be created. Creates global constants by
1062
- default.</p>
1063
- </div>
1022
+ default.</p></div>
1064
1023
 
1065
1024
  </li>
1066
1025
 
@@ -1071,8 +1030,7 @@ default.</p>
1071
1030
 
1072
1031
  </span>
1073
1032
 
1074
- &mdash; <div class='inline'><p>See <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>.</p>
1075
- </div>
1033
+ &mdash; <div class='inline'><p>See <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>.</p></div>
1076
1034
 
1077
1035
  </li>
1078
1036
 
@@ -1083,8 +1041,7 @@ default.</p>
1083
1041
 
1084
1042
  </span>
1085
1043
 
1086
- &mdash; <div class='inline'><p>See <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>.</p>
1087
- </div>
1044
+ &mdash; <div class='inline'><p>See <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>.</p></div>
1088
1045
 
1089
1046
  </li>
1090
1047
 
@@ -1095,8 +1052,7 @@ default.</p>
1095
1052
 
1096
1053
  </span>
1097
1054
 
1098
- &mdash; <div class='inline'><p>See <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>.</p>
1099
- </div>
1055
+ &mdash; <div class='inline'><p>See <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>.</p></div>
1100
1056
 
1101
1057
  </li>
1102
1058
 
@@ -1107,8 +1063,7 @@ default.</p>
1107
1063
 
1108
1064
  </span>
1109
1065
 
1110
- &mdash; <div class='inline'><p>See <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>.</p>
1111
- </div>
1066
+ &mdash; <div class='inline'><p>See <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>.</p></div>
1112
1067
 
1113
1068
  </li>
1114
1069
 
@@ -1127,9 +1082,8 @@ default.</p>
1127
1082
 
1128
1083
  &mdash;
1129
1084
  <div class='inline'><p>A block (if given) is treated exactly as in <span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span>. Note, however, that a single block
1130
- cannot be used to register multiple constants simultaneously – each value needing
1131
- validation must give its own “validated_by” Proc.</p>
1132
- </div>
1085
+ cannot be used to register multiple constants simultaneously -- each value needing
1086
+ validation must give its own &quot;validated_by&quot; Proc.</p></div>
1133
1087
 
1134
1088
  </li>
1135
1089
 
@@ -1230,11 +1184,11 @@ validation must give its own “validated_by” Proc.</p>
1230
1184
  </div>
1231
1185
 
1232
1186
  <div id="footer">
1233
- Generated on Mon Jun 9 14:00:25 2025 by
1187
+ Generated on Sun Jun 21 01:17:51 2026 by
1234
1188
  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1235
- 0.9.37 (ruby-3.4.2).
1189
+ 0.9.44 (ruby-3.4.8).
1236
1190
  </div>
1237
1191
 
1238
1192
  </div>
1239
1193
  </body>
1240
- </html>
1194
+ </html>
data/docs/_index.html CHANGED
@@ -4,13 +4,13 @@
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.37
7
+ Documentation by YARD 0.9.44
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
15
  <script type="text/javascript">
16
16
  pathId = null;
@@ -25,6 +25,8 @@
25
25
 
26
26
  </head>
27
27
  <body>
28
+ <div id="main_progress" aria-hidden="true"></div>
29
+
28
30
  <div class="nav_wrap">
29
31
  <iframe id="nav" src="class_list.html?1"></iframe>
30
32
  <div id="resizer"></div>
@@ -52,7 +54,7 @@
52
54
  <div class="clear"></div>
53
55
  </div>
54
56
 
55
- <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.37</h1>
57
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.44</h1>
56
58
  <div id="listing">
57
59
  <h1 class="alphaindex">Alphabetic Index</h1>
58
60
 
@@ -233,11 +235,11 @@
233
235
  </div>
234
236
 
235
237
  <div id="footer">
236
- Generated on Mon Jun 9 14:00:25 2025 by
238
+ Generated on Sun Jun 21 01:17:51 2026 by
237
239
  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
238
- 0.9.37 (ruby-3.4.2).
240
+ 0.9.44 (ruby-3.4.8).
239
241
  </div>
240
242
 
241
243
  </div>
242
244
  </body>
243
- </html>
245
+ </html>
data/docs/class_list.html CHANGED
@@ -2,11 +2,11 @@
2
2
  <html >
3
3
  <head>
4
4
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
- <meta charset="utf-8" />
5
+ <meta charset="utf-8">
6
6
 
7
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen">
8
8
 
9
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen">
10
10
 
11
11
 
12
12
 
@@ -16,7 +16,7 @@
16
16
 
17
17
 
18
18
  <title>Class List</title>
19
- <base id="base_target" target="_parent" />
19
+ <base id="base_target" target="_parent">
20
20
  </head>
21
21
  <body>
22
22
  <div id="content">
@@ -40,7 +40,7 @@
40
40
 
41
41
  <div id="search">
42
42
  <label for="search-class">Search:</label>
43
- <input id="search-class" type="text" />
43
+ <input id="search-class" type="text">
44
44
  </div>
45
45
  </div>
46
46
 
data/docs/css/common.css CHANGED
@@ -1 +1 @@
1
- /* Override this file with custom rules */
1
+ /* Override this file with custom rules */