outboxer 0.1.2 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/outboxer/version.rb +1 -1
- data/outboxer.gemspec +2 -2
- metadata +3 -25
- data/doc/Outboxer/Models/Exception.html +0 -124
- data/doc/Outboxer/Models/Message.html +0 -144
- data/doc/Outboxer/Models/Outboxable/ClassMethods.html +0 -105
- data/doc/Outboxer/Models/Outboxable.html +0 -265
- data/doc/Outboxer/Models.html +0 -119
- data/doc/Outboxer/Publisher/Args.html +0 -310
- data/doc/Outboxer/Publisher.html +0 -384
- data/doc/Outboxer/Railtie.html +0 -124
- data/doc/Outboxer.html +0 -150
- data/doc/_index.html +0 -211
- data/doc/class_list.html +0 -51
- data/doc/css/common.css +0 -1
- data/doc/css/full_list.css +0 -58
- data/doc/css/style.css +0 -497
- data/doc/file.README.html +0 -180
- data/doc/file_list.html +0 -56
- data/doc/frames.html +0 -17
- data/doc/index.html +0 -180
- data/doc/js/app.js +0 -314
- data/doc/js/full_list.js +0 -216
- data/doc/js/jquery.js +0 -4
- data/doc/method_list.html +0 -99
- data/doc/top-level-namespace.html +0 -110
data/doc/file_list.html
DELETED
|
@@ -1,56 +0,0 @@
|
|
|
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" />
|
|
8
|
-
|
|
9
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
|
|
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
|
-
|
|
53
|
-
</ul>
|
|
54
|
-
</div>
|
|
55
|
-
</body>
|
|
56
|
-
</html>
|
data/doc/frames.html
DELETED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html>
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<title>Documentation by YARD 0.9.34</title>
|
|
6
|
-
</head>
|
|
7
|
-
<script type="text/javascript">
|
|
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>
|
data/doc/index.html
DELETED
|
@@ -1,180 +0,0 @@
|
|
|
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.34
|
|
10
|
-
|
|
11
|
-
</title>
|
|
12
|
-
|
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
|
14
|
-
|
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
|
16
|
-
|
|
17
|
-
<script type="text/javascript">
|
|
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-Outboxer">Outboxer</h1>
|
|
62
|
-
|
|
63
|
-
<h2 id="label-Background">Background</h2>
|
|
64
|
-
|
|
65
|
-
<p>Typically in event driven Ruby on Rails applications:</p>
|
|
66
|
-
<ol><li>
|
|
67
|
-
<p>a domain event model is created in an SQL database table</p>
|
|
68
|
-
</li><li>
|
|
69
|
-
<p>a sidekiq worker is queued to handle the domain event asynchronously</p>
|
|
70
|
-
</li></ol>
|
|
71
|
-
|
|
72
|
-
<h2 id="label-Problem">Problem</h2>
|
|
73
|
-
|
|
74
|
-
<p>As these two operations span multiple database types (SQL and redis), they can not be combined into a single atomic operation using a transaction. If either step fails, inconsistencies can occur.</p>
|
|
75
|
-
|
|
76
|
-
<h2 id="label-Solution">Solution</h2>
|
|
77
|
-
|
|
78
|
-
<p>Outboxer is a simple Ruby on Rails implementation of the <a href="https://microservices.io/patterns/data/transactional-outbox.html">transactional outbox pattern</a>: a well established solution to this problem. It ensures both operations succeed <em>eventually</em>, or both fail.</p>
|
|
79
|
-
|
|
80
|
-
<h3 id="label-Getting+started">Getting started</h3>
|
|
81
|
-
|
|
82
|
-
<h3 id="label-Installation">Installation</h3>
|
|
83
|
-
<ol><li>
|
|
84
|
-
<p>Add the Outboxer gem to your application's Gemfile:</p>
|
|
85
|
-
</li></ol>
|
|
86
|
-
|
|
87
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>outboxer</span><span class='tstring_end'>'</span></span>
|
|
88
|
-
</code></pre>
|
|
89
|
-
<ol><li>
|
|
90
|
-
<p>Install the Outboxer gem:</p>
|
|
91
|
-
</li></ol>
|
|
92
|
-
|
|
93
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_install'>install</span>
|
|
94
|
-
</code></pre>
|
|
95
|
-
<ol><li>
|
|
96
|
-
<p>Generate the migration and publisher files</p>
|
|
97
|
-
</li></ol>
|
|
98
|
-
|
|
99
|
-
<pre class="code ruby"><code class="ruby">bin/rails generate outboxer:install
|
|
100
|
-
</code></pre>
|
|
101
|
-
|
|
102
|
-
<h3 id="label-Usage">Usage</h3>
|
|
103
|
-
|
|
104
|
-
<h4 id="label-1.+Include+Outboxer-3A-3AOutboxable+into+your+existing+Message+model">1. Include <code>Outboxer::Outboxable</code> into your existing Message model</h4>
|
|
105
|
-
|
|
106
|
-
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Message</span> <span class='op'><</span> <span class='const'>ApplicationRecord</span>
|
|
107
|
-
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="Outboxer.html" title="Outboxer (module)">Outboxer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Outboxer.html#Outboxable-constant" title="Outboxer::Outboxable (constant)">Outboxable</a></span></span>
|
|
108
|
-
<span class='kw'>end</span>
|
|
109
|
-
</code></pre>
|
|
110
|
-
|
|
111
|
-
<h4 id="label-2.+Update+the+generated+bin-2Fpublish+block+e.g.">2. Update the generated bin/publish block e.g.</h4>
|
|
112
|
-
|
|
113
|
-
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Outboxer.html" title="Outboxer (module)">Outboxer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Outboxer/Publisher.html" title="Outboxer::Publisher (module)">Publisher</a></span></span><span class='period'>.</span><span class='id identifier rubyid_publish'><span class='object_link'><a href="Outboxer/Publisher.html#publish-class_method" title="Outboxer::Publisher.publish (method)">publish</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_args'>args</span><span class='op'>|</span>
|
|
114
|
-
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_info'>info</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>] publishing</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
115
|
-
|
|
116
|
-
<span class='const'>Worker</span><span class='period'>.</span><span class='id identifier rubyid_perform_async'>perform_async</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>message_id:</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
117
|
-
|
|
118
|
-
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_info'>info</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>] published</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
119
|
-
<span class='kw'>end</span>
|
|
120
|
-
</code></pre>
|
|
121
|
-
|
|
122
|
-
<h4 id="label-3.+Migrate+the+database">3. Migrate the database</h4>
|
|
123
|
-
|
|
124
|
-
<pre class="code ruby"><code class="ruby">bin/rake db:migrate
|
|
125
|
-
</code></pre>
|
|
126
|
-
|
|
127
|
-
<h4 id="label-4.+Run+the+publisher">4. Run the publisher</h4>
|
|
128
|
-
|
|
129
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bin'>bin</span><span class='op'>/</span><span class='id identifier rubyid_publisher'>publisher</span>
|
|
130
|
-
</code></pre>
|
|
131
|
-
|
|
132
|
-
<h2 id="label-Implementation">Implementation</h2>
|
|
133
|
-
<ol><li>
|
|
134
|
-
<p>when an <code>ActiveRecord</code> model that includes <code>Outbox::Outboxable</code> is created, an <code>unpublished</code> <code>Outboxer::Message</code> is automatically created in the same transaction, with <code>Outboxer::Message#message</code> polymorphically assigned to the original model</p>
|
|
135
|
-
</li><li>
|
|
136
|
-
<p>When the publisher finds a new <code>unpublished</code> <code>Outboxer::Message</code>, it yields to a user-supplied block and then:</p>
|
|
137
|
-
<ul><li>
|
|
138
|
-
<p>removes it if the task completes successfully</p>
|
|
139
|
-
</li><li>
|
|
140
|
-
<p>marks it as failed and records the error if there's a problem</p>
|
|
141
|
-
</li></ul>
|
|
142
|
-
</li></ol>
|
|
143
|
-
|
|
144
|
-
<p>To see all the parts working together in a single place, check out the <a href="https://github.com/fast-programmer/outboxer/blob/master/spec/outboxer/publisher_spec.rb">publisher_spec.rb</a></p>
|
|
145
|
-
|
|
146
|
-
<h2 id="label-Motivation">Motivation</h2>
|
|
147
|
-
|
|
148
|
-
<p>Outboxer was created with 4 key benefits in mind:</p>
|
|
149
|
-
<ol><li>
|
|
150
|
-
<p>speed of integration into existing Ruby on Rails applications (< 1 hour)</p>
|
|
151
|
-
</li><li>
|
|
152
|
-
<p>comprehensive documentation that is easy to understand</p>
|
|
153
|
-
</li><li>
|
|
154
|
-
<p>high reliability in production environments (100% code coverage)</p>
|
|
155
|
-
</li><li>
|
|
156
|
-
<p>forever free to use in commerical applications (MIT licence)</p>
|
|
157
|
-
</li></ol>
|
|
158
|
-
|
|
159
|
-
<h2 id="label-Contributing">Contributing</h2>
|
|
160
|
-
|
|
161
|
-
<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/fast-programmer/outboxer">github.com/fast-programmer/outboxer</a>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="https://github.com/fast-programmer/outboxer/blob/main/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
|
|
162
|
-
|
|
163
|
-
<h2 id="label-License">License</h2>
|
|
164
|
-
|
|
165
|
-
<p>The gem is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
166
|
-
|
|
167
|
-
<h2 id="label-Code+of+Conduct">Code of Conduct</h2>
|
|
168
|
-
|
|
169
|
-
<p>Everyone interacting in the Outboxer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the <a href="https://github.com/fast-programmer/outboxer/blob/main/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
|
|
170
|
-
</div></div>
|
|
171
|
-
|
|
172
|
-
<div id="footer">
|
|
173
|
-
Generated on Sat Aug 5 04:37:46 2023 by
|
|
174
|
-
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
175
|
-
0.9.34 (ruby-2.7.8).
|
|
176
|
-
</div>
|
|
177
|
-
|
|
178
|
-
</div>
|
|
179
|
-
</body>
|
|
180
|
-
</html>
|
data/doc/js/app.js
DELETED
|
@@ -1,314 +0,0 @@
|
|
|
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
|
-
var curli;
|
|
175
|
-
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
176
|
-
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
177
|
-
var lastTag = parseInt(tags[0][1], 10);
|
|
178
|
-
$(tags.join(', ')).each(function() {
|
|
179
|
-
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
180
|
-
if (this.id == "filecontents") return;
|
|
181
|
-
show = true;
|
|
182
|
-
var thisTag = parseInt(this.tagName[1], 10);
|
|
183
|
-
if (this.id.length === 0) {
|
|
184
|
-
var proposedId = $(this).attr('toc-id');
|
|
185
|
-
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
186
|
-
else {
|
|
187
|
-
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
188
|
-
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
189
|
-
this.id = proposedId;
|
|
190
|
-
}
|
|
191
|
-
}
|
|
192
|
-
if (thisTag > lastTag) {
|
|
193
|
-
for (i = 0; i < thisTag - lastTag; i++) {
|
|
194
|
-
if ( typeof(curli) == "undefined" ) {
|
|
195
|
-
curli = $('<li/>');
|
|
196
|
-
toc.append(curli);
|
|
197
|
-
}
|
|
198
|
-
toc = $('<ol/>');
|
|
199
|
-
curli.append(toc);
|
|
200
|
-
curli = undefined;
|
|
201
|
-
}
|
|
202
|
-
}
|
|
203
|
-
if (thisTag < lastTag) {
|
|
204
|
-
for (i = 0; i < lastTag - thisTag; i++) {
|
|
205
|
-
toc = toc.parent();
|
|
206
|
-
toc = toc.parent();
|
|
207
|
-
}
|
|
208
|
-
}
|
|
209
|
-
var title = $(this).attr('toc-title');
|
|
210
|
-
if (typeof(title) == "undefined") title = $(this).text();
|
|
211
|
-
curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
212
|
-
toc.append(curli);
|
|
213
|
-
lastTag = thisTag;
|
|
214
|
-
});
|
|
215
|
-
if (!show) return;
|
|
216
|
-
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
|
217
|
-
$('#content').prepend(html);
|
|
218
|
-
$('#toc').append(_toc);
|
|
219
|
-
$('#toc .hide_toc').toggle(function() {
|
|
220
|
-
$('#toc .top').slideUp('fast');
|
|
221
|
-
$('#toc').toggleClass('hidden');
|
|
222
|
-
$('#toc .title small').toggle();
|
|
223
|
-
}, function() {
|
|
224
|
-
$('#toc .top').slideDown('fast');
|
|
225
|
-
$('#toc').toggleClass('hidden');
|
|
226
|
-
$('#toc .title small').toggle();
|
|
227
|
-
});
|
|
228
|
-
}
|
|
229
|
-
|
|
230
|
-
function navResizeFn(e) {
|
|
231
|
-
if (e.which !== 1) {
|
|
232
|
-
navResizeFnStop();
|
|
233
|
-
return;
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
sessionStorage.navWidth = e.pageX.toString();
|
|
237
|
-
$('.nav_wrap').css('width', e.pageX);
|
|
238
|
-
$('.nav_wrap').css('-ms-flex', 'inherit');
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
function navResizeFnStop() {
|
|
242
|
-
$(window).unbind('mousemove', navResizeFn);
|
|
243
|
-
window.removeEventListener('message', navMessageFn, false);
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
function navMessageFn(e) {
|
|
247
|
-
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
|
248
|
-
if (e.data.action === 'mouseup') navResizeFnStop();
|
|
249
|
-
}
|
|
250
|
-
|
|
251
|
-
function navResizer() {
|
|
252
|
-
$('#resizer').mousedown(function(e) {
|
|
253
|
-
e.preventDefault();
|
|
254
|
-
$(window).mousemove(navResizeFn);
|
|
255
|
-
window.addEventListener('message', navMessageFn, false);
|
|
256
|
-
});
|
|
257
|
-
$(window).mouseup(navResizeFnStop);
|
|
258
|
-
|
|
259
|
-
if (sessionStorage.navWidth) {
|
|
260
|
-
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
|
261
|
-
}
|
|
262
|
-
}
|
|
263
|
-
|
|
264
|
-
function navExpander() {
|
|
265
|
-
var done = false, timer = setTimeout(postMessage, 500);
|
|
266
|
-
function postMessage() {
|
|
267
|
-
if (done) return;
|
|
268
|
-
clearTimeout(timer);
|
|
269
|
-
var opts = { action: 'expand', path: pathId };
|
|
270
|
-
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
|
271
|
-
done = true;
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
window.addEventListener('message', function(event) {
|
|
275
|
-
if (event.data === 'navReady') postMessage();
|
|
276
|
-
return false;
|
|
277
|
-
}, false);
|
|
278
|
-
}
|
|
279
|
-
|
|
280
|
-
function mainFocus() {
|
|
281
|
-
var hash = window.location.hash;
|
|
282
|
-
if (hash !== '' && $(hash)[0]) {
|
|
283
|
-
$(hash)[0].scrollIntoView();
|
|
284
|
-
}
|
|
285
|
-
|
|
286
|
-
setTimeout(function() { $('#main').focus(); }, 10);
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
function navigationChange() {
|
|
290
|
-
// This works around the broken anchor navigation with the YARD template.
|
|
291
|
-
window.onpopstate = function() {
|
|
292
|
-
var hash = window.location.hash;
|
|
293
|
-
if (hash !== '' && $(hash)[0]) {
|
|
294
|
-
$(hash)[0].scrollIntoView();
|
|
295
|
-
}
|
|
296
|
-
};
|
|
297
|
-
}
|
|
298
|
-
|
|
299
|
-
$(document).ready(function() {
|
|
300
|
-
navResizer();
|
|
301
|
-
navExpander();
|
|
302
|
-
createSourceLinks();
|
|
303
|
-
createDefineLinks();
|
|
304
|
-
createFullTreeLinks();
|
|
305
|
-
searchFrameButtons();
|
|
306
|
-
linkSummaries();
|
|
307
|
-
summaryToggle();
|
|
308
|
-
constantSummaryToggle();
|
|
309
|
-
generateTOC();
|
|
310
|
-
mainFocus();
|
|
311
|
-
navigationChange();
|
|
312
|
-
});
|
|
313
|
-
|
|
314
|
-
})();
|