iiif_manifest 0.4.0 → 1.1.0

data/lib/iiif_manifest/manifest_service_locator.rb

@@ -195,13 +195,13 @@ module IIIFManifest
 
     class InjectedFactory
       attr_reader :factory, :hash_args
-      def initialize(factory, hash_args)
+      def initialize(factory, **hash_args)
         @hash_args = hash_args
         @factory = factory
       end
 
       def new(*args)
-        factory.new(*args, hash_args)
+        factory.new(*args, **hash_args)
       end
     end
   end

data/lib/iiif_manifest/v3.rb

@@ -0,0 +1,13 @@
+require 'active_support'
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/object'
+
+module IIIFManifest
+  module V3
+    extend ActiveSupport::Autoload
+    autoload :ManifestBuilder
+    autoload :ManifestFactory
+    autoload :ManifestServiceLocator
+    autoload :DisplayContent
+  end
+end

data/lib/iiif_manifest/v3/display_content.rb

@@ -0,0 +1,20 @@
+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)
+        @url = url
+        @type = type
+        @width = width
+        @height = height
+        @duration = duration
+        @label = label
+        @format = format
+        @iiif_endpoint = iiif_endpoint
+        @auth_service = auth_service
+      end
+    end
+  end
+end

data/lib/iiif_manifest/v3/manifest_builder.rb

@@ -0,0 +1,61 @@
+require_relative 'manifest_builder/iiif_service'
+require_relative 'manifest_builder/canvas_builder'
+require_relative 'manifest_builder/record_property_builder'
+require_relative 'manifest_builder/choice_builder'
+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'
+
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class << self
+        # Utility method to wrap the obj into a IIIF V3 compliant language map as needed.
+        def language_map(obj)
+          return nil if obj.blank?
+          return obj if valid_language_map?(obj)
+          obj_to_language_map(obj)
+        end
+
+        def valid_language_map?(obj)
+          obj.is_a?(Hash) && obj.all? do |k, v|
+            k.is_a?(String) && v.is_a?(Array) && v.all? { |o| o.is_a?(String) }
+          end
+        end
+
+        private
+
+        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) }
+        end
+      end
+
+      attr_reader :work,
+                  :builders,
+                  :top_record_factory
+      def initialize(work, builders:, top_record_factory:)
+        @work = work
+        @builders = builders
+        @top_record_factory = top_record_factory
+      end
+
+      def apply(collection)
+        collection['manifests'] ||= []
+        collection['manifests'] << to_h
+        collection
+      end
+
+      def to_h
+        @to_h ||= builders.new(work).apply(top_record)
+      end
+
+     private
+
+      def top_record
+        top_record_factory.new
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class BodyBuilder
+        attr_reader :display_content, :iiif_body_factory, :image_service_builder_factory
+        def initialize(display_content, iiif_body_factory:, image_service_builder_factory:)
+          @display_content = display_content
+          @iiif_body_factory = iiif_body_factory
+          @image_service_builder_factory = image_service_builder_factory
+        end
+
+        def apply(annotation)
+          build_body
+          image_service_builder.apply(body) if iiif_endpoint
+          apply_auth_service if auth_service
+          annotation.body = body
+        end
+
+        private
+
+        def build_body
+          body['id'] = display_content.url
+          body['type'] = body_type
+          body['height'] = display_content.height if display_content.try(:height).present?
+          body['width'] = display_content.width if display_content.try(:width).present?
+          body['duration'] = display_content.duration if display_content.try(:duration).present?
+          body['format'] = display_content.format if display_content.try(:format).present?
+          body['label'] = ManifestBuilder.language_map(display_content.label) if display_content.try(:label).present?
+        end
+
+        def body
+          @body ||= iiif_body_factory.new
+        end
+
+        def body_type
+          display_content.try(:type) || 'Image'
+        end
+
+        def iiif_endpoint
+          display_content.try(:iiif_endpoint)
+        end
+
+        def image_service_builder
+          image_service_builder_factory.new(iiif_endpoint)
+        end
+
+        def auth_service
+          display_content.try(:auth_service)
+        end
+
+        def apply_auth_service
+          body.service = if body['service'].blank?
+                           [auth_service]
+                         else
+                           body['service'] + [auth_service]
+                         end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class CanvasBuilder
+        attr_reader :record, :parent, :iiif_canvas_factory, :content_builder,
+                    :choice_builder, :iiif_annotation_page_factory
+
+        def initialize(record,
+                       parent,
+                       iiif_canvas_factory:,
+                       content_builder:,
+                       choice_builder:,
+                       iiif_annotation_page_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
+          apply_record_properties
+          # Presentation 2.x approach
+          attach_image if display_image
+          # Presentation 3.0 approach
+          attach_content if display_content
+        end
+
+        def canvas
+          @canvas ||= iiif_canvas_factory.new
+        end
+
+        def path
+          path = "#{parent.manifest_url}/canvas/#{record.id}"
+          path << "##{record.media_fragment}" if record.respond_to?(:media_fragment) && record.media_fragment.present?
+          path
+        end
+
+        def apply(items)
+          return items if canvas.items.blank?
+          items << canvas
+        end
+
+        private
+
+        def display_image
+          record.display_image if record.respond_to?(:display_image)
+        end
+
+        def display_content
+          Array.wrap(record.display_content) if record.respond_to?(:display_content) && record.display_content.present?
+        end
+
+        def apply_record_properties
+          canvas['id'] = path
+          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]
+        end
+
+        def annotation_page
+          @annotation_page ||= iiif_annotation_page_factory.new
+        end
+
+        def attach_image
+          content_builder.new(display_image).apply(canvas)
+        end
+
+        def attach_content
+          if display_content.size == 1
+            content_builder.new(display_content.first).apply(canvas)
+          else
+            choice_builder.new(display_content).apply(canvas)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class ChoiceBuilder
+        attr_reader :display_content, :iiif_annotation_factory, :body_builder_factory, :iiif_choice_factory
+        def initialize(display_content, iiif_annotation_factory:, body_builder_factory:, iiif_choice_factory:)
+          @display_content = display_content
+          @iiif_annotation_factory = iiif_annotation_factory
+          @body_builder_factory = body_builder_factory
+          @iiif_choice_factory = iiif_choice_factory
+          build_choice
+        end
+
+        def apply(canvas)
+          annotation['target'] = canvas['id']
+          canvas['width'] = choice.items.first['width']
+          canvas['height'] = choice.items.first['height']
+          canvas['duration'] = choice.items.first['duration']
+          annotation.body = choice
+          # Assume first item in canvas is an annotation page
+          canvas.items.first.items += [annotation]
+        end
+
+        private
+
+        def build_choice
+          display_content.each do |content|
+            content_body = body_builder(content).apply(iiif_annotation_factory.new)
+            choice.items += [content_body]
+          end
+        end
+
+        def body_builder(content)
+          body_builder_factory.new(content)
+        end
+
+        def annotation
+          @annotation ||= iiif_annotation_factory.new
+        end
+
+        def choice
+          @choice ||= iiif_choice_factory.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class ContentBuilder
+        attr_reader :display_content, :iiif_annotation_factory, :body_builder_factory
+        def initialize(display_content, iiif_annotation_factory:, body_builder_factory:)
+          @display_content = display_content
+          @iiif_annotation_factory = iiif_annotation_factory
+          @body_builder_factory = body_builder_factory
+          build_resource
+        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
+          canvas.items.first.items += [annotation]
+        end
+
+        private
+
+        def build_resource
+          body_builder.apply(annotation)
+        end
+
+        def body_builder
+          body_builder_factory.new(display_content)
+        end
+
+        def annotation
+          @annotation ||= iiif_annotation_factory.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,239 @@
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class IIIFService < IIIFManifest::ManifestBuilder::IIIFService
+      end
+
+      class IIIFManifest < IIIFService
+        def label
+          inner_hash['label']
+        end
+
+        def label=(label)
+          inner_hash['label'] = label
+        end
+
+        def summary
+          inner_hash['summary']
+        end
+
+        def summary=(summary)
+          return unless summary.present?
+          inner_hash['summary'] = summary
+        end
+
+        def behavior=(behavior)
+          return unless behavior.present?
+          inner_hash['behavior'] = behavior
+        end
+
+        def viewing_direction=(viewing_direction)
+          return unless viewing_direction.present?
+          inner_hash['viewingDirection'] = viewing_direction
+        end
+
+        def viewingDirection
+          inner_hash['viewingDirection']
+        end
+
+        def items
+          inner_hash['items'] ||= []
+        end
+
+        def items=(items)
+          inner_hash['items'] = items
+        end
+
+        def metadata=(metadata)
+          inner_hash['metadata'] = metadata
+        end
+
+        def service
+          inner_hash['service'] || []
+        end
+
+        def service=(service)
+          inner_hash['service'] = service
+        end
+
+        def see_also=(see_also)
+          inner_hash['seeAlso'] = see_also
+        end
+
+        def rendering=(rendering)
+          inner_hash['rendering'] = rendering
+        end
+
+        def rights=(rights)
+          inner_hash['rights'] = rights
+        end
+
+        def homepage=(homepage)
+          inner_hash['homepage'] = homepage
+        end
+
+        def initial_attributes
+          {
+            '@context' => [
+              'http://www.w3.org/ns/anno.jsonld',
+              'http://iiif.io/api/presentation/3/context.json'
+            ],
+            'type' => 'Manifest'
+          }
+        end
+
+        class Collection < IIIFManifest
+          def initial_attributes
+            {
+              '@context' => [
+                'http://www.w3.org/ns/anno.jsonld',
+                'http://iiif.io/api/presentation/3/context.json'
+              ],
+              'type' => 'Collection'
+            }
+          end
+
+          def viewing_direction=(_viewing_direction)
+            raise NotImplementedError
+          end
+
+          def viewingDirection
+            raise NotImplementedError
+          end
+        end
+
+        class Canvas < IIIFService
+          def label
+            inner_hash['label']
+          end
+
+          def label=(label)
+            inner_hash['label'] = label
+          end
+
+          def items
+            inner_hash['items'] ||= []
+          end
+
+          def items=(items)
+            inner_hash['items'] = items
+          end
+
+          def initial_attributes
+            {
+              'type' => 'Canvas'
+            }
+          end
+        end
+
+        class Range < IIIFService
+          def initial_attributes
+            {
+              'type' => 'Range'
+            }
+          end
+        end
+
+        class Body < IIIFService
+          def service=(service)
+            inner_hash['service'] = service
+          end
+
+          def initial_attributes
+            {
+            }
+          end
+        end
+
+        class Choice < IIIFService
+          def items
+            inner_hash['items'] ||= []
+          end
+
+          def items=(items)
+            inner_hash['items'] = items
+          end
+
+          def initial_attributes
+            {
+              'type' => 'Choice',
+              'choiceHint' => 'user'
+            }
+          end
+        end
+
+        class AnnotationPage < IIIFService
+          def items
+            inner_hash['items'] ||= []
+          end
+
+          def items=(items)
+            inner_hash['items'] = items
+          end
+
+          def index
+            @index ||= SecureRandom.uuid
+          end
+
+          def initial_attributes
+            {
+              'type' => 'AnnotationPage'
+            }
+          end
+        end
+
+        class Annotation < IIIFService
+          def body=(body)
+            inner_hash['body'] = body
+          end
+
+          def body
+            inner_hash['body']
+          end
+
+          def initial_attributes
+            {
+              'type' => 'Annotation',
+              'motivation' => 'painting'
+            }
+          end
+        end
+
+        class SearchService < IIIFService
+          def service=(service)
+            inner_hash['service'] = service
+          end
+
+          def search_service=(search_service)
+            inner_hash['id'] = search_service
+          end
+
+          def initial_attributes
+            {
+              '@context' => 'http://iiif.io/api/search/1/context.json',
+              'profile' => 'http://iiif.io/api/search/1/search',
+              'label' => 'Search within this manifest'
+            }
+          end
+        end
+
+        class AutocompleteService < IIIFService
+          def autocomplete_service
+            inner_hash['id']
+          end
+
+          def autocomplete_service=(autocomplete_service)
+            inner_hash['id'] = autocomplete_service
+          end
+
+          def initial_attributes
+            {
+              'profile' => 'http://iiif.io/api/search/1/autocomplete',
+              'label' => 'Get suggested words in this manifest'
+            }
+          end
+        end
+      end
+    end
+  end
+end