assembly-objectfile 1.13.0 → 2.0.0

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ require 'simplecov'
 SimpleCov.start
 
 require File.expand_path("#{File.dirname(__FILE__)}/../config/boot")
-require 'byebug'
+require 'pry-byebug'
 
 RSpec.configure do |config|
   config.order = 'random'
@@ -14,45 +14,16 @@ TEST_DATA_DIR = File.join(Assembly::PATH_TO_GEM, 'spec', 'test_data')
 TEST_INPUT_DIR       = File.join(TEST_DATA_DIR, 'input')
 TEST_OUTPUT_DIR      = File.join(TEST_DATA_DIR, 'output')
 TEST_TIF_INPUT_FILE  = File.join(TEST_INPUT_DIR, 'test.tif')
-TEST_TIF_INPUT_FILE2  = File.join(TEST_INPUT_DIR, 'test2.tif')
-TEST_JPEG_INPUT_FILE  = File.join(TEST_INPUT_DIR, 'test.jpg')
+TEST_JPEG_INPUT_FILE = File.join(TEST_INPUT_DIR, 'test.jpg')
 TEST_JP2_INPUT_FILE = File.join(TEST_INPUT_DIR, 'test.jp2')
-TEST_JP2_INPUT_FILE2 = File.join(TEST_INPUT_DIR, 'test2.jp2')
-TEST_SVG_INPUT_FILE  = File.join(TEST_INPUT_DIR, 'test.svg')
 TEST_JP2_OUTPUT_FILE = File.join(TEST_OUTPUT_DIR, 'test.jp2')
-TEST_PDF_FILE = File.join(TEST_INPUT_DIR, 'test.pdf')
-
-TEST_DPG_TIF = File.join(TEST_INPUT_DIR, 'oo000oo0001', '00', 'oo000oo0001_00_001.tif')
-TEST_DPG_TIF2 = File.join(TEST_INPUT_DIR, 'oo000oo0001', '00', 'oo000oo0001_00_002.tif')
-TEST_DPG_JP = File.join(TEST_INPUT_DIR, 'oo000oo0001', '05', 'oo000oo0001_05_001.jp2')
-TEST_DPG_JP2 = File.join(TEST_INPUT_DIR, 'oo000oo0001', '05', 'oo000oo0001_05_002.jp2')
-TEST_DPG_PDF = File.join(TEST_INPUT_DIR, 'oo000oo0001', '15', 'oo000oo0001_15_001.pdf')
-TEST_DPG_PDF2 = File.join(TEST_INPUT_DIR, 'oo000oo0001', '15', 'oo000oo0001_15_002.pdf')
-TEST_DPG_SPECIAL_PDF1 = File.join(TEST_INPUT_DIR, 'oo000oo0001', 'oo000oo0001_book.pdf')
-TEST_DPG_SPECIAL_PDF2 = File.join(TEST_INPUT_DIR, 'oo000oo0001', '31', 'oo000oo0001_31_001.pdf')
-TEST_DPG_SPECIAL_TIF = File.join(TEST_INPUT_DIR, 'oo000oo0001', '50', 'oo000oo0001_50_001.tif')
 
 TEST_TIFF_NO_COLOR_FILE = File.join(TEST_INPUT_DIR, 'test_no_color_profile.tif')
 
 TEST_RES1_TIF1 = File.join(TEST_INPUT_DIR, 'res1_image1.tif')
-TEST_RES1_JP1 = File.join(TEST_INPUT_DIR, 'res1_image1.jp2')
-TEST_RES1_TIF2 = File.join(TEST_INPUT_DIR, 'res1_image2.tif')
-TEST_RES1_JP2 = File.join(TEST_INPUT_DIR, 'res1_image2.jp2')
-TEST_RES1_TEI = File.join(TEST_INPUT_DIR, 'res1_teifile.txt')
 TEST_RES1_TEXT = File.join(TEST_INPUT_DIR, 'res1_textfile.txt')
 TEST_RES1_PDF = File.join(TEST_INPUT_DIR, 'res1_transcript.pdf')
 
-TEST_RES2_TIF1 = File.join(TEST_INPUT_DIR, 'res2_image1.tif')
-TEST_RES2_JP1 = File.join(TEST_INPUT_DIR, 'res2_image1.jp2')
-TEST_RES2_TIF2 = File.join(TEST_INPUT_DIR, 'res2_image2.tif')
-TEST_RES2_JP2 = File.join(TEST_INPUT_DIR, 'res2_image2.jp2')
-TEST_RES2_TEI = File.join(TEST_INPUT_DIR, 'res2_teifile.txt')
-TEST_RES2_TEXT = File.join(TEST_INPUT_DIR, 'res2_textfile.txt')
-
-TEST_RES3_TIF1 = File.join(TEST_INPUT_DIR, 'res3_image1.tif')
-TEST_RES3_JP1 = File.join(TEST_INPUT_DIR, 'res3_image1.jp2')
-TEST_RES3_TEI = File.join(TEST_INPUT_DIR, 'res3_teifile.txt')
-
 TEST_FILE_NO_EXIF = File.join(TEST_INPUT_DIR, 'file_with_no_exif.xml')
 
 TEST_JSON_FILE = File.join(TEST_INPUT_DIR, 'test.json')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-objectfile
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -41,34 +41,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: dry-struct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: dry-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +97,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +196,7 @@ files:
 - ".rubocop_todo.yml"
 - ".rvmrc.example"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -218,58 +205,24 @@ files:
 - bin/run_all_tests
 - config/boot.rb
 - lib/assembly-objectfile.rb
-- lib/assembly-objectfile/content_metadata.rb
-- lib/assembly-objectfile/content_metadata/config.rb
-- lib/assembly-objectfile/content_metadata/file.rb
-- lib/assembly-objectfile/content_metadata/file_set.rb
-- lib/assembly-objectfile/content_metadata/file_set_builder.rb
-- lib/assembly-objectfile/content_metadata/nokogiri_builder.rb
 - lib/assembly-objectfile/object_file.rb
-- lib/assembly-objectfile/object_fileable.rb
 - lib/assembly-objectfile/version.rb
 - profiles/AdobeRGB1998.icc
 - profiles/DotGain20.icc
 - profiles/sRGBIEC6196621.icc
-- spec/content_metadata_spec.rb
 - spec/object_file_spec.rb
 - spec/spec_helper.rb
 - spec/test_data/empty.txt
 - spec/test_data/input/.empty
 - spec/test_data/input/file_with_no_exif.xml
-- spec/test_data/input/oo000oo0001/00/oo000oo0001_00_001.tif
-- spec/test_data/input/oo000oo0001/00/oo000oo0001_00_002.tif
-- spec/test_data/input/oo000oo0001/05/oo000oo0001_05_001.jp2
-- spec/test_data/input/oo000oo0001/05/oo000oo0001_05_002.jp2
-- spec/test_data/input/oo000oo0001/15/oo000oo0001_15_001.pdf
-- spec/test_data/input/oo000oo0001/15/oo000oo0001_15_002.pdf
-- spec/test_data/input/oo000oo0001/31/oo000oo0001_31_001.pdf
-- spec/test_data/input/oo000oo0001/50/oo000oo0001_50_001.tif
-- spec/test_data/input/oo000oo0001/oo000oo0001_book.pdf
-- spec/test_data/input/res1_image1.jp2
 - spec/test_data/input/res1_image1.tif
-- spec/test_data/input/res1_image2.jp2
-- spec/test_data/input/res1_image2.tif
-- spec/test_data/input/res1_teifile.txt
 - spec/test_data/input/res1_textfile.txt
 - spec/test_data/input/res1_transcript.pdf
-- spec/test_data/input/res2_image1.jp2
-- spec/test_data/input/res2_image1.tif
-- spec/test_data/input/res2_image2.jp2
-- spec/test_data/input/res2_image2.tif
-- spec/test_data/input/res2_teifile.txt
-- spec/test_data/input/res2_textfile.txt
-- spec/test_data/input/res3_image1.jp2
-- spec/test_data/input/res3_image1.tif
-- spec/test_data/input/res3_teifile.txt
 - spec/test_data/input/someobject.obj
 - spec/test_data/input/someobject.ply
 - spec/test_data/input/test.jp2
 - spec/test_data/input/test.json
-- spec/test_data/input/test.pdf
-- spec/test_data/input/test.svg
 - spec/test_data/input/test.tif
-- spec/test_data/input/test2.jp2
-- spec/test_data/input/test2.tif
 - spec/test_data/input/test_no_color_profile.tif
 homepage: https://github.com/sul-dlss/assembly-objectfile
 licenses:
@@ -291,50 +244,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby immplementation of file services needed to prepare objects to be accessioned
   in SULAIR digital library
-test_files:
-- spec/content_metadata_spec.rb
-- spec/object_file_spec.rb
-- spec/spec_helper.rb
-- spec/test_data/empty.txt
-- spec/test_data/input/.empty
-- spec/test_data/input/file_with_no_exif.xml
-- spec/test_data/input/oo000oo0001/00/oo000oo0001_00_001.tif
-- spec/test_data/input/oo000oo0001/00/oo000oo0001_00_002.tif
-- spec/test_data/input/oo000oo0001/05/oo000oo0001_05_001.jp2
-- spec/test_data/input/oo000oo0001/05/oo000oo0001_05_002.jp2
-- spec/test_data/input/oo000oo0001/15/oo000oo0001_15_001.pdf
-- spec/test_data/input/oo000oo0001/15/oo000oo0001_15_002.pdf
-- spec/test_data/input/oo000oo0001/31/oo000oo0001_31_001.pdf
-- spec/test_data/input/oo000oo0001/50/oo000oo0001_50_001.tif
-- spec/test_data/input/oo000oo0001/oo000oo0001_book.pdf
-- spec/test_data/input/res1_image1.jp2
-- spec/test_data/input/res1_image1.tif
-- spec/test_data/input/res1_image2.jp2
-- spec/test_data/input/res1_image2.tif
-- spec/test_data/input/res1_teifile.txt
-- spec/test_data/input/res1_textfile.txt
-- spec/test_data/input/res1_transcript.pdf
-- spec/test_data/input/res2_image1.jp2
-- spec/test_data/input/res2_image1.tif
-- spec/test_data/input/res2_image2.jp2
-- spec/test_data/input/res2_image2.tif
-- spec/test_data/input/res2_teifile.txt
-- spec/test_data/input/res2_textfile.txt
-- spec/test_data/input/res3_image1.jp2
-- spec/test_data/input/res3_image1.tif
-- spec/test_data/input/res3_teifile.txt
-- spec/test_data/input/someobject.obj
-- spec/test_data/input/someobject.ply
-- spec/test_data/input/test.jp2
-- spec/test_data/input/test.json
-- spec/test_data/input/test.pdf
-- spec/test_data/input/test.svg
-- spec/test_data/input/test.tif
-- spec/test_data/input/test2.jp2
-- spec/test_data/input/test2.tif
-- spec/test_data/input/test_no_color_profile.tif
+test_files: []

data/lib/assembly-objectfile/content_metadata/config.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry-struct'
-require 'dry-types'
-
-module Assembly
-  class ContentMetadata
-    # Types for the configuration
-    module Types
-      include Dry.Types()
-    end
-
-    # Represents a configuration for generating the content metadata
-    class Config < Dry::Struct
-      STYLES = %w[image file book map 3d document webarchive-seed].freeze
-      READING_ORDERS = %w[ltr rtl].freeze
-      attribute :auto_labels, Types::Strict::Bool.default(true)
-      attribute :flatten_folder_structure, Types::Strict::Bool.default(false)
-      attribute :add_file_attributes, Types::Strict::Bool.default(false)
-      attribute :add_exif, Types::Strict::Bool.default(false)
-      attribute :file_attributes, Types::Strict::Hash.default({}.freeze)
-      attribute :type, Types::Strict::String.enum(*STYLES)
-      attribute :reading_order, Types::Strict::String.default('ltr').enum(*READING_ORDERS)
-    end
-  end
-end

data/lib/assembly-objectfile/content_metadata/file.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/module/delegation'
-
-module Assembly
-  class ContentMetadata
-    # Represents a single File
-    class File
-      # default publish/preserve/shelve attributes used in content metadata
-      # if no mimetype specific attributes are specified for a given file, define some defaults, and override for specific mimetypes below
-      ATTRIBUTES_FOR_TYPE = {
-        'default' => { preserve: 'yes', shelve: 'no', publish: 'no' },
-        'image/tif' => { preserve: 'yes', shelve: 'no', publish: 'no' },
-        'image/tiff' => { preserve: 'yes', shelve: 'no', publish: 'no' },
-        'image/jp2' => { preserve: 'no', shelve: 'yes', publish: 'yes' },
-        'image/jpeg' => { preserve: 'yes', shelve: 'no', publish: 'no' },
-        'audio/wav' => { preserve: 'yes', shelve: 'no', publish: 'no' },
-        'audio/x-wav' => { preserve: 'yes', shelve: 'no', publish: 'no' },
-        'audio/mp3' => { preserve: 'no', shelve: 'yes', publish: 'yes' },
-        'audio/mpeg' => { preserve: 'no', shelve: 'yes', publish: 'yes' },
-        'application/pdf' => { preserve: 'yes', shelve: 'yes', publish: 'yes' },
-        'plain/text' => { preserve: 'yes', shelve: 'yes', publish: 'yes' },
-        'text/plain' => { preserve: 'yes', shelve: 'yes', publish: 'yes' },
-        'image/png' => { preserve: 'yes', shelve: 'yes', publish: 'no' },
-        'application/zip' => { preserve: 'yes', shelve: 'no', publish: 'no' },
-        'application/json' => { preserve: 'yes', shelve: 'yes', publish: 'yes' }
-      }.freeze
-
-      # @param [Symbol] bundle
-      # @param [Assembly::ObjectFile] file
-      # @param style
-      def initialize(file:, bundle: nil, style: nil)
-        @bundle = bundle
-        @file = file
-        @style = style
-      end
-
-      delegate :sha1, :md5, :provider_md5, :provider_sha1, :mimetype, :filesize, :image?, :valid_image?, to: :file
-
-      def file_id(common_path:, flatten_folder_structure:)
-        # set file id attribute, first check the relative_path parameter on the object, and if it is set, just use that
-        return file.relative_path if file.relative_path
-
-        # if the relative_path attribute is not set, then use the path attribute and check to see if we need to remove the common part of the path
-        file_id = common_path ? file.path.gsub(common_path, '') : file.path
-        file_id = ::File.basename(file_id) if flatten_folder_structure
-        file_id
-      end
-
-      def file_attributes(provided_file_attributes)
-        file.file_attributes || provided_file_attributes[mimetype] || provided_file_attributes['default'] || ATTRIBUTES_FOR_TYPE[mimetype] || ATTRIBUTES_FOR_TYPE['default']
-      end
-
-      def image_data
-        { height: file.exif.imageheight, width: file.exif.imagewidth }
-      end
-
-      private
-
-      attr_reader :file
-    end
-  end
-end

data/lib/assembly-objectfile/content_metadata/file_set.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/object/blank'
-
-module Assembly
-  class ContentMetadata
-    # Represents a groups of related Files, such as a single master file and the derivatives
-    class FileSet
-      # @param [Boolean] dpg (false) is it a dpg bundle?
-      # @param [Array<Assembly::ObjectFile>] resource_files
-      # @param style
-      def initialize(resource_files:, style:, dpg: false)
-        @dpg = dpg
-        @resource_files = resource_files
-        @style = style
-      end
-
-      # objects in the special DPG folders are always type=object when we using :bundle=>:dpg
-      # otherwise look at the style to determine the resource_type_description
-      def resource_type_description
-        @resource_type_description ||= special_dpg_resource? ? 'object' : resource_type_descriptions
-      end
-
-      def label_from_file(default:)
-        resource_files.find { |obj| obj.label.present? }&.label || default
-      end
-
-      def files
-        resource_files.map { |file| File.new(file: file) }
-      end
-
-      private
-
-      attr_reader :dpg, :resource_files, :style
-
-      def special_dpg_resource?
-        return false unless dpg
-
-        resource_files.collect { |obj| ContentMetadata.special_dpg_folder?(obj.dpg_folder) }.include?(true)
-      end
-
-      # rubocop:disable Metrics/CyclomaticComplexity
-      def resource_type_descriptions
-        # grab all of the file types within a resource into an array so we can decide what the resource type should be
-        resource_file_types = resource_files.collect(&:object_type)
-        resource_has_non_images = !(resource_file_types - [:image]).empty?
-
-        case style
-        when :simple_image, :map, :'webarchive-seed'
-          'image'
-        when :file
-          'file'
-        when :simple_book # in a simple book project, all resources are pages unless they are *all* non-images -- if so, switch the type to object
-          resource_has_non_images && resource_file_types.include?(:image) == false ? 'object' : 'page'
-        when :book_as_image # same as simple book, but all resources are images instead of pages, unless we need to switch them to object type
-          resource_has_non_images && resource_file_types.include?(:image) == false ? 'object' : 'image'
-        when :book_with_pdf # in book with PDF type, if we find a resource with *any* non images, switch it's type from book to object
-          resource_has_non_images ? 'object' : 'page'
-        when :document
-          'document'
-        when :'3d'
-          resource_extensions = resource_files.collect(&:ext)
-          if (resource_extensions & VALID_THREE_DIMENSION_EXTENTIONS).empty? # if this resource contains no known 3D file extensions, the resource type is file
-            'file'
-          else # otherwise the resource type is 3d
-            '3d'
-          end
-        end
-      end
-      # rubocop:enable Metrics/CyclomaticComplexity
-    end
-  end
-end

data/lib/assembly-objectfile/content_metadata/file_set_builder.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module Assembly
-  class ContentMetadata
-    # Builds a groups of related Files, based on bundle
-    class FileSetBuilder
-      # @param [Symbol] bundle one of: :default, :filename, :dpg or :prebundled
-      # @param [Array<Assembly::ObjectFile>] objects
-      # @param [Symbol] style one of: :simple_image, :file, :simple_book, :book_as_image, :book_with_pdf, :map, or :'3d'
-      def self.build(bundle:, objects:, style:)
-        new(bundle: bundle, objects: objects, style: style).build
-      end
-
-      def initialize(bundle:, objects:, style:)
-        @bundle = bundle
-        @objects = objects
-        @style = style
-      end
-
-      # @return [Array<FileSet>] a list of filesets in the object
-      def build
-        case bundle
-        when :default # one resource per object
-          objects.collect { |obj| FileSet.new(resource_files: [obj], style: style) }
-        when :filename # one resource per distinct filename (excluding extension)
-          build_for_filename
-        when :dpg # group by DPG filename
-          build_for_dpg
-        when :prebundled
-          # if the user specifies this method, they will pass in an array of arrays, indicating resources, so we don't need to bundle in the gem
-          # This is used by the assemblyWF if you have stubContentMetadata.xml
-          objects.map { |inner| FileSet.new(resource_files: inner, style: style) }
-        else
-          raise 'Invalid bundle method'
-        end
-      end
-
-      private
-
-      attr_reader :bundle, :objects, :style
-
-      def build_for_filename
-        # loop over distinct filenames, this determines how many resources we will have and
-        # create one resource node per distinct filename, collecting the relevant objects with the distinct filename into that resource
-        distinct_filenames = objects.collect(&:filename_without_ext).uniq # find all the unique filenames in the set of objects, leaving off extensions and base paths
-        distinct_filenames.map do |distinct_filename|
-          FileSet.new(resource_files: objects.collect { |obj| obj if obj.filename_without_ext == distinct_filename }.compact,
-                      style: style)
-        end
-      end
-
-      def build_for_dpg
-        # loop over distinct dpg base names, this determines how many resources we will have and
-        # create one resource node per distinct dpg base name, collecting the relevant objects with the distinct names into that resource
-
-        distinct_filenames = objects.collect(&:dpg_basename).uniq # find all the unique DPG filenames in the set of objects
-        resources = distinct_filenames.map do |distinct_filename|
-          FileSet.new(dpg: true, resource_files: objects.collect { |obj| obj if obj.dpg_basename == distinct_filename && !ContentMetadata.special_dpg_folder?(obj.dpg_folder) }.compact, style: style)
-        end
-        objects.each { |obj| resources << FileSet.new(dpg: true, resource_files: [obj], style: style) if ContentMetadata.special_dpg_folder?(obj.dpg_folder) } # certain subfolders require individual resources for files within them regardless of file-naming convention
-        resources
-      end
-    end
-  end
-end

data/lib/assembly-objectfile/content_metadata/nokogiri_builder.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Assembly
-  class ContentMetadata
-    # Builds a nokogiri representation of the content metadata
-    class NokogiriBuilder
-      # @param [Array<Fileset>] filesets
-      # @param [String] druid
-      # @param [String] common_path
-      # @param [Config] config
-      def self.build(filesets:, druid:, common_path:, config:)
-        # a counter to use when creating auto-labels for resources, with incremenets for each type
-        resource_type_counters = Hash.new(0)
-        pid = druid.gsub('druid:', '') # remove druid prefix when creating IDs
-
-        Nokogiri::XML::Builder.new do |xml|
-          xml.contentMetadata(objectId: druid.to_s, type: config.type) do
-            xml.bookData(readingOrder: config.reading_order) if config.type == 'book'
-
-            filesets.each_with_index do |fileset, index| # iterate over all the resources
-              # start a new resource element
-              sequence = index + 1
-
-              resource_type_counters[fileset.resource_type_description] += 1 # each resource type description gets its own incrementing counter
-
-              xml.resource(id: "#{pid}_#{sequence}", sequence: sequence, type: fileset.resource_type_description) do
-                # create a generic resource label if needed
-                default_label = config.auto_labels ? "#{fileset.resource_type_description.capitalize} #{resource_type_counters[fileset.resource_type_description]}" : ''
-
-                # but if one of the files has a label, use it instead
-                resource_label = fileset.label_from_file(default: default_label)
-
-                xml.label(resource_label) unless resource_label.empty?
-                fileset.files.each do |cm_file| # iterate over all the files in a resource
-                  xml_file_params = { id: cm_file.file_id(common_path: common_path, flatten_folder_structure: config.flatten_folder_structure) }
-                  xml_file_params.merge!(cm_file.file_attributes(config.file_attributes)) if config.add_file_attributes
-                  xml_file_params.merge!(mimetype: cm_file.mimetype, size: cm_file.filesize) if config.add_exif
-
-                  xml.file(xml_file_params) do
-                    if config.add_exif # add exif info if the user requested it
-                      xml.checksum(cm_file.sha1, type: 'sha1')
-                      xml.checksum(cm_file.md5, type: 'md5')
-                      xml.imageData(cm_file.image_data) if cm_file.valid_image? # add image data for an image
-                    elsif cm_file.provider_md5 || cm_file.provider_sha1 # if we did not add exif info, see if there are user supplied checksums to add
-                      xml.checksum(cm_file.provider_sha1, type: 'sha1') if cm_file.provider_sha1
-                      xml.checksum(cm_file.provider_md5, type: 'md5') if cm_file.provider_md5
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/assembly-objectfile/content_metadata.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-require 'nokogiri'
-require 'deprecation'
-require 'active_support'
-require 'assembly-objectfile/content_metadata/file'
-require 'assembly-objectfile/content_metadata/file_set'
-require 'assembly-objectfile/content_metadata/file_set_builder'
-require 'assembly-objectfile/content_metadata/config'
-require 'assembly-objectfile/content_metadata/nokogiri_builder'
-
-module Assembly
-  SPECIAL_DPG_FOLDERS = %w[31 44 50].freeze # these special dpg folders will force any files contained in them into their own resources, regardless of filenaming convention
-  # these are used when :bundle=>:dpg only
-
-  DEPRECATED_STYLES = %i[book_with_pdf book_as_image].freeze
-  VALID_STYLES = %i[simple_image simple_book file map document 3d webarchive-seed].freeze
-
-  # This class generates content metadata for image files
-  class ContentMetadata
-    # Generates image content XML metadata for a repository object.
-    # This method only produces content metadata for images
-    # and does not depend on a specific folder structure.  Note that it is class level method.
-    #
-    # @param [Hash] params a hash containg parameters needed to produce content metadata
-    #   :druid = required - a string of druid of the repository object's druid id (with or without 'druid:' prefix)
-    #   :objects = required - an array of Assembly::ObjectFile objects containing the list of files to add to content metadata
-    #                NOTE: if you set the :bundle option to :prebundled, you will need to pass in an array of arrays, and not a flat array, as noted below
-    #   :style = optional - a symbol containing the style of metadata to create, allowed values are
-    #                 :simple_image (default), contentMetadata type="image", resource type="image"
-    #                 :file, contentMetadata type="file", resource type="file"
-    #                 :simple_book, contentMetadata type="book", resource type="page", but any resource which has file(s) other than an image, and also contains no images at all, will be resource type="object"
-    #                 :book_with_pdf, contentMetadata type="book", resource type="page", but any resource which has any file(s) other than an image will be resource type="object" - NOTE: THIS IS DEPRECATED
-    #                 :book_as_image, as simple_book, but with contentMetadata type="book", resource type="image" (same rule applies for resources with non images)  - NOTE: THIS IS DEPRECATED
-    #                 :map, like simple_image, but with contentMetadata type="map", resource type="image"
-    #                 :3d, contentMetadata type="3d", ".obj" and other configured 3d extension files go into resource_type="3d", everything else into resource_type="file"
-    #                 :webarchive-seed, contentMetadata type="webarchive-seed", resource type="image"
-    #   :bundle = optional - a symbol containing the method of bundling files into resources, allowed values are
-    #                 :default = all files get their own resources (default)
-    #                 :filename = files with the same filename but different extensions get bundled together in a single resource
-    #                 :dpg = files representing the same image but of different mimetype that use the SULAIR DPG filenaming standard (00 vs 05) get bundled together in a single resource
-    #                 :prebundlded = this option requires you to prebundled the files passed in as an array of arrays, indicating how files are bundlded into resources; this is the most flexible option since it gives you full control
-    #   :add_exif = optional - a boolean to indicate if exif data should be added (mimetype, filesize, image height/width, etc.) to each file, defaults to false and is not required if project goes through assembly
-    #   :add_file_attributes = optional - a boolean to indicate if publish/preserve/shelve/role attributes should be added using defaults or by supplied override by mime/type, defaults to false and is not required if project goes through assembly
-    #   :file_attributes = optional - a hash of file attributes by mimetype to use instead of defaults, only used if add_file_attributes is also true,
-    #             If a mimetype match is not found in your hash, the default is used (either your supplied default or the gems).
-    #             e.g. {'default'=>{:preserve=>'yes',:shelve=>'yes',:publish=>'yes'},'image/tif'=>{:preserve=>'yes',:shelve=>'no',:publish=>'no'},'application/pdf'=>{:preserve=>'yes',:shelve=>'yes',:publish=>'yes'}}
-    #   :include_root_xml = optional - a boolean to indicate if the contentMetadata returned includes a root <?xml version="1.0"?> tag, defaults to true
-    #   :preserve_common_paths = optional - When creating the file "id" attribute, content metadata uses the "relative_path" attribute of the ObjectFile objects passed in.  If the "relative_path" attribute is not set,  the "path" attribute is used instead,
-    #                   which includes a full path to the file. If the "preserve_common_paths" parameter is set to false or left off, then the common paths of all of the ObjectFile's passed in are removed from any "path" attributes.  This should turn full paths into
-    #                   the relative paths that are required in content metadata file id nodes.  If you do not want this behavior, set "preserve_common_paths" to true.  The default is false.
-    #   :flatten_folder_structure = optional - Will remove *all* folder structure when genearting file IDs (e.g. DPG subfolders like '00','05' will be removed) when generating file IDs.  This is useful if the folder structure is flattened when staging files (like for DPG).
-    #                                             The default is false.  If set to true, will override the "preserve_common_paths" parameter.
-    #   :auto_labels = optional - Will add automated resource labels (e.g. "File 1") when labels are not provided by the user.  The default is true.
-    #   See https://consul.stanford.edu/pages/viewpage.action?spaceKey=chimera&title=DOR+content+types%2C+resource+types+and+interpretive+metadata for next two settings
-    #   :reading_order = optional - only valid for simple_book, can be 'rtl' or 'ltr'.  The default is 'ltr'.
-    # Example:
-    #    Assembly::ContentMetadata.create_content_metadata(:druid=>'druid:nx288wh8889',:style=>:simple_image,:objects=>object_files,:add_file_attributes=>false)
-    def self.create_content_metadata(druid:, objects:, auto_labels: true,
-                                     add_exif: false, bundle: :default, style: :simple_image,
-                                     add_file_attributes: false, file_attributes: {},
-                                     preserve_common_paths: false, flatten_folder_structure: false,
-                                     include_root_xml: nil, reading_order: 'ltr')
-
-      common_path = find_common_path(objects) unless preserve_common_paths # find common paths to all files provided if needed
-
-      filesets = FileSetBuilder.build(bundle: bundle, objects: objects, style: style)
-      config = Config.new(auto_labels: auto_labels,
-                          flatten_folder_structure: flatten_folder_structure,
-                          add_file_attributes: add_file_attributes,
-                          file_attributes: file_attributes,
-                          add_exif: add_exif,
-                          reading_order: reading_order,
-                          type: object_level_type(style))
-
-      builder = NokogiriBuilder.build(druid: druid,
-                                      filesets: filesets,
-                                      common_path: common_path,
-                                      config: config)
-
-      if include_root_xml == false
-        builder.doc.root.to_xml
-      else
-        builder.to_xml
-      end
-    end
-
-    def self.special_dpg_folder?(folder)
-      SPECIAL_DPG_FOLDERS.include?(folder)
-    end
-
-    def self.find_common_path(objects)
-      all_paths = objects.flatten.map do |obj|
-        raise "File '#{obj.path}' not found" unless obj.file_exists?
-
-        obj.path # collect all of the filenames into an array
-      end
-
-      Assembly::ObjectFile.common_path(all_paths) # find common paths to all files provided if needed
-    end
-    private_class_method :find_common_path
-
-    def self.object_level_type(style)
-      Deprecation.warn(self, "the style #{style} is now deprecated and should not be used. This will be removed in assembly-objectfile 2.0") if DEPRECATED_STYLES.include? style
-      raise "Supplied style (#{style}) not valid" unless (VALID_STYLES + DEPRECATED_STYLES).include? style
-
-      case style
-      when :simple_image
-        'image'
-      when :simple_book, :book_with_pdf, :book_as_image
-        'book'
-      else
-        style.to_s
-      end
-    end
-  end # class
-end # module