baccigalupi-aqua 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (57) hide show
  1. data/.yardoc +0 -0
  2. data/Aqua.gemspec +17 -1
  3. data/VERSION +1 -1
  4. data/doc/Aqua.html +12 -12
  5. data/doc/Aqua/Config.html +1 -1
  6. data/doc/Aqua/Config/ClassMethods.html +1 -1
  7. data/doc/Aqua/From.html +107 -0
  8. data/doc/Aqua/ObjectNotFound.html +1 -1
  9. data/doc/Aqua/Pack.html +2 -2
  10. data/doc/Aqua/Pack/ClassMethods.html +4 -4
  11. data/doc/Aqua/Pack/InstanceMethods.html +379 -17
  12. data/doc/Aqua/Query.html +1 -1
  13. data/doc/Aqua/Query/ClassMethods.html +1 -1
  14. data/doc/Aqua/Query/InstanceMethods.html +1 -1
  15. data/doc/Aqua/Storage.html +1 -1
  16. data/doc/Aqua/Store.html +1 -1
  17. data/doc/Aqua/Store/CouchDB.html +1 -1
  18. data/doc/Aqua/Store/CouchDB/Conflict.html +1 -1
  19. data/doc/Aqua/Store/CouchDB/Database.html +1 -1
  20. data/doc/Aqua/Store/CouchDB/RequestFailed.html +1 -1
  21. data/doc/Aqua/Store/CouchDB/RequestTimeout.html +1 -1
  22. data/doc/Aqua/Store/CouchDB/ResourceNotFound.html +1 -1
  23. data/doc/Aqua/Store/CouchDB/Server.html +1 -1
  24. data/doc/Aqua/Store/CouchDB/ServerBrokeConnection.html +1 -1
  25. data/doc/Aqua/Store/CouchDB/StorageMethods.html +1 -1
  26. data/doc/Aqua/Store/CouchDB/StorageMethods/ClassMethods.html +1 -1
  27. data/doc/Aqua/Store/CouchDB/StorageMethods/InstanceMethods.html +7 -7
  28. data/doc/Aqua/Stub.html +464 -0
  29. data/doc/Aqua/Tank.html +4 -4
  30. data/doc/Aqua/TempStub.html +81 -0
  31. data/doc/Aqua/To.html +179 -0
  32. data/doc/Aqua/Unpack.html +1 -1
  33. data/doc/Aqua/Unpack/ClassMethods.html +41 -10
  34. data/doc/Aqua/Unpack/InstanceMethods.html +1244 -37
  35. data/doc/Array.html +178 -0
  36. data/doc/Bignum.html +102 -0
  37. data/doc/Date.html +102 -0
  38. data/doc/FalseClass.html +102 -0
  39. data/doc/Fixnum.html +102 -0
  40. data/doc/Float.html +102 -0
  41. data/doc/Hash.html +196 -0
  42. data/doc/OpenStruct.html +102 -0
  43. data/doc/README.rdoc.html +10 -1
  44. data/doc/Rational.html +170 -0
  45. data/doc/RestAPI.html +1 -1
  46. data/doc/RestClientAdapter.html +1 -1
  47. data/doc/Time.html +102 -0
  48. data/doc/TrueClass.html +102 -0
  49. data/doc/all-methods.html +252 -0
  50. data/doc/all-namespaces.html +30 -0
  51. data/doc/custom.css +3 -5
  52. data/doc/top-level-namespace.html +1 -1
  53. data/lib/aqua.rb +1 -0
  54. data/lib/aqua/object/pack.rb +104 -132
  55. data/lib/aqua/object/unpack.rb +71 -49
  56. data/lib/aqua/support/initializers.rb +133 -0
  57. metadata +17 -1
data/.yardoc CHANGED
Binary file
@@ -5,7 +5,7 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = %q{aqua}
8
- s.version = "0.1.3"
8
+ s.version = "0.1.4"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Kane Baccigalupi"]
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
29
29
  "doc/Aqua.html",
30
30
  "doc/Aqua/Config.html",
31
31
  "doc/Aqua/Config/ClassMethods.html",
32
+ "doc/Aqua/From.html",
32
33
  "doc/Aqua/ObjectNotFound.html",
33
34
  "doc/Aqua/Pack.html",
34
35
  "doc/Aqua/Pack/ClassMethods.html",
@@ -49,13 +50,27 @@ Gem::Specification.new do |s|
49
50
  "doc/Aqua/Store/CouchDB/StorageMethods.html",
50
51
  "doc/Aqua/Store/CouchDB/StorageMethods/ClassMethods.html",
51
52
  "doc/Aqua/Store/CouchDB/StorageMethods/InstanceMethods.html",
53
+ "doc/Aqua/Stub.html",
52
54
  "doc/Aqua/Tank.html",
55
+ "doc/Aqua/TempStub.html",
56
+ "doc/Aqua/To.html",
53
57
  "doc/Aqua/Unpack.html",
54
58
  "doc/Aqua/Unpack/ClassMethods.html",
55
59
  "doc/Aqua/Unpack/InstanceMethods.html",
60
+ "doc/Array.html",
61
+ "doc/Bignum.html",
62
+ "doc/Date.html",
63
+ "doc/FalseClass.html",
64
+ "doc/Fixnum.html",
65
+ "doc/Float.html",
66
+ "doc/Hash.html",
67
+ "doc/OpenStruct.html",
56
68
  "doc/README.rdoc.html",
69
+ "doc/Rational.html",
57
70
  "doc/RestAPI.html",
58
71
  "doc/RestClientAdapter.html",
72
+ "doc/Time.html",
73
+ "doc/TrueClass.html",
59
74
  "doc/all-files.html",
60
75
  "doc/all-methods.html",
61
76
  "doc/all-namespaces.html",
@@ -84,6 +99,7 @@ Gem::Specification.new do |s|
84
99
  "lib/aqua/store/couch_db/server.rb",
85
100
  "lib/aqua/store/couch_db/storage_methods.rb",
86
101
  "lib/aqua/store/storage.rb",
102
+ "lib/aqua/support/initializers.rb",
87
103
  "lib/aqua/support/mash.rb",
88
104
  "lib/aqua/support/string_extensions.rb",
89
105
  "spec/aqua_spec.rb",
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.1.3
1
+ 0.1.4
@@ -90,7 +90,7 @@ Loads the requested backend storage engine.
90
90
  <p class='returns'>
91
91
  Returns:
92
92
  <span class='return_types'>
93
- <tt>TrueClass</tt>
93
+ <tt><a href="TrueClass.html" title="TrueClass">TrueClass</a></tt>
94
94
  </span>
95
95
  </p>
96
96
 
@@ -145,14 +145,14 @@ Loads an external engine from a hash of options.
145
145
  <pre class="lines">
146
146
 
147
147
 
148
- 88
149
148
  89
150
149
  90
151
150
  91
152
- 92</pre>
151
+ 92
152
+ 93</pre>
153
153
  </td>
154
154
  <td>
155
- <pre class="code"><span class="info file"># File 'lib/aqua.rb', line 88</span>
155
+ <pre class="code"><span class="info file"># File 'lib/aqua.rb', line 89</span>
156
156
 
157
157
  <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='include_engine identifier id'>include_engine</span><span class='lparen token'>(</span> <span class='str identifier id'>str</span> <span class='rparen token'>)</span>
158
158
  <span class='Aqua constant id'>Aqua</span><span class='colon2 op'>::</span><span class='Storage constant id'>Storage</span><span class='dot token'>.</span><span class='class_eval identifier id'>class_eval</span> <span class='do do kw'>do</span>
@@ -199,14 +199,14 @@ Loads an internal engine from a string
199
199
  <pre class="lines">
200
200
 
201
201
 
202
- 79
203
202
  80
204
203
  81
205
204
  82
206
- 83</pre>
205
+ 83
206
+ 84</pre>
207
207
  </td>
208
208
  <td>
209
- <pre class="code"><span class="info file"># File 'lib/aqua.rb', line 79</span>
209
+ <pre class="code"><span class="info file"># File 'lib/aqua.rb', line 80</span>
210
210
 
211
211
  <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='load_internal_engine identifier id'>load_internal_engine</span><span class='lparen token'>(</span> <span class='str identifier id'>str</span> <span class='rparen token'>)</span>
212
212
  <span class='underscored identifier id'>underscored</span> <span class='assign token'>=</span> <span class='str identifier id'>str</span><span class='dot token'>.</span><span class='underscore identifier id'>underscore</span>
@@ -289,7 +289,7 @@ engine, at runtime, when needed.
289
289
 
290
290
  <dt>
291
291
 
292
- <span class='type'>[<tt>TrueClass</tt>]</span>
292
+ <span class='type'>[<tt><a href="TrueClass.html" title="TrueClass">TrueClass</a></tt>]</span>
293
293
 
294
294
 
295
295
  <span class='name'></span>
@@ -439,7 +439,6 @@ String with the full module name
439
439
  <pre class="lines">
440
440
 
441
441
 
442
- 63
443
442
  64
444
443
  65
445
444
  66
@@ -451,10 +450,11 @@ String with the full module name
451
450
  72
452
451
  73
453
452
  74
454
- 75</pre>
453
+ 75
454
+ 76</pre>
455
455
  </td>
456
456
  <td>
457
- <pre class="code"><span class="info file"># File 'lib/aqua.rb', line 63</span>
457
+ <pre class="code"><span class="info file"># File 'lib/aqua.rb', line 64</span>
458
458
 
459
459
  <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='set_storage_engine identifier id'>set_storage_engine</span><span class='lparen token'>(</span> <span class='engine identifier id'>engine</span><span class='assign token'>=</span><span class='string val'>&quot;CouchDB&quot;</span> <span class='rparen token'>)</span>
460
460
  <span class='if if kw'>if</span> <span class='engine identifier id'>engine</span><span class='dot token'>.</span><span class='class identifier id'>class</span> <span class='eq op'>==</span> <span class='String constant id'>String</span>
@@ -484,7 +484,7 @@ String with the full module name
484
484
  </div>
485
485
  </div>
486
486
  <div id="yard_info">
487
- Generated on Friday, August 21 2009 at 12:48:50 PM by
487
+ Generated on Thursday, August 27 2009 at 05:50:25 PM by
488
488
  <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr>
489
489
  0.2.3.5 (ruby-1.8.6).
490
490
  </div>
@@ -103,7 +103,7 @@
103
103
  </div>
104
104
  </div>
105
105
  <div id="yard_info">
106
- Generated on Friday, August 21 2009 at 12:48:50 PM by
106
+ Generated on Thursday, August 27 2009 at 05:50:24 PM by
107
107
  <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr>
108
108
  0.2.3.5 (ruby-1.8.6).
109
109
  </div>
@@ -151,7 +151,7 @@
151
151
  </div>
152
152
  </div>
153
153
  <div id="yard_info">
154
- Generated on Friday, August 21 2009 at 12:48:50 PM by
154
+ Generated on Thursday, August 27 2009 at 05:50:25 PM by
155
155
  <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr>
156
156
  0.2.3.5 (ruby-1.8.6).
157
157
  </div>
@@ -0,0 +1,107 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
+ <html>
4
+ <head>
5
+ <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
6
+ <link rel="stylesheet" href="../style.css" type="text/css" charset="utf-8" />
7
+ <link rel="stylesheet" href="../custom.css" type="text/css" charset="utf-8" />
8
+ <link rel="stylesheet" href="../syntax_highlight.css" type="text/css" charset="utf-8" />
9
+
10
+ <script src="../jquery.js" type="text/javascript" charset="utf-8"></script>
11
+ <script src="../app.js" type="text/javascript" charset="utf-8"></script>
12
+ <title>Module: Aqua::From</title>
13
+ </head>
14
+ <body>
15
+ <div id="content">
16
+ <div class="section module Aqua_From">
17
+ <h1 class="title">Module: Aqua::From</h1>
18
+ <div class="section docstring">
19
+ <p>
20
+ From
21
+ </p>
22
+
23
+ </div><div class="section constants">
24
+
25
+ </div> <div class="section visibilitygroup public">
26
+ <h1>Public Visibility</h1>
27
+ <div class="section methodsummary instance public">
28
+ <h1>Public Instance Method Summary</h1>
29
+ <table class="summary">
30
+
31
+ <tr>
32
+ <th class="signature">
33
+
34
+ <span class='overload'>
35
+ <span class='name'><a href="#aqua_init-instance_method" title="#aqua_init">#aqua_init</a></span><span class='args'>(init)</span>
36
+ <span class='block'></span>
37
+ </span>
38
+
39
+
40
+ </th>
41
+ <td class="docstring">
42
+
43
+
44
+ </td>
45
+ </tr>
46
+
47
+ </table>
48
+
49
+ </div>
50
+ <div class="section methoddetails instance public">
51
+ <h1>Public Instance Method Details</h1>
52
+
53
+ <div class="method">
54
+ <div class="method_header">
55
+ <h3>aqua_init</h3>
56
+ </div><div id="aqua_init-instance_method" class="section method">
57
+ <div class="details_title">
58
+ <div class='section methodsignature'>
59
+ <tt class='def'>
60
+ <span class='visibility'>public</span>
61
+ <span class='return_types'></span>
62
+ <span class='name'>aqua_init</span><span class='args'>(init)</span>
63
+ <span class='block'></span>
64
+ </tt>
65
+ </div>
66
+
67
+ </div><div class="section source">
68
+ <span>[<a class="source_link" href="#">View source</a>]</span>
69
+ <div class="source_code">
70
+ <table>
71
+ <tr>
72
+ <td>
73
+ <pre class="lines">
74
+
75
+
76
+ 24
77
+ 25
78
+ 26</pre>
79
+ </td>
80
+ <td>
81
+ <pre class="code"><span class="info file"># File 'lib/aqua/support/initializers.rb', line 24</span>
82
+
83
+ <span class='def def kw'>def</span> <span class='aqua_init identifier id'>aqua_init</span><span class='lparen token'>(</span> <span class='init identifier id'>init</span> <span class='rparen token'>)</span>
84
+ <span class='new identifier id'>new</span><span class='lparen token'>(</span> <span class='init identifier id'>init</span> <span class='rparen token'>)</span>
85
+ <span class='end end kw'>end</span>
86
+ </pre>
87
+ </td>
88
+ </tr>
89
+ </table>
90
+ </div>
91
+ </div>
92
+ </div>
93
+ </div>
94
+
95
+ </div>
96
+ </div>
97
+
98
+ </div>
99
+ </div>
100
+ <div id="yard_info">
101
+ Generated on Thursday, August 27 2009 at 05:50:20 PM by
102
+ <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr>
103
+ 0.2.3.5 (ruby-1.8.6).
104
+ </div>
105
+
106
+ </body>
107
+ </html>
@@ -25,7 +25,7 @@
25
25
  </div>
26
26
  </div>
27
27
  <div id="yard_info">
28
- Generated on Friday, August 21 2009 at 12:48:49 PM by
28
+ Generated on Thursday, August 27 2009 at 05:50:21 PM by
29
29
  <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr>
30
30
  0.2.3.5 (ruby-1.8.6).
31
31
  </div>
@@ -20,7 +20,7 @@
20
20
  This module is responsible for packing objects into Storage Objects The
21
21
  Storage Object is expected to be a Mash-Like thing (Hash with indifferent
22
22
  access). It is the job of the storage engine to convert the Mash into the
23
- actual storage data. Aqua::Pack
23
+ actual storage ivars. Aqua::Pack
24
24
  </p>
25
25
 
26
26
  </div><div class="section constants">
@@ -119,7 +119,7 @@ actual storage data. Aqua::Pack
119
119
  </div>
120
120
  </div>
121
121
  <div id="yard_info">
122
- Generated on Friday, August 21 2009 at 12:48:48 PM by
122
+ Generated on Thursday, August 27 2009 at 05:50:23 PM by
123
123
  <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr>
124
124
  0.2.3.5 (ruby-1.8.6).
125
125
  </div>
@@ -47,7 +47,7 @@ Reader method for accessing hidden attributes.
47
47
  <p class='returns'>
48
48
  Returns:
49
49
  <span class='return_types'>
50
- <tt>Array</tt>
50
+ <tt><a href="../../Array.html" title="Array">Array</a></tt>
51
51
  </span>
52
52
  </p>
53
53
 
@@ -88,7 +88,7 @@ persistance.
88
88
  <div class='section methodsignature'>
89
89
  <tt class='def'>
90
90
  <span class='visibility'>public</span>
91
- <span class='return_types'><tt>Array</tt></span>
91
+ <span class='return_types'><tt><a href="../../Array.html" title="Array">Array</a></tt></span>
92
92
  <span class='name'>_hidden_attributes</span><span class='args'></span>
93
93
  <span class='block'></span>
94
94
  </tt>
@@ -107,7 +107,7 @@ Reader method for accessing hidden attributes.
107
107
 
108
108
  <dt>
109
109
 
110
- <span class='type'>[<tt>Array</tt>]</span>
110
+ <span class='type'>[<tt><a href="../../Array.html" title="Array">Array</a></tt>]</span>
111
111
 
112
112
 
113
113
  <span class='name'></span>
@@ -231,7 +231,7 @@ persistance
231
231
  </div>
232
232
  </div>
233
233
  <div id="yard_info">
234
- Generated on Friday, August 21 2009 at 12:48:50 PM by
234
+ Generated on Thursday, August 27 2009 at 05:50:23 PM by
235
235
  <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr>
236
236
  0.2.3.5 (ruby-1.8.6).
237
237
  </div>
@@ -42,7 +42,7 @@ InstanceMethods
42
42
  <td class="docstring">
43
43
  <p>
44
44
  __pack is an Aqua::Storage object into which the object respresentation is
45
- packed _store is the current state of the storage of the object on CouchDB.
45
+ packed.
46
46
  </p>
47
47
 
48
48
 
@@ -64,7 +64,7 @@ packed _store is the current state of the storage of the object on CouchDB.
64
64
  <td class="docstring">
65
65
  <p>
66
66
  __pack is an Aqua::Storage object into which the object respresentation is
67
- packed _store is the current state of the storage of the object on CouchDB.
67
+ packed.
68
68
  </p>
69
69
 
70
70
 
@@ -86,7 +86,28 @@ packed _store is the current state of the storage of the object on CouchDB.
86
86
  <td class="docstring">
87
87
  <p>
88
88
  __pack is an Aqua::Storage object into which the object respresentation is
89
- packed _store is the current state of the storage of the object on CouchDB.
89
+ packed.
90
+ </p>
91
+
92
+
93
+ </td>
94
+ </tr>
95
+
96
+
97
+
98
+ <tr class="">
99
+ <th class='signature'>
100
+ <span class='name'>_warnings</span>
101
+ </td>
102
+ <td class="readwrite">
103
+ [<span id='_warnings-instance_method'>R</span><span id='_warnings=-instance_method'>W</span>]
104
+ </td>
105
+ <td class="visibility">
106
+ public
107
+ </td>
108
+ <td class="docstring">
109
+ <p>
110
+ Sets the attribute <tt>_warnings</tt>.
90
111
  </p>
91
112
 
92
113
 
@@ -106,6 +127,32 @@ packed _store is the current state of the storage of the object on CouchDB.
106
127
  <h1>Public Instance Method Summary</h1>
107
128
  <table class="summary">
108
129
 
130
+ <tr>
131
+ <th class="signature">
132
+
133
+ <span class='overload'>
134
+ <span class='name'><a href="#_build_object_key-instance_method" title="#_build_object_key">#_build_object_key</a></span><span class='args'>(obj)</span>
135
+ <span class='block'></span>
136
+ </span>
137
+
138
+
139
+ </th>
140
+ <td class="docstring">
141
+ <p>
142
+ Handles the case of an hash-like object with keys that are objects.
143
+ </p>
144
+
145
+
146
+ <p class='returns'>
147
+ Returns:
148
+ <span class='return_types'>
149
+ <tt>Integer</tt>
150
+ </span>
151
+ </p>
152
+
153
+ </td>
154
+ </tr>
155
+
109
156
  <tr>
110
157
  <th class="signature">
111
158
 
@@ -160,6 +207,58 @@ storage.
160
207
  </td>
161
208
  </tr>
162
209
 
210
+ <tr>
211
+ <th class="signature">
212
+
213
+ <span class='overload'>
214
+ <span class='name'><a href="#_pack_ivars-instance_method" title="#_pack_ivars">#_pack_ivars</a></span><span class='args'>(obj)</span>
215
+ <span class='block'></span>
216
+ </span>
217
+
218
+
219
+ </th>
220
+ <td class="docstring">
221
+ <p>
222
+ Packs the ivars for a given object.
223
+ </p>
224
+
225
+
226
+ <p class='returns'>
227
+ Returns:
228
+ <span class='return_types'>
229
+ <tt>Mash</tt>
230
+ </span>
231
+ </p>
232
+
233
+ </td>
234
+ </tr>
235
+
236
+ <tr>
237
+ <th class="signature">
238
+
239
+ <span class='overload'>
240
+ <span class='name'><a href="#_pack_object-instance_method" title="#_pack_object">#_pack_object</a></span><span class='args'>(obj)</span>
241
+ <span class='block'></span>
242
+ </span>
243
+
244
+
245
+ </th>
246
+ <td class="docstring">
247
+ <p>
248
+ Packs an object into data and meta data.
249
+ </p>
250
+
251
+
252
+ <p class='returns'>
253
+ Returns:
254
+ <span class='return_types'>
255
+ <tt>Mash</tt>
256
+ </span>
257
+ </p>
258
+
259
+ </td>
260
+ </tr>
261
+
163
262
  <tr>
164
263
  <th class="signature">
165
264
 
@@ -179,7 +278,7 @@ An array of instance variables that are not hidden.
179
278
  <p class='returns'>
180
279
  Returns:
181
280
  <span class='return_types'>
182
- <tt>Array</tt>
281
+ <tt><a href="../../Array.html" title="Array">Array</a></tt>
183
282
  </span>
184
283
  </p>
185
284
 
@@ -231,6 +330,83 @@ Saves object and raises an error on failure.
231
330
  <div class="section methoddetails instance public">
232
331
  <h1>Public Instance Method Details</h1>
233
332
 
333
+ <div class="method">
334
+ <div class="method_header">
335
+ <h3>_build_object_key</h3>
336
+ </div><div id="_build_object_key-instance_method" class="section method">
337
+ <div class="details_title">
338
+ <div class='section methodsignature'>
339
+ <tt class='def'>
340
+ <span class='visibility'>public</span>
341
+ <span class='return_types'><tt>Integer</tt></span>
342
+ <span class='name'>_build_object_key</span><span class='args'>(obj)</span>
343
+ <span class='block'></span>
344
+ </tt>
345
+ </div>
346
+
347
+ </div><div class="section docstring">
348
+ <p>
349
+ Handles the case of an hash-like object with keys that are objects
350
+ </p>
351
+
352
+ </div><div class="section tags">
353
+ <h2>Meta Tags</h2>
354
+ <div class="return">
355
+ <h3>Returns:</h3>
356
+ <dl>
357
+
358
+ <dt>
359
+
360
+ <span class='type'>[<tt>Integer</tt>]</span>
361
+
362
+
363
+ <span class='name'></span>
364
+
365
+
366
+ </dt>
367
+ <dd>
368
+ <span class='desc'><p>
369
+ Index of the object in the keys array, used by the hash packer to name the
370
+ key
371
+ </p>
372
+ </span>
373
+ </dd>
374
+
375
+ </dl>
376
+ </div>
377
+
378
+ </div><div class="section source">
379
+ <span>[<a class="source_link" href="#">View source</a>]</span>
380
+ <div class="source_code">
381
+ <table>
382
+ <tr>
383
+ <td>
384
+ <pre class="lines">
385
+
386
+
387
+ 142
388
+ 143
389
+ 144
390
+ 145
391
+ 146</pre>
392
+ </td>
393
+ <td>
394
+ <pre class="code"><span class="info file"># File 'lib/aqua/object/pack.rb', line 142</span>
395
+
396
+ <span class='def def kw'>def</span> <span class='_build_object_key identifier id'>_build_object_key</span><span class='lparen token'>(</span> <span class='obj identifier id'>obj</span> <span class='rparen token'>)</span>
397
+ <span class='index identifier id'>index</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='__pack identifier id'>__pack</span><span class='lbrack token'>[</span><span class='symbol val'>:keys</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='length identifier id'>length</span>
398
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='__pack identifier id'>__pack</span><span class='lbrack token'>[</span><span class='symbol val'>:keys</span><span class='rbrack token'>]</span> <span class='lshft op'>&lt;&lt;</span> <span class='_pack_object identifier id'>_pack_object</span><span class='lparen token'>(</span> <span class='obj identifier id'>obj</span> <span class='rparen token'>)</span>
399
+ <span class='index identifier id'>index</span> <span class='comment val'># return key</span>
400
+ <span class='end end kw'>end</span>
401
+ </pre>
402
+ </td>
403
+ </tr>
404
+ </table>
405
+ </div>
406
+ </div>
407
+ </div>
408
+ </div>
409
+
234
410
  <div class="method">
235
411
  <div class="method_header">
236
412
  <h3>_embed_me</h3>
@@ -259,7 +435,7 @@ embedability.
259
435
 
260
436
  <dt>
261
437
 
262
- <span class='type'>[<tt>true</tt>, <tt>false</tt>, <tt>Hash</tt>]</span>
438
+ <span class='type'>[<tt>true</tt>, <tt>false</tt>, <tt><a href="../../Hash.html" title="Hash">Hash</a></tt>]</span>
263
439
 
264
440
 
265
441
  <span class='name'></span>
@@ -288,12 +464,12 @@ externally, with a few cached methods as defined in the array.
288
464
  <pre class="lines">
289
465
 
290
466
 
291
- 83
292
467
  84
293
- 85</pre>
468
+ 85
469
+ 86</pre>
294
470
  </td>
295
471
  <td>
296
- <pre class="code"><span class="info file"># File 'lib/aqua/object/pack.rb', line 83</span>
472
+ <pre class="code"><span class="info file"># File 'lib/aqua/object/pack.rb', line 84</span>
297
473
 
298
474
  <span class='def def kw'>def</span> <span class='_embed_me identifier id'>_embed_me</span>
299
475
  <span class='self self kw'>self</span><span class='dot token'>.</span><span class='class identifier id'>class</span><span class='dot token'>.</span><span class='_aqua_opts identifier id'>_aqua_opts</span><span class='lbrack token'>[</span><span class='symbol val'>:embed</span><span class='rbrack token'>]</span>
@@ -367,7 +543,8 @@ storage.
367
543
  71
368
544
  72
369
545
  73
370
- 74</pre>
546
+ 74
547
+ 75</pre>
371
548
  </td>
372
549
  <td>
373
550
  <pre class="code"><span class="info file"># File 'lib/aqua/object/pack.rb', line 65</span>
@@ -377,8 +554,9 @@ storage.
377
554
  <span class='self self kw'>self</span><span class='dot token'>.</span><span class='__pack identifier id'>__pack</span> <span class='assign token'>=</span> <span class='Aqua constant id'>Aqua</span><span class='colon2 op'>::</span><span class='Storage constant id'>Storage</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
378
555
  <span class='self self kw'>self</span><span class='dot token'>.</span><span class='__pack identifier id'>__pack</span><span class='dot token'>.</span><span class='id identifier id'>id</span> <span class='assign token'>=</span> <span class='@id ivar id'>@id</span> <span class='if if_mod kw'>if</span> <span class='@id ivar id'>@id</span>
379
556
  <span class='self self kw'>self</span><span class='dot token'>.</span><span class='__pack identifier id'>__pack</span><span class='lbrack token'>[</span><span class='symbol val'>:_rev</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='_rev identifier id'>_rev</span> <span class='if if_mod kw'>if</span> <span class='_rev identifier id'>_rev</span>
380
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='__pack identifier id'>__pack</span><span class='lbrack token'>[</span><span class='symbol val'>:class</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='class_name identifier id'>class_name</span>
381
- <span class='_pack_properties identifier id'>_pack_properties</span>
557
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='__pack identifier id'>__pack</span><span class='lbrack token'>[</span><span class='symbol val'>:keys</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
558
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='__pack identifier id'>__pack</span><span class='lbrack token'>[</span><span class='symbol val'>:stubs</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
559
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='__pack identifier id'>__pack</span><span class='dot token'>.</span><span class='merge! fid id'>merge!</span><span class='lparen token'>(</span> <span class='_pack_object identifier id'>_pack_object</span><span class='lparen token'>(</span> <span class='self self kw'>self</span> <span class='rparen token'>)</span> <span class='rparen token'>)</span>
382
560
  <span class='_pack_singletons identifier id'>_pack_singletons</span>
383
561
  <span class='__pack identifier id'>__pack</span>
384
562
  <span class='end end kw'>end</span>
@@ -391,6 +569,190 @@ storage.
391
569
  </div>
392
570
  </div>
393
571
 
572
+ <div class="method">
573
+ <div class="method_header">
574
+ <h3>_pack_ivars</h3>
575
+ </div><div id="_pack_ivars-instance_method" class="section method">
576
+ <div class="details_title">
577
+ <div class='section methodsignature'>
578
+ <tt class='def'>
579
+ <span class='visibility'>public</span>
580
+ <span class='return_types'><tt>Mash</tt></span>
581
+ <span class='name'>_pack_ivars</span><span class='args'>(obj)</span>
582
+ <span class='block'></span>
583
+ </tt>
584
+ </div>
585
+
586
+ </div><div class="section docstring">
587
+ <p>
588
+ Packs the ivars for a given object.
589
+ </p>
590
+
591
+ </div><div class="section tags">
592
+ <h2>Meta Tags</h2>
593
+ <div class="return">
594
+ <h3>Returns:</h3>
595
+ <dl>
596
+
597
+ <dt>
598
+
599
+ <span class='type'>[<tt>Mash</tt>]</span>
600
+
601
+
602
+ <span class='name'></span>
603
+
604
+
605
+ </dt>
606
+ <dd>
607
+ <span class='desc'><p>
608
+ Indifferent hash that is the data/metadata deconstruction of an object.
609
+ </p>
610
+ </span>
611
+ </dd>
612
+
613
+ </dl>
614
+ </div>
615
+
616
+ </div><div class="section source">
617
+ <span>[<a class="source_link" href="#">View source</a>]</span>
618
+ <div class="source_code">
619
+ <table>
620
+ <tr>
621
+ <td>
622
+ <pre class="lines">
623
+
624
+
625
+ 126
626
+ 127
627
+ 128
628
+ 129
629
+ 130
630
+ 131
631
+ 132
632
+ 133
633
+ 134</pre>
634
+ </td>
635
+ <td>
636
+ <pre class="code"><span class="info file"># File 'lib/aqua/object/pack.rb', line 126</span>
637
+
638
+ <span class='def def kw'>def</span> <span class='_pack_ivars identifier id'>_pack_ivars</span><span class='lparen token'>(</span> <span class='obj identifier id'>obj</span> <span class='rparen token'>)</span>
639
+ <span class='return_hash identifier id'>return_hash</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
640
+ <span class='vars identifier id'>vars</span> <span class='assign token'>=</span> <span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='aquatic? fid id'>aquatic?</span> <span class='integer val'>? </span><span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='_storable_attributes identifier id'>_storable_attributes</span> <span class='colon op'>:</span> <span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='instance_variables identifier id'>instance_variables</span>
641
+ <span class='vars identifier id'>vars</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='ivar_name identifier id'>ivar_name</span><span class='bitor op'>|</span>
642
+ <span class='ivar identifier id'>ivar</span> <span class='assign token'>=</span> <span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='instance_variable_get identifier id'>instance_variable_get</span><span class='lparen token'>(</span> <span class='ivar_name identifier id'>ivar_name</span> <span class='rparen token'>)</span>
643
+ <span class='return_hash identifier id'>return_hash</span><span class='lbrack token'>[</span><span class='ivar_name identifier id'>ivar_name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='_pack_object identifier id'>_pack_object</span><span class='lparen token'>(</span> <span class='ivar identifier id'>ivar</span> <span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='ivar identifier id'>ivar</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
644
+ <span class='end end kw'>end</span>
645
+ <span class='return_hash identifier id'>return_hash</span>
646
+ <span class='end end kw'>end</span>
647
+ </pre>
648
+ </td>
649
+ </tr>
650
+ </table>
651
+ </div>
652
+ </div>
653
+ </div>
654
+ </div>
655
+
656
+ <div class="method">
657
+ <div class="method_header">
658
+ <h3>_pack_object</h3>
659
+ </div><div id="_pack_object-instance_method" class="section method">
660
+ <div class="details_title">
661
+ <div class='section methodsignature'>
662
+ <tt class='def'>
663
+ <span class='visibility'>public</span>
664
+ <span class='return_types'><tt>Mash</tt></span>
665
+ <span class='name'>_pack_object</span><span class='args'>(obj)</span>
666
+ <span class='block'></span>
667
+ </tt>
668
+ </div>
669
+
670
+ </div><div class="section docstring">
671
+ <p>
672
+ Packs an object into data and meta data. Works recursively sending out to
673
+ array, hash, etc. object packers, which send their values back to
674
+ _pack_object
675
+ </p>
676
+
677
+ </div><div class="section tags">
678
+ <h2>Meta Tags</h2>
679
+ <div class="return">
680
+ <h3>Returns:</h3>
681
+ <dl>
682
+
683
+ <dt>
684
+
685
+ <span class='type'>[<tt>Mash</tt>]</span>
686
+
687
+
688
+ <span class='name'></span>
689
+
690
+
691
+ </dt>
692
+ <dd>
693
+ <span class='desc'><p>
694
+ Indifferent hash that is the data/metadata deconstruction of an object.
695
+ </p>
696
+ </span>
697
+ </dd>
698
+
699
+ </dl>
700
+ </div>
701
+
702
+ </div><div class="section source">
703
+ <span>[<a class="source_link" href="#">View source</a>]</span>
704
+ <div class="source_code">
705
+ <table>
706
+ <tr>
707
+ <td>
708
+ <pre class="lines">
709
+
710
+
711
+ 103
712
+ 104
713
+ 105
714
+ 106
715
+ 107
716
+ 108
717
+ 109
718
+ 110
719
+ 111
720
+ 112
721
+ 113
722
+ 114
723
+ 115
724
+ 116
725
+ 117
726
+ 118</pre>
727
+ </td>
728
+ <td>
729
+ <pre class="code"><span class="info file"># File 'lib/aqua/object/pack.rb', line 103</span>
730
+
731
+ <span class='def def kw'>def</span> <span class='_pack_object identifier id'>_pack_object</span><span class='lparen token'>(</span> <span class='obj identifier id'>obj</span> <span class='rparen token'>)</span>
732
+ <span class='klass identifier id'>klass</span> <span class='assign token'>=</span> <span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='class identifier id'>class</span>
733
+ <span class='if if kw'>if</span> <span class='klass identifier id'>klass</span> <span class='eq op'>==</span> <span class='String constant id'>String</span>
734
+ <span class='obj identifier id'>obj</span>
735
+ <span class='elsif elsif kw'>elsif</span> <span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:to_aqua</span><span class='rparen token'>)</span> <span class='comment val'># Types requiring initialization</span>
736
+ <span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='to_aqua identifier id'>to_aqua</span><span class='lparen token'>(</span> <span class='self self kw'>self</span> <span class='rparen token'>)</span>
737
+ <span class='elsif elsif kw'>elsif</span> <span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='aquatic? fid id'>aquatic?</span> <span class='andop op'>&amp;&amp;</span> <span class='obj identifier id'>obj</span> <span class='neq op'>!=</span> <span class='self self kw'>self</span>
738
+ <span class='if if kw'>if</span> <span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='_embed_me identifier id'>_embed_me</span> <span class='eq op'>==</span> <span class='true true kw'>true</span>
739
+ <span class='obj identifier id'>obj</span><span class='dot token'>.</span><span class='_pack identifier id'>_pack</span>
740
+ <span class='else else kw'>else</span>
741
+ <span class='_build_stub identifier id'>_build_stub</span><span class='lparen token'>(</span> <span class='obj identifier id'>obj</span> <span class='rparen token'>)</span>
742
+ <span class='end end kw'>end</span>
743
+ <span class='else else kw'>else</span> <span class='comment val'># other object without initializations</span>
744
+ <span class='_pack_vanilla identifier id'>_pack_vanilla</span><span class='lparen token'>(</span> <span class='obj identifier id'>obj</span> <span class='rparen token'>)</span>
745
+ <span class='end end kw'>end</span>
746
+ <span class='end end kw'>end</span>
747
+ </pre>
748
+ </td>
749
+ </tr>
750
+ </table>
751
+ </div>
752
+ </div>
753
+ </div>
754
+ </div>
755
+
394
756
  <div class="method">
395
757
  <div class="method_header">
396
758
  <h3>_storable_attributes</h3>
@@ -399,7 +761,7 @@ storage.
399
761
  <div class='section methodsignature'>
400
762
  <tt class='def'>
401
763
  <span class='visibility'>public</span>
402
- <span class='return_types'><tt>Array</tt></span>
764
+ <span class='return_types'><tt><a href="../../Array.html" title="Array">Array</a></tt></span>
403
765
  <span class='name'>_storable_attributes</span><span class='args'></span>
404
766
  <span class='block'></span>
405
767
  </tt>
@@ -418,7 +780,7 @@ An array of instance variables that are not hidden.
418
780
 
419
781
  <dt>
420
782
 
421
- <span class='type'>[<tt>Array</tt>]</span>
783
+ <span class='type'>[<tt><a href="../../Array.html" title="Array">Array</a></tt>]</span>
422
784
 
423
785
 
424
786
  <span class='name'></span>
@@ -444,12 +806,12 @@ of names for instance variables
444
806
  <pre class="lines">
445
807
 
446
808
 
447
- 91
448
809
  92
449
- 93</pre>
810
+ 93
811
+ 94</pre>
450
812
  </td>
451
813
  <td>
452
- <pre class="code"><span class="info file"># File 'lib/aqua/object/pack.rb', line 91</span>
814
+ <pre class="code"><span class="info file"># File 'lib/aqua/object/pack.rb', line 92</span>
453
815
 
454
816
  <span class='def def kw'>def</span> <span class='_storable_attributes identifier id'>_storable_attributes</span>
455
817
  <span class='lparen token'>(</span><span class='instance_variables identifier id'>instance_variables</span><span class='orop op'>||</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='minus op'>-</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='class identifier id'>class</span><span class='dot token'>.</span><span class='_hidden_attributes identifier id'>_hidden_attributes</span>
@@ -564,7 +926,7 @@ Saves object and raises an error on failure
564
926
  </div>
565
927
  </div>
566
928
  <div id="yard_info">
567
- Generated on Friday, August 21 2009 at 12:48:47 PM by
929
+ Generated on Thursday, August 27 2009 at 05:50:22 PM by
568
930
  <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr>
569
931
  0.2.3.5 (ruby-1.8.6).
570
932
  </div>