ro-crate 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c4aabc50994541bbcbb2071b805f457e47c9e30176299fdde40741aa5ff1094
-  data.tar.gz: 0f4d7df6b4eb21961446ce2e3c05fe337fa7ed9e161eb21a7651b8ea6292f988
+  metadata.gz: eee42ff56abf6a19d3a0e3575957c338b79a87c5609566618c032ca302ccab8d
+  data.tar.gz: 7d36b9517a344a2d2f9559a11229e8a51e2a2e4b02c5ada951d8b86b82051900
 SHA512:
-  metadata.gz: f590b0e08e5f813474e4c46e3230b01999d17cf349645b8c86285c8dbe3cd371563405e1e1143a7b68d115764373847ace352029beed404a5cc069e64ef40dab
-  data.tar.gz: 972a1e14b6faa4986bad9138fdd39861bf54af81dd5678354f84cc0f4bbc3b50252e38cf948d013bb6a979365dedc74e81c48661115f0cd3f408fcdd0744f777
+  metadata.gz: 82917f083837b091d304e61188dbcb06cbe9a306676e3c17e4c56d662cb3a65d90bb7f41b5c09503caaf457a0740d30a9011a4f4edc64fe2bf78556a6e9f078e
+  data.tar.gz: 430857f30551fb3f4e2c82fce71babfd9574cf4a039ece9dd26318766d054ff4ac9725b3fa6bab134d8e0a5ad5eed01905324aeadbdaf0053730716b57e97eca

data/README.md

@@ -2,10 +2,10 @@
 
 ![Tests](https://github.com/ResearchObject/ro-crate-ruby/actions/workflows/tests.yml/badge.svg)
 
-This is a WIP gem for creating, manipulating and reading RO-Crates (conforming to version 1.2 of the specification). RO-Crates produced by older versions (1.0, 1.1) of the spec can still be read.
+This is a WIP gem for creating, manipulating and reading RO-Crates (conforming to version 1.3 of the specification). RO-Crates produced by older versions (1.0, 1.1, 1.2) of the spec can still be read.
 
 * RO-Crate - https://www.researchobject.org/ro-crate/
-* RO-Crate spec (1.2) - https://www.researchobject.org/ro-crate/specification/1.2/
+* RO-Crate spec (1.3) - https://www.researchobject.org/ro-crate/specification/1.3/
 
 ## Installation
 

data/lib/ro_crate/model/metadata.rb

@@ -6,8 +6,8 @@ module ROCrate
     IDENTIFIER_1_0 = 'ro-crate-metadata.jsonld'.freeze # 1.0 spec identifier
     RO_CRATE_BASE = 'https://w3id.org/ro/crate/'
 
-    SUPPORTED_VERSIONS = %w[1.0 1.0-DRAFT 1.1 1.1-DRAFT 1.2 1.2-DRAFT].freeze
-    DEFAULT_VERSION = '1.2'.freeze
+    SUPPORTED_VERSIONS = %w[1.0 1.0-DRAFT 1.1 1.1-DRAFT 1.2 1.2-DRAFT 1.3].freeze
+    DEFAULT_VERSION = '1.3'.freeze
 
     CONTEXT = "#{RO_CRATE_BASE}#{DEFAULT_VERSION}/context".freeze
     SPEC = "#{RO_CRATE_BASE}#{DEFAULT_VERSION}".freeze

data/ro_crate.gemspec

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

data/test/crate_test.rb

@@ -378,12 +378,12 @@ class CrateTest < Test::Unit::TestCase
     assert crate.get('#joehouse')
   end
 
-  test 'defaults to RO-Crate spec 1.2' do
+  test 'defaults to RO-Crate spec 1.3' do
     crate = ROCrate::Crate.new
-    assert_equal '1.2', crate.metadata.version
-    assert_equal 'https://w3id.org/ro/crate/1.2/context', crate.metadata.context
-    assert_equal 'https://w3id.org/ro/crate/1.2', crate.metadata.spec_url
-    assert_equal({ '@id' => 'https://w3id.org/ro/crate/1.2' }, crate.metadata.properties['conformsTo'])
+    assert_equal '1.3', crate.metadata.version
+    assert_equal 'https://w3id.org/ro/crate/1.3/context', crate.metadata.context
+    assert_equal 'https://w3id.org/ro/crate/1.3', crate.metadata.spec_url
+    assert_equal({ '@id' => 'https://w3id.org/ro/crate/1.3' }, crate.metadata.properties['conformsTo'])
   end
 
   test 'can write older spec version' do

data/test/fixtures/crate-spec1.2/file with spaces.txt

@@ -0,0 +1 @@
+I have spaces in my name

data/test/fixtures/crate-spec1.2/ro-crate-metadata.json

@@ -0,0 +1,42 @@
+{
+  "@context": "https://w3id.org/ro/crate/1.2/context",
+  "@graph": [
+    {
+      "@id": "ro-crate-metadata.json",
+      "@type": "CreativeWork",
+      "about": {
+        "@id": "./"
+      },
+      "conformsTo": {
+        "@id": "https://w3id.org/ro/crate/1.2"
+      }
+    },
+    {
+      "@id": "ro-crate-preview.html",
+      "@type": "CreativeWork",
+      "about": {
+        "@id": "./"
+      }
+    },
+    {
+      "@id": "./",
+      "@type": "Dataset",
+      "hasPart": [
+        {
+          "@id": "http://example.com/external_ref.txt"
+        },
+        {
+          "@id": "file%20with%20spaces.txt"
+        }
+      ]
+    },
+    {
+      "@id": "http://example.com/external_ref.txt",
+      "@type": "File"
+    },
+    {
+      "@id": "file%20with%20spaces.txt",
+      "@type": "File"
+    }
+  ]
+}

data/test/fixtures/crate-spec1.2/ro-crate-preview.html

@@ -0,0 +1,82 @@
+
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <title>New RO-Crate</title>
+  <script type="application/ld+json">{
+  "@context": "https://w3id.org/ro/crate/1.2/context",
+  "@graph": [
+    {
+      "@id": "ro-crate-metadata.json",
+      "@type": "CreativeWork",
+      "about": {
+        "@id": "./"
+      },
+      "conformsTo": {
+        "@id": "https://w3id.org/ro/crate/1.2"
+      }
+    },
+    {
+      "@id": "ro-crate-preview.html",
+      "@type": "CreativeWork",
+      "about": {
+        "@id": "./"
+      }
+    },
+    {
+      "@id": "./",
+      "@type": "Dataset",
+      "hasPart": [
+        {
+          "@id": "http://example.com/external_ref.txt"
+        },
+        {
+          "@id": "file%20with%20spaces.txt"
+        }
+      ]
+    },
+    {
+      "@id": "http://example.com/external_ref.txt",
+      "@type": "File"
+    },
+    {
+      "@id": "file%20with%20spaces.txt",
+      "@type": "File"
+    }
+  ]
+}</script>
+  <meta name="generator" content="https://github.com/ResearchObject/ro-crate-ruby">
+  <meta name="keywords" content="RO-Crate">
+  <meta charset="utf-8">
+</head>
+<body>
+  <h1>New RO-Crate</h1>
+  
+  <p>
+    
+  </p>
+  <dl>
+    
+    
+    
+    
+  </dl>
+
+  <h2>Contents</h2>
+  <ul>
+    
+      <li>
+        <strong><a href="http://example.com/external_ref.txt" target="_blank">http://example.com/external_ref.txt</a></strong>
+        
+        
+      </li>
+    
+      <li>
+        <strong>file%20with%20spaces.txt</strong>
+        
+        
+      </li>
+    
+  </ul>
+</body>
+</html>

data/test/fixtures/crate-spec1.3/file with spaces.txt

@@ -0,0 +1 @@
+I have spaces in my name

data/test/fixtures/crate-spec1.3/ro-crate-metadata.json

@@ -0,0 +1,42 @@
+{
+  "@context": "https://w3id.org/ro/crate/1.3/context",
+  "@graph": [
+    {
+      "@id": "ro-crate-metadata.json",
+      "@type": "CreativeWork",
+      "about": {
+        "@id": "./"
+      },
+      "conformsTo": {
+        "@id": "https://w3id.org/ro/crate/1.3"
+      }
+    },
+    {
+      "@id": "ro-crate-preview.html",
+      "@type": "CreativeWork",
+      "about": {
+        "@id": "./"
+      }
+    },
+    {
+      "@id": "./",
+      "@type": "Dataset",
+      "hasPart": [
+        {
+          "@id": "http://example.com/external_ref.txt"
+        },
+        {
+          "@id": "file%20with%20spaces.txt"
+        }
+      ]
+    },
+    {
+      "@id": "http://example.com/external_ref.txt",
+      "@type": "File"
+    },
+    {
+      "@id": "file%20with%20spaces.txt",
+      "@type": "File"
+    }
+  ]
+}

data/test/fixtures/crate-spec1.3/ro-crate-preview.html

@@ -0,0 +1,82 @@
+
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <title>New RO-Crate</title>
+  <script type="application/ld+json">{
+  "@context": "https://w3id.org/ro/crate/1.3/context",
+  "@graph": [
+    {
+      "@id": "ro-crate-metadata.json",
+      "@type": "CreativeWork",
+      "about": {
+        "@id": "./"
+      },
+      "conformsTo": {
+        "@id": "https://w3id.org/ro/crate/1.3"
+      }
+    },
+    {
+      "@id": "ro-crate-preview.html",
+      "@type": "CreativeWork",
+      "about": {
+        "@id": "./"
+      }
+    },
+    {
+      "@id": "./",
+      "@type": "Dataset",
+      "hasPart": [
+        {
+          "@id": "http://example.com/external_ref.txt"
+        },
+        {
+          "@id": "file%20with%20spaces.txt"
+        }
+      ]
+    },
+    {
+      "@id": "http://example.com/external_ref.txt",
+      "@type": "File"
+    },
+    {
+      "@id": "file%20with%20spaces.txt",
+      "@type": "File"
+    }
+  ]
+}</script>
+  <meta name="generator" content="https://github.com/ResearchObject/ro-crate-ruby">
+  <meta name="keywords" content="RO-Crate">
+  <meta charset="utf-8">
+</head>
+<body>
+  <h1>New RO-Crate</h1>
+  
+  <p>
+    
+  </p>
+  <dl>
+    
+    
+    
+    
+  </dl>
+
+  <h2>Contents</h2>
+  <ul>
+    
+      <li>
+        <strong><a href="http://example.com/external_ref.txt" target="_blank">http://example.com/external_ref.txt</a></strong>
+        
+        
+      </li>
+    
+      <li>
+        <strong>file%20with%20spaces.txt</strong>
+        
+        
+      </li>
+    
+  </ul>
+</body>
+</html>

data/test/reader_test.rb

@@ -188,6 +188,48 @@ class ReaderTest < Test::Unit::TestCase
     assert crate.preview.source.source.is_a?(ROCrate::PreviewGenerator)
   end
 
+  test 'can read a 1.2 spec crate' do
+    stub_request(:get, "http://example.com/external_ref.txt").to_return(status: 200, body: 'file contents')
+
+    crate = ROCrate::Reader.read_directory(fixture_file('crate-spec1.2').path)
+    file = crate.dereference('file with spaces.txt')
+    assert file
+    assert file.is_a?(ROCrate::File)
+    refute file.remote?
+    assert file.source.is_a?(ROCrate::Entry)
+    assert_equal 'file%20with%20spaces.txt', file.id
+
+    ext_file = crate.dereference('http://example.com/external_ref.txt')
+    assert ext_file
+    assert ext_file.is_a?(ROCrate::File)
+    assert ext_file.remote?
+    assert ext_file.source.is_a?(ROCrate::RemoteEntry)
+    assert_equal 'http://example.com/external_ref.txt', ext_file.id
+    assert_equal 'file contents', ext_file.source.read
+    assert crate.preview.source.source.is_a?(Pathname)
+  end
+
+  test 'can read a 1.3 spec crate' do
+    stub_request(:get, "http://example.com/external_ref.txt").to_return(status: 200, body: 'file contents')
+
+    crate = ROCrate::Reader.read_directory(fixture_file('crate-spec1.3').path)
+    file = crate.dereference('file with spaces.txt')
+    assert file
+    assert file.is_a?(ROCrate::File)
+    refute file.remote?
+    assert file.source.is_a?(ROCrate::Entry)
+    assert_equal 'file%20with%20spaces.txt', file.id
+
+    ext_file = crate.dereference('http://example.com/external_ref.txt')
+    assert ext_file
+    assert ext_file.is_a?(ROCrate::File)
+    assert ext_file.remote?
+    assert ext_file.source.is_a?(ROCrate::RemoteEntry)
+    assert_equal 'http://example.com/external_ref.txt', ext_file.id
+    assert_equal 'file contents', ext_file.source.read
+    assert crate.preview.source.source.is_a?(Pathname)
+  end
+
   test 'reading from directory with unlisted files' do
     crate = ROCrate::Reader.read_directory(fixture_file('sparse_directory_crate').path)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ro-crate
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Finn Bacall
@@ -185,6 +185,12 @@ files:
 - test/fixtures/conflicting_data_directory/nested.txt
 - test/fixtures/crate-spec1.1/file with spaces.txt
 - test/fixtures/crate-spec1.1/ro-crate-metadata.json
+- test/fixtures/crate-spec1.2/file with spaces.txt
+- test/fixtures/crate-spec1.2/ro-crate-metadata.json
+- test/fixtures/crate-spec1.2/ro-crate-preview.html
+- test/fixtures/crate-spec1.3/file with spaces.txt
+- test/fixtures/crate-spec1.3/ro-crate-metadata.json
+- test/fixtures/crate-spec1.3/ro-crate-preview.html
 - test/fixtures/data.csv
 - test/fixtures/dir_symlink
 - test/fixtures/directory.zip