1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: SnakyHash
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "SnakyHash";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (S)</a> »
<span class="title">SnakyHash</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: SnakyHash
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/snaky_hash.rb<span class="defines">,<br />
lib/snaky_hash/snake.rb,<br /> lib/snaky_hash/version.rb,<br /> lib/snaky_hash/extensions.rb,<br /> lib/snaky_hash/serializer.rb,<br /> lib/snaky_hash/string_keyed.rb,<br /> lib/snaky_hash/symbol_keyed.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is a module-class hybrid.</p>
<p>A flexible key conversion system that supports both String and Symbol keys,<br />
with optional serialization capabilities.</p>
<p>Hashie’s standard SymbolizeKeys is similar to the functionality we want.<br />
… but not quite. We need to support both String (for oauth2) and Symbol keys (for oauth).<br />
see: Hashie::Extensions::Mash::SymbolizeKeys</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<h5 class="example_title"><div class='inline'><p>Basic usage with string keys</p>
</div></h5>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>MyHash</span> <span class='op'><</span> <span class='const'>Hashie</span><span class='op'>::</span><span class='const'>Mash</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>SnakyHash</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SnakyHash/Snake.html" title="SnakyHash::Snake (class)">Snake</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="SnakyHash/Snake.html#initialize-instance_method" title="SnakyHash::Snake#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>key_type:</span> <span class='symbol'>:string</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
<h5 class="example_title"><div class='inline'><p>Usage with symbol keys and serialization</p>
</div></h5>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>MySerializableHash</span> <span class='op'><</span> <span class='const'>Hashie</span><span class='op'>::</span><span class='const'>Mash</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>SnakyHash</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SnakyHash/Snake.html" title="SnakyHash::Snake (class)">Snake</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="SnakyHash/Snake.html#initialize-instance_method" title="SnakyHash::Snake#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>key_type:</span> <span class='symbol'>:symbol</span><span class='comma'>,</span> <span class='label'>serializer:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="SnakyHash/Serializer.html" title="SnakyHash::Serializer (module)">Serializer</a></span>, <span class='object_link'><a href="SnakyHash/Version.html" title="SnakyHash::Version (module)">Version</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="SnakyHash/Error.html" title="SnakyHash::Error (class)">Error</a></span>, <span class='object_link'><a href="SnakyHash/Extensions.html" title="SnakyHash::Extensions (class)">Extensions</a></span>, <span class='object_link'><a href="SnakyHash/Snake.html" title="SnakyHash::Snake (class)">Snake</a></span>, <span class='object_link'><a href="SnakyHash/StringKeyed.html" title="SnakyHash::StringKeyed (class)">StringKeyed</a></span>, <span class='object_link'><a href="SnakyHash/SymbolKeyed.html" title="SnakyHash::SymbolKeyed (class)">SymbolKeyed</a></span>
</p>
</div>
<div id="footer">
Generated on Fri May 23 09:32:07 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.4.3).
</div>
</div>
</body>
</html>
|
