mailer 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (30) hide show
  1. data/.gitignore +24 -0
  2. data/Gemfile +13 -0
  3. data/LICENSE +22 -0
  4. data/README.md +76 -0
  5. data/Rakefile +5 -0
  6. data/doc/Mailer.html +152 -0
  7. data/doc/Mailer/Client.html +481 -0
  8. data/doc/Mailer/Config.html +511 -0
  9. data/doc/_index.html +132 -0
  10. data/doc/class_list.html +53 -0
  11. data/doc/css/common.css +1 -0
  12. data/doc/css/full_list.css +57 -0
  13. data/doc/css/style.css +328 -0
  14. data/doc/file.README.html +160 -0
  15. data/doc/file_list.html +55 -0
  16. data/doc/frames.html +28 -0
  17. data/doc/index.html +160 -0
  18. data/doc/js/app.js +208 -0
  19. data/doc/js/full_list.js +173 -0
  20. data/doc/js/jquery.js +4 -0
  21. data/doc/method_list.html +116 -0
  22. data/doc/top-level-namespace.html +112 -0
  23. data/lib/mailer.rb +7 -0
  24. data/lib/mailer/client.rb +61 -0
  25. data/lib/mailer/config.rb +46 -0
  26. data/lib/mailer/version.rb +3 -0
  27. data/mailer.gemspec +20 -0
  28. data/test/mailer/client_test.rb +72 -0
  29. data/test/test_helper.rb +2 -0
  30. metadata +109 -0
data/doc/file.README.html ADDED
@@ -0,0 +1,160 @@
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.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" 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'><h1>Mailer</h1>
65
+
66
+ <p>Гем для создания листов рассылки, подписывания пользователей на них и отправки писем в рассылку</p>
67
+
68
+ <h2>Установка</h2>
69
+
70
+ <p>Добавить в Gemfile строки:</p>
71
+
72
+ <pre class="code ruby"><code><span class='id identifier rubyid_source'>source</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://gems.undev.cc</span><span class='tstring_end'>&quot;</span></span>
73
+ <span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mailer</span><span class='tstring_end'>'</span></span>
74
+ </code></pre>
75
+
76
+ <p>Затем запустить:</p>
77
+
78
+ <pre class="code ruby"><code>$ bundle
79
+ </code></pre>
80
+
81
+ <h2>Использование</h2>
82
+
83
+ <h3>Настройка</h3>
84
+
85
+ <p>Для работы гема требуется указать <code>api_token</code> и <code>api_domain</code> с помощью файла конфигурации</p>
86
+
87
+ <pre class="code ruby"><code><span class='comment'>#config/initializers/mailer.rb
88
+ </span><span class='const'>Mailer</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
89
+ <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_token'>api_token</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>API_TOKEN</span><span class='tstring_end'>'</span></span>
90
+ <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_domain'>api_domain</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://mailer.st2.ul.home/</span><span class='tstring_end'>'</span></span> <span class='comment'># Staging
91
+ </span><span class='kw'>end</span>
92
+ </code></pre>
93
+
94
+ <h3>Создание рассылки</h3>
95
+
96
+ <p>Для создания рассылки необходимы два параметра:</p>
97
+
98
+ <ul>
99
+ <li><code>name</code> - название рассылки</li>
100
+ <li><code>id</code> - ваш идентификатор рассылки по которому она будет идентифицироватся в дальнейшем для подписок пользователей и рассылки писем</li>
101
+ </ul>
102
+
103
+ <p>Пример:</p>
104
+
105
+ <pre class="code ruby"><code><span class='const'>Mailer</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:api_token</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>API_TOKEN</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>
106
+ </span><span class='id identifier rubyid_ .create_maillist'> .create_maillist</span><span class='lparen'>(</span>
107
+ <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_list</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
108
+ <span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>New mailist name</span><span class='tstring_end'>'</span></span>
109
+ <span class='rparen'>)</span>
110
+ </code></pre>
111
+
112
+ <h3>Подписка пользователя на рассылку</h3>
113
+
114
+ <p>Необходимые параметры</p>
115
+
116
+ <ul>
117
+ <li><code>id</code> - ваш идентификатор рассылки</li>
118
+ <li><code>email</code> - email пользователя</li>
119
+ </ul>
120
+
121
+ <p>Пример:</p>
122
+
123
+ <pre class="code ruby"><code><span class='const'>Mailer</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:api_token</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>API_TOKEN</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>
124
+ </span><span class='id identifier rubyid_ .subscribe_user'> .subscribe_user</span><span class='lparen'>(</span>
125
+ <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_list</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
126
+ <span class='symbol'>:email</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>user@example.com</span><span class='tstring_end'>'</span></span>
127
+ <span class='rparen'>)</span>
128
+ </code></pre>
129
+
130
+ <h3>Отправка сообщения в рассылку</h3>
131
+
132
+ <p>Аттрибуты письма:</p>
133
+
134
+ <ul>
135
+ <li><code>id</code> - идентификатор рассылки</li>
136
+ <li><code>subject</code> - заголовок письма</li>
137
+ <li><code>body</code> - тело письма</li>
138
+ <li><code>reply_name</code> - имя отправителя</li>
139
+ <li><code>reply_email</code> - email отправителя</li>
140
+ </ul>
141
+
142
+ <p>Пример:</p>
143
+
144
+ <pre class="code ruby"><code><span class='const'>Mailer</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:api_token</span> <span class='op'>=&gt;</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>API_TOKEN</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>
145
+ </span><span class='id identifier rubyid_ .send_letter'> .send_letter</span><span class='lparen'>(</span>
146
+ <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_list</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
147
+ <span class='symbol'>:subject</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>My spam</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
148
+ <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Меня зовут Бакаре Тунде, я брат первого нигерийского космонавта...</span><span class='tstring_end'>'</span></span>
149
+ <span class='rparen'>)</span>
150
+ </code></pre>
151
+ </div></div>
152
+
153
+ <div id="footer">
154
+ Generated on Tue May 29 13:58:48 2012 by
155
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
156
+ 0.8.1 (ruby-1.9.3).
157
+ </div>
158
+
159
+ </body>
160
+ </html>
data/doc/file_list.html ADDED
@@ -0,0 +1,55 @@
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
+ <base id="base_target" target="_parent" />
19
+ </head>
20
+ <body>
21
+ <script type="text/javascript" charset="utf-8">
22
+ if (window.top.frames.main) {
23
+ document.getElementById('base_target').target = 'main';
24
+ document.body.className = 'frames';
25
+ }
26
+ </script>
27
+ <div id="content">
28
+ <h1 id="full_list_header">File List</h1>
29
+ <div id="nav">
30
+
31
+ <span><a target="_self" href="class_list.html">
32
+ Classes
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="method_list.html">
36
+ Methods
37
+ </a></span>
38
+
39
+ <span><a target="_self" href="file_list.html">
40
+ Files
41
+ </a></span>
42
+
43
+ </div>
44
+ <div id="search">Search: <input type="text" /></div>
45
+
46
+ <ul id="full_list" class="file">
47
+
48
+
49
+ <li class="r1"><a href="index.html" title="README">README</a></li>
50
+
51
+
52
+ </ul>
53
+ </div>
54
+ </body>
55
+ </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.1</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,160 @@
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.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" 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'><h1>Mailer</h1>
65
+
66
+ <p>Гем для создания листов рассылки, подписывания пользователей на них и отправки писем в рассылку</p>
67
+
68
+ <h2>Установка</h2>
69
+
70
+ <p>Добавить в Gemfile строки:</p>
71
+
72
+ <pre class="code ruby"><code><span class='id identifier rubyid_source'>source</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://gems.undev.cc</span><span class='tstring_end'>&quot;</span></span>
73
+ <span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mailer</span><span class='tstring_end'>'</span></span>
74
+ </code></pre>
75
+
76
+ <p>Затем запустить:</p>
77
+
78
+ <pre class="code ruby"><code>$ bundle
79
+ </code></pre>
80
+
81
+ <h2>Использование</h2>
82
+
83
+ <h3>Настройка</h3>
84
+
85
+ <p>Для работы гема требуется указать <code>api_token</code> и <code>api_domain</code> с помощью файла конфигурации</p>
86
+
87
+ <pre class="code ruby"><code><span class='comment'>#config/initializers/mailer.rb
88
+ </span><span class='const'>Mailer</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
89
+ <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_token'>api_token</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>API_TOKEN</span><span class='tstring_end'>'</span></span>
90
+ <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_domain'>api_domain</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://mailer.st2.ul.home/</span><span class='tstring_end'>'</span></span> <span class='comment'># Staging
91
+ </span><span class='kw'>end</span>
92
+ </code></pre>
93
+
94
+ <h3>Создание рассылки</h3>
95
+
96
+ <p>Для создания рассылки необходимы два параметра:</p>
97
+
98
+ <ul>
99
+ <li><code>name</code> - название рассылки</li>
100
+ <li><code>id</code> - ваш идентификатор рассылки по которому она будет идентифицироватся в дальнейшем для подписок пользователей и рассылки писем</li>
101
+ </ul>
102
+
103
+ <p>Пример:</p>
104
+
105
+ <pre class="code ruby"><code><span class='const'>Mailer</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:api_token</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>API_TOKEN</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>
106
+ </span><span class='id identifier rubyid_ .create_maillist'> .create_maillist</span><span class='lparen'>(</span>
107
+ <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_list</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
108
+ <span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>New mailist name</span><span class='tstring_end'>'</span></span>
109
+ <span class='rparen'>)</span>
110
+ </code></pre>
111
+
112
+ <h3>Подписка пользователя на рассылку</h3>
113
+
114
+ <p>Необходимые параметры</p>
115
+
116
+ <ul>
117
+ <li><code>id</code> - ваш идентификатор рассылки</li>
118
+ <li><code>email</code> - email пользователя</li>
119
+ </ul>
120
+
121
+ <p>Пример:</p>
122
+
123
+ <pre class="code ruby"><code><span class='const'>Mailer</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:api_token</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>API_TOKEN</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>
124
+ </span><span class='id identifier rubyid_ .subscribe_user'> .subscribe_user</span><span class='lparen'>(</span>
125
+ <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_list</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
126
+ <span class='symbol'>:email</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>user@example.com</span><span class='tstring_end'>'</span></span>
127
+ <span class='rparen'>)</span>
128
+ </code></pre>
129
+
130
+ <h3>Отправка сообщения в рассылку</h3>
131
+
132
+ <p>Аттрибуты письма:</p>
133
+
134
+ <ul>
135
+ <li><code>id</code> - идентификатор рассылки</li>
136
+ <li><code>subject</code> - заголовок письма</li>
137
+ <li><code>body</code> - тело письма</li>
138
+ <li><code>reply_name</code> - имя отправителя</li>
139
+ <li><code>reply_email</code> - email отправителя</li>
140
+ </ul>
141
+
142
+ <p>Пример:</p>
143
+
144
+ <pre class="code ruby"><code><span class='const'>Mailer</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:api_token</span> <span class='op'>=&gt;</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>API_TOKEN</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>
145
+ </span><span class='id identifier rubyid_ .send_letter'> .send_letter</span><span class='lparen'>(</span>
146
+ <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_list</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
147
+ <span class='symbol'>:subject</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>My spam</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
148
+ <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Меня зовут Бакаре Тунде, я брат первого нигерийского космонавта...</span><span class='tstring_end'>'</span></span>
149
+ <span class='rparen'>)</span>
150
+ </code></pre>
151
+ </div></div>
152
+
153
+ <div id="footer">
154
+ Generated on Tue May 29 13:58:48 2012 by
155
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
156
+ 0.8.1 (ruby-1.9.3).
157
+ </div>
158
+
159
+ </body>
160
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,208 @@
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
+ localStorage.summaryCollapsed = $(this).text();
107
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
108
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
109
+ if (next.hasClass('compact')) {
110
+ next.toggle();
111
+ next.nextAll('ul.summary').first().toggle();
112
+ }
113
+ else if (next.hasClass('summary')) {
114
+ var list = $('<ul class="summary compact" />');
115
+ list.html(next.html());
116
+ list.find('.summary_desc, .note').remove();
117
+ list.find('a').each(function() {
118
+ $(this).html($(this).find('strong').html());
119
+ $(this).parent().html($(this)[0].outerHTML);
120
+ });
121
+ next.before(list);
122
+ next.toggle();
123
+ }
124
+ return false;
125
+ });
126
+ if (localStorage) {
127
+ if (localStorage.summaryCollapsed == "collapse") $('.summary_toggle').click();
128
+ else localStorage.summaryCollapsed = "expand";
129
+ }
130
+ }
131
+
132
+ function fixOutsideWorldLinks() {
133
+ $('a').each(function() {
134
+ if (window.location.host != this.host) this.target = '_parent';
135
+ });
136
+ }
137
+
138
+ function generateTOC() {
139
+ if ($('#filecontents').length === 0) return;
140
+ var _toc = $('<ol class="top"></ol>');
141
+ var show = false;
142
+ var toc = _toc;
143
+ var counter = 0;
144
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
145
+ var i;
146
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
147
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
148
+ var lastTag = parseInt(tags[0][1], 10);
149
+ $(tags.join(', ')).each(function() {
150
+ if ($(this).parents('.method_details .docstring').length != 0) return;
151
+ if (this.id == "filecontents") return;
152
+ show = true;
153
+ var thisTag = parseInt(this.tagName[1], 10);
154
+ if (this.id.length === 0) {
155
+ var proposedId = $(this).attr('toc-id');
156
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
157
+ else {
158
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
159
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
160
+ this.id = proposedId;
161
+ }
162
+ }
163
+ if (thisTag > lastTag) {
164
+ for (i = 0; i < thisTag - lastTag; i++) {
165
+ var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
166
+ }
167
+ }
168
+ if (thisTag < lastTag) {
169
+ for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
170
+ }
171
+ var title = $(this).attr('toc-title');
172
+ if (typeof(title) == "undefined") title = $(this).text();
173
+ toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
174
+ lastTag = thisTag;
175
+ });
176
+ if (!show) return;
177
+ 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>';
178
+ $('#content').prepend(html);
179
+ $('#toc').append(_toc);
180
+ $('#toc .hide_toc').toggle(function() {
181
+ $('#toc .top').slideUp('fast');
182
+ $('#toc').toggleClass('hidden');
183
+ $('#toc .title small').toggle();
184
+ }, function() {
185
+ $('#toc .top').slideDown('fast');
186
+ $('#toc').toggleClass('hidden');
187
+ $('#toc .title small').toggle();
188
+ });
189
+ $('#toc .float_toc').toggle(function() {
190
+ $(this).text('float');
191
+ $('#toc').toggleClass('nofloat');
192
+ }, function() {
193
+ $(this).text('left');
194
+ $('#toc').toggleClass('nofloat');
195
+ });
196
+ }
197
+
198
+ $(framesInit);
199
+ $(createSourceLinks);
200
+ $(createDefineLinks);
201
+ $(createFullTreeLinks);
202
+ $(fixBoxInfoHeights);
203
+ $(searchFrameLinks);
204
+ $(linkSummaries);
205
+ $(keyboardShortcuts);
206
+ $(summaryToggle);
207
+ $(fixOutsideWorldLinks);
208
+ $(generateTOC);