hyper-resource 1.0.0.lap79 → 1.0.0.lap80
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.
- checksums.yaml +4 -4
- data/.gitignore +3 -0
- data/.yardopts +1 -0
- data/API.md +62 -0
- data/Gemfile +2 -0
- data/JSON_format.md +62 -0
- data/PubSub.md +20 -0
- data/README.md +2 -0
- data/Security.md +0 -0
- data/docs/HyperRecord/ClassMethods.html +2969 -0
- data/docs/HyperRecord/ClientInstanceMethods.html +1833 -0
- data/docs/HyperRecord/Collection.html +564 -0
- data/docs/HyperRecord/DummyValue.html +384 -0
- data/docs/HyperRecord/PubSub/ClassMethods.html +2047 -0
- data/docs/HyperRecord/PubSub.html +1679 -0
- data/docs/HyperRecord/ServerClassMethods.html +697 -0
- data/docs/HyperRecord.html +119 -0
- data/docs/Hyperloop/Resource/ClientDrivers.html +352 -0
- data/docs/Hyperloop/Resource/HTTP.html +1795 -0
- data/docs/Hyperloop/Resource/MethodsController.html +479 -0
- data/docs/Hyperloop/Resource/PropertiesController.html +225 -0
- data/docs/Hyperloop/Resource/PubSub/ClassMethods.html +105 -0
- data/docs/Hyperloop/Resource/PubSub.html +1210 -0
- data/docs/Hyperloop/Resource/RelationsController.html +529 -0
- data/docs/Hyperloop/Resource/ScopesController.html +380 -0
- data/docs/Hyperloop/Resource/SecurityError.html +124 -0
- data/docs/Hyperloop/Resource/SecurityGuards/ClassMethods.html +226 -0
- data/docs/Hyperloop/Resource/SecurityGuards.html +299 -0
- data/docs/Hyperloop/Resource.html +135 -0
- data/docs/Hyperloop.html +186 -0
- data/docs/_index.html +302 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.API.html +138 -0
- data/docs/file.JSON_format.html +134 -0
- data/docs/file.PubSub.html +86 -0
- data/docs/file.README.html +192 -0
- data/docs/file_list.html +71 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +192 -0
- data/docs/js/app.js +292 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1115 -0
- data/docs/top-level-namespace.html +110 -0
- data/hyper-resource.gemspec +19 -18
- data/lib/hyper_record/class_methods.rb +186 -3
- data/lib/hyper_record/client_instance_methods.rb +68 -3
- data/lib/hyper_record/collection.rb +19 -4
- data/lib/hyper_record/pub_sub.rb +92 -12
- data/lib/hyper_record/server_class_methods.rb +15 -0
- data/lib/hyperloop/resource/client_drivers.rb +2 -0
- data/lib/hyperloop/resource/http.rb +33 -22
- data/lib/hyperloop/resource/pub_sub.rb +2 -0
- data/lib/hyperloop/resource/version.rb +1 -1
- metadata +61 -2
data/docs/index.html
ADDED
|
@@ -0,0 +1,192 @@
|
|
|
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
|
+
— Documentation by YARD 0.9.13
|
|
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="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index</a> »
|
|
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-hyper-resource">hyper-resource</h1>
|
|
62
|
+
|
|
63
|
+
<p><a href="https://github.com/janbiedermann/hyper-resource">Github Repo</a></p>
|
|
64
|
+
|
|
65
|
+
<p>HyperResource is an affective way of moving data between your server and
|
|
66
|
+
clients when using Hyperloop and Rails.</p>
|
|
67
|
+
|
|
68
|
+
<p><a href="http://www.youtube.com/watch?v=fPSpESBbeMQ"><img
|
|
69
|
+
src="http://img.youtube.com/vi/fPSpESBbeMQ/0.jpg"></a></p>
|
|
70
|
+
|
|
71
|
+
<h2 id="label-Motivation">Motivation</h2>
|
|
72
|
+
<ul><li>
|
|
73
|
+
<p>To co-exist with a resource based REST API</p>
|
|
74
|
+
</li><li>
|
|
75
|
+
<p>To have ActiveRecord type Models shared by both the client and server code</p>
|
|
76
|
+
</li><li>
|
|
77
|
+
<p>To be ORM/database agnostic (tested with ActiveRecord on Postgres and
|
|
78
|
+
Neo4j.rb on Neo4j)</p>
|
|
79
|
+
</li><li>
|
|
80
|
+
<p>To fit the 'Rails way' as far as possible (under the covers,
|
|
81
|
+
HyperResource is a traditional REST API)</p>
|
|
82
|
+
</li><li>
|
|
83
|
+
<p>To keep all Policy checking and authorisation logic in the Rails
|
|
84
|
+
Controllers</p>
|
|
85
|
+
</li><li>
|
|
86
|
+
<p>To allow a stages implementation</p>
|
|
87
|
+
</li></ul>
|
|
88
|
+
|
|
89
|
+
<h2 id="label-Staged+implementation">Staged implementation</h2>
|
|
90
|
+
|
|
91
|
+
<p>HyperResource is designed to be implemented in stages and each stage
|
|
92
|
+
delivers value in its own right, so the developer only needs to go as far
|
|
93
|
+
as they like.</p>
|
|
94
|
+
|
|
95
|
+
<p>A record can be of any ORM but the ORM must implement: “`ruby
|
|
96
|
+
record_class.find(id) # to get a record record.id # a identifier
|
|
97
|
+
record.updated_at # a time stamp record.destroyed? # to identify if its
|
|
98
|
+
scheduled for destruction</p>
|
|
99
|
+
|
|
100
|
+
<h1 id="label-when+using+relations+controller">when using relations controller</h1>
|
|
101
|
+
|
|
102
|
+
<p>record.touch # to update updated_at, identicating that something about that
|
|
103
|
+
record changed # for example it has been added to a relation “`</p>
|
|
104
|
+
|
|
105
|
+
<h3 id="label-Stage+1+-+Wrap+a+REST+API+with+Ruby+classes+to+represent+Models">Stage 1 - Wrap a REST API with Ruby classes to represent Models</h3>
|
|
106
|
+
|
|
107
|
+
<p>The simplest implementation of HyperResource is a client side only wrapper
|
|
108
|
+
of an existing REST API which treats each REST Resource as a Ruby class.</p>
|
|
109
|
+
|
|
110
|
+
<pre class="code ruby"><code class="ruby"><span class='comment'># in your client-cide code
|
|
111
|
+
</span><span class='kw'>class</span> <span class='const'>Customer</span>
|
|
112
|
+
<span class='id identifier rubyid_include'>include</span> <span class='const'>ApplicationHyperRecord</span>
|
|
113
|
+
<span class='kw'>end</span>
|
|
114
|
+
|
|
115
|
+
<span class='comment'># then work with the Customer class as if it were an ActiveRecord
|
|
116
|
+
</span><span class='id identifier rubyid_customer'>customer</span> <span class='op'>=</span> <span class='const'>Customer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>John Smith</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
117
|
+
<span class='id identifier rubyid_customer'>customer</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># ---> POST api/customer.json ... {name: 'John Smith' }
|
|
118
|
+
</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_customer'>customer</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='comment'># 123
|
|
119
|
+
</span>
|
|
120
|
+
<span class='comment'># to find a record
|
|
121
|
+
</span><span class='id identifier rubyid_customer'>customer</span> <span class='op'>=</span> <span class='const'>Customer</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='int'>123</span><span class='rparen'>)</span> <span class='comment'># ---> GET api/customer/123.json
|
|
122
|
+
</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_customer'>customer</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='comment'># `John Smith`
|
|
123
|
+
</span></code></pre>
|
|
124
|
+
|
|
125
|
+
<h3 id="label-Stage+2+-+Adapt+your+Models+so+the+client+and+server+code+share+the+same+Models">Stage 2 - Adapt your Models so the client and server code share the same Models</h3>
|
|
126
|
+
|
|
127
|
+
<p>HyperResource supports ActiveRecord associations and scopes so you can DRY
|
|
128
|
+
up your code and the client an server can share the same Models.</p>
|
|
129
|
+
|
|
130
|
+
<pre class="code ruby"><code class="ruby"><span class='kw'>module</span> <span class='const'>ApplicationHyperRecord</span>
|
|
131
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
|
|
132
|
+
<span class='kw'>if</span> <span class='const'>RUBY_ENGINE</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>opal</span><span class='tstring_end'>'</span></span>
|
|
133
|
+
<span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="HyperRecord.html" title="HyperRecord (module)">HyperRecord</a></span></span><span class='rparen'>)</span>
|
|
134
|
+
<span class='kw'>else</span>
|
|
135
|
+
<span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_extend'>extend</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="HyperRecord.html" title="HyperRecord (module)">HyperRecord</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HyperRecord/ServerClassMethods.html" title="HyperRecord::ServerClassMethods (module)">ServerClassMethods</a></span></span><span class='rparen'>)</span>
|
|
136
|
+
<span class='kw'>end</span>
|
|
137
|
+
<span class='kw'>end</span>
|
|
138
|
+
<span class='kw'>end</span>
|
|
139
|
+
|
|
140
|
+
<span class='kw'>class</span> <span class='const'>Customer</span>
|
|
141
|
+
<span class='id identifier rubyid_include'>include</span> <span class='const'>ApplicationHyperRecord</span>
|
|
142
|
+
<span class='id identifier rubyid_has_many'>has_many</span> <span class='symbol'>:addresses</span>
|
|
143
|
+
|
|
144
|
+
<span class='kw'>unless</span> <span class='const'>RUBY_ENGINE</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>opal</span><span class='tstring_end'>'</span></span>
|
|
145
|
+
<span class='comment'># methods which should only exist on the server
|
|
146
|
+
</span> <span class='kw'>end</span>
|
|
147
|
+
<span class='kw'>end</span>
|
|
148
|
+
|
|
149
|
+
<span class='id identifier rubyid_customer'>customer</span> <span class='op'>=</span> <span class='const'>Customer</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='int'>123</span><span class='rparen'>)</span> <span class='comment'># ---> GET api/customer/123.json
|
|
150
|
+
</span><span class='id identifier rubyid_customer'>customer</span><span class='period'>.</span><span class='id identifier rubyid_addresses'>addresses</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_address'>address</span><span class='op'>|</span>
|
|
151
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_address'>address</span><span class='period'>.</span><span class='id identifier rubyid_post_code'>post_code</span>
|
|
152
|
+
<span class='kw'>end</span>
|
|
153
|
+
</code></pre>
|
|
154
|
+
|
|
155
|
+
<h3 id="label-Stage+3+-+Implement+a+Redis+based+pub-sub+mechanism+so+the+client+code+is+notified+when+the+server+data+changes">Stage 3 - Implement a Redis based pub-sub mechanism so the client code is notified when the server data changes</h3>
|
|
156
|
+
|
|
157
|
+
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>ApplicationController</span>
|
|
158
|
+
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="Hyperloop.html" title="Hyperloop (module)">Hyperloop</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyperloop/Resource.html" title="Hyperloop::Resource (module)">Resource</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyperloop/Resource/PubSub.html" title="Hyperloop::Resource::PubSub (module)">PubSub</a></span></span>
|
|
159
|
+
|
|
160
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_my_action'>my_action</span>
|
|
161
|
+
<span class='comment'># available methods for pubsub
|
|
162
|
+
</span> <span class='id identifier rubyid_publish_collection'>publish_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_base_record'>base_record</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_name'>collection_name</span><span class='comma'>,</span> <span class='id identifier rubyid_record'>record</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
163
|
+
<span class='id identifier rubyid_publish_record'>publish_record</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='rparen'>)</span>
|
|
164
|
+
<span class='id identifier rubyid_publish_scope'>publish_scope</span><span class='lparen'>(</span><span class='id identifier rubyid_record_class'>record_class</span><span class='comma'>,</span> <span class='id identifier rubyid_scope_name'>scope_name</span><span class='rparen'>)</span>
|
|
165
|
+
|
|
166
|
+
<span class='id identifier rubyid_subscribe_collection'>subscribe_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='comma'>,</span> <span class='id identifier rubyid_base_record'>base_record</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_name'>collection_name</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
167
|
+
<span class='id identifier rubyid_subscribe_record'>subscribe_record</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='rparen'>)</span>
|
|
168
|
+
<span class='id identifier rubyid_subscribe_scope'>subscribe_scope</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='comma'>,</span> <span class='id identifier rubyid_record_class'>record_class</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_scope_name'>scope_name</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
169
|
+
|
|
170
|
+
<span class='id identifier rubyid_pub_sub_collection'>pub_sub_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='comma'>,</span> <span class='id identifier rubyid_base_record'>base_record</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_name'>collection_name</span><span class='comma'>,</span> <span class='id identifier rubyid_causing_record'>causing_record</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
171
|
+
<span class='id identifier rubyid_pub_sub_record'>pub_sub_record</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='rparen'>)</span>
|
|
172
|
+
<span class='id identifier rubyid_pub_sub_scope'>pub_sub_scope</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='comma'>,</span> <span class='id identifier rubyid_record_class'>record_class</span><span class='comma'>,</span> <span class='id identifier rubyid_scope_name'>scope_name</span><span class='rparen'>)</span>
|
|
173
|
+
<span class='kw'>end</span>
|
|
174
|
+
<span class='kw'>end</span>
|
|
175
|
+
</code></pre>
|
|
176
|
+
|
|
177
|
+
<p>EXAMPLE</p>
|
|
178
|
+
|
|
179
|
+
<h2 id="label-Implementation">Implementation</h2>
|
|
180
|
+
|
|
181
|
+
<p>How to install.…</p>
|
|
182
|
+
</div></div>
|
|
183
|
+
|
|
184
|
+
<div id="footer">
|
|
185
|
+
Generated on Tue Jun 5 23:13:51 2018 by
|
|
186
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
187
|
+
0.9.13 (ruby-2.5.1).
|
|
188
|
+
</div>
|
|
189
|
+
|
|
190
|
+
</div>
|
|
191
|
+
</body>
|
|
192
|
+
</html>
|
data/docs/js/app.js
ADDED
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
(function() {
|
|
2
|
+
|
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
|
6
|
+
|
|
7
|
+
function createSourceLinks() {
|
|
8
|
+
$('.method_details_list .source_code').
|
|
9
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
10
|
+
$('.toggleSource').toggle(function() {
|
|
11
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
12
|
+
$(this).text("Hide source");
|
|
13
|
+
},
|
|
14
|
+
function() {
|
|
15
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
16
|
+
$(this).text("View source");
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
function createDefineLinks() {
|
|
21
|
+
var tHeight = 0;
|
|
22
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
23
|
+
$('.toggleDefines').toggle(function() {
|
|
24
|
+
tHeight = $(this).parent().prev().height();
|
|
25
|
+
$(this).prev().css('display', 'inline');
|
|
26
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
27
|
+
$(this).text("(less)");
|
|
28
|
+
},
|
|
29
|
+
function() {
|
|
30
|
+
$(this).prev().hide();
|
|
31
|
+
$(this).parent().prev().height(tHeight);
|
|
32
|
+
$(this).text("more...");
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function createFullTreeLinks() {
|
|
37
|
+
var tHeight = 0;
|
|
38
|
+
$('.inheritanceTree').toggle(function() {
|
|
39
|
+
tHeight = $(this).parent().prev().height();
|
|
40
|
+
$(this).parent().toggleClass('showAll');
|
|
41
|
+
$(this).text("(hide)");
|
|
42
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
43
|
+
},
|
|
44
|
+
function() {
|
|
45
|
+
$(this).parent().toggleClass('showAll');
|
|
46
|
+
$(this).parent().prev().height(tHeight);
|
|
47
|
+
$(this).text("show all");
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameButtons() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
window.addEventListener('message', function(e) {
|
|
57
|
+
if (e.data === 'navEscape') {
|
|
58
|
+
$('#nav').slideUp(100);
|
|
59
|
+
$('#search a').removeClass('active inactive');
|
|
60
|
+
$(window).focus();
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
$(window).resize(function() {
|
|
65
|
+
if ($('#search:visible').length === 0) {
|
|
66
|
+
$('#nav').removeAttr('style');
|
|
67
|
+
$('#search a').removeClass('active inactive');
|
|
68
|
+
$(window).focus();
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function toggleSearchFrame(id, link) {
|
|
74
|
+
var frame = $('#nav');
|
|
75
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
|
77
|
+
frame.slideUp(100);
|
|
78
|
+
$('#search a').removeClass('active inactive');
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
$(id).addClass('active').removeClass('inactive');
|
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
|
83
|
+
frame.slideDown(100);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
function linkSummaries() {
|
|
88
|
+
$('.summary_signature').click(function() {
|
|
89
|
+
document.location = $(this).find('a').attr('href');
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function summaryToggle() {
|
|
94
|
+
$('.summary_toggle').click(function(e) {
|
|
95
|
+
e.preventDefault();
|
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
97
|
+
$('.summary_toggle').each(function() {
|
|
98
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
99
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
100
|
+
if (next.hasClass('compact')) {
|
|
101
|
+
next.toggle();
|
|
102
|
+
next.nextAll('ul.summary').first().toggle();
|
|
103
|
+
}
|
|
104
|
+
else if (next.hasClass('summary')) {
|
|
105
|
+
var list = $('<ul class="summary compact" />');
|
|
106
|
+
list.html(next.html());
|
|
107
|
+
list.find('.summary_desc, .note').remove();
|
|
108
|
+
list.find('a').each(function() {
|
|
109
|
+
$(this).html($(this).find('strong').html());
|
|
110
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
111
|
+
});
|
|
112
|
+
next.before(list);
|
|
113
|
+
next.toggle();
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
return false;
|
|
117
|
+
});
|
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
119
|
+
$('.summary_toggle').first().click();
|
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function constantSummaryToggle() {
|
|
124
|
+
$('.constants_summary_toggle').click(function(e) {
|
|
125
|
+
e.preventDefault();
|
|
126
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
127
|
+
$('.constants_summary_toggle').each(function() {
|
|
128
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
129
|
+
var next = $(this).parent().parent().nextAll('dl.constants').first();
|
|
130
|
+
if (next.hasClass('compact')) {
|
|
131
|
+
next.toggle();
|
|
132
|
+
next.nextAll('dl.constants').first().toggle();
|
|
133
|
+
}
|
|
134
|
+
else if (next.hasClass('constants')) {
|
|
135
|
+
var list = $('<dl class="constants compact" />');
|
|
136
|
+
list.html(next.html());
|
|
137
|
+
list.find('dt').each(function() {
|
|
138
|
+
$(this).addClass('summary_signature');
|
|
139
|
+
$(this).text( $(this).text().split('=')[0]);
|
|
140
|
+
if ($(this).has(".deprecated").length) {
|
|
141
|
+
$(this).addClass('deprecated');
|
|
142
|
+
};
|
|
143
|
+
});
|
|
144
|
+
// Add the value of the constant as "Tooltip" to the summary object
|
|
145
|
+
list.find('pre.code').each(function() {
|
|
146
|
+
console.log($(this).parent());
|
|
147
|
+
var dt_element = $(this).parent().prev();
|
|
148
|
+
var tooltip = $(this).text();
|
|
149
|
+
if (dt_element.hasClass("deprecated")) {
|
|
150
|
+
tooltip = 'Deprecated. ' + tooltip;
|
|
151
|
+
};
|
|
152
|
+
dt_element.attr('title', tooltip);
|
|
153
|
+
});
|
|
154
|
+
list.find('.docstring, .tags, dd').remove();
|
|
155
|
+
next.before(list);
|
|
156
|
+
next.toggle();
|
|
157
|
+
}
|
|
158
|
+
});
|
|
159
|
+
return false;
|
|
160
|
+
});
|
|
161
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
162
|
+
$('.constants_summary_toggle').first().click();
|
|
163
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
function generateTOC() {
|
|
167
|
+
if ($('#filecontents').length === 0) return;
|
|
168
|
+
var _toc = $('<ol class="top"></ol>');
|
|
169
|
+
var show = false;
|
|
170
|
+
var toc = _toc;
|
|
171
|
+
var counter = 0;
|
|
172
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
173
|
+
var i;
|
|
174
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
175
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
176
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
177
|
+
$(tags.join(', ')).each(function() {
|
|
178
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
179
|
+
if (this.id == "filecontents") return;
|
|
180
|
+
show = true;
|
|
181
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
182
|
+
if (this.id.length === 0) {
|
|
183
|
+
var proposedId = $(this).attr('toc-id');
|
|
184
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
185
|
+
else {
|
|
186
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
187
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
188
|
+
this.id = proposedId;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
if (thisTag > lastTag) {
|
|
192
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
193
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
if (thisTag < lastTag) {
|
|
197
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
198
|
+
}
|
|
199
|
+
var title = $(this).attr('toc-title');
|
|
200
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
201
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
202
|
+
lastTag = thisTag;
|
|
203
|
+
});
|
|
204
|
+
if (!show) return;
|
|
205
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
|
206
|
+
$('#content').prepend(html);
|
|
207
|
+
$('#toc').append(_toc);
|
|
208
|
+
$('#toc .hide_toc').toggle(function() {
|
|
209
|
+
$('#toc .top').slideUp('fast');
|
|
210
|
+
$('#toc').toggleClass('hidden');
|
|
211
|
+
$('#toc .title small').toggle();
|
|
212
|
+
}, function() {
|
|
213
|
+
$('#toc .top').slideDown('fast');
|
|
214
|
+
$('#toc').toggleClass('hidden');
|
|
215
|
+
$('#toc .title small').toggle();
|
|
216
|
+
});
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
function navResizeFn(e) {
|
|
220
|
+
if (e.which !== 1) {
|
|
221
|
+
navResizeFnStop();
|
|
222
|
+
return;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
sessionStorage.navWidth = e.pageX.toString();
|
|
226
|
+
$('.nav_wrap').css('width', e.pageX);
|
|
227
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
function navResizeFnStop() {
|
|
231
|
+
$(window).unbind('mousemove', navResizeFn);
|
|
232
|
+
window.removeEventListener('message', navMessageFn, false);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
function navMessageFn(e) {
|
|
236
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
|
237
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
function navResizer() {
|
|
241
|
+
$('#resizer').mousedown(function(e) {
|
|
242
|
+
e.preventDefault();
|
|
243
|
+
$(window).mousemove(navResizeFn);
|
|
244
|
+
window.addEventListener('message', navMessageFn, false);
|
|
245
|
+
});
|
|
246
|
+
$(window).mouseup(navResizeFnStop);
|
|
247
|
+
|
|
248
|
+
if (sessionStorage.navWidth) {
|
|
249
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
function navExpander() {
|
|
254
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
|
255
|
+
function postMessage() {
|
|
256
|
+
if (done) return;
|
|
257
|
+
clearTimeout(timer);
|
|
258
|
+
var opts = { action: 'expand', path: pathId };
|
|
259
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
|
260
|
+
done = true;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
window.addEventListener('message', function(event) {
|
|
264
|
+
if (event.data === 'navReady') postMessage();
|
|
265
|
+
return false;
|
|
266
|
+
}, false);
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
function mainFocus() {
|
|
270
|
+
var hash = window.location.hash;
|
|
271
|
+
if (hash !== '' && $(hash)[0]) {
|
|
272
|
+
$(hash)[0].scrollIntoView();
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
$(document).ready(function() {
|
|
279
|
+
navResizer();
|
|
280
|
+
navExpander();
|
|
281
|
+
createSourceLinks();
|
|
282
|
+
createDefineLinks();
|
|
283
|
+
createFullTreeLinks();
|
|
284
|
+
searchFrameButtons();
|
|
285
|
+
linkSummaries();
|
|
286
|
+
summaryToggle();
|
|
287
|
+
constantSummaryToggle();
|
|
288
|
+
generateTOC();
|
|
289
|
+
mainFocus();
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
})();
|