iiif-presentation 1.4.1 → 1.5.0

data/spec/integration/iiif/service_spec.rb

@@ -1,43 +1,43 @@
 RSpec.describe IIIF::Service do
+  let(:fixtures_dir) { File.join(File.dirname(__FILE__), "../../fixtures") }
+  let(:manifest_from_spec_path) { File.join(fixtures_dir, "manifests/complete_from_spec.json") }
 
-  let(:fixtures_dir) { File.join(File.dirname(__FILE__), '../../fixtures') }
-  let(:manifest_from_spec_path) { File.join(fixtures_dir, 'manifests/complete_from_spec.json') }
-
-  describe 'self.parse' do
-    it 'works from a file' do
+  describe "self.parse" do
+    it "works from a file" do
       s = described_class.parse(manifest_from_spec_path)
-      expect(s['label']).to eq 'Book 1'
+      expect(s["label"]).to eq "Book 1"
     end
-    it 'works from a string of JSON' do
-      file = File.open(manifest_from_spec_path, 'rb')
+    it "works from a string of JSON" do
+      file = File.open(manifest_from_spec_path, "rb")
       json_string = file.read
       file.close
       s = described_class.parse(json_string)
-      expect(s['label']).to eq 'Book 1'
+      expect(s["label"]).to eq "Book 1"
     end
-    describe 'works from a hash' do
-      it 'plain old' do
+    describe "works from a hash" do
+      it "plain old" do
         h = JSON.parse(IO.read(manifest_from_spec_path))
         s = described_class.parse(h)
-        expect(s['label']).to eq 'Book 1'
+        expect(s["label"]).to eq "Book 1"
       end
-      it 'IIIF::OrderedHash' do
+      it "IIIF::OrderedHash" do
         h = JSON.parse(IO.read(manifest_from_spec_path))
         oh = IIIF::OrderedHash[h]
         s = described_class.parse(oh)
-        expect(s['label']).to eq 'Book 1'
+        expect(s["label"]).to eq "Book 1"
       end
     end
-    it 'turns camels to snakes' do
+    it "turns camels to snakes" do
       s = described_class.parse(manifest_from_spec_path)
-      expect(s.keys.include?('see_also')).to be_truthy
-      expect(s.keys.include?('seeAlso')).to be_falsey
+      expect(s.key?("see_also")).to be_truthy
+      expect(s.key?("seeAlso")).to be_falsey
     end
   end
 
-  describe 'self#from_ordered_hash' do
+  describe "self#from_ordered_hash" do
     subject(:parsed) { described_class.from_ordered_hash(fixture) }
-    let(:fixture) { JSON.parse('{
+    let(:fixture) {
+      JSON.parse('{
         "@context": "http://iiif.io/api/presentation/2/context.json",
         "@id": "http://example.com/manifest",
         "@type": "sc:Manifest",
@@ -84,33 +84,31 @@ RSpec.describe IIIF::Service do
         ]
       }')
     }
-    it 'doesn\'t raise a NoMethodError when we check the keys' do
+    it "doesn't raise a NoMethodError when we check the keys" do
       expect { parsed }.to_not raise_error
     end
 
-    it 'turns the fixture into a Manifest instance' do
+    it "turns the fixture into a Manifest instance" do
       expect(parsed).to be_a IIIF::Presentation::Manifest
     end
 
     it 'turns keys without "@type" into an OrderedHash' do
-      expect(parsed['some_other_thing']).to be_a IIIF::OrderedHash
+      expect(parsed["some_other_thing"]).to be_a IIIF::OrderedHash
     end
 
-    it 'turns services into Services' do
-      expect(parsed['service']).to be_a IIIF::Presentation::Service
+    it "turns services into Services" do
+      expect(parsed["service"]).to be_a IIIF::Presentation::Service
     end
 
-    it 'works with arrays of services' do
-      fixture['service'] = [fixture['service']]
-      expect(parsed['service'].first).to be_a IIIF::Presentation::Service
+    it "works with arrays of services" do
+      fixture["service"] = [fixture["service"]]
+      expect(parsed["service"].first).to be_a IIIF::Presentation::Service
     end
 
-    it 'round-trips' do
-      fp = '/tmp/osullivan-spec.json'
-      File.open(fp,'w') do |f|
-        f.write(parsed.to_json)
-      end
-      from_file = IIIF::Service.parse('/tmp/osullivan-spec.json')
+    it "round-trips" do
+      fp = "/tmp/osullivan-spec.json"
+      File.write(fp, parsed.to_json)
+      from_file = IIIF::Service.parse("/tmp/osullivan-spec.json")
       File.delete(fp)
       # is this sufficient?
       expect(parsed.to_ordered_hash.to_a - from_file.to_ordered_hash.to_a).to eq []
@@ -118,86 +116,87 @@ RSpec.describe IIIF::Service do
     end
 
     it 'turns each memeber of "sequences" into an instance of Sequence' do
-      expect(parsed['sequences']).to all be_a IIIF::Presentation::Sequence
+      expect(parsed["sequences"]).to all be_a IIIF::Presentation::Sequence
     end
 
-    it 'turns each member of sequences/canvaes in an instance of Canvas' do
-      parsed['sequences'].each do |s|
+    it "turns each member of sequences/canvaes in an instance of Canvas" do
+      parsed["sequences"].each do |s|
         expect(s.canvases).to all be_a IIIF::Presentation::Canvas
       end
     end
 
-    it 'turns the keys into snakes' do
-      expect(parsed.has_key?('seeAlso')).to be false
-      expect(parsed.has_key?('see_also')).to be true
+    it "turns the keys into snakes" do
+      expect(parsed.has_key?("seeAlso")).to be false
+      expect(parsed.has_key?("see_also")).to be true
     end
 
-    it 'copies over plain-old key-values' do
-      expect(parsed['label']).to eq 'My Manifest'
+    it "copies over plain-old key-values" do
+      expect(parsed["label"]).to eq "My Manifest"
     end
   end
 
-  describe '#to_ordered_hash' do
-    let(:logo_uri) { 'http://www.example.org/logos/institution1.jpg' }
-    let(:within_uri) { 'http://www.example.org/collections/books/' }
-    let(:see_also) { 'http://www.example.org/library/catalog/book1.xml' }
-
-    describe 'it puts the json-ld keys at the top' do
-      let(:extra_props) { [ 
-        ['label','foo'], 
-        ['logo','http://example.com/logo.jpg'],
-        ['within','http://example.com/something']
-      ] }
-      let(:sorted_ld_keys) { 
-        subject.keys.select { |k| k.start_with?('@') }.sort!
+  describe "#to_ordered_hash" do
+    let(:logo_uri) { "http://www.example.org/logos/institution1.jpg" }
+    let(:within_uri) { "http://www.example.org/collections/books/" }
+    let(:see_also) { "http://www.example.org/library/catalog/book1.xml" }
+
+    describe "it puts the json-ld keys at the top" do
+      let(:extra_props) {
+        [
+          ["label", "foo"],
+          ["logo", "http://example.com/logo.jpg"],
+          ["within", "http://example.com/something"]
+        ]
       }
-      before(:each) { 
-        extra_props.reverse.each do |k,v| 
-          subject.unshift(k,v) 
+      let(:sorted_ld_keys) {
+        subject.keys.select { |k| k.start_with?("@") }.sort!
+      }
+      before(:each) {
+        extra_props.reverse_each do |k, v|
+          subject.unshift(k, v)
         end
       }
 
-      it 'by default' do
-        (0..extra_props.length-1).each do |i|
+      it "by default" do
+        (0..extra_props.length - 1).each do |i|
           expect(subject.keys[i]).to eq(extra_props[i][0])
         end
         oh = subject.to_ordered_hash
-        (0..sorted_ld_keys.length-1).each do |i|
+        (0..sorted_ld_keys.length - 1).each do |i|
           expect(oh.keys[i]).to eq(sorted_ld_keys[i])
         end
       end
-      it 'unless you say not to' do
-        (0..extra_props.length-1).each do |i|
+      it "unless you say not to" do
+        (0..extra_props.length - 1).each do |i|
           expect(subject.keys[i]).to eq(extra_props[i][0])
         end
         oh = subject.to_ordered_hash(sort_json_ld_keys: false)
-        (0..extra_props.length-1).each do |i|
+        (0..extra_props.length - 1).each do |i|
           expect(oh.keys[i]).to eq(extra_props[i][0])
         end
       end
     end
 
-    describe 'removes empty keys' do
-      it 'if they\'re arrays' do
-        subject['logo'] = logo_uri
-        subject['within'] = []
+    describe "removes empty keys" do
+      it "if they're arrays" do
+        subject["logo"] = logo_uri
+        subject["within"] = []
         ordered_hash = subject.to_ordered_hash
-        expect(ordered_hash.has_key?('within')).to be_falsey
+        expect(ordered_hash.has_key?("within")).to be_falsey
       end
-      it 'if they\'re nil' do
-        subject['logo'] = logo_uri
-        subject['within'] = nil
+      it "if they're nil" do
+        subject["logo"] = logo_uri
+        subject["within"] = nil
         ordered_hash = subject.to_ordered_hash
-        expect(ordered_hash.has_key?('within')).to be_falsey
+        expect(ordered_hash.has_key?("within")).to be_falsey
       end
     end
 
-    it 'converts snake_case keys to camelCase' do
-      subject['see_also'] = logo_uri
-      subject['within'] = within_uri
+    it "converts snake_case keys to camelCase" do
+      subject["see_also"] = logo_uri
+      subject["within"] = within_uri
       ordered_hash = subject.to_ordered_hash
-      expect(ordered_hash.keys.include?('seeAlso')).to be_truthy
+      expect(ordered_hash.key?("seeAlso")).to be_truthy
     end
   end
-
 end

data/spec/integration/iiif/v3/abstract_resource_spec.rb

@@ -1,51 +1,52 @@
-require 'active_support/inflector'
-require 'json'
+require "active_support/inflector"
+require "json"
 
 describe IIIF::V3::AbstractResource do
+  let(:fixtures_dir) { File.join(File.dirname(__FILE__), "../../../fixtures") }
+  let(:manifest_from_spec_path) { File.join(fixtures_dir, "v3/manifests/complete_from_spec.json") }
 
-  let(:fixtures_dir) { File.join(File.dirname(__FILE__), '../../../fixtures') }
-  let(:manifest_from_spec_path) { File.join(fixtures_dir, 'v3/manifests/complete_from_spec.json') }
-
-  describe 'self.parse' do
-    it 'works from a file' do
+  describe "self.parse" do
+    it "works from a file" do
       s = described_class.parse(manifest_from_spec_path)
-      expect(s['label']['en']).to include 'Book 1'
+      expect(s["label"]["en"]).to include "Book 1"
     end
-    it 'works from a string of JSON' do
-      file = File.open(manifest_from_spec_path, 'rb')
+    it "works from a string of JSON" do
+      file = File.open(manifest_from_spec_path, "rb")
       json_string = file.read
       file.close
       s = described_class.parse(json_string)
-      expect(s['label']['en']).to include 'Book 1'
+      expect(s["label"]["en"]).to include "Book 1"
     end
-    describe 'works from a hash' do
-      it 'plain old' do
+    describe "works from a hash" do
+      it "plain old" do
         h = JSON.parse(IO.read(manifest_from_spec_path))
         s = described_class.parse(h)
-        expect(s['label']['en']).to include 'Book 1'
+        expect(s["label"]["en"]).to include "Book 1"
       end
-      it 'IIIF::OrderedHash' do
+      it "IIIF::OrderedHash" do
         h = JSON.parse(IO.read(manifest_from_spec_path))
         oh = IIIF::OrderedHash[h]
         s = described_class.parse(oh)
-        expect(s['label']['en']).to include 'Book 1'
+        expect(s["label"]["en"]).to include "Book 1"
       end
     end
-    it 'turns camels to snakes' do
+    it "turns camels to snakes" do
       s = described_class.parse(manifest_from_spec_path)
-      expect(s.keys.include?('see_also')).to be_truthy
-      expect(s.keys.include?('seeAlso')).to be_falsey
+      expect(s.key?("see_also")).to be_truthy
+      expect(s.key?("seeAlso")).to be_falsey
     end
   end
 
-  describe 'self#from_ordered_hash' do
-    let(:fixture) { JSON.parse('{
+  describe "self#from_ordered_hash" do
+    let(:fixture) {
+      JSON.parse('{
         "@context": [
           "http://iiif.io/api/presentation/3/context.json",
           "http://www.w3.org/ns/anno.jsonld"
         ],
         "id": "http://example.com/manifest",
         "type": "Manifest",
+        "rights": "http://creativecommons.org/licenses/by/4.0/",
         "label": "My Manifest",
         "service": [
           {
@@ -80,10 +81,10 @@ describe IIIF::V3::AbstractResource do
         ]
       }')
     }
-    it 'doesn\'t raise a NoMethodError when we check the keys' do
+    it "doesn't raise a NoMethodError when we check the keys" do
       expect { described_class.from_ordered_hash(fixture) }.to_not raise_error
     end
-    it 'turns the fixture into a Manifest instance' do
+    it "turns the fixture into a Manifest instance" do
       expected_klass = IIIF::V3::Presentation::Manifest
       parsed = described_class.from_ordered_hash(fixture)
       expect(parsed.class).to be expected_klass
@@ -91,22 +92,20 @@ describe IIIF::V3::AbstractResource do
     it 'turns keys without "type" into an OrderedHash' do
       expected_klass = IIIF::OrderedHash
       parsed = described_class.from_ordered_hash(fixture)
-      expect(parsed['some_other_thing'].class).to be expected_klass
+      expect(parsed["some_other_thing"].class).to be expected_klass
     end
 
-    it 'turns services into Services' do
+    it "turns services into Services" do
       expected_klass = IIIF::V3::Presentation::Service
       parsed = described_class.from_ordered_hash(fixture)
-      expect(parsed['service'].map(&:class).uniq).to contain_exactly expected_klass
+      expect(parsed["service"].map(&:class).uniq).to contain_exactly expected_klass
     end
 
-    it 'round-trips' do
-      fp = '/tmp/osullivan-spec.json'
+    it "round-trips" do
+      fp = "/tmp/osullivan-spec.json"
       parsed = described_class.from_ordered_hash(fixture)
-      File.open(fp,'w') do |f|
-        f.write(parsed.to_json)
-      end
-      from_file = IIIF::V3::Presentation::Service.parse('/tmp/osullivan-spec.json')
+      File.write(fp, parsed.to_json)
+      from_file = IIIF::V3::Presentation::Service.parse("/tmp/osullivan-spec.json")
       File.delete(fp)
       # is this sufficient?
       expect(parsed.to_ordered_hash.to_a - from_file.to_ordered_hash.to_a).to eq []
@@ -114,91 +113,92 @@ describe IIIF::V3::AbstractResource do
     end
     it 'turns each member of "items" into an instance of Sequence' do
       parsed = described_class.from_ordered_hash(fixture)
-      parsed['items'].each do |s|
+      parsed["items"].each do |s|
         expect(s.class).to be IIIF::V3::Presentation::Canvas
       end
     end
-    it 'turns each member of sequences/items into an instance of Canvas' do
+    it "turns each member of sequences/items into an instance of Canvas" do
       parsed = described_class.from_ordered_hash(fixture)
-      parsed['items'].each do |s|
+      parsed["items"].each do |s|
         s.items.each do |c|
           expect(c.class).to be IIIF::V3::Presentation::Canvas
         end
       end
     end
-    it 'turns the keys into snakes' do
-      expect(described_class.from_ordered_hash(fixture).has_key?('seeAlso')).to be_falsey
-      expect(described_class.from_ordered_hash(fixture).has_key?('see_also')).to be_truthy
+    it "turns the keys into snakes" do
+      expect(described_class.from_ordered_hash(fixture).has_key?("seeAlso")).to be_falsey
+      expect(described_class.from_ordered_hash(fixture).has_key?("see_also")).to be_truthy
     end
-    it 'copies over plain-old key-values' do
+    it "copies over plain-old key-values" do
       parsed = described_class.from_ordered_hash(fixture)
-      expect(parsed['label']).to eq 'My Manifest'
+      expect(parsed["label"]).to eq "My Manifest"
     end
   end
 
-  describe '#to_ordered_hash' do
-    let(:logo_uri) { 'http://www.example.org/logos/institution1.jpg' }
-    let(:within_uri) { 'http://www.example.org/collections/books/' }
-    let(:see_also) { 'http://www.example.org/library/catalog/book1.xml' }
+  describe "#to_ordered_hash" do
+    let(:logo_uri) { "http://www.example.org/logos/institution1.jpg" }
+    let(:within_uri) { "http://www.example.org/collections/books/" }
+    let(:see_also) { "http://www.example.org/library/catalog/book1.xml" }
     # NOTE:  Using Service to test, as we can't initialize the abstract class
     let(:instantiated_class) { IIIF::V3::Presentation::Service.new }
 
-    describe 'it puts the json-ld keys at the top' do
-      let(:extra_props) { [
-        ['label','foo'],
-        ['logo','http://example.com/logo.jpg'],
-        ['within','http://example.com/something']
-      ] }
+    describe "it puts the json-ld keys at the top" do
+      let(:extra_props) {
+        [
+          ["label", "foo"],
+          ["logo", "http://example.com/logo.jpg"],
+          ["within", "http://example.com/something"]
+        ]
+      }
       let(:sorted_ld_keys) {
-        instantiated_class.keys.select { |k| k.start_with?('@') }.sort!
+        instantiated_class.keys.select { |k| k.start_with?("@") }.sort!
       }
       before(:each) {
-        extra_props.reverse.each do |k,v|
-          instantiated_class.unshift(k,v)
+        extra_props.reverse_each do |k, v|
+          instantiated_class.unshift(k, v)
         end
       }
 
-      it 'by default' do
-        (0..extra_props.length-1).each do |i|
+      it "by default" do
+        (0..extra_props.length - 1).each do |i|
           expect(instantiated_class.keys[i]).to eq(extra_props[i][0])
         end
         oh = instantiated_class.to_ordered_hash
-        (0..sorted_ld_keys.length-1).each do |i|
+        (0..sorted_ld_keys.length - 1).each do |i|
           expect(oh.keys[i]).to eq(sorted_ld_keys[i])
         end
       end
-      it 'unless you say not to' do
-        (0..extra_props.length-1).each do |i|
+      it "unless you say not to" do
+        (0..extra_props.length - 1).each do |i|
           expect(instantiated_class.keys[i]).to eq(extra_props[i][0])
         end
         oh = instantiated_class.to_ordered_hash(sort_json_ld_keys: false)
-        (0..extra_props.length-1).each do |i|
+        (0..extra_props.length - 1).each do |i|
           expect(oh.keys[i]).to eq(extra_props[i][0])
         end
       end
     end
 
-    describe 'removes empty keys' do
-      it 'if they\'re arrays' do
-        instantiated_class['logo'] = logo_uri
-        instantiated_class['within'] = []
+    describe "removes empty keys" do
+      it "if they're arrays" do
+        instantiated_class["logo"] = logo_uri
+        instantiated_class["within"] = []
         ordered_hash = instantiated_class.to_ordered_hash
-        expect(ordered_hash.has_key?('within')).to be_falsey
+        expect(ordered_hash.has_key?("within")).to be_falsey
       end
-      it 'if they\'re nil' do
-        instantiated_class['logo'] = logo_uri
-        instantiated_class['within'] = nil
+      it "if they're nil" do
+        instantiated_class["logo"] = logo_uri
+        instantiated_class["within"] = nil
         ordered_hash = instantiated_class.to_ordered_hash
-        expect(ordered_hash.has_key?('within')).to be_falsey
+        expect(ordered_hash.has_key?("within")).to be_falsey
       end
     end
 
-    it 'converts snake_case keys to camelCase' do
-      instantiated_class['see_also'] = logo_uri
-      instantiated_class['within'] = within_uri
+    it "converts snake_case keys to camelCase" do
+      instantiated_class["see_also"] = logo_uri
+      instantiated_class["within"] = within_uri
       ordered_hash = instantiated_class.to_ordered_hash
-      expect(ordered_hash.keys.include?('seeAlso')).to be_truthy
+      expect(ordered_hash.key?("seeAlso")).to be_truthy
     end
   end
-
 end