iiif_manifest 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce4c4a874b8b50d50d11344dac0e635248754bb2b3498331cbd94945a5f3be75
-  data.tar.gz: 3da6a490d37ea8107e50a4393c21d5189ff97e47e9f34a65bd87848f3504f307
+  metadata.gz: d8dd7b48693245057fa3e99f6b3f434da255e4f1e7f26412e1b56937a73dace4
+  data.tar.gz: 6b719a4f0b94ed7347420d5c940d8b2244195a201bd2415e9842ee7e55c8afab
 SHA512:
-  metadata.gz: e54f567e6ed14b4a802d05433a17547e119da18ee6dc851db026f157eb344e431649d8bc84076d102449bbee5b7d69a73bbf8b22d36eb43e6e46d7062e4c7133
-  data.tar.gz: ea7afaf08fdd7d142d7bbe6c0087521ddcda5ec520f183f7d2ae479961dd36908fa4b34054fdb379ad88f6c71c4a898d0e5c19419528e0135005a49be3deb6ee
+  metadata.gz: 9f38cc5f1426ea385f128351a3189989cc31a1138faa693b4938f71a8fca3964da01bd1d17c3eff5501060c9483a6a6a95874feea87df1f7d9a35a55e4d3aa93
+  data.tar.gz: fb614960e6bcfd54792d061a783cb7f8719a5dddc1d6060b3ba8173136700537715ab2cc48234602c3788fef95d5c2ca8ffd9a505a4ae09c4f6c4fea54554a15

data/.circleci/config.yml

@@ -1,7 +1,7 @@
 ---
 version: 2.1
 orbs:
-  samvera: samvera/circleci-orb@0
+  samvera: samvera/circleci-orb@1.0
 
 jobs:
  test:
@@ -10,7 +10,7 @@ jobs:
         type: string
       bundler_version:
         type: string
-        default: 2.0.2
+        default: 2.3.10
 
     executor:
       name: 'samvera/ruby'
@@ -36,16 +36,35 @@ workflows:
     jobs:
       - test:
           name: "ruby3-0"
-          ruby_version: "3.0.0"
+          ruby_version: "3.0.3"
       - test:
           name: "ruby2-7"
-          ruby_version: "2.7.0"
+          ruby_version: "2.7.5"
       - test:
           name: "ruby2-6"
-          ruby_version: "2.6.5"
+          ruby_version: "2.6.9"
       - test:
           name: "ruby2-5"
-          ruby_version: "2.5.7"
+          ruby_version: "2.5.9"
+
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - main
+    jobs:
       - test:
-          name: "ruby2-4"
-          ruby_version: "2.4.9"
+          name: "ruby3-0"
+          ruby_version: "3.0.3"
+      - test:
+          name: "ruby2-7"
+          ruby_version: "2.7.5"
+      - test:
+          name: "ruby2-6"
+          ruby_version: "2.6.9"
+      - test:
+          name: "ruby2-5"
+          ruby_version: "2.5.9"

data/README.md

@@ -4,7 +4,7 @@ Code: [![CircleCI](https://circleci.com/gh/samvera/iiif_manifest.svg?style=svg)]
 
 Docs: [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md) [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 
-Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
+Join the conversation on slack: [![Slack Status](https://raw.githubusercontent.com/samvera/maintenance/main/assets/slack_icon.png)](http://slack.samvera.org/)
 
 # What is IIIFManifest
 
@@ -144,7 +144,7 @@ Then you can produce the manifest on the book object like this:
 
 Provisional support for the [3.0 alpha version of the IIIF presentation api spec](https://iiif.io/api/presentation/3.0/) has been added with a focus on audiovisual content. The [change log](https://iiif.io/api/presentation/3.0/change-log/) lists the changes to the specification.
 
-The presentation 3.0 support has been contained to the `V3` namespace. Version 2.0 manifests are still be built using `IIIFManifest::ManifestFactory` while version 3.0 manifests can now be built using `IIIFManifest::V3::ManifestFactory`.
+The presentation 3.0 support has been contained to the `V3` namespace. Version 2.0 manifests are still being built using `IIIFManifest::ManifestFactory` while version 3.0 manifests can now be built using `IIIFManifest::V3::ManifestFactory`.
 
 ```ruby
   book = Book.new('book-77',[Page.new('page-99')])
@@ -161,30 +161,50 @@ The presentation 3.0 support has been contained to the `V3` namespace. Version 2
 - File set presenters may provide `#display_content` which should return an instance of `IIIFManifest::V3::DisplayContent` (or an array of instances in the case of a user `Choice`). `#display_image` is no longer required but will still work if provided.
 - DisplayContent may provide `#auth_service` which should return a hash containing a IIIF Authentication service definition (<https://iiif.io/api/auth/1.0/>) that will be included on the content resource.
 
-# Development
+## Configuration
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+The `label`, `rights`, `homepage`, `description` (V2 only), and `summary` (V3 only) properties can be configured to pull its information from different attributes.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+**NOTE:** In the V2 manifest, `label` and `description` is expected to be a string so if the model's attribute is multivalued, only the first value would be used.
 
-## Contributing
+To enable this, add the following code to a config file at `config/initializers/iiif_manifest_config.rb` in your application.
+```ruby
+  # Example: use the default configuration but amend the summary property
+  IIIFManifest.config do |config|
+    config.manifest_property_to_record_method_name_map.merge!(summary: :abstract, rights: :license)
+  end
+```
+In the above example of a V3 manifest (since it is a `summary` instead of `description`), the `summary` property will be using the model's `#abstract` attribute value instead of the default `#description`. The `rights` property will use the model's `#license` attribute instead of the default `#rights_statement`. All other configurable properties will use their defaults.
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/samvera-labs/iiif_manifest>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+```ruby
+  # Example: use this configuration to set the max edge length of thumbnails, default is 200
+   IIIFManifest.confg do |config|
+     config.max_edge_for_thumbnail = 100
+   end
+```
+Thumbnails have been added for version 3 manifests because [Universal Viewer](https://github.com/UniversalViewer/universalviewer/issues/102) currently require them to be explicitly set otherwise they would not show up.  The above example is used to configure what the default size for the thumbnails would be.
 
-## Releasing
+```ruby
+# Example: use this configuration to disable thumbnails to show up by default on the manifest level (version 3 only)
+  IIIFManifest.confg do |config|
+    config.manifest_thumbnail = false
+  end
+```
+According to the Presentation API 3.0 [specifications](https://iiif.io/api/presentation/3.0/#thumbnail):
+> A Manifest *SHOULD* have the `thumbnail` property with at least one item.
+
+The above configuration allows you to disable that if desired since it is not a *MUST*.
+
+
+# Development
 
-1. `bundle install`
-2. Increase the version number in `lib/iiif_manifest/version.rb`
-3. Increase the same version number in `.github_changelog_generator`
-4. Update `CHANGELOG.md` by running this command:
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-  ```
-  github_changelog_generator --user samvera --project iiif_manifest --token YOUR_GITHUB_TOKEN_HERE
-  ```
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-5. Commit these changes to the master branch
+## Contributing
 
-6. Run `rake release`
+Bug reports and pull requests are welcome on GitHub at <https://github.com/samvera-labs/iiif_manifest>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Help
 
@@ -194,4 +214,4 @@ The Samvera community is here to help. Please see our [support guide](./SUPPORT.
 
 This software has been developed by and is brought to you by the Samvera community. Learn more at the [Samvera website](http://samvera.org/).
 
-![Samvera Logo](https://wiki.duraspace.org/download/thumbnails/87459292/samvera-fall-font2-200w.png?version=1&modificationDate=1498550535816&api=v2)
+![Samvera Logo](https://raw.githubusercontent.com/samvera/maintenance/main/assets/samvera_tree.png)

data/lib/iiif_manifest/configuration.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module IIIFManifest
+  ##
+  # Handles configuration for the IIIFManifest gem
+  #
+  # @see IIIFManifest.config
+  class Configuration
+    DEFAULT_MANIFEST_PROPERTY_TO_RECORD_METHOD_NAME_MAP = {
+      summary: :description, # for V3 manifests
+      description: :description, # for V2 manifests
+      label: :to_s,
+      rights: :rights_statement,
+      homepage: :homepage
+    }.freeze
+
+    ##
+    # @!attribute [w] manifest_property_to_record_method_name_map
+    #   @param value [Hash<Symbol, Symbol>]
+    #   @return [Hash<Symbol, Symbol>]
+    attr_writer :manifest_property_to_record_method_name_map
+    # Used to map a record's public method to a manifest property.
+    # @see manifest_value_for
+    # @see DEFAULT_MANIFEST_PROPERTY_TO_RECORD_METHOD_NAME_MAP DEFAULT_MANIFEST_PROPERTY_TO_RECORD_METHOD_NAME_MAP
+    #   are the default values
+    # @return [Hash<Symbol, Symbol>]
+    def manifest_property_to_record_method_name_map
+      # the constant is frozen but we need to be able to configure something unfrozen
+      @manifest_property_to_record_method_name_map ||= DEFAULT_MANIFEST_PROPERTY_TO_RECORD_METHOD_NAME_MAP.dup
+    end
+
+    ##
+    # @param value [Integer]
+    attr_writer :max_edge_for_thumbnail
+    # Used to set max edge length for thumbnail generation.
+    # @return [Integer]
+    def max_edge_for_thumbnail
+      return @max_edge_for_thumbnail unless @max_edge_for_thumbnail.nil?
+      @max_edge_for_thumbnail = 200
+    end
+
+    attr_writer :manifest_thumbnail
+    # Used to configure whether or not to show the manifest thumbnail property.
+    # @return [Boolean]
+    def manifest_thumbnail
+      return @manifest_thumbnail unless @manifest_thumbnail.nil?
+      @manifest_thumbnail = true
+    end
+
+    ##
+    # @api private
+    # @param record [Object] has the value for the :property we want to set
+    # @param property [Symbol] IIIF manifest property
+    # @return [NilClass] the record does not have a value for the given property
+    # @return [#to_s] the record has a value that is "present"
+    def manifest_value_for(record, property:)
+      method_name = map_property_to_method_name(property: property)
+      return nil unless record.respond_to?(method_name)
+      record.public_send(method_name)
+    end
+
+    private
+
+    def map_property_to_method_name(property:)
+      manifest_property_to_record_method_name_map.fetch(property)
+    end
+  end
+end

data/lib/iiif_manifest/display_image.rb

@@ -1,12 +1,14 @@
 module IIIFManifest
   class DisplayImage
-    attr_reader :url, :width, :height, :iiif_endpoint, :format
-    def initialize(url, width:, height:, format: nil, iiif_endpoint: nil)
+    attr_reader :url, :type, :width, :height, :iiif_endpoint, :format, :thumbnail
+    def initialize(url, width:, height:, format: nil, iiif_endpoint: nil, thumbnail: nil)
       @url = url
+      @type = 'Image'
       @width = width
       @height = height
       @format = format
       @iiif_endpoint = iiif_endpoint
+      @thumbnail = thumbnail
     end
   end
 end

data/lib/iiif_manifest/manifest_builder/iiif_service.rb

@@ -6,7 +6,7 @@ module IIIFManifest
         @inner_hash = initial_attributes
       end
 
-      delegate :[]=, :[], :as_json, :to_json, :has_key?, to: :inner_hash
+      delegate :[]=, :[], :as_json, :to_json, :has_key?, :key?, to: :inner_hash
 
       def initial_attributes
         {}

data/lib/iiif_manifest/manifest_builder/record_property_builder.rb

@@ -10,8 +10,10 @@ module IIIFManifest
 
       def apply(manifest)
         manifest['@id'] = record.manifest_url.to_s
-        manifest.label = record.to_s
-        manifest.description = record.description
+        label = Array(::IIIFManifest.config.manifest_value_for(record, property: :label)).first
+        manifest.label = label
+        description = Array(::IIIFManifest.config.manifest_value_for(record, property: :description)).first
+        manifest.description = description
         manifest.viewing_hint = viewing_hint if viewing_hint.present?
         manifest.viewing_direction = viewing_direction if viewing_direction.present?
         manifest.metadata = record.manifest_metadata if valid_metadata?

data/lib/iiif_manifest/v3/display_content.rb

@@ -2,18 +2,18 @@ module IIIFManifest
   module V3
     class DisplayContent
       attr_reader :url, :width, :height, :duration, :iiif_endpoint, :format, :type,
-                  :label, :auth_service
-      def initialize(url, type:, width: nil, height: nil, duration: nil, label: nil,
-                     format: nil, iiif_endpoint: nil, auth_service: nil)
+                  :label, :auth_service, :thumbnail
+      def initialize(url, type:, **kwargs)
         @url = url
         @type = type
-        @width = width
-        @height = height
-        @duration = duration
-        @label = label
-        @format = format
-        @iiif_endpoint = iiif_endpoint
-        @auth_service = auth_service
+        @width = kwargs[:width]
+        @height = kwargs[:height]
+        @duration = kwargs[:duration]
+        @label = kwargs[:label]
+        @format = kwargs[:format]
+        @iiif_endpoint = kwargs[:iiif_endpoint]
+        @auth_service = kwargs[:auth_service]
+        @thumbnail = kwargs[:thumbnail]
       end
     end
   end

data/lib/iiif_manifest/v3/manifest_builder/canvas_builder.rb

@@ -3,20 +3,22 @@ module IIIFManifest
     class ManifestBuilder
       class CanvasBuilder
         attr_reader :record, :parent, :iiif_canvas_factory, :content_builder,
-                    :choice_builder, :iiif_annotation_page_factory
+                    :choice_builder, :iiif_annotation_page_factory, :thumbnail_builder_factory
 
         def initialize(record,
                        parent,
                        iiif_canvas_factory:,
                        content_builder:,
                        choice_builder:,
-                       iiif_annotation_page_factory:)
+                       iiif_annotation_page_factory:,
+                       thumbnail_builder_factory:)
           @record = record
           @parent = parent
           @iiif_canvas_factory = iiif_canvas_factory
           @content_builder = content_builder
           @choice_builder = choice_builder
           @iiif_annotation_page_factory = iiif_annotation_page_factory
+          @thumbnail_builder_factory = thumbnail_builder_factory
           apply_record_properties
           # Presentation 2.x approach
           attach_image if display_image
@@ -45,6 +47,8 @@ module IIIFManifest
           record.display_image if record.respond_to?(:display_image)
         end
 
+        # @return [Array<Object>] if the record has a display content
+        # @return [NilClass] if there is no display content
         def display_content
           Array.wrap(record.display_content) if record.respond_to?(:display_content) && record.display_content.present?
         end
@@ -54,6 +58,15 @@ module IIIFManifest
           canvas.label = ManifestBuilder.language_map(record.to_s) if record.to_s.present?
           annotation_page['id'] = "#{path}/annotation_page/#{annotation_page.index}"
           canvas.items = [annotation_page]
+          apply_thumbnail_to(canvas)
+        end
+
+        def apply_thumbnail_to(canvas)
+          if display_image
+            canvas.thumbnail = Array(thumbnail_builder_factory.new(display_image).build)
+          elsif display_content.try(:first)
+            canvas.thumbnail = Array(thumbnail_builder_factory.new(display_content.first).build)
+          end
         end
 
         def annotation_page

data/lib/iiif_manifest/v3/manifest_builder/content_builder.rb

@@ -11,11 +11,12 @@ module IIIFManifest
         end
 
         def apply(canvas)
-          annotation['target'] = canvas['id']
-          canvas['width'] = annotation.body['width']
-          canvas['height'] = annotation.body['height']
-          canvas['duration'] = annotation.body['duration']
           # Assume first item in canvas is an annotation page
+          annotation['id'] = "#{canvas.items.first['id']}/annotation/#{annotation.index}"
+          annotation['target'] = canvas['id']
+          canvas['width'] = annotation.body['width'] if annotation.body['width'].present?
+          canvas['height'] = annotation.body['height'] if annotation.body['height'].present?
+          canvas['duration'] = annotation.body['duration'] if annotation.body['duration'].present?
           canvas.items.first.items += [annotation]
         end
 

data/lib/iiif_manifest/v3/manifest_builder/iiif_service.rb

@@ -65,13 +65,17 @@ module IIIFManifest
         end
 
         def rights=(rights)
-          inner_hash['rights'] = rights
+          inner_hash['rights'] = Array(rights).first
         end
 
         def homepage=(homepage)
           inner_hash['homepage'] = homepage
         end
 
+        def thumbnail=(thumbnail)
+          inner_hash['thumbnail'] = thumbnail
+        end
+
         def initial_attributes
           {
             '@context' => [
@@ -119,6 +123,14 @@ module IIIFManifest
             inner_hash['items'] = items
           end
 
+          def thumbnail
+            inner_hash['thumbnail']
+          end
+
+          def thumbnail=(thumbnail)
+            inner_hash['thumbnail'] = thumbnail
+          end
+
           def initial_attributes
             {
               'type' => 'Canvas'
@@ -191,6 +203,10 @@ module IIIFManifest
             inner_hash['body']
           end
 
+          def index
+            @index ||= SecureRandom.uuid
+          end
+
           def initial_attributes
             {
               'type' => 'Annotation',
@@ -212,7 +228,8 @@ module IIIFManifest
             {
               '@context' => 'http://iiif.io/api/search/1/context.json',
               'profile' => 'http://iiif.io/api/search/1/search',
-              'label' => 'Search within this manifest'
+              'label' => 'Search within this manifest',
+              'type' => 'SearchService1'
             }
           end
         end
@@ -229,7 +246,19 @@ module IIIFManifest
           def initial_attributes
             {
               'profile' => 'http://iiif.io/api/search/1/autocomplete',
-              'label' => 'Get suggested words in this manifest'
+              'label' => 'Get suggested words in this manifest',
+              'type' => 'AutoCompleteService1'
+            }
+          end
+        end
+
+        class Thumbnail < IIIFService
+          def service=(service)
+            inner_hash['service'] = service
+          end
+
+          def initial_attributes
+            {
             }
           end
         end

data/lib/iiif_manifest/v3/manifest_builder/image_service_builder.rb

@@ -9,9 +9,9 @@ module IIIFManifest
         end
 
         def apply(resource)
-          service['id'] = iiif_endpoint.url
+          service['@id'] = iiif_endpoint.url
           service['profile'] = iiif_endpoint.profile
-          service['type'] = determine_type(iiif_endpoint.context)
+          service['@type'] = determine_type(iiif_endpoint.context)
           resource.service = [service]
         end
 

data/lib/iiif_manifest/v3/manifest_builder/record_property_builder.rb

@@ -2,36 +2,36 @@ module IIIFManifest
   module V3
     class ManifestBuilder
       class RecordPropertyBuilder < ::IIIFManifest::ManifestBuilder::RecordPropertyBuilder
-        attr_reader :canvas_builder_factory
+        attr_reader :canvas_builder_factory, :thumbnail_builder_factory
         def initialize(record,
                        iiif_search_service_factory:,
                        iiif_autocomplete_service_factory:,
-                       canvas_builder_factory:)
+                       canvas_builder_factory:,
+                       thumbnail_builder_factory:)
           super(record,
                 iiif_search_service_factory: iiif_search_service_factory,
                 iiif_autocomplete_service_factory: iiif_autocomplete_service_factory)
           @canvas_builder_factory = canvas_builder_factory
+          @thumbnail_builder_factory = thumbnail_builder_factory
         end
 
         def apply(manifest)
           setup_manifest_from_record(manifest, record)
           # Build the items array
           canvas_builder.apply(manifest.items)
+          apply_thumbnail_to(manifest) unless manifest_thumbnail?
           manifest
         end
 
         def populate_rendering
-          if record.respond_to?(:sequence_rendering)
-            record.sequence_rendering.collect do |rendering|
-              sequence_rendering = rendering.to_h.except('@id', 'label')
-              sequence_rendering['id'] = rendering['@id']
-              if rendering['label'].present?
-                sequence_rendering['label'] = ManifestBuilder.language_map(rendering['label'])
-              end
-              sequence_rendering
+          return unless record.respond_to?(:sequence_rendering)
+          record.sequence_rendering.collect do |rendering|
+            sequence_rendering = rendering.to_h.except('@id', 'label')
+            sequence_rendering['id'] = rendering['@id']
+            if rendering['label'].present?
+              sequence_rendering['label'] = ManifestBuilder.language_map(rendering['label'])
             end
-          else
-            []
+            sequence_rendering
           end
         end
 
@@ -41,19 +41,24 @@ module IIIFManifest
           canvas_builder_factory.from(record)
         end
 
-          # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/MethodLength
         def setup_manifest_from_record(manifest, record)
           manifest['id'] = record.manifest_url.to_s
-          manifest.label = ManifestBuilder.language_map(record.to_s) if record.to_s.present?
-          manifest.summary = ManifestBuilder.language_map(record.description) if record.try(:description).present?
+          label = ::IIIFManifest.config.manifest_value_for(record, property: :label)
+          manifest.label = ManifestBuilder.language_map(label) if label.present?
+          summary = ::IIIFManifest.config.manifest_value_for(record, property: :summary)
+          manifest.summary = ManifestBuilder.language_map(summary) if summary.present?
+          rights = ::IIIFManifest.config.manifest_value_for(record, property: :rights)
+          manifest.rights = rights if rights.present?
           manifest.behavior = viewing_hint if viewing_hint.present?
-          manifest.metadata = metadata_from_record(record)
+          manifest.metadata = metadata_from_record(record) if metadata_from_record(record).present?
           manifest.viewing_direction = viewing_direction if viewing_direction.present?
           manifest.service = services if search_service.present?
-          manifest.rendering = populate_rendering
-          manifest.homepage = record.homepage if record.try(:homepage).present?
+          manifest.rendering = populate_rendering if populate_rendering.present?
+          homepage = ::IIIFManifest.config.manifest_value_for(record, property: :homepage)
+          manifest.homepage = homepage if homepage.present?
         end
-          # rubocop:enable Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/MethodLength
 
         def metadata_from_record(record)
           if valid_v3_metadata?
@@ -94,6 +99,18 @@ module IIIFManifest
           metadata_field['value'] = ManifestBuilder.language_map(field['value'])
           metadata_field
         end
+
+        def apply_thumbnail_to(manifest)
+          if manifest.is_a? IIIFManifest::Collection
+            manifest.thumbnail = manifest.items.collect(&:thumbnail).compact
+          elsif manifest.items.first&.thumbnail.present?
+            manifest.thumbnail = manifest.items.first&.thumbnail
+          end
+        end
+
+        def manifest_thumbnail?
+          ::IIIFManifest.config.manifest_thumbnail == false
+        end
       end
     end
   end

data/lib/iiif_manifest/v3/manifest_builder/thumbnail_builder.rb

@@ -0,0 +1,66 @@
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class ThumbnailBuilder
+        attr_reader :display_content, :iiif_thumbnail_factory, :image_service_builder_factory
+        def initialize(display_content, iiif_thumbnail_factory:, image_service_builder_factory:)
+          @display_content = display_content
+          @iiif_thumbnail_factory = iiif_thumbnail_factory
+          @image_service_builder_factory = image_service_builder_factory
+        end
+
+        # @return [Array<Object>]
+        def build
+          return Array(display_content.thumbnail.map(&:stringify_keys)) unless display_content.thumbnail.nil?
+          return nil if display_content.type != "Image" || iiif_endpoint.nil?
+
+          build_thumbnail
+          image_service_builder.apply(thumbnail)
+          [thumbnail]
+        end
+
+        private
+
+        def build_thumbnail
+          thumbnail['id'] = File.join(
+            display_content.iiif_endpoint.url,
+            'full',
+            "!#{max_edge},#{max_edge}",
+            '0',
+            'default.jpg'
+          )
+          thumbnail['type'] = display_content.type
+          thumbnail['height'] = (display_content.height * reduction_ratio).round
+          thumbnail['width'] = (display_content.width * reduction_ratio).round
+          thumbnail['format'] = display_content.format
+        end
+
+        def reduction_ratio
+          width = display_content.width
+          height = display_content.height
+          max_edge = @max_edge.to_f
+          return 1 if width <= max_edge && height <= max_edge
+
+          long_edge = [height, width].max
+          max_edge / long_edge
+        end
+
+        def max_edge
+          @max_edge = ::IIIFManifest.config.max_edge_for_thumbnail
+        end
+
+        def thumbnail
+          @thumbnail ||= iiif_thumbnail_factory.new
+        end
+
+        def iiif_endpoint
+          display_content.try(:iiif_endpoint)
+        end
+
+        def image_service_builder
+          image_service_builder_factory.new(iiif_endpoint)
+        end
+      end
+    end
+  end
+end

data/lib/iiif_manifest/v3/manifest_builder.rb

@@ -6,6 +6,7 @@ require_relative 'manifest_builder/content_builder'
 require_relative 'manifest_builder/body_builder'
 require_relative 'manifest_builder/structure_builder'
 require_relative 'manifest_builder/image_service_builder'
+require_relative 'manifest_builder/thumbnail_builder'
 
 module IIIFManifest
   module V3
@@ -28,7 +29,7 @@ module IIIFManifest
 
         def obj_to_language_map(obj)
           return nil unless obj.is_a?(String) || (obj.is_a?(Array) && obj.all? { |o| o.is_a?(String) })
-          { '@none' => Array(obj) }
+          { 'none' => Array(obj) }
         end
       end
 

data/lib/iiif_manifest/v3/manifest_service_locator.rb

@@ -29,7 +29,8 @@ module IIIFManifest
             ManifestBuilder::RecordPropertyBuilder,
             iiif_search_service_factory: iiif_search_service_factory,
             iiif_autocomplete_service_factory: iiif_autocomplete_service_factory,
-            canvas_builder_factory: deep_canvas_builder_factory
+            canvas_builder_factory: deep_canvas_builder_factory,
+            thumbnail_builder_factory: thumbnail_builder_factory
             # canvas_builder_factory: canvas_builder_factory
           )
         end
@@ -55,7 +56,8 @@ module IIIFManifest
             iiif_canvas_factory: iiif_canvas_factory,
             content_builder: content_builder,
             choice_builder: choice_builder,
-            iiif_annotation_page_factory: iiif_annotation_page_factory
+            iiif_annotation_page_factory: iiif_annotation_page_factory,
+            thumbnail_builder_factory: thumbnail_builder_factory
           )
         end
 
@@ -84,6 +86,14 @@ module IIIFManifest
           )
         end
 
+        def thumbnail_builder_factory
+          IIIFManifest::ManifestServiceLocator::InjectedFactory.new(
+            ManifestBuilder::ThumbnailBuilder,
+            iiif_thumbnail_factory: iiif_thumbnail_factory,
+            image_service_builder_factory: image_service_builder_factory
+          )
+        end
+
         def image_service_builder_factory
           IIIFManifest::ManifestServiceLocator::InjectedFactory.new(
             ManifestBuilder::ImageServiceBuilder,
@@ -142,6 +152,10 @@ module IIIFManifest
         def iiif_autocomplete_service_factory
           IIIFManifest::V3::ManifestBuilder::IIIFManifest::AutocompleteService
         end
+
+        def iiif_thumbnail_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::Thumbnail
+        end
       end
     end
   end

data/lib/iiif_manifest/version.rb

@@ -1,3 +1,3 @@
 module IIIFManifest
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/iiif_manifest.rb

@@ -5,6 +5,7 @@ require 'active_support/core_ext/object'
 
 module IIIFManifest
   extend ActiveSupport::Autoload
+  autoload :Configuration
   autoload :ManifestBuilder
   autoload :ManifestFactory
   autoload :ManifestServiceLocator
@@ -12,4 +13,46 @@ module IIIFManifest
   autoload :IIIFCollection
   autoload :IIIFEndpoint
   autoload :V3
+
+  ##
+  # @api public
+  #
+  # Exposes the IIIFManifest configuration.
+  #
+  # In the below examples, you would add the code to a `config/initializers/iiif_manifest_config.rb` file
+  # in your application.
+  #
+  # @example
+  #   # obliterate the default configuration and only use the one we gave
+  #   IIIFManifest.config do |config|
+  #     config.manifest_property_to_record_method_name_map = { summary: :abstract }
+  #   end
+  #
+  #   # use the default configuration but amend the summary property
+  #   IIIFManifest.config do |config|
+  #     config.manifest_property_to_record_method_name_map.merge!(summary: :abstract)
+  #   end
+  #
+  #   # set max edge length for thumbnail images
+  #   # the below example will set the max edge to 100px
+  #   IIIFManifest.confg do |config|
+  #     config.max_edge_for_thumbnail = 100
+  #   end
+  #
+  #   # disable the thumbnail property on the manifest level
+  #   # since it will be shown by default
+  #   IIIFManifest.confg do |config|
+  #     config.manifest_thumbnail = false
+  #   end
+  #
+  # @yield [IIIFManifest::Configuration] if a block is passed
+  # @return [IIIFManifest::Configuration]
+  # @see IIIFManifest::Configuration for configuration options
+  def self.config(&block)
+    @config ||= IIIFManifest::Configuration.new
+
+    yield @config if block
+
+    @config
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iiif_manifest
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -138,6 +138,7 @@ files:
 - bin/setup
 - iiif_manifest.gemspec
 - lib/iiif_manifest.rb
+- lib/iiif_manifest/configuration.rb
 - lib/iiif_manifest/display_image.rb
 - lib/iiif_manifest/iiif_collection.rb
 - lib/iiif_manifest/iiif_endpoint.rb
@@ -168,6 +169,7 @@ files:
 - lib/iiif_manifest/v3/manifest_builder/image_service_builder.rb
 - lib/iiif_manifest/v3/manifest_builder/record_property_builder.rb
 - lib/iiif_manifest/v3/manifest_builder/structure_builder.rb
+- lib/iiif_manifest/v3/manifest_builder/thumbnail_builder.rb
 - lib/iiif_manifest/v3/manifest_factory.rb
 - lib/iiif_manifest/v3/manifest_service_locator.rb
 - lib/iiif_manifest/version.rb
@@ -189,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Generate IIIF presentation manifests for Hydra::Works