guard-phpspec 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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +4 -0
  3. data/.rspec +2 -0
  4. data/.travis.yml +0 -0
  5. data/Gemfile +1 -0
  6. data/Gemfile.lock +54 -0
  7. data/Guardfile +8 -0
  8. data/HISTORY.md +5 -0
  9. data/README.md +127 -0
  10. data/Rakefile +20 -0
  11. data/doc/Guard.html +117 -0
  12. data/doc/Guard/PHPSpec.html +714 -0
  13. data/doc/Guard/PHPSpec/Exceptions.html +115 -0
  14. data/doc/Guard/PHPSpec/Exceptions/TaskHasFailed.html +123 -0
  15. data/doc/Guard/PHPSpec/Formatter.html +259 -0
  16. data/doc/Guard/PHPSpec/Inspector.html +325 -0
  17. data/doc/Guard/PHPSpec/Notifier.html +400 -0
  18. data/doc/Guard/PHPSpec/Runner.html +328 -0
  19. data/doc/_index.html +185 -0
  20. data/doc/class_list.html +54 -0
  21. data/doc/css/common.css +1 -0
  22. data/doc/css/full_list.css +57 -0
  23. data/doc/css/style.css +338 -0
  24. data/doc/file.README.html +176 -0
  25. data/doc/file_list.html +56 -0
  26. data/doc/frames.html +28 -0
  27. data/doc/index.html +176 -0
  28. data/doc/js/app.js +214 -0
  29. data/doc/js/full_list.js +178 -0
  30. data/doc/js/jquery.js +4 -0
  31. data/doc/method_list.html +113 -0
  32. data/doc/top-level-namespace.html +112 -0
  33. data/guard-phpspec.gemspec +24 -0
  34. data/lib/guard/phpspec/application.rb +9 -0
  35. data/lib/guard/phpspec/error.rb +8 -0
  36. data/lib/guard/phpspec/version.rb +22 -0
  37. data/tasks/default.rake +271 -0
  38. data/tasks/this.rb +209 -0
  39. metadata +87 -5
data/doc/file.README.html ADDED
@@ -0,0 +1,176 @@
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
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#!" + escape(window.location.href);
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-Guard%3A%3APHPSpec">Guard::PHPSpec</h1>
66
+
67
+ <h2 id="label-Description">Description</h2>
68
+
69
+ <p>guard-phpspec allows you to automatically run <a
70
+ href="http://www.phpunit.de">PHPSpec</a> tests when sources are modified.
71
+ It helps with integrating test-driven development (TDD) into your
72
+ development process: Just launch guard-phpspec before you start working and
73
+ it will notify you about the status of your tests!</p>
74
+
75
+ <p><em>Note</em>: Although guard-phpspec should work with any <a
76
+ href="http://php.net">PHP</a> version <a
77
+ href="http://www.phpunit.de">PHPSpec</a> supports, it has only been tested
78
+ on <a href="http://php.net">PHP</a> 5.3.8 and 5.4.4.</p>
79
+
80
+ <h2 id="label-Author">Author</h2>
81
+
82
+ <p><a href="https://github.com/lsd">Isam Machlovi</a></p>
83
+
84
+ <h2 id="label-Install">Install</h2>
85
+
86
+ <p>Please be sure to have <a href="http://php.net">PHP</a>, <a
87
+ href="http://www.phpunit.de">PHPSpec</a> and <a
88
+ href="http://ruby-lang.org">Ruby</a> installed on your machine before you
89
+ proceed with the installation.</p>
90
+
91
+ <p>The latest versions of <a href="http://ruby-lang.org">Ruby</a> come with a
92
+ packages-manager called <code>gem</code>. <code>gem</code> can be used to
93
+ install various packages, including guard-phpspec.</p>
94
+
95
+ <p>To install guard-phpspec, run the following command in the terminal:</p>
96
+
97
+ <pre class="code ruby"><code class="ruby"></code></pre>
98
+
99
+ <h2 id="label-Usage">Usage</h2>
100
+
101
+ <p>Please read the <a href="https://github.com/guard/guard#readme">Guard usage
102
+ documentation</a>.</p>
103
+
104
+ <h2 id="label-Guardfile">Guardfile</h2>
105
+
106
+ <p>guard-phpspec can be used with any kind of <a href="http://php.net">PHP</a>
107
+ projects that uses PHPSpec as its testing framwork. Please read the <a
108
+ href="https://github.com/guard/guard#readme">Guard documentation</a> for
109
+ more information about the Guardfile DSL.</p>
110
+
111
+ <p>By default, guard-phpspec will use the current working directory (pwd) to
112
+ search for tests and run them on start (if you enabled the
113
+ <code>:all_on_start</code> option).</p>
114
+
115
+ <h3 id="label-Example+PHP+project">Example PHP project</h3>
116
+
117
+ <p>The <a href="http://www.phpunit.de/manual/current/en/">PHPSpec
118
+ documentaion</a> uses the <a
119
+ href="https://github.com/sebastianbergmann/php-object-freezer/">Object
120
+ Freezer</a> library as an example on how to organize tests. This project
121
+ uses the <code>Tests</code> directory for its tests.</p>
122
+
123
+ <p>An example of the Guardfile for the same project would look something like:</p>
124
+
125
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_guard'>guard</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>phpunit</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='symbol'>:tests_path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Tests</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='symbol'>:cli</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>--colors</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
126
+ <span class='comment'># Watch tests files
127
+ </span> <span class='id identifier rubyid_watch'>watch</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>^.+Test\.php$</span><span class='regexp_end'>}</span></span><span class='rparen'>)</span>
128
+
129
+ <span class='comment'># Watch library files and run their tests
130
+ </span> <span class='id identifier rubyid_watch'>watch</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>^Object/(.+)\.php</span><span class='regexp_end'>}</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Tests/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_m'>m</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>Test.php</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
131
+ <span class='kw'>end</span>
132
+ </code></pre>
133
+
134
+ <h2 id="label-Options">Options</h2>
135
+
136
+ <p>The following options can be passed to Guard::PHPSpec:</p>
137
+
138
+ <pre class="code ruby"><code class="ruby">:all_on_start =&gt; false # Run all tests on startup.
139
+ # default: true
140
+
141
+ :all_after_pass =&gt; false # Run all tests after changed tests pass. This ensures
142
+ # that the process of making changed tests pass didn&#39;t
143
+ # break something else.
144
+ # default: true
145
+
146
+ :keep_failed =&gt; false # Remember failed tests and keep running them with
147
+ # each change until they pass.
148
+ # default: true
149
+
150
+ :tests_path =&gt; &#39;tests&#39; # Relative path to the tests directory. This path
151
+ # is used when running all the tests.
152
+ # default: the current working directory (pwd)
153
+
154
+ :cli =&gt; &#39;--colors&#39; # The options passed to the phpunit command
155
+ # when running the tests.
156
+ # default: nil
157
+ </code></pre>
158
+
159
+ <h2 id="label-Development">Development</h2>
160
+ <ul><li>
161
+ <p>Source hosted at <a
162
+ href="https://github.com/lsd/guard-phpspec">GitHub/lsd</a></p>
163
+ </li><li>
164
+ <p>Report issues/questions/requests on <a
165
+ href="https://github.com/lsd/guard-phpspec/issues">GitHub Issues</a></p>
166
+ </li></ul>
167
+ </div></div>
168
+
169
+ <div id="footer">
170
+ Generated on Sat Aug 24 15:20:45 2013 by
171
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
172
+ 0.8.7 (ruby-2.0.0).
173
+ </div>
174
+
175
+ </body>
176
+ </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,28 @@
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</title>
8
+ </head>
9
+ <script type="text/javascript" charset="utf-8">
10
+ window.onload = function() {
11
+ var match = window.location.hash.match(/^#!(.+)/);
12
+ var name = 'index.html';
13
+ if (match) {
14
+ name = unescape(match[1]);
15
+ }
16
+ document.writeln('<frameset cols="20%,*">' +
17
+ '<frame name="list" src="class_list.html" />' +
18
+ '<frame name="main" src="' + name + '" />' +
19
+ '</frameset>');
20
+ }
21
+ </script>
22
+ <noscript>
23
+ <frameset cols="20%,*">
24
+ <frame name="list" src="class_list.html" />
25
+ <frame name="main" src="index.html" />
26
+ </frameset>
27
+ </noscript>
28
+ </html>
data/doc/index.html ADDED
@@ -0,0 +1,176 @@
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
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#!" + escape(window.location.href);
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-Guard%3A%3APHPSpec">Guard::PHPSpec</h1>
66
+
67
+ <h2 id="label-Description">Description</h2>
68
+
69
+ <p>guard-phpspec allows you to automatically run <a
70
+ href="http://www.phpunit.de">PHPSpec</a> tests when sources are modified.
71
+ It helps with integrating test-driven development (TDD) into your
72
+ development process: Just launch guard-phpspec before you start working and
73
+ it will notify you about the status of your tests!</p>
74
+
75
+ <p><em>Note</em>: Although guard-phpspec should work with any <a
76
+ href="http://php.net">PHP</a> version <a
77
+ href="http://www.phpunit.de">PHPSpec</a> supports, it has only been tested
78
+ on <a href="http://php.net">PHP</a> 5.3.8 and 5.4.4.</p>
79
+
80
+ <h2 id="label-Author">Author</h2>
81
+
82
+ <p><a href="https://github.com/lsd">Isam Machlovi</a></p>
83
+
84
+ <h2 id="label-Install">Install</h2>
85
+
86
+ <p>Please be sure to have <a href="http://php.net">PHP</a>, <a
87
+ href="http://www.phpunit.de">PHPSpec</a> and <a
88
+ href="http://ruby-lang.org">Ruby</a> installed on your machine before you
89
+ proceed with the installation.</p>
90
+
91
+ <p>The latest versions of <a href="http://ruby-lang.org">Ruby</a> come with a
92
+ packages-manager called <code>gem</code>. <code>gem</code> can be used to
93
+ install various packages, including guard-phpspec.</p>
94
+
95
+ <p>To install guard-phpspec, run the following command in the terminal:</p>
96
+
97
+ <pre class="code ruby"><code class="ruby"></code></pre>
98
+
99
+ <h2 id="label-Usage">Usage</h2>
100
+
101
+ <p>Please read the <a href="https://github.com/guard/guard#readme">Guard usage
102
+ documentation</a>.</p>
103
+
104
+ <h2 id="label-Guardfile">Guardfile</h2>
105
+
106
+ <p>guard-phpspec can be used with any kind of <a href="http://php.net">PHP</a>
107
+ projects that uses PHPSpec as its testing framwork. Please read the <a
108
+ href="https://github.com/guard/guard#readme">Guard documentation</a> for
109
+ more information about the Guardfile DSL.</p>
110
+
111
+ <p>By default, guard-phpspec will use the current working directory (pwd) to
112
+ search for tests and run them on start (if you enabled the
113
+ <code>:all_on_start</code> option).</p>
114
+
115
+ <h3 id="label-Example+PHP+project">Example PHP project</h3>
116
+
117
+ <p>The <a href="http://www.phpunit.de/manual/current/en/">PHPSpec
118
+ documentaion</a> uses the <a
119
+ href="https://github.com/sebastianbergmann/php-object-freezer/">Object
120
+ Freezer</a> library as an example on how to organize tests. This project
121
+ uses the <code>Tests</code> directory for its tests.</p>
122
+
123
+ <p>An example of the Guardfile for the same project would look something like:</p>
124
+
125
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_guard'>guard</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>phpunit</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='symbol'>:tests_path</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Tests</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='symbol'>:cli</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>--colors</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
126
+ <span class='comment'># Watch tests files
127
+ </span> <span class='id identifier rubyid_watch'>watch</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>^.+Test\.php$</span><span class='regexp_end'>}</span></span><span class='rparen'>)</span>
128
+
129
+ <span class='comment'># Watch library files and run their tests
130
+ </span> <span class='id identifier rubyid_watch'>watch</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>^Object/(.+)\.php</span><span class='regexp_end'>}</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Tests/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_m'>m</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>Test.php</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
131
+ <span class='kw'>end</span>
132
+ </code></pre>
133
+
134
+ <h2 id="label-Options">Options</h2>
135
+
136
+ <p>The following options can be passed to Guard::PHPSpec:</p>
137
+
138
+ <pre class="code ruby"><code class="ruby">:all_on_start =&gt; false # Run all tests on startup.
139
+ # default: true
140
+
141
+ :all_after_pass =&gt; false # Run all tests after changed tests pass. This ensures
142
+ # that the process of making changed tests pass didn&#39;t
143
+ # break something else.
144
+ # default: true
145
+
146
+ :keep_failed =&gt; false # Remember failed tests and keep running them with
147
+ # each change until they pass.
148
+ # default: true
149
+
150
+ :tests_path =&gt; &#39;tests&#39; # Relative path to the tests directory. This path
151
+ # is used when running all the tests.
152
+ # default: the current working directory (pwd)
153
+
154
+ :cli =&gt; &#39;--colors&#39; # The options passed to the phpunit command
155
+ # when running the tests.
156
+ # default: nil
157
+ </code></pre>
158
+
159
+ <h2 id="label-Development">Development</h2>
160
+ <ul><li>
161
+ <p>Source hosted at <a
162
+ href="https://github.com/lsd/guard-phpspec">GitHub/lsd</a></p>
163
+ </li><li>
164
+ <p>Report issues/questions/requests on <a
165
+ href="https://github.com/lsd/guard-phpspec/issues">GitHub Issues</a></p>
166
+ </li></ul>
167
+ </div></div>
168
+
169
+ <div id="footer">
170
+ Generated on Sat Aug 24 15:20:44 2013 by
171
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
172
+ 0.8.7 (ruby-2.0.0).
173
+ </div>
174
+
175
+ </body>
176
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,214 @@
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
+ window.top.document.title = $('html head title').text();
82
+ }
83
+ else {
84
+ $('#menu .noframes a').text('frames').attr('href', framesUrl);
85
+ }
86
+ }
87
+
88
+ function keyboardShortcuts() {
89
+ if (window.top.frames.main) return;
90
+ $(document).keypress(function(evt) {
91
+ if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
92
+ if (typeof evt.target !== "undefined" &&
93
+ (evt.target.nodeName == "INPUT" ||
94
+ evt.target.nodeName == "TEXTAREA")) return;
95
+ switch (evt.charCode) {
96
+ case 67: case 99: $('#class_list_link').click(); break; // 'c'
97
+ case 77: case 109: $('#method_list_link').click(); break; // 'm'
98
+ case 70: case 102: $('#file_list_link').click(); break; // 'f'
99
+ default: break;
100
+ }
101
+ });
102
+ }
103
+
104
+ function summaryToggle() {
105
+ $('.summary_toggle').click(function() {
106
+ if (localStorage) {
107
+ localStorage.summaryCollapsed = $(this).text();
108
+ }
109
+ $('.summary_toggle').each(function() {
110
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
111
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
112
+ if (next.hasClass('compact')) {
113
+ next.toggle();
114
+ next.nextAll('ul.summary').first().toggle();
115
+ }
116
+ else if (next.hasClass('summary')) {
117
+ var list = $('<ul class="summary compact" />');
118
+ list.html(next.html());
119
+ list.find('.summary_desc, .note').remove();
120
+ list.find('a').each(function() {
121
+ $(this).html($(this).find('strong').html());
122
+ $(this).parent().html($(this)[0].outerHTML);
123
+ });
124
+ next.before(list);
125
+ next.toggle();
126
+ }
127
+ });
128
+ return false;
129
+ });
130
+ if (localStorage) {
131
+ if (localStorage.summaryCollapsed == "collapse") {
132
+ $('.summary_toggle').first().click();
133
+ }
134
+ else localStorage.summaryCollapsed = "expand";
135
+ }
136
+ }
137
+
138
+ function fixOutsideWorldLinks() {
139
+ $('a').each(function() {
140
+ if (window.location.host != this.host) this.target = '_parent';
141
+ });
142
+ }
143
+
144
+ function generateTOC() {
145
+ if ($('#filecontents').length === 0) return;
146
+ var _toc = $('<ol class="top"></ol>');
147
+ var show = false;
148
+ var toc = _toc;
149
+ var counter = 0;
150
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
151
+ var i;
152
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
153
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
154
+ var lastTag = parseInt(tags[0][1], 10);
155
+ $(tags.join(', ')).each(function() {
156
+ if ($(this).parents('.method_details .docstring').length != 0) return;
157
+ if (this.id == "filecontents") return;
158
+ show = true;
159
+ var thisTag = parseInt(this.tagName[1], 10);
160
+ if (this.id.length === 0) {
161
+ var proposedId = $(this).attr('toc-id');
162
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
163
+ else {
164
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
165
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
166
+ this.id = proposedId;
167
+ }
168
+ }
169
+ if (thisTag > lastTag) {
170
+ for (i = 0; i < thisTag - lastTag; i++) {
171
+ var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
172
+ }
173
+ }
174
+ if (thisTag < lastTag) {
175
+ for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
176
+ }
177
+ var title = $(this).attr('toc-title');
178
+ if (typeof(title) == "undefined") title = $(this).text();
179
+ toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
180
+ lastTag = thisTag;
181
+ });
182
+ if (!show) return;
183
+ 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>';
184
+ $('#content').prepend(html);
185
+ $('#toc').append(_toc);
186
+ $('#toc .hide_toc').toggle(function() {
187
+ $('#toc .top').slideUp('fast');
188
+ $('#toc').toggleClass('hidden');
189
+ $('#toc .title small').toggle();
190
+ }, function() {
191
+ $('#toc .top').slideDown('fast');
192
+ $('#toc').toggleClass('hidden');
193
+ $('#toc .title small').toggle();
194
+ });
195
+ $('#toc .float_toc').toggle(function() {
196
+ $(this).text('float');
197
+ $('#toc').toggleClass('nofloat');
198
+ }, function() {
199
+ $(this).text('left');
200
+ $('#toc').toggleClass('nofloat');
201
+ });
202
+ }
203
+
204
+ $(framesInit);
205
+ $(createSourceLinks);
206
+ $(createDefineLinks);
207
+ $(createFullTreeLinks);
208
+ $(fixBoxInfoHeights);
209
+ $(searchFrameLinks);
210
+ $(linkSummaries);
211
+ $(keyboardShortcuts);
212
+ $(summaryToggle);
213
+ $(fixOutsideWorldLinks);
214
+ $(generateTOC);