iiif-presentation 1.4.2 → 1.5.0

data/spec/unit/iiif/v3/presentation/choice_spec.rb

@@ -1,119 +1,123 @@
 describe IIIF::V3::Presentation::Choice do
-
-  describe '#prohibited_keys' do
-    it 'contains the expected key names' do
+  describe "#prohibited_keys" do
+    it "contains the expected key names" do
       keys = described_class::PAGING_PROPERTIES +
         described_class::CONTENT_RESOURCE_PROPERTIES +
-       %w{
-         nav_date
-         viewing_direction
-         start_canvas
-         content_annotations
-       }
-     expect(subject.prohibited_keys).to include(*keys)
-   end
+        %w[
+          nav_date
+          viewing_direction
+          start_canvas
+          content_annotations
+        ]
+      expect(subject.prohibited_keys).to include(*keys)
+    end
   end
 
-  describe '#any_type_keys' do
-    it 'default' do
-      expect(subject.any_type_keys).to include('default')
+  describe "#any_type_keys" do
+    it "default" do
+      expect(subject.any_type_keys).to include("default")
     end
   end
 
-  describe '#string_only_keys' do
-    it 'choice_hint' do
-      expect(subject.string_only_keys).to include('choice_hint')
+  describe "#string_only_keys" do
+    it "choice_hint" do
+      expect(subject.string_only_keys).to include("choice_hint")
     end
   end
 
-  describe '#array_only_keys' do
-    it 'items' do
-      expect(subject.array_only_keys).to include('items')
+  describe "#array_only_keys" do
+    it "items" do
+      expect(subject.array_only_keys).to include("items")
     end
   end
 
-  describe '#legal_choice_hint_values' do
-    it 'contains the expected values' do
-      expect(subject.legal_choice_hint_values).to contain_exactly('client', 'user')
+  describe "#legal_choice_hint_values" do
+    it "contains the expected values" do
+      expect(subject.legal_choice_hint_values).to contain_exactly("client", "user")
     end
   end
 
-  describe '#legal_viewing_hint_values' do
-    it 'contains none' do
-      expect(subject.legal_viewing_hint_values).to contain_exactly('none')
+  describe "#legal_viewing_hint_values" do
+    it "contains none" do
+      expect(subject.legal_viewing_hint_values).to contain_exactly("none")
     end
   end
 
-  describe '#initialize' do
-    it 'sets type to Choice by default' do
-      expect(subject['type']).to eq 'Choice'
+  describe "#initialize" do
+    it "sets type to Choice by default" do
+      expect(subject["type"]).to eq "Choice"
     end
-    it 'allows subclasses to override type' do
+    it "allows subclasses to override type" do
       subclass = Class.new(described_class) do
-        def initialize(hsh={})
-          hsh = { 'type' => 'a:SubClass' }
-          super(hsh)
+        def initialize(_hsh = {})
+          super({"type" => "a:SubClass"})
         end
       end
       sub = subclass.new
-      expect(sub['type']).to eq 'a:SubClass'
+      expect(sub["type"]).to eq "a:SubClass"
     end
-    it 'allows type to be passed in' do
-      my_choice = described_class.new('type' => 'bar')
-      expect(my_choice.type).to eq 'bar'
+    it "allows type to be passed in" do
+      my_choice = described_class.new("type" => "bar")
+      expect(my_choice.type).to eq "bar"
     end
   end
 
-  describe '#validate' do
-    it 'raises an IllegalValueError if choice_hint isn\'t an allowable value' do
+  describe "#validate" do
+    it "raises an IllegalValueError if choice_hint isn't an allowable value" do
       exp_err_msg = "choiceHint for #{described_class} must be one of [\"client\", \"user\"]."
-      subject['choice_hint'] = 'foo'
+      subject["choice_hint"] = "foo"
       expect { subject.validate }.to raise_error IIIF::V3::Presentation::IllegalValueError, exp_err_msg
     end
   end
 
-  describe 'realistic examples' do
-    describe 'from digerati' do
-      let(:item_type) { 'Video' }
-      let(:item1_id) { 'http://example.org/foo.mp4f' }
-      let(:item1_mime) { 'video/mp4' }
-      let(:item1_res) { IIIF::V3::Presentation::Resource.new(
-        'id' => item1_id,
-        'type' => item_type,
-        'format' => item1_mime
-        )}
-      let(:item2_id) { 'http://example.org/foo.webm' }
-      let(:item2_mime) { 'video/webm' }
-      let(:item2_res) { IIIF::V3::Presentation::Resource.new(
-        'id' => item2_id,
-        'type' => item_type,
-        'format' => item2_mime
-        )}
-      let(:choice) { IIIF::V3::Presentation::Choice.new(
-        'choiceHint' => 'client',
-        'items' => [item1_res, item2_res]
-        )}
-      it 'validates' do
-        expect{choice.validate}.not_to raise_error
+  describe "realistic examples" do
+    describe "from digerati" do
+      let(:item_type) { "Video" }
+      let(:item1_id) { "http://example.org/foo.mp4f" }
+      let(:item1_mime) { "video/mp4" }
+      let(:item1_res) {
+        IIIF::V3::Presentation::Resource.new(
+          "id" => item1_id,
+          "type" => item_type,
+          "format" => item1_mime
+        )
+      }
+      let(:item2_id) { "http://example.org/foo.webm" }
+      let(:item2_mime) { "video/webm" }
+      let(:item2_res) {
+        IIIF::V3::Presentation::Resource.new(
+          "id" => item2_id,
+          "type" => item_type,
+          "format" => item2_mime
+        )
+      }
+      let(:choice) {
+        IIIF::V3::Presentation::Choice.new(
+          "choiceHint" => "client",
+          "items" => [item1_res, item2_res]
+        )
+      }
+      it "validates" do
+        expect { choice.validate }.not_to raise_error
       end
-      it 'has expected required values' do
-        expect(choice['type']).to eq 'Choice'
+      it "has expected required values" do
+        expect(choice["type"]).to eq "Choice"
       end
-      it 'has expected additional values' do
+      it "has expected additional values" do
         expect(choice.id).to be_nil
-        expect(choice['choice_hint']).to eq 'client'
-        expect(choice.choiceHint).to eq 'client'
-        expect(choice['items']).to eq [item1_res, item2_res]
-        first = choice['items'].first
+        expect(choice["choice_hint"]).to eq "client"
+        expect(choice.choiceHint).to eq "client"
+        expect(choice["items"]).to eq [item1_res, item2_res]
+        first = choice["items"].first
         expect(first.keys.size).to eq 3
-        expect(first['id']).to eq item1_id
-        expect(first['type']).to eq item_type
-        expect(first['format']).to eq item1_mime
-        second = choice['items'].last
+        expect(first["id"]).to eq item1_id
+        expect(first["type"]).to eq item_type
+        expect(first["format"]).to eq item1_mime
+        second = choice["items"].last
         expect(second.keys.size).to eq 3
-        expect(second['id']).to eq item2_id
-        expect(second['type']).to eq item_type
-        expect(second['format']).to eq item2_mime
+        expect(second["id"]).to eq item2_id
+        expect(second["type"]).to eq item_type
+        expect(second["format"]).to eq item2_mime
       end
     end
   end

data/spec/unit/iiif/v3/presentation/collection_spec.rb

@@ -1,55 +1,50 @@
 describe IIIF::V3::Presentation::Collection do
-
   let(:fixed_values) do
     {
       "@context" => [
         "http://iiif.io/api/presentation/3/context.json",
         "http://www.w3.org/ns/anno.jsonld"
       ],
-      'id' => 'http://example.org/iiif/collection/top',
-      'type' => 'Collection',
-      'label' => 'Top Level Collection for Example Organization',
-      'description' => 'Description of Collection',
-      'attribution' => 'Provided by Example Organization',
-
-      'collections' => [
-        { 'id' => 'http://example.org/iiif/collection/part1',
-          'type' => 'Collection',
-          'label' => 'Sub Collection 1'
-         },
-         { 'id' => 'http://example.org/iiif/collection/part2',
-           'type' => 'Collection',
-           'label' => 'Sub Collection 2'
-          }
+      "id" => "http://example.org/iiif/collection/top",
+      "type" => "Collection",
+      "label" => "Top Level Collection for Example Organization",
+      "description" => "Description of Collection",
+      "attribution" => "Provided by Example Organization",
+
+      "collections" => [
+        {"id" => "http://example.org/iiif/collection/part1",
+         "type" => "Collection",
+         "label" => "Sub Collection 1"},
+        {"id" => "http://example.org/iiif/collection/part2",
+         "type" => "Collection",
+         "label" => "Sub Collection 2"}
       ],
-      'manifests' => [
-        { 'id' => 'http://example.org/iiif/book1/manifest',
-          'type' => 'Manifest',
-          'label' => 'Book 1'
-        }
+      "manifests" => [
+        {"id" => "http://example.org/iiif/book1/manifest",
+         "type" => "Manifest",
+         "label" => "Book 1"}
       ]
     }
   end
 
-  describe '#initialize' do
-    it 'sets type to Collection by default' do
-      expect(subject['type']).to eq 'Collection'
+  describe "#initialize" do
+    it "sets type to Collection by default" do
+      expect(subject["type"]).to eq "Collection"
     end
   end
 
   describe "#{described_class}.define_methods_for_array_only_keys" do
-    it_behaves_like 'it has the appropriate methods for array-only keys v3'
+    it_behaves_like "it has the appropriate methods for array-only keys v3"
   end
 
   describe "#{described_class}.define_methods_for_string_only_keys" do
-    it_behaves_like 'it has the appropriate methods for string-only keys v3'
+    it_behaves_like "it has the appropriate methods for string-only keys v3"
   end
 
   describe "#{described_class}.define_methods_for_any_type_keys" do
-    it_behaves_like 'it has the appropriate methods for any-type keys v3'
+    it_behaves_like "it has the appropriate methods for any-type keys v3"
   end
 
-  describe '#validate' do
+  describe "#validate" do
   end
-
 end

data/spec/unit/iiif/v3/presentation/image_resource_spec.rb

@@ -1,155 +1,154 @@
 describe IIIF::V3::Presentation::ImageResource do
-
-  describe '#initialize' do
-    it 'sets type to Image' do
-      expect(subject['type']).to eq 'Image'
+  describe "#initialize" do
+    it "sets type to Image" do
+      expect(subject["type"]).to eq "Image"
     end
   end
 
-  describe 'realistic examples' do
-    let(:img_id) { 'https://example.org/image/iiif/abc666' }
+  describe "realistic examples" do
+    let(:img_id) { "https://example.org/image/iiif/abc666" }
     let(:image_v2_service) {
       IIIF::V3::Presentation::Service.new(
-        '@context' => 'http://iiif.io/api/image/2/context.json',
-        '@id' => img_id,
-        'id' => img_id,
-        'profile' => 'http://iiif.io/api/image/2/level1.json'
+        "@context" => "http://iiif.io/api/image/2/context.json",
+        "@id" => img_id,
+        "id" => img_id,
+        "profile" => "http://iiif.io/api/image/2/level1.json"
       )
     }
-    let(:img_mimetype) { 'image/jpeg' }
+    let(:img_mimetype) { "image/jpeg" }
     let(:width) { 999 }
     let(:height) { 666 }
-    describe 'stanford' do
-      describe 'thumbnail per purl code' do
+    describe "stanford" do
+      describe "thumbnail per purl code" do
         let(:thumb_id) { "#{img_id}/full/!400,400/0/default.jpg" }
         let(:thumb_object) {
           thumb = IIIF::V3::Presentation::ImageResource.new
-          thumb['type'] = 'Image'
-          thumb['id'] = thumb_id
+          thumb["type"] = "Image"
+          thumb["id"] = thumb_id
           thumb.format = img_mimetype
           thumb.service = [image_v2_service]
           thumb
         }
-        it 'validates' do
-          expect{thumb_object.validate}.not_to raise_error
+        it "validates" do
+          expect { thumb_object.validate }.not_to raise_error
         end
-        it 'has expected required values' do
-          expect(thumb_object.type).to eq 'Image'
+        it "has expected required values" do
+          expect(thumb_object.type).to eq "Image"
           expect(thumb_object.id).to eq thumb_id
         end
-        it 'has expected additional values' do
+        it "has expected additional values" do
           expect(thumb_object.format).to eq img_mimetype
           expect(thumb_object.service.first).to eq image_v2_service
         end
       end
-      describe 'full size per purl code' do
+      describe "full size per purl code" do
         let(:full_id) { "#{img_id}/full/full/0/default.jpg" }
         let(:image_object) {
           img = IIIF::V3::Presentation::ImageResource.new
-          img['id'] = full_id
+          img["id"] = full_id
           img.format = img_mimetype
           img.height = height
           img.width = width
           img.service = [image_v2_service]
           img
         }
-        describe 'world visible' do
-          it 'validates' do
-            expect{image_object.validate}.not_to raise_error
+        describe "world visible" do
+          it "validates" do
+            expect { image_object.validate }.not_to raise_error
           end
-          it 'has expected required values' do
-            expect(image_object.type).to eq 'Image'
+          it "has expected required values" do
+            expect(image_object.type).to eq "Image"
             expect(image_object.id).to eq full_id
           end
-          it 'has expected additional values' do
+          it "has expected additional values" do
             expect(image_object.format).to eq img_mimetype
             expect(image_object.height).to eq height
             expect(image_object.width).to eq width
             expect(image_object.service.first).to eq image_v2_service
           end
-          it 'has expected service value' do
+          it "has expected service value" do
             img_service_obj = image_object.service.first
             expect(img_service_obj.class).to eq IIIF::V3::Presentation::Service
             expect(img_service_obj.keys.size).to eq 4
             expect(img_service_obj.id).to eq img_id
-            expect(img_service_obj['@id']).to eq img_id
+            expect(img_service_obj["@id"]).to eq img_id
             expect(img_service_obj.profile).to eq IIIF::V3::Presentation::Service::IIIF_IMAGE_V2_LEVEL1_PROFILE
           end
         end
-        describe 'requires login' do
-          let(:service_label) { 'login message' }
-          let(:token_service_id) { 'https://example.org/iiif/token' }
+        describe "requires login" do
+          let(:service_label) { "login message" }
+          let(:token_service_id) { "https://example.org/iiif/token" }
           let(:login_service) {
             IIIF::V3::Presentation::Service.new(
-              'id' => 'https://example.org/auth/iiif',
-              'profile' => 'http://iiif.io/api/auth/1/login',
-              'label' => service_label,
-              'service' => [{
-                'id' => token_service_id,
-                'profile' => 'http://iiif.io/api/auth/1/token'
+              "id" => "https://example.org/auth/iiif",
+              "profile" => "http://iiif.io/api/auth/1/login",
+              "label" => service_label,
+              "service" => [{
+                "id" => token_service_id,
+                "profile" => "http://iiif.io/api/auth/1/token"
               }]
             )
           }
           let(:image_object_w_login) {
             img = image_object
-            img.service.first['service'] = [login_service]
+            img.service.first["service"] = [login_service]
             img
           }
-          it 'validates' do
-            expect{image_object_w_login.validate}.not_to raise_error
+          it "validates" do
+            expect { image_object_w_login.validate }.not_to raise_error
           end
-          it 'has expected service value' do
+          it "has expected service value" do
             img_service_obj = image_object_w_login.service.first
             expect(img_service_obj.class).to eq IIIF::V3::Presentation::Service
             expect(img_service_obj.keys.size).to eq 5
             expect(img_service_obj.id).to eq img_id
-            expect(img_service_obj['@id']).to eq img_id
+            expect(img_service_obj["@id"]).to eq img_id
             expect(img_service_obj.profile).to eq IIIF::V3::Presentation::Service::IIIF_IMAGE_V2_LEVEL1_PROFILE
             expect(img_service_obj.service.class).to eq Array
             expect(img_service_obj.service.size).to eq 1
 
             login_service_obj = img_service_obj.service.first
             expect(login_service_obj.keys.size).to eq 4
-            expect(login_service.id).to eq 'https://example.org/auth/iiif'
+            expect(login_service.id).to eq "https://example.org/auth/iiif"
             expect(login_service.profile).to eq IIIF::V3::Presentation::Service::IIIF_AUTHENTICATION_V1_LOGIN_PROFILE
             expect(login_service.label).to eq service_label
             expect(login_service.service.class).to eq Array
             expect(login_service.service.size).to eq 1
 
             token_service_obj = login_service_obj.service.first
-            expect(token_service_obj['id']).to eq token_service_id
-            expect(token_service_obj['profile']).to eq IIIF::V3::Presentation::Service::IIIF_AUTHENTICATION_V1_TOKEN_PROFILE
+            expect(token_service_obj["id"]).to eq token_service_id
+            expect(token_service_obj["profile"]).to eq IIIF::V3::Presentation::Service::IIIF_AUTHENTICATION_V1_TOKEN_PROFILE
           end
         end
       end
     end
-    describe 'image examples from http://prezi3.iiif.io/api/presentation/3.0' do
+    describe "image examples from http://prezi3.iiif.io/api/presentation/3.0" do
       let(:image_object) {
         IIIF::V3::Presentation::ImageResource.new({
-          'id' => "#{img_id}/full/full/0/default.jpg",
-          'type' => 'dctypes:Image',
-          'format' => img_mimetype,
-          'height' => height,
-          'width' => width,
-          'service' => [image_v2_service]
-          })
+          "id" => "#{img_id}/full/full/0/default.jpg",
+          "type" => "dctypes:Image",
+          "format" => img_mimetype,
+          "height" => height,
+          "width" => width,
+          "service" => [image_v2_service]
+        })
       }
-      describe 'simpler' do
-        it 'validates' do
-          expect{image_object.validate}.not_to raise_error
+      describe "simpler" do
+        it "validates" do
+          expect { image_object.validate }.not_to raise_error
         end
-        it 'has expected required values' do
+        it "has expected required values" do
           expect(image_object.id).to eq "#{img_id}/full/full/0/default.jpg"
-          expect(image_object.type).to eq 'dctypes:Image'
+          expect(image_object.type).to eq "dctypes:Image"
         end
-        it 'has expected additional values' do
+        it "has expected additional values" do
           expect(image_object.format).to eq img_mimetype
           expect(image_object.height).to eq height
           expect(image_object.width).to eq width
           expect(image_object.service.first).to eq image_v2_service
         end
       end
-      describe 'height and width in service' do
+      describe "height and width in service" do
         # {
         #   "id": "http://example.org/images/book1-page2/full/1500,2000/0/default.jpg",
         #   "type": "dctypes:Image",
@@ -167,21 +166,21 @@ describe IIIF::V3::Presentation::ImageResource do
         # }
         let(:img_obj) {
           img = image_object
-          img.service.first['height'] = 6666
-          img.service.first['width'] = 9999
-          img.service.first['tiles'] = [{"width" => 512, "scaleFactors" => [1,2,4,8,16]}]
+          img.service.first["height"] = 6666
+          img.service.first["width"] = 9999
+          img.service.first["tiles"] = [{"width" => 512, "scaleFactors" => [1, 2, 4, 8, 16]}]
           img
         }
-        it 'validates' do
-          expect{img_obj.validate}.not_to raise_error
+        it "validates" do
+          expect { img_obj.validate }.not_to raise_error
         end
-        it 'has expected service value' do
+        it "has expected service value" do
           service_obj = img_obj.service.first
           expect(service_obj.class).to eq IIIF::V3::Presentation::Service
           expect(service_obj.keys.size).to eq 7
-          expect(service_obj['height']).to eq 6666
-          expect(service_obj['width']).to eq 9999
-          expect(service_obj['tiles']).to eq [{"width" => 512, "scaleFactors" => [1,2,4,8,16]}]
+          expect(service_obj["height"]).to eq 6666
+          expect(service_obj["width"]).to eq 9999
+          expect(service_obj["tiles"]).to eq [{"width" => 512, "scaleFactors" => [1, 2, 4, 8, 16]}]
         end
       end
     end