ro-crate 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7003f224766d4445498db499257b246ea2dbfb842f0f5e0c8d04471ccea4d299
-  data.tar.gz: f62e7c90a54f26aa6b18cf98310c998ada8c6836975c997f551b2b1ab7d85e29
+  metadata.gz: 88f4e08570b547ac985a759af19d619747dd78a9001cd7994f314a42c014e001
+  data.tar.gz: e3711f54d12c1b4d6b1d68d16923dd051ae2b3a01a28a1d1e155a471bb84bfab
 SHA512:
-  metadata.gz: f63fa2c3b9d88ec76f20e8986986d81878dc8bbb82bedd4c2c862ca6fca7f021ad84309678abb12ec6de7fb498a87711409f3f64809aba4c09c5b00676c60aac
-  data.tar.gz: 16616f82e91760e9a6ff3eff1199c327143401086b0f9c577908e28d023e27828b7e36eeffc65333ec3aa440697b8f18cddd9406185f116ccc59ff238c98b1e9
+  metadata.gz: 2a468ad85761945fc782b5ccb6943e4d1b53c7bb528dba59ed19f93ab2af08017f212d93bf47f9af983b6f00fd304dd1b2edfaef5e096f04ffdb181fd75352e5
+  data.tar.gz: 89edb2f44a6842a7409c2e3107e76b3c401533738c32e6c18faecc6c9c29e6fd71a0d06fbe20f67fdec62564d00b3c168da36b29662ab8badfe652d923b7ab58

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ro-crate (0.4.8)
+    ro-crate (0.4.9)
       addressable (~> 2.7.0)
       rubyzip (~> 2.0.0)
 

data/lib/ro_crate/model/contextual_entity.rb

@@ -3,21 +3,9 @@ module ROCrate
   # A class to represent a "Contextual Entity" within an RO-Crate.
   # Contextual Entities are used to describe and provide context to the Data Entities within the crate.
   class ContextualEntity < Entity
-    def self.format_id(id)
+    def self.format_local_id(id)
       i = super
-      begin
-        uri = URI(id)
-      rescue ArgumentError
-        uri = nil
-      end
-
-      if uri&.absolute?
-        i
-      elsif i.start_with?('#')
-        i
-      else
-        "##{i}"
-      end
+      i.start_with?('#') ? i : "##{i}"
     end
 
     ##

data/lib/ro_crate/model/crate.rb

@@ -8,6 +8,11 @@ module ROCrate
     properties(%w[name datePublished author license identifier distribution contactPoint publisher description url hasPart])
 
     def self.format_id(id)
+      i = super(id)
+      i.end_with?('/') ? i : "#{i}/"
+    end
+
+    def self.format_local_id(id)
       return id if id == IDENTIFIER
       super
     end

data/lib/ro_crate/model/data_entity.rb

@@ -3,7 +3,7 @@ module ROCrate
   # A class to represent a "Data Entity" within an RO-Crate.
   # Data Entities are the actual physical files and directories within the Crate.
   class DataEntity < Entity
-    def self.format_id(id)
+    def self.format_local_id(id)
       super.chomp('/')
     end
 

data/lib/ro_crate/model/directory.rb

@@ -4,7 +4,7 @@ module ROCrate
   class Directory < DataEntity
     properties(%w[name contentSize dateModified encodingFormat identifier sameAs])
 
-    def self.format_id(id)
+    def self.format_local_id(id)
       super + '/'
     end
 

data/lib/ro_crate/model/entity.rb

@@ -29,12 +29,34 @@ module ROCrate
     end
 
     ##
-    # Format the given ID with rules appropriate for this type.
+    # Format the given ID with rules appropriate for this type if it is local/relative, leave as-is if absolute.
+    #
+    # @param id [String] The candidate ID to be formatted.
+    # @return [String] The formatted ID.
+    def self.format_id(id)
+      begin
+        uri = URI(id)
+      rescue ArgumentError, URI::InvalidURIError
+        uri = nil
+      end
+
+      if uri&.absolute?
+        id
+      else
+        format_local_id(id)
+      end
+    end
+
+    ##
+    # Format the given local ID with rules appropriate for this type.
     # For example:
     #  * contextual entities MUST be absolute URIs, or begin with: #
     #  * files MUST NOT begin with ./
     #  * directories MUST NOT begin with ./ (except for the crate itself), and MUST end with /
-    def self.format_id(id)
+    #
+    # @param id [String] The candidate local ID to be formatted.
+    # @return [String] The formatted local ID.
+    def self.format_local_id(id)
       Addressable::URI.escape(id.sub(/\A\.\//, '')) # Remove initial ./ if present
     end
 

data/lib/ro_crate/reader.rb

@@ -31,7 +31,7 @@ module ROCrate
     def self.unzip_to(source, target)
       source = Pathname.new(::File.expand_path(source)) if source.is_a?(String)
 
-      if source.is_a?(Pathname) || source.is_a?(::File)
+      if source.is_a?(Pathname) || source.respond_to?(:path)
         unzip_file_to(source, target)
       else
         unzip_io_to(source, target)

data/ro_crate.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ro-crate'
-  s.version     = '0.4.8'
+  s.version     = '0.4.9'
   s.summary     = 'Create, manipulate, read RO-Crates.'
   s.authors     = ['Finn Bacall']
   s.email       = 'finn.bacall@manchester.ac.uk'

data/test/entity_test.rb

@@ -70,4 +70,25 @@ class EntityTest < Test::Unit::TestCase
     assert_equal({ '@id' => '#fred' }, person.reference)
     assert_equal(person.canonical_id, crate.author.canonical_id)
   end
+
+  test 'format various IDs' do
+    assert_equal "#Hello%20World/Goodbye%20World", ROCrate::ContextualEntity.format_id('#Hello World/Goodbye World')
+    assert_equal "#Hello%20World/Goodbye%20World", ROCrate::ContextualEntity.format_id('Hello World/Goodbye World')
+    assert_equal "#%F0%9F%98%8A", ROCrate::ContextualEntity.format_id("😊")
+
+    assert_equal "test123/hello.txt", ROCrate::File.format_id('./test123/hello.txt')
+    assert_equal "test123/hello.txt", ROCrate::File.format_id('./test123/hello.txt/')
+    assert_equal "http://www.data.com/my%20data.txt", ROCrate::File.format_id('http://www.data.com/my%20data.txt')
+    assert_equal "http://www.data.com/my%20data.txt/", ROCrate::File.format_id('http://www.data.com/my%20data.txt/'), 'Should not modify absolute URI for DataEntity'
+
+    assert_equal "my%20directory/", ROCrate::Directory.format_id('my directory')
+    assert_equal "my%20directory/", ROCrate::Directory.format_id('my directory/')
+    assert_equal 'http://www.data.com/my%20directory', ROCrate::Directory.format_id('http://www.data.com/my%20directory'), 'Should not modify absolute URI for DataEntity'
+    assert_equal 'http://www.data.com/my%20directory/', ROCrate::Directory.format_id('http://www.data.com/my%20directory/'), 'Should not modify absolute URI for DataEntity'
+
+    assert_equal "./", ROCrate::Crate.format_id('./')
+    assert_equal "cool%20crate/", ROCrate::Crate.format_id('./cool crate')
+    assert_equal "http://www.data.com/my%20crate/", ROCrate::Crate.format_id('http://www.data.com/my%20crate'), 'Crate ID should end with /'
+    assert_equal "http://www.data.com/my%20crate/", ROCrate::Crate.format_id('http://www.data.com/my%20crate/')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ro-crate
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors:
 - Finn Bacall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable