gitlab-release-tools 1.0.0 → 1.0.1

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 (30) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -1
  3. data/CHANGELOG.md +3 -0
  4. data/Gemfile.lock +1 -1
  5. data/doc/Gitlab.html +117 -0
  6. data/doc/Gitlab/Release.html +135 -0
  7. data/doc/Gitlab/Release/ApiClient.html +213 -0
  8. data/doc/Gitlab/Release/Changelog.html +117 -0
  9. data/doc/Gitlab/Release/Changelog/Entries.html +603 -0
  10. data/doc/Gitlab/Release/Changelog/Entry.html +556 -0
  11. data/doc/Gitlab/Release/Changelog/Generator.html +462 -0
  12. data/doc/Gitlab/Release/Changelog/Issue.html +225 -0
  13. data/doc/Gitlab/Release/Changelog/MergeRequest.html +225 -0
  14. data/doc/Gitlab/Release/Manager.html +430 -0
  15. data/doc/_index.html +218 -0
  16. data/doc/class_list.html +51 -0
  17. data/doc/css/common.css +1 -0
  18. data/doc/css/full_list.css +58 -0
  19. data/doc/css/style.css +496 -0
  20. data/doc/file.README.html +135 -0
  21. data/doc/file_list.html +56 -0
  22. data/doc/frames.html +17 -0
  23. data/doc/index.html +135 -0
  24. data/doc/js/app.js +303 -0
  25. data/doc/js/full_list.js +216 -0
  26. data/doc/js/jquery.js +4 -0
  27. data/doc/method_list.html +187 -0
  28. data/doc/top-level-namespace.html +110 -0
  29. data/lib/gitlab/release/version.rb +1 -1
  30. metadata +27 -3
data/doc/file.README.html ADDED
@@ -0,0 +1,135 @@
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
+ &mdash; Documentation by YARD 0.9.20
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> &raquo;
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-gitlab-release-tools">gitlab-release-tools</h1>
62
+
63
+ <p><a
64
+ href="https://github.com/andreadelfante/gitlab-release-tools/blob/master/LICENSE"><img
65
+ src="https://img.shields.io/badge/license-MIT-green.svg?style=flat"></a> <a
66
+ href="https://rubygems.org/gems/gitlab-release-tools"><img
67
+ src="https://img.shields.io/gem/v/gitlab-release-tools.svg?style=flat"></a>
68
+ <a href="https://travis-ci.org/andreadelfante/gitlab-release-tools"><img
69
+ src="https://travis-ci.org/andreadelfante/gitlab-release-tools.svg?branch=master"></a></p>
70
+
71
+ <h2 id="label-Installation">Installation</h2>
72
+
73
+ <p>Add this line to your application&#39;s Gemfile:</p>
74
+
75
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gitlab-release-tools</span><span class='tstring_end'>&#39;</span></span>
76
+ </code></pre>
77
+
78
+ <p>And then execute:</p>
79
+
80
+ <pre class="code ruby"><code class="ruby">$ bundle install</code></pre>
81
+
82
+ <p>Or install it yourself as:</p>
83
+
84
+ <pre class="code ruby"><code class="ruby">$ gem install gitlab-release-tools</code></pre>
85
+
86
+ <h2 id="label-Usage">Usage</h2>
87
+
88
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>endpoint</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># or value from ENV for CI/CD
89
+ </span><span class='id identifier rubyid_private_token'>private_token</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>private_token</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># or value from ENV for CI/CD
90
+ </span><span class='id identifier rubyid_project_id'>project_id</span> <span class='op'>=</span> <span class='int'>50</span> <span class='comment'># or value from ENV for CI/CD
91
+ </span><span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.0</span><span class='tstring_end'>&#39;</span></span>
92
+
93
+ <span class='id identifier rubyid_generator'>generator</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Gitlab.html" title="Gitlab (module)">Gitlab</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release.html" title="Gitlab::Release (module)">Release</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release/Changelog.html" title="Gitlab::Release::Changelog (module)">Changelog</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release/Changelog/Generator.html" title="Gitlab::Release::Changelog::Generator (class)">Generator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Gitlab/Release/Changelog/Generator.html#initialize-instance_method" title="Gitlab::Release::Changelog::Generator#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>endpoint:</span> <span class='id identifier rubyid_endpoint'>endpoint</span><span class='comma'>,</span> <span class='label'>private_token:</span> <span class='id identifier rubyid_private_token'>private_token</span><span class='rparen'>)</span>
94
+ <span class='id identifier rubyid_changelog'>changelog</span> <span class='op'>=</span> <span class='id identifier rubyid_generator'>generator</span><span class='period'>.</span><span class='id identifier rubyid_changelog'>changelog</span><span class='lparen'>(</span><span class='id identifier rubyid_version'>version</span><span class='comma'>,</span> <span class='label'>project_id:</span> <span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
95
+ <span class='comment'># print(changelog) for a simple changelog list
96
+ </span><span class='comment'># print(changelog.to_s_with_reference) for a changelog list with mrs/issues references
97
+ </span>
98
+ <span class='id identifier rubyid_manager'>manager</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Gitlab.html" title="Gitlab (module)">Gitlab</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release.html" title="Gitlab::Release (module)">Release</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release/Manager.html" title="Gitlab::Release::Manager (class)">Manager</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Gitlab/Release/ApiClient.html#initialize-instance_method" title="Gitlab::Release::ApiClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>endpoint:</span> <span class='id identifier rubyid_endpoint'>endpoint</span><span class='comma'>,</span> <span class='label'>private_token:</span> <span class='id identifier rubyid_private_token'>private_token</span><span class='rparen'>)</span>
99
+ <span class='id identifier rubyid_manager'>manager</span><span class='period'>.</span><span class='id identifier rubyid_define_tag'>define_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_version'>version</span><span class='comma'>,</span> <span class='id identifier rubyid_changelog'>changelog</span><span class='period'>.</span><span class='id identifier rubyid_to_s_with_reference'>to_s_with_reference</span><span class='rparen'>)</span>
100
+ <span class='id identifier rubyid_manager'>manager</span><span class='period'>.</span><span class='id identifier rubyid_close_milestones'>close_milestones</span><span class='lparen'>(</span><span class='id identifier rubyid_version'>version</span><span class='rparen'>)</span>
101
+ </code></pre>
102
+
103
+ <p>Check out the <a href="./doc/index.html">documentation</a> for more.</p>
104
+
105
+ <h2 id="label-Development">Development</h2>
106
+ <ol><li>
107
+ <p>Install this gem onto your local machine, <code>bundle exec rake
108
+ install</code>.</p>
109
+ </li><li>
110
+ <p>Copy <code>.env.example</code> and rename with <code>.env</code>.</p>
111
+ </li><li>
112
+ <p>Define Gitlab base url and generate a private token.</p>
113
+ </li><li>
114
+ <p>You are ready to go!</p>
115
+ </li></ol>
116
+
117
+ <h2 id="label-Contributing">Contributing</h2>
118
+
119
+ <p>Bug reports and pull requests are welcome.</p>
120
+
121
+ <h2 id="label-License">License</h2>
122
+
123
+ <p>The gem is available as open source under the terms of the <a
124
+ href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
125
+ </div></div>
126
+
127
+ <div id="footer">
128
+ Generated on Fri Nov 29 14:42:41 2019 by
129
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
130
+ 0.9.20 (ruby-2.4.6).
131
+ </div>
132
+
133
+ </div>
134
+ </body>
135
+ </html>
data/doc/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/doc/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.20</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/doc/index.html ADDED
@@ -0,0 +1,135 @@
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
+ &mdash; Documentation by YARD 0.9.20
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> &raquo;
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-gitlab-release-tools">gitlab-release-tools</h1>
62
+
63
+ <p><a
64
+ href="https://github.com/andreadelfante/gitlab-release-tools/blob/master/LICENSE"><img
65
+ src="https://img.shields.io/badge/license-MIT-green.svg?style=flat"></a> <a
66
+ href="https://rubygems.org/gems/gitlab-release-tools"><img
67
+ src="https://img.shields.io/gem/v/gitlab-release-tools.svg?style=flat"></a>
68
+ <a href="https://travis-ci.org/andreadelfante/gitlab-release-tools"><img
69
+ src="https://travis-ci.org/andreadelfante/gitlab-release-tools.svg?branch=master"></a></p>
70
+
71
+ <h2 id="label-Installation">Installation</h2>
72
+
73
+ <p>Add this line to your application&#39;s Gemfile:</p>
74
+
75
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gitlab-release-tools</span><span class='tstring_end'>&#39;</span></span>
76
+ </code></pre>
77
+
78
+ <p>And then execute:</p>
79
+
80
+ <pre class="code ruby"><code class="ruby">$ bundle install</code></pre>
81
+
82
+ <p>Or install it yourself as:</p>
83
+
84
+ <pre class="code ruby"><code class="ruby">$ gem install gitlab-release-tools</code></pre>
85
+
86
+ <h2 id="label-Usage">Usage</h2>
87
+
88
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>endpoint</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># or value from ENV for CI/CD
89
+ </span><span class='id identifier rubyid_private_token'>private_token</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>private_token</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># or value from ENV for CI/CD
90
+ </span><span class='id identifier rubyid_project_id'>project_id</span> <span class='op'>=</span> <span class='int'>50</span> <span class='comment'># or value from ENV for CI/CD
91
+ </span><span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.0</span><span class='tstring_end'>&#39;</span></span>
92
+
93
+ <span class='id identifier rubyid_generator'>generator</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Gitlab.html" title="Gitlab (module)">Gitlab</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release.html" title="Gitlab::Release (module)">Release</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release/Changelog.html" title="Gitlab::Release::Changelog (module)">Changelog</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release/Changelog/Generator.html" title="Gitlab::Release::Changelog::Generator (class)">Generator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Gitlab/Release/Changelog/Generator.html#initialize-instance_method" title="Gitlab::Release::Changelog::Generator#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>endpoint:</span> <span class='id identifier rubyid_endpoint'>endpoint</span><span class='comma'>,</span> <span class='label'>private_token:</span> <span class='id identifier rubyid_private_token'>private_token</span><span class='rparen'>)</span>
94
+ <span class='id identifier rubyid_changelog'>changelog</span> <span class='op'>=</span> <span class='id identifier rubyid_generator'>generator</span><span class='period'>.</span><span class='id identifier rubyid_changelog'>changelog</span><span class='lparen'>(</span><span class='id identifier rubyid_version'>version</span><span class='comma'>,</span> <span class='label'>project_id:</span> <span class='id identifier rubyid_project_id'>project_id</span><span class='rparen'>)</span>
95
+ <span class='comment'># print(changelog) for a simple changelog list
96
+ </span><span class='comment'># print(changelog.to_s_with_reference) for a changelog list with mrs/issues references
97
+ </span>
98
+ <span class='id identifier rubyid_manager'>manager</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Gitlab.html" title="Gitlab (module)">Gitlab</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release.html" title="Gitlab::Release (module)">Release</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Gitlab/Release/Manager.html" title="Gitlab::Release::Manager (class)">Manager</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Gitlab/Release/ApiClient.html#initialize-instance_method" title="Gitlab::Release::ApiClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>endpoint:</span> <span class='id identifier rubyid_endpoint'>endpoint</span><span class='comma'>,</span> <span class='label'>private_token:</span> <span class='id identifier rubyid_private_token'>private_token</span><span class='rparen'>)</span>
99
+ <span class='id identifier rubyid_manager'>manager</span><span class='period'>.</span><span class='id identifier rubyid_define_tag'>define_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_version'>version</span><span class='comma'>,</span> <span class='id identifier rubyid_changelog'>changelog</span><span class='period'>.</span><span class='id identifier rubyid_to_s_with_reference'>to_s_with_reference</span><span class='rparen'>)</span>
100
+ <span class='id identifier rubyid_manager'>manager</span><span class='period'>.</span><span class='id identifier rubyid_close_milestones'>close_milestones</span><span class='lparen'>(</span><span class='id identifier rubyid_version'>version</span><span class='rparen'>)</span>
101
+ </code></pre>
102
+
103
+ <p>Check out the <a href="./doc/index.html">documentation</a> for more.</p>
104
+
105
+ <h2 id="label-Development">Development</h2>
106
+ <ol><li>
107
+ <p>Install this gem onto your local machine, <code>bundle exec rake
108
+ install</code>.</p>
109
+ </li><li>
110
+ <p>Copy <code>.env.example</code> and rename with <code>.env</code>.</p>
111
+ </li><li>
112
+ <p>Define Gitlab base url and generate a private token.</p>
113
+ </li><li>
114
+ <p>You are ready to go!</p>
115
+ </li></ol>
116
+
117
+ <h2 id="label-Contributing">Contributing</h2>
118
+
119
+ <p>Bug reports and pull requests are welcome.</p>
120
+
121
+ <h2 id="label-License">License</h2>
122
+
123
+ <p>The gem is available as open source under the terms of the <a
124
+ href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
125
+ </div></div>
126
+
127
+ <div id="footer">
128
+ Generated on Fri Nov 29 14:42:41 2019 by
129
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
130
+ 0.9.20 (ruby-2.4.6).
131
+ </div>
132
+
133
+ </div>
134
+ </body>
135
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,303 @@
1
+ (function() {
2
+
3
+ var localStorage = {}, sessionStorage = {};
4
+ try { localStorage = window.localStorage; } catch (e) { }
5
+ try { sessionStorage = window.sessionStorage; } catch (e) { }
6
+
7
+ function createSourceLinks() {
8
+ $('.method_details_list .source_code').
9
+ before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
10
+ $('.toggleSource').toggle(function() {
11
+ $(this).parent().nextAll('.source_code').slideDown(100);
12
+ $(this).text("Hide source");
13
+ },
14
+ function() {
15
+ $(this).parent().nextAll('.source_code').slideUp(100);
16
+ $(this).text("View source");
17
+ });
18
+ }
19
+
20
+ function createDefineLinks() {
21
+ var tHeight = 0;
22
+ $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
23
+ $('.toggleDefines').toggle(function() {
24
+ tHeight = $(this).parent().prev().height();
25
+ $(this).prev().css('display', 'inline');
26
+ $(this).parent().prev().height($(this).parent().height());
27
+ $(this).text("(less)");
28
+ },
29
+ function() {
30
+ $(this).prev().hide();
31
+ $(this).parent().prev().height(tHeight);
32
+ $(this).text("more...");
33
+ });
34
+ }
35
+
36
+ function createFullTreeLinks() {
37
+ var tHeight = 0;
38
+ $('.inheritanceTree').toggle(function() {
39
+ tHeight = $(this).parent().prev().height();
40
+ $(this).parent().toggleClass('showAll');
41
+ $(this).text("(hide)");
42
+ $(this).parent().prev().height($(this).parent().height());
43
+ },
44
+ function() {
45
+ $(this).parent().toggleClass('showAll');
46
+ $(this).parent().prev().height(tHeight);
47
+ $(this).text("show all");
48
+ });
49
+ }
50
+
51
+ function searchFrameButtons() {
52
+ $('.full_list_link').click(function() {
53
+ toggleSearchFrame(this, $(this).attr('href'));
54
+ return false;
55
+ });
56
+ window.addEventListener('message', function(e) {
57
+ if (e.data === 'navEscape') {
58
+ $('#nav').slideUp(100);
59
+ $('#search a').removeClass('active inactive');
60
+ $(window).focus();
61
+ }
62
+ });
63
+
64
+ $(window).resize(function() {
65
+ if ($('#search:visible').length === 0) {
66
+ $('#nav').removeAttr('style');
67
+ $('#search a').removeClass('active inactive');
68
+ $(window).focus();
69
+ }
70
+ });
71
+ }
72
+
73
+ function toggleSearchFrame(id, link) {
74
+ var frame = $('#nav');
75
+ $('#search a').removeClass('active').addClass('inactive');
76
+ if (frame.attr('src') === link && frame.css('display') !== "none") {
77
+ frame.slideUp(100);
78
+ $('#search a').removeClass('active inactive');
79
+ }
80
+ else {
81
+ $(id).addClass('active').removeClass('inactive');
82
+ if (frame.attr('src') !== link) frame.attr('src', link);
83
+ frame.slideDown(100);
84
+ }
85
+ }
86
+
87
+ function linkSummaries() {
88
+ $('.summary_signature').click(function() {
89
+ document.location = $(this).find('a').attr('href');
90
+ });
91
+ }
92
+
93
+ function summaryToggle() {
94
+ $('.summary_toggle').click(function(e) {
95
+ e.preventDefault();
96
+ localStorage.summaryCollapsed = $(this).text();
97
+ $('.summary_toggle').each(function() {
98
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
99
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
100
+ if (next.hasClass('compact')) {
101
+ next.toggle();
102
+ next.nextAll('ul.summary').first().toggle();
103
+ }
104
+ else if (next.hasClass('summary')) {
105
+ var list = $('<ul class="summary compact" />');
106
+ list.html(next.html());
107
+ list.find('.summary_desc, .note').remove();
108
+ list.find('a').each(function() {
109
+ $(this).html($(this).find('strong').html());
110
+ $(this).parent().html($(this)[0].outerHTML);
111
+ });
112
+ next.before(list);
113
+ next.toggle();
114
+ }
115
+ });
116
+ return false;
117
+ });
118
+ if (localStorage.summaryCollapsed == "collapse") {
119
+ $('.summary_toggle').first().click();
120
+ } else { localStorage.summaryCollapsed = "expand"; }
121
+ }
122
+
123
+ function constantSummaryToggle() {
124
+ $('.constants_summary_toggle').click(function(e) {
125
+ e.preventDefault();
126
+ localStorage.summaryCollapsed = $(this).text();
127
+ $('.constants_summary_toggle').each(function() {
128
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
129
+ var next = $(this).parent().parent().nextAll('dl.constants').first();
130
+ if (next.hasClass('compact')) {
131
+ next.toggle();
132
+ next.nextAll('dl.constants').first().toggle();
133
+ }
134
+ else if (next.hasClass('constants')) {
135
+ var list = $('<dl class="constants compact" />');
136
+ list.html(next.html());
137
+ list.find('dt').each(function() {
138
+ $(this).addClass('summary_signature');
139
+ $(this).text( $(this).text().split('=')[0]);
140
+ if ($(this).has(".deprecated").length) {
141
+ $(this).addClass('deprecated');
142
+ };
143
+ });
144
+ // Add the value of the constant as "Tooltip" to the summary object
145
+ list.find('pre.code').each(function() {
146
+ console.log($(this).parent());
147
+ var dt_element = $(this).parent().prev();
148
+ var tooltip = $(this).text();
149
+ if (dt_element.hasClass("deprecated")) {
150
+ tooltip = 'Deprecated. ' + tooltip;
151
+ };
152
+ dt_element.attr('title', tooltip);
153
+ });
154
+ list.find('.docstring, .tags, dd').remove();
155
+ next.before(list);
156
+ next.toggle();
157
+ }
158
+ });
159
+ return false;
160
+ });
161
+ if (localStorage.summaryCollapsed == "collapse") {
162
+ $('.constants_summary_toggle').first().click();
163
+ } else { localStorage.summaryCollapsed = "expand"; }
164
+ }
165
+
166
+ function generateTOC() {
167
+ if ($('#filecontents').length === 0) return;
168
+ var _toc = $('<ol class="top"></ol>');
169
+ var show = false;
170
+ var toc = _toc;
171
+ var counter = 0;
172
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
173
+ var i;
174
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
175
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
176
+ var lastTag = parseInt(tags[0][1], 10);
177
+ $(tags.join(', ')).each(function() {
178
+ if ($(this).parents('.method_details .docstring').length != 0) return;
179
+ if (this.id == "filecontents") return;
180
+ show = true;
181
+ var thisTag = parseInt(this.tagName[1], 10);
182
+ if (this.id.length === 0) {
183
+ var proposedId = $(this).attr('toc-id');
184
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
185
+ else {
186
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
187
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
188
+ this.id = proposedId;
189
+ }
190
+ }
191
+ if (thisTag > lastTag) {
192
+ for (i = 0; i < thisTag - lastTag; i++) {
193
+ var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
194
+ }
195
+ }
196
+ if (thisTag < lastTag) {
197
+ for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
198
+ }
199
+ var title = $(this).attr('toc-title');
200
+ if (typeof(title) == "undefined") title = $(this).text();
201
+ toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
202
+ lastTag = thisTag;
203
+ });
204
+ if (!show) return;
205
+ html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
206
+ $('#content').prepend(html);
207
+ $('#toc').append(_toc);
208
+ $('#toc .hide_toc').toggle(function() {
209
+ $('#toc .top').slideUp('fast');
210
+ $('#toc').toggleClass('hidden');
211
+ $('#toc .title small').toggle();
212
+ }, function() {
213
+ $('#toc .top').slideDown('fast');
214
+ $('#toc').toggleClass('hidden');
215
+ $('#toc .title small').toggle();
216
+ });
217
+ }
218
+
219
+ function navResizeFn(e) {
220
+ if (e.which !== 1) {
221
+ navResizeFnStop();
222
+ return;
223
+ }
224
+
225
+ sessionStorage.navWidth = e.pageX.toString();
226
+ $('.nav_wrap').css('width', e.pageX);
227
+ $('.nav_wrap').css('-ms-flex', 'inherit');
228
+ }
229
+
230
+ function navResizeFnStop() {
231
+ $(window).unbind('mousemove', navResizeFn);
232
+ window.removeEventListener('message', navMessageFn, false);
233
+ }
234
+
235
+ function navMessageFn(e) {
236
+ if (e.data.action === 'mousemove') navResizeFn(e.data.event);
237
+ if (e.data.action === 'mouseup') navResizeFnStop();
238
+ }
239
+
240
+ function navResizer() {
241
+ $('#resizer').mousedown(function(e) {
242
+ e.preventDefault();
243
+ $(window).mousemove(navResizeFn);
244
+ window.addEventListener('message', navMessageFn, false);
245
+ });
246
+ $(window).mouseup(navResizeFnStop);
247
+
248
+ if (sessionStorage.navWidth) {
249
+ navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
250
+ }
251
+ }
252
+
253
+ function navExpander() {
254
+ var done = false, timer = setTimeout(postMessage, 500);
255
+ function postMessage() {
256
+ if (done) return;
257
+ clearTimeout(timer);
258
+ var opts = { action: 'expand', path: pathId };
259
+ document.getElementById('nav').contentWindow.postMessage(opts, '*');
260
+ done = true;
261
+ }
262
+
263
+ window.addEventListener('message', function(event) {
264
+ if (event.data === 'navReady') postMessage();
265
+ return false;
266
+ }, false);
267
+ }
268
+
269
+ function mainFocus() {
270
+ var hash = window.location.hash;
271
+ if (hash !== '' && $(hash)[0]) {
272
+ $(hash)[0].scrollIntoView();
273
+ }
274
+
275
+ setTimeout(function() { $('#main').focus(); }, 10);
276
+ }
277
+
278
+ function navigationChange() {
279
+ // This works around the broken anchor navigation with the YARD template.
280
+ window.onpopstate = function() {
281
+ var hash = window.location.hash;
282
+ if (hash !== '' && $(hash)[0]) {
283
+ $(hash)[0].scrollIntoView();
284
+ }
285
+ };
286
+ }
287
+
288
+ $(document).ready(function() {
289
+ navResizer();
290
+ navExpander();
291
+ createSourceLinks();
292
+ createDefineLinks();
293
+ createFullTreeLinks();
294
+ searchFrameButtons();
295
+ linkSummaries();
296
+ summaryToggle();
297
+ constantSummaryToggle();
298
+ generateTOC();
299
+ mainFocus();
300
+ navigationChange();
301
+ });
302
+
303
+ })();