ro-crate 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa3bf8a8cdaa985143e1e2988d4fc24e14aad40bfd55763b4be17af23c8fa36a
-  data.tar.gz: 190326475ec90f7328e86252dd4f0c1150750ba8298fef7ba8337291ae988e21
+  metadata.gz: 28049e56f761e9b8684970817cc4eace0a60c78aee05b6a16688e589a2088357
+  data.tar.gz: 3e731b4c6039aa74ea34ab7d672fa665b99d4d030598a16ac593877cb0bf306f
 SHA512:
-  metadata.gz: 7cf568838eba39df6ff3770456a8f2133efe8797d1b916b0acf4523f1830623120e14e3a3e8d3e5bbbf09d7960fe5afc585389010ab674394cc80b3c944363d7
-  data.tar.gz: 151807e2411c7d7d09ef2930f75b1eca9f1274fce14ca28d084c7b609268defc70803832697d79b68b9efe282ed63b0af1b179fd1cb0de2dba641798b331afe9
+  metadata.gz: ac8be2df8a04041f7cafc51e04c2ee67d0e25599b1c7a16716aa0b61a4db132b5fb1e55a1bef48b7c6c83aea6bfaba1826a1ac294f58e3092a35438e1938433c
+  data.tar.gz: 13a3780ee9ff9c85ac6829b0f93e393df3917e9286468c54cd127d1fdba704d14ced069fafb7bcb76378c6b120c6598e431e905059983f1dcec704efefc038cf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ro-crate (0.5.0)
+    ro-crate (0.5.1)
       addressable (>= 2.7, < 2.9)
       rubyzip (~> 2.0.0)
 

data/lib/ro_crate/model/data_entity.rb

@@ -27,12 +27,25 @@ module ROCrate
     # PLEASE NOTE, the new data entity will not be added to the crate. To do this, call Crate#add_data_entity.
     #
     # @param crate [Crate] The RO-Crate that owns this directory.
-    # @param source [nil] Ignored. For compatibility with the File and Directory constructor signatures.
-    # @param id [String, nil] An ID to identify this DataEntity, or nil to auto-generate an appropriate one,
-    #   (or determine via the properties param)
+    # @param source [String, Pathname, ::File, URI, nil, #read] The source on the disk (or on the internet if a URI)
+    # where the content of this DataEntity can be found.
+    # @param crate_path [String, nil] The relative path within the RO-Crate where this data entity should be written.
+    # Also used as the ID of the DataEntity. Will be taken from `properties` or generated if `crate_path` is nil.
     # @param properties [Hash{String => Object}] A hash of JSON-LD properties to associate with this DataEntity.
-    def initialize(crate, source = nil, id = nil, properties = {})
-      super(crate, id, properties)
+    def initialize(crate, source = nil, crate_path = nil, properties = {})
+      if crate_path.is_a?(Hash) && properties.empty?
+        properties = crate_path
+        crate_path = nil
+      end
+
+      @source = normalize_source(source)
+
+      if crate_path.nil?
+        crate_path = @source.basename.to_s if @source.respond_to?(:basename)
+        crate_path = @source.to_s if @source.is_a?(URI) && @source.absolute?
+      end
+
+      super(crate, crate_path, properties)
     end
 
     ##
@@ -51,5 +64,28 @@ module ROCrate
     def filepath
       Addressable::URI.unescape(id.sub(/\A\//, '')).to_s # Remove initial / and decode %20 etc.
     end
+
+    private
+
+    ##
+    # Do some normalization of the given source. Coverts `::File` and `String` (if relative path) to `Pathname`
+    # and ensures they are expanded.
+    #
+    # @param source [String, Pathname, ::File, URI, nil, #read] The source on the disk (or on the internet if a URI).
+    # @return [Pathname, URI, nil, #read] An absolute Pathname or URI for the source.
+    def normalize_source(source)
+      if source.is_a?(String)
+        uri = URI(source) rescue nil
+        if uri&.absolute?
+          source = uri
+        else
+          source = Pathname.new(source)
+        end
+      elsif source.is_a?(::File)
+        source = Pathname.new(source)
+      end
+
+      source.is_a?(Pathname) ? source.expand_path : source
+    end
   end
 end

data/lib/ro_crate/model/directory.rb

@@ -11,20 +11,21 @@ module ROCrate
     # Crate#add_data_entity, or just use Crate#add_directory.
     #
     # @param crate [Crate] The RO-Crate that owns this directory.
-    # @param source_directory [String, Pathname, ::File, nil] The source directory that will be included in the crate.
-    # @param crate_path [String] The relative path within the RO-Crate where this directory will be written.
+    # @param source [String, Pathname, ::File, nil] The source directory that will be included in the crate.
+    # @param crate_path [String, nil] The relative path within the RO-Crate where this directory will be written.
     # @param properties [Hash{String => Object}] A hash of JSON-LD properties to associate with this directory.
-    def initialize(crate, source_directory = nil, crate_path = nil, properties = {})
-      @directory_entries = {}
+    def initialize(crate, source = nil, crate_path = nil, properties = {})
+      super(crate, source, crate_path, properties)
 
-      if source_directory
-        source_directory = Pathname.new(::File.expand_path(source_directory))
-        @entry = Entry.new(source_directory)
-        populate_entries(source_directory)
-        crate_path = source_directory.basename.to_s if crate_path.nil?
+      @directory_entries = {}
+      if @source
+        if @source.is_a?(URI) && @source.absolute?
+          @entry = RemoteEntry.new(@source, directory: true)
+        else
+          @entry = Entry.new(@source)
+          populate_entries(@source)
+        end
       end
-
-      super(crate, nil, crate_path, properties)
     end
 
     ##
@@ -34,7 +35,7 @@ module ROCrate
     # @return [Hash{String => Entry}>]
     def payload
       entries = {}
-      entries[filepath.chomp('/')] = @entry if @entry
+      entries[filepath.chomp('/')] = @entry if @entry && !remote?
 
       @directory_entries.each do |rel_path, entry|
         entries[full_entry_path(rel_path)] = entry
@@ -43,6 +44,10 @@ module ROCrate
       entries
     end
 
+    def remote?
+      @entry.remote?
+    end
+
     private
 
     ##

data/lib/ro_crate/model/file.rb

@@ -15,33 +15,12 @@ module ROCrate
     # @param crate_path [String] The relative path within the RO-Crate where this file will be written.
     # @param properties [Hash{String => Object}] A hash of JSON-LD properties to associate with this file.
     def initialize(crate, source, crate_path = nil, properties = {})
-      if crate_path.is_a?(Hash) && properties.empty?
-        properties = crate_path
-        crate_path = nil
-      end
-
-      if source.is_a?(String)
-        uri = URI(source) rescue nil
-        if uri.absolute?
-          source = uri
-        else
-          source = Pathname.new(source).expand_path
-        end
-      elsif source.is_a?(::File)
-        source = Pathname.new(source).expand_path
-      end
-
-      if crate_path.nil?
-        crate_path = source.basename.to_s if source.respond_to?(:basename)
-        crate_path = source.to_s if source.is_a?(URI) && source.absolute?
-      end
-
-      super(crate, nil, crate_path, properties)
+      super(crate, source, crate_path, properties)
 
-      if source.is_a?(URI) && source.absolute?
-        @entry = RemoteEntry.new(source)
+      if @source.is_a?(URI) && @source.absolute?
+        @entry = RemoteEntry.new(@source)
       else
-        @entry = Entry.new(source)
+        @entry = Entry.new(@source)
       end
     end
 

data/lib/ro_crate/model/remote_entry.rb

@@ -9,8 +9,9 @@ module ROCrate
     # Create a new RemoteEntry.
     #
     # @param uri [URI] An absolute URI.
-    def initialize(uri)
+    def initialize(uri, directory: false)
       @uri = uri
+      @directory = directory
     end
 
     ##
@@ -23,7 +24,7 @@ module ROCrate
     ##
     # Does this RemoteEntry point to a directory
     def directory?
-      false
+      @directory
     end
 
     ##

data/ro_crate.gemspec

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

data/test/fixtures/uri_heavy_crate/main.nf

@@ -0,0 +1,2 @@
+# Redacted!
+# Thanks to Veit Schwämmle and Laura Rodriguez Navas for this example