agouti 0.0.1 → 0.0.2

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.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -2
  3. data/.rspec +2 -0
  4. data/.travis.yml +7 -0
  5. data/CHANGELOG.md +9 -0
  6. data/Gemfile.lock +46 -0
  7. data/README.md +2 -2
  8. data/Rakefile +5 -1
  9. data/agouti.gemspec +4 -0
  10. data/doc/Agouti.html +131 -0
  11. data/doc/Agouti/Rack.html +115 -0
  12. data/doc/Agouti/Rack/PackageLimiter.html +408 -0
  13. data/doc/Agouti/Rack/PackageLimiter/GzipTruncatedStream.html +310 -0
  14. data/doc/Agouti/Rack/PackageLimiter/InvalidHeaderException.html +134 -0
  15. data/doc/Agouti/Railtie.html +123 -0
  16. data/doc/_index.html +177 -0
  17. data/doc/class_list.html +54 -0
  18. data/doc/css/common.css +1 -0
  19. data/doc/css/full_list.css +57 -0
  20. data/doc/css/style.css +339 -0
  21. data/doc/file.README.html +140 -0
  22. data/doc/file_list.html +56 -0
  23. data/doc/frames.html +26 -0
  24. data/doc/index.html +140 -0
  25. data/doc/js/app.js +219 -0
  26. data/doc/js/full_list.js +178 -0
  27. data/doc/js/jquery.js +4 -0
  28. data/doc/method_list.html +77 -0
  29. data/doc/top-level-namespace.html +112 -0
  30. data/lib/agouti.rb +3 -3
  31. data/lib/agouti/rack/package_limiter.rb +73 -24
  32. data/lib/agouti/version.rb +1 -1
  33. data/spec/rack/package_limiter_spec.rb +91 -0
  34. data/spec/spec_helper.rb +7 -0
  35. metadata +88 -3
data/doc/file.README.html ADDED
@@ -0,0 +1,140 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!file.README.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index</a> &raquo;
35
+ <span class="title">File: README</span>
36
+
37
+
38
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
+ </div>
40
+
41
+ <div id="search">
42
+
43
+ <a class="full_list_link" id="class_list_link"
44
+ href="class_list.html">
45
+ Class List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="method_list_link"
49
+ href="method_list.html">
50
+ Method List
51
+ </a>
52
+
53
+ <a class="full_list_link" id="file_list_link"
54
+ href="file_list.html">
55
+ File List
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame"></iframe>
63
+
64
+ <div id="content"><div id='filecontents'>
65
+ <h1 id="label-Agouti+%7BBuild+Status%7D%5Bhttps%3A%2F%2Ftravis-ci.org%2FCWISoftware%2Fagouti%5D+%7BCode+Climate%7D%5Bhttps%3A%2F%2Fcodeclimate.com%2Fgithub%2FCWISoftware%2Fagouti%5D+%7BGem+Version%7D%5Bhttp%3A%2F%2Fbadge.fury.io%2Frb%2Fagouti%5D">Agouti <a href="https://travis-ci.org/CWISoftware/agouti.png?branch=master">{Build Status</a>] <a href="https://codeclimate.com/github/CWISoftware/agouti/badges/gpa.svg">{Code Climate</a>] <a href="https://badge.fury.io/rb/agouti.svg">{Gem Version</a>]</h1>
66
+
67
+ <p>Gem for testing above the fold render on the first tcp round trip.</p>
68
+
69
+ <p>This gem is a Rack middleware that truncates the gzipped response to 14kb.</p>
70
+
71
+ <p>Useful for testing <a
72
+ href="https://developers.google.com/web/fundamentals/performance/critical-rendering-path/">critical
73
+ rendering path optimization</a>.</p>
74
+
75
+ <h2 id="label-Installation">Installation</h2>
76
+
77
+ <p>Add this line to your application&#39;s Gemfile:</p>
78
+
79
+ <pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-string">&#39;agouti&#39;</span>
80
+ </pre>
81
+
82
+ <p>And then execute:</p>
83
+
84
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
85
+
86
+ <p>Or install it yourself as:</p>
87
+
88
+ <pre class="code ruby"><code class="ruby">$ gem install agouti</code></pre>
89
+
90
+ <h2 id="label-Usage">Usage</h2>
91
+
92
+ <p>To enable the middleware, it is necessary to add the following header to
93
+ the request:
94
+ &lt;code&gt;
95
+ X-Agouti-Enable: 1
96
+ &lt;/code&gt;</p>
97
+
98
+ <p>It is possible to customize the length of the content that the server will
99
+ respond with the following header:
100
+ &lt;code&gt;
101
+ X-Agouti-Limit:
102
+ 14000
103
+ &lt;/code&gt;</p>
104
+
105
+ <h3 id="label-Example+usage+with+Cucumber%2C+Capybara+and+Poltergeist">Example usage with Cucumber, Capybara and Poltergeist</h3>
106
+
107
+ <pre class="ruby"><span class="ruby-constant">Given</span> <span class="ruby-regexp">/^(?:|I )navigate to &#39;(.+)&#39;$/</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">page_path</span><span class="ruby-operator">|</span>
108
+ <span class="ruby-identifier">visit</span> <span class="ruby-identifier">page_path</span>
109
+
110
+ <span class="ruby-constant">Given</span> <span class="ruby-regexp">/^(?:|I )navigate to &#39;(.+)&#39; waiting only one tcp round trip$/</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">page_path</span><span class="ruby-operator">|</span>
111
+ <span class="ruby-identifier">page</span>.<span class="ruby-identifier">driver</span>.<span class="ruby-identifier">add_header</span>(<span class="ruby-string">&quot;X-Agouti-Enable&quot;</span>, <span class="ruby-string">&quot;1&quot;</span>, <span class="ruby-identifier">permanent</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>)
112
+ <span class="ruby-identifier">visit</span> <span class="ruby-identifier">page_path</span>
113
+ <span class="ruby-keyword">end</span>
114
+ </pre>
115
+
116
+ <h2 id="label-Contributing">Contributing</h2>
117
+ <ol><li>
118
+ <p>Fork it ( <a
119
+ href="https://github.com/CWISoftware/agouti/fork">github.com/CWISoftware/agouti/fork</a>
120
+ )</p>
121
+ </li><li>
122
+ <p>Create your feature branch (<code>git checkout -b my-new-feature</code>)</p>
123
+ </li><li>
124
+ <p>Commit your changes (<code>git commit -am &#39;Add some
125
+ feature&#39;</code>)</p>
126
+ </li><li>
127
+ <p>Push to the branch (<code>git push origin my-new-feature</code>)</p>
128
+ </li><li>
129
+ <p>Create a new Pull Request</p>
130
+ </li></ol>
131
+ </div></div>
132
+
133
+ <div id="footer">
134
+ Generated on Tue Sep 2 15:27:49 2014 by
135
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
136
+ 0.8.7.4 (ruby-2.0.0).
137
+ </div>
138
+
139
+ </body>
140
+ </html>
data/doc/file_list.html ADDED
@@ -0,0 +1,56 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html>
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; 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
+ <script type="text/javascript" charset="utf-8">
23
+ if (window.top.frames.main) {
24
+ document.getElementById('base_target').target = 'main';
25
+ document.body.className = 'frames';
26
+ }
27
+ </script>
28
+ <div id="content">
29
+ <h1 id="full_list_header">File List</h1>
30
+ <div id="nav">
31
+
32
+ <span><a target="_self" href="class_list.html">
33
+ Classes
34
+ </a></span>
35
+
36
+ <span><a target="_self" href="method_list.html">
37
+ Methods
38
+ </a></span>
39
+
40
+ <span><a target="_self" href="file_list.html">
41
+ Files
42
+ </a></span>
43
+
44
+ </div>
45
+ <div id="search">Search: <input type="text" /></div>
46
+
47
+ <ul id="full_list" class="file">
48
+
49
+
50
+ <li class="r1"><span class="object_link"><a href="index.html" title="README">README</a></a></li>
51
+
52
+
53
+ </ul>
54
+ </div>
55
+ </body>
56
+ </html>
data/doc/frames.html ADDED
@@ -0,0 +1,26 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
3
+
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
7
+ <title>Documentation by YARD 0.8.7.4</title>
8
+ </head>
9
+ <script type="text/javascript" charset="utf-8">
10
+ window.onload = function() {
11
+ var match = unescape(window.location.hash).match(/^#!(.+)/);
12
+ var name = match ? match[1] : 'index.html';
13
+ name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
14
+ document.writeln('<frameset cols="20%,*">' +
15
+ '<frame name="list" src="class_list.html" />' +
16
+ '<frame name="main" src="' + escape(name) + '" />' +
17
+ '</frameset>');
18
+ }
19
+ </script>
20
+ <noscript>
21
+ <frameset cols="20%,*">
22
+ <frame name="list" src="class_list.html" />
23
+ <frame name="main" src="index.html" />
24
+ </frameset>
25
+ </noscript>
26
+ </html>
data/doc/index.html ADDED
@@ -0,0 +1,140 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!file.README.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index</a> &raquo;
35
+ <span class="title">File: README</span>
36
+
37
+
38
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
+ </div>
40
+
41
+ <div id="search">
42
+
43
+ <a class="full_list_link" id="class_list_link"
44
+ href="class_list.html">
45
+ Class List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="method_list_link"
49
+ href="method_list.html">
50
+ Method List
51
+ </a>
52
+
53
+ <a class="full_list_link" id="file_list_link"
54
+ href="file_list.html">
55
+ File List
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame"></iframe>
63
+
64
+ <div id="content"><div id='filecontents'>
65
+ <h1 id="label-Agouti+%7BBuild+Status%7D%5Bhttps%3A%2F%2Ftravis-ci.org%2FCWISoftware%2Fagouti%5D+%7BCode+Climate%7D%5Bhttps%3A%2F%2Fcodeclimate.com%2Fgithub%2FCWISoftware%2Fagouti%5D+%7BGem+Version%7D%5Bhttp%3A%2F%2Fbadge.fury.io%2Frb%2Fagouti%5D">Agouti <a href="https://travis-ci.org/CWISoftware/agouti.png?branch=master">{Build Status</a>] <a href="https://codeclimate.com/github/CWISoftware/agouti/badges/gpa.svg">{Code Climate</a>] <a href="https://badge.fury.io/rb/agouti.svg">{Gem Version</a>]</h1>
66
+
67
+ <p>Gem for testing above the fold render on the first tcp round trip.</p>
68
+
69
+ <p>This gem is a Rack middleware that truncates the gzipped response to 14kb.</p>
70
+
71
+ <p>Useful for testing <a
72
+ href="https://developers.google.com/web/fundamentals/performance/critical-rendering-path/">critical
73
+ rendering path optimization</a>.</p>
74
+
75
+ <h2 id="label-Installation">Installation</h2>
76
+
77
+ <p>Add this line to your application&#39;s Gemfile:</p>
78
+
79
+ <pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-string">&#39;agouti&#39;</span>
80
+ </pre>
81
+
82
+ <p>And then execute:</p>
83
+
84
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
85
+
86
+ <p>Or install it yourself as:</p>
87
+
88
+ <pre class="code ruby"><code class="ruby">$ gem install agouti</code></pre>
89
+
90
+ <h2 id="label-Usage">Usage</h2>
91
+
92
+ <p>To enable the middleware, it is necessary to add the following header to
93
+ the request:
94
+ &lt;code&gt;
95
+ X-Agouti-Enable: 1
96
+ &lt;/code&gt;</p>
97
+
98
+ <p>It is possible to customize the length of the content that the server will
99
+ respond with the following header:
100
+ &lt;code&gt;
101
+ X-Agouti-Limit:
102
+ 14000
103
+ &lt;/code&gt;</p>
104
+
105
+ <h3 id="label-Example+usage+with+Cucumber%2C+Capybara+and+Poltergeist">Example usage with Cucumber, Capybara and Poltergeist</h3>
106
+
107
+ <pre class="ruby"><span class="ruby-constant">Given</span> <span class="ruby-regexp">/^(?:|I )navigate to &#39;(.+)&#39;$/</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">page_path</span><span class="ruby-operator">|</span>
108
+ <span class="ruby-identifier">visit</span> <span class="ruby-identifier">page_path</span>
109
+
110
+ <span class="ruby-constant">Given</span> <span class="ruby-regexp">/^(?:|I )navigate to &#39;(.+)&#39; waiting only one tcp round trip$/</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">page_path</span><span class="ruby-operator">|</span>
111
+ <span class="ruby-identifier">page</span>.<span class="ruby-identifier">driver</span>.<span class="ruby-identifier">add_header</span>(<span class="ruby-string">&quot;X-Agouti-Enable&quot;</span>, <span class="ruby-string">&quot;1&quot;</span>, <span class="ruby-identifier">permanent</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>)
112
+ <span class="ruby-identifier">visit</span> <span class="ruby-identifier">page_path</span>
113
+ <span class="ruby-keyword">end</span>
114
+ </pre>
115
+
116
+ <h2 id="label-Contributing">Contributing</h2>
117
+ <ol><li>
118
+ <p>Fork it ( <a
119
+ href="https://github.com/CWISoftware/agouti/fork">github.com/CWISoftware/agouti/fork</a>
120
+ )</p>
121
+ </li><li>
122
+ <p>Create your feature branch (<code>git checkout -b my-new-feature</code>)</p>
123
+ </li><li>
124
+ <p>Commit your changes (<code>git commit -am &#39;Add some
125
+ feature&#39;</code>)</p>
126
+ </li><li>
127
+ <p>Push to the branch (<code>git push origin my-new-feature</code>)</p>
128
+ </li><li>
129
+ <p>Create a new Pull Request</p>
130
+ </li></ol>
131
+ </div></div>
132
+
133
+ <div id="footer">
134
+ Generated on Tue Sep 2 15:27:49 2014 by
135
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
136
+ 0.8.7.4 (ruby-2.0.0).
137
+ </div>
138
+
139
+ </body>
140
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,219 @@
1
+ function createSourceLinks() {
2
+ $('.method_details_list .source_code').
3
+ before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
4
+ $('.toggleSource').toggle(function() {
5
+ $(this).parent().nextAll('.source_code').slideDown(100);
6
+ $(this).text("Hide source");
7
+ },
8
+ function() {
9
+ $(this).parent().nextAll('.source_code').slideUp(100);
10
+ $(this).text("View source");
11
+ });
12
+ }
13
+
14
+ function createDefineLinks() {
15
+ var tHeight = 0;
16
+ $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
17
+ $('.toggleDefines').toggle(function() {
18
+ tHeight = $(this).parent().prev().height();
19
+ $(this).prev().show();
20
+ $(this).parent().prev().height($(this).parent().height());
21
+ $(this).text("(less)");
22
+ },
23
+ function() {
24
+ $(this).prev().hide();
25
+ $(this).parent().prev().height(tHeight);
26
+ $(this).text("more...");
27
+ });
28
+ }
29
+
30
+ function createFullTreeLinks() {
31
+ var tHeight = 0;
32
+ $('.inheritanceTree').toggle(function() {
33
+ tHeight = $(this).parent().prev().height();
34
+ $(this).parent().toggleClass('showAll');
35
+ $(this).text("(hide)");
36
+ $(this).parent().prev().height($(this).parent().height());
37
+ },
38
+ function() {
39
+ $(this).parent().toggleClass('showAll');
40
+ $(this).parent().prev().height(tHeight);
41
+ $(this).text("show all");
42
+ });
43
+ }
44
+
45
+ function fixBoxInfoHeights() {
46
+ $('dl.box dd.r1, dl.box dd.r2').each(function() {
47
+ $(this).prev().height($(this).height());
48
+ });
49
+ }
50
+
51
+ function searchFrameLinks() {
52
+ $('.full_list_link').click(function() {
53
+ toggleSearchFrame(this, $(this).attr('href'));
54
+ return false;
55
+ });
56
+ }
57
+
58
+ function toggleSearchFrame(id, link) {
59
+ var frame = $('#search_frame');
60
+ $('#search a').removeClass('active').addClass('inactive');
61
+ if (frame.attr('src') == link && frame.css('display') != "none") {
62
+ frame.slideUp(100);
63
+ $('#search a').removeClass('active inactive');
64
+ }
65
+ else {
66
+ $(id).addClass('active').removeClass('inactive');
67
+ frame.attr('src', link).slideDown(100);
68
+ }
69
+ }
70
+
71
+ function linkSummaries() {
72
+ $('.summary_signature').click(function() {
73
+ document.location = $(this).find('a').attr('href');
74
+ });
75
+ }
76
+
77
+ function framesInit() {
78
+ if (hasFrames) {
79
+ document.body.className = 'frames';
80
+ $('#menu .noframes a').attr('href', document.location);
81
+ try {
82
+ window.top.document.title = $('html head title').text();
83
+ } catch(error) {
84
+ // some browsers will not allow this when serving from file://
85
+ // but we don't want to stop the world.
86
+ }
87
+ }
88
+ else {
89
+ $('#menu .noframes a').text('frames').attr('href', framesUrl);
90
+ }
91
+ }
92
+
93
+ function keyboardShortcuts() {
94
+ if (window.top.frames.main) return;
95
+ $(document).keypress(function(evt) {
96
+ if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
97
+ if (typeof evt.target !== "undefined" &&
98
+ (evt.target.nodeName == "INPUT" ||
99
+ evt.target.nodeName == "TEXTAREA")) return;
100
+ switch (evt.charCode) {
101
+ case 67: case 99: $('#class_list_link').click(); break; // 'c'
102
+ case 77: case 109: $('#method_list_link').click(); break; // 'm'
103
+ case 70: case 102: $('#file_list_link').click(); break; // 'f'
104
+ default: break;
105
+ }
106
+ });
107
+ }
108
+
109
+ function summaryToggle() {
110
+ $('.summary_toggle').click(function() {
111
+ if (localStorage) {
112
+ localStorage.summaryCollapsed = $(this).text();
113
+ }
114
+ $('.summary_toggle').each(function() {
115
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
116
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
117
+ if (next.hasClass('compact')) {
118
+ next.toggle();
119
+ next.nextAll('ul.summary').first().toggle();
120
+ }
121
+ else if (next.hasClass('summary')) {
122
+ var list = $('<ul class="summary compact" />');
123
+ list.html(next.html());
124
+ list.find('.summary_desc, .note').remove();
125
+ list.find('a').each(function() {
126
+ $(this).html($(this).find('strong').html());
127
+ $(this).parent().html($(this)[0].outerHTML);
128
+ });
129
+ next.before(list);
130
+ next.toggle();
131
+ }
132
+ });
133
+ return false;
134
+ });
135
+ if (localStorage) {
136
+ if (localStorage.summaryCollapsed == "collapse") {
137
+ $('.summary_toggle').first().click();
138
+ }
139
+ else localStorage.summaryCollapsed = "expand";
140
+ }
141
+ }
142
+
143
+ function fixOutsideWorldLinks() {
144
+ $('a').each(function() {
145
+ if (window.location.host != this.host) this.target = '_parent';
146
+ });
147
+ }
148
+
149
+ function generateTOC() {
150
+ if ($('#filecontents').length === 0) return;
151
+ var _toc = $('<ol class="top"></ol>');
152
+ var show = false;
153
+ var toc = _toc;
154
+ var counter = 0;
155
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
156
+ var i;
157
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
158
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
159
+ var lastTag = parseInt(tags[0][1], 10);
160
+ $(tags.join(', ')).each(function() {
161
+ if ($(this).parents('.method_details .docstring').length != 0) return;
162
+ if (this.id == "filecontents") return;
163
+ show = true;
164
+ var thisTag = parseInt(this.tagName[1], 10);
165
+ if (this.id.length === 0) {
166
+ var proposedId = $(this).attr('toc-id');
167
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
168
+ else {
169
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
170
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
171
+ this.id = proposedId;
172
+ }
173
+ }
174
+ if (thisTag > lastTag) {
175
+ for (i = 0; i < thisTag - lastTag; i++) {
176
+ var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
177
+ }
178
+ }
179
+ if (thisTag < lastTag) {
180
+ for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
181
+ }
182
+ var title = $(this).attr('toc-title');
183
+ if (typeof(title) == "undefined") title = $(this).text();
184
+ toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
185
+ lastTag = thisTag;
186
+ });
187
+ if (!show) return;
188
+ html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
189
+ $('#content').prepend(html);
190
+ $('#toc').append(_toc);
191
+ $('#toc .hide_toc').toggle(function() {
192
+ $('#toc .top').slideUp('fast');
193
+ $('#toc').toggleClass('hidden');
194
+ $('#toc .title small').toggle();
195
+ }, function() {
196
+ $('#toc .top').slideDown('fast');
197
+ $('#toc').toggleClass('hidden');
198
+ $('#toc .title small').toggle();
199
+ });
200
+ $('#toc .float_toc').toggle(function() {
201
+ $(this).text('float');
202
+ $('#toc').toggleClass('nofloat');
203
+ }, function() {
204
+ $(this).text('left');
205
+ $('#toc').toggleClass('nofloat');
206
+ });
207
+ }
208
+
209
+ $(framesInit);
210
+ $(createSourceLinks);
211
+ $(createDefineLinks);
212
+ $(createFullTreeLinks);
213
+ $(fixBoxInfoHeights);
214
+ $(searchFrameLinks);
215
+ $(linkSummaries);
216
+ $(keyboardShortcuts);
217
+ $(summaryToggle);
218
+ $(fixOutsideWorldLinks);
219
+ $(generateTOC);