kdict 0.1.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 (56) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +15 -0
  3. data/.rspec +3 -0
  4. data/.travis.yml +7 -0
  5. data/.yardopts +3 -0
  6. data/CODE_OF_CONDUCT.md +74 -0
  7. data/Gemfile +6 -0
  8. data/Gemfile.lock +43 -0
  9. data/LICENSE.txt +21 -0
  10. data/README.md +301 -0
  11. data/Rakefile +8 -0
  12. data/bin/console +14 -0
  13. data/bin/setup +8 -0
  14. data/docs/Between.html +302 -0
  15. data/docs/Bool.html +121 -0
  16. data/docs/Example1.md +195 -0
  17. data/docs/FalseClass.html +143 -0
  18. data/docs/KDict/Error.html +135 -0
  19. data/docs/KDict.html +128 -0
  20. data/docs/Kdict/Error.html +135 -0
  21. data/docs/Kdict.html +157 -0
  22. data/docs/Kdict_.html +143 -0
  23. data/docs/KwargDict.html +697 -0
  24. data/docs/KwargModel.html +638 -0
  25. data/docs/KwargTypes.html +988 -0
  26. data/docs/Numeric.html +148 -0
  27. data/docs/TrueClass.html +143 -0
  28. data/docs/_index.html +184 -0
  29. data/docs/class_list.html +51 -0
  30. data/docs/css/common.css +1 -0
  31. data/docs/css/full_list.css +58 -0
  32. data/docs/css/style.css +496 -0
  33. data/docs/file.Example1.html +240 -0
  34. data/docs/file.README.html +370 -0
  35. data/docs/file_list.html +61 -0
  36. data/docs/frames.html +17 -0
  37. data/docs/index.html +370 -0
  38. data/docs/js/app.js +303 -0
  39. data/docs/js/full_list.js +216 -0
  40. data/docs/js/jquery.js +4 -0
  41. data/docs/method_list.html +187 -0
  42. data/docs/top-level-namespace.html +112 -0
  43. data/examples/example1.rb +90 -0
  44. data/kdict.gemspec +39 -0
  45. data/lib/kdict/kwargdict/kwargtypes/bool.rb +9 -0
  46. data/lib/kdict/kwargdict/kwargtypes.rb +196 -0
  47. data/lib/kdict/kwargdict.rb +75 -0
  48. data/lib/kdict/kwargmodel.rb +40 -0
  49. data/lib/kdict/version.rb +5 -0
  50. data/lib/kdict.rb +19 -0
  51. data/ndoc/checksums +6 -0
  52. data/ndoc/complete +0 -0
  53. data/ndoc/object_types +0 -0
  54. data/ndoc/objects/root.dat +0 -0
  55. data/ndoc/proxy_types +0 -0
  56. metadata +150 -0
data/docs/file.README.html ADDED
@@ -0,0 +1,370 @@
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
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.19
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 = "README";
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="file_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</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'>
61
+ <h1 id="label-KDict+-+A+Kwarg+Dictionary">KDict - A Kwarg Dictionary</h1>
62
+
63
+ <p>KDict allows you to quickly create powerful Keyword-Argument Dictionaries. Each entry can be used to validate a user&#39;s input against it, and is built from a generic type defintion (<em>typedef</em>) and a unique structure (<em>struct</em>).</p>
64
+
65
+ <p>With the included <em>typedefs</em> users can create simple to complex validaters in just a single line of code.</p>
66
+
67
+ <p>Examples avaible here in the README don&#39;t offer up the full scope of usefulness, so take the time to look at the example documentation in the full docs page.</p>
68
+
69
+ <p>View full docs at: <a href="https://stkterry.github.io/KDict">stkterry.github.io/KDict</a>/</p>
70
+
71
+ <p>View source code at: <a href="https://github.com/stkterry/KDict">github.com/stkterry/KDict</a>/</p>
72
+
73
+ <p><a href="file.Example1.html" title="Example1">Example1</a></p>
74
+
75
+ <p><em>Note: I&#39;m very new to Ruby, less than a month in, as it were. I suspect this thing might change quite a bit as I better familiarize myself with everything.</em></p>
76
+ <hr>
77
+
78
+ <h3 id="label-KwargDict">KwargDict</h3>
79
+
80
+ <p>This class defines a new, empty dictionary which can be filled with KwargModels. The class inherits Hash.</p>
81
+
82
+ <h4 id="label-Initialization-3A">Initialization:</h4>
83
+
84
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_kdict'>kdict</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="KwargDict.html" title="KwargDict (class)">KwargDict</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="KwargDict.html#initialize-instance_method" title="KwargDict#initialize (method)">new</a></span></span>
85
+ </code></pre>
86
+
87
+ <h4 id="label-Adding+Models+to+the+Dictionary-3A">Adding Models to the Dictionary:</h4>
88
+
89
+ <p>Each entry in the dictionary gets a name and the appropriate parameters used to construct a KwargModel. As an example the following definitions might be used in an app where the user is allowed to modify a label, it&#39;s fontsize, it&#39;s color, and x_data for a graph.</p>
90
+
91
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_kdict'>kdict</span><span class='lbracket'>[</span><span class='symbol'>:label</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>String</span>
92
+ <span class='id identifier rubyid_kdict'>kdict</span><span class='lbracket'>[</span><span class='symbol'>:fontsize</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>Integer</span>
93
+ <span class='id identifier rubyid_kdict'>kdict</span><span class='lbracket'>[</span><span class='symbol'>:rgb</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Integer</span><span class='rbracket'>]</span><span class='op'>*</span><span class='int'>3</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_n'>n</span><span class='op'>|</span> <span class='id identifier rubyid_n'>n</span><span class='period'>.</span><span class='id identifier rubyid_ibetween?'>ibetween?</span><span class='lparen'>(</span><span class='int'>0</span><span class='comma'>,</span> <span class='int'>255</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
94
+ <span class='id identifier rubyid_kdict'>kdict</span><span class='lbracket'>[</span><span class='symbol'>:x_data</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>Float</span>
95
+
96
+ <span class='comment'># Or if you prefer a single command
97
+ </span><span class='id identifier rubyid_kdict'>kdict</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:one</span><span class='comma'>,</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:two</span><span class='comma'>,</span> <span class='symbol'>:kwargsof</span><span class='comma'>,</span> <span class='id identifier rubyid_anotherKwargModel'>anotherKwargModel</span><span class='rbracket'>]</span><span class='comma'>,</span>
98
+ <span class='lbracket'>[</span><span class='symbol'>:three</span><span class='comma'>,</span> <span class='symbol'>:anyof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>this</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>or</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>that</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># ... etc.
99
+ </span></code></pre>
100
+
101
+ <h4 id="label-KwargModel+Structure">KwargModel Structure</h4>
102
+
103
+ <p>Each entry in the dictionary is defined by its name and by two or three parameters.</p>
104
+ <ul><li>
105
+ <p><strong>type</strong> - The model&#39;s generic type</p>
106
+ </li><li>
107
+ <p><strong>struct</strong> - The model&#39;s structure/definition</p>
108
+ </li><li>
109
+ <p><strong>prc</strong> - An optional Proc that increases specificity of the model&#39;s defintion.</p>
110
+ <ul><li>
111
+ <p><em>not all typedefs allow for an optional Proc</em></p>
112
+ </li></ul>
113
+ </li></ul>
114
+
115
+ <h4 id="label-Checking+Input+Against+the+Dictionary-3A">Checking Input Against the Dictionary:</h4>
116
+
117
+ <p>In the user&#39;s main code, one need only provide a single line to test input</p>
118
+
119
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_kdict'>kdict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:label</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Is This A Good Label?</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># =&gt; true
120
+ </span><span class='id identifier rubyid_kdict'>kdict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:lable</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A mispelled kword</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># =&gt; false
121
+ </span><span class='id identifier rubyid_kdict'>kdict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:fontsize</span><span class='comma'>,</span> <span class='int'>16</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
122
+ </span><span class='id identifier rubyid_kdict'>kdict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:fontsize</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>16</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># =&gt; false
123
+ </span><span class='id identifier rubyid_kdict'>kdict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:rgb</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='int'>125</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>223</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
124
+ </span><span class='id identifier rubyid_kdict'>kdict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:rgb</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='int'>256</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>192</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
125
+ </span><span class='id identifier rubyid_kdict'>kdict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:rgb</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='int'>125</span><span class='comma'>,</span> <span class='int'>0</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
126
+ </span><span class='id identifier rubyid_kdict'>kdict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:x_data</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>1.3</span><span class='comma'>,</span> <span class='float'>2.5</span><span class='comma'>,</span> <span class='float'>4.0</span><span class='comma'>,</span> <span class='float'>11.1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
127
+ </span><span class='comment'>#... etc.
128
+ </span></code></pre>
129
+ <hr>
130
+
131
+ <h3 id="label-Where+Is+This+Useful-3F">Where Is This Useful?</h3>
132
+
133
+ <p>Any application that might have a large number of optional parameters across several different methods, such as graphing libs and user-databases.</p>
134
+
135
+ <h4 id="label-Example+Implementation+Snippet-3A">Example Implementation Snippet:</h4>
136
+
137
+ <p>A user made want to format strings and pass them on to an interpreter or other application.</p>
138
+
139
+ <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>MyFigure</span>
140
+ <span class='id identifier rubyid_include'>include</span> <span class='const'>TextKwargs</span> <span class='comment'># &lt;- A predefined KwargDict (text_dict) would be included in this module.
141
+ </span> <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:my_params</span>
142
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_title'>title</span><span class='rparen'>)</span>
143
+ <span class='ivar'>@title</span> <span class='op'>=</span> <span class='id identifier rubyid_title'>title</span>
144
+ <span class='ivar'>@my_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
145
+ <span class='kw'>end</span>
146
+
147
+ <span class='kw'>def</span> <span class='id identifier rubyid_set_some_params'>set_some_params</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_kwords_vals'>kwords_vals</span><span class='rparen'>)</span>
148
+ <span class='id identifier rubyid_kwords_vals'>kwords_vals</span><span class='period'>.</span><span class='id identifier rubyid_each_slice'>each_slice</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_kword'>kword</span><span class='comma'>,</span> <span class='id identifier rubyid_val'>val</span><span class='op'>|</span>
149
+ <span class='ivar'>@my_params</span><span class='lbracket'>[</span><span class='id identifier rubyid_kword'>kword</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span> <span class='kw'>if</span> <span class='id identifier rubyid_text_dict'>text_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='id identifier rubyid_kword'>kword</span><span class='comma'>,</span> <span class='id identifier rubyid_val'>val</span><span class='rparen'>)</span>
150
+ <span class='kw'>end</span>
151
+ <span class='kw'>end</span>
152
+ <span class='kw'>end</span>
153
+
154
+ <span class='id identifier rubyid_fig'>fig</span> <span class='op'>=</span> <span class='const'>MyFigure</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>It Came From Outer Space!</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
155
+ <span class='id identifier rubyid_fig'>fig</span><span class='period'>.</span><span class='id identifier rubyid_set_some_params'>set_some_params</span><span class='lparen'>(</span><span class='symbol'>:fontsize</span><span class='comma'>,</span> <span class='int'>11</span><span class='comma'>,</span> <span class='symbol'>:fontfamily</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sans</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='symbol'>:bold</span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:fontname</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Georiga</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
156
+ </code></pre>
157
+
158
+ <p>How users treat validated or failed parameters from here is left to the imagination.</p>
159
+ <hr>
160
+
161
+ <h3 id="label-Anatomy+of+a+KwargModel-3A">Anatomy of a KwargModel:</h3>
162
+
163
+ <h4 id="label-Typedef+and+Struct">Typedef and Struct</h4>
164
+
165
+ <p>Each <em>typedef</em> is actually a method built to handle a particular kind of <em>struct</em>, while each <em>struct</em> is what makes an instance of KwargModel unique. Some <em>typedefs</em> will only allow for a specific set of <em>struct</em> values while others are more flexible. There are just eight <em>typedef</em> methods, though you can easily make your own.</p>
166
+
167
+ <h4 id="label-3Atypeof"><strong><em>:typeof</em></strong></h4>
168
+
169
+ <p>Your <em>struct</em> contains a singular value of exactly one datatype.</p>
170
+ <ul><li>
171
+ <p><strong><em>structs</em></strong> - Some of Ruby&#39;s built-in types plus <em>Bool</em>, an added datatype for true/false collectively. Acceptable <em>struct</em> arguments then, are: <strong>Numeric, Float, Integer, Bool, String, Symbol</strong></p>
172
+ </li><li>
173
+ <p>Can accept a Proc that must also return true for successful validation</p>
174
+ </li></ul>
175
+
176
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span>
177
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
178
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
179
+ </span>
180
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>Float</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_n'>n</span><span class='op'>|</span> <span class='id identifier rubyid_n'>n</span> <span class='op'>&gt;</span> <span class='float'>5.3</span> <span class='rbrace'>}</span>
181
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='float'>2.1</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
182
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='float'>5.4</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
183
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='int'>6</span><span class='rparen'>)</span> <span class='comment'># =&gt; false ... note that 6 &gt; 5.3 but 6 is not datatype Float
184
+ </span></code></pre>
185
+ <hr>
186
+
187
+ <h4 id="label-3Aarrayof"><strong><em>:arrayof</em></strong></h4>
188
+
189
+ <p>Your <em>struct</em> contains an array of any length but contains only one datatype.</p>
190
+ <ul><li>
191
+ <p><strong><em>structs</em></strong> - Again some of Ruby&#39;s built-in types plus Bool: <strong>Numeric, Float, Integer, Bool, String, Symbol</strong></p>
192
+ </li><li>
193
+ <p>Multi-dimensional arrays will be treated as flattened and all values will still be checked against the given <em>struct</em></p>
194
+ </li><li>
195
+ <p>Can accept a Proc that must return true for ALL values in the array.</p>
196
+ </li></ul>
197
+
198
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>Strings</span>
199
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>will</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>return</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>true</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
200
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>is</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>false</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='float'>4.7</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
201
+ </span>
202
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>Strings</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>2</span> <span class='rbrace'>}</span>
203
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>will</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>return</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>true</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
204
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>is</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>still</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>false</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
205
+ </span></code></pre>
206
+ <hr>
207
+
208
+ <h4 id="label-3Aanyof"><strong><em>:anyof</em></strong></h4>
209
+
210
+ <p>Your <em>struct</em> contains a singular element that can be found in an array.</p>
211
+ <ul><li>
212
+ <p><strong><em>structs</em></strong> - An array of any mix of things you&#39;d like, EXCEPT other instances of KwargModels or KwargDicts.</p>
213
+ </li><li>
214
+ <p>Will not accept a Proc and must not contain generic datatype symbols.</p>
215
+ </li></ul>
216
+
217
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:anyof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>xx-small</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>x-small</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>large</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='float'>3.2</span><span class='rbracket'>]</span>
218
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>x-small</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># =&gt; true
219
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='float'>3.2</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
220
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>xx-large</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># =&gt; false
221
+ </span></code></pre>
222
+ <hr>
223
+
224
+ <h4 id="label-3AanyNof"><strong><em>:anyNof</em></strong></h4>
225
+
226
+ <p>Your <em>struct</em> contains an element AND specific datatypes in an array.</p>
227
+ <ul><li>
228
+ <p><strong><em>structs</em></strong> - An array of any mixed things you&#39;d like plus generic datatype keywords <strong>Numeric, Float, Integer, Bool, String, Symbol</strong></p>
229
+ </li><li>
230
+ <p>Can accept a Proc that will only operate on a given value if it&#39;s identified by a generic datatype in <em>struct</em> after a check for explicit existence in the array</p>
231
+ </li></ul>
232
+
233
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:anyNof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Integer</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>red</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blue</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>magenta</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
234
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>red</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># =&gt; true
235
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='int'>34</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
236
+ </span>
237
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:anyNof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Float</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>green</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='float'>3.1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_n'>n</span><span class='op'>|</span> <span class='id identifier rubyid_n'>n</span> <span class='op'>&gt;</span> <span class='int'>5</span> <span class='rbrace'>}</span>
238
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>green</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># =&gt; true
239
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='float'>6.1</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
240
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='float'>3.1</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
241
+ </span><span class='comment'># Again note that :anyNof&#39;s Proc is operating only on values NOT explicitly listed in the array.
242
+ </span></code></pre>
243
+ <hr>
244
+
245
+ <h4 id="label-3Aformof"><strong><em>:formof</em></strong></h4>
246
+
247
+ <p>Your <em>struct</em> contains an array of exact length, you expect each element to be contained in a specific order and be a generic datatype</p>
248
+ <ul><li>
249
+ <p><strong><em>structs</em></strong> - An array of set length containing generic datatype keywords <strong>Numeric, Float, Integer, Bool, String, Symbol</strong>, in a specific order. Will return false if user input appears out of order with respect to the <em>struct</em>.</p>
250
+ </li><li>
251
+ <p>Can accept a Proc that must return true for ALL values in the array.</p>
252
+ </li></ul>
253
+
254
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span><span class='comma'>,</span> <span class='const'>Float</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span>
255
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='kw'>false</span><span class='comma'>,</span> <span class='float'>3.1</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Holly Dolly</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
256
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='kw'>false</span><span class='comma'>,</span> <span class='float'>3.1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
257
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Holly Dolly</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='float'>3.1</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
258
+ </span>
259
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_n'>n</span><span class='op'>|</span> <span class='id identifier rubyid_n'>n</span><span class='period'>.</span><span class='id identifier rubyid_between?'>between?</span><span class='lparen'>(</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>3</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
260
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='int'>2</span><span class='comma'>,</span> <span class='float'>1.1</span><span class='comma'>,</span> <span class='float'>1.2</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
261
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>1.1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='float'>1.4</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
262
+ </span></code></pre>
263
+ <hr>
264
+
265
+ <h4 id="label-3Akwargsof"><strong><em>:kwargsof</em></strong></h4>
266
+
267
+ <p>Your <em>struct</em> contains a hash that corresponds to another KwargDict</p>
268
+ <ul><li>
269
+ <p><strong><em>structs</em></strong> - Can only be another KwargDict instance.</p>
270
+ </li><li>
271
+ <p>Will not accept a Proc</p>
272
+ </li><li>
273
+ <p>Input hash need not contain every <em>kword</em> from the nested KwargDict to return true</p>
274
+ </li><li>
275
+ <p>Will return true only if every key-arg pair in input hash is valid in nested KwargDict</p>
276
+ </li></ul>
277
+
278
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_another_dict'>another_dict</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:one</span><span class='comma'>,</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:two</span><span class='comma'>,</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:three</span><span class='comma'>,</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span><span class='rbracket'>]</span><span class='comma'>,</span>
279
+ <span class='lbracket'>[</span><span class='symbol'>:and</span><span class='comma'>,</span> <span class='symbol'>:anyof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>partridge</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>in</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>a</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>pear</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tree</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span>
280
+
281
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:kwargsof</span><span class='comma'>,</span> <span class='id identifier rubyid_another_dict'>another_dict</span>
282
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>one:</span><span class='float'>3.1</span><span class='comma'>,</span> <span class='label'>three:</span><span class='kw'>false</span><span class='comma'>,</span> <span class='label'>and:</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>in</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
283
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>two:</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>this</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>works</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>four:</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>without this</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
284
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>two:</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>see?</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
285
+ </span></code></pre>
286
+ <hr>
287
+
288
+ <h4 id="label-3Aadv_formof"><strong><em>:adv_formof</em></strong></h4>
289
+
290
+ <p>Your <em>struct</em> contains an array of exact length, each of whom&#39;s elements has its own subset of <em>typedef</em>, <em>struct</em>, and possibly <em>prc</em></p>
291
+ <ul><li>
292
+ <p><strong><em>structs</em></strong> - Must be an array of exact length, each element of which is a sub array containing <em>typedef</em>, <em>struct</em>, and an optional <em>prc</em>, in that order. Can accept <strong>:typeof, :arrayof, :anyof, :anyNof, :formof</strong>, and <strong>:adv_formof</strong>.</p>
293
+ </li><li>
294
+ <p>Will NOT accept <em>:kwargsof</em> or <em>:and_kwargsof</em>.</p>
295
+ </li><li>
296
+ <p>Will return false if user input appears out of order with respect to the <em>struct</em>.</p>
297
+ </li><li>
298
+ <p>Will not accept a Proc outside of a sub <em>typedef</em>. Each element in <em>struct</em> may have its own unique Proc, however, if allowed for that <em>typedef</em>.</p>
299
+ </li></ul>
300
+
301
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:adv_formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
302
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>3.1</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='comma'>,</span> <span class='int'>4</span><span class='comma'>,</span> <span class='int'>5</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
303
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>3.1</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>3</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
304
+ </span>
305
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:proc_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:adv_formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>5</span> <span class='rbrace'>}</span><span class='rbracket'>]</span><span class='comma'>,</span>
306
+ <span class='lbracket'>[</span><span class='symbol'>:formof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Float</span><span class='rbracket'>]</span><span class='op'>*</span><span class='int'>3</span> <span class='comma'>,</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_n'>n</span><span class='op'>|</span> <span class='id identifier rubyid_n'>n</span><span class='period'>.</span><span class='id identifier rubyid_ibetween?'>ibetween?</span><span class='lparen'>(</span><span class='int'>0</span><span class='comma'>,</span><span class='int'>1</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
307
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Longer</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>0.25</span><span class='comma'>,</span> <span class='float'>0.5</span><span class='comma'>,</span> <span class='float'>1.0</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
308
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Longer</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='op'>-</span><span class='float'>0.25</span><span class='comma'>,</span> <span class='float'>0.5</span><span class='comma'>,</span> <span class='op'>-</span><span class='float'>1.0</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
309
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:proc_example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Short</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='float'>0.25</span><span class='comma'>,</span> <span class='float'>0.5</span><span class='comma'>,</span> <span class='float'>1.0</span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false
310
+ </span></code></pre>
311
+ <hr>
312
+
313
+ <h4 id="label-3Aand_kwargsof"><strong><em>:and_kwargsof</em></strong></h4>
314
+
315
+ <p>Your <em>struct</em> is structured like <em>:adv_formof</em> but the last element MUST be a <em>:kwargsof</em> <em>typedef</em></p>
316
+ <ul><li>
317
+ <p><strong><em>structs</em></strong> - MUST be an array in the form of <em>:adv_formof</em>, but the last sub <em>typedef</em> MUST be <em>:kwargsof</em></p>
318
+ </li><li>
319
+ <p>Will return true if given a single value that returns true from the first sub <em>typedef</em> in the array.</p>
320
+ </li><li>
321
+ <p>Will return true if given an array of values in the order they appear in <em>struct</em>, without skipping one, and each returns true from its respective sub <em>typedef</em></p>
322
+ </li><li>
323
+ <p>Will return true if the previous statement is true but the given array also includes a hash that corresponds to the last sub <em>typedef</em> in the <em>struct</em>, which again must always be <em>:kwargsof</em>.</p>
324
+ </li><li>
325
+ <p>Will return false if only a hash is present, even if the hash elements are all valid to its nested KwargDict</p>
326
+ </li><li>
327
+ <p>Each sub <em>typedef</em> may receive a Proc if allowed for that <em>typedef</em></p>
328
+ </li></ul>
329
+
330
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_another_dict'>another_dict</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:one</span><span class='comma'>,</span> <span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>Float</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:two</span><span class='comma'>,</span> <span class='symbol'>:arrayof</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span><span class='rparen'>)</span>
331
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='lbracket'>[</span><span class='symbol'>:example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:and_kwargsof</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'>String</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:typeof</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Bool.html" title="Bool (module)">Bool</a></span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:kwargsof</span><span class='comma'>,</span> <span class='id identifier rubyid_another_dict'>another_dict</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
332
+
333
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>It works!</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># =&gt; true
334
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>And this.</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
335
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This too.</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
336
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>As does this.</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>two:</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Super!</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
337
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Even this works.</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>two:</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Yep.</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>one:</span><span class='float'>3.1</span><span class='rbrace'>}</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; true
338
+ </span>
339
+ <span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='comment'># =&gt; false | Skips the first element of :example
340
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>It broke!</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='comment'># =&gt; false | Elements appear out of order
341
+ </span><span class='id identifier rubyid_my_dict'>my_dict</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>one:</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Nope</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'># =&gt; false | Contains only the hash
342
+ </span></code></pre>
343
+
344
+ <h3 id="label-ToDo-3A">ToDo:</h3>
345
+ <ul><li>
346
+ <p>Add more examples.</p>
347
+ </li><li>
348
+ <p>Modify the typedefs <em>:kwargsof</em> and <em>:and_kwargsof</em> to return a mapping of true and false values. Write a method #granular_check into KwargDict to return those arrays of Bools and re-write #check to return a singular Bool based on whether any Bool in the array from #granular_check is false.</p>
349
+ </li><li>
350
+ <p>Concerning the above, may re-rewrite those typedefs to return hashes of Bools, which may make it even easier for the user to decide what to do with the returned validation data.</p>
351
+ </li><li>
352
+ <p>The RSPEC files do not yet check every detail of the KwargTypes as they should.</p>
353
+ </li><li>
354
+ <p>Add another module that check&#39;s most aspects of a definition itself. In other words, checking that the <em>struct</em> a user wishes to assign to a definition in a KwargDict fits within the boundaries set by it&#39;s associated <em>typedef</em>. No assigning the datatype keyword &#39;Array&#39; to a <em>:typeof</em> model, for instance.</p>
355
+ </li><li>
356
+ <p>Better documentation?</p>
357
+ </li><li>
358
+ <p>Build a method into KwargDict that allows the user to easily merge specific entries from different dictionaries.</p>
359
+ </li></ul>
360
+ </div></div>
361
+
362
+ <div id="footer">
363
+ Generated on Thu Apr 11 21:45:29 2019 by
364
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
365
+ 0.9.19 (ruby-2.6.2).
366
+ </div>
367
+
368
+ </div>
369
+ </body>
370
+ </html>
data/docs/file_list.html ADDED
@@ -0,0 +1,61 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
+ <meta charset="utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <title>File List</title>
19
+ <base id="base_target" target="_parent" />
20
+ </head>
21
+ <body>
22
+ <div id="content">
23
+ <div class="fixed_header">
24
+ <h1 id="full_list_header">File List</h1>
25
+ <div id="full_list_nav">
26
+
27
+ <span><a target="_self" href="class_list.html">
28
+ Classes
29
+ </a></span>
30
+
31
+ <span><a target="_self" href="method_list.html">
32
+ Methods
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="file_list.html">
36
+ Files
37
+ </a></span>
38
+
39
+ </div>
40
+
41
+ <div id="search">Search: <input type="text" /></div>
42
+ </div>
43
+
44
+ <ul id="full_list" class="file">
45
+
46
+
47
+ <li id="object_README" class="odd">
48
+ <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
49
+ </li>
50
+
51
+
52
+ <li id="object_Example1" class="even">
53
+ <div class="item"><span class="object_link"><a href="file.Example1.html" title="Example1">Example1</a></span></div>
54
+ </li>
55
+
56
+
57
+
58
+ </ul>
59
+ </div>
60
+ </body>
61
+ </html>
data/docs/frames.html ADDED
@@ -0,0 +1,17 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Documentation by YARD 0.9.19</title>
6
+ </head>
7
+ <script type="text/javascript" charset="utf-8">
8
+ var match = unescape(window.location.hash).match(/^#!(.+)/);
9
+ var name = match ? match[1] : 'index.html';
10
+ name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
11
+ window.top.location = name;
12
+ </script>
13
+ <noscript>
14
+ <h1>Oops!</h1>
15
+ <h2>YARD requires JavaScript!</h2>
16
+ </noscript>
17
+ </html>