danger-slather 0.0.2 → 0.0.3
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 +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +25 -3
- data/doc/Danger.html +117 -0
- data/doc/Danger/DangerSlather.html +1135 -0
- data/doc/Slather.html +117 -0
- data/doc/_index.html +129 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +481 -0
- data/doc/file.README.html +175 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +175 -0
- data/doc/js/app.js +243 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +123 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/slather/gem_version.rb +1 -1
- data/lib/slather/plugin.rb +10 -9
- metadata +18 -1
|
@@ -0,0 +1,175 @@
|
|
|
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.5
|
|
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"></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
|
+
<iframe id="search_frame" src="file_list.html"></iframe>
|
|
61
|
+
|
|
62
|
+
<div id="content"><div id='filecontents'><h1 id="danger-slather">Danger-slather</h1>
|
|
63
|
+
|
|
64
|
+
<p>A <a href="http://danger.systems/">Danger</a> plugin that show code coverage of a Xcode project and file by file using <a href="https://github.com/SlatherOrg/slather">Slather</a>. Add warnings or fail the build if a minimum coverage are not achieved. It uses Slather Framework for calculate coverage, so it’s required to configure the slather object before using it.</p>
|
|
65
|
+
|
|
66
|
+
<h2 id="how-does-it-look">How does it look?</h2>
|
|
67
|
+
<table>
|
|
68
|
+
<thead>
|
|
69
|
+
<tr>
|
|
70
|
+
<th width="50"></th>
|
|
71
|
+
<th width="100%">
|
|
72
|
+
1 Error
|
|
73
|
+
</th>
|
|
74
|
+
</tr>
|
|
75
|
+
</thead>
|
|
76
|
+
<tbody>
|
|
77
|
+
<tr>
|
|
78
|
+
<td><g-emoji alias="no_entry_sign" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f6ab.png">🚫</g-emoji></td>
|
|
79
|
+
<td>
|
|
80
|
+
Total coverage less than 80%
|
|
81
|
+
</td>
|
|
82
|
+
</tr>
|
|
83
|
+
</tbody>
|
|
84
|
+
</table>
|
|
85
|
+
|
|
86
|
+
<table>
|
|
87
|
+
<thead>
|
|
88
|
+
<tr>
|
|
89
|
+
<th width="50"></th>
|
|
90
|
+
<th width="100%">
|
|
91
|
+
1 Warnings
|
|
92
|
+
</th>
|
|
93
|
+
</tr>
|
|
94
|
+
</thead>
|
|
95
|
+
<tbody>
|
|
96
|
+
<tr>
|
|
97
|
+
<td><g-emoji alias="warning" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/26a0.png">⚠️</g-emoji></td>
|
|
98
|
+
<td>AppDelegate.swift has less than 50% code coverage
|
|
99
|
+
</td>
|
|
100
|
+
</tr>
|
|
101
|
+
</tbody>
|
|
102
|
+
</table>
|
|
103
|
+
|
|
104
|
+
<h2 id="code-coverage">Code coverage</h2>
|
|
105
|
+
<p>Total coverage: 35.0</p>
|
|
106
|
+
|
|
107
|
+
<p>File | Coverage
|
|
108
|
+
—–|—–
|
|
109
|
+
AppDelegate.swift | 10.00
|
|
110
|
+
ViewController.swift | 20.00
|
|
111
|
+
ViewController2.swift | 30.00
|
|
112
|
+
ViewController3.swift | 40.00
|
|
113
|
+
ViewController4.swift | 50.00
|
|
114
|
+
ViewController5.swift | 60.00
|
|
115
|
+
> Powered by <a href="https://github.com/SlatherOrg/slather">Slather</a></p>
|
|
116
|
+
|
|
117
|
+
<h2 id="installation">Installation</h2>
|
|
118
|
+
|
|
119
|
+
<pre class="code ruby"><code class="ruby">$ gem install danger-slather
|
|
120
|
+
</code></pre>
|
|
121
|
+
|
|
122
|
+
<h2 id="usage">Usage</h2>
|
|
123
|
+
|
|
124
|
+
<p>First configure the slather object:</p>
|
|
125
|
+
|
|
126
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_slather'>slather</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Path/to/my/project.xcodeproj</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>MyScheme</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
127
|
+
</code></pre>
|
|
128
|
+
|
|
129
|
+
<p>For a more complex case:</p>
|
|
130
|
+
|
|
131
|
+
<pre class="code ruby"><code class="ruby">slather.configure("Path/to/my/project.xcodeproj", "MyScheme", options: {
|
|
132
|
+
workspace: 'Path/to/my/workspace.xcworkspace',
|
|
133
|
+
build_directory: = 'Path/to/my/build_directory',
|
|
134
|
+
ignore_list: = 'ignore file list',
|
|
135
|
+
ci_service: = :travis,
|
|
136
|
+
coverage_access_token: = 'acc123123123123',
|
|
137
|
+
coverage_service: = :terminal,
|
|
138
|
+
source_directory: = 'Path/to/my/source_directory',
|
|
139
|
+
output_directory: = 'Path/to/my/output_directory',
|
|
140
|
+
input_format: = 'profdata',
|
|
141
|
+
binary_file: = 'Path/to/my/output_directory',
|
|
142
|
+
decimals: = 2
|
|
143
|
+
post = false
|
|
144
|
+
})
|
|
145
|
+
</code></pre>
|
|
146
|
+
|
|
147
|
+
<p>For a more complete documentation of all support configuration see <a href="https://github.com/SlatherOrg/slather">Slather</a></p>
|
|
148
|
+
|
|
149
|
+
<p>Than just add this line to your <code>Dangerfile</code>:</p>
|
|
150
|
+
|
|
151
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_slather'>slather</span><span class='period'>.</span><span class='id identifier rubyid_notify_if_coverage_is_less_than'>notify_if_coverage_is_less_than</span><span class='lparen'>(</span><span class='label'>minimum_coverage:</span> <span class='int'>80</span><span class='rparen'>)</span>
|
|
152
|
+
<span class='id identifier rubyid_slather'>slather</span><span class='period'>.</span><span class='id identifier rubyid_notify_if_modified_file_is_less_than'>notify_if_modified_file_is_less_than</span><span class='lparen'>(</span><span class='label'>minimum_coverage:</span> <span class='int'>60</span><span class='rparen'>)</span>
|
|
153
|
+
<span class='id identifier rubyid_slather'>slather</span><span class='period'>.</span><span class='id identifier rubyid_show_coverage'>show_coverage</span>
|
|
154
|
+
</code></pre>
|
|
155
|
+
|
|
156
|
+
<h2 id="development">Development</h2>
|
|
157
|
+
|
|
158
|
+
<ol>
|
|
159
|
+
<li>Clone this repo</li>
|
|
160
|
+
<li>Run <code>bundle install</code> to setup dependencies.</li>
|
|
161
|
+
<li>Run <code>bundle exec rake spec</code> to run the tests.</li>
|
|
162
|
+
<li>Use <code>bundle exec guard</code> to automatically have tests run as you make changes.</li>
|
|
163
|
+
<li>Make your changes.</li>
|
|
164
|
+
</ol>
|
|
165
|
+
</div></div>
|
|
166
|
+
|
|
167
|
+
<div id="footer">
|
|
168
|
+
Generated on Sun Nov 27 19:08:31 2016 by
|
|
169
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
170
|
+
0.9.5 (ruby-2.3.1).
|
|
171
|
+
</div>
|
|
172
|
+
|
|
173
|
+
</div>
|
|
174
|
+
</body>
|
|
175
|
+
</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.5</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,175 @@
|
|
|
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.5
|
|
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"></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
|
+
<iframe id="search_frame" src="class_list.html"></iframe>
|
|
61
|
+
|
|
62
|
+
<div id="content"><div id='filecontents'><h1 id="danger-slather">Danger-slather</h1>
|
|
63
|
+
|
|
64
|
+
<p>A <a href="http://danger.systems/">Danger</a> plugin that show code coverage of a Xcode project and file by file using <a href="https://github.com/SlatherOrg/slather">Slather</a>. Add warnings or fail the build if a minimum coverage are not achieved. It uses Slather Framework for calculate coverage, so it’s required to configure the slather object before using it.</p>
|
|
65
|
+
|
|
66
|
+
<h2 id="how-does-it-look">How does it look?</h2>
|
|
67
|
+
<table>
|
|
68
|
+
<thead>
|
|
69
|
+
<tr>
|
|
70
|
+
<th width="50"></th>
|
|
71
|
+
<th width="100%">
|
|
72
|
+
1 Error
|
|
73
|
+
</th>
|
|
74
|
+
</tr>
|
|
75
|
+
</thead>
|
|
76
|
+
<tbody>
|
|
77
|
+
<tr>
|
|
78
|
+
<td><g-emoji alias="no_entry_sign" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f6ab.png">🚫</g-emoji></td>
|
|
79
|
+
<td>
|
|
80
|
+
Total coverage less than 80%
|
|
81
|
+
</td>
|
|
82
|
+
</tr>
|
|
83
|
+
</tbody>
|
|
84
|
+
</table>
|
|
85
|
+
|
|
86
|
+
<table>
|
|
87
|
+
<thead>
|
|
88
|
+
<tr>
|
|
89
|
+
<th width="50"></th>
|
|
90
|
+
<th width="100%">
|
|
91
|
+
1 Warnings
|
|
92
|
+
</th>
|
|
93
|
+
</tr>
|
|
94
|
+
</thead>
|
|
95
|
+
<tbody>
|
|
96
|
+
<tr>
|
|
97
|
+
<td><g-emoji alias="warning" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/26a0.png">⚠️</g-emoji></td>
|
|
98
|
+
<td>AppDelegate.swift has less than 50% code coverage
|
|
99
|
+
</td>
|
|
100
|
+
</tr>
|
|
101
|
+
</tbody>
|
|
102
|
+
</table>
|
|
103
|
+
|
|
104
|
+
<h2 id="code-coverage">Code coverage</h2>
|
|
105
|
+
<p>Total coverage: 35.0</p>
|
|
106
|
+
|
|
107
|
+
<p>File | Coverage
|
|
108
|
+
—–|—–
|
|
109
|
+
AppDelegate.swift | 10.00
|
|
110
|
+
ViewController.swift | 20.00
|
|
111
|
+
ViewController2.swift | 30.00
|
|
112
|
+
ViewController3.swift | 40.00
|
|
113
|
+
ViewController4.swift | 50.00
|
|
114
|
+
ViewController5.swift | 60.00
|
|
115
|
+
> Powered by <a href="https://github.com/SlatherOrg/slather">Slather</a></p>
|
|
116
|
+
|
|
117
|
+
<h2 id="installation">Installation</h2>
|
|
118
|
+
|
|
119
|
+
<pre class="code ruby"><code class="ruby">$ gem install danger-slather
|
|
120
|
+
</code></pre>
|
|
121
|
+
|
|
122
|
+
<h2 id="usage">Usage</h2>
|
|
123
|
+
|
|
124
|
+
<p>First configure the slather object:</p>
|
|
125
|
+
|
|
126
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_slather'>slather</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Path/to/my/project.xcodeproj</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>MyScheme</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
127
|
+
</code></pre>
|
|
128
|
+
|
|
129
|
+
<p>For a more complex case:</p>
|
|
130
|
+
|
|
131
|
+
<pre class="code ruby"><code class="ruby">slather.configure("Path/to/my/project.xcodeproj", "MyScheme", options: {
|
|
132
|
+
workspace: 'Path/to/my/workspace.xcworkspace',
|
|
133
|
+
build_directory: = 'Path/to/my/build_directory',
|
|
134
|
+
ignore_list: = 'ignore file list',
|
|
135
|
+
ci_service: = :travis,
|
|
136
|
+
coverage_access_token: = 'acc123123123123',
|
|
137
|
+
coverage_service: = :terminal,
|
|
138
|
+
source_directory: = 'Path/to/my/source_directory',
|
|
139
|
+
output_directory: = 'Path/to/my/output_directory',
|
|
140
|
+
input_format: = 'profdata',
|
|
141
|
+
binary_file: = 'Path/to/my/output_directory',
|
|
142
|
+
decimals: = 2
|
|
143
|
+
post = false
|
|
144
|
+
})
|
|
145
|
+
</code></pre>
|
|
146
|
+
|
|
147
|
+
<p>For a more complete documentation of all support configuration see <a href="https://github.com/SlatherOrg/slather">Slather</a></p>
|
|
148
|
+
|
|
149
|
+
<p>Than just add this line to your <code>Dangerfile</code>:</p>
|
|
150
|
+
|
|
151
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_slather'>slather</span><span class='period'>.</span><span class='id identifier rubyid_notify_if_coverage_is_less_than'>notify_if_coverage_is_less_than</span><span class='lparen'>(</span><span class='label'>minimum_coverage:</span> <span class='int'>80</span><span class='rparen'>)</span>
|
|
152
|
+
<span class='id identifier rubyid_slather'>slather</span><span class='period'>.</span><span class='id identifier rubyid_notify_if_modified_file_is_less_than'>notify_if_modified_file_is_less_than</span><span class='lparen'>(</span><span class='label'>minimum_coverage:</span> <span class='int'>60</span><span class='rparen'>)</span>
|
|
153
|
+
<span class='id identifier rubyid_slather'>slather</span><span class='period'>.</span><span class='id identifier rubyid_show_coverage'>show_coverage</span>
|
|
154
|
+
</code></pre>
|
|
155
|
+
|
|
156
|
+
<h2 id="development">Development</h2>
|
|
157
|
+
|
|
158
|
+
<ol>
|
|
159
|
+
<li>Clone this repo</li>
|
|
160
|
+
<li>Run <code>bundle install</code> to setup dependencies.</li>
|
|
161
|
+
<li>Run <code>bundle exec rake spec</code> to run the tests.</li>
|
|
162
|
+
<li>Use <code>bundle exec guard</code> to automatically have tests run as you make changes.</li>
|
|
163
|
+
<li>Make your changes.</li>
|
|
164
|
+
</ol>
|
|
165
|
+
</div></div>
|
|
166
|
+
|
|
167
|
+
<div id="footer">
|
|
168
|
+
Generated on Sun Nov 27 19:08:31 2016 by
|
|
169
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
170
|
+
0.9.5 (ruby-2.3.1).
|
|
171
|
+
</div>
|
|
172
|
+
|
|
173
|
+
</div>
|
|
174
|
+
</body>
|
|
175
|
+
</html>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,243 @@
|
|
|
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
|
+
$('#search_frame').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
|
+
$('#search_frame').slideUp(100);
|
|
67
|
+
$('#search a').removeClass('active inactive');
|
|
68
|
+
$(window).focus();
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function toggleSearchFrame(id, link) {
|
|
74
|
+
var frame = $('#search_frame');
|
|
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
|
+
$('#main')[0].focus();
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
$(document).ready(function() {
|
|
231
|
+
navResizer();
|
|
232
|
+
navExpander();
|
|
233
|
+
createSourceLinks();
|
|
234
|
+
createDefineLinks();
|
|
235
|
+
createFullTreeLinks();
|
|
236
|
+
searchFrameButtons();
|
|
237
|
+
linkSummaries();
|
|
238
|
+
summaryToggle();
|
|
239
|
+
generateTOC();
|
|
240
|
+
mainFocus();
|
|
241
|
+
});
|
|
242
|
+
|
|
243
|
+
})();
|