AlimentoSolete 1.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.
- checksums.yaml +7 -0
- data/.coveralls.yml +1 -0
- data/.rspec_status +46 -0
- data/Alimento.gemspec +40 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +95 -0
- data/Guardfile +82 -0
- data/LICENSE.txt +21 -0
- data/README.md +54 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/coverage/.last_run.json +5 -0
- data/coverage/.resultset.json +224 -0
- data/coverage/.resultset.json.lock +0 -0
- data/doc/ALU0101000756_ALIMENTO.html +133 -0
- data/doc/Alimento.html +1473 -0
- data/doc/AlimentoCategorizable.html +773 -0
- data/doc/GrupoAlimenticio.html +960 -0
- data/doc/Lista.html +1246 -0
- data/doc/Node.html +441 -0
- data/doc/Plato.html +1723 -0
- data/doc/_index.html +169 -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 +492 -0
- data/doc/file.README.html +162 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +162 -0
- data/doc/js/app.js +248 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +443 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/Alimento.rb +11 -0
- data/lib/alimento/Alimento.rb +79 -0
- data/lib/alimento/AlimentoCategorizable.rb +33 -0
- data/lib/alimento/GrupoAlimenticio.rb +49 -0
- data/lib/alimento/Lista.rb +110 -0
- data/lib/alimento/Plato.rb +157 -0
- data/lib/alimento/version.rb +19 -0
- metadata +185 -0
|
@@ -0,0 +1,162 @@
|
|
|
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.10
|
|
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> »
|
|
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-Alimento">Alimento</h1>
|
|
62
|
+
|
|
63
|
+
<p>La gema Alimento contiene la clase alimento, la cual permite la creación de
|
|
64
|
+
un objeto Alimento con un identificador literal y unas componentes basadas
|
|
65
|
+
en los glúcidos, lípidos y proteínas para gestionar las calorías
|
|
66
|
+
proporcionadas por este.</p>
|
|
67
|
+
|
|
68
|
+
<h2 id="label-Instalaci-C3-B3n">Instalación</h2>
|
|
69
|
+
|
|
70
|
+
<p>Añade esta línea a tu documento Gemgfile:</p>
|
|
71
|
+
|
|
72
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Alimento</span><span class='tstring_end'>'</span></span>
|
|
73
|
+
</code></pre>
|
|
74
|
+
|
|
75
|
+
<p>y ejecuta el comando:</p>
|
|
76
|
+
|
|
77
|
+
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
|
|
78
|
+
|
|
79
|
+
<p>O realiza una instalación directa con:</p>
|
|
80
|
+
|
|
81
|
+
<pre class="code ruby"><code class="ruby">$ gem install Alimento</code></pre>
|
|
82
|
+
|
|
83
|
+
<h2 id="label-Detalles+de+las+clases">Detalles de las clases</h2>
|
|
84
|
+
|
|
85
|
+
<h3 id="label-Alimento">Alimento</h3>
|
|
86
|
+
<ul><li>
|
|
87
|
+
<p>Creacion de Alimento: Alimento.new(Nombre, gr glúcidos, gr proteínas, gr
|
|
88
|
+
lípidos).</p>
|
|
89
|
+
</li><li>
|
|
90
|
+
<p>Tiene métodos para el acceso de lectura a los atributos <em>nombre</em>,
|
|
91
|
+
<em>glucidos</em>, <em>proteinas</em> y <em>lipidos</em>.</p>
|
|
92
|
+
</li><li>
|
|
93
|
+
<p>kcal: método para el cálculo. Devuelve el valor energético del alimento en
|
|
94
|
+
kilocalorías.</p>
|
|
95
|
+
</li><li>
|
|
96
|
+
<p>Es comparable</p>
|
|
97
|
+
</li><li>
|
|
98
|
+
<p>calculate_index: Tiene un metodo para calcular el indice glucemico</p>
|
|
99
|
+
</li></ul>
|
|
100
|
+
|
|
101
|
+
<h3 id="label-AlimentoCategorizable">AlimentoCategorizable</h3>
|
|
102
|
+
<ul><li>
|
|
103
|
+
<p>Creacion de AlimentoCategorizable: AlimentoCategorizable.new(Nombre,
|
|
104
|
+
categoria, gr glúcidos, gr proteínas, gr lípidos)</p>
|
|
105
|
+
</li><li>
|
|
106
|
+
<p>Hereda la funcionalidad de Alimento</p>
|
|
107
|
+
</li><li>
|
|
108
|
+
<p>Tiene un atributo <em>categoria</em>, su grupo alimenticio, y métodos para
|
|
109
|
+
su acceso de lectura</p>
|
|
110
|
+
</li></ul>
|
|
111
|
+
|
|
112
|
+
<h3 id="label-Node">Node</h3>
|
|
113
|
+
<ul><li>
|
|
114
|
+
<p>Creacion de Node: Node.new(valor, nodo siguiente, nodo previo).</p>
|
|
115
|
+
</li><li>
|
|
116
|
+
<p>Tiene métodos de acceso y modificación de los atributos <em>value</em>,
|
|
117
|
+
<em>next</em> y <em>prev</em>.</p>
|
|
118
|
+
</li></ul>
|
|
119
|
+
|
|
120
|
+
<h3 id="label-Lista">Lista</h3>
|
|
121
|
+
<ul><li>
|
|
122
|
+
<p>Creacion de Lista: Lista.new()</p>
|
|
123
|
+
</li><li>
|
|
124
|
+
<p>Tiene métodos de acceso para sus atributos <em>head</em> y <em>tail</em>,
|
|
125
|
+
lo que permite hacer comprobación del contenido previa sustracción o
|
|
126
|
+
inserción.</p>
|
|
127
|
+
</li><li>
|
|
128
|
+
<p>Tiene métodos para la extracción (<em>pop_head</em>, <em>pop_tail</em>)
|
|
129
|
+
para eliminar un nodo de la lista y obtener su contenido (su valor
|
|
130
|
+
Node.value).</p>
|
|
131
|
+
</li><li>
|
|
132
|
+
<p>Tiene métodos para la inserción de elementos (<em>push_head(x)</em>,
|
|
133
|
+
<em>push_tail</em>) para la inclusión de un nodo en la lista.</p>
|
|
134
|
+
</li><li>
|
|
135
|
+
<p>Es enumerable</p>
|
|
136
|
+
</li></ul>
|
|
137
|
+
|
|
138
|
+
<h3 id="label-GrupoAlimenticio">GrupoAlimenticio</h3>
|
|
139
|
+
<ul><li>
|
|
140
|
+
<p>Creacion de GrupoAlimenticio: GrupoAlimenticio.new(Categoria).</p>
|
|
141
|
+
</li><li>
|
|
142
|
+
<p>Hereda su funcionalidad de la lista</p>
|
|
143
|
+
</li><li>
|
|
144
|
+
<p>Tiene un atributo <em>categoria</em> que define la categoria de los
|
|
145
|
+
alimentos que se meten en la lista, y su método de lectura</p>
|
|
146
|
+
</li></ul>
|
|
147
|
+
|
|
148
|
+
<h2 id="label-Licencia">Licencia</h2>
|
|
149
|
+
|
|
150
|
+
<p>La gema está disponible como código abierto bajo los términos de la <a
|
|
151
|
+
href="http://opensource.org/licenses/MIT">Licencia MIT</a>.</p>
|
|
152
|
+
</div></div>
|
|
153
|
+
|
|
154
|
+
<div id="footer">
|
|
155
|
+
Generated on Tue Dec 12 21:38:03 2017 by
|
|
156
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
157
|
+
0.9.10 (ruby-2.3.0).
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
</div>
|
|
161
|
+
</body>
|
|
162
|
+
</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.10</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,162 @@
|
|
|
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.10
|
|
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> »
|
|
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-Alimento">Alimento</h1>
|
|
62
|
+
|
|
63
|
+
<p>La gema Alimento contiene la clase alimento, la cual permite la creación de
|
|
64
|
+
un objeto Alimento con un identificador literal y unas componentes basadas
|
|
65
|
+
en los glúcidos, lípidos y proteínas para gestionar las calorías
|
|
66
|
+
proporcionadas por este.</p>
|
|
67
|
+
|
|
68
|
+
<h2 id="label-Instalaci-C3-B3n">Instalación</h2>
|
|
69
|
+
|
|
70
|
+
<p>Añade esta línea a tu documento Gemgfile:</p>
|
|
71
|
+
|
|
72
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Alimento</span><span class='tstring_end'>'</span></span>
|
|
73
|
+
</code></pre>
|
|
74
|
+
|
|
75
|
+
<p>y ejecuta el comando:</p>
|
|
76
|
+
|
|
77
|
+
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
|
|
78
|
+
|
|
79
|
+
<p>O realiza una instalación directa con:</p>
|
|
80
|
+
|
|
81
|
+
<pre class="code ruby"><code class="ruby">$ gem install Alimento</code></pre>
|
|
82
|
+
|
|
83
|
+
<h2 id="label-Detalles+de+las+clases">Detalles de las clases</h2>
|
|
84
|
+
|
|
85
|
+
<h3 id="label-Alimento">Alimento</h3>
|
|
86
|
+
<ul><li>
|
|
87
|
+
<p>Creacion de Alimento: Alimento.new(Nombre, gr glúcidos, gr proteínas, gr
|
|
88
|
+
lípidos).</p>
|
|
89
|
+
</li><li>
|
|
90
|
+
<p>Tiene métodos para el acceso de lectura a los atributos <em>nombre</em>,
|
|
91
|
+
<em>glucidos</em>, <em>proteinas</em> y <em>lipidos</em>.</p>
|
|
92
|
+
</li><li>
|
|
93
|
+
<p>kcal: método para el cálculo. Devuelve el valor energético del alimento en
|
|
94
|
+
kilocalorías.</p>
|
|
95
|
+
</li><li>
|
|
96
|
+
<p>Es comparable</p>
|
|
97
|
+
</li><li>
|
|
98
|
+
<p>calculate_index: Tiene un metodo para calcular el indice glucemico</p>
|
|
99
|
+
</li></ul>
|
|
100
|
+
|
|
101
|
+
<h3 id="label-AlimentoCategorizable">AlimentoCategorizable</h3>
|
|
102
|
+
<ul><li>
|
|
103
|
+
<p>Creacion de AlimentoCategorizable: AlimentoCategorizable.new(Nombre,
|
|
104
|
+
categoria, gr glúcidos, gr proteínas, gr lípidos)</p>
|
|
105
|
+
</li><li>
|
|
106
|
+
<p>Hereda la funcionalidad de Alimento</p>
|
|
107
|
+
</li><li>
|
|
108
|
+
<p>Tiene un atributo <em>categoria</em>, su grupo alimenticio, y métodos para
|
|
109
|
+
su acceso de lectura</p>
|
|
110
|
+
</li></ul>
|
|
111
|
+
|
|
112
|
+
<h3 id="label-Node">Node</h3>
|
|
113
|
+
<ul><li>
|
|
114
|
+
<p>Creacion de Node: Node.new(valor, nodo siguiente, nodo previo).</p>
|
|
115
|
+
</li><li>
|
|
116
|
+
<p>Tiene métodos de acceso y modificación de los atributos <em>value</em>,
|
|
117
|
+
<em>next</em> y <em>prev</em>.</p>
|
|
118
|
+
</li></ul>
|
|
119
|
+
|
|
120
|
+
<h3 id="label-Lista">Lista</h3>
|
|
121
|
+
<ul><li>
|
|
122
|
+
<p>Creacion de Lista: Lista.new()</p>
|
|
123
|
+
</li><li>
|
|
124
|
+
<p>Tiene métodos de acceso para sus atributos <em>head</em> y <em>tail</em>,
|
|
125
|
+
lo que permite hacer comprobación del contenido previa sustracción o
|
|
126
|
+
inserción.</p>
|
|
127
|
+
</li><li>
|
|
128
|
+
<p>Tiene métodos para la extracción (<em>pop_head</em>, <em>pop_tail</em>)
|
|
129
|
+
para eliminar un nodo de la lista y obtener su contenido (su valor
|
|
130
|
+
Node.value).</p>
|
|
131
|
+
</li><li>
|
|
132
|
+
<p>Tiene métodos para la inserción de elementos (<em>push_head(x)</em>,
|
|
133
|
+
<em>push_tail</em>) para la inclusión de un nodo en la lista.</p>
|
|
134
|
+
</li><li>
|
|
135
|
+
<p>Es enumerable</p>
|
|
136
|
+
</li></ul>
|
|
137
|
+
|
|
138
|
+
<h3 id="label-GrupoAlimenticio">GrupoAlimenticio</h3>
|
|
139
|
+
<ul><li>
|
|
140
|
+
<p>Creacion de GrupoAlimenticio: GrupoAlimenticio.new(Categoria).</p>
|
|
141
|
+
</li><li>
|
|
142
|
+
<p>Hereda su funcionalidad de la lista</p>
|
|
143
|
+
</li><li>
|
|
144
|
+
<p>Tiene un atributo <em>categoria</em> que define la categoria de los
|
|
145
|
+
alimentos que se meten en la lista, y su método de lectura</p>
|
|
146
|
+
</li></ul>
|
|
147
|
+
|
|
148
|
+
<h2 id="label-Licencia">Licencia</h2>
|
|
149
|
+
|
|
150
|
+
<p>La gema está disponible como código abierto bajo los términos de la <a
|
|
151
|
+
href="http://opensource.org/licenses/MIT">Licencia MIT</a>.</p>
|
|
152
|
+
</div></div>
|
|
153
|
+
|
|
154
|
+
<div id="footer">
|
|
155
|
+
Generated on Tue Dec 12 21:38:03 2017 by
|
|
156
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
157
|
+
0.9.10 (ruby-2.3.0).
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
</div>
|
|
161
|
+
</body>
|
|
162
|
+
</html>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,248 @@
|
|
|
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 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
|
+
var hash = window.location.hash;
|
|
228
|
+
if (hash !== '' && $(hash)[0]) {
|
|
229
|
+
$(hash)[0].scrollIntoView();
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
$(document).ready(function() {
|
|
236
|
+
navResizer();
|
|
237
|
+
navExpander();
|
|
238
|
+
createSourceLinks();
|
|
239
|
+
createDefineLinks();
|
|
240
|
+
createFullTreeLinks();
|
|
241
|
+
searchFrameButtons();
|
|
242
|
+
linkSummaries();
|
|
243
|
+
summaryToggle();
|
|
244
|
+
generateTOC();
|
|
245
|
+
mainFocus();
|
|
246
|
+
});
|
|
247
|
+
|
|
248
|
+
})();
|