moab-versioning 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e5f606dfba2cd8e6b58c044835b380fbfe6fbd2
-  data.tar.gz: 53ac0623d30970defef6303eb5a60dbc08251b72
+  metadata.gz: b369a2ecc1e65bdcf4a40dfde46176838912ce2f
+  data.tar.gz: 8e9b829361e700e12220e203204433a1c56e7b55
 SHA512:
-  metadata.gz: 330703dff850a3fd21e9a70839df565811b668cbdc228cf59ceafc8633b0cb703893298a054936fc5e87f2d66fc76e2599baa4dcb6c7eb16b7d1438e9bdcb738
-  data.tar.gz: 4f55f879bd0d6dd5e0ff3ee0f8ce7db04566006cf7af5ddd0a252c521e6c79a7f0857808756f09bb0a05907eece777e0ffd8d171f463467d92f5a0705a7f8f9f
+  metadata.gz: b076d84c4bc16759c646234d37625068922cdbbbbe68add37bb0922c21d9963441ce7d280bab4f1d5511a078364004b0c59c9d7b4a376f60fe7f37ed8844f674
+  data.tar.gz: 81a48dbd61d60ca5469cba9d330970cb4b929a003bcea55177294f8426eca1d84e223988fdf70ac95ee818e38787992ae2355d3f3fe7d8c1718d8807a78fa803

data/lib/moab/storage_object_validator.rb

@@ -16,6 +16,8 @@ module Moab
     MANIFEST_INVENTORY_PATH = File.join(MANIFESTS_DIR, "manifestInventory.xml").freeze
     SIGNATURE_CATALOG_PATH = File.join(MANIFESTS_DIR, "signatureCatalog.xml").freeze
 
+    FORBIDDEN_CONTENT_SUB_DIRS = ([DATA_DIR, MANIFESTS_DIR] + EXPECTED_DATA_SUB_DIRS).freeze
+
     # error codes
     INCORRECT_DIR_CONTENTS = 0
     MISSING_DIR = 1
@@ -30,6 +32,7 @@ module Moab
     NO_FILES_IN_METADATA_DIR = 10
     NO_FILES_IN_CONTENT_DIR = 11
     CONTENT_SUB_DIRS_DETECTED = 12
+    BAD_SUB_DIR_IN_CONTENT_DIR = 13
 
     attr_reader :storage_obj_path
 
@@ -38,11 +41,11 @@ module Moab
       @directory_entries_hash = {}
     end
 
-    def validation_errors
+    def validation_errors(allow_content_subdirs=true)
       errors = []
       errors.concat check_correctly_named_version_dirs
       errors.concat check_sequential_version_dirs if errors.empty?
-      errors.concat check_correctly_formed_moab if errors.empty?
+      errors.concat check_correctly_formed_moab(allow_content_subdirs) if errors.empty?
       errors
     end
 
@@ -61,7 +64,8 @@ module Moab
           VERSIONS_NOT_IN_ORDER => "Should contain only sequential version directories. Current directories: %{addl}",
           NO_FILES_IN_METADATA_DIR => "Version %{addl}: No files present in metadata dir",
           NO_FILES_IN_CONTENT_DIR => "Version %{addl}: No files present in content dir",
-          CONTENT_SUB_DIRS_DETECTED => "Version %{addl}: content directory should only contain files, not directories"
+          CONTENT_SUB_DIRS_DETECTED => "Version %{addl}: content directory should only contain files, not directories",
+          BAD_SUB_DIR_IN_CONTENT_DIR => "Version %{addl}: content directory has forbidden sub-directory name: vnnnn or #{FORBIDDEN_CONTENT_SUB_DIRS}"
         }.freeze
     end
 
@@ -75,11 +79,15 @@ module Moab
       errors = []
       errors << result_hash(MISSING_DIR, 'no versions exist') unless version_directories.count > 0
       version_directories.each do |version_dir|
-        errors << result_hash(VERSION_DIR_BAD_FORMAT, version_dir) unless version_dir =~ /^[v]\d{4}$/
+        errors << result_hash(VERSION_DIR_BAD_FORMAT, version_dir) unless version_dir_format?(version_dir)
       end
       errors
     end
 
+    def version_dir_format?(dirname)
+      dirname =~ /^[v]\d{4}$/
+    end
+
     # call only if the version directories are "correctly named" vdddd
     def check_sequential_version_dirs
       errors = []
@@ -93,14 +101,14 @@ module Moab
       errors
     end
 
-    def check_correctly_formed_moab
+    def check_correctly_formed_moab(allow_content_subdirs=true)
       errors = []
       version_directories.each do |version_dir|
         version_path = File.join(storage_obj_path, version_dir)
         version_error_count = errors.size
         errors.concat check_version_sub_dirs(version_path, version_dir)
         errors.concat check_required_manifest_files(version_path, version_dir) if version_error_count == errors.size
-        errors.concat check_data_directory(version_path, version_dir) if version_error_count == errors.size
+        errors.concat check_data_directory(version_path, version_dir, allow_content_subdirs) if version_error_count == errors.size
       end
       errors
     end
@@ -119,13 +127,13 @@ module Moab
       errors
     end
 
-    def check_data_directory(version_path, version)
+    def check_data_directory(version_path, version, allow_content_subdirs=true)
       errors = []
       data_dir_path = File.join(version_path, DATA_DIR)
       data_sub_dirs = directory_entries(data_dir_path)
       errors.concat check_data_sub_dirs(version, data_sub_dirs)
       errors.concat check_metadata_dir_files_only(version_path) if errors.empty?
-      errors.concat check_optional_content_dir_files_only(version_path) if data_sub_dirs.include?('content') && errors.empty?
+      errors.concat check_optional_content_dir(version_path, allow_content_subdirs) if data_sub_dirs.include?('content') && errors.empty?
       errors
     end
 
@@ -141,14 +149,25 @@ module Moab
       errors
     end
 
-    def check_optional_content_dir_files_only(version_path)
+    def check_optional_content_dir(version_path, allow_content_subdirs=true)
       errors = []
       content_dir_path = File.join(version_path, DATA_DIR, CONTENT_DIR)
       errors << result_hash(NO_FILES_IN_CONTENT_DIR, basename(version_path)) if directory_entries(content_dir_path).empty?
-      errors << result_hash(CONTENT_SUB_DIRS_DETECTED, basename(version_path)) if contains_sub_dir?(content_dir_path)
+      errors << result_hash(CONTENT_SUB_DIRS_DETECTED, basename(version_path)) if contains_sub_dir?(content_dir_path) && !allow_content_subdirs
+      if allow_content_subdirs && contains_sub_dir?(content_dir_path) && contains_forbidden_content_sub_dir?(content_dir_path)
+        errors << result_hash(BAD_SUB_DIR_IN_CONTENT_DIR, basename(version_path))
+      end
       errors
     end
 
+    def contains_forbidden_content_sub_dir?(path)
+      sub_dirs(path).detect { |sub_dir| content_sub_dir_forbidden?(sub_dir) }
+    end
+
+    def content_sub_dir_forbidden?(dirname)
+      FORBIDDEN_CONTENT_SUB_DIRS.include?(dirname) || version_dir_format?(dirname)
+    end
+
     def subset?(first_array, second_array)
       first_array.to_set.subset?(second_array.to_set)
     end
@@ -208,6 +227,10 @@ module Moab
       directory_entries(path).detect { |entry| File.file?(File.join(path, entry)) }
     end
 
+    def sub_dirs(path)
+      directory_entries(path).select { |entry| File.directory?(File.join(path, entry)) }
+    end
+
     def basename(path)
       path.split(File::SEPARATOR)[-1]
     end

data/lib/stanford/storage_object_validator.rb

@@ -8,9 +8,9 @@ module Stanford
     # keep from stepping on previously defined error code constants.
     DRUID_MISMATCH = superclass.error_code_to_messages.keys.max + 1
 
-    def validation_errors
+    def validation_errors(allow_content_subdirs=true)
       errors = []
-      errors.concat super
+      errors.concat super(allow_content_subdirs)
       errors.concat(identify_druid) if errors.empty?
       errors
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moab-versioning
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Darren Weber
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2017-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: confstruct