iiif_manifest 0.4.0 → 0.5.0

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

@@ -0,0 +1,35 @@
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class ImageServiceBuilder
+        attr_reader :iiif_endpoint, :iiif_service_factory
+        def initialize(iiif_endpoint, iiif_service_factory:)
+          @iiif_endpoint = iiif_endpoint
+          @iiif_service_factory = iiif_service_factory
+        end
+
+        def apply(resource)
+          service['id'] = iiif_endpoint.url
+          service['profile'] = iiif_endpoint.profile
+          service['type'] = determine_type(iiif_endpoint.context)
+          resource.service = [service]
+        end
+
+        private
+
+          def determine_type(context)
+            case context
+            when 'http://iiif.io/api/image/1/context.json'
+              'ImageService1'
+            when 'http://iiif.io/api/image/2/context.json'
+              'ImageService2'
+            end
+          end
+
+          def service
+            @service ||= iiif_service_factory.new
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class RecordPropertyBuilder < ::IIIFManifest::ManifestBuilder::RecordPropertyBuilder
+        attr_reader :canvas_builder_factory
+        def initialize(record,
+                       iiif_search_service_factory:,
+                       iiif_autocomplete_service_factory:,
+                       canvas_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
+        end
+
+        def apply(manifest)
+          setup_manifest_from_record(manifest, record)
+          # Build the items array
+          canvas_builder.apply(manifest.items)
+          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
+            end
+          else
+            []
+          end
+        end
+
+        private
+
+          def canvas_builder
+            canvas_builder_factory.from(record)
+          end
+
+          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?
+            manifest.behavior = viewing_hint if viewing_hint.present?
+            manifest.metadata = metadata_from_record(record)
+            manifest.viewing_direction = viewing_direction if viewing_direction.present?
+            manifest.service = services if search_service.present?
+            manifest.rendering = populate_rendering
+          end
+
+          def metadata_from_record(record)
+            if valid_v3_metadata?
+              record.manifest_metadata
+            elsif valid_metadata?
+              transform_metadata(record.manifest_metadata)
+            end
+          end
+
+          # Validate manifest_metadata against the IIIF spec format for metadata
+          #
+          # @return [Boolean]
+          def valid_v3_metadata?
+            return false unless record.respond_to?(:manifest_metadata)
+            metadata = record.manifest_metadata
+            valid_v3_metadata_fields?(metadata)
+          end
+
+          # Manifest metadata must be an array containing hashes
+          #
+          # @param metadata [Array<Hash>] a list of metadata with label and value as required keys for each entry
+          # @return [Boolean]
+          def valid_v3_metadata_fields?(metadata)
+            metadata.is_a?(Array) && metadata.all? do |metadata_field|
+              metadata_field.is_a?(Hash) &&
+                ManifestBuilder.valid_language_map?(metadata_field['label']) &&
+                ManifestBuilder.valid_language_map?(metadata_field['value'])
+            end
+          end
+
+          def transform_metadata(metadata)
+            metadata.collect { |field| transform_field(field) }
+          end
+
+          def transform_field(field)
+            metadata_field = {}
+            metadata_field['label'] = ManifestBuilder.language_map(field['label'])
+            metadata_field['value'] = ManifestBuilder.language_map(field['value'])
+            metadata_field
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+module IIIFManifest
+  module V3
+    class ManifestBuilder
+      class StructureBuilder < ::IIIFManifest::ManifestBuilder::StructureBuilder
+        def range_builder(top_range)
+          RangeBuilder.new(
+            top_range,
+            record, true,
+            canvas_builder_factory: canvas_builder_factory,
+            iiif_range_factory: iiif_range_factory
+          )
+        end
+      end
+      class RangeBuilder < ::IIIFManifest::ManifestBuilder::RangeBuilder
+        def apply(manifest)
+          manifest << range
+          sub_ranges.map do |sub_range|
+            sub_range.apply(range['items'])
+          end
+          range_items.map do |range_item|
+            next if range_item.nil?
+            if range_item.is_a? Hash
+              range['items'] << range_item
+            else
+              range_item.apply(range['items'])
+            end
+          end
+          manifest
+        end
+
+        def build_range
+          range['id'] = path
+          range['label'] = ManifestBuilder.language_map(record.label) if record.try(:label).present?
+          range['behavior'] = 'top' if top?
+          range['items'] = canvas_builders.collect { |cb| { 'type' => 'Canvas', 'id' => cb.path } }
+        end
+
+        def canvas_builders
+          @canvas_builders ||= [] unless record.respond_to?(:file_set_presenters)
+          @canvas_builders ||= file_set_presenters.map do |file_set_presenter|
+            canvas_builder_factory.new(file_set_presenter, parent)
+          end
+          @canvas_builders
+        end
+
+        def sub_ranges
+          @sub_ranges ||= [] unless record.respond_to?(:ranges)
+          @sub_ranges ||= record.ranges.map do |sub_range|
+            RangeBuilder.new(
+              sub_range,
+              parent,
+              canvas_builder_factory: canvas_builder_factory,
+              iiif_range_factory: iiif_range_factory
+            )
+          end
+        end
+
+        def range_items
+          @range_items ||= [] unless record.respond_to?(:items)
+          @range_items ||= record.items.map do |range_item|
+            # Determine if this item is a range or canvas
+            if range_item.respond_to? :id
+              canvas_range_item(range_item)
+            elsif range_item.respond_to? :label
+              range_range_item(range_item)
+            end
+          end
+          @range_items
+        end
+
+        def canvas_range_item(range_item)
+          canvas_builder = canvas_builder_factory.new(range_item, parent)
+          { 'type' => 'Canvas', 'id' => canvas_builder.path }
+        end
+
+        def range_range_item(range_item)
+          RangeBuilder.new(
+            range_item,
+            parent,
+            canvas_builder_factory: canvas_builder_factory,
+            iiif_range_factory: iiif_range_factory
+          )
+        end
+      end
+    end
+  end
+end

data/lib/iiif_manifest/v3/manifest_factory.rb

@@ -0,0 +1,38 @@
+module IIIFManifest
+  module V3
+    class ManifestFactory
+      class << self
+        def new(work, manifest_service_locator: ManifestServiceLocator)
+          super(manifest_service_locator).new(work)
+        end
+      end
+
+      delegate :collection_manifest_builder, :manifest_builder, :sammelband_manifest_builder,
+               to: :manifest_service_locator
+      attr_reader :manifest_service_locator
+
+      def initialize(manifest_service_locator)
+        @manifest_service_locator = manifest_service_locator
+      end
+
+      def new(work)
+        if !work.work_presenters.empty?
+          if sammelband?(work) || !work.file_set_presenters.empty?
+            manifest_builder.new(work)
+          elsif work.file_set_presenters.empty?
+            work = IIIFManifest::IIIFCollection.new(work)
+            collection_manifest_builder.new(work)
+          end
+        else
+          manifest_builder.new(work)
+        end
+      end
+
+      private
+
+        def sammelband?(work)
+          work.respond_to?(:sammelband?) && work.sammelband?
+        end
+    end
+  end
+end

data/lib/iiif_manifest/v3/manifest_service_locator.rb

@@ -0,0 +1,148 @@
+module IIIFManifest
+  module V3
+    class ManifestServiceLocator < IIIFManifest::ManifestServiceLocator
+      class << self
+        # Builders which receive a work as an argument to .new and return objects
+        #   that respond to #apply.
+        def manifest_builders
+          composite_builder_factory.new(
+            record_property_builder,
+            structure_builder,
+            composite_builder: composite_builder
+          )
+        end
+
+        def collection_manifest_builders
+          composite_builder_factory.new(
+            record_property_builder,
+            child_manifest_builder_factory,
+            composite_builder: composite_builder
+          )
+        end
+
+        def iiif_collection_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::Collection
+        end
+
+        def record_property_builder
+          IIIFManifest::ManifestServiceLocator::InjectedFactory.new(
+            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: canvas_builder_factory
+          )
+        end
+
+        def structure_builder
+          IIIFManifest::ManifestServiceLocator::InjectedFactory.new(
+            ManifestBuilder::StructureBuilder,
+            canvas_builder_factory: canvas_builder,
+            iiif_range_factory: iiif_range_factory
+          )
+        end
+
+        def canvas_builder_factory
+          IIIFManifest::ManifestBuilder::CanvasBuilderFactory.new(
+            composite_builder: composite_builder,
+            canvas_builder_factory: canvas_builder
+          )
+        end
+
+        def canvas_builder
+          IIIFManifest::ManifestServiceLocator::InjectedFactory.new(
+            ManifestBuilder::CanvasBuilder,
+            iiif_canvas_factory: iiif_canvas_factory,
+            content_builder: content_builder,
+            choice_builder: choice_builder,
+            iiif_annotation_page_factory: iiif_annotation_page_factory
+          )
+        end
+
+        def content_builder
+          IIIFManifest::ManifestServiceLocator::InjectedFactory.new(
+            ManifestBuilder::ContentBuilder,
+            iiif_annotation_factory: iiif_annotation_factory,
+            body_builder_factory: body_builder_factory
+          )
+        end
+
+        def choice_builder
+          IIIFManifest::ManifestServiceLocator::InjectedFactory.new(
+            ManifestBuilder::ChoiceBuilder,
+            iiif_annotation_factory: iiif_annotation_factory,
+            body_builder_factory: body_builder_factory,
+            iiif_choice_factory: iiif_choice_factory
+          )
+        end
+
+        def body_builder_factory
+          IIIFManifest::ManifestServiceLocator::InjectedFactory.new(
+            ManifestBuilder::BodyBuilder,
+            iiif_body_factory: iiif_body_factory,
+            image_service_builder_factory: image_service_builder_factory
+          )
+        end
+
+        def image_service_builder_factory
+          IIIFManifest::ManifestServiceLocator::InjectedFactory.new(
+            ManifestBuilder::ImageServiceBuilder,
+            iiif_service_factory: iiif_service_factory
+          )
+        end
+
+        def sequence_builder
+          raise NotImplementedError
+        end
+
+        def sammelband_sequence_builder
+          raise NotImplementedError
+        end
+
+        def sequence_factory
+          raise NotImplementedError
+        end
+
+        def iiif_service_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFService
+        end
+
+        def iiif_body_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::Body
+        end
+
+        def iiif_choice_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::Choice
+        end
+
+        def iiif_annotation_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::Annotation
+        end
+
+        def iiif_annotation_page_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::AnnotationPage
+        end
+
+        def iiif_manifest_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest
+        end
+
+        def iiif_canvas_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::Canvas
+        end
+
+        def iiif_range_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::Range
+        end
+
+        def iiif_search_service_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::SearchService
+        end
+
+        def iiif_autocomplete_service_factory
+          IIIFManifest::V3::ManifestBuilder::IIIFManifest::AutocompleteService
+        end
+      end
+    end
+  end
+end

data/lib/iiif_manifest/version.rb

@@ -1,3 +1,3 @@
 module IIIFManifest
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iiif_manifest
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: bixby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +165,19 @@ files:
 - lib/iiif_manifest/manifest_builder/structure_builder.rb
 - lib/iiif_manifest/manifest_factory.rb
 - lib/iiif_manifest/manifest_service_locator.rb
+- lib/iiif_manifest/v3.rb
+- lib/iiif_manifest/v3/display_content.rb
+- lib/iiif_manifest/v3/manifest_builder.rb
+- lib/iiif_manifest/v3/manifest_builder/body_builder.rb
+- lib/iiif_manifest/v3/manifest_builder/canvas_builder.rb
+- lib/iiif_manifest/v3/manifest_builder/choice_builder.rb
+- lib/iiif_manifest/v3/manifest_builder/content_builder.rb
+- lib/iiif_manifest/v3/manifest_builder/iiif_service.rb
+- 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_factory.rb
+- lib/iiif_manifest/v3/manifest_service_locator.rb
 - lib/iiif_manifest/version.rb
 homepage: http://github.com/projecthydra-labs/iiif_manifest
 licenses: []