env_parser 0.1.0
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 +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.rubocop.yml +78 -0
- data/.ruby-version +1 -0
- data/.travis.yml +5 -0
- data/.yardopts +1 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +48 -0
- data/LICENSE.txt +21 -0
- data/README.md +90 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/docs/EnvParser.html +315 -0
- data/docs/_index.html +107 -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 +499 -0
- data/docs/file.README.html +182 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +182 -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 +59 -0
- data/docs/top-level-namespace.html +110 -0
- data/env_parser.gemspec +28 -0
- data/lib/env_parser/version.rb +3 -0
- data/lib/env_parser.rb +99 -0
- metadata +132 -0
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.11</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,182 @@
|
|
|
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.11
|
|
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-EnvParser">EnvParser</h1>
|
|
62
|
+
|
|
63
|
+
<p>If your code uses environment variables, you know that <code>ENV</code>
|
|
64
|
+
will always surface these as strings. Interpreting these strings as the
|
|
65
|
+
value you <em>actually</em> want to see/use takes some additional effort,
|
|
66
|
+
however.</p>
|
|
67
|
+
|
|
68
|
+
<p>If you want a number, you need to cast:
|
|
69
|
+
<code>#to_i</code>/<code>#to_f</code>. If you want a boolean, you need to
|
|
70
|
+
check for a specific value: <code>ENV['SOME_VAR'] == 'true'</code>.
|
|
71
|
+
Maybe you want to set non-trivial defaults (something other than
|
|
72
|
+
<code>0</code> or <code>''</code>)? Maybe you only want to allow
|
|
73
|
+
values from a limited set.</p>
|
|
74
|
+
|
|
75
|
+
<p>Things can get out of control pretty fast, especially as the number of
|
|
76
|
+
environment variables in play grows. EnvParser aims to help keep things
|
|
77
|
+
simple.</p>
|
|
78
|
+
|
|
79
|
+
<h2 id="label-Installation">Installation</h2>
|
|
80
|
+
|
|
81
|
+
<p>Add this line to your application's Gemfile:</p>
|
|
82
|
+
|
|
83
|
+
<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'>env_parser</span><span class='tstring_end'>'</span></span>
|
|
84
|
+
</code></pre>
|
|
85
|
+
|
|
86
|
+
<p>And then execute:</p>
|
|
87
|
+
|
|
88
|
+
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
|
|
89
|
+
|
|
90
|
+
<p>Or install it yourself as:</p>
|
|
91
|
+
|
|
92
|
+
<pre class="code ruby"><code class="ruby">$ gem install env_parser</code></pre>
|
|
93
|
+
|
|
94
|
+
<h2 id="label-Usage">Usage</h2>
|
|
95
|
+
|
|
96
|
+
<p>Basic EnvParser usage: “`ruby</p>
|
|
97
|
+
|
|
98
|
+
<h2 id="label-Returns+ENV+as+an+Integer.">Returns <a href="'TIMEOUT_MS'">ENV</a> as an Integer.</h2>
|
|
99
|
+
|
|
100
|
+
<h2 id="label-Yields+0+if+ENV+is+unset+or+nil.">Yields 0 if <a href="'TIMEOUT_MS'">ENV</a> is unset or nil.</h2>
|
|
101
|
+
|
|
102
|
+
<p>## timeout_ms = EnvParser.parse <a href="'TIMEOUT_MS'">ENV</a>, as:
|
|
103
|
+
:integer</p>
|
|
104
|
+
|
|
105
|
+
<h2 id="label-LESS+TYPING-2C+PLZ-21+-3A-28">LESS TYPING, PLZ! :(</h2>
|
|
106
|
+
|
|
107
|
+
<h2 id="label-If+you+pass+in+a+Symbol+instead+of+a+String-2C+EnvParser">If you pass in a Symbol instead of a String, EnvParser</h2>
|
|
108
|
+
|
|
109
|
+
<h2 id="label-will+use+the+value+behind+the+matching+String+key+in+ENV.">will use the value behind the matching String key in ENV.</h2>
|
|
110
|
+
|
|
111
|
+
<h2 id="label-28i.e.+passing+in+ENV-5B-27X-27-5D+is+equivalent+to+passing+in+-3AX-29">(i.e. passing in <code>ENV['X']</code> is equivalent to passing in <code>:X</code>)</h2>
|
|
112
|
+
|
|
113
|
+
<p>## timeout_ms = EnvParser.parse :TIMEOUT_MS, as: :integer “`</p>
|
|
114
|
+
<hr>
|
|
115
|
+
|
|
116
|
+
<p>The named <code>:as</code> value is required. Allowed values are:</p>
|
|
117
|
+
|
|
118
|
+
<p>| <code>:as</code> value | type returned | |—————————–|———————————| |
|
|
119
|
+
:string | String | | :symbol | Symbol | | :boolean | TrueValue / FalseValue
|
|
120
|
+
| | :int / :integer | Integer | | :float / :decimal / :number | Float | |
|
|
121
|
+
:json | < depends on JSON given > | | :array | Array | | :hash | Hash
|
|
122
|
+
|</p>
|
|
123
|
+
|
|
124
|
+
<p>Note JSON is parsed using <em>quirks-mode</em> (meaning 'true',
|
|
125
|
+
'25', and 'null' are all considered valid, parseable JSON).</p>
|
|
126
|
+
<hr>
|
|
127
|
+
|
|
128
|
+
<p><a
|
|
129
|
+
href="https://github.com/nestor-custodio/env_parser/blob/master/docs/index.html">Consult
|
|
130
|
+
the repo docs</a> for the full EnvParser documentation.</p>
|
|
131
|
+
|
|
132
|
+
<h2 id="label-Feature+Roadmap+-2F+Future+Development">Feature Roadmap / Future Development</h2>
|
|
133
|
+
|
|
134
|
+
<p>Additional features/options coming in the future: - An
|
|
135
|
+
<code>:if_unset</code> option to more easily set default values. - A
|
|
136
|
+
<code>:from_set</code> option to restrict acceptable values to those on a
|
|
137
|
+
given list. - An <code>EnvParser.load</code> method that will not only
|
|
138
|
+
parse the given value, but will set a constant, easily converting
|
|
139
|
+
environment variables into constants in your code. - An
|
|
140
|
+
<code>EnvParser.load_all</code> method to shortcut multiple
|
|
141
|
+
<code>.load</code> calls. - A means to <strong>optionally</strong> bind
|
|
142
|
+
<code>#parse</code>, <code>#load</code>, and <code>#load_all</code> methods
|
|
143
|
+
onto <code>ENV</code> itself (not all hashes!). Because <code>ENV.parse
|
|
144
|
+
...</code> reads better than <code>EnvParser.parse ...</code>. - … ?</p>
|
|
145
|
+
|
|
146
|
+
<h2 id="label-Contribution+-2F+Development">Contribution / Development</h2>
|
|
147
|
+
|
|
148
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a
|
|
149
|
+
href="https://github.com/nestor-custodio/env_parser">github.com/nestor-custodio/env_parser</a>.</p>
|
|
150
|
+
|
|
151
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install
|
|
152
|
+
dependencies. Then, run <code>rake spec</code> to run the tests. You can
|
|
153
|
+
also run <code>bin/console</code> for an interactive prompt that will allow
|
|
154
|
+
you to experiment.</p>
|
|
155
|
+
|
|
156
|
+
<p>Linting is courtesy of <a
|
|
157
|
+
href="https://github.com/bbatsov/rubocop">Rubocop</a> and documentation is
|
|
158
|
+
built using <a href="https://yardoc.org/">Yard</a>. Neither is included in
|
|
159
|
+
the Gemspec; you'll need to install these locally to take advantage.</p>
|
|
160
|
+
|
|
161
|
+
<p>To install this gem onto your local machine, run <code>bundle exec rake
|
|
162
|
+
install</code>. To release a new version, update the version number in
|
|
163
|
+
<code>version.rb</code>, and then run <code>bundle exec rake
|
|
164
|
+
release</code>, which will create a git tag for the version, push git
|
|
165
|
+
commits and tags, and push the <code>.gem</code> file to <a
|
|
166
|
+
href="https://rubygems.org">rubygems.org</a>.</p>
|
|
167
|
+
|
|
168
|
+
<h2 id="label-License">License</h2>
|
|
169
|
+
|
|
170
|
+
<p>The gem is available as open source under the terms of the <a
|
|
171
|
+
href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
172
|
+
</div></div>
|
|
173
|
+
|
|
174
|
+
<div id="footer">
|
|
175
|
+
Generated on Mon Nov 27 21:58:11 2017 by
|
|
176
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
177
|
+
0.9.11 (ruby-2.4.2).
|
|
178
|
+
</div>
|
|
179
|
+
|
|
180
|
+
</div>
|
|
181
|
+
</body>
|
|
182
|
+
</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
|
+
})();
|