assembly-objectfile 1.10.1 → 1.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfe0d362cd776d4099d57530dc6c502e8760eb49953dfa93d755016b98c54d6a
-  data.tar.gz: c1f0da284aa258aa89375b6d7b92dd7847b3e87b27712c2802e29157b86b6d9c
+  metadata.gz: 925ceb88bbc6d965b3ab9be3695e7ec318c65a11716cb5cdb2d1178af1a08174
+  data.tar.gz: bbc6282d8d375dd0cf49a55519563abff44429f012221dfc1b4cf0219de47aa9
 SHA512:
-  metadata.gz: dfce4baa7f4d0cd52944195661ba94b6af1010fce66d714eb7c7b54778681fd5041d92d5f2fb82561c20048f76e4c313050afd880d7eb8b0c6eafb0fd6aedb67
-  data.tar.gz: c936f71be1c89887f76a9e3c66a37b690730f40a4bcc01605dcd2610d961f85d44eb110b91f40754346ef46482ad481a1aa6a76a2d9e866de42782cb344115b3
+  metadata.gz: 997b90f28dd603f11cabc20d2dc598eaf60a5f3c1b3b168b770748f6ce48377e15e8665824976a4838be52e35a54bafb508c42aca6ddaa3c6f8e31c3f627b1b2
+  data.tar.gz: 1033e903f01344e8944ed681e61debb128603b3b3d898269cad582d7a1a0b674fd837e4114a81033b2cbfff97da6c9d9ee17a27cfad606622eacf768436c22fc

data/.rubocop_todo.yml

@@ -1,33 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-01-08 23:41:37 UTC using RuboCop version 1.8.0.
+# on 2021-03-16 21:16:42 UTC using RuboCop version 1.11.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleAlignWith, Severity.
-# SupportedStylesAlignWith: start_of_line, begin
-Layout/BeginEndAlignment:
-  Exclude:
-    - 'lib/assembly-objectfile/object_fileable.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowAliasSyntax, AllowedMethods.
-# AllowedMethods: alias_method, public, protected, private
-Layout/EmptyLinesAroundAttributeAccessor:
-  Exclude:
-    - 'lib/assembly-objectfile/object_fileable.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Layout/RescueEnsureAlignment:
-  Exclude:
-    - 'lib/assembly-objectfile/object_fileable.rb'
-
 # Offense count: 1
 Lint/UselessAssignment:
   Exclude:
@@ -36,23 +14,23 @@ Lint/UselessAssignment:
 # Offense count: 3
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 52
+  Max: 56
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 26
+  Max: 27
 
 # Offense count: 2
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 14
 
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 30
+  Max: 31
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
@@ -62,12 +40,12 @@ Metrics/ModuleLength:
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 11
+  Max: 13
 
 # Offense count: 2
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 14
+  Max: 15
 
 # Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
@@ -87,7 +65,7 @@ Naming/PredicateName:
     - 'spec/**/*'
     - 'lib/assembly-objectfile/object_fileable.rb'
 
-# Offense count: 8
+# Offense count: 9
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Exclude:
@@ -107,7 +85,7 @@ RSpec/InstanceVariable:
   Exclude:
     - 'spec/object_file_spec.rb'
 
-# Offense count: 38
+# Offense count: 39
 RSpec/MultipleExpectations:
   Max: 29
 
@@ -132,29 +110,7 @@ Style/CommentedKeyword:
   Exclude:
     - 'lib/assembly-objectfile/content_metadata.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/KeywordParametersOrder:
-  Exclude:
-    - 'lib/assembly-objectfile/content_metadata/file.rb'
-    - 'lib/assembly-objectfile/content_metadata/file_set.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RedundantAssignment:
-  Exclude:
-    - 'lib/assembly-objectfile/content_metadata.rb'
-
-# Offense count: 5
-# Cop supports --auto-correct.
-Style/StringConcatenation:
-  Exclude:
-    - 'config/boot.rb'
-    - 'lib/assembly-objectfile.rb'
-    - 'lib/assembly-objectfile/object_file.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 113
+# Offense count: 116
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

data/lib/assembly-objectfile/content_metadata.rb

@@ -52,13 +52,15 @@ module Assembly
     #   :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)
+                                     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
 
@@ -68,6 +70,7 @@ module Assembly
                           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,

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

@@ -13,12 +13,14 @@ module Assembly
     # 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/nokogiri_builder.rb

@@ -15,6 +15,8 @@ module Assembly
 
         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

data/lib/assembly-objectfile/version.rb

@@ -4,6 +4,6 @@
 module Assembly
   class ObjectFile
     # Project version number
-    VERSION = '1.10.1'
+    VERSION = '1.10.2'
   end
 end

data/spec/content_metadata_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe Assembly::ContentMetadata do
 
     let(:xml) { Nokogiri::XML(result) }
 
-    context 'when style is simple_image' do
+    context 'when style=simple_image' do
       context 'when using a single tif and jp2' do
         it 'generates valid content metadata with exif, adding file attributes' do
           objects = [Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE), Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE)]
@@ -333,7 +333,7 @@ RSpec.describe Assembly::ContentMetadata do
       end
     end
 
-    context 'when style is webarchive-seed' do
+    context 'when style=webarchive-seed' do
       context 'when using a jp2' do
         it 'generates valid content metadata with exif, adding file attributes' do
           objects = [Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE)]
@@ -342,6 +342,7 @@ RSpec.describe Assembly::ContentMetadata do
           xml = Nokogiri::XML(result)
           expect(xml.errors.size).to eq 0
           expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('webarchive-seed')
+          expect(xml.xpath('//bookData').length).to eq 0
           expect(xml.xpath('//resource').length).to eq 1
           expect(xml.xpath('//resource/file').length).to eq 1
           expect(xml.xpath('//resource/file/checksum').length).to eq 2
@@ -375,6 +376,7 @@ RSpec.describe Assembly::ContentMetadata do
           xml = Nokogiri::XML(result)
           expect(xml.errors.size).to eq 0
           expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('map')
+          expect(xml.xpath('//bookData').length).to eq 0
           expect(xml.xpath('//resource/file').length).to eq 2
           expect(xml.xpath('//resource/file')[0].attributes['mimetype']).to be_nil
           expect(xml.xpath('//resource/file')[0].attributes['publish'].value).to eq('yes')
@@ -404,6 +406,7 @@ RSpec.describe Assembly::ContentMetadata do
           expect(xml.errors.size).to eq 0
           expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('book')
           expect(xml.xpath('//contentMetadata')[0].attributes['objectId'].value).to eq(TEST_DRUID.to_s)
+          expect(xml.xpath('//bookData')[0].attributes['readingOrder'].value).to eq('ltr')
           expect(xml.xpath('//resource').length).to eq 4
           expect(xml.xpath('//resource/file').length).to eq 6
           expect(xml.xpath("//resource[@sequence='1']/file")[0].attributes['id'].value).to eq('oo000oo0001_00_001.tif')
@@ -428,20 +431,21 @@ RSpec.describe Assembly::ContentMetadata do
         end
       end
 
-      context "when item has a 'druid:' prefix. Using two tifs, two associated jp2s, two associated pdfs and one lingering PDF using bundle=dpg" do
+      context "when item has a 'druid:' prefix and specified book order. Using two tifs, two associated jp2s, two associated pdfs and one lingering PDF using bundle=dpg" do
         it 'generates valid content metadata with flattening folder structure' do
           objects = [Assembly::ObjectFile.new(TEST_DPG_TIF), Assembly::ObjectFile.new(TEST_DPG_JP),
                      Assembly::ObjectFile.new(TEST_DPG_PDF), Assembly::ObjectFile.new(TEST_DPG_TIF2),
                      Assembly::ObjectFile.new(TEST_DPG_JP2), Assembly::ObjectFile.new(TEST_DPG_PDF2),
                      Assembly::ObjectFile.new(TEST_DPG_SPECIAL_PDF1)]
           test_druid = "druid:#{TEST_DRUID}"
-          result = described_class.create_content_metadata(druid: test_druid, bundle: :dpg, objects: objects, style: :simple_book, flatten_folder_structure: true)
+          result = described_class.create_content_metadata(druid: test_druid, bundle: :dpg, objects: objects, style: :simple_book, flatten_folder_structure: true, reading_order: 'rtl')
           expect(result.class).to be String
           expect(result.include?('<?xml')).to be true
           xml = Nokogiri::XML(result)
           expect(xml.errors.size).to eq 0
           expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('book')
           expect(xml.xpath('//contentMetadata')[0].attributes['objectId'].value).to eq(test_druid)
+          expect(xml.xpath('//bookData')[0].attributes['readingOrder'].value).to eq('rtl')
           expect(test_druid).to eq("druid:#{TEST_DRUID}")
           expect(xml.xpath('//resource').length).to eq 3
           expect(xml.xpath('//resource/file').length).to be 7
@@ -466,6 +470,14 @@ RSpec.describe Assembly::ContentMetadata do
         end
       end
 
+      context 'throws an error with invalid reading order' do
+        subject(:result) { described_class.create_content_metadata(druid: "druid:#{TEST_DRUID}", bundle: :dpg, objects: [], style: :simple_book, flatten_folder_structure: true, reading_order: 'bogus') }
+
+        it 'generates valid content metadata with flattening folder structure' do
+          expect { result }.to raise_error(Dry::Struct::Error)
+        end
+      end
+
       context 'when using two tifs' do
         it 'generates valid content metadata for two tifs of style=simple_book' do
           objects = [Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE), Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE2)]
@@ -493,7 +505,7 @@ RSpec.describe Assembly::ContentMetadata do
       end
     end
 
-    context 'when using style=book_with_pdf' do
+    context 'when style=book_with_pdf' do
       context 'when using two tiffs and a pdf' do
         let(:objects) do
           [Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE),
@@ -580,6 +592,7 @@ RSpec.describe Assembly::ContentMetadata do
           xml = Nokogiri::XML(result)
           expect(xml.errors.size).to eq 0
           expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('file')
+          expect(xml.xpath('//bookData').length).to eq 0
           expect(xml.xpath('//resource').length).to eq 4
           expect(xml.xpath('//resource/file').length).to eq 4
           expect(xml.xpath('//label').length).to eq 4
@@ -611,6 +624,7 @@ RSpec.describe Assembly::ContentMetadata do
       it 'generates valid content metadata for two tifs' do
         expect(xml.errors.size).to eq 0
         expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('book')
+        expect(xml.xpath('//bookData').length).to eq 1
         expect(xml.xpath('//resource').length).to eq 2
         expect(xml.xpath('//resource/file').length).to eq 2
         expect(xml.xpath('//label').length).to eq 2
@@ -641,6 +655,7 @@ RSpec.describe Assembly::ContentMetadata do
       it 'generates valid content metadata' do
         expect(xml.errors.size).to eq 0
         expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('document')
+        expect(xml.xpath('//bookData').length).to eq 0
         expect(xml.xpath('//resource').length).to eq 1
         expect(xml.xpath('//resource/file').length).to eq 1
         expect(xml.xpath('//label').length).to eq 1
@@ -713,6 +728,7 @@ RSpec.describe Assembly::ContentMetadata do
       it 'generates valid content metadata' do
         expect(xml.errors.size).to eq 0
         expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('3d')
+        expect(xml.xpath('//bookData').length).to eq 0
         expect(xml.xpath('//resource').length).to eq 4
         expect(xml.xpath('//resource/file').length).to eq 4
         expect(xml.xpath('//label').length).to eq 4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-objectfile
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.10.2
 platform: ruby
 authors:
 - Peter Mangiafico