jsonapi_compliable 0.6.4 → 0.6.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +1 -1
- data/.travis.yml +11 -3
- data/.yardopts +1 -0
- data/README.md +10 -1
- data/Rakefile +1 -0
- data/docs/JsonapiCompliable.html +202 -0
- data/docs/JsonapiCompliable/Adapters.html +119 -0
- data/docs/JsonapiCompliable/Adapters/Abstract.html +2285 -0
- data/docs/JsonapiCompliable/Adapters/ActiveRecord.html +2151 -0
- data/docs/JsonapiCompliable/Adapters/ActiveRecordSideloading.html +582 -0
- data/docs/JsonapiCompliable/Adapters/Null.html +1682 -0
- data/docs/JsonapiCompliable/Base.html +1395 -0
- data/docs/JsonapiCompliable/Deserializer.html +835 -0
- data/docs/JsonapiCompliable/Errors.html +115 -0
- data/docs/JsonapiCompliable/Errors/BadFilter.html +124 -0
- data/docs/JsonapiCompliable/Errors/StatNotFound.html +266 -0
- data/docs/JsonapiCompliable/Errors/UnsupportedPageSize.html +264 -0
- data/docs/JsonapiCompliable/Errors/ValidationError.html +124 -0
- data/docs/JsonapiCompliable/Extensions.html +117 -0
- data/docs/JsonapiCompliable/Extensions/BooleanAttribute.html +212 -0
- data/docs/JsonapiCompliable/Extensions/BooleanAttribute/ClassMethods.html +229 -0
- data/docs/JsonapiCompliable/Extensions/ExtraAttribute.html +242 -0
- data/docs/JsonapiCompliable/Extensions/ExtraAttribute/ClassMethods.html +237 -0
- data/docs/JsonapiCompliable/Query.html +1099 -0
- data/docs/JsonapiCompliable/Rails.html +211 -0
- data/docs/JsonapiCompliable/Resource.html +5241 -0
- data/docs/JsonapiCompliable/Scope.html +703 -0
- data/docs/JsonapiCompliable/Scoping.html +117 -0
- data/docs/JsonapiCompliable/Scoping/Base.html +843 -0
- data/docs/JsonapiCompliable/Scoping/DefaultFilter.html +318 -0
- data/docs/JsonapiCompliable/Scoping/ExtraFields.html +301 -0
- data/docs/JsonapiCompliable/Scoping/Filter.html +313 -0
- data/docs/JsonapiCompliable/Scoping/Filterable.html +364 -0
- data/docs/JsonapiCompliable/Scoping/Paginate.html +613 -0
- data/docs/JsonapiCompliable/Scoping/Sort.html +454 -0
- data/docs/JsonapiCompliable/SerializableTempId.html +216 -0
- data/docs/JsonapiCompliable/Sideload.html +2484 -0
- data/docs/JsonapiCompliable/Stats.html +117 -0
- data/docs/JsonapiCompliable/Stats/DSL.html +999 -0
- data/docs/JsonapiCompliable/Stats/Payload.html +391 -0
- data/docs/JsonapiCompliable/Util.html +117 -0
- data/docs/JsonapiCompliable/Util/FieldParams.html +228 -0
- data/docs/JsonapiCompliable/Util/Hash.html +471 -0
- data/docs/JsonapiCompliable/Util/IncludeParams.html +299 -0
- data/docs/JsonapiCompliable/Util/Persistence.html +435 -0
- data/docs/JsonapiCompliable/Util/RelationshipPayload.html +563 -0
- data/docs/JsonapiCompliable/Util/RenderOptions.html +250 -0
- data/docs/JsonapiCompliable/Util/ValidationResponse.html +532 -0
- data/docs/_index.html +527 -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 +492 -0
- data/docs/file.README.html +99 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +99 -0
- data/docs/js/app.js +248 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1731 -0
- data/docs/top-level-namespace.html +110 -0
- data/gemfiles/rails_5.gemfile +1 -1
- data/lib/jsonapi_compliable/adapters/abstract.rb +267 -4
- data/lib/jsonapi_compliable/adapters/active_record.rb +23 -1
- data/lib/jsonapi_compliable/adapters/null.rb +43 -3
- data/lib/jsonapi_compliable/base.rb +182 -33
- data/lib/jsonapi_compliable/deserializer.rb +90 -21
- data/lib/jsonapi_compliable/extensions/boolean_attribute.rb +12 -0
- data/lib/jsonapi_compliable/extensions/extra_attribute.rb +32 -0
- data/lib/jsonapi_compliable/extensions/temp_id.rb +11 -0
- data/lib/jsonapi_compliable/query.rb +94 -2
- data/lib/jsonapi_compliable/rails.rb +8 -0
- data/lib/jsonapi_compliable/resource.rb +548 -11
- data/lib/jsonapi_compliable/scope.rb +43 -1
- data/lib/jsonapi_compliable/scoping/base.rb +59 -8
- data/lib/jsonapi_compliable/scoping/default_filter.rb +33 -0
- data/lib/jsonapi_compliable/scoping/extra_fields.rb +33 -0
- data/lib/jsonapi_compliable/scoping/filter.rb +29 -2
- data/lib/jsonapi_compliable/scoping/filterable.rb +4 -0
- data/lib/jsonapi_compliable/scoping/paginate.rb +33 -0
- data/lib/jsonapi_compliable/scoping/sort.rb +18 -0
- data/lib/jsonapi_compliable/sideload.rb +229 -1
- data/lib/jsonapi_compliable/stats/dsl.rb +44 -0
- data/lib/jsonapi_compliable/stats/payload.rb +20 -0
- data/lib/jsonapi_compliable/util/field_params.rb +1 -0
- data/lib/jsonapi_compliable/util/hash.rb +18 -0
- data/lib/jsonapi_compliable/util/include_params.rb +22 -0
- data/lib/jsonapi_compliable/util/persistence.rb +13 -3
- data/lib/jsonapi_compliable/util/relationship_payload.rb +2 -0
- data/lib/jsonapi_compliable/util/render_options.rb +2 -0
- data/lib/jsonapi_compliable/util/validation_response.rb +16 -0
- data/lib/jsonapi_compliable/version.rb +1 -1
- metadata +60 -5
- data/gemfiles/rails_4.gemfile.lock +0 -208
- data/gemfiles/rails_5.gemfile.lock +0 -212
- data/lib/jsonapi_compliable/write.rb +0 -93
@@ -0,0 +1,99 @@
|
|
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.9
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "README";
|
19
|
+
relpath = '';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="file_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="_index.html">Index</a> »
|
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'><h3 id="jsonapicompliable">JsonapiCompliable</h3>
|
61
|
+
|
62
|
+
<p><a href="https://travis-ci.org/jsonapi-suite/jsonapi_compliable"><img src="https://travis-ci.org/jsonapi-suite/jsonapi_compliable.svg?branch=master" alt="Build Status" /></a></p>
|
63
|
+
|
64
|
+
<p><a href="https://jsonapi-suite.github.io/jsonapi_suite">official documentation</a></p>
|
65
|
+
|
66
|
+
<p>Supported Rails versions: >= 4.1</p>
|
67
|
+
|
68
|
+
<h3 id="running-tests">Running tests</h3>
|
69
|
+
|
70
|
+
<p>We support Rails >= 4.1. To do so, we use the <a href="https://github.com/thoughtbot/appraisal">appraisal</a> gem. So, run:</p>
|
71
|
+
|
72
|
+
<p><code>bash
|
73
|
+
$ bin/appraisal rails-4 bin/rspec
|
74
|
+
$ bin/appraisal rails-5 bin/rspec
|
75
|
+
</code></p>
|
76
|
+
|
77
|
+
<p>Or run tests for all versions:</p>
|
78
|
+
|
79
|
+
<p><code>bash
|
80
|
+
$ bin/appraisal bin/rspec
|
81
|
+
</code></p>
|
82
|
+
|
83
|
+
<h3 id="generating-the-documentation">Generating the Documentation</h3>
|
84
|
+
|
85
|
+
<p><code>bash
|
86
|
+
$ yard doc
|
87
|
+
$ yard server
|
88
|
+
</code></p>
|
89
|
+
</div></div>
|
90
|
+
|
91
|
+
<div id="footer">
|
92
|
+
Generated on Fri May 5 15:53:21 2017 by
|
93
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
94
|
+
0.9.9 (ruby-2.3.0).
|
95
|
+
</div>
|
96
|
+
|
97
|
+
</div>
|
98
|
+
</body>
|
99
|
+
</html>
|
data/docs/file_list.html
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
|
+
<meta charset="utf-8" />
|
6
|
+
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
+
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
+
|
17
|
+
|
18
|
+
<title>File List</title>
|
19
|
+
<base id="base_target" target="_parent" />
|
20
|
+
</head>
|
21
|
+
<body>
|
22
|
+
<div id="content">
|
23
|
+
<div class="fixed_header">
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
25
|
+
<div id="full_list_nav">
|
26
|
+
|
27
|
+
<span><a target="_self" href="class_list.html">
|
28
|
+
Classes
|
29
|
+
</a></span>
|
30
|
+
|
31
|
+
<span><a target="_self" href="method_list.html">
|
32
|
+
Methods
|
33
|
+
</a></span>
|
34
|
+
|
35
|
+
<span><a target="_self" href="file_list.html">
|
36
|
+
Files
|
37
|
+
</a></span>
|
38
|
+
|
39
|
+
</div>
|
40
|
+
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<ul id="full_list" class="file">
|
45
|
+
|
46
|
+
|
47
|
+
<li id="object_README" class="odd">
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
49
|
+
</li>
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
</ul>
|
54
|
+
</div>
|
55
|
+
</body>
|
56
|
+
</html>
|
data/docs/frames.html
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<title>Documentation by YARD 0.9.9</title>
|
6
|
+
</head>
|
7
|
+
<script type="text/javascript" charset="utf-8">
|
8
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
|
+
var name = match ? match[1] : 'index.html';
|
10
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
11
|
+
window.top.location = name;
|
12
|
+
</script>
|
13
|
+
<noscript>
|
14
|
+
<h1>Oops!</h1>
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
16
|
+
</noscript>
|
17
|
+
</html>
|
data/docs/index.html
ADDED
@@ -0,0 +1,99 @@
|
|
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.9
|
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'><h3 id="jsonapicompliable">JsonapiCompliable</h3>
|
61
|
+
|
62
|
+
<p><a href="https://travis-ci.org/jsonapi-suite/jsonapi_compliable"><img src="https://travis-ci.org/jsonapi-suite/jsonapi_compliable.svg?branch=master" alt="Build Status" /></a></p>
|
63
|
+
|
64
|
+
<p><a href="https://jsonapi-suite.github.io/jsonapi_suite">official documentation</a></p>
|
65
|
+
|
66
|
+
<p>Supported Rails versions: >= 4.1</p>
|
67
|
+
|
68
|
+
<h3 id="running-tests">Running tests</h3>
|
69
|
+
|
70
|
+
<p>We support Rails >= 4.1. To do so, we use the <a href="https://github.com/thoughtbot/appraisal">appraisal</a> gem. So, run:</p>
|
71
|
+
|
72
|
+
<p><code>bash
|
73
|
+
$ bin/appraisal rails-4 bin/rspec
|
74
|
+
$ bin/appraisal rails-5 bin/rspec
|
75
|
+
</code></p>
|
76
|
+
|
77
|
+
<p>Or run tests for all versions:</p>
|
78
|
+
|
79
|
+
<p><code>bash
|
80
|
+
$ bin/appraisal bin/rspec
|
81
|
+
</code></p>
|
82
|
+
|
83
|
+
<h3 id="generating-the-documentation">Generating the Documentation</h3>
|
84
|
+
|
85
|
+
<p><code>bash
|
86
|
+
$ yard doc
|
87
|
+
$ yard server
|
88
|
+
</code></p>
|
89
|
+
</div></div>
|
90
|
+
|
91
|
+
<div id="footer">
|
92
|
+
Generated on Fri May 5 15:53:21 2017 by
|
93
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
94
|
+
0.9.9 (ruby-2.3.0).
|
95
|
+
</div>
|
96
|
+
|
97
|
+
</div>
|
98
|
+
</body>
|
99
|
+
</html>
|
data/docs/js/app.js
ADDED
@@ -0,0 +1,248 @@
|
|
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 generateTOC() {
|
124
|
+
if ($('#filecontents').length === 0) return;
|
125
|
+
var _toc = $('<ol class="top"></ol>');
|
126
|
+
var show = false;
|
127
|
+
var toc = _toc;
|
128
|
+
var counter = 0;
|
129
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
130
|
+
var i;
|
131
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
132
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
133
|
+
var lastTag = parseInt(tags[0][1], 10);
|
134
|
+
$(tags.join(', ')).each(function() {
|
135
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
136
|
+
if (this.id == "filecontents") return;
|
137
|
+
show = true;
|
138
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
139
|
+
if (this.id.length === 0) {
|
140
|
+
var proposedId = $(this).attr('toc-id');
|
141
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
142
|
+
else {
|
143
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
144
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
145
|
+
this.id = proposedId;
|
146
|
+
}
|
147
|
+
}
|
148
|
+
if (thisTag > lastTag) {
|
149
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
150
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
151
|
+
}
|
152
|
+
}
|
153
|
+
if (thisTag < lastTag) {
|
154
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
155
|
+
}
|
156
|
+
var title = $(this).attr('toc-title');
|
157
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
158
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
159
|
+
lastTag = thisTag;
|
160
|
+
});
|
161
|
+
if (!show) return;
|
162
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
163
|
+
$('#content').prepend(html);
|
164
|
+
$('#toc').append(_toc);
|
165
|
+
$('#toc .hide_toc').toggle(function() {
|
166
|
+
$('#toc .top').slideUp('fast');
|
167
|
+
$('#toc').toggleClass('hidden');
|
168
|
+
$('#toc .title small').toggle();
|
169
|
+
}, function() {
|
170
|
+
$('#toc .top').slideDown('fast');
|
171
|
+
$('#toc').toggleClass('hidden');
|
172
|
+
$('#toc .title small').toggle();
|
173
|
+
});
|
174
|
+
}
|
175
|
+
|
176
|
+
function navResizeFn(e) {
|
177
|
+
if (e.which !== 1) {
|
178
|
+
navResizeFnStop();
|
179
|
+
return;
|
180
|
+
}
|
181
|
+
|
182
|
+
sessionStorage.navWidth = e.pageX.toString();
|
183
|
+
$('.nav_wrap').css('width', e.pageX);
|
184
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
185
|
+
}
|
186
|
+
|
187
|
+
function navResizeFnStop() {
|
188
|
+
$(window).unbind('mousemove', navResizeFn);
|
189
|
+
window.removeEventListener('message', navMessageFn, false);
|
190
|
+
}
|
191
|
+
|
192
|
+
function navMessageFn(e) {
|
193
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
194
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
195
|
+
}
|
196
|
+
|
197
|
+
function navResizer() {
|
198
|
+
$('#resizer').mousedown(function(e) {
|
199
|
+
e.preventDefault();
|
200
|
+
$(window).mousemove(navResizeFn);
|
201
|
+
window.addEventListener('message', navMessageFn, false);
|
202
|
+
});
|
203
|
+
$(window).mouseup(navResizeFnStop);
|
204
|
+
|
205
|
+
if (sessionStorage.navWidth) {
|
206
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
207
|
+
}
|
208
|
+
}
|
209
|
+
|
210
|
+
function navExpander() {
|
211
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
212
|
+
function postMessage() {
|
213
|
+
if (done) return;
|
214
|
+
clearTimeout(timer);
|
215
|
+
var opts = { action: 'expand', path: pathId };
|
216
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
217
|
+
done = true;
|
218
|
+
}
|
219
|
+
|
220
|
+
window.addEventListener('message', function(event) {
|
221
|
+
if (event.data === 'navReady') postMessage();
|
222
|
+
return false;
|
223
|
+
}, false);
|
224
|
+
}
|
225
|
+
|
226
|
+
function mainFocus() {
|
227
|
+
var hash = window.location.hash;
|
228
|
+
if (hash !== '' && $(hash)[0]) {
|
229
|
+
$(hash)[0].scrollIntoView();
|
230
|
+
}
|
231
|
+
|
232
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
233
|
+
}
|
234
|
+
|
235
|
+
$(document).ready(function() {
|
236
|
+
navResizer();
|
237
|
+
navExpander();
|
238
|
+
createSourceLinks();
|
239
|
+
createDefineLinks();
|
240
|
+
createFullTreeLinks();
|
241
|
+
searchFrameButtons();
|
242
|
+
linkSummaries();
|
243
|
+
summaryToggle();
|
244
|
+
generateTOC();
|
245
|
+
mainFocus();
|
246
|
+
});
|
247
|
+
|
248
|
+
})();
|