assembly-objectfile 1.6.8 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6dc0ea8319dd859ec9be81fd8f1f198c7cf4f9b
-  data.tar.gz: 658c0a71e1d654e25ef96ed3d6f726ffc62fc032
+  metadata.gz: 525c02a47a00911d384772353e49b34f0e730f9a
+  data.tar.gz: 73656cb1be5cdbab3275bbaab9883b1a79598bc0
 SHA512:
-  metadata.gz: a651a9d5ef31b219cc861189da4dccacb7d65072718fff634b27adc91e9f6475dc7d3f093f0624ab09e8f90ddb4253adaa52366eb81451fdc341a387a9551731
-  data.tar.gz: f6daca5780f916a41a5d4b3f2890ba2432803bb852a0e24837041f5ce489dd06ebebde38caae6d636402653f0b67815f6820971fa35b5d51b4edb53a50e565dc
+  metadata.gz: aa7a37c0e0705c51de15c0d8b9500533e845eb9cb953acee0f88c63e3302445c1939cd13492c53c30c1aeff8776284d3baefe4c5ff5ff15a48a6f8e8f6c2ad8e
+  data.tar.gz: 23fe849cf5e4a54f939ecde806dd31db990c75ca5e3c4e159451db1c00276772f3803ba13325285dfe1d9859e32404ae0877cedd411d606b103ccbc71fdc5a32

data/README.rdoc

@@ -1,3 +1,5 @@
+{<img src="https://travis-ci.org/sul-dlss/assembly-objectfile.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/sul-dlss/assembly-objectfile]
+
 = Assembly-ObjectFile Gem
 
 ==Overview 
@@ -67,6 +69,7 @@ content type specific operations (such as jp2 generation).
 - 1.6.3 Integrate with TravisCI
 - 1.6.4 Try and solve UTF-8 encoding issues with exif data in images
 - 1.6.5 Just use mime-types extension by default to compute mimetype to prevent calling to shell all the time (and avoid potential memory problems).  A new method allows you to call out to shell if you really want to.
+- 1.7.0 Support the `role` attribute on files
 
 ==Usage
 
@@ -108,4 +111,3 @@ To keep a local server running with up to date code documentation that you can v
 
    Mac users:
        brew install exiftool
-

data/lib/assembly-objectfile/content_metadata.rb

@@ -2,9 +2,11 @@ require 'nokogiri'
 
 module Assembly
 
-  SPECIAL_DPG_FOLDERS=['31','44','50']  # these special dpg folders will force any files contained in them into their own resources, regardless of filenaming convention
+  SPECIAL_DPG_FOLDERS = ['31', '44', '50']  # 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 = [:book_with_pdf, :book_as_image]
+                                  
   # This class generates content metadata for image files
   class ContentMetadata
     
@@ -20,8 +22,8 @@ module Assembly
       #                 :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"
-      #                 :book_as_image, as simple_book, but with contentMetadata type="book", resource type="image" (same rule applies for resources with non images)
+      #                 :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" 
       #   :bundle = optional - a symbol containing the method of bundling files into resources, allowed values are
       #                 :default = all files get their own resources (default)
@@ -29,8 +31,8 @@ module Assembly
       #                 :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 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, 
+      #   :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
@@ -41,7 +43,7 @@ module Assembly
       #                                             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. 
       # Example:
-      #    Assembly::Image.create_content_metadata(:druid=>'druid:nx288wh8889',:style=>:simple_image,:objects=>object_files,:add_file_attributes=>false)
+      #    Assembly::ContentMetadata.create_content_metadata(:druid=>'druid:nx288wh8889',:style=>:simple_image,:objects=>object_files,:add_file_attributes=>false)
       def self.create_content_metadata(params={})
 
         druid=params[:druid]
@@ -93,6 +95,7 @@ module Assembly
             raise "Supplied style not valid"
         end
           
+        puts "WARNING - the style #{style} is now deprecated and should not be used." if DEPRECATED_STYLES.include? style
         
         # determine how many resources to create
         # setup an array of arrays, where the first array is the number of resources, and the second array is the object files containined in that resource
@@ -188,6 +191,7 @@ module Assembly
                       :preserve => file_attributes_hash[:preserve],
                       :publish  => file_attributes_hash[:publish],
                       :shelve   => file_attributes_hash[:shelve],
+                      :role     => file_attributes_hash[:role],
                     })
                   end
                                                       

data/lib/assembly-objectfile/version.rb

@@ -3,7 +3,7 @@ module Assembly
   
   class ObjectFile
     # Project version number    
-    VERSION = "1.6.8"
+    VERSION = "1.7.0"
   end
 
 end

data/spec/content_metadata_spec.rb

@@ -551,6 +551,23 @@ describe Assembly::ContentMetadata do
     end
   end
 
+  it "should generate role attributes for content metadata for a tif" do
+    obj1=Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE)
+    obj1.file_attributes={:publish=>'no',:preserve=>'no',:shelve=>'no',:role=>'master-role'}
+    objects=[obj1]
+    result = Assembly::ContentMetadata.create_content_metadata(:druid=>TEST_DRUID,:add_exif=>false,:add_file_attributes=>true,:objects=>objects)
+    expect(result.class).to be String
+    xml = Nokogiri::XML(result)
+    expect(xml.errors.size).to be 0
+    expect(xml.xpath("//contentMetadata")[0].attributes['type'].value).to eq("image")
+    expect(xml.xpath("//resource").length).to be 1
+    expect(xml.xpath("//resource/file").length).to be 1
+    expect(xml.xpath("//resource/file").length).to be 1
+    expect(xml.xpath("//resource/file")[0].attributes['role'].value).to eq("master-role")
+  end
+
+
+
   it "should generate content metadata even when no objects are passed in" do
     objects=[]
     result = Assembly::ContentMetadata.create_content_metadata(:druid=>TEST_DRUID,:bundle=>:prebundled,:style=>:file,:objects=>objects)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-objectfile
 version: !ruby/object:Gem::Version
-  version: 1.6.8
+  version: 1.7.0
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_exiftool
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: assembly-objectfile
-rubygems_version: 2.6.7
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby immplementation of file services needed to prepare objects to be accessioned
@@ -235,4 +235,3 @@ test_files:
 - spec/test_data/input/test2.jp2
 - spec/test_data/input/test2.tif
 - spec/test_data/input/test_no_color_profile.tif
-has_rdoc: