ro-crate 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4880110308b68d8bc35333b1fc8a8396ea30e36069f92e059b8c57ec3567d33e
-  data.tar.gz: 77a17a0436f2dea14254a3501f9db349eed5460851d94ab4e87adb7be83e1b38
+  metadata.gz: 12ec7081b3540a664a8146c27c07ad1ab68f7c6dec49fda79560a4e81588c5d6
+  data.tar.gz: 6e367c3d7b299dbaa095cf74c3715cffa877fed5b1cd89f195e61758c47782b3
 SHA512:
-  metadata.gz: 711a45d7aaa63f8a5a7bba78e433d82875311472d6f4abfd6d388dd8565a7707036152c81de4059fd92da5b7851925caf9d808f39d115752e68eaddbdc85bac1
-  data.tar.gz: ce14efaf63e7224adc79cdb11d27bdec933be290ccf60196014cb7ce9380136451265a8f814e1ca7b70286fc32852024d429334bbaab18208d31095cd619dc9e
+  metadata.gz: a659655a5e779cf9ee0f9c662809b82d06c25e57af67bde6954fdc08d6a58ce0b053495b939a764dbf47b91c4298644e23556e02f9ec23d04ce680e746d6ff5f
+  data.tar.gz: 70c036c6fd7692dfdedf466c962bf92d7e92bbe9fe4283fc74a39f8827540f0d828de727ba7b1dde1daa33ee5551554bb52ce87e0637d4d275e6f15574fc8eb9

data/Gemfile.lock

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

data/lib/ro_crate/reader.rb

@@ -3,29 +3,67 @@ module ROCrate
   # A class to handle reading of RO-Crates from Zip files or directories.
   class Reader
     ##
-    # Reads an RO-Crate from a directory of zip file.
+    # Reads an RO-Crate from a directory or zip file.
     #
-    # @param source [String, ::File, Pathname] The source location for the crate.
+    # @param source [String, ::File, Pathname, #read] The location of the zip or directory, or an IO-like object containing a zip.
     # @param target_dir [String, ::File, Pathname] The target directory where the crate should be unzipped (if its a Zip file).
     # @return [Crate] The RO-Crate.
     def self.read(source, target_dir: Dir.mktmpdir)
       raise "Not a directory!" unless ::File.directory?(target_dir)
-      if ::File.directory?(source)
+      begin
+        is_dir = ::File.directory?(source)
+      rescue TypeError
+        is_dir = false
+      end
+
+      if is_dir
         read_directory(source)
       else
         read_zip(source, target_dir: target_dir)
       end
     end
 
+    ##
+    # Extract the contents of the given Zip file/data to the given directory.
+    #
+    # @param source [String, ::File, Pathname, #read] The location of the zip file, or an IO-like object.
+    # @param target [String, ::File, Pathname] The target directory where the file should be unzipped.
+    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)
+        unzip_file_to(source, target)
+      else
+        unzip_io_to(source, target)
+      end
+    end
+
+    ##
+    # Extract the given Zip file data to the given directory.
+    #
+    # @param source [#read] An IO-like object containing a Zip file.
+    # @param target [String, ::File, Pathname] The target directory where the file should be unzipped.
+    def self.unzip_io_to(io, target)
+      Dir.chdir(target) do
+        Zip::InputStream.open(io) do |input|
+          while (entry = input.get_next_entry)
+            unless ::File.exist?(entry.name) || entry.name_is_directory?
+              FileUtils::mkdir_p(::File.dirname(entry.name))
+              ::File.write(entry.name, input.read)
+            end
+          end
+        end
+      end
+    end
+
     ##
     # Extract the contents of the given Zip file to the given directory.
     #
     # @param source [String, ::File, Pathname] The location of the zip file.
     # @param target [String, ::File, Pathname] The target directory where the file should be unzipped.
-    def self.unzip_to(source, target)
-      source = ::File.expand_path(source)
+    def self.unzip_file_to(file_or_path, target)
       Dir.chdir(target) do
-        Zip::File.open(source) do |zipfile|
+        Zip::File.open(file_or_path) do |zipfile|
           zipfile.each do |entry|
             unless ::File.exist?(entry.name)
               FileUtils::mkdir_p(::File.dirname(entry.name))
@@ -40,7 +78,7 @@ module ROCrate
     # Reads an RO-Crate from a zip file. It first extracts the Zip file to a temporary directory, and then calls
     # #read_directory.
     #
-    # @param source [String, ::File, Pathname] The location of the zip file.
+    # @param source [String, ::File, Pathname, #read] The location of the zip file, or an IO-like object.
     # @param target_dir [String, ::File, Pathname] The target directory where the crate should be unzipped.
     # @return [Crate] The RO-Crate.
     def self.read_zip(source, target_dir: Dir.mktmpdir)
@@ -55,6 +93,8 @@ module ROCrate
     # @param source [String, ::File, Pathname] The location of the directory.
     # @return [Crate] The RO-Crate.
     def self.read_directory(source)
+      raise "Not a directory!" unless ::File.directory?(source)
+
       source = ::File.expand_path(source)
       metadata_file = Dir.entries(source).detect { |entry| entry == ROCrate::Metadata::IDENTIFIER ||
           entry == ROCrate::Metadata::IDENTIFIER_1_0 }

data/ro_crate.gemspec

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

data/test/reader_test.rb

@@ -195,4 +195,24 @@ class ReaderTest < Test::Unit::TestCase
     assert crate.entries['fish/data/binary.jpg']
     assert_equal ['./', 'listed_file.txt', 'ro-crate-metadata.jsonld', 'ro-crate-preview.html'], crate.entities.map(&:id).sort
   end
+
+  test 'reading a zip from various object types' do
+    string_io = StringIO.new
+    string_io.write(::File.read(fixture_file('sparse_directory_crate.zip').path))
+    string_io.rewind
+    assert string_io.is_a?(StringIO)
+    assert_equal 11, ROCrate::Reader.read_zip(string_io).entries.count
+
+    path = Pathname.new(fixture_file('sparse_directory_crate.zip').path)
+    assert path.is_a?(Pathname)
+    assert_equal 11, ROCrate::Reader.read_zip(path).entries.count
+
+    file = ::File.open(fixture_file('sparse_directory_crate.zip').path)
+    assert file.is_a?(::File)
+    assert_equal 11, ROCrate::Reader.read_zip(file).entries.count
+
+    string = fixture_file('sparse_directory_crate.zip').path
+    assert string.is_a?(String)
+    assert_equal 11, ROCrate::Reader.read_zip(string).entries.count
+  end
 end

metadata

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