RubyGems - longleaf - Versions diffs - 0.2.0.pre.1 → 0.3.0 - Mend

longleaf 0.2.0.pre.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (165) hide show

checksums.yaml +4 -4
data/.circleci/config.yml +84 -0
data/.gitignore +4 -2
data/.rubocop.yml +42 -2
data/.rubocop_todo.yml +390 -311
data/.yardopts +1 -0
data/Gemfile +16 -1
data/README.md +67 -13
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 +47 -15
data/lib/longleaf/candidates/registered_file_selector.rb +67 -0
data/lib/longleaf/candidates/service_candidate_filesystem_iterator.rb +29 -35
data/lib/longleaf/candidates/service_candidate_index_iterator.rb +84 -0
data/lib/longleaf/candidates/service_candidate_locator.rb +9 -4
data/lib/longleaf/cli.rb +162 -80
data/lib/longleaf/commands/deregister_command.rb +12 -11
data/lib/longleaf/commands/preserve_command.rb +13 -8
data/lib/longleaf/commands/register_command.rb +9 -6
data/lib/longleaf/commands/reindex_command.rb +92 -0
data/lib/longleaf/commands/validate_config_command.rb +27 -6
data/lib/longleaf/commands/validate_metadata_command.rb +11 -9
data/lib/longleaf/errors.rb +12 -12
data/lib/longleaf/events/deregister_event.rb +13 -15
data/lib/longleaf/events/event_status_tracking.rb +7 -7
data/lib/longleaf/events/preserve_event.rb +24 -14
data/lib/longleaf/events/register_event.rb +21 -35
data/lib/longleaf/helpers/digest_helper.rb +4 -4
data/lib/longleaf/helpers/service_date_helper.rb +5 -6
data/lib/longleaf/indexing/index_manager.rb +101 -0
data/lib/longleaf/indexing/sequel_index_driver.rb +324 -0
data/lib/longleaf/logging.rb +4 -4
data/lib/longleaf/logging/redirecting_logger.rb +20 -20
data/lib/longleaf/models/app_fields.rb +2 -1
data/lib/longleaf/models/file_record.rb +10 -6
data/lib/longleaf/models/md_fields.rb +1 -1
data/lib/longleaf/models/metadata_record.rb +22 -12
data/lib/longleaf/models/service_definition.rb +3 -3
data/lib/longleaf/models/service_fields.rb +1 -1
data/lib/longleaf/models/service_record.rb +6 -5
data/lib/longleaf/models/storage_location.rb +26 -7
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 +16 -14
data/lib/longleaf/preservation_services/rsync_replication_service.rb +32 -31
data/lib/longleaf/services/application_config_deserializer.rb +55 -18
data/lib/longleaf/services/application_config_manager.rb +16 -4
data/lib/longleaf/services/application_config_validator.rb +1 -2
data/lib/longleaf/services/configuration_validator.rb +6 -4
data/lib/longleaf/services/metadata_deserializer.rb +40 -38
data/lib/longleaf/services/metadata_persistence_manager.rb +46 -0
data/lib/longleaf/services/metadata_serializer.rb +23 -22
data/lib/longleaf/services/service_class_cache.rb +15 -15
data/lib/longleaf/services/service_definition_manager.rb +5 -6
data/lib/longleaf/services/service_definition_validator.rb +5 -6
data/lib/longleaf/services/service_manager.rb +37 -17
data/lib/longleaf/services/service_mapping_manager.rb +9 -9
data/lib/longleaf/services/service_mapping_validator.rb +9 -10
data/lib/longleaf/services/storage_location_manager.rb +22 -8
data/lib/longleaf/services/storage_location_validator.rb +11 -8
data/lib/longleaf/services/storage_path_validator.rb +1 -1
data/lib/longleaf/specs/config_builder.rb +30 -17
data/lib/longleaf/specs/custom_matchers.rb +1 -1
data/lib/longleaf/specs/file_helpers.rb +15 -14
data/lib/longleaf/specs/metadata_builder.rb +91 -0
data/lib/longleaf/specs/system_config_builder.rb +27 -0
data/lib/longleaf/version.rb +1 -1
data/longleaf.gemspec +17 -7
data/mkdocs.yml +20 -0
metadata +233 -22

data/docs/rdocs/Longleaf/ServiceMappingManager.html ADDED Viewed

@@ -0,0 +1,410 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: Longleaf::ServiceMappingManager
+    &mdash; Documentation by YARD 0.9.19
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "Longleaf::ServiceMappingManager";
+  relpath = '../';
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (S)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Longleaf.html" title="Longleaf (module)">Longleaf</a></span></span>
+     &raquo;
+    <span class="title">ServiceMappingManager</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: Longleaf::ServiceMappingManager
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">Longleaf::ServiceMappingManager</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/longleaf/services/service_mapping_manager.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Manager which loads and provides access to location to service mappings</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(config)  &#x21d2; ServiceMappingManager </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of ServiceMappingManager.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#list_services-instance_method" title="#list_services (instance method)">#<strong>list_services</strong>(loc_name)  &#x21d2; Array </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Gets a list of service names associated with the given location.</p>
+</div></span>
+</li>
+    </ul>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    #<strong>initialize</strong>(config)  &#x21d2; <tt><span class='object_link'><a href="" title="Longleaf::ServiceMappingManager (class)">ServiceMappingManager</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of ServiceMappingManager</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>config</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>has representation of the application configuration</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt>ArgumentError</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/longleaf/services/service_mapping_manager.rb', line 10</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Configuration must be provided</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
+  <span class='id identifier rubyid_mappings_config'>mappings_config</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>SERVICE_MAPPINGS</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Service mappings configuration must be provided</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_mappings_config'>mappings_config</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='ivar'>@loc_to_services</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_mappings_config'>mappings_config</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_mapping'>mapping</span><span class='op'>|</span>
+    <span class='id identifier rubyid_locations'>locations</span> <span class='op'>=</span> <span class='id identifier rubyid_mapping'>mapping</span><span class='lbracket'>[</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>LOCATIONS</span><span class='rbracket'>]</span>
+    <span class='id identifier rubyid_services'>services</span> <span class='op'>=</span> <span class='id identifier rubyid_mapping'>mapping</span><span class='lbracket'>[</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>SERVICES</span><span class='rbracket'>]</span>
+    <span class='id identifier rubyid_locations'>locations</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_locations'>locations</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_locations'>locations</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_services'>services</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_services'>services</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_services'>services</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_locations'>locations</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_loc_name'>loc_name</span><span class='op'>|</span>
+      <span class='ivar'>@loc_to_services</span><span class='lbracket'>[</span><span class='id identifier rubyid_loc_name'>loc_name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>unless</span> <span class='ivar'>@loc_to_services</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_loc_name'>loc_name</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_service_set'>service_set</span> <span class='op'>=</span> <span class='ivar'>@loc_to_services</span><span class='lbracket'>[</span><span class='id identifier rubyid_loc_name'>loc_name</span><span class='rbracket'>]</span>
+      <span class='kw'>if</span> <span class='id identifier rubyid_services'>services</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
+        <span class='id identifier rubyid_service_set'>service_set</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_services'>services</span><span class='rparen'>)</span>
+      <span class='kw'>else</span>
+        <span class='id identifier rubyid_service_set'>service_set</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='id identifier rubyid_services'>services</span><span class='rparen'>)</span>
+      <span class='kw'>end</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='ivar'>@loc_to_services</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_loc'>loc</span><span class='comma'>,</span> <span class='id identifier rubyid_services'>services</span><span class='op'>|</span> <span class='id identifier rubyid_services'>services</span><span class='period'>.</span><span class='id identifier rubyid_uniq!'>uniq!</span> <span class='rbrace'>}</span>
+  <span class='ivar'>@loc_to_services</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="list_services-instance_method">
+    #<strong>list_services</strong>(loc_name)  &#x21d2; <tt>Array</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Gets a list of service names associated with the given location</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>loc_name</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>name of the location to lookup</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>a list of service names associated with the location</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+44
+45
+46</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/longleaf/services/service_mapping_manager.rb', line 44</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_list_services'>list_services</span><span class='lparen'>(</span><span class='id identifier rubyid_loc_name'>loc_name</span><span class='rparen'>)</span>
+  <span class='ivar'>@loc_to_services</span><span class='lbracket'>[</span><span class='id identifier rubyid_loc_name'>loc_name</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Tue May 28 15:48:02 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.19 (ruby-2.6.3).
+</div>
+    </div>
+  </body>
+</html>

data/docs/rdocs/Longleaf/ServiceMappingValidator.html ADDED Viewed

@@ -0,0 +1,347 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: Longleaf::ServiceMappingValidator
+    &mdash; Documentation by YARD 0.9.19
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "Longleaf::ServiceMappingValidator";
+  relpath = '../';
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (S)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Longleaf.html" title="Longleaf (module)">Longleaf</a></span></span>
+     &raquo;
+    <span class="title">ServiceMappingValidator</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: Longleaf::ServiceMappingValidator
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="ConfigurationValidator.html" title="Longleaf::ConfigurationValidator (class)">ConfigurationValidator</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="ConfigurationValidator.html" title="Longleaf::ConfigurationValidator (class)">ConfigurationValidator</a></span></li>
+            <li class="next">Longleaf::ServiceMappingValidator</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/longleaf/services/service_mapping_validator.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Validates application configuration of service to location mappings</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#validate_config-class_method" title="validate_config (class method)">.<strong>validate_config</strong>(config)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Validates service mapping configuration to ensure that it is syntactically and referentially correct.</p>
+</div></span>
+</li>
+        <li class="private ">
+  <span class="summary_signature">
+      <a href="#validate_mapping_field-class_method" title="validate_mapping_field (class method)">.<strong>validate_mapping_field</strong>(field, mapping, valid_values)  &#x21d2; Object </a>
+  </span>
+  <span class="note title private">private</span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="ConfigurationValidator.html" title="Longleaf::ConfigurationValidator (class)">ConfigurationValidator</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="ConfigurationValidator.html#assert-class_method" title="Longleaf::ConfigurationValidator.assert (method)">assert</a></span></p>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="validate_config-class_method">
+    .<strong>validate_config</strong>(config)  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Validates service mapping configuration to ensure that it is syntactically and referentially correct.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>config</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>hash containing the application configuration</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/longleaf/services/service_mapping_validator.rb', line 14</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_validate_config'>validate_config</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Configuration must be a hash, but a </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> was provided</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>==</span> <span class='const'>Hash</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Configuration must contain a root &#39;</span><span class='embexpr_beg'>#{</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>SERVICE_MAPPINGS</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; key</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>SERVICE_MAPPINGS</span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_mappings'>mappings</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>SERVICE_MAPPINGS</span><span class='rbracket'>]</span>
+  <span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_mappings'>mappings</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_mappings'>mappings</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
+  <span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&#39;</span><span class='embexpr_beg'>#{</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>SERVICE_MAPPINGS</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; must be an array of mappings</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_mappings'>mappings</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_service_names'>service_names</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>SERVICES</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
+  <span class='id identifier rubyid_location_names'>location_names</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>LOCATIONS</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
+  <span class='id identifier rubyid_mappings'>mappings</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_mapping'>mapping</span><span class='op'>|</span>
+    <span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Mapping must be a hash, but received </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_mapping'>mapping</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> instead</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_mapping'>mapping</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_validate_mapping_field'>validate_mapping_field</span><span class='lparen'>(</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>LOCATIONS</span><span class='comma'>,</span> <span class='id identifier rubyid_mapping'>mapping</span><span class='comma'>,</span> <span class='id identifier rubyid_location_names'>location_names</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_validate_mapping_field'>validate_mapping_field</span><span class='lparen'>(</span><span class='const'>AF</span><span class='op'>::</span><span class='const'>SERVICES</span><span class='comma'>,</span> <span class='id identifier rubyid_mapping'>mapping</span><span class='comma'>,</span> <span class='id identifier rubyid_service_names'>service_names</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="validate_mapping_field-class_method">
+    .<strong>validate_mapping_field</strong>(field, mapping, valid_values)  &#x21d2; <tt>Object</tt>  <span class="extras">(private)</span>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/longleaf/services/service_mapping_validator.rb', line 32</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_validate_mapping_field'>validate_mapping_field</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='comma'>,</span> <span class='id identifier rubyid_mapping'>mapping</span><span class='comma'>,</span> <span class='id identifier rubyid_valid_values'>valid_values</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Mapping must contain a &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_field'>field</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; field</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_mapping'>mapping</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_field_values'>field_values</span> <span class='op'>=</span> <span class='id identifier rubyid_mapping'>mapping</span><span class='lbracket'>[</span><span class='id identifier rubyid_field'>field</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Mapping &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_field'>field</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; field must be either a string or an array, but received &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_field_values'>field_values</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; instead</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+      <span class='id identifier rubyid_field_values'>field_values</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_field_values'>field_values</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Mapping must specify one or more value in the &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_field'>field</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; field</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>!</span><span class='id identifier rubyid_field_values'>field_values</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_check_values'>check_values</span> <span class='op'>=</span> <span class='id identifier rubyid_field_values'>field_values</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='lbracket'>[</span><span class='id identifier rubyid_field_values'>field_values</span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='id identifier rubyid_field_values'>field_values</span>
+  <span class='id identifier rubyid_check_values'>check_values</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
+    <span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Mapping &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_field'>field</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; specifies value &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39;, but no </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_field'>field</span><span class='embexpr_end'>}</span><span class='tstring_content'> with that name exist</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+        <span class='id identifier rubyid_valid_values'>valid_values</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Tue May 28 15:48:02 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.19 (ruby-2.6.3).
+</div>
+    </div>
+  </body>
+</html>