lims-core 3.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +15 -0
- data/.gitignore +5 -0
- data/.rspec +1 -0
- data/.rvmrc +2 -0
- data/.travis.yml +2 -0
- data/.vimrc +27 -0
- data/.yard_templates/default/layout/html/footer.erb +0 -0
- data/.yardopts +1 -0
- data/Gemfile +54 -0
- data/Gemfile.lock +197 -0
- data/Guardfile +21 -0
- data/Guardfile.tmux +28 -0
- data/README.markdown +67 -0
- data/Rakefile +16 -0
- data/config/database.yml +16 -0
- data/doc/Array.html +116 -0
- data/doc/Array/ArrayLoggerPersistor.html +152 -0
- data/doc/Lims.html +114 -0
- data/doc/Lims/Core.html +178 -0
- data/doc/Lims/Core/Action.html +91 -0
- data/doc/Lims/Core/Actions.html +116 -0
- data/doc/Lims/Core/Actions/Action.html +216 -0
- data/doc/Lims/Core/Actions/Action/AfterEval.html +853 -0
- data/doc/Lims/Core/Actions/Action/InvalidParameters.html +268 -0
- data/doc/Lims/Core/Actions/ActionGroup.html +196 -0
- data/doc/Lims/Core/Actions/ActionGroup/AfterEval.html +315 -0
- data/doc/Lims/Core/Actions/BulkAction.html +224 -0
- data/doc/Lims/Core/Actions/BulkAction/AfterEval.html +253 -0
- data/doc/Lims/Core/Actions/TestActionGroup.html +101 -0
- data/doc/Lims/Core/Actions/TestActionGroup/Action.html +133 -0
- data/doc/Lims/Core/Actions/TestActionGroup/ActionGroup.html +127 -0
- data/doc/Lims/Core/Base.html +287 -0
- data/doc/Lims/Core/Base/AccessibleViaSuper.html +252 -0
- data/doc/Lims/Core/Base/ClassMethod.html +177 -0
- data/doc/Lims/Core/Base/HashString.html +177 -0
- data/doc/Lims/Core/Base/IsArrayOf.html +606 -0
- data/doc/Lims/Core/Base/State.html +130 -0
- data/doc/Lims/Core/Organization.html +113 -0
- data/doc/Lims/Core/Organization/Batch.html +106 -0
- data/doc/Lims/Core/Persistence.html +267 -0
- data/doc/Lims/Core/Persistence/ComparisonFilter.html +318 -0
- data/doc/Lims/Core/Persistence/Filter.html +252 -0
- data/doc/Lims/Core/Persistence/IdentityMap.html +409 -0
- data/doc/Lims/Core/Persistence/IdentityMap/Class.html +144 -0
- data/doc/Lims/Core/Persistence/IdentityMap/DuplicateError.html +126 -0
- data/doc/Lims/Core/Persistence/IdentityMap/DuplicateIdError.html +136 -0
- data/doc/Lims/Core/Persistence/IdentityMap/DuplicateObjectError.html +136 -0
- data/doc/Lims/Core/Persistence/IdentityMapClass.html +133 -0
- data/doc/Lims/Core/Persistence/Logger.html +105 -0
- data/doc/Lims/Core/Persistence/Logger/Persistor.html +334 -0
- data/doc/Lims/Core/Persistence/Logger/Session.html +452 -0
- data/doc/Lims/Core/Persistence/Logger/Store.html +470 -0
- data/doc/Lims/Core/Persistence/MessageBus.html +871 -0
- data/doc/Lims/Core/Persistence/MessageBus/ConnectionError.html +123 -0
- data/doc/Lims/Core/Persistence/MessageBus/InvalidSettingsError.html +122 -0
- data/doc/Lims/Core/Persistence/MultiCriteriaFilter.html +293 -0
- data/doc/Lims/Core/Persistence/PersistAssociationTrait.html +91 -0
- data/doc/Lims/Core/Persistence/PersistableTrait.html +91 -0
- data/doc/Lims/Core/Persistence/Persistor.html +3072 -0
- data/doc/Lims/Core/Persistence/Persistor/DuplicateError.html +205 -0
- data/doc/Lims/Core/Persistence/Persistor/DuplicateIdError.html +147 -0
- data/doc/Lims/Core/Persistence/Persistor/DuplicateObjectError.html +147 -0
- data/doc/Lims/Core/Persistence/PersistorTrait.html +91 -0
- data/doc/Lims/Core/Persistence/ResourceState.html +1738 -0
- data/doc/Lims/Core/Persistence/Search.html +269 -0
- data/doc/Lims/Core/Persistence/Search/CreateSearch.html +251 -0
- data/doc/Lims/Core/Persistence/Search/SearchPersistor.html +240 -0
- data/doc/Lims/Core/Persistence/Search/SearchSequelPersistor.html +396 -0
- data/doc/Lims/Core/Persistence/Sequel.html +117 -0
- data/doc/Lims/Core/Persistence/Sequel/Filters.html +462 -0
- data/doc/Lims/Core/Persistence/Sequel/ForTest.html +101 -0
- data/doc/Lims/Core/Persistence/Sequel/ForTest/Name.html +137 -0
- data/doc/Lims/Core/Persistence/Sequel/ForTest/Name/NamePersitor.html +143 -0
- data/doc/Lims/Core/Persistence/Sequel/Migrations.html +266 -0
- data/doc/Lims/Core/Persistence/Sequel/Persistor.html +665 -0
- data/doc/Lims/Core/Persistence/Sequel/Session.html +501 -0
- data/doc/Lims/Core/Persistence/Sequel/Store.html +417 -0
- data/doc/Lims/Core/Persistence/Session.html +2751 -0
- data/doc/Lims/Core/Persistence/Session/UnmanagedObjectError.html +111 -0
- data/doc/Lims/Core/Persistence/StateGroup.html +696 -0
- data/doc/Lims/Core/Persistence/StateList.html +498 -0
- data/doc/Lims/Core/Persistence/Store.html +695 -0
- data/doc/Lims/Core/Persistence/UuidResource.html +1044 -0
- data/doc/Lims/Core/Persistence/UuidResource/InvalidUuidError.html +111 -0
- data/doc/Lims/Core/Persistence/UuidResource/UuidResourcePersistor.html +337 -0
- data/doc/Lims/Core/Persistence/Uuidable.html +799 -0
- data/doc/Lims/Core/Persistor.html +320 -0
- data/doc/Lims/Core/Resource.html +165 -0
- data/doc/Object.html +228 -0
- data/doc/SessionSpec.html +101 -0
- data/doc/SessionSpec/Model.html +279 -0
- data/doc/SessionSpec/Model/ModelPersistor.html +327 -0
- data/doc/_index.html +732 -0
- data/doc/class_list.html +47 -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 +127 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +127 -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 +1894 -0
- data/doc/top-level-namespace.html +100 -0
- data/lib/common.rb +18 -0
- data/lib/lims-core.rb +29 -0
- data/lib/lims-core/actions.rb +10 -0
- data/lib/lims-core/actions/action.rb +185 -0
- data/lib/lims-core/actions/action_group.rb +54 -0
- data/lib/lims-core/actions/bulk_action.rb +65 -0
- data/lib/lims-core/base.rb +132 -0
- data/lib/lims-core/helpers.rb +41 -0
- data/lib/lims-core/persistence.rb +15 -0
- data/lib/lims-core/persistence/comparison_filter.rb +54 -0
- data/lib/lims-core/persistence/filter.rb +23 -0
- data/lib/lims-core/persistence/identity_map.rb +55 -0
- data/lib/lims-core/persistence/logger/all.rb +5 -0
- data/lib/lims-core/persistence/logger/persistor.rb +35 -0
- data/lib/lims-core/persistence/logger/session.rb +30 -0
- data/lib/lims-core/persistence/logger/store.rb +37 -0
- data/lib/lims-core/persistence/message_bus.rb +131 -0
- data/lib/lims-core/persistence/multi_criteria_filter.rb +50 -0
- data/lib/lims-core/persistence/persist_association_trait.rb +96 -0
- data/lib/lims-core/persistence/persistable_trait.rb +150 -0
- data/lib/lims-core/persistence/persistor.rb +495 -0
- data/lib/lims-core/persistence/resource_state.rb +157 -0
- data/lib/lims-core/persistence/search.rb +3 -0
- data/lib/lims-core/persistence/search/all.rb +3 -0
- data/lib/lims-core/persistence/search/create_search.rb +55 -0
- data/lib/lims-core/persistence/search/search_persistor.rb +45 -0
- data/lib/lims-core/persistence/search/search_sequel_persistor.rb +40 -0
- data/lib/lims-core/persistence/sequel.rb +14 -0
- data/lib/lims-core/persistence/sequel/filters.rb +106 -0
- data/lib/lims-core/persistence/sequel/migrations.rb +14 -0
- data/lib/lims-core/persistence/sequel/migrations/add_audit_tables.rb +147 -0
- data/lib/lims-core/persistence/sequel/migrations/initial.rb +156 -0
- data/lib/lims-core/persistence/sequel/persistor.rb +200 -0
- data/lib/lims-core/persistence/sequel/session.rb +136 -0
- data/lib/lims-core/persistence/sequel/store.rb +37 -0
- data/lib/lims-core/persistence/session.rb +409 -0
- data/lib/lims-core/persistence/state_group.rb +97 -0
- data/lib/lims-core/persistence/state_list.rb +56 -0
- data/lib/lims-core/persistence/store.rb +73 -0
- data/lib/lims-core/persistence/uuid_resource.rb +115 -0
- data/lib/lims-core/persistence/uuid_resource_persistor.rb +43 -0
- data/lib/lims-core/persistence/uuidable.rb +107 -0
- data/lib/lims-core/resource.rb +21 -0
- data/lib/lims-core/subclass_tracker.rb +30 -0
- data/lib/lims-core/version.rb +5 -0
- data/lims-core.gemspec +40 -0
- data/makefile +52 -0
- data/showoff/core-2012-06-11/core/01_slide.md +237 -0
- data/showoff/core-2012-06-11/core/02_slide.md +110 -0
- data/showoff/core-2012-06-11/custom.css +44 -0
- data/showoff/core-2012-06-11/main/01_slide.md +53 -0
- data/showoff/core-2012-06-11/showoff.json +10 -0
- data/showoff/core-2012-06-11/tp1.tpl +1 -0
- data/spec/actions/action_group_spec.rb +39 -0
- data/spec/actions/spec_helper.rb +1 -0
- data/spec/persistence/identity_map_spec.rb +55 -0
- data/spec/persistence/logger/spec_helper.rb +7 -0
- data/spec/persistence/logger/store_spec.rb +48 -0
- data/spec/persistence/message_bus_spec.rb +76 -0
- data/spec/persistence/sequel/session_spec.rb +125 -0
- data/spec/persistence/sequel/spec_helper.rb +39 -0
- data/spec/persistence/sequel/store_shared.rb +25 -0
- data/spec/persistence/sequel/store_spec.rb +22 -0
- data/spec/persistence/session_spec.rb +199 -0
- data/spec/persistence/spec_helper.rb +2 -0
- data/spec/persistence/uuid_resource_spec.rb +80 -0
- data/spec/spec_helper.rb +10 -0
- data/spec/subclass_tracker_sperc.rb +62 -0
- data/utils/constant_tree.rb +29 -0
- data/utils/stack.rb +48 -0
- metadata +402 -0
data/doc/class_list.html
ADDED
@@ -0,0 +1,47 @@
|
|
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">Class 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="class">
|
41
|
+
<li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
|
42
|
+
<li><a class='toggle'></a> <span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span> < Object<small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Array/ArrayLoggerPersistor.html" title="Array::ArrayLoggerPersistor (class)">ArrayLoggerPersistor</a></span> < Persistor<small class='search_info'>Array</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims.html" title="Lims (module)">Lims</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core.html" title="Lims::Core (module)">Core</a></span><small class='search_info'>Lims</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Actions.html" title="Lims::Core::Actions (module)">Actions</a></span><small class='search_info'>Lims::Core</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Actions/Action.html" title="Lims::Core::Actions::Action (module)">Action</a></span><small class='search_info'>Lims::Core::Actions</small></li><ul><li><span class='object_link'><a href="Lims/Core/Actions/Action/AfterEval.html" title="Lims::Core::Actions::Action::AfterEval (module)">AfterEval</a></span><small class='search_info'>Lims::Core::Actions::Action</small></li><li><span class='object_link'><a href="Lims/Core/Actions/Action/InvalidParameters.html" title="Lims::Core::Actions::Action::InvalidParameters (class)">InvalidParameters</a></span> < RuntimeError<small class='search_info'>Lims::Core::Actions::Action</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Actions/ActionGroup.html" title="Lims::Core::Actions::ActionGroup (module)">ActionGroup</a></span><small class='search_info'>Lims::Core::Actions</small></li><ul><li><span class='object_link'><a href="Lims/Core/Actions/ActionGroup/AfterEval.html" title="Lims::Core::Actions::ActionGroup::AfterEval (module)">AfterEval</a></span><small class='search_info'>Lims::Core::Actions::ActionGroup</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Actions/BulkAction.html" title="Lims::Core::Actions::BulkAction (module)">BulkAction</a></span><small class='search_info'>Lims::Core::Actions</small></li><ul><li><span class='object_link'><a href="Lims/Core/Actions/BulkAction/AfterEval.html" title="Lims::Core::Actions::BulkAction::AfterEval (module)">AfterEval</a></span><small class='search_info'>Lims::Core::Actions::BulkAction</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Actions/TestActionGroup.html" title="Lims::Core::Actions::TestActionGroup (module)">TestActionGroup</a></span><small class='search_info'>Lims::Core::Actions</small></li><ul><li><span class='object_link'><a href="Lims/Core/Actions/TestActionGroup/Action.html" title="Lims::Core::Actions::TestActionGroup::Action (class)">Action</a></span> < Object<small class='search_info'>Lims::Core::Actions::TestActionGroup</small></li><li><span class='object_link'><a href="Lims/Core/Actions/TestActionGroup/ActionGroup.html" title="Lims::Core::Actions::TestActionGroup::ActionGroup (class)">ActionGroup</a></span> < Object<small class='search_info'>Lims::Core::Actions::TestActionGroup</small></li></ul></ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Base.html" title="Lims::Core::Base (module)">Base</a></span><small class='search_info'>Lims::Core</small></li><ul><li><span class='object_link'><a href="Lims/Core/Base/AccessibleViaSuper.html" title="Lims::Core::Base::AccessibleViaSuper (module)">AccessibleViaSuper</a></span><small class='search_info'>Lims::Core::Base</small></li><li><span class='object_link'><a href="Lims/Core/Base/ClassMethod.html" title="Lims::Core::Base::ClassMethod (module)">ClassMethod</a></span><small class='search_info'>Lims::Core::Base</small></li><li><span class='object_link'><a href="Lims/Core/Base/HashString.html" title="Lims::Core::Base::HashString (class)">HashString</a></span> < Object<small class='search_info'>Lims::Core::Base</small></li><li><span class='object_link'><a href="Lims/Core/Base/IsArrayOf.html" title="Lims::Core::Base::IsArrayOf (module)">IsArrayOf</a></span><small class='search_info'>Lims::Core::Base</small></li><li><span class='object_link'><a href="Lims/Core/Base/State.html" title="Lims::Core::Base::State (class)">State</a></span> < Object<small class='search_info'>Lims::Core::Base</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence.html" title="Lims::Core::Persistence (module)">Persistence</a></span><small class='search_info'>Lims::Core</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/ComparisonFilter.html" title="Lims::Core::Persistence::ComparisonFilter (class)">ComparisonFilter</a></span> < Filter<small class='search_info'>Lims::Core::Persistence</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Filter.html" title="Lims::Core::Persistence::Filter (class)">Filter</a></span> < Object<small class='search_info'>Lims::Core::Persistence</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/IdentityMap.html" title="Lims::Core::Persistence::IdentityMap (module)">IdentityMap</a></span><small class='search_info'>Lims::Core::Persistence</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/IdentityMap/Class.html" title="Lims::Core::Persistence::IdentityMap::Class (class)">Class</a></span> < Object<small class='search_info'>Lims::Core::Persistence::IdentityMap</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/IdentityMap/DuplicateError.html" title="Lims::Core::Persistence::IdentityMap::DuplicateError (class)">DuplicateError</a></span> < RuntimeError<small class='search_info'>Lims::Core::Persistence::IdentityMap</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/IdentityMap/DuplicateIdError.html" title="Lims::Core::Persistence::IdentityMap::DuplicateIdError (class)">DuplicateIdError</a></span> < DuplicateError<small class='search_info'>Lims::Core::Persistence::IdentityMap</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/IdentityMap/DuplicateObjectError.html" title="Lims::Core::Persistence::IdentityMap::DuplicateObjectError (class)">DuplicateObjectError</a></span> < DuplicateError<small class='search_info'>Lims::Core::Persistence::IdentityMap</small></li></ul><li><span class='object_link'><a href="Lims/Core/Persistence/IdentityMapClass.html" title="Lims::Core::Persistence::IdentityMapClass (class)">IdentityMapClass</a></span> < Object<small class='search_info'>Lims::Core::Persistence</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/Logger.html" title="Lims::Core::Persistence::Logger (module)">Logger</a></span><small class='search_info'>Lims::Core::Persistence</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/Logger/Persistor.html" title="Lims::Core::Persistence::Logger::Persistor (module)">Persistor</a></span><small class='search_info'>Lims::Core::Persistence::Logger</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Logger/Session.html" title="Lims::Core::Persistence::Logger::Session (class)">Session</a></span> < Session<small class='search_info'>Lims::Core::Persistence::Logger</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Logger/Store.html" title="Lims::Core::Persistence::Logger::Store (class)">Store</a></span> < Store<small class='search_info'>Lims::Core::Persistence::Logger</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/MessageBus.html" title="Lims::Core::Persistence::MessageBus (class)">MessageBus</a></span> < Object<small class='search_info'>Lims::Core::Persistence</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/MessageBus/ConnectionError.html" title="Lims::Core::Persistence::MessageBus::ConnectionError (class)">ConnectionError</a></span> < StandardError<small class='search_info'>Lims::Core::Persistence::MessageBus</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/MessageBus/InvalidSettingsError.html" title="Lims::Core::Persistence::MessageBus::InvalidSettingsError (class)">InvalidSettingsError</a></span> < StandardError<small class='search_info'>Lims::Core::Persistence::MessageBus</small></li></ul><li><span class='object_link'><a href="Lims/Core/Persistence/MultiCriteriaFilter.html" title="Lims::Core::Persistence::MultiCriteriaFilter (class)">MultiCriteriaFilter</a></span> < Filter<small class='search_info'>Lims::Core::Persistence</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/PersistAssociationTrait.html" title="Lims::Core::Persistence::PersistAssociationTrait (module)">PersistAssociationTrait</a></span><small class='search_info'>Lims::Core::Persistence</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/PersistableTrait.html" title="Lims::Core::Persistence::PersistableTrait (module)">PersistableTrait</a></span><small class='search_info'>Lims::Core::Persistence</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/Persistor.html" title="Lims::Core::Persistence::Persistor (class)">Persistor</a></span> < Object<small class='search_info'>Lims::Core::Persistence</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/Persistor/DuplicateError.html" title="Lims::Core::Persistence::Persistor::DuplicateError (class)">DuplicateError</a></span> < RuntimeError<small class='search_info'>Lims::Core::Persistence::Persistor</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Persistor/DuplicateIdError.html" title="Lims::Core::Persistence::Persistor::DuplicateIdError (class)">DuplicateIdError</a></span> < DuplicateError<small class='search_info'>Lims::Core::Persistence::Persistor</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Persistor/DuplicateObjectError.html" title="Lims::Core::Persistence::Persistor::DuplicateObjectError (class)">DuplicateObjectError</a></span> < DuplicateError<small class='search_info'>Lims::Core::Persistence::Persistor</small></li></ul><li><span class='object_link'><a href="Lims/Core/Persistence/PersistorTrait.html" title="Lims::Core::Persistence::PersistorTrait (module)">PersistorTrait</a></span><small class='search_info'>Lims::Core::Persistence</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/ResourceState.html" title="Lims::Core::Persistence::ResourceState (class)">ResourceState</a></span> < Object<small class='search_info'>Lims::Core::Persistence</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/Search.html" title="Lims::Core::Persistence::Search (class)">Search</a></span> < Object<small class='search_info'>Lims::Core::Persistence</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/Search/CreateSearch.html" title="Lims::Core::Persistence::Search::CreateSearch (class)">CreateSearch</a></span> < Object<small class='search_info'>Lims::Core::Persistence::Search</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Search/SearchPersistor.html" title="Lims::Core::Persistence::Search::SearchPersistor (class)">SearchPersistor</a></span> < Persistor<small class='search_info'>Lims::Core::Persistence::Search</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Search/SearchSequelPersistor.html" title="Lims::Core::Persistence::Search::SearchSequelPersistor (class)">SearchSequelPersistor</a></span> < SearchPersistor<small class='search_info'>Lims::Core::Persistence::Search</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/Sequel.html" title="Lims::Core::Persistence::Sequel (module)">Sequel</a></span><small class='search_info'>Lims::Core::Persistence</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/Sequel/Filters.html" title="Lims::Core::Persistence::Sequel::Filters (module)">Filters</a></span><small class='search_info'>Lims::Core::Persistence::Sequel</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/Sequel/ForTest.html" title="Lims::Core::Persistence::Sequel::ForTest (module)">ForTest</a></span><small class='search_info'>Lims::Core::Persistence::Sequel</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/Sequel/ForTest/Name.html" title="Lims::Core::Persistence::Sequel::ForTest::Name (class)">Name</a></span> < Object<small class='search_info'>Lims::Core::Persistence::Sequel::ForTest</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/Sequel/ForTest/Name/NamePersitor.html" title="Lims::Core::Persistence::Sequel::ForTest::Name::NamePersitor (class)">NamePersitor</a></span> < Persistor<small class='search_info'>Lims::Core::Persistence::Sequel::ForTest::Name</small></li></ul></ul><li><span class='object_link'><a href="Lims/Core/Persistence/Sequel/Migrations.html" title="Lims::Core::Persistence::Sequel::Migrations (module)">Migrations</a></span><small class='search_info'>Lims::Core::Persistence::Sequel</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Sequel/Persistor.html" title="Lims::Core::Persistence::Sequel::Persistor (module)">Persistor</a></span><small class='search_info'>Lims::Core::Persistence::Sequel</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Sequel/Session.html" title="Lims::Core::Persistence::Sequel::Session (class)">Session</a></span> < Session<small class='search_info'>Lims::Core::Persistence::Sequel</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Sequel/Store.html" title="Lims::Core::Persistence::Sequel::Store (class)">Store</a></span> < Store<small class='search_info'>Lims::Core::Persistence::Sequel</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/Session.html" title="Lims::Core::Persistence::Session (class)">Session</a></span> < Object<small class='search_info'>Lims::Core::Persistence</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/Session/UnmanagedObjectError.html" title="Lims::Core::Persistence::Session::UnmanagedObjectError (class)">UnmanagedObjectError</a></span> < RuntimeError<small class='search_info'>Lims::Core::Persistence::Session</small></li></ul><li><span class='object_link'><a href="Lims/Core/Persistence/StateGroup.html" title="Lims::Core::Persistence::StateGroup (class)">StateGroup</a></span> < StateList<small class='search_info'>Lims::Core::Persistence</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/StateList.html" title="Lims::Core::Persistence::StateList (class)">StateList</a></span> < Set<small class='search_info'>Lims::Core::Persistence</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/Store.html" title="Lims::Core::Persistence::Store (class)">Store</a></span> < Object<small class='search_info'>Lims::Core::Persistence</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Lims/Core/Persistence/UuidResource.html" title="Lims::Core::Persistence::UuidResource (class)">UuidResource</a></span> < Object<small class='search_info'>Lims::Core::Persistence</small></li><ul><li><span class='object_link'><a href="Lims/Core/Persistence/UuidResource/InvalidUuidError.html" title="Lims::Core::Persistence::UuidResource::InvalidUuidError (class)">InvalidUuidError</a></span> < RuntimeError<small class='search_info'>Lims::Core::Persistence::UuidResource</small></li><li><span class='object_link'><a href="Lims/Core/Persistence/UuidResource/UuidResourcePersistor.html" title="Lims::Core::Persistence::UuidResource::UuidResourcePersistor (class)">UuidResourcePersistor</a></span> < Persistor<small class='search_info'>Lims::Core::Persistence::UuidResource</small></li></ul><li><span class='object_link'><a href="Lims/Core/Persistence/Uuidable.html" title="Lims::Core::Persistence::Uuidable (module)">Uuidable</a></span><small class='search_info'>Lims::Core::Persistence</small></li></ul><li><span class='object_link'><a href="Lims/Core/Persistor.html" title="Lims::Core::Persistor (class)">Persistor</a></span> < Object<small class='search_info'>Lims::Core</small></li><li><span class='object_link'><a href="Lims/Core/Resource.html" title="Lims::Core::Resource (module)">Resource</a></span><small class='search_info'>Lims::Core</small></li></ul></ul><li><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span> < BasicObject<small class='search_info'>Top Level Namespace</small></li><li><a class='toggle'></a> <span class='object_link'><a href="SessionSpec.html" title="SessionSpec (module)">SessionSpec</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="SessionSpec/Model.html" title="SessionSpec::Model (class)">Model</a></span> < Object<small class='search_info'>SessionSpec</small></li><ul><li><span class='object_link'><a href="SessionSpec/Model/ModelPersistor.html" title="SessionSpec::Model::ModelPersistor (class)">ModelPersistor</a></span> < Persistor<small class='search_info'>SessionSpec::Model</small></li></ul></ul>
|
43
|
+
|
44
|
+
</ul>
|
45
|
+
</div>
|
46
|
+
</body>
|
47
|
+
</html>
|
data/doc/css/common.css
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
/* Override this file with custom rules */
|
@@ -0,0 +1,55 @@
|
|
1
|
+
body {
|
2
|
+
margin: 0;
|
3
|
+
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
|
4
|
+
font-size: 13px;
|
5
|
+
height: 101%;
|
6
|
+
overflow-x: hidden;
|
7
|
+
}
|
8
|
+
|
9
|
+
h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
|
10
|
+
.clear { clear: both; }
|
11
|
+
#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
|
12
|
+
#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
|
13
|
+
#full_list { padding: 0; list-style: none; margin-left: 0; }
|
14
|
+
#full_list ul { padding: 0; }
|
15
|
+
#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; }
|
16
|
+
#noresults { padding: 7px 12px; }
|
17
|
+
#content.insearch #noresults { margin-left: 7px; }
|
18
|
+
ul.collapsed ul, ul.collapsed li { display: none; }
|
19
|
+
ul.collapsed.search_uncollapsed { display: block; }
|
20
|
+
ul.collapsed.search_uncollapsed li { display: list-item; }
|
21
|
+
li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
|
22
|
+
li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
|
23
|
+
li { color: #888; cursor: pointer; }
|
24
|
+
li.deprecated { text-decoration: line-through; font-style: italic; }
|
25
|
+
li.r1 { background: #f0f0f0; }
|
26
|
+
li.r2 { background: #fafafa; }
|
27
|
+
li:hover { background: #ddd; }
|
28
|
+
li small:before { content: "("; }
|
29
|
+
li small:after { content: ")"; }
|
30
|
+
li small.search_info { display: none; }
|
31
|
+
a:link, a:visited { text-decoration: none; color: #05a; }
|
32
|
+
li.clicked { background: #05a; color: #ccc; }
|
33
|
+
li.clicked a:link, li.clicked a:visited { color: #eee; }
|
34
|
+
li.clicked a.toggle { opacity: 0.5; background-position: bottom right; }
|
35
|
+
li.collapsed.clicked a.toggle { background-position: top right; }
|
36
|
+
#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
|
37
|
+
#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; }
|
38
|
+
#nav a:link, #nav a:visited { color: #358; }
|
39
|
+
#nav a:hover { background: transparent; color: #5af; }
|
40
|
+
|
41
|
+
.frames #content h1 { margin-top: 0; }
|
42
|
+
.frames li { white-space: nowrap; cursor: normal; }
|
43
|
+
.frames li small { display: block; font-size: 0.8em; }
|
44
|
+
.frames li small:before { content: ""; }
|
45
|
+
.frames li small:after { content: ""; }
|
46
|
+
.frames li small.search_info { display: none; }
|
47
|
+
.frames #search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
|
48
|
+
.frames #content.insearch #search { background-position: center right; }
|
49
|
+
.frames #search input { width: 110px; }
|
50
|
+
.frames #nav { display: block; }
|
51
|
+
|
52
|
+
#full_list.insearch li { display: none; }
|
53
|
+
#full_list.insearch li.found { display: list-item; padding-left: 10px; }
|
54
|
+
#full_list.insearch li a.toggle { display: none; }
|
55
|
+
#full_list.insearch li small.search_info { display: block; }
|
data/doc/css/style.css
ADDED
@@ -0,0 +1,322 @@
|
|
1
|
+
body {
|
2
|
+
padding: 0 20px;
|
3
|
+
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
|
4
|
+
font-size: 13px;
|
5
|
+
}
|
6
|
+
body.frames { padding: 0 5px; }
|
7
|
+
h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
|
8
|
+
h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
|
9
|
+
h1.title { margin-bottom: 10px; }
|
10
|
+
h1.alphaindex { margin-top: 0; font-size: 22px; }
|
11
|
+
h2 {
|
12
|
+
padding: 0;
|
13
|
+
padding-bottom: 3px;
|
14
|
+
border-bottom: 1px #aaa solid;
|
15
|
+
font-size: 1.4em;
|
16
|
+
margin: 1.8em 0 0.5em;
|
17
|
+
}
|
18
|
+
h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; }
|
19
|
+
.clear { clear: both; }
|
20
|
+
.inline { display: inline; }
|
21
|
+
.inline p:first-child { display: inline; }
|
22
|
+
.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
|
23
|
+
.docstring h1 { font-size: 1.2em; }
|
24
|
+
.docstring h2 { font-size: 1.1em; }
|
25
|
+
.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; }
|
26
|
+
.summary_desc .object_link, .docstring .object_link { font-family: monospace; }
|
27
|
+
.rdoc-term { padding-right: 25px; font-weight: bold; }
|
28
|
+
.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
|
29
|
+
|
30
|
+
/* style for <ul> */
|
31
|
+
#filecontents li > p, .docstring li > p { margin: 0px; }
|
32
|
+
#filecontents ul, .docstring ul { padding-left: 20px; }
|
33
|
+
/* style for <dl> */
|
34
|
+
#filecontents dl, .docstring dl { border: 1px solid #ccc; }
|
35
|
+
#filecontents dt, .docstring dt { background: #ddd; font-weight: bold; padding: 3px 5px; }
|
36
|
+
#filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; }
|
37
|
+
#filecontents dd > p, .docstring dd > p { margin: 0px; }
|
38
|
+
|
39
|
+
.note {
|
40
|
+
color: #222;
|
41
|
+
-moz-border-radius: 3px; -webkit-border-radius: 3px;
|
42
|
+
background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
|
43
|
+
display: block;
|
44
|
+
}
|
45
|
+
.note.todo { background: #ffffc5; border-color: #ececaa; }
|
46
|
+
.note.returns_void { background: #efefef; }
|
47
|
+
.note.deprecated { background: #ffe5e5; border-color: #e9dada; }
|
48
|
+
.note.private { background: #ffffc5; border-color: #ececaa; }
|
49
|
+
.note.title { text-transform: lowercase; padding: 1px 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
|
50
|
+
.summary_signature + .note.title { margin-left: 7px; }
|
51
|
+
h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
|
52
|
+
.note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; }
|
53
|
+
.note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; }
|
54
|
+
.note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; }
|
55
|
+
.note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
|
56
|
+
.discussion .note { margin-top: 6px; }
|
57
|
+
.discussion .note:first-child { margin-top: 0; }
|
58
|
+
|
59
|
+
h3.inherited {
|
60
|
+
font-style: italic;
|
61
|
+
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
|
62
|
+
font-weight: normal;
|
63
|
+
padding: 0;
|
64
|
+
margin: 0;
|
65
|
+
margin-top: 12px;
|
66
|
+
margin-bottom: 3px;
|
67
|
+
font-size: 13px;
|
68
|
+
}
|
69
|
+
p.inherited {
|
70
|
+
padding: 0;
|
71
|
+
margin: 0;
|
72
|
+
margin-left: 25px;
|
73
|
+
}
|
74
|
+
|
75
|
+
#filecontents dl.box, dl.box {
|
76
|
+
border: 0;
|
77
|
+
width: 520px;
|
78
|
+
font-size: 1em;
|
79
|
+
}
|
80
|
+
#filecontents dl.box dt, dl.box dt {
|
81
|
+
float: left;
|
82
|
+
display: block;
|
83
|
+
width: 100px;
|
84
|
+
margin: 0;
|
85
|
+
text-align: right;
|
86
|
+
font-weight: bold;
|
87
|
+
background: transparent;
|
88
|
+
border: 1px solid #aaa;
|
89
|
+
border-width: 1px 0px 0px 1px;
|
90
|
+
padding: 6px 0;
|
91
|
+
padding-right: 10px;
|
92
|
+
}
|
93
|
+
#filecontents dl.box dd, dl.box dd {
|
94
|
+
float: left;
|
95
|
+
display: block;
|
96
|
+
width: 380px;
|
97
|
+
margin: 0;
|
98
|
+
padding: 6px 0;
|
99
|
+
padding-right: 20px;
|
100
|
+
border: 1px solid #aaa;
|
101
|
+
border-width: 1px 1px 0 0;
|
102
|
+
}
|
103
|
+
#filecontents dl.box .last, dl.box .last {
|
104
|
+
border-bottom: 1px solid #aaa;
|
105
|
+
}
|
106
|
+
#filecontents dl.box .r1, dl.box .r1 { background: #eee; }
|
107
|
+
|
108
|
+
ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
|
109
|
+
#files { padding-left: 15px; font-size: 1.1em; }
|
110
|
+
|
111
|
+
#files { padding: 0; }
|
112
|
+
#files li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
|
113
|
+
|
114
|
+
dl.constants { margin-left: 40px; }
|
115
|
+
dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
|
116
|
+
dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
|
117
|
+
|
118
|
+
.summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
|
119
|
+
.summary_desc tt { font-size: 0.9em; }
|
120
|
+
dl.constants .note { padding: 2px 6px; padding-right: 12px; margin-top: 6px; }
|
121
|
+
dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
|
122
|
+
dl.constants .tags { padding-left: 32px; font-size: 0.9em; line-height: 0.8em; }
|
123
|
+
dl.constants .discussion *:first-child { margin-top: 0; }
|
124
|
+
dl.constants .discussion *:last-child { margin-bottom: 0; }
|
125
|
+
|
126
|
+
.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
|
127
|
+
.method_details.first { border: 0; }
|
128
|
+
p.signature {
|
129
|
+
font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
|
130
|
+
padding: 6px 10px; margin-top: 18px;
|
131
|
+
background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
|
132
|
+
}
|
133
|
+
p.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
|
134
|
+
p.signature .overload { display: block; }
|
135
|
+
p.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
|
136
|
+
p.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
|
137
|
+
p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
|
138
|
+
|
139
|
+
.tags h3 { font-size: 1em; margin-bottom: 0; }
|
140
|
+
.tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
|
141
|
+
.tags ul li { margin-bottom: 3px; }
|
142
|
+
.tags ul .name { font-family: monospace; font-weight: bold; }
|
143
|
+
.tags ul .note { padding: 3px 6px; }
|
144
|
+
.tags { margin-bottom: 12px; }
|
145
|
+
|
146
|
+
.tags .examples h3 { margin-bottom: 10px; }
|
147
|
+
.tags .examples h4 { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
|
148
|
+
|
149
|
+
.tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
|
150
|
+
.tags .overload .overload_item .signature {
|
151
|
+
padding: 2px 8px;
|
152
|
+
background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
|
153
|
+
}
|
154
|
+
.tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; }
|
155
|
+
.tags .overload .docstring { margin-top: 15px; }
|
156
|
+
|
157
|
+
.defines { display: none; }
|
158
|
+
|
159
|
+
#method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; }
|
160
|
+
|
161
|
+
.showSource { font-size: 0.9em; }
|
162
|
+
.showSource a:link, .showSource a:visited { text-decoration: none; color: #666; }
|
163
|
+
|
164
|
+
#content a:link, #content a:visited { text-decoration: none; color: #05a; }
|
165
|
+
#content a:hover { background: #ffffa5; }
|
166
|
+
.docstring { margin-right: 6em; }
|
167
|
+
|
168
|
+
ul.summary {
|
169
|
+
list-style: none;
|
170
|
+
font-family: monospace;
|
171
|
+
font-size: 1em;
|
172
|
+
line-height: 1.5em;
|
173
|
+
}
|
174
|
+
ul.summary a:link, ul.summary a:visited {
|
175
|
+
text-decoration: none; font-size: 1.1em;
|
176
|
+
}
|
177
|
+
ul.summary li { margin-bottom: 5px; }
|
178
|
+
.summary .summary_signature {
|
179
|
+
padding: 1px 10px;
|
180
|
+
background: #eaeaff; border: 1px solid #dfdfe5;
|
181
|
+
-moz-border-radius: 3px; -webkit-border-radius: 3px;
|
182
|
+
}
|
183
|
+
.summary_signature:hover { background: #eeeeff; cursor: pointer; }
|
184
|
+
ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
|
185
|
+
ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
|
186
|
+
#content .summary_signature:hover a:link,
|
187
|
+
#content .summary_signature:hover a:visited {
|
188
|
+
background: transparent;
|
189
|
+
color: #48f;
|
190
|
+
}
|
191
|
+
|
192
|
+
p.inherited a { font-family: monospace; font-size: 0.9em; }
|
193
|
+
p.inherited { word-spacing: 5px; font-size: 1.2em; }
|
194
|
+
|
195
|
+
p.children { font-size: 1.2em; }
|
196
|
+
p.children a { font-size: 0.9em; }
|
197
|
+
p.children strong { font-size: 0.8em; }
|
198
|
+
p.children strong.modules { padding-left: 5px; }
|
199
|
+
|
200
|
+
ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
|
201
|
+
ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
|
202
|
+
ul.fullTree li { text-align: center; padding-top: 18px; padding-bottom: 12px; background: url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) no-repeat top center; }
|
203
|
+
ul.fullTree li:first-child { padding-top: 0; background: transparent; }
|
204
|
+
ul.fullTree li:last-child { padding-bottom: 0; }
|
205
|
+
.showAll ul.fullTree { display: block; }
|
206
|
+
.showAll .inheritName { display: none; }
|
207
|
+
|
208
|
+
#search { position: absolute; right: 14px; top: 0px; }
|
209
|
+
#search a:link, #search a:visited {
|
210
|
+
display: block; float: left; margin-right: 4px;
|
211
|
+
padding: 8px 10px; text-decoration: none; color: #05a;
|
212
|
+
border: 1px solid #d8d8e5;
|
213
|
+
-moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px;
|
214
|
+
-webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
|
215
|
+
background: #eaf0ff;
|
216
|
+
-webkit-box-shadow: -1px 1px 3px #ddd;
|
217
|
+
}
|
218
|
+
#search a:hover { background: #f5faff; color: #06b; }
|
219
|
+
#search a.active {
|
220
|
+
background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457;
|
221
|
+
-moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
|
222
|
+
-webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
|
223
|
+
}
|
224
|
+
#search a.inactive { color: #999; }
|
225
|
+
.frames #search { display: none; }
|
226
|
+
.inheritanceTree, .toggleDefines { float: right; }
|
227
|
+
|
228
|
+
#menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
|
229
|
+
#menu .title, #menu a { font-size: 0.7em; }
|
230
|
+
#menu .title a { font-size: 1em; }
|
231
|
+
#menu .title { color: #555; }
|
232
|
+
#menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
|
233
|
+
#menu a:hover { color: #05a; }
|
234
|
+
#menu .noframes { display: none; }
|
235
|
+
.frames #menu .noframes { display: inline; float: right; }
|
236
|
+
|
237
|
+
#footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
|
238
|
+
#footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
|
239
|
+
#footer a:hover { color: #05a; }
|
240
|
+
|
241
|
+
#listing ul.alpha { font-size: 1.1em; }
|
242
|
+
#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
|
243
|
+
#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
|
244
|
+
#listing ul.alpha ul { margin: 0; padding-left: 15px; }
|
245
|
+
#listing ul small { color: #666; font-size: 0.7em; }
|
246
|
+
|
247
|
+
li.r1 { background: #f0f0f0; }
|
248
|
+
li.r2 { background: #fafafa; }
|
249
|
+
|
250
|
+
#search_frame {
|
251
|
+
z-index: 9999;
|
252
|
+
background: #fff;
|
253
|
+
display: none;
|
254
|
+
position: absolute;
|
255
|
+
top: 36px;
|
256
|
+
right: 18px;
|
257
|
+
width: 500px;
|
258
|
+
height: 80%;
|
259
|
+
overflow-y: scroll;
|
260
|
+
border: 1px solid #999;
|
261
|
+
border-collapse: collapse;
|
262
|
+
-webkit-box-shadow: -7px 5px 25px #aaa;
|
263
|
+
-moz-box-shadow: -7px 5px 25px #aaa;
|
264
|
+
-moz-border-radius: 2px;
|
265
|
+
-webkit-border-radius: 2px;
|
266
|
+
}
|
267
|
+
|
268
|
+
#content ul.summary li.deprecated .summary_signature a:link,
|
269
|
+
#content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; }
|
270
|
+
|
271
|
+
#toc {
|
272
|
+
padding: 20px; padding-right: 30px; border: 1px solid #ddd; float: right; background: #fff; margin-left: 20px; margin-bottom: 20px;
|
273
|
+
max-width: 300px;
|
274
|
+
-webkit-box-shadow: -2px 2px 6px #bbb;
|
275
|
+
-moz-box-shadow: -2px 2px 6px #bbb;
|
276
|
+
z-index: 5000;
|
277
|
+
position: relative;
|
278
|
+
}
|
279
|
+
#toc.nofloat { float: none; max-width: none; border: none; padding: 0; margin: 20px 0; -webkit-box-shadow: none; -moz-box-shadow: none; }
|
280
|
+
#toc.nofloat.hidden { padding: 0; background: 0; margin-bottom: 5px; }
|
281
|
+
#toc .title { margin: 0; }
|
282
|
+
#toc ol { padding-left: 1.8em; }
|
283
|
+
#toc li { font-size: 1.1em; line-height: 1.7em; }
|
284
|
+
#toc > ol > li { font-size: 1.1em; font-weight: bold; }
|
285
|
+
#toc ol > ol { font-size: 0.9em; }
|
286
|
+
#toc ol ol > ol { padding-left: 2.3em; }
|
287
|
+
#toc ol + li { margin-top: 0.3em; }
|
288
|
+
#toc.hidden { padding: 10px; background: #f6f6f6; -webkit-box-shadow: none; -moz-box-shadow: none; }
|
289
|
+
#filecontents h1 + #toc.nofloat { margin-top: 0; }
|
290
|
+
|
291
|
+
/* syntax highlighting */
|
292
|
+
.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
|
293
|
+
#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
|
294
|
+
#filecontents pre.code, .docstring pre.code { display: block; }
|
295
|
+
.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
|
296
|
+
#filecontents pre.code, .docstring pre.code,
|
297
|
+
.tags .example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
|
298
|
+
pre.code { color: #000; }
|
299
|
+
pre.code .info.file { color: #555; }
|
300
|
+
pre.code .val { color: #036A07; }
|
301
|
+
pre.code .tstring_content,
|
302
|
+
pre.code .heredoc_beg, pre.code .heredoc_end,
|
303
|
+
pre.code .qwords_beg, pre.code .qwords_end,
|
304
|
+
pre.code .tstring, pre.code .dstring { color: #036A07; }
|
305
|
+
pre.code .fid, pre.code .id.new, pre.code .id.to_s,
|
306
|
+
pre.code .id.to_sym, pre.code .id.to_f,
|
307
|
+
pre.code .dot + pre.code .id,
|
308
|
+
pre.code .id.to_i pre.code .id.each { color: #0085FF; }
|
309
|
+
pre.code .comment { color: #0066FF; }
|
310
|
+
pre.code .const, pre.code .constant { color: #585CF6; }
|
311
|
+
pre.code .symbol { color: #C5060B; }
|
312
|
+
pre.code .kw,
|
313
|
+
pre.code .label,
|
314
|
+
pre.code .id.require,
|
315
|
+
pre.code .id.extend,
|
316
|
+
pre.code .id.include { color: #0000FF; }
|
317
|
+
pre.code .ivar { color: #318495; }
|
318
|
+
pre.code .gvar,
|
319
|
+
pre.code .id.backref,
|
320
|
+
pre.code .id.nth_ref { color: #6D79DE; }
|
321
|
+
pre.code .regexp, .dregexp { color: #036A07; }
|
322
|
+
pre.code a { border-bottom: 1px dotted #bbf; }
|
@@ -0,0 +1,127 @@
|
|
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
|
+
— Documentation by YARD 0.7.3
|
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
|
+
relpath = '';
|
19
|
+
if (relpath != '') relpath += '/';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
25
|
+
|
26
|
+
|
27
|
+
</head>
|
28
|
+
<body>
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
31
|
+
</script>
|
32
|
+
|
33
|
+
<div id="header">
|
34
|
+
<div id="menu">
|
35
|
+
|
36
|
+
<a href="_index.html" title="Index">Index</a> »
|
37
|
+
<span class="title">File: README</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a id="class_list_link" href="#">Class List</a>
|
46
|
+
|
47
|
+
<a id="method_list_link" href="#">Method List</a>
|
48
|
+
|
49
|
+
<a id="file_list_link" href="#">File List</a>
|
50
|
+
|
51
|
+
</div>
|
52
|
+
<div class="clear"></div>
|
53
|
+
</div>
|
54
|
+
|
55
|
+
<iframe id="search_frame"></iframe>
|
56
|
+
|
57
|
+
<div id="content"><div id='filecontents'><!-- vim: spell:spelllang=en tw=80
|
58
|
+
Yard markup
|
59
|
+
# @markup markdown
|
60
|
+
# @title README
|
61
|
+
-->
|
62
|
+
|
63
|
+
|
64
|
+
<h1>Overview </h1>
|
65
|
+
|
66
|
+
<p>This gem implements the core functionalities of the LIMS (Laboratory Information Management System).
|
67
|
+
It's not meant to be a stand alone application but the core library of the LIMS
|
68
|
+
server.</p>
|
69
|
+
|
70
|
+
<p>For more information consult the documentation.</p>
|
71
|
+
|
72
|
+
<h1>Installation</h1>
|
73
|
+
|
74
|
+
<pre class="code"><span class='id gem'>gem</span> <span class='id install'>install</span> <span class='id lims'>lims</span><span class='op'>-</span><span class='id core'>core</span>
|
75
|
+
</pre>
|
76
|
+
|
77
|
+
<p>Or, if you are using <a href="http://gembundler.com/">bundler</a> , add the following line</p>
|
78
|
+
|
79
|
+
<pre class="code"> <span class='id gem'>gem</span> <span class='symbol'>:lims</span><span class='op'>-</span><span class='id core'>core</span><span class='comma'>,</span> <span class='symbol'>:git</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>git+ssh://git@github.com/sanger/lims-core.git'
|
80
|
+
</span></span></pre>
|
81
|
+
|
82
|
+
<p>in your <code>Gemfile</code>.</p>
|
83
|
+
|
84
|
+
<h1>Documentation</h1>
|
85
|
+
|
86
|
+
<p>The documentation is generated using <a href="http://yardoc.org/index.html">yard</a> and can
|
87
|
+
be found under the <code>doc/</code> directory or using a <code>yard server</code></p>
|
88
|
+
|
89
|
+
<h1>Developers Guide</h1>
|
90
|
+
|
91
|
+
<h2>Gem requirements</h2>
|
92
|
+
|
93
|
+
<p>Ideally each should be loadable on its own. This mean that every file should
|
94
|
+
require everything it needs. The exception is for gems re-opening ruby basic
|
95
|
+
classes as facet do. The common requirements are grouped in the <code>lib/common.rb</code>
|
96
|
+
file.</p>
|
97
|
+
|
98
|
+
<p>For the user convenience, requiring a directory should requires everything
|
99
|
+
underneath. However, requiring <code>lims-core</code> will require <code>Persistence</code>, but not
|
100
|
+
the subdirectories of it (specific to each different stores like <code>Sequel</code>, or
|
101
|
+
<code>Logger</code>). This to not force to install all the dependencies specific to each
|
102
|
+
store.</p>
|
103
|
+
|
104
|
+
<h2>Documentation Guide</h2>
|
105
|
+
|
106
|
+
<p>The documentation is written using <a href="http://yardoc.org/index.html">yard</a>.
|
107
|
+
It allows to write documentation within the doc and add <em>typing</em> hints/
|
108
|
+
expectations.
|
109
|
+
The recommended format for stand alone documentation files is
|
110
|
+
<a href="http://daringfireball.net/projects/markdown/">markdown</a>, however
|
111
|
+
it's easier to keep the native markup language used by <strong>yard</strong>, i.e. the
|
112
|
+
<a href="http://rdoc.sourceforge.net/">rdoc</a> one.
|
113
|
+
This allows the code to be parsed via <strong>rdoc</strong> and doesn't need the extra spaces at
|
114
|
+
the end of a line needed by <strong>markdown</strong>.</p>
|
115
|
+
|
116
|
+
<p>However, when the usage of pure <strong>markdown</strong> seems appropriate, it's still
|
117
|
+
possible to the use <code>@markup</code> switch.</p>
|
118
|
+
|
119
|
+
<p>Some documentation can also be added in the specs.</p>
|
120
|
+
|
121
|
+
<h2>Tests</h2>
|
122
|
+
|
123
|
+
<p>We are using <a href="http://rspec.info/">rspec</a>.</p></div></div>
|
124
|
+
|
125
|
+
|
126
|
+
</body>
|
127
|
+
</html>
|