longleaf 0.1.0.pre.3 → 1.1.0

data/lib/longleaf/specs/system_config_builder.rb

@@ -0,0 +1,27 @@
+require 'longleaf/models/system_config_fields'
+require 'yaml'
+
+module Longleaf
+  # Test helper for constructing system configuration hashes
+  class SystemConfigBuilder
+    SCF ||= Longleaf::SystemConfigFields
+
+    attr_accessor :config
+
+    def initialize
+      @config = Hash.new
+    end
+
+    def with_index(adapter, connection)
+      @config[SCF::MD_INDEX] = Hash.new
+      @config[SCF::MD_INDEX][SCF::MD_INDEX_ADAPTER] = adapter
+      @config[SCF::MD_INDEX][SCF::MD_INDEX_CONNECTION] = connection
+      self
+    end
+
+    # @return the constructed configuration
+    def get
+      @config
+    end
+  end
+end

data/lib/longleaf/version.rb

@@ -1,3 +1,3 @@
 module Longleaf
-  VERSION = "0.1.0.pre.3"
+  VERSION = "1.1.0"
 end

data/longleaf.gemspec

@@ -6,14 +6,17 @@ require 'longleaf/version'
 Gem::Specification.new do |spec|
   spec.name          = "longleaf"
   spec.version       = Longleaf::VERSION
-  spec.authors       = ["bbpennel"]
+  spec.authors       = ["Ben Pennell"]
   spec.email         = ["bbpennel@email.unc.edu"]
 
   spec.summary       = %q{Longleaf preservation services tool}
-  spec.description   = %q{Provides a framework for performing preservation services over sets of files.}
-  spec.homepage      = "https://github.com/UNC-Libraries/"
+  spec.description   = %q{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.}
+  spec.homepage      = "https://unc-libraries.github.io/longleaf-preservation"
+  spec.metadata         = { "source_code_uri" => "https://github.com/UNC-Libraries/longleaf-preservation" }
   spec.license       = "Apache-2.0"
 
+  spec.required_ruby_version = '>= 2.3'
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
@@ -25,10 +28,20 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "thor", "~> 0.20.0"
   spec.add_dependency "yard", "~> 0.9.16"
+  spec.add_dependency "sequel", "~> 5.20"
+  spec.add_dependency "aws-sdk-s3", "~> 1.56"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.6.0"
-  spec.add_development_dependency "factory_bot", "~> 4.0"
-  spec.add_development_dependency "aruba", "~> 0.14.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rspec-core", "~> 3.8"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4"
+  spec.add_development_dependency "factory_bot", "~> 5.0"
+  spec.add_development_dependency "aruba", "~> 0.14.9"
+  spec.add_development_dependency "rubocop", '~> 0.70.0'
+  spec.add_development_dependency "rubocop-rspec", '~> 1.33'
+  spec.add_development_dependency "rubocop-performance", '~> 1.3'
+  spec.add_development_dependency "rubocop-sequel", '~> 0.0.5'
+  spec.add_development_dependency "amalgalite", "~> 1.6"
+  spec.add_development_dependency "simplecov", "~> 0.16"
 end

data/mkdocs.yml

@@ -0,0 +1,21 @@
+site_name: Longleaf Documentation
+site_url: https://unc-libraries.github.io/longleaf-preservation
+theme: readthedocs
+# repo_name: 'UNC-Libraries/Longleaf-preservation'
+#setting edit_uri to empty string removes the "Edit in" link in upper right hand corner of pages, but keeps the Github link to repo in the bottom of sidepane
+repo_url: https://github.com/UNC-Libraries/longleaf-preservation/
+site_description: 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.
+edit_uri: ''
+
+# include extra css file, in docs/
+extra_css: [extra.css]
+
+# docs markdown pages to include in sidepane navigation
+nav:
+    - Welcome: index.md
+    - About Longleaf: aboutlongleaf.md
+    - Installation: install.md
+    - Basic Usage: quickstart.md
+# pages to add and include later
+#    - Troubleshooting: trouble.md
+#    - FAQs: faq.md

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: longleaf
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.3
+  version: 1.1.0
 platform: ruby
 authors:
-- bbpennel
-autorequire: 
+- Ben Pennell
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,20 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.16
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.56'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.56'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,44 +100,159 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.14.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.9
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.70.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
-description: Provides a framework for performing preservation services over sets of
-  files.
+        version: 0.70.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.33'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: amalgalite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: 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.
 email:
 - bbpennel@email.unc.edu
 executables:
@@ -117,39 +260,175 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docs/aboutlongleaf.md
+- docs/extra.css
+- docs/img/change-file.png
+- docs/img/ll-example-preserved.png
+- docs/index.md
+- docs/install.md
+- docs/ll-example/config-example-relative.yml
+- docs/ll-example/files-dir/LLexample-PDF.pdf
+- docs/ll-example/files-dir/LLexample-TOCHANGE.txt
+- docs/ll-example/files-dir/LLexample-tokeep.txt
+- docs/ll-example/metadata-dir/.gitkeep
+- docs/ll-example/replica-files/.gitkeep
+- docs/ll-example/replica-metadata/.gitkeep
+- docs/quickstart.md
+- docs/rdocs/Longleaf.html
+- docs/rdocs/Longleaf/AppFields.html
+- docs/rdocs/Longleaf/ApplicationConfigDeserializer.html
+- docs/rdocs/Longleaf/ApplicationConfigManager.html
+- docs/rdocs/Longleaf/ApplicationConfigValidator.html
+- docs/rdocs/Longleaf/CLI.html
+- docs/rdocs/Longleaf/ChecksumMismatchError.html
+- docs/rdocs/Longleaf/ConfigBuilder.html
+- docs/rdocs/Longleaf/ConfigurationError.html
+- docs/rdocs/Longleaf/ConfigurationValidator.html
+- docs/rdocs/Longleaf/DeregisterCommand.html
+- docs/rdocs/Longleaf/DeregisterEvent.html
+- docs/rdocs/Longleaf/DeregistrationError.html
+- docs/rdocs/Longleaf/DigestHelper.html
+- docs/rdocs/Longleaf/EventError.html
+- docs/rdocs/Longleaf/EventNames.html
+- docs/rdocs/Longleaf/EventStatusTracking.html
+- docs/rdocs/Longleaf/FileCheckService.html
+- docs/rdocs/Longleaf/FileHelpers.html
+- docs/rdocs/Longleaf/FileRecord.html
+- docs/rdocs/Longleaf/FileSelector.html
+- docs/rdocs/Longleaf/FixityCheckService.html
+- docs/rdocs/Longleaf/IndexManager.html
+- docs/rdocs/Longleaf/InvalidDigestAlgorithmError.html
+- docs/rdocs/Longleaf/InvalidStoragePathError.html
+- docs/rdocs/Longleaf/Logging.html
+- docs/rdocs/Longleaf/Logging/RedirectingLogger.html
+- docs/rdocs/Longleaf/LongleafError.html
+- docs/rdocs/Longleaf/MDFields.html
+- docs/rdocs/Longleaf/MetadataBuilder.html
+- docs/rdocs/Longleaf/MetadataDeserializer.html
+- docs/rdocs/Longleaf/MetadataError.html
+- docs/rdocs/Longleaf/MetadataPersistenceManager.html
+- docs/rdocs/Longleaf/MetadataRecord.html
+- docs/rdocs/Longleaf/MetadataSerializer.html
+- docs/rdocs/Longleaf/PreservationServiceError.html
+- docs/rdocs/Longleaf/PreserveCommand.html
+- docs/rdocs/Longleaf/PreserveEvent.html
+- docs/rdocs/Longleaf/RegisterCommand.html
+- docs/rdocs/Longleaf/RegisterEvent.html
+- docs/rdocs/Longleaf/RegisteredFileSelector.html
+- docs/rdocs/Longleaf/RegistrationError.html
+- docs/rdocs/Longleaf/ReindexCommand.html
+- docs/rdocs/Longleaf/RsyncReplicationService.html
+- docs/rdocs/Longleaf/SequelIndexDriver.html
+- docs/rdocs/Longleaf/ServiceCandidateFilesystemIterator.html
+- docs/rdocs/Longleaf/ServiceCandidateIndexIterator.html
+- docs/rdocs/Longleaf/ServiceCandidateLocator.html
+- docs/rdocs/Longleaf/ServiceClassCache.html
+- docs/rdocs/Longleaf/ServiceDateHelper.html
+- docs/rdocs/Longleaf/ServiceDefinition.html
+- docs/rdocs/Longleaf/ServiceDefinitionManager.html
+- docs/rdocs/Longleaf/ServiceDefinitionValidator.html
+- docs/rdocs/Longleaf/ServiceFields.html
+- docs/rdocs/Longleaf/ServiceManager.html
+- docs/rdocs/Longleaf/ServiceMappingManager.html
+- docs/rdocs/Longleaf/ServiceMappingValidator.html
+- docs/rdocs/Longleaf/ServiceRecord.html
+- docs/rdocs/Longleaf/StorageLocation.html
+- docs/rdocs/Longleaf/StorageLocationManager.html
+- docs/rdocs/Longleaf/StorageLocationUnavailableError.html
+- docs/rdocs/Longleaf/StorageLocationValidator.html
+- docs/rdocs/Longleaf/StoragePathValidator.html
+- docs/rdocs/Longleaf/SystemConfigBuilder.html
+- docs/rdocs/Longleaf/SystemConfigFields.html
+- docs/rdocs/Longleaf/ValidateConfigCommand.html
+- docs/rdocs/Longleaf/ValidateMetadataCommand.html
+- docs/rdocs/_index.html
+- docs/rdocs/class_list.html
+- docs/rdocs/css/common.css
+- docs/rdocs/css/full_list.css
+- docs/rdocs/css/style.css
+- docs/rdocs/file.README.html
+- docs/rdocs/file_list.html
+- docs/rdocs/frames.html
+- docs/rdocs/index.html
+- docs/rdocs/js/app.js
+- docs/rdocs/js/full_list.js
+- docs/rdocs/js/jquery.js
+- docs/rdocs/method_list.html
+- docs/rdocs/top-level-namespace.html
 - exe/longleaf
 - lib/longleaf.rb
+- lib/longleaf/candidates/file_selector.rb
+- lib/longleaf/candidates/manifest_digest_provider.rb
+- lib/longleaf/candidates/physical_path_provider.rb
+- lib/longleaf/candidates/registered_file_selector.rb
+- lib/longleaf/candidates/service_candidate_filesystem_iterator.rb
+- lib/longleaf/candidates/service_candidate_index_iterator.rb
+- lib/longleaf/candidates/service_candidate_locator.rb
+- lib/longleaf/candidates/single_digest_provider.rb
 - lib/longleaf/cli.rb
-- lib/longleaf/commands/abstract_command.rb
+- lib/longleaf/commands/deregister_command.rb
+- lib/longleaf/commands/preserve_command.rb
 - lib/longleaf/commands/register_command.rb
+- lib/longleaf/commands/reindex_command.rb
 - lib/longleaf/commands/validate_config_command.rb
+- lib/longleaf/commands/validate_metadata_command.rb
 - lib/longleaf/errors.rb
+- lib/longleaf/events/deregister_event.rb
+- lib/longleaf/events/event_names.rb
+- lib/longleaf/events/event_status_tracking.rb
+- lib/longleaf/events/preserve_event.rb
 - lib/longleaf/events/register_event.rb
+- lib/longleaf/helpers/case_insensitive_hash.rb
+- lib/longleaf/helpers/digest_helper.rb
+- lib/longleaf/helpers/s3_uri_helper.rb
+- lib/longleaf/helpers/selection_options_parser.rb
+- lib/longleaf/helpers/service_date_helper.rb
+- lib/longleaf/indexing/index_manager.rb
+- lib/longleaf/indexing/sequel_index_driver.rb
 - lib/longleaf/logging.rb
 - lib/longleaf/logging/redirecting_logger.rb
 - lib/longleaf/models/app_fields.rb
 - lib/longleaf/models/file_record.rb
+- lib/longleaf/models/filesystem_metadata_location.rb
+- lib/longleaf/models/filesystem_storage_location.rb
 - lib/longleaf/models/md_fields.rb
+- lib/longleaf/models/metadata_location.rb
 - lib/longleaf/models/metadata_record.rb
+- lib/longleaf/models/s3_storage_location.rb
 - lib/longleaf/models/service_definition.rb
 - lib/longleaf/models/service_fields.rb
 - lib/longleaf/models/service_record.rb
 - lib/longleaf/models/storage_location.rb
+- lib/longleaf/models/storage_types.rb
+- lib/longleaf/models/system_config_fields.rb
+- lib/longleaf/preservation_services/file_check_service.rb
+- lib/longleaf/preservation_services/fixity_check_service.rb
+- lib/longleaf/preservation_services/rsync_replication_service.rb
+- lib/longleaf/preservation_services/s3_replication_service.rb
 - lib/longleaf/services/application_config_deserializer.rb
 - lib/longleaf/services/application_config_manager.rb
 - lib/longleaf/services/application_config_validator.rb
 - lib/longleaf/services/configuration_validator.rb
+- lib/longleaf/services/filesystem_location_validator.rb
 - lib/longleaf/services/metadata_deserializer.rb
+- lib/longleaf/services/metadata_persistence_manager.rb
 - lib/longleaf/services/metadata_serializer.rb
+- lib/longleaf/services/metadata_validator.rb
+- lib/longleaf/services/s3_location_validator.rb
+- lib/longleaf/services/service_class_cache.rb
 - lib/longleaf/services/service_definition_manager.rb
 - lib/longleaf/services/service_definition_validator.rb
 - lib/longleaf/services/service_manager.rb
@@ -157,15 +436,21 @@ files:
 - lib/longleaf/services/service_mapping_validator.rb
 - lib/longleaf/services/storage_location_manager.rb
 - lib/longleaf/services/storage_location_validator.rb
-- lib/longleaf/services/storage_path_validator.rb
 - lib/longleaf/specs/config_builder.rb
+- lib/longleaf/specs/config_validator_helpers.rb
+- lib/longleaf/specs/custom_matchers.rb
+- lib/longleaf/specs/file_helpers.rb
+- lib/longleaf/specs/metadata_builder.rb
+- lib/longleaf/specs/system_config_builder.rb
 - lib/longleaf/version.rb
 - longleaf.gemspec
-homepage: https://github.com/UNC-Libraries/
+- mkdocs.yml
+homepage: https://unc-libraries.github.io/longleaf-preservation
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/UNC-Libraries/longleaf-preservation
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,16 +458,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Longleaf preservation services tool
 test_files: []