longleaf 0.1.0.pre.2 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.circleci/config.yml +94 -0
- data/.editorconfig +13 -0
- data/.gitignore +4 -1
- data/.rubocop.yml +44 -0
- data/.rubocop_todo.yml +834 -0
- data/.yardopts +1 -0
- data/Gemfile +16 -1
- data/README.md +98 -12
- data/Rakefile +6 -0
- data/bin/setup +16 -1
- data/docs/aboutlongleaf.md +28 -0
- data/docs/extra.css +32 -0
- data/docs/img/change-file.png +0 -0
- data/docs/img/ll-example-preserved.png +0 -0
- data/docs/index.md +19 -0
- data/docs/install.md +66 -0
- data/docs/ll-example/config-example-relative.yml +33 -0
- data/docs/ll-example/files-dir/LLexample-PDF.pdf +0 -0
- data/docs/ll-example/files-dir/LLexample-TOCHANGE.txt +15 -0
- data/docs/ll-example/files-dir/LLexample-tokeep.txt +10 -0
- data/docs/ll-example/metadata-dir/.gitkeep +0 -0
- data/docs/ll-example/replica-files/.gitkeep +0 -0
- data/docs/ll-example/replica-metadata/.gitkeep +0 -0
- data/docs/quickstart.md +270 -0
- data/docs/rdocs/Longleaf.html +135 -0
- data/docs/rdocs/Longleaf/AppFields.html +178 -0
- data/docs/rdocs/Longleaf/ApplicationConfigDeserializer.html +631 -0
- data/docs/rdocs/Longleaf/ApplicationConfigManager.html +610 -0
- data/docs/rdocs/Longleaf/ApplicationConfigValidator.html +238 -0
- data/docs/rdocs/Longleaf/CLI.html +909 -0
- data/docs/rdocs/Longleaf/ChecksumMismatchError.html +151 -0
- data/docs/rdocs/Longleaf/ConfigBuilder.html +1339 -0
- data/docs/rdocs/Longleaf/ConfigurationError.html +143 -0
- data/docs/rdocs/Longleaf/ConfigurationValidator.html +227 -0
- data/docs/rdocs/Longleaf/DeregisterCommand.html +420 -0
- data/docs/rdocs/Longleaf/DeregisterEvent.html +453 -0
- data/docs/rdocs/Longleaf/DeregistrationError.html +151 -0
- data/docs/rdocs/Longleaf/DigestHelper.html +419 -0
- data/docs/rdocs/Longleaf/EventError.html +147 -0
- data/docs/rdocs/Longleaf/EventNames.html +163 -0
- data/docs/rdocs/Longleaf/EventStatusTracking.html +656 -0
- data/docs/rdocs/Longleaf/FileCheckService.html +540 -0
- data/docs/rdocs/Longleaf/FileHelpers.html +520 -0
- data/docs/rdocs/Longleaf/FileRecord.html +716 -0
- data/docs/rdocs/Longleaf/FileSelector.html +901 -0
- data/docs/rdocs/Longleaf/FixityCheckService.html +691 -0
- data/docs/rdocs/Longleaf/IndexManager.html +1155 -0
- data/docs/rdocs/Longleaf/InvalidDigestAlgorithmError.html +143 -0
- data/docs/rdocs/Longleaf/InvalidStoragePathError.html +143 -0
- data/docs/rdocs/Longleaf/Logging.html +405 -0
- data/docs/rdocs/Longleaf/Logging/RedirectingLogger.html +1213 -0
- data/docs/rdocs/Longleaf/LongleafError.html +139 -0
- data/docs/rdocs/Longleaf/MDFields.html +193 -0
- data/docs/rdocs/Longleaf/MetadataBuilder.html +787 -0
- data/docs/rdocs/Longleaf/MetadataDeserializer.html +537 -0
- data/docs/rdocs/Longleaf/MetadataError.html +143 -0
- data/docs/rdocs/Longleaf/MetadataPersistenceManager.html +539 -0
- data/docs/rdocs/Longleaf/MetadataRecord.html +1411 -0
- data/docs/rdocs/Longleaf/MetadataSerializer.html +786 -0
- data/docs/rdocs/Longleaf/PreservationServiceError.html +147 -0
- data/docs/rdocs/Longleaf/PreserveCommand.html +410 -0
- data/docs/rdocs/Longleaf/PreserveEvent.html +491 -0
- data/docs/rdocs/Longleaf/RegisterCommand.html +428 -0
- data/docs/rdocs/Longleaf/RegisterEvent.html +628 -0
- data/docs/rdocs/Longleaf/RegisteredFileSelector.html +446 -0
- data/docs/rdocs/Longleaf/RegistrationError.html +151 -0
- data/docs/rdocs/Longleaf/ReindexCommand.html +576 -0
- data/docs/rdocs/Longleaf/RsyncReplicationService.html +1180 -0
- data/docs/rdocs/Longleaf/SequelIndexDriver.html +1978 -0
- data/docs/rdocs/Longleaf/ServiceCandidateFilesystemIterator.html +572 -0
- data/docs/rdocs/Longleaf/ServiceCandidateIndexIterator.html +532 -0
- data/docs/rdocs/Longleaf/ServiceCandidateLocator.html +333 -0
- data/docs/rdocs/Longleaf/ServiceClassCache.html +725 -0
- data/docs/rdocs/Longleaf/ServiceDateHelper.html +425 -0
- data/docs/rdocs/Longleaf/ServiceDefinition.html +683 -0
- data/docs/rdocs/Longleaf/ServiceDefinitionManager.html +371 -0
- data/docs/rdocs/Longleaf/ServiceDefinitionValidator.html +269 -0
- data/docs/rdocs/Longleaf/ServiceFields.html +173 -0
- data/docs/rdocs/Longleaf/ServiceManager.html +1229 -0
- data/docs/rdocs/Longleaf/ServiceMappingManager.html +410 -0
- data/docs/rdocs/Longleaf/ServiceMappingValidator.html +347 -0
- data/docs/rdocs/Longleaf/ServiceRecord.html +821 -0
- data/docs/rdocs/Longleaf/StorageLocation.html +985 -0
- data/docs/rdocs/Longleaf/StorageLocationManager.html +729 -0
- data/docs/rdocs/Longleaf/StorageLocationUnavailableError.html +143 -0
- data/docs/rdocs/Longleaf/StorageLocationValidator.html +373 -0
- data/docs/rdocs/Longleaf/StoragePathValidator.html +253 -0
- data/docs/rdocs/Longleaf/SystemConfigBuilder.html +441 -0
- data/docs/rdocs/Longleaf/SystemConfigFields.html +163 -0
- data/docs/rdocs/Longleaf/ValidateConfigCommand.html +451 -0
- data/docs/rdocs/Longleaf/ValidateMetadataCommand.html +408 -0
- data/docs/rdocs/_index.html +660 -0
- data/docs/rdocs/class_list.html +51 -0
- data/docs/rdocs/css/common.css +1 -0
- data/docs/rdocs/css/full_list.css +58 -0
- data/docs/rdocs/css/style.css +496 -0
- data/docs/rdocs/file.README.html +165 -0
- data/docs/rdocs/file_list.html +56 -0
- data/docs/rdocs/frames.html +17 -0
- data/docs/rdocs/index.html +165 -0
- data/docs/rdocs/js/app.js +303 -0
- data/docs/rdocs/js/full_list.js +216 -0
- data/docs/rdocs/js/jquery.js +4 -0
- data/docs/rdocs/method_list.html +2051 -0
- data/docs/rdocs/top-level-namespace.html +110 -0
- data/lib/longleaf/candidates/file_selector.rb +139 -0
- data/lib/longleaf/candidates/manifest_digest_provider.rb +17 -0
- data/lib/longleaf/candidates/registered_file_selector.rb +67 -0
- data/lib/longleaf/candidates/service_candidate_filesystem_iterator.rb +93 -0
- data/lib/longleaf/candidates/service_candidate_index_iterator.rb +84 -0
- data/lib/longleaf/candidates/service_candidate_locator.rb +23 -0
- data/lib/longleaf/candidates/single_digest_provider.rb +13 -0
- data/lib/longleaf/cli.rb +237 -46
- data/lib/longleaf/commands/deregister_command.rb +51 -0
- data/lib/longleaf/commands/preserve_command.rb +50 -0
- data/lib/longleaf/commands/register_command.rb +32 -43
- data/lib/longleaf/commands/reindex_command.rb +92 -0
- data/lib/longleaf/commands/validate_config_command.rb +33 -8
- data/lib/longleaf/commands/validate_metadata_command.rb +51 -0
- data/lib/longleaf/errors.rb +26 -7
- data/lib/longleaf/events/deregister_event.rb +53 -0
- data/lib/longleaf/events/event_names.rb +9 -0
- data/lib/longleaf/events/event_status_tracking.rb +59 -0
- data/lib/longleaf/events/preserve_event.rb +81 -0
- data/lib/longleaf/events/register_event.rb +52 -51
- data/lib/longleaf/helpers/case_insensitive_hash.rb +38 -0
- data/lib/longleaf/helpers/digest_helper.rb +56 -0
- data/lib/longleaf/helpers/s3_uri_helper.rb +86 -0
- data/lib/longleaf/helpers/selection_options_parser.rb +189 -0
- data/lib/longleaf/helpers/service_date_helper.rb +78 -0
- data/lib/longleaf/indexing/index_manager.rb +101 -0
- data/lib/longleaf/indexing/sequel_index_driver.rb +306 -0
- data/lib/longleaf/logging.rb +5 -4
- data/lib/longleaf/logging/redirecting_logger.rb +26 -25
- data/lib/longleaf/models/app_fields.rb +7 -2
- data/lib/longleaf/models/file_record.rb +17 -8
- data/lib/longleaf/models/filesystem_metadata_location.rb +56 -0
- data/lib/longleaf/models/filesystem_storage_location.rb +52 -0
- data/lib/longleaf/models/md_fields.rb +2 -1
- data/lib/longleaf/models/metadata_location.rb +47 -0
- data/lib/longleaf/models/metadata_record.rb +39 -15
- data/lib/longleaf/models/s3_storage_location.rb +133 -0
- data/lib/longleaf/models/service_definition.rb +7 -6
- data/lib/longleaf/models/service_fields.rb +7 -1
- data/lib/longleaf/models/service_record.rb +10 -6
- data/lib/longleaf/models/storage_location.rb +24 -19
- data/lib/longleaf/models/storage_types.rb +9 -0
- data/lib/longleaf/models/system_config_fields.rb +9 -0
- data/lib/longleaf/preservation_services/file_check_service.rb +58 -0
- data/lib/longleaf/preservation_services/fixity_check_service.rb +123 -0
- data/lib/longleaf/preservation_services/rsync_replication_service.rb +182 -0
- data/lib/longleaf/preservation_services/s3_replication_service.rb +143 -0
- data/lib/longleaf/services/application_config_deserializer.rb +81 -24
- data/lib/longleaf/services/application_config_manager.rb +20 -6
- data/lib/longleaf/services/application_config_validator.rb +19 -9
- data/lib/longleaf/services/configuration_validator.rb +67 -4
- data/lib/longleaf/services/filesystem_location_validator.rb +16 -0
- data/lib/longleaf/services/metadata_deserializer.rb +113 -42
- data/lib/longleaf/services/metadata_persistence_manager.rb +47 -0
- data/lib/longleaf/services/metadata_serializer.rb +138 -25
- data/lib/longleaf/services/metadata_validator.rb +76 -0
- data/lib/longleaf/services/s3_location_validator.rb +19 -0
- data/lib/longleaf/services/service_class_cache.rb +112 -0
- data/lib/longleaf/services/service_definition_manager.rb +10 -7
- data/lib/longleaf/services/service_definition_validator.rb +25 -18
- data/lib/longleaf/services/service_manager.rb +86 -11
- data/lib/longleaf/services/service_mapping_manager.rb +13 -12
- data/lib/longleaf/services/service_mapping_validator.rb +36 -26
- data/lib/longleaf/services/storage_location_manager.rb +76 -15
- data/lib/longleaf/services/storage_location_validator.rb +49 -35
- data/lib/longleaf/specs/config_builder.rb +47 -23
- data/lib/longleaf/specs/config_validator_helpers.rb +16 -0
- data/lib/longleaf/specs/custom_matchers.rb +9 -0
- data/lib/longleaf/specs/file_helpers.rb +61 -0
- data/lib/longleaf/specs/metadata_builder.rb +92 -0
- data/lib/longleaf/specs/system_config_builder.rb +27 -0
- data/lib/longleaf/version.rb +1 -1
- data/longleaf.gemspec +20 -7
- data/mkdocs.yml +21 -0
- metadata +306 -23
- data/.travis.yml +0 -4
- data/lib/longleaf/commands/abstract_command.rb +0 -37
- data/lib/longleaf/services/storage_path_validator.rb +0 -16
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.19
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "README";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="file_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index</a> »
|
|
40
|
+
<span class="title">File: README</span>
|
|
41
|
+
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<div id="search">
|
|
45
|
+
|
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
|
47
|
+
href="class_list.html">
|
|
48
|
+
|
|
49
|
+
<svg width="24" height="24">
|
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
</svg>
|
|
54
|
+
</a>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
<div class="clear"></div>
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div id="content"><div id='filecontents'>
|
|
61
|
+
<h1 id="label-Longleaf">Longleaf</h1>
|
|
62
|
+
|
|
63
|
+
<p>Longleaf is a command-line tool which allows users to configure a set of storage locations and define custom sets of preservation services to run on their contents. These services are executed in response to applicable preservation events issued by clients. Its primary goal is to provide tools to create a simple and customizable preservation environment. Longleaf:</p>
|
|
64
|
+
<ul><li>
|
|
65
|
+
<p>Offers a predictable command-line interface and integrates with standard command-line tools.</p>
|
|
66
|
+
</li><li>
|
|
67
|
+
<p>Offers configurable and customizable criteria based preservation workflows.</p>
|
|
68
|
+
</li><li>
|
|
69
|
+
<p>Provides a base set of tools and a framework for building extensions.</p>
|
|
70
|
+
</li><li>
|
|
71
|
+
<p>Provides activity logging and notifications.</p>
|
|
72
|
+
</li><li>
|
|
73
|
+
<p>Performs preservation services only when required.</p>
|
|
74
|
+
</li></ul>
|
|
75
|
+
|
|
76
|
+
<h2 id="label-Installation">Installation</h2>
|
|
77
|
+
|
|
78
|
+
<p>There are two primary ways to install Longleaf, depending on how you intend to use it:</p>
|
|
79
|
+
|
|
80
|
+
<h4 id="label-Standalone+gem">Standalone gem</h4>
|
|
81
|
+
|
|
82
|
+
<p>To use Longleaf as a command-line application, the gem can be installed using:</p>
|
|
83
|
+
|
|
84
|
+
<pre class="code ruby"><code class="ruby">$ gem install longleaf
|
|
85
|
+
</code></pre>
|
|
86
|
+
|
|
87
|
+
<p>Or it may be built from source:</p>
|
|
88
|
+
|
|
89
|
+
<pre class="code ruby"><code class="ruby">$ git clone git@github.com:UNC-Libraries/longleaf-preservation.git
|
|
90
|
+
$ cd longleaf-preservation
|
|
91
|
+
$ bin/setup
|
|
92
|
+
$ bundle exec rake install # builds the gem
|
|
93
|
+
$ gem install --local pkg/longleaf* # installs gem
|
|
94
|
+
</code></pre>
|
|
95
|
+
|
|
96
|
+
<h4 id="label-Applicaton+dependency">Applicaton dependency</h4>
|
|
97
|
+
|
|
98
|
+
<p>To make use of longleaf as a dependency of your application, add this line to your application's Gemfile:</p>
|
|
99
|
+
|
|
100
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>longleaf</span><span class='tstring_end'>'</span></span>
|
|
101
|
+
</code></pre>
|
|
102
|
+
|
|
103
|
+
<p>And then execute:</p>
|
|
104
|
+
|
|
105
|
+
<pre class="code ruby"><code class="ruby">$ bundle
|
|
106
|
+
</code></pre>
|
|
107
|
+
|
|
108
|
+
<h2 id="label-Usage">Usage</h2>
|
|
109
|
+
|
|
110
|
+
<h4 id="label-Register+a+file">Register a file</h4>
|
|
111
|
+
|
|
112
|
+
<p>In order to register a new file with Longleaf, use the register command: <code>longleaf register -c <config.yml> -f <path to file></code></p>
|
|
113
|
+
|
|
114
|
+
<p>In the case that a file's content is replaced, the file can be re-registered by providing the <code>--force</code> flag.</p>
|
|
115
|
+
|
|
116
|
+
<h4 id="label-Validate+configuration+files">Validate configuration files</h4>
|
|
117
|
+
|
|
118
|
+
<p>Application configuration files can be validated prior to usage with the following command: <code>longleaf validate_config -c <config.yml></code></p>
|
|
119
|
+
|
|
120
|
+
<h4 id="label-Output+and+logging">Output and logging</h4>
|
|
121
|
+
|
|
122
|
+
<p>The primary output from Longleaf is directed to STDOUT, and contains both success and failure messages. If you would like to only return failure messages, you may provide the <code>--failure_only</code> flag.</p>
|
|
123
|
+
|
|
124
|
+
<p>Additional logging is sent to STDERR. To control the level of logging, you may provide the <code>--log-level</code> parameter, which expects the standard <a href="https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html">Ruby Logger levels</a>. The default log level is 'WARN'.</p>
|
|
125
|
+
|
|
126
|
+
<p>Messages sent to STDOUT are duplicated to STDERR at 'INFO' level, so they are excluded by default. In order to store an ongoing log of activity and errors, you would perform the following: <code>longleaf <command> --log-level 'INFO' 2> /logs/longleaf.log</code></p>
|
|
127
|
+
|
|
128
|
+
<h2 id="label-Development">Development</h2>
|
|
129
|
+
|
|
130
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies.</p>
|
|
131
|
+
|
|
132
|
+
<p>To perform the tests, run: <code> bundle exec rspec </code></p>
|
|
133
|
+
|
|
134
|
+
<p>To run Longleaf with local changes without needing to do a local install, you may run: <code> bundle exec exe/longleaf <command> </code></p>
|
|
135
|
+
|
|
136
|
+
<p>To install this gem onto your local machine, run: <code> bundle exec rake install </code></p>
|
|
137
|
+
|
|
138
|
+
<p>This places a newly built gem into the <code>pkg/</code> directory. This gem may then be installed in order to run commands in the <code>longleaf <command></code> form. <em>Note:</em> Only files committed to git will be included in the installed gem.</p>
|
|
139
|
+
|
|
140
|
+
<p>To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
|
|
141
|
+
|
|
142
|
+
<h2 id="label-Indexing">Indexing</h2>
|
|
143
|
+
|
|
144
|
+
<p>To use an index to improve performance, you will need to install the database drivers separately or bundle longleaf with the driver you wish to use: <code>bundle install --with postgres</code></p>
|
|
145
|
+
|
|
146
|
+
<p>Options include: postgres, mysql2, mysql, sqlite, amalgalite</p>
|
|
147
|
+
|
|
148
|
+
<h2 id="label-Contributing">Contributing</h2>
|
|
149
|
+
|
|
150
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/UNC-Libraries/longleaf-preservation">github.com/UNC-Libraries/longleaf-preservation</a>.</p>
|
|
151
|
+
|
|
152
|
+
<h2 id="label-License">License</h2>
|
|
153
|
+
|
|
154
|
+
<p>The gem is available as open source under the terms of the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>.</p>
|
|
155
|
+
</div></div>
|
|
156
|
+
|
|
157
|
+
<div id="footer">
|
|
158
|
+
Generated on Tue May 28 15:48:00 2019 by
|
|
159
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
160
|
+
0.9.19 (ruby-2.6.3).
|
|
161
|
+
</div>
|
|
162
|
+
|
|
163
|
+
</div>
|
|
164
|
+
</body>
|
|
165
|
+
</html>
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
5
|
+
<meta charset="utf-8" />
|
|
6
|
+
|
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
|
+
|
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<title>File List</title>
|
|
19
|
+
<base id="base_target" target="_parent" />
|
|
20
|
+
</head>
|
|
21
|
+
<body>
|
|
22
|
+
<div id="content">
|
|
23
|
+
<div class="fixed_header">
|
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
|
25
|
+
<div id="full_list_nav">
|
|
26
|
+
|
|
27
|
+
<span><a target="_self" href="class_list.html">
|
|
28
|
+
Classes
|
|
29
|
+
</a></span>
|
|
30
|
+
|
|
31
|
+
<span><a target="_self" href="method_list.html">
|
|
32
|
+
Methods
|
|
33
|
+
</a></span>
|
|
34
|
+
|
|
35
|
+
<span><a target="_self" href="file_list.html">
|
|
36
|
+
Files
|
|
37
|
+
</a></span>
|
|
38
|
+
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<ul id="full_list" class="file">
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
<li id="object_README" class="odd">
|
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
|
49
|
+
</li>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
</ul>
|
|
54
|
+
</div>
|
|
55
|
+
</body>
|
|
56
|
+
</html>
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>Documentation by YARD 0.9.19</title>
|
|
6
|
+
</head>
|
|
7
|
+
<script type="text/javascript" charset="utf-8">
|
|
8
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
|
9
|
+
var name = match ? match[1] : 'index.html';
|
|
10
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
|
11
|
+
window.top.location = name;
|
|
12
|
+
</script>
|
|
13
|
+
<noscript>
|
|
14
|
+
<h1>Oops!</h1>
|
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
|
16
|
+
</noscript>
|
|
17
|
+
</html>
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.19
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "README";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index</a> »
|
|
40
|
+
<span class="title">File: README</span>
|
|
41
|
+
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<div id="search">
|
|
45
|
+
|
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
|
47
|
+
href="class_list.html">
|
|
48
|
+
|
|
49
|
+
<svg width="24" height="24">
|
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
</svg>
|
|
54
|
+
</a>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
<div class="clear"></div>
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div id="content"><div id='filecontents'>
|
|
61
|
+
<h1 id="label-Longleaf">Longleaf</h1>
|
|
62
|
+
|
|
63
|
+
<p>Longleaf is a command-line tool which allows users to configure a set of storage locations and define custom sets of preservation services to run on their contents. These services are executed in response to applicable preservation events issued by clients. Its primary goal is to provide tools to create a simple and customizable preservation environment. Longleaf:</p>
|
|
64
|
+
<ul><li>
|
|
65
|
+
<p>Offers a predictable command-line interface and integrates with standard command-line tools.</p>
|
|
66
|
+
</li><li>
|
|
67
|
+
<p>Offers configurable and customizable criteria based preservation workflows.</p>
|
|
68
|
+
</li><li>
|
|
69
|
+
<p>Provides a base set of tools and a framework for building extensions.</p>
|
|
70
|
+
</li><li>
|
|
71
|
+
<p>Provides activity logging and notifications.</p>
|
|
72
|
+
</li><li>
|
|
73
|
+
<p>Performs preservation services only when required.</p>
|
|
74
|
+
</li></ul>
|
|
75
|
+
|
|
76
|
+
<h2 id="label-Installation">Installation</h2>
|
|
77
|
+
|
|
78
|
+
<p>There are two primary ways to install Longleaf, depending on how you intend to use it:</p>
|
|
79
|
+
|
|
80
|
+
<h4 id="label-Standalone+gem">Standalone gem</h4>
|
|
81
|
+
|
|
82
|
+
<p>To use Longleaf as a command-line application, the gem can be installed using:</p>
|
|
83
|
+
|
|
84
|
+
<pre class="code ruby"><code class="ruby">$ gem install longleaf
|
|
85
|
+
</code></pre>
|
|
86
|
+
|
|
87
|
+
<p>Or it may be built from source:</p>
|
|
88
|
+
|
|
89
|
+
<pre class="code ruby"><code class="ruby">$ git clone git@github.com:UNC-Libraries/longleaf-preservation.git
|
|
90
|
+
$ cd longleaf-preservation
|
|
91
|
+
$ bin/setup
|
|
92
|
+
$ bundle exec rake install # builds the gem
|
|
93
|
+
$ gem install --local pkg/longleaf* # installs gem
|
|
94
|
+
</code></pre>
|
|
95
|
+
|
|
96
|
+
<h4 id="label-Applicaton+dependency">Applicaton dependency</h4>
|
|
97
|
+
|
|
98
|
+
<p>To make use of longleaf as a dependency of your application, add this line to your application's Gemfile:</p>
|
|
99
|
+
|
|
100
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>longleaf</span><span class='tstring_end'>'</span></span>
|
|
101
|
+
</code></pre>
|
|
102
|
+
|
|
103
|
+
<p>And then execute:</p>
|
|
104
|
+
|
|
105
|
+
<pre class="code ruby"><code class="ruby">$ bundle
|
|
106
|
+
</code></pre>
|
|
107
|
+
|
|
108
|
+
<h2 id="label-Usage">Usage</h2>
|
|
109
|
+
|
|
110
|
+
<h4 id="label-Register+a+file">Register a file</h4>
|
|
111
|
+
|
|
112
|
+
<p>In order to register a new file with Longleaf, use the register command: <code>longleaf register -c <config.yml> -f <path to file></code></p>
|
|
113
|
+
|
|
114
|
+
<p>In the case that a file's content is replaced, the file can be re-registered by providing the <code>--force</code> flag.</p>
|
|
115
|
+
|
|
116
|
+
<h4 id="label-Validate+configuration+files">Validate configuration files</h4>
|
|
117
|
+
|
|
118
|
+
<p>Application configuration files can be validated prior to usage with the following command: <code>longleaf validate_config -c <config.yml></code></p>
|
|
119
|
+
|
|
120
|
+
<h4 id="label-Output+and+logging">Output and logging</h4>
|
|
121
|
+
|
|
122
|
+
<p>The primary output from Longleaf is directed to STDOUT, and contains both success and failure messages. If you would like to only return failure messages, you may provide the <code>--failure_only</code> flag.</p>
|
|
123
|
+
|
|
124
|
+
<p>Additional logging is sent to STDERR. To control the level of logging, you may provide the <code>--log-level</code> parameter, which expects the standard <a href="https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html">Ruby Logger levels</a>. The default log level is 'WARN'.</p>
|
|
125
|
+
|
|
126
|
+
<p>Messages sent to STDOUT are duplicated to STDERR at 'INFO' level, so they are excluded by default. In order to store an ongoing log of activity and errors, you would perform the following: <code>longleaf <command> --log-level 'INFO' 2> /logs/longleaf.log</code></p>
|
|
127
|
+
|
|
128
|
+
<h2 id="label-Development">Development</h2>
|
|
129
|
+
|
|
130
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies.</p>
|
|
131
|
+
|
|
132
|
+
<p>To perform the tests, run: <code> bundle exec rspec </code></p>
|
|
133
|
+
|
|
134
|
+
<p>To run Longleaf with local changes without needing to do a local install, you may run: <code> bundle exec exe/longleaf <command> </code></p>
|
|
135
|
+
|
|
136
|
+
<p>To install this gem onto your local machine, run: <code> bundle exec rake install </code></p>
|
|
137
|
+
|
|
138
|
+
<p>This places a newly built gem into the <code>pkg/</code> directory. This gem may then be installed in order to run commands in the <code>longleaf <command></code> form. <em>Note:</em> Only files committed to git will be included in the installed gem.</p>
|
|
139
|
+
|
|
140
|
+
<p>To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
|
|
141
|
+
|
|
142
|
+
<h2 id="label-Indexing">Indexing</h2>
|
|
143
|
+
|
|
144
|
+
<p>To use an index to improve performance, you will need to install the database drivers separately or bundle longleaf with the driver you wish to use: <code>bundle install --with postgres</code></p>
|
|
145
|
+
|
|
146
|
+
<p>Options include: postgres, mysql2, mysql, sqlite, amalgalite</p>
|
|
147
|
+
|
|
148
|
+
<h2 id="label-Contributing">Contributing</h2>
|
|
149
|
+
|
|
150
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/UNC-Libraries/longleaf-preservation">github.com/UNC-Libraries/longleaf-preservation</a>.</p>
|
|
151
|
+
|
|
152
|
+
<h2 id="label-License">License</h2>
|
|
153
|
+
|
|
154
|
+
<p>The gem is available as open source under the terms of the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>.</p>
|
|
155
|
+
</div></div>
|
|
156
|
+
|
|
157
|
+
<div id="footer">
|
|
158
|
+
Generated on Tue May 28 15:48:00 2019 by
|
|
159
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
160
|
+
0.9.19 (ruby-2.6.3).
|
|
161
|
+
</div>
|
|
162
|
+
|
|
163
|
+
</div>
|
|
164
|
+
</body>
|
|
165
|
+
</html>
|
|
@@ -0,0 +1,303 @@
|
|
|
1
|
+
(function() {
|
|
2
|
+
|
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
|
6
|
+
|
|
7
|
+
function createSourceLinks() {
|
|
8
|
+
$('.method_details_list .source_code').
|
|
9
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
10
|
+
$('.toggleSource').toggle(function() {
|
|
11
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
12
|
+
$(this).text("Hide source");
|
|
13
|
+
},
|
|
14
|
+
function() {
|
|
15
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
16
|
+
$(this).text("View source");
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
function createDefineLinks() {
|
|
21
|
+
var tHeight = 0;
|
|
22
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
23
|
+
$('.toggleDefines').toggle(function() {
|
|
24
|
+
tHeight = $(this).parent().prev().height();
|
|
25
|
+
$(this).prev().css('display', 'inline');
|
|
26
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
27
|
+
$(this).text("(less)");
|
|
28
|
+
},
|
|
29
|
+
function() {
|
|
30
|
+
$(this).prev().hide();
|
|
31
|
+
$(this).parent().prev().height(tHeight);
|
|
32
|
+
$(this).text("more...");
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function createFullTreeLinks() {
|
|
37
|
+
var tHeight = 0;
|
|
38
|
+
$('.inheritanceTree').toggle(function() {
|
|
39
|
+
tHeight = $(this).parent().prev().height();
|
|
40
|
+
$(this).parent().toggleClass('showAll');
|
|
41
|
+
$(this).text("(hide)");
|
|
42
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
43
|
+
},
|
|
44
|
+
function() {
|
|
45
|
+
$(this).parent().toggleClass('showAll');
|
|
46
|
+
$(this).parent().prev().height(tHeight);
|
|
47
|
+
$(this).text("show all");
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameButtons() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
window.addEventListener('message', function(e) {
|
|
57
|
+
if (e.data === 'navEscape') {
|
|
58
|
+
$('#nav').slideUp(100);
|
|
59
|
+
$('#search a').removeClass('active inactive');
|
|
60
|
+
$(window).focus();
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
$(window).resize(function() {
|
|
65
|
+
if ($('#search:visible').length === 0) {
|
|
66
|
+
$('#nav').removeAttr('style');
|
|
67
|
+
$('#search a').removeClass('active inactive');
|
|
68
|
+
$(window).focus();
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function toggleSearchFrame(id, link) {
|
|
74
|
+
var frame = $('#nav');
|
|
75
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
|
77
|
+
frame.slideUp(100);
|
|
78
|
+
$('#search a').removeClass('active inactive');
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
$(id).addClass('active').removeClass('inactive');
|
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
|
83
|
+
frame.slideDown(100);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
function linkSummaries() {
|
|
88
|
+
$('.summary_signature').click(function() {
|
|
89
|
+
document.location = $(this).find('a').attr('href');
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function summaryToggle() {
|
|
94
|
+
$('.summary_toggle').click(function(e) {
|
|
95
|
+
e.preventDefault();
|
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
97
|
+
$('.summary_toggle').each(function() {
|
|
98
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
99
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
100
|
+
if (next.hasClass('compact')) {
|
|
101
|
+
next.toggle();
|
|
102
|
+
next.nextAll('ul.summary').first().toggle();
|
|
103
|
+
}
|
|
104
|
+
else if (next.hasClass('summary')) {
|
|
105
|
+
var list = $('<ul class="summary compact" />');
|
|
106
|
+
list.html(next.html());
|
|
107
|
+
list.find('.summary_desc, .note').remove();
|
|
108
|
+
list.find('a').each(function() {
|
|
109
|
+
$(this).html($(this).find('strong').html());
|
|
110
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
111
|
+
});
|
|
112
|
+
next.before(list);
|
|
113
|
+
next.toggle();
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
return false;
|
|
117
|
+
});
|
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
119
|
+
$('.summary_toggle').first().click();
|
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function constantSummaryToggle() {
|
|
124
|
+
$('.constants_summary_toggle').click(function(e) {
|
|
125
|
+
e.preventDefault();
|
|
126
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
127
|
+
$('.constants_summary_toggle').each(function() {
|
|
128
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
129
|
+
var next = $(this).parent().parent().nextAll('dl.constants').first();
|
|
130
|
+
if (next.hasClass('compact')) {
|
|
131
|
+
next.toggle();
|
|
132
|
+
next.nextAll('dl.constants').first().toggle();
|
|
133
|
+
}
|
|
134
|
+
else if (next.hasClass('constants')) {
|
|
135
|
+
var list = $('<dl class="constants compact" />');
|
|
136
|
+
list.html(next.html());
|
|
137
|
+
list.find('dt').each(function() {
|
|
138
|
+
$(this).addClass('summary_signature');
|
|
139
|
+
$(this).text( $(this).text().split('=')[0]);
|
|
140
|
+
if ($(this).has(".deprecated").length) {
|
|
141
|
+
$(this).addClass('deprecated');
|
|
142
|
+
};
|
|
143
|
+
});
|
|
144
|
+
// Add the value of the constant as "Tooltip" to the summary object
|
|
145
|
+
list.find('pre.code').each(function() {
|
|
146
|
+
console.log($(this).parent());
|
|
147
|
+
var dt_element = $(this).parent().prev();
|
|
148
|
+
var tooltip = $(this).text();
|
|
149
|
+
if (dt_element.hasClass("deprecated")) {
|
|
150
|
+
tooltip = 'Deprecated. ' + tooltip;
|
|
151
|
+
};
|
|
152
|
+
dt_element.attr('title', tooltip);
|
|
153
|
+
});
|
|
154
|
+
list.find('.docstring, .tags, dd').remove();
|
|
155
|
+
next.before(list);
|
|
156
|
+
next.toggle();
|
|
157
|
+
}
|
|
158
|
+
});
|
|
159
|
+
return false;
|
|
160
|
+
});
|
|
161
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
162
|
+
$('.constants_summary_toggle').first().click();
|
|
163
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
function generateTOC() {
|
|
167
|
+
if ($('#filecontents').length === 0) return;
|
|
168
|
+
var _toc = $('<ol class="top"></ol>');
|
|
169
|
+
var show = false;
|
|
170
|
+
var toc = _toc;
|
|
171
|
+
var counter = 0;
|
|
172
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
173
|
+
var i;
|
|
174
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
175
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
176
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
177
|
+
$(tags.join(', ')).each(function() {
|
|
178
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
179
|
+
if (this.id == "filecontents") return;
|
|
180
|
+
show = true;
|
|
181
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
182
|
+
if (this.id.length === 0) {
|
|
183
|
+
var proposedId = $(this).attr('toc-id');
|
|
184
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
185
|
+
else {
|
|
186
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
187
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
188
|
+
this.id = proposedId;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
if (thisTag > lastTag) {
|
|
192
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
193
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
if (thisTag < lastTag) {
|
|
197
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
198
|
+
}
|
|
199
|
+
var title = $(this).attr('toc-title');
|
|
200
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
201
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
202
|
+
lastTag = thisTag;
|
|
203
|
+
});
|
|
204
|
+
if (!show) return;
|
|
205
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
|
206
|
+
$('#content').prepend(html);
|
|
207
|
+
$('#toc').append(_toc);
|
|
208
|
+
$('#toc .hide_toc').toggle(function() {
|
|
209
|
+
$('#toc .top').slideUp('fast');
|
|
210
|
+
$('#toc').toggleClass('hidden');
|
|
211
|
+
$('#toc .title small').toggle();
|
|
212
|
+
}, function() {
|
|
213
|
+
$('#toc .top').slideDown('fast');
|
|
214
|
+
$('#toc').toggleClass('hidden');
|
|
215
|
+
$('#toc .title small').toggle();
|
|
216
|
+
});
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
function navResizeFn(e) {
|
|
220
|
+
if (e.which !== 1) {
|
|
221
|
+
navResizeFnStop();
|
|
222
|
+
return;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
sessionStorage.navWidth = e.pageX.toString();
|
|
226
|
+
$('.nav_wrap').css('width', e.pageX);
|
|
227
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
function navResizeFnStop() {
|
|
231
|
+
$(window).unbind('mousemove', navResizeFn);
|
|
232
|
+
window.removeEventListener('message', navMessageFn, false);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
function navMessageFn(e) {
|
|
236
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
|
237
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
function navResizer() {
|
|
241
|
+
$('#resizer').mousedown(function(e) {
|
|
242
|
+
e.preventDefault();
|
|
243
|
+
$(window).mousemove(navResizeFn);
|
|
244
|
+
window.addEventListener('message', navMessageFn, false);
|
|
245
|
+
});
|
|
246
|
+
$(window).mouseup(navResizeFnStop);
|
|
247
|
+
|
|
248
|
+
if (sessionStorage.navWidth) {
|
|
249
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
function navExpander() {
|
|
254
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
|
255
|
+
function postMessage() {
|
|
256
|
+
if (done) return;
|
|
257
|
+
clearTimeout(timer);
|
|
258
|
+
var opts = { action: 'expand', path: pathId };
|
|
259
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
|
260
|
+
done = true;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
window.addEventListener('message', function(event) {
|
|
264
|
+
if (event.data === 'navReady') postMessage();
|
|
265
|
+
return false;
|
|
266
|
+
}, false);
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
function mainFocus() {
|
|
270
|
+
var hash = window.location.hash;
|
|
271
|
+
if (hash !== '' && $(hash)[0]) {
|
|
272
|
+
$(hash)[0].scrollIntoView();
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
function navigationChange() {
|
|
279
|
+
// This works around the broken anchor navigation with the YARD template.
|
|
280
|
+
window.onpopstate = function() {
|
|
281
|
+
var hash = window.location.hash;
|
|
282
|
+
if (hash !== '' && $(hash)[0]) {
|
|
283
|
+
$(hash)[0].scrollIntoView();
|
|
284
|
+
}
|
|
285
|
+
};
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
$(document).ready(function() {
|
|
289
|
+
navResizer();
|
|
290
|
+
navExpander();
|
|
291
|
+
createSourceLinks();
|
|
292
|
+
createDefineLinks();
|
|
293
|
+
createFullTreeLinks();
|
|
294
|
+
searchFrameButtons();
|
|
295
|
+
linkSummaries();
|
|
296
|
+
summaryToggle();
|
|
297
|
+
constantSummaryToggle();
|
|
298
|
+
generateTOC();
|
|
299
|
+
mainFocus();
|
|
300
|
+
navigationChange();
|
|
301
|
+
});
|
|
302
|
+
|
|
303
|
+
})();
|