io_shuten 0.0.1.dev4 → 0.0.1.dev5
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.
- data/.travis.yml +5 -0
- data/.yardopts +0 -1
- data/Gemfile +1 -1
- data/Gemfile.lock +0 -3
- data/Rakefile +0 -6
- data/doc/IO_shuten.html +126 -0
- data/doc/IO_shuten/Base.html +2677 -0
- data/doc/IO_shuten/Base/FileAccessError.html +129 -0
- data/doc/IO_shuten/Base/FileNotFoundError.html +129 -0
- data/doc/IO_shuten/Base/NodeNameError.html +129 -0
- data/doc/IO_shuten/Base/NodeNotFoundError.html +129 -0
- data/doc/IO_shuten/Base/NotYetImplemented.html +129 -0
- data/doc/IO_shuten/Errors.html +119 -0
- data/doc/IO_shuten/Errors/FileAccessError.html +129 -0
- data/doc/IO_shuten/Errors/FileNotFoundError.html +129 -0
- data/doc/IO_shuten/Errors/NodeExistsError.html +129 -0
- data/doc/IO_shuten/Errors/NodeNameError.html +129 -0
- data/doc/IO_shuten/Errors/NodeNameExistsError.html +129 -0
- data/doc/IO_shuten/Errors/NodeNotFoundError.html +129 -0
- data/doc/IO_shuten/Errors/NotYetImplemented.html +129 -0
- data/doc/IO_shuten/Mongo.html +172 -0
- data/doc/IO_shuten/Redis.html +172 -0
- data/doc/IO_shuten/Stores.html +121 -0
- data/doc/IO_shuten/Stores/Mongo.html +121 -0
- data/doc/IO_shuten/Stores/Mongo/Collection.html +109 -0
- data/doc/IO_shuten/Stores/Mongo/GridFS.html +109 -0
- data/doc/IO_shuten/Stores/Redis.html +121 -0
- data/doc/IO_shuten/Stores/Redis/KeyValue.html +109 -0
- data/doc/IO_shuten/Stores/Redis/PubSub.html +109 -0
- data/doc/_index.html +318 -0
- data/doc/class_list.html +47 -0
- data/doc/css/blame.css +11 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.README.html +136 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +136 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +167 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +150 -0
- data/doc/top-level-namespace.html +105 -0
- data/io_shuten.gemspec +57 -10
- data/lib/io_shuten.rb +3 -1
- data/lib/io_shuten/base.rb +105 -67
- data/lib/io_shuten/errors.rb +42 -0
- data/lib/io_shuten/redis.rb +2 -0
- data/lib/io_shuten/stores.rb +11 -0
- data/lib/io_shuten/stores/mongo.rb +11 -0
- data/lib/io_shuten/stores/mongo/collection.rb +7 -0
- data/lib/io_shuten/stores/mongo/gridfs.rb +7 -0
- data/lib/io_shuten/stores/redis.rb +11 -0
- data/lib/io_shuten/stores/redis/key_value.rb +7 -0
- data/lib/io_shuten/stores/redis/pub_sub.rb +7 -0
- data/lib/io_shuten/version.rb +1 -1
- data/spec/lib/base_spec.rb +163 -73
- data/spec/lib/mongo_spec.rb +1 -1
- data/spec/lib/redis_spec.rb +1 -1
- data/spec/lib/stores/mongo/collection_spec.rb +7 -0
- data/spec/lib/stores/mongo/gridfs_spec.rb +7 -0
- data/spec/lib/stores/mongo_spec.rb +7 -0
- data/spec/lib/stores/redis/key_value_spec.rb +7 -0
- data/spec/lib/stores/redis/pub_sub_spec.rb +7 -0
- data/spec/lib/stores/redis_spec.rb +7 -0
- data/spec/lib/stores_spec.rb +7 -0
- data/spec/spec_helper.rb +9 -0
- metadata +90 -51
- data/.rdoc_options +0 -20
- data/.yardoc/checksums +0 -5
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
data/doc/file_list.html
ADDED
@@ -0,0 +1,49 @@
|
|
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
|
+
<a target="_self" href="class_list.html">Classes</a>
|
32
|
+
|
33
|
+
<a target="_self" href="method_list.html">Methods</a>
|
34
|
+
|
35
|
+
<a target="_self" href="file_list.html">Files</a>
|
36
|
+
|
37
|
+
</div>
|
38
|
+
<div id="search">Search: <input type="text" /></div>
|
39
|
+
|
40
|
+
<ul id="full_list" class="files">
|
41
|
+
|
42
|
+
|
43
|
+
<li class="r1"><a href="index.html" title="README">README</a></li>
|
44
|
+
|
45
|
+
|
46
|
+
</ul>
|
47
|
+
</div>
|
48
|
+
</body>
|
49
|
+
</html>
|
data/doc/frames.html
ADDED
@@ -0,0 +1,13 @@
|
|
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>IO::shuten 【五百::終点】</title>
|
8
|
+
</head>
|
9
|
+
<frameset cols="20%,*">
|
10
|
+
<frame name="list" src="class_list.html" />
|
11
|
+
<frame name="main" src="index.html" />
|
12
|
+
</frameset>
|
13
|
+
</html>
|
data/doc/index.html
ADDED
@@ -0,0 +1,136 @@
|
|
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
|
+
— IO::shuten 【五百::終点】
|
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
|
+
<link rel="stylesheet" href="css/blame.css" type="text/css" media="screen" charset="utf-8" />
|
18
|
+
|
19
|
+
<script type="text/javascript" charset="utf-8">
|
20
|
+
relpath = '';
|
21
|
+
if (relpath != '') relpath += '/';
|
22
|
+
</script>
|
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
|
+
<script type="text/javascript" charset="utf-8">
|
32
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
33
|
+
</script>
|
34
|
+
|
35
|
+
<div id="header">
|
36
|
+
<div id="menu">
|
37
|
+
|
38
|
+
<a href="_index.html" title="Index">Index</a> »
|
39
|
+
<span class="title">File: README</span>
|
40
|
+
|
41
|
+
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
43
|
+
</div>
|
44
|
+
|
45
|
+
<div id="search">
|
46
|
+
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
48
|
+
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
50
|
+
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
52
|
+
|
53
|
+
</div>
|
54
|
+
<div class="clear"></div>
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<iframe id="search_frame"></iframe>
|
58
|
+
|
59
|
+
<div id="content"><div id='filecontents'><h1>IO::shuten 【五百::終点】 <a href="http://travis-ci.org/asaaki/io_shuten"><img src="https://secure.travis-ci.org/asaaki/io_shuten.png" alt="Build Status"></a></h1>
|
60
|
+
|
61
|
+
<p>Use databases as IO handler like you would do with files and streams.</p>
|
62
|
+
|
63
|
+
<h2>Motivation</h2>
|
64
|
+
|
65
|
+
<p>One purpose for creating this project is to have an IO like interface to database storages.</p>
|
66
|
+
|
67
|
+
<p>With this gem you should have the possibility to use redis or mongodb as endpoints for IO related tasks like logging.</p>
|
68
|
+
|
69
|
+
<p>Example:</p>
|
70
|
+
|
71
|
+
<p>```ruby
|
72
|
+
require "io_shuten"
|
73
|
+
require "logger"</p>
|
74
|
+
|
75
|
+
<p>logdev = IO<em>shuten::Redis.new( REDIS</em>INSTANCE )
|
76
|
+
logger = Logger.new(logdev)</p>
|
77
|
+
|
78
|
+
<p>logger.info "This message will be stored in redis."
|
79
|
+
```</p>
|
80
|
+
|
81
|
+
<h2>IO::shuten? 【五百::終点】(io shūten)!</h2>
|
82
|
+
|
83
|
+
<p>In japanese <code>io</code> means <em>500</em> or <em>big amount</em>, <code>shū・ten</code> means <em>endpoint</em> (train terminus/last stop or mathematical endpoint).</p>
|
84
|
+
|
85
|
+
<h2>Types</h2>
|
86
|
+
|
87
|
+
<h3>IO_shuten::Base</h3>
|
88
|
+
|
89
|
+
<p>An in-memory storage system (handles simple StringIO objects).</p>
|
90
|
+
|
91
|
+
<p>Offers write-to-disk for single instance and all instances.</p>
|
92
|
+
|
93
|
+
<h3>IO_shuten::Redis</h3>
|
94
|
+
|
95
|
+
<p>Stores content in a redis database.</p>
|
96
|
+
|
97
|
+
<h3>IO_shuten::Mongo</h3>
|
98
|
+
|
99
|
+
<p>Stores content in a mongodb database.</p>
|
100
|
+
|
101
|
+
<h2>Not for production!</h2>
|
102
|
+
|
103
|
+
<p>This project is freshly started and currently not usable.</p>
|
104
|
+
|
105
|
+
<p>Everything can and maybe will change.</p>
|
106
|
+
|
107
|
+
<p>Feel free to contribute, write issues if you want to support me with your ideas and insights.</p>
|
108
|
+
|
109
|
+
<h2>git flowed</h2>
|
110
|
+
|
111
|
+
<p>Development will happen in the <code>develop</code> branch now, master should be in a deployable state.</p>
|
112
|
+
|
113
|
+
<p>Read more about <code>git flow</code> and the branchin model here:</p>
|
114
|
+
|
115
|
+
<ul>
|
116
|
+
<li>http://nvie.com/posts/a-successful-git-branching-model/</li>
|
117
|
+
<li>https://github.com/nvie/gitflow</li>
|
118
|
+
</ul>
|
119
|
+
|
120
|
+
<p>I like this approach and try to use it whenever possible, also in one-man-development.</p>
|
121
|
+
|
122
|
+
<h2>License</h2>
|
123
|
+
|
124
|
+
<p>This gem/software is licensed under MIT/X11 license. See <a href="https://raw.github.com/asaaki/io_shuten/develop/LICENSE">LICENSE</a> (or <a href="https://raw.github.com/asaaki/io_shuten/develop/LICENSE.de">LICENSE.de</a> for german translation).</p>
|
125
|
+
|
126
|
+
<p>— <a href="https://github.com/asaaki">Christoph 'asaaki' Grabo</a></p>
|
127
|
+
</div></div>
|
128
|
+
|
129
|
+
<div id="footer">
|
130
|
+
Generated on Mon Jan 23 01:15:28 2012 by
|
131
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
132
|
+
0.7.4 (ruby-1.9.3).
|
133
|
+
</div>
|
134
|
+
|
135
|
+
</body>
|
136
|
+
</html>
|
data/doc/js/app.js
ADDED
@@ -0,0 +1,205 @@
|
|
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
|
+
$('#method_list_link').click(function() {
|
53
|
+
toggleSearchFrame(this, relpath + 'method_list.html');
|
54
|
+
});
|
55
|
+
|
56
|
+
$('#class_list_link').click(function() {
|
57
|
+
toggleSearchFrame(this, relpath + 'class_list.html');
|
58
|
+
});
|
59
|
+
|
60
|
+
$('#file_list_link').click(function() {
|
61
|
+
toggleSearchFrame(this, relpath + 'file_list.html');
|
62
|
+
});
|
63
|
+
}
|
64
|
+
|
65
|
+
function toggleSearchFrame(id, link) {
|
66
|
+
var frame = $('#search_frame');
|
67
|
+
$('#search a').removeClass('active').addClass('inactive');
|
68
|
+
if (frame.attr('src') == link && frame.css('display') != "none") {
|
69
|
+
frame.slideUp(100);
|
70
|
+
$('#search a').removeClass('active inactive');
|
71
|
+
}
|
72
|
+
else {
|
73
|
+
$(id).addClass('active').removeClass('inactive');
|
74
|
+
frame.attr('src', link).slideDown(100);
|
75
|
+
}
|
76
|
+
}
|
77
|
+
|
78
|
+
function linkSummaries() {
|
79
|
+
$('.summary_signature').click(function() {
|
80
|
+
document.location = $(this).find('a').attr('href');
|
81
|
+
});
|
82
|
+
}
|
83
|
+
|
84
|
+
function framesInit() {
|
85
|
+
if (window.top.frames.main) {
|
86
|
+
document.body.className = 'frames';
|
87
|
+
$('#menu .noframes a').attr('href', document.location);
|
88
|
+
$('html head title', window.parent.document).text($('html head title').text());
|
89
|
+
}
|
90
|
+
}
|
91
|
+
|
92
|
+
function keyboardShortcuts() {
|
93
|
+
if (window.top.frames.main) return;
|
94
|
+
$(document).keypress(function(evt) {
|
95
|
+
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
96
|
+
if (typeof evt.target !== "undefined" &&
|
97
|
+
(evt.target.nodeName == "INPUT" ||
|
98
|
+
evt.target.nodeName == "TEXTAREA")) return;
|
99
|
+
switch (evt.charCode) {
|
100
|
+
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
101
|
+
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
102
|
+
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
103
|
+
default: break;
|
104
|
+
}
|
105
|
+
});
|
106
|
+
}
|
107
|
+
|
108
|
+
function summaryToggle() {
|
109
|
+
$('.summary_toggle').click(function() {
|
110
|
+
localStorage.summaryCollapsed = $(this).text();
|
111
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
112
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
113
|
+
if (next.hasClass('compact')) {
|
114
|
+
next.toggle();
|
115
|
+
next.nextAll('ul.summary').first().toggle();
|
116
|
+
}
|
117
|
+
else if (next.hasClass('summary')) {
|
118
|
+
var list = $('<ul class="summary compact" />');
|
119
|
+
list.html(next.html());
|
120
|
+
list.find('.summary_desc, .note').remove();
|
121
|
+
list.find('a').each(function() {
|
122
|
+
$(this).html($(this).find('strong').html());
|
123
|
+
$(this).parent().html($(this)[0].outerHTML);
|
124
|
+
});
|
125
|
+
next.before(list);
|
126
|
+
next.toggle();
|
127
|
+
}
|
128
|
+
return false;
|
129
|
+
});
|
130
|
+
if (localStorage) {
|
131
|
+
if (localStorage.summaryCollapsed == "collapse") $('.summary_toggle').click();
|
132
|
+
else localStorage.summaryCollapsed = "expand";
|
133
|
+
}
|
134
|
+
}
|
135
|
+
|
136
|
+
function fixOutsideWorldLinks() {
|
137
|
+
$('a').each(function() {
|
138
|
+
if (window.location.host != this.host) this.target = '_parent';
|
139
|
+
});
|
140
|
+
}
|
141
|
+
|
142
|
+
function generateTOC() {
|
143
|
+
if ($('#filecontents').length === 0) return;
|
144
|
+
var _toc = $('<ol class="top"></ol>');
|
145
|
+
var show = false;
|
146
|
+
var toc = _toc;
|
147
|
+
var counter = 0;
|
148
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
149
|
+
var i;
|
150
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
151
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
152
|
+
var lastTag = parseInt(tags[0][1], 10);
|
153
|
+
$(tags.join(', ')).each(function() {
|
154
|
+
if (this.id == "filecontents") return;
|
155
|
+
show = true;
|
156
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
157
|
+
if (this.id.length === 0) {
|
158
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
159
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
160
|
+
this.id = proposedId;
|
161
|
+
}
|
162
|
+
if (thisTag > lastTag) {
|
163
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
164
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
165
|
+
}
|
166
|
+
}
|
167
|
+
if (thisTag < lastTag) {
|
168
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
169
|
+
}
|
170
|
+
toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
|
171
|
+
lastTag = thisTag;
|
172
|
+
});
|
173
|
+
if (!show) return;
|
174
|
+
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>';
|
175
|
+
$('#content').prepend(html);
|
176
|
+
$('#toc').append(_toc);
|
177
|
+
$('#toc .hide_toc').toggle(function() {
|
178
|
+
$('#toc .top').slideUp('fast');
|
179
|
+
$('#toc').toggleClass('hidden');
|
180
|
+
$('#toc .title small').toggle();
|
181
|
+
}, function() {
|
182
|
+
$('#toc .top').slideDown('fast');
|
183
|
+
$('#toc').toggleClass('hidden');
|
184
|
+
$('#toc .title small').toggle();
|
185
|
+
});
|
186
|
+
$('#toc .float_toc').toggle(function() {
|
187
|
+
$(this).text('float');
|
188
|
+
$('#toc').toggleClass('nofloat');
|
189
|
+
}, function() {
|
190
|
+
$(this).text('left');
|
191
|
+
$('#toc').toggleClass('nofloat');
|
192
|
+
});
|
193
|
+
}
|
194
|
+
|
195
|
+
$(framesInit);
|
196
|
+
$(createSourceLinks);
|
197
|
+
$(createDefineLinks);
|
198
|
+
$(createFullTreeLinks);
|
199
|
+
$(fixBoxInfoHeights);
|
200
|
+
$(searchFrameLinks);
|
201
|
+
$(linkSummaries);
|
202
|
+
$(keyboardShortcuts);
|
203
|
+
$(summaryToggle);
|
204
|
+
$(fixOutsideWorldLinks);
|
205
|
+
$(generateTOC);
|
data/doc/js/full_list.js
ADDED
@@ -0,0 +1,167 @@
|
|
1
|
+
var inSearch = null;
|
2
|
+
var searchIndex = 0;
|
3
|
+
var searchCache = [];
|
4
|
+
var searchString = '';
|
5
|
+
var regexSearchString = '';
|
6
|
+
var caseSensitiveMatch = false;
|
7
|
+
|
8
|
+
RegExp.escape = function(text) {
|
9
|
+
return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
|
10
|
+
}
|
11
|
+
|
12
|
+
function fullListSearch() {
|
13
|
+
// generate cache
|
14
|
+
searchCache = [];
|
15
|
+
$('#full_list li').each(function() {
|
16
|
+
var link = $(this).find('.object_link a');
|
17
|
+
var fullName = link.attr('title').split(' ')[0];
|
18
|
+
searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
|
19
|
+
});
|
20
|
+
|
21
|
+
$('#search input').keyup(function() {
|
22
|
+
searchString = this.value;
|
23
|
+
caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
|
24
|
+
regexSearchString = RegExp.escape(searchString);
|
25
|
+
if (caseSensitiveMatch) {
|
26
|
+
regexSearchString += "|" +
|
27
|
+
$.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
|
28
|
+
join('.+?');
|
29
|
+
}
|
30
|
+
if (searchString === "") {
|
31
|
+
clearTimeout(inSearch);
|
32
|
+
inSearch = null;
|
33
|
+
$('ul .search_uncollapsed').removeClass('search_uncollapsed');
|
34
|
+
$('#full_list, #content').removeClass('insearch');
|
35
|
+
$('#full_list li').removeClass('found').each(function() {
|
36
|
+
|
37
|
+
var link = $(this).find('.object_link a');
|
38
|
+
link.text(link.text());
|
39
|
+
});
|
40
|
+
if (clicked) {
|
41
|
+
clicked.parents('ul').each(function() {
|
42
|
+
$(this).removeClass('collapsed').prev().removeClass('collapsed');
|
43
|
+
});
|
44
|
+
}
|
45
|
+
highlight();
|
46
|
+
}
|
47
|
+
else {
|
48
|
+
if (inSearch) clearTimeout(inSearch);
|
49
|
+
searchIndex = 0;
|
50
|
+
lastRowClass = '';
|
51
|
+
$('#full_list, #content').addClass('insearch');
|
52
|
+
$('#noresults').text('');
|
53
|
+
searchItem();
|
54
|
+
}
|
55
|
+
});
|
56
|
+
|
57
|
+
$('#search input').focus();
|
58
|
+
$('#full_list').after("<div id='noresults'></div>");
|
59
|
+
}
|
60
|
+
|
61
|
+
var lastRowClass = '';
|
62
|
+
function searchItem() {
|
63
|
+
for (var i = 0; i < searchCache.length / 50; i++) {
|
64
|
+
var item = searchCache[searchIndex];
|
65
|
+
var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
|
66
|
+
var matchString = regexSearchString;
|
67
|
+
var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
|
68
|
+
if (searchName.match(matchRegexp) == null) {
|
69
|
+
item.node.removeClass('found');
|
70
|
+
}
|
71
|
+
else {
|
72
|
+
item.node.css('padding-left', '10px').addClass('found');
|
73
|
+
item.node.parents().addClass('search_uncollapsed');
|
74
|
+
item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
|
75
|
+
lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
|
76
|
+
item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
|
77
|
+
}
|
78
|
+
|
79
|
+
if (searchCache.length === searchIndex + 1) {
|
80
|
+
searchDone();
|
81
|
+
return;
|
82
|
+
}
|
83
|
+
else {
|
84
|
+
searchIndex++;
|
85
|
+
}
|
86
|
+
}
|
87
|
+
inSearch = setTimeout('searchItem()', 0);
|
88
|
+
}
|
89
|
+
|
90
|
+
function searchDone() {
|
91
|
+
highlight(true);
|
92
|
+
if ($('#full_list li:visible').size() === 0) {
|
93
|
+
$('#noresults').text('No results were found.').hide().fadeIn();
|
94
|
+
}
|
95
|
+
else {
|
96
|
+
$('#noresults').text('');
|
97
|
+
}
|
98
|
+
$('#content').removeClass('insearch');
|
99
|
+
clearTimeout(inSearch);
|
100
|
+
inSearch = null;
|
101
|
+
}
|
102
|
+
|
103
|
+
clicked = null;
|
104
|
+
function linkList() {
|
105
|
+
$('#full_list li, #full_list li a:last').click(function(evt) {
|
106
|
+
if ($(this).hasClass('toggle')) return true;
|
107
|
+
if (this.tagName.toLowerCase() == "li") {
|
108
|
+
var toggle = $(this).children('a.toggle');
|
109
|
+
if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
|
110
|
+
toggle.click();
|
111
|
+
return false;
|
112
|
+
}
|
113
|
+
}
|
114
|
+
if (clicked) clicked.removeClass('clicked');
|
115
|
+
var win = window.top.frames.main ? window.top.frames.main : window.parent;
|
116
|
+
if (this.tagName.toLowerCase() == "a") {
|
117
|
+
clicked = $(this).parent('li').addClass('clicked');
|
118
|
+
win.location = this.href;
|
119
|
+
}
|
120
|
+
else {
|
121
|
+
clicked = $(this).addClass('clicked');
|
122
|
+
win.location = $(this).find('a:last').attr('href');
|
123
|
+
}
|
124
|
+
return false;
|
125
|
+
});
|
126
|
+
}
|
127
|
+
|
128
|
+
function collapse() {
|
129
|
+
if (!$('#full_list').hasClass('class')) return;
|
130
|
+
$('#full_list.class a.toggle').click(function() {
|
131
|
+
$(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
|
132
|
+
highlight();
|
133
|
+
return false;
|
134
|
+
});
|
135
|
+
$('#full_list.class ul').each(function() {
|
136
|
+
$(this).addClass('collapsed').prev().addClass('collapsed');
|
137
|
+
});
|
138
|
+
$('#full_list.class').children().removeClass('collapsed');
|
139
|
+
highlight();
|
140
|
+
}
|
141
|
+
|
142
|
+
function highlight(no_padding) {
|
143
|
+
var n = 1;
|
144
|
+
$('#full_list li:visible').each(function() {
|
145
|
+
var next = n == 1 ? 2 : 1;
|
146
|
+
$(this).removeClass("r" + next).addClass("r" + n);
|
147
|
+
if (!no_padding && $('#full_list').hasClass('class')) {
|
148
|
+
$(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
|
149
|
+
}
|
150
|
+
n = next;
|
151
|
+
});
|
152
|
+
}
|
153
|
+
|
154
|
+
function escapeShortcut() {
|
155
|
+
$(document).keydown(function(evt) {
|
156
|
+
if (evt.which == 27) {
|
157
|
+
$('#search_frame', window.top.document).slideUp(100);
|
158
|
+
$('#search a', window.top.document).removeClass('active inactive');
|
159
|
+
$(window.top).focus();
|
160
|
+
}
|
161
|
+
});
|
162
|
+
}
|
163
|
+
|
164
|
+
$(escapeShortcut);
|
165
|
+
$(fullListSearch);
|
166
|
+
$(linkList);
|
167
|
+
$(collapse);
|