equationoftime 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +19 -0
  3. data/.rspec +1 -0
  4. data/Gemfile +4 -0
  5. data/LICENSE.md +22 -0
  6. data/LICENSE.txt +22 -0
  7. data/README.md +80 -0
  8. data/README2.txt +70 -0
  9. data/Rakefile +80 -0
  10. data/doc/GeoLatLng.html +770 -0
  11. data/doc/_index.html +123 -0
  12. data/doc/class_list.html +54 -0
  13. data/doc/css/common.css +1 -0
  14. data/doc/css/full_list.css +57 -0
  15. data/doc/css/style.css +339 -0
  16. data/doc/file.README.html +179 -0
  17. data/doc/file_list.html +56 -0
  18. data/doc/frames.html +26 -0
  19. data/doc/index.html +179 -0
  20. data/doc/js/app.js +219 -0
  21. data/doc/js/full_list.js +178 -0
  22. data/doc/js/jquery.js +4 -0
  23. data/doc/method_list.html +611 -0
  24. data/doc/top-level-namespace.html +112 -0
  25. data/equationoftime.gemspec +35 -0
  26. data/examples/Equation_of_Time.jpg +0 -0
  27. data/examples/analemma_data_generator.rb +53 -0
  28. data/examples/check_date_type.rb +57 -0
  29. data/examples/compare_geoc_long_ra.rb +31 -0
  30. data/examples/data_table.rb +26 -0
  31. data/examples/earth_rotation.rb +13 -0
  32. data/examples/eot_methods_list.rb +16 -0
  33. data/examples/eot_plot.r +57 -0
  34. data/examples/eot_suntimes.rb +140 -0
  35. data/examples/equation_of_time.py +186 -0
  36. data/examples/figure_1.jpg +0 -0
  37. data/examples/file_converter.rb +31 -0
  38. data/examples/from_readme.rb +10 -0
  39. data/examples/geo_locator.rb +12 -0
  40. data/examples/getjd.rb +45 -0
  41. data/examples/input_suntimes.rb +21 -0
  42. data/examples/julian_day_formula.rb +29 -0
  43. data/examples/julian_day_formula.txt +12 -0
  44. data/examples/my_time_conversion.rb +21 -0
  45. data/examples/nutation_series.txt +678 -0
  46. data/examples/nutation_series.yaml +14239 -0
  47. data/examples/nutation_table5_3a.txt +682 -0
  48. data/examples/nutation_table5_3a.yaml +9532 -0
  49. data/examples/ptime.rb +162 -0
  50. data/examples/read_nutation_data.rb +399 -0
  51. data/examples/suntimes.rb +28 -0
  52. data/examples/suntimes_test.rb +47 -0
  53. data/examples/test_poly_eval.rb +38 -0
  54. data/examples/time_scales.rb +29 -0
  55. data/examples/usage_example.rb +13 -0
  56. data/examples/use_angles.rb +155 -0
  57. data/lib/eot/angles.rb +337 -0
  58. data/lib/eot/constants.rb +168 -0
  59. data/lib/eot/displays.rb +213 -0
  60. data/lib/eot/geo_lat_lng_smt.rb +80 -0
  61. data/lib/eot/init.rb +93 -0
  62. data/lib/eot/nutation.rb +70 -0
  63. data/lib/eot/nutation_table5_3a.yaml +9532 -0
  64. data/lib/eot/times.rb +130 -0
  65. data/lib/eot/utilities.rb +129 -0
  66. data/lib/eot/version.rb +6 -0
  67. data/lib/eot.rb +11 -0
  68. data/tests/minitest/aliased_angles_spec.rb +287 -0
  69. data/tests/minitest/aliased_displays_spec.rb +106 -0
  70. data/tests/minitest/aliased_times_spec.rb +36 -0
  71. data/tests/minitest/aliased_utilities_spec.rb +49 -0
  72. data/tests/minitest/angles_spec.rb +313 -0
  73. data/tests/minitest/constants_spec.rb +27 -0
  74. data/tests/minitest/delta_epsilon_spec.rb +35 -0
  75. data/tests/minitest/displays_spec.rb +111 -0
  76. data/tests/minitest/geo_spec.rb +36 -0
  77. data/tests/minitest/init_spec.rb +32 -0
  78. data/tests/minitest/nutation_spec.rb +33 -0
  79. data/tests/minitest/times_spec.rb +137 -0
  80. data/tests/minitest/utilities_spec.rb +121 -0
  81. data/tests/spec_config.rb +3 -0
  82. data/wiki.md +46 -0
  83. data/wiki2.md +4 -0
  84. metadata +240 -0
data/doc/file.README.html ADDED
@@ -0,0 +1,179 @@
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
+ <p><a href="http://badge.fury.io/rb/equationoftime"><img
66
+ src="https://badge.fury.io/rb/equationoftime.png"></a></p>
67
+
68
+ <h2 id="label-RDocs"><a href="http://rubydoc.info/gems/equationoftime/3.0.0/frames">RDocs</a></h2>
69
+
70
+ <h2 id="label-Graphic+Plot+1+created+from+equation_of_time.py"><img src="https://github.com/DouglasAllen/equationoftime-3.0.0/blob/master/examples/figure_1.jpg" /> created from <a href="https://bitbucket.org/cmcqueen1975/sundials/src/26a0f54a7c18fc3b54a3a4cff4f79192fcef1a91/equation_of_time.py?at=default">equation_of_time.py</a></h2>
71
+
72
+ <h2 id="label-Graphic+Plot+2+created+from+R+script"><img src="https://github.com/DouglasAllen/equationoftime-3.0.0/blob/master/examples/Equation_of_Time.jpg" /> created from <img src="http://en.wikipedia.org/wiki/File:Zeitgleichung.png" /></h2>
73
+
74
+ <h2 id="label-Solar+Time"><a href="http://www.maa.mhn.de/Scholar/times.html#solar">Solar Time</a></h2>
75
+
76
+ <h2 id="label-Web+Calculator"><a href="http://www.nature1st.net/bogan/astro/time/jsjdetst.html">Web Calculator</a></h2>
77
+
78
+ <h1 id="label-equationoftime+gem">equationoftime gem</h1>
79
+
80
+ <h2 id="label-Equation+of+Time+download"><a href="https://rubygems.org/gems/equationoftime">Equation of Time download</a></h2>
81
+
82
+ <h2 id="label-Equation+of+Time+Ruby+Sinatra+Website"><a href="http://equationoftime.herokuapp.com/">Equation of Time Ruby Sinatra Website</a></h2>
83
+
84
+ <h1 id="label-Installation%3A">Installation:</h1>
85
+
86
+ <p>Fork it and Clone it:</p>
87
+
88
+ <pre class="code ruby"><code class="ruby">$ git clone git@github.com:DouglasAllen/equationoftime-3.0.0.git</code></pre>
89
+
90
+ <p>Enter dir:</p>
91
+
92
+ <pre class="code ruby"><code class="ruby">$ cd equationoftime-3.0.0</code></pre>
93
+
94
+ <p>Execute:</p>
95
+
96
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
97
+
98
+ <p>Run minitest tests:</p>
99
+
100
+ <pre class="code ruby"><code class="ruby">$ rake</code></pre>
101
+
102
+ <p>Build gem:</p>
103
+
104
+ <pre class="code ruby"><code class="ruby">$ rake build</code></pre>
105
+
106
+ <p>Local install of gem build:</p>
107
+
108
+ <pre class="code ruby"><code class="ruby">$ rake install</code></pre>
109
+
110
+ <p>Add this line to your application&#39;s Gemfile:</p>
111
+
112
+ <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'>equationoftime</span><span class='tstring_end'>&#39;</span></span></code></pre>
113
+
114
+ <p>And then execute:</p>
115
+
116
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
117
+
118
+ <p>Or install it yourself as:</p>
119
+
120
+ <pre class="code ruby"><code class="ruby">$ gem install equationoftime</code></pre>
121
+
122
+ <h1 id="label-Usage%3A">Usage:</h1>
123
+
124
+ <pre class="code ruby"><code class="ruby">$ irb --simple-prompt
125
+
126
+ require &#39;eot&#39;
127
+ eot = Eot.new; &quot;note: nutation data loading is normal if you leave this off.&quot;
128
+ eot.string_eot()
129
+ </code></pre>
130
+
131
+ <h1 id="label-Wikis"><a href="https://github.com/DouglasAllen/equationoftime-3.0.0/blob/master/wiki.md">Wikis</a></h1>
132
+
133
+ <p>Notes:</p>
134
+ <ol><li>
135
+ <p>for other time equations see:<a href="https://gist.github.com/2032003">gist
136
+ 2032003</a></p>
137
+ </li></ol>
138
+
139
+ <p>Suggestions:</p>
140
+ <ol><li>
141
+ <p><a
142
+ href="http://equationoftime.herokuapp.com/analemma">equationoftime.herokuapp.com/analemma</a>
143
+ Itererates through a years worth of dates and computes analemma data.</p>
144
+ </li><li>
145
+ <p>A file is included in examples named analemma_data_generator.rb and may
146
+ help you get started.</p>
147
+ </li><li>
148
+ <p>see the <a
149
+ href="https://github.com/DouglasAllen/Sinatra-projects/tree/master/astro_dog">astro
150
+ dog</a> project here and the web post of it on <a
151
+ href="http://equationoftime.herokuapp.com/">Heroku</a> for more info about
152
+ the Equation of Time.</p>
153
+ </li><li>
154
+ <p>see the wikis for more usage examples.</p>
155
+ </li></ol>
156
+
157
+ <p>Contributing:</p>
158
+ <ol><li>
159
+ <p>Fork it</p>
160
+ </li><li>
161
+ <p>Create your feature branch (<code>git checkout -b my-new-feature</code>)</p>
162
+ </li><li>
163
+ <p>Commit your changes (<code>git commit -am &quot;Added some
164
+ feature&quot;</code>)</p>
165
+ </li><li>
166
+ <p>Push to the branch (<code>git push origin my-new-feature</code>)</p>
167
+ </li><li>
168
+ <p>Create new Pull Request</p>
169
+ </li></ol>
170
+ </div></div>
171
+
172
+ <div id="footer">
173
+ Generated on Wed Aug 20 13:59:05 2014 by
174
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
175
+ 0.8.7.4 (ruby-2.1.2).
176
+ </div>
177
+
178
+ </body>
179
+ </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,179 @@
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
+ <p><a href="http://badge.fury.io/rb/equationoftime"><img
66
+ src="https://badge.fury.io/rb/equationoftime.png"></a></p>
67
+
68
+ <h2 id="label-RDocs"><a href="http://rubydoc.info/gems/equationoftime/3.0.0/frames">RDocs</a></h2>
69
+
70
+ <h2 id="label-Graphic+Plot+1+created+from+equation_of_time.py"><img src="https://github.com/DouglasAllen/equationoftime-3.0.0/blob/master/examples/figure_1.jpg" /> created from <a href="https://bitbucket.org/cmcqueen1975/sundials/src/26a0f54a7c18fc3b54a3a4cff4f79192fcef1a91/equation_of_time.py?at=default">equation_of_time.py</a></h2>
71
+
72
+ <h2 id="label-Graphic+Plot+2+created+from+R+script"><img src="https://github.com/DouglasAllen/equationoftime-3.0.0/blob/master/examples/Equation_of_Time.jpg" /> created from <img src="http://en.wikipedia.org/wiki/File:Zeitgleichung.png" /></h2>
73
+
74
+ <h2 id="label-Solar+Time"><a href="http://www.maa.mhn.de/Scholar/times.html#solar">Solar Time</a></h2>
75
+
76
+ <h2 id="label-Web+Calculator"><a href="http://www.nature1st.net/bogan/astro/time/jsjdetst.html">Web Calculator</a></h2>
77
+
78
+ <h1 id="label-equationoftime+gem">equationoftime gem</h1>
79
+
80
+ <h2 id="label-Equation+of+Time+download"><a href="https://rubygems.org/gems/equationoftime">Equation of Time download</a></h2>
81
+
82
+ <h2 id="label-Equation+of+Time+Ruby+Sinatra+Website"><a href="http://equationoftime.herokuapp.com/">Equation of Time Ruby Sinatra Website</a></h2>
83
+
84
+ <h1 id="label-Installation%3A">Installation:</h1>
85
+
86
+ <p>Fork it and Clone it:</p>
87
+
88
+ <pre class="code ruby"><code class="ruby">$ git clone git@github.com:DouglasAllen/equationoftime-3.0.0.git</code></pre>
89
+
90
+ <p>Enter dir:</p>
91
+
92
+ <pre class="code ruby"><code class="ruby">$ cd equationoftime-3.0.0</code></pre>
93
+
94
+ <p>Execute:</p>
95
+
96
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
97
+
98
+ <p>Run minitest tests:</p>
99
+
100
+ <pre class="code ruby"><code class="ruby">$ rake</code></pre>
101
+
102
+ <p>Build gem:</p>
103
+
104
+ <pre class="code ruby"><code class="ruby">$ rake build</code></pre>
105
+
106
+ <p>Local install of gem build:</p>
107
+
108
+ <pre class="code ruby"><code class="ruby">$ rake install</code></pre>
109
+
110
+ <p>Add this line to your application&#39;s Gemfile:</p>
111
+
112
+ <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'>equationoftime</span><span class='tstring_end'>&#39;</span></span></code></pre>
113
+
114
+ <p>And then execute:</p>
115
+
116
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
117
+
118
+ <p>Or install it yourself as:</p>
119
+
120
+ <pre class="code ruby"><code class="ruby">$ gem install equationoftime</code></pre>
121
+
122
+ <h1 id="label-Usage%3A">Usage:</h1>
123
+
124
+ <pre class="code ruby"><code class="ruby">$ irb --simple-prompt
125
+
126
+ require &#39;eot&#39;
127
+ eot = Eot.new; &quot;note: nutation data loading is normal if you leave this off.&quot;
128
+ eot.string_eot()
129
+ </code></pre>
130
+
131
+ <h1 id="label-Wikis"><a href="https://github.com/DouglasAllen/equationoftime-3.0.0/blob/master/wiki.md">Wikis</a></h1>
132
+
133
+ <p>Notes:</p>
134
+ <ol><li>
135
+ <p>for other time equations see:<a href="https://gist.github.com/2032003">gist
136
+ 2032003</a></p>
137
+ </li></ol>
138
+
139
+ <p>Suggestions:</p>
140
+ <ol><li>
141
+ <p><a
142
+ href="http://equationoftime.herokuapp.com/analemma">equationoftime.herokuapp.com/analemma</a>
143
+ Itererates through a years worth of dates and computes analemma data.</p>
144
+ </li><li>
145
+ <p>A file is included in examples named analemma_data_generator.rb and may
146
+ help you get started.</p>
147
+ </li><li>
148
+ <p>see the <a
149
+ href="https://github.com/DouglasAllen/Sinatra-projects/tree/master/astro_dog">astro
150
+ dog</a> project here and the web post of it on <a
151
+ href="http://equationoftime.herokuapp.com/">Heroku</a> for more info about
152
+ the Equation of Time.</p>
153
+ </li><li>
154
+ <p>see the wikis for more usage examples.</p>
155
+ </li></ol>
156
+
157
+ <p>Contributing:</p>
158
+ <ol><li>
159
+ <p>Fork it</p>
160
+ </li><li>
161
+ <p>Create your feature branch (<code>git checkout -b my-new-feature</code>)</p>
162
+ </li><li>
163
+ <p>Commit your changes (<code>git commit -am &quot;Added some
164
+ feature&quot;</code>)</p>
165
+ </li><li>
166
+ <p>Push to the branch (<code>git push origin my-new-feature</code>)</p>
167
+ </li><li>
168
+ <p>Create new Pull Request</p>
169
+ </li></ol>
170
+ </div></div>
171
+
172
+ <div id="footer">
173
+ Generated on Wed Aug 20 13:59:04 2014 by
174
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
175
+ 0.8.7.4 (ruby-2.1.2).
176
+ </div>
177
+
178
+ </body>
179
+ </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);