iiif_manifest 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9bfc627db90ac1d23556a85e962f89447195fb7
-  data.tar.gz: b59e46225bae67ddfc5e2460b3672d4be113e4b6
+  metadata.gz: 3cba606c659d4ff84c0709b6332ba67cdf938015
+  data.tar.gz: a140e32c9319b5747210da28634becb8213f35d3
 SHA512:
-  metadata.gz: 64f3b567ca52687d5fd6fe889bc085ed8850b69a343220819a5296c5ecce3d7d1a1aa7de386ca5f2ef82a3aedbac0a3b078c19c280c1e22ba7fc42effbf1234c
-  data.tar.gz: f550acc4ad049b10514d2c68333db4256ee0ac6e79bc4d995a9024681824bda83ac060d7fbbb9697f01e33e5eae5900c0e429212ed178133d0d9fb2f659e35d4
+  metadata.gz: 0fbbff5fca777d6e14bda44fe3d46df558234b872a87e62d4136f011c4a1909a4659966dc1ddd6b2e2769de6cdb10898a10c13b832b39efe926c6d4f1ee9739b
+  data.tar.gz: 48db3a55ee7899108d8c89a5a126046f0b92bc1b91fa983a3f47e0bd6a0db2dc32af8a56b7b0143c003481b69dcb348aaa336ef63936699fdfd9730a2d594d48

data/.rubocop.yml

@@ -1,5 +1,7 @@
 require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
+inherit_gem:
+  bixby: bixby_default.yml
 
 AllCops:
   DisplayCopNames: true
@@ -14,6 +16,7 @@ Metrics/BlockLength:
 Naming/MethodName:
   Exclude:
     - 'lib/iiif_manifest/manifest_builder/iiif_service.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder/iiif_service.rb'
 
 RSpec/MultipleExpectations:
   Enabled: false

data/.rubocop_todo.yml

@@ -11,6 +11,10 @@ Metrics/AbcSize:
   Exclude:
     - 'lib/iiif_manifest/manifest_builder/resource_builder.rb'
     - 'lib/iiif_manifest/manifest_factory.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder/body_builder.rb'
+    - 'lib/iiif_manifest/v3/manifest_factory.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder/content_builder.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder/choice_builder.rb'
 
 # Offense count: 1
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
@@ -31,16 +35,23 @@ RSpec/NamedSubject:
     - 'spec/lib/iiif_manifest/display_image_spec.rb'
     - 'spec/lib/iiif_manifest/iiif_endpoint_spec.rb'
     - 'spec/lib/iiif_manifest/manifest_builder/resource_builder_spec.rb'
+    - 'spec/lib/iiif_manifest/v3/manifest_builder/body_builder_spec.rb'
+    - 'spec/lib/iiif_manifest/v3/manifest_builder/structure_builder_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Exclude:
     - 'spec/lib/iiif_manifest/display_image_spec.rb'
+    - 'spec/lib/iiif_manifest/v3/manifest_builder/canvas_builder_spec.rb'
+    - 'spec/lib/iiif_manifest/v3/manifest_builder/structure_builder_spec.rb'
 
 RSpec/ExampleLength:
   Exclude:
     - 'spec/lib/iiif_manifest/manifest_factory_spec.rb'
+    - 'spec/lib/iiif_manifest/v3/manifest_factory_spec.rb'
+    - 'spec/lib/iiif_manifest/v3/manifest_builder/body_builder_spec.rb'
+    - 'spec/lib/iiif_manifest/v3/manifest_builder/structure_builder_spec.rb'
 
 # Offense count: 20
 Style/Documentation:
@@ -66,7 +77,21 @@ Style/Documentation:
     - 'lib/iiif_manifest/manifest_service_locator.rb'
     - 'lib/iiif_manifest.rb'
     - 'lib/iiif_manifest/manifest_builder/iiif_service.rb'
+    - 'lib/iiif_manifest/v3.rb'
+    - 'lib/iiif_manifest/v3/display_content.rb'
+    - 'lib/iiif_manifest/v3/manifest_factory.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder/structure_builder.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder/iiif_service.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/body_builder.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder/record_property_builder.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder/image_service_builder.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder.rb'
+    - 'lib/iiif_manifest/v3/manifest_service_locator.rb'
     - 'spec/lib/iiif_manifest/manifest_factory_spec.rb'
+    - 'spec/lib/iiif_manifest/v3/manifest_factory_spec.rb'
 
 # Offense count: 1
 Style/MethodMissing:
@@ -76,6 +101,7 @@ Style/MethodMissing:
 Metrics/ClassLength:
   Exclude:
     - 'lib/iiif_manifest/manifest_service_locator.rb'
+    - 'lib/iiif_manifest/v3/manifest_service_locator.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -83,3 +109,13 @@ Metrics/ClassLength:
 # SupportedStyles: percent, brackets
 Style/SymbolArray:
   EnforcedStyle: brackets
+
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/iiif_manifest/v3/display_content.rb'
+    - 'lib/iiif_manifest/v3/manifest_builder/canvas_builder.rb'
+
+RSpec/NestedGroups:
+  Exclude:
+    - 'spec/lib/iiif_manifest/v3/manifest_factory_spec.rb'
+    - 'spec/lib/iiif_manifest/v3/manifest_builder/body_builder_spec.rb'

data/README.md

@@ -1,19 +1,19 @@
 # IIIFManifest
-[![Build Status](https://travis-ci.org/projecthydra-labs/iiif_manifest.svg?branch=master)](https://travis-ci.org/projecthydra-labs/iiif_manifest)
+[![Build Status](https://travis-ci.org/samvera-labs/iiif_manifest.svg?branch=master)](https://travis-ci.org/projecthydra-labs/iiif_manifest)
 
 IIIF http://iiif.io/ defines an API for presenting related images in a viewer. This transforms Hydra::Works objects into that format usable by players such as http://universalviewer.io/
 
 ## Usage
 
-Your application ***must*** have an object that implements `#file_set_presenters` and `#work_presenters`.  The former method should return as set of leaf nodes and the later any interstitial nodes. If none are found an empty array should be returned. 
+Your application ***must*** have an object that implements `#file_set_presenters` and `#work_presenters`.  The former method should return as set of leaf nodes and the later any interstitial nodes. If none are found an empty array should be returned.
 
 Additionally, it ***must*** have a `#description` method that returns a string.
 
-Additionally it ***should*** implement `#manifest_url` that shows where the manifest can be found. 
+Additionally it ***should*** implement `#manifest_url` that shows where the manifest can be found.
 
-Additionally it ***should*** implement `#manifest_metadata` to provide an array containing hashes of metadata Label/Value pairs. 
+Additionally it ***should*** implement `#manifest_metadata` to provide an array containing hashes of metadata Label/Value pairs.
 
-Additionally it ***may*** implement `#search_service` to contain the url for an IIIF search api compliant search endpoint and `#autocomplete_service` to contain the url for an IIIF search api compliant autocomplete endpoint. Please note, the autocomplete service is embedded within the search service description so if an autocomplete_service is supplied without a search_service it will be ignored. The IIIF `profile` added to the service descriptions is version 0 as this is the version supported by the current version of Universal Viewer. Only include a search_service within the manifest if your application has impelmented an IIIF search service at the endpoint specified in the manifest. 
+Additionally it ***may*** implement `#search_service` to contain the url for an IIIF search api compliant search endpoint and `#autocomplete_service` to contain the url for an IIIF search api compliant autocomplete endpoint. Please note, the autocomplete service is embedded within the search service description so if an autocomplete_service is supplied without a search_service it will be ignored. The IIIF `profile` added to the service descriptions is version 0 as this is the version supported by the current version of Universal Viewer. Only include a search_service within the manifest if your application has impelmented an IIIF search service at the endpoint specified in the manifest.
 
 Additionally it ***may*** implement `#sequence_rendering` to contain an array of hashes for file downloads to be offered at sequences level. Each hash must contain "@id", "format" (mime type) and "label" (eg. `{ "@id" => "download url", "format" => "application/pdf", "label" => "user friendly label" }`).
 
@@ -45,18 +45,18 @@ For example:
     def description
       'a brief description'
     end
-    
+
     def manifest_metadata
           [
             { "label" => "Title", "value" => "Title of the Item" },
             { "label" => "Creator", "value" => "Morrissey, Stephen Patrick" }
           ]
     end
-    
+
     def search_service
       "http://test.host/books/#{@id}/search"
     end
-    
+
     def autocomplete_service
       "http://test.host/books/#{@id}/autocomplete"
     end
@@ -127,6 +127,24 @@ Then you can produce the manifest on the book object like this:
   IIIFManifest::ManifestFactory.new(book).to_h.to_json
 ```
 
+## Presentation 3.0 (Alpha)
+
+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 manifets can now be built using `IIIFManifest::V3::ManifestFactory`.
+
+```ruby
+  book = Book.new('book-77',[Page.new('page-99')])
+  IIIFManifest::V3::ManifestFactory.new(book).to_h.to_json
+```
+
+### Notable changes for Presentation 3.0
+- Presenters must still define `#description` but it is now serialized as `summary`. (https://iiif.io/api/presentation/3.0/change-log/#126-rename-description-to-summary)
+- All textual strings, including metadata labels and values, are now serialized as language maps and may be provided as a hash with language code keys with string values.  Values not provided in this format are automatically converted so no change to `#description`, `#manifest_metadata`, range labels, or other fields are required. (https://iiif.io/api/presentation/3.0/change-log/#133-use-language-map-pattern-for-label-value-summary)
+- File set presenters may target a fragment of its content by providing `#media_fragment` which will be appended to its `id`.
+- Range objects may now implement `#items` instead of `#ranges` and `#file_set_presenters` to allow for interleaving these objects.  `#items` is not required and existing range objects should continue to work.
+- 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.
+
 ## Development
 
 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.
@@ -135,5 +153,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/projecthydra-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.
-
+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.

data/iiif_manifest.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'iiif_manifest/version'
 
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 4'
 
+  spec.add_development_dependency 'bixby', '~> 1.0'
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/iiif_manifest.rb

@@ -11,4 +11,5 @@ module IIIFManifest
   autoload :DisplayImage
   autoload :IIIFCollection
   autoload :IIIFEndpoint
+  autoload :V3
 end

data/lib/iiif_manifest/iiif_collection.rb

@@ -1,6 +1,8 @@
-class IIIFCollection < SimpleDelegator
-  def viewing_hint
-    return super if __getobj__.respond_to?(:viewing_hint)
-    'multi-part'
+module IIIFManifest
+  class IIIFCollection < SimpleDelegator
+    def viewing_hint
+      return super if __getobj__.respond_to?(:viewing_hint)
+      'multi-part'
+    end
   end
 end

data/lib/iiif_manifest/manifest_builder.rb

@@ -35,12 +35,12 @@ module IIIFManifest
 
     private
 
-    def manifest
-      @manifest ||= manifest_builder_class
-    end
+      def manifest
+        @manifest ||= manifest_builder_class
+      end
 
-    def top_record
-      top_record_factory.new
-    end
+      def top_record
+        top_record_factory.new
+      end
   end
 end

data/lib/iiif_manifest/manifest_builder/canvas_builder.rb

@@ -28,18 +28,18 @@ module IIIFManifest
 
       private
 
-      def display_image
-        record.display_image if record.respond_to?(:display_image)
-      end
-
-      def apply_record_properties
-        canvas['@id'] = path
-        canvas.label = record.to_s
-      end
-
-      def attach_image
-        image_builder.new(display_image).apply(canvas)
-      end
+        def display_image
+          record.display_image if record.respond_to?(:display_image)
+        end
+
+        def apply_record_properties
+          canvas['@id'] = path
+          canvas.label = record.to_s
+        end
+
+        def attach_image
+          image_builder.new(display_image).apply(canvas)
+        end
     end
   end
 end

data/lib/iiif_manifest/manifest_builder/canvas_builder_factory.rb

@@ -17,9 +17,9 @@ module IIIFManifest
 
       private
 
-      def file_set_presenters(work)
-        work.file_set_presenters
-      end
+        def file_set_presenters(work)
+          work.file_set_presenters
+        end
     end
   end
 end

data/lib/iiif_manifest/manifest_builder/deep_canvas_builder_factory.rb

@@ -26,13 +26,13 @@ module IIIFManifest
 
       private
 
-      def file_set_presenters
-        work.try(:file_set_presenters) || []
-      end
+        def file_set_presenters
+          work.try(:file_set_presenters) || []
+        end
 
-      def work_presenters
-        work.try(:work_presenters) || []
-      end
+        def work_presenters
+          work.try(:work_presenters) || []
+        end
     end
   end
 end

data/lib/iiif_manifest/manifest_builder/image_builder.rb

@@ -18,17 +18,17 @@ module IIIFManifest
 
       private
 
-      def build_resource
-        resource_builder.apply(annotation)
-      end
+        def build_resource
+          resource_builder.apply(annotation)
+        end
 
-      def resource_builder
-        resource_builder_factory.new(display_image)
-      end
+        def resource_builder
+          resource_builder_factory.new(display_image)
+        end
 
-      def annotation
-        @annotation ||= iiif_annotation_factory.new
-      end
+        def annotation
+          @annotation ||= iiif_annotation_factory.new
+        end
     end
   end
 end

data/lib/iiif_manifest/manifest_builder/image_service_builder.rb

@@ -16,9 +16,9 @@ module IIIFManifest
 
       private
 
-      def service
-        @service ||= iiif_service_factory.new
-      end
+        def service
+          @service ||= iiif_service_factory.new
+        end
     end
   end
 end

data/lib/iiif_manifest/manifest_builder/record_property_builder.rb

@@ -8,7 +8,6 @@ module IIIFManifest
         @iiif_autocomplete_service_factory = iiif_autocomplete_service_factory
       end
 
-      # rubocop:disable Metrics/AbcSize
       def apply(manifest)
         manifest['@id'] = record.manifest_url.to_s
         manifest.label = record.to_s
@@ -23,65 +22,65 @@ module IIIFManifest
 
       private
 
-      def viewing_hint
-        (record.respond_to?(:viewing_hint) && record.send(:viewing_hint))
-      end
+        def viewing_hint
+          (record.respond_to?(:viewing_hint) && record.send(:viewing_hint))
+        end
 
-      def viewing_direction
-        (record.respond_to?(:viewing_direction) && record.send(:viewing_direction))
-      end
+        def viewing_direction
+          (record.respond_to?(:viewing_direction) && record.send(:viewing_direction))
+        end
 
-      def autocomplete_service
-        (record.respond_to?(:autocomplete_service) && record.send(:autocomplete_service))
-      end
+        def autocomplete_service
+          (record.respond_to?(:autocomplete_service) && record.send(:autocomplete_service))
+        end
 
-      def search_service
-        (record.respond_to?(:search_service) && record.send(:search_service))
-      end
+        def search_service
+          (record.respond_to?(:search_service) && record.send(:search_service))
+        end
 
-      def iiif_search_service
-        @iiif_search_service ||= iiif_search_service_factory.new
-      end
+        def iiif_search_service
+          @iiif_search_service ||= iiif_search_service_factory.new
+        end
 
-      def iiif_autocomplete_service
-        @iiif_autocomplete_service ||= iiif_autocomplete_service_factory.new
-      end
+        def iiif_autocomplete_service
+          @iiif_autocomplete_service ||= iiif_autocomplete_service_factory.new
+        end
 
-      # Build services. Currently supported:
-      #   search_service, with (optional) embedded autocomplete service
-      #
-      # @return [Array] array of services
-      def services
-        iiif_search_service.search_service = search_service
-        iiif_autocomplete_service.autocomplete_service = autocomplete_service
-        iiif_search_service.service = iiif_autocomplete_service if autocomplete_service.present?
-        [iiif_search_service]
-      end
+        # Build services. Currently supported:
+        #   search_service, with (optional) embedded autocomplete service
+        #
+        # @return [Array] array of services
+        def services
+          iiif_search_service.search_service = search_service
+          iiif_autocomplete_service.autocomplete_service = autocomplete_service
+          iiif_search_service.service = iiif_autocomplete_service if autocomplete_service.present?
+          [iiif_search_service]
+        end
 
-      # Validate manifest_metadata against the IIIF spec format for metadata
-      #
-      # @return [Boolean]
-      def valid_metadata?
-        return false unless record.respond_to?(:manifest_metadata)
-        metadata = record.manifest_metadata
-        valid_metadata_structure?(metadata) && valid_metadata_content?(metadata)
-      end
+        # Validate manifest_metadata against the IIIF spec format for metadata
+        #
+        # @return [Boolean]
+        def valid_metadata?
+          return false unless record.respond_to?(:manifest_metadata)
+          metadata = record.manifest_metadata
+          valid_metadata_structure?(metadata) && valid_metadata_content?(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_metadata_structure?(metadata)
-        metadata.is_a?(Array) && metadata.all? { |v| v.is_a?(Hash) }
-      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_metadata_structure?(metadata)
+          metadata.is_a?(Array) && metadata.all? { |v| v.is_a?(Hash) }
+        end
 
-      # Manifest Metadata Hashes must contain 'label' and 'value' keys
-      #
-      # @param metadata [Array<Hash>] a list of metadata with label and value as required keys for each entry
-      # @return [Boolean]
-      def valid_metadata_content?(metadata)
-        metadata.all? { |v| v['label'].present? && v['value'].present? }
-      end
+        # Manifest Metadata Hashes must contain 'label' and 'value' keys
+        #
+        # @param metadata [Array<Hash>] a list of metadata with label and value as required keys for each entry
+        # @return [Boolean]
+        def valid_metadata_content?(metadata)
+          metadata.all? { |v| v['label'].present? && v['value'].present? }
+        end
     end
   end
 end