ro-crate 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e3f58e7b54e7d04913b3ab7ed778fe0c2fbfa01c9571ec7d5c62d9fb7ec9555
-  data.tar.gz: 5b544b0a343c185571a2fccc1438bfd53426b7f6a02d4605b4d7a7f517058560
+  metadata.gz: 78897fbce0fd01688c27516dceba600ed7cd984668fd16abde32a1713c0ba40f
+  data.tar.gz: 3194d882e4b7f6cd347d652d5da38cb2fe02cfb18e36d84f50e012193a538a69
 SHA512:
-  metadata.gz: e12c059af0471d6423fc0af754713d66f0d654d3196d331fc2d3a8a7d9f6642e8e7fada4749ad7fa2b7478cc64be4652b09aba2d1851d2d7f44100d1d52a6b14
-  data.tar.gz: c0c2654d4261aad3f2e9db64b64338af9425e7aea73a92848a98561bf27ea3f0489a926857efc5e80990475b17b42a499657cad292e8b0e8d7593be647ab6d80
+  metadata.gz: ddc2f5ffe217717299f2e5d76313b2a124fabfbc7b1e1800db18ca36d2f79c716ef249c6fcb8a6a8bfd4e0c5bba3b8a30d6ae3498ef8fd0068d7df08985c72f5
+  data.tar.gz: 802bf935d2e911ce771e962d6faaf0821f682049424cf5ac893ec780b8fc89d22f844156a83dd38adbe045a31faa7e527b4d8406bcabe937bdf8a2e8afafcd93

data/Gemfile.lock

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

data/lib/ro_crate/model/crate.rb

@@ -68,22 +68,23 @@ module ROCrate
     #
     # @param source_directory [String, Pathname, ::File,] The source directory that will be included in the crate.
     # @param create_entities [Boolean] Whether to create data entities for the added content, or just include them anonymously.
+    # @param include_hidden [Boolean] Whether to include hidden files, i.e. those prefixed by a `.` (period).
     #
     # @return [Array<DataEntity>] Any entities that were created from the directory contents. Will be empty if `create_entities` was false.
-    def add_all(source_directory, create_entities = true)
+    def add_all(source_directory, create_entities = true, include_hidden: false)
       added = []
 
-      list_all_files(source_directory).each do |rel_path|
-        source_path = Pathname.new(::File.join(source_directory, rel_path)).expand_path
-        if create_entities
+      if create_entities
+        list_all_files(source_directory, include_hidden: include_hidden).each do |rel_path|
+          source_path = Pathname.new(::File.join(source_directory, rel_path)).expand_path
           if source_path.directory?
             added << add_directory(source_path, rel_path)
           else
             added << add_file(source_path, rel_path)
           end
-        else
-          populate_entries(Pathname.new(::File.expand_path(source_directory)))
         end
+      else
+        populate_entries(Pathname.new(::File.expand_path(source_directory)), include_hidden: include_hidden)
       end
 
       added
@@ -224,8 +225,8 @@ module ROCrate
       entries = {}
 
       (default_entities | data_entities).each do |entity|
-        (entity == self ? own_entries : entity.entries).each do |path, io|
-          entries[path] = io
+        (entity == self ? own_entries : entity.entries).each do |path, entry|
+          entries[path] = entry
         end
       end
 

data/lib/ro_crate/model/directory.rb

@@ -21,7 +21,7 @@ module ROCrate
 
       if source_directory
         source_directory = Pathname.new(::File.expand_path(source_directory))
-        @entry = source_directory
+        @entry = Entry.new(source_directory)
         populate_entries(source_directory)
         crate_path = source_directory.basename.to_s if crate_path.nil?
       end
@@ -51,13 +51,14 @@ module ROCrate
     # Populate this directory with files/directories from a given source directory on disk.
     #
     # @param source_directory [Pathname] The source directory to populate from.
+    # @param include_hidden [Boolean] Whether to include hidden files, i.e. those prefixed by a `.` (period).
     #
     # @return [Hash{String => Entry}>] The files/directories that were populated.
     #   The key is the relative path of the file/directory, and the value is an Entry object where data can be read etc.
-    def populate_entries(source_directory)
+    def populate_entries(source_directory, include_hidden: false)
       raise 'Not a directory' unless ::File.directory?(source_directory)
       @directory_entries = {}
-      list_all_files(source_directory).each do |rel_path|
+      list_all_files(source_directory, include_hidden: include_hidden).each do |rel_path|
         source_path = Pathname.new(::File.join(source_directory, rel_path)).expand_path
         @directory_entries[rel_path] = Entry.new(source_path)
       end
@@ -69,8 +70,10 @@ module ROCrate
       ::File.join(filepath, relative_path)
     end
 
-    def list_all_files(source_directory)
-      Dir.chdir(source_directory) { Dir.glob('**/*', ::File::FNM_DOTMATCH) }.reject do |path|
+    def list_all_files(source_directory, include_hidden: false)
+      args = ['**/*']
+      args << ::File::FNM_DOTMATCH if include_hidden
+      Dir.chdir(source_directory) { Dir.glob(*args) }.reject do |path|
         path == '.' || path == '..' || path.end_with?('/.')
       end
     end

data/ro_crate.gemspec

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

data/test/crate_test.rb

@@ -201,7 +201,7 @@ class CrateTest < Test::Unit::TestCase
 
   test 'can add an entire directory tree as data entities' do
     crate = ROCrate::Crate.new
-    entities = crate.add_all(fixture_file('directory').path)
+    entities = crate.add_all(fixture_file('directory').path, include_hidden: true)
 
     paths = crate.entries.keys
     assert_equal 11, paths.length
@@ -234,7 +234,7 @@ class CrateTest < Test::Unit::TestCase
 
   test 'can create an RO-Crate using content from a given directory' do
     crate = ROCrate::Crate.new
-    entities = crate.add_all(fixture_file('directory').path, false)
+    entities = crate.add_all(fixture_file('directory').path, false, include_hidden: true)
 
     assert_empty entities
 
@@ -261,4 +261,36 @@ class CrateTest < Test::Unit::TestCase
     assert_nil crate.dereference('data/nested.txt')
     assert_nil crate.dereference('.dotfile')
   end
+
+  test 'can create an RO-Crate using content from a given directory, excluding hidden files' do
+    crate = ROCrate::Crate.new
+    entities = crate.add_all(fixture_file('directory').path)
+
+    paths = crate.entries.keys
+    assert_equal 8, paths.length
+    assert_includes paths, 'data'
+    assert_includes paths, 'root.txt'
+    assert_includes paths, 'info.txt'
+    assert_includes paths, 'data/binary.jpg'
+    assert_includes paths, 'data/info.txt'
+    assert_includes paths, 'data/nested.txt'
+    assert_not_includes paths, '.dotfile'
+    assert_not_includes paths, '.dir'
+    assert_not_includes paths, '.dir/test.txt'
+    assert_includes paths, 'ro-crate-metadata.json'
+    assert_includes paths, 'ro-crate-preview.html'
+
+    assert_equal 6, entities.length
+    assert_equal 'ROCrate::Directory', crate.dereference('data/').class.name
+    assert_equal 'ROCrate::File', crate.dereference('root.txt').class.name
+    assert_equal 'ROCrate::File', crate.dereference('info.txt').class.name
+    assert_equal 'ROCrate::File', crate.dereference('data/binary.jpg').class.name
+    assert_equal 'ROCrate::File', crate.dereference('data/info.txt').class.name
+    assert_equal 'ROCrate::File', crate.dereference('data/nested.txt').class.name
+    assert_nil crate.dereference('.dotfile')
+    assert_nil crate.dereference('.dir/')
+    assert_nil crate.dereference('.dir/test.txt')
+
+    assert_equal "5678\n", crate.dereference('data/info.txt').source.read
+  end
 end

data/test/reader_test.rb

@@ -109,11 +109,13 @@ class ReaderTest < Test::Unit::TestCase
   test 'reading from directory with directories' do
     crate = ROCrate::Reader.read_directory(fixture_file('directory_crate').path)
 
+    assert crate.entries.values.all? { |e| e.is_a?(ROCrate::Entry) }
     assert crate.entries['fish/info.txt']
     assert_equal '1234', crate.entries['fish/info.txt'].source.read.chomp
-    assert crate.entries['fish/root.txt']
+    refute crate.entries['fish/root.txt'].directory?
+    assert crate.entries['fish/data'].directory?
     assert crate.entries['fish/data/info.txt']
-    assert crate.entries['fish/data/nested.txt']
+    refute crate.entries['fish/data/nested.txt'].remote?
     assert crate.entries['fish/data/binary.jpg']
     assert_equal ['./', 'fish/', 'ro-crate-metadata.jsonld', 'ro-crate-preview.html'], crate.entities.map(&:id).sort
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ro-crate
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Finn Bacall