iiif-presentation 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5872ac7de857fa05e0181916f712460413e5b08b09d0b99867cc14ae39e0e5
-  data.tar.gz: 213166e3e00800955380ed432a1b10fce3a497011af92db4657474ef56e4b2aa
+  metadata.gz: cc1d6696459ce980fb1c2b41a48ff98f97c25096e72fe803eedbe058e73031ed
+  data.tar.gz: cb0e7e02ae09625490473a11fac3eb8680ae91ae43279311b1c41f922df1c578
 SHA512:
-  metadata.gz: 840576064059d424a68fc9917e30a6a2bc120fb7157691fae70edadaa705711301fd175a3942ce227298086c934ae0f0f471b8379a00314da9aea7b068643b07
-  data.tar.gz: 308dd4b3bcd7b4dfbfaa5147a4d0208dfaedaa69265577b43fd46e04e59be8f95f12a92667a12c935d07a534e6ef271ea2ce9d50dbc449b5a2af1a800b0a51d9
+  metadata.gz: 075fbdad767e99ccf4b8e197b5fef5c0fdd658a7a59e6f9c37845f17147d7069441fc031915c3eba1116e5a86c4056ec6dc0eec86eb32c8846efbc92be5f0c82
+  data.tar.gz: fa4986c26803ebb8abaa71571ed982475ecd1f6ccad4d170ca48e98352cae3477e0a6b7c4c5f9aeddcecc13208ed8f359161882e76cde71e8af9c91122d71208

data/.github/workflows/ruby.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+        ruby-version: ['3.3', '3.4', '4.0']
 
     steps:
     - uses: actions/checkout@v3
@@ -33,3 +33,10 @@ jobs:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: bundle exec rake
+    - name: Upload coverage to Coveralls
+      if: matrix.ruby-version == '4.0'
+      uses: coverallsapp/github-action@v2
+      with:
+        file: coverage/.resultset.json
+        format: simplecov
+        fail-on-error: false

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.3

data/Gemfile

@@ -1,12 +1,12 @@
 source "https://rubygems.org"
 gemspec
 
-if ENV['RAILS_VERSION']
-  gem 'activesupport', ENV['RAILS_VERSION']
+if ENV["RAILS_VERSION"]
+  gem "activesupport", ENV["RAILS_VERSION"]
 end
 
-if ENV['FARADAY_VERSION']
-  gem 'faraday', ENV['FARADAY_VERSION']
+if ENV["FARADAY_VERSION"]
+  gem "faraday", ENV["FARADAY_VERSION"]
 end
 
-gem 'debug'
+gem "debug"

data/README.md

@@ -1,6 +1,6 @@
 # O'Sullivan: A Ruby API for working with IIIF Presentation manifests
 
-[![Coverage Status](https://coveralls.io/repos/github/iiif-prezi/osullivan/badge.svg?branch=development)](https://coveralls.io/github/iiif-prezi/osullivan?branch=development)
+[![Coverage Status](https://coveralls.io/repos/github/iiif-prezi/osullivan/badge.svg?branch=main)](https://coveralls.io/github/iiif-prezi/osullivan?branch=main)
 [![Gem Version](https://badge.fury.io/rb/iiif-presentation.svg)](https://badge.fury.io/rb/iiif-presentation)
 
 

data/Rakefile

@@ -1,12 +1,14 @@
 #!/usr/bin/env rake
 
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :ci do
-  Rake::Task['spec'].invoke
+  Rake::Task["standard"].invoke
+  Rake::Task["spec"].invoke
 end
 
 task default: :ci

data/VERSION

@@ -1 +1 @@
-1.4.2
+1.5.0

data/bin/standardrb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/iiif-presentation.gemspec

@@ -1,29 +1,29 @@
-version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+version = File.read(File.expand_path("../VERSION", __FILE__)).strip
 
 Gem::Specification.new do |spec|
-  spec.name          = 'iiif-presentation'
-  spec.version       = version
-  spec.authors       = ['Jon Stroop']
-  spec.email         = ['jpstroop@gmail.com']
-  spec.description   = 'API for working with IIIF Presentation manifests.'
-  spec.summary       = 'API for working with IIIF Presentation manifests.'
-  spec.license       = 'Simplified BSD'
-  spec.homepage      = 'https://github.com/iiif/osullivan'
+  spec.name = "iiif-presentation"
+  spec.version = version
+  spec.authors = ["Jon Stroop"]
+  spec.email = ["jpstroop@gmail.com"]
+  spec.description = "API for working with IIIF Presentation manifests."
+  spec.summary = "API for working with IIIF Presentation manifests."
+  spec.license = "Simplified BSD"
+  spec.homepage = "https://github.com/iiif/osullivan"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.test_files    = spec.files.grep(%r{^spec/})
-  spec.require_paths = ['lib']
+  spec.files = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'multi_json'
-  spec.add_development_dependency 'vcr', '~> 5'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov", "~> 1.3"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "multi_json"
+  spec.add_development_dependency "vcr", "~> 6.4"
+  spec.add_development_dependency "standard"
 
-  spec.add_dependency 'json'
-  spec.add_dependency 'activesupport', '>= 3.2.18'
-  spec.add_dependency 'faraday', '~> 2.7'
-  spec.add_dependency 'geo_coord'
+  spec.add_dependency "json"
+  spec.add_dependency "activesupport", ">= 3.2.18"
+  spec.add_dependency "faraday", "~> 2.7"
+  spec.add_dependency "geo_coord"
 end

data/lib/iiif/hash_behaviours.rb

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module IIIF
   module HashBehaviours
@@ -9,10 +9,9 @@ module IIIF
     #  * replace
 
     def_delegators :@data, :[], :[]=, :camelize_keys, :delete, :dig, :empty?,
-    :fetch, :has_key?, :has_value?, :include?, :insert, :insert_after,
-    :insert_before, :key, :key?, :keys, :length, :member?, :shift, :size,
-    :snakeize_keys, :store, :unshift, :value?, :values
-
+      :fetch, :has_key?, :has_value?, :include?, :insert, :insert_after,
+      :insert_before, :key, :key?, :keys, :length, :member?, :shift, :size,
+      :snakeize_keys, :store, :unshift, :value?, :values
 
     ###
     # Methods that take a block and should return an instance (self or a new'
@@ -23,11 +22,11 @@ module IIIF
 
     SIMPLE_SELF_RETURNERS.each do |method_name|
       define_method(method_name) do |*arg, &block|
-        unless block.nil? # block_given? doesn't seem to work in this context
-          @data.send(method_name, *arg, &block)
-          return self
-        else
+        if block.nil?
           @data.send(method_name)
+        else # block_given? doesn't seem to work in this context
+          @data.send(method_name, *arg, &block)
+          self
         end
       end
     end
@@ -35,7 +34,7 @@ module IIIF
     # Clear is the only method that returns self but doesn't accept a block
     def clear
       @data.clear
-      return self
+      self
     end
 
     # Returns a new instance of this class containing the contents of'
@@ -53,19 +52,19 @@ module IIIF
     # by calling the block with the key, its value in hsh and its value in'
     # another_obj.
     def merge another_obj
-      new_instance =  self.class.new
+      new_instance = self.class.new
       # self.clone # Would this be better? What happens to other attributes of the class?
       if block_given?
-        self.each do |k,v|
-          if another_obj.has_key? k
-            new_instance[k] = yield(k, self[k], another_obj[k])
+        each do |k, v|
+          new_instance[k] = if another_obj.has_key? k
+            yield(k, self[k], another_obj[k])
           else
-            new_instance[k] = v
+            v
           end
         end
       else
-        self.each { |k,v| new_instance[k] = v }
-        another_obj.each { |k,v| new_instance[k] = v }
+        each { |k, v| new_instance[k] = v }
+        another_obj.each { |k, v| new_instance[k] = v }
       end
       new_instance
     end
@@ -85,20 +84,20 @@ module IIIF
     # another_obj.
     def merge! another_obj
       if block_given?
-        self.each do |k,v|
-          if another_obj.has_key? k
-            self[k] = yield(k, self[k], another_obj[k])
+        each do |k, v|
+          self[k] = if another_obj.has_key? k
+            yield(k, self[k], another_obj[k])
           else
-            self[k] = v
+            v
           end
         end
       else
-        self.each { |k,v| self[k] = v }
-        another_obj.each { |k,v| self[k] = v }
+        each { |k, v| self[k] = v }
+        another_obj.each { |k, v| self[k] = v }
       end
       self
     end
-    alias update merge!
+    alias_method :update, :merge!
 
     # Deletes entries for which the supplied block evaluates to true.
     # Equivalent to #delete_if, but returns nil if there were no changes
@@ -111,9 +110,9 @@ module IIIF
             return_nil = false
           end
         end
-        return return_nil ? nil : self
+        return_nil ? nil : self
       else
-        return self.data.reject!
+        data.reject!
       end
     end
 
@@ -123,9 +122,9 @@ module IIIF
     def select
       new_instance = self.class.new
       if block_given?
-        @data.each { |k,v| new_instance.data[k] = v if yield(k,v) }
+        @data.each { |k, v| new_instance.data[k] = v if yield(k, v) }
       end
-      return new_instance
+      new_instance
     end
 
     # Deletes entries for which the supplied block evaluates to false.
@@ -133,8 +132,8 @@ module IIIF
     def select!
       if block_given?
         return_nil = true
-        @data.each do |k,v|
-          unless yield(k,v)
+        @data.each do |k, v|
+          unless yield(k, v)
             @data.delete(k)
             return_nil = false
           end
@@ -143,8 +142,5 @@ module IIIF
       end
       self
     end
-
   end
-
 end
-

data/lib/iiif/ordered_hash.rb

@@ -1,8 +1,7 @@
-require 'active_support/inflector'
+require "active_support/inflector"
 
 module IIIF
   class OrderedHash < ::Hash
-
     # Insert a new key and value at the suppplied index.
     #
     # Note that this is slightly different from Array#insert in that new
@@ -14,24 +13,24 @@ module IIIF
     # @param [Object] value
     def insert(index, key, value)
       tmp = IIIF::OrderedHash.new
-      index = self.length + 1 + index if index < 0
+      index = length + 1 + index if index < 0
       if index < 0
         m = "Index #{index} is too small for current length (#{length})"
         raise IndexError, m
       end
       if index > 0
-        i=0
-        self.each do |k,v|
+        i = 0
+        each do |k, v|
           tmp[k] = v
-          self.delete(k)
-          i+=1
+          delete(k)
+          i += 1
           break if i == index
         end
       end
       tmp[key] = value
       tmp.merge!(self) # copy the remaining to tmp
-      self.clear       # start over...
-      self.merge!(tmp) # now put them all back
+      clear       # start over...
+      merge!(tmp) # now put them all back
       self
     end
 
@@ -49,9 +48,9 @@ module IIIF
       new_key = hsh[:new_key]
       value = hsh[:value]
       if block_given?
-        self.insert_here(0, new_key, value, &block)
+        insert_here(0, new_key, value, &block)
       else
-        self.insert_here(0, new_key, value, existing_key)
+        insert_here(0, new_key, value, existing_key)
       end
     end
 
@@ -69,27 +68,29 @@ module IIIF
       new_key = hsh[:new_key]
       value = hsh[:value]
       if block_given?
-        self.insert_here(1, new_key, value, &block)
+        insert_here(1, new_key, value, &block)
       else
-        self.insert_here(1, new_key, value, existing_key)
+        insert_here(1, new_key, value, existing_key)
       end
     end
 
     # Delete any keys that are empty arrays
     def remove_empties
-      self.keys.each do |key|
-        if (self[key].kind_of?(Array) && self[key].empty?) || self[key].nil?
-          self.delete(key)
+      keys.each do |key|
+        if (self[key].is_a?(Array) && self[key].empty?) || self[key].nil?
+          delete(key)
         end
       end
     end
 
     # Covert snake_case keys to camelCase
     def camelize_keys
-      self.keys.each_with_index do |key, i|
-        if key != key.camelize(:lower)
-          self.insert(i, key.camelize(:lower), self[key])
-          self.delete(key)
+      keys.each_with_index do |key, i|
+        camelized_key = key.camelize(:lower)
+
+        if key != camelized_key
+          insert(i, camelized_key, self[key])
+          delete(key)
         end
       end
       self
@@ -97,30 +98,30 @@ module IIIF
 
     # Covert camelCase keys to snake_case
     def snakeize_keys
-      self.keys.each_with_index do |key, i|
+      keys.each_with_index do |key, i|
         if key != key.underscore
-          self.insert(i, key.underscore, self[key])
-          self.delete(key)
+          insert(i, key.underscore, self[key])
+          delete(key)
         end
       end
       self
     end
 
-
     # Prepends an entry to the front of the object.
     # Note that this is slightly different from Array#unshift in that new
     # entries must be added one at a time, i.e. unshift([k,v],[k,v],...) is
     # not currently supported.
-    def unshift k,v
-      self.insert(0, k, v)
+    def unshift k, v
+      insert(0, k, v)
       self
     end
 
     protected
-    def insert_here(where, new_key, value, existing_key=nil, &block)
+
+    def insert_here(where, new_key, value, existing_key = nil, &block)
       idx = nil
       if block_given?
-        self.each_with_index do |(k,v), i|
+        each_with_index do |(k, v), i|
           if yield(k, v)
             idx = i
             break
@@ -130,17 +131,16 @@ module IIIF
           raise KeyError, "Supplied block never evaluates to true"
         end
       else
-        unless self.has_key?(existing_key)
+        unless has_key?(existing_key)
           raise KeyError, "Existing key '#{existing_key}' does not exist"
         end
-        if self.has_key?(new_key)
+        if has_key?(new_key)
           raise KeyError, "Supplied new key '#{new_key}' already exists"
         end
-        idx = self.keys.index(existing_key) + where
+        idx = keys.index(existing_key) + where
       end
-      self.insert(idx, new_key, value)
+      insert(idx, new_key, value)
       self
     end
-
   end
 end

data/lib/iiif/presentation/abstract_resource.rb

@@ -1,44 +1,43 @@
-require File.join(File.dirname(__FILE__), '../service')
+require File.join(File.dirname(__FILE__), "../service")
 
 module IIIF
   module Presentation
     class AbstractResource < Service
-
       # Every subclass should override the following five methods where
       # appropriate, see Subclasses for how.
       def required_keys
-        %w{ @type }
+        %w[@type]
       end
 
       def any_type_keys # these are allowed on all classes
-        %w{ label description thumbnail attribution license logo see_also
-        related within }
+        %w[ label description thumbnail attribution license logo see_also
+          related within ]
       end
 
       def string_only_keys
-        %w{ viewing_hint } # should any of the any_type_keys be here?
+        %w[viewing_hint] # should any of the any_type_keys be here?
       end
 
       def array_only_keys
-        %w{ metadata }
+        %w[metadata]
       end
 
       def abstract_resource_only_keys
-        super + [ { key: 'service', type: IIIF::Service } ]
+        super + [{key: "service", type: IIIF::Service}]
       end
 
       def hash_only_keys
-        %w{ }
+        %w[]
       end
 
       def int_only_keys
-        %w{ }
+        %w[]
       end
 
       # Not every subclass is allowed to have viewingDirect, but when it is,
       # it must be one of these values
       def legal_viewing_direction_values
-        %w{ left-to-right right-to-left top-to-bottom bottom-to-top }
+        %w[left-to-right right-to-left top-to-bottom bottom-to-top]
       end
 
       def legal_viewing_hint_values
@@ -49,30 +48,26 @@ module IIIF
       # @param [Hash] hsh - Anything in this hash will be added to the Object.
       # @param [boolean] include_context (default: false). Pass true if the'
       #   context should be included.
-      def initialize(hsh={})
-        if self.class == IIIF::Presentation::AbstractResource
+      def initialize(hsh = {})
+        if instance_of?(IIIF::Presentation::AbstractResource)
           raise "#{self.class} is an abstract class. Please use one of its subclasses."
         end
-        super(hsh)
+        super
       end
 
-
       # Options:
       #  * force: (true|false). Skips validations.
       #  * include_context: (true|false). Adds the @context to the top of the
       #      document if it doesn't exist. Default: true.
       #  * sort_json_ld_keys: (true|false). Brings all properties starting with
       #      '@'. Default: true. to the top of the document and sorts them.
-      def to_ordered_hash(opts={})
+      def to_ordered_hash(opts = {})
         include_context = opts.fetch(:include_context, true)
-        if include_context && !self.has_key?('@context')
-          self['@context'] = IIIF::Presentation::CONTEXT
+        if include_context && !has_key?("@context")
+          self["@context"] = IIIF::Presentation::CONTEXT
         end
-        super(opts)
+        super
       end
-      
     end
-
   end
 end
-

data/lib/iiif/presentation/annotation.rb

@@ -1,29 +1,27 @@
-require File.join(File.dirname(__FILE__), 'abstract_resource')
+require File.join(File.dirname(__FILE__), "abstract_resource")
 
 module IIIF
   module Presentation
     class Annotation < AbstractResource
-
-      TYPE = 'oa:Annotation'
+      TYPE = "oa:Annotation"
 
       def required_keys
-        super + %w{ motivation on }
+        super + %w[motivation on]
       end
 
       def string_only_keys
-        super + %w{ on }
+        super + %w[on]
       end
 
       def abstract_resource_only_keys
-        super + [ { key: 'resource', type: IIIF::Presentation::Resource } ]
+        super + [{key: "resource", type: IIIF::Presentation::Resource}]
       end
 
-      def initialize(hsh={})
-        hsh['@type'] = TYPE unless hsh.has_key? '@type'
-        hsh['motivation'] = 'sc:painting' unless hsh.has_key? 'motivation'
-        super(hsh)
+      def initialize(hsh = {})
+        hsh["@type"] = TYPE unless hsh.has_key? "@type"
+        hsh["motivation"] = "sc:painting" unless hsh.has_key? "motivation"
+        super
       end
-
     end
   end
 end

data/lib/iiif/presentation/annotation_list.rb

@@ -1,28 +1,26 @@
-require File.join(File.dirname(__FILE__), 'abstract_resource')
+require File.join(File.dirname(__FILE__), "abstract_resource")
 
 module IIIF
   module Presentation
     class AnnotationList < AbstractResource
-
-      TYPE = 'sc:AnnotationList'
+      TYPE = "sc:AnnotationList"
 
       def required_keys
-        super + %w{ @id }
+        super + %w[@id]
       end
 
-      def array_only_keys; 
-        super + %w{ resources }; 
+      def array_only_keys
+        super + %w[resources]
       end
 
-      def initialize(hsh={})
-        hsh['@type'] = TYPE unless hsh.has_key? '@type'
-        super(hsh)
+      def initialize(hsh = {})
+        hsh["@type"] = TYPE unless hsh.has_key? "@type"
+        super
       end
 
       def validate
         # Each member or resources must be a kind of Annotation
       end
-
     end
   end
 end