bagit 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 258b30416233feee5590250bd84b8ebc84d4c8db3465a6fb30866eecef46d57f
-  data.tar.gz: adf39f1b00e380fc9768e3760ae563130f715656e0eb59ed73f3acbe86a74ae1
+  metadata.gz: e17d65c9af15cfc4638a668291c406670609270c26824fd83634b088ff0a086d
+  data.tar.gz: 23aee83a592d8d722946ae9d6c5ad9b5e93f11dab79fdfef83ee0286800243a1
 SHA512:
-  metadata.gz: 881dac45875b30c505b3efc881337c6695764ec944f6f0f9af7bdd037dd7a50670c9a975e1617d7df13af135e678f800551310dbd0555a57326f4adec88e1c1d
-  data.tar.gz: 375a19f57ed7d8752050ccf7e68499dfd1bb29187c23ae21a85113477e9297e42b932fd931f4fd8981e612a8f1a8bd7a7cb87f04c0c7ae3a3606b90bcdd7e3cb
+  metadata.gz: 17dcf7d21f86cb2c92e74505e509344c45b3febd7d137b34cf43fef08d60a01caf49b58bb2ff3bae6da997344de8da801e879b64f54f83d99953c0dd84b93d79
+  data.tar.gz: a63f38b5c951c8c6d207fd831fbdb3467a2fd9c19e6b12d1ce88b364ab5e74d42c6303cc48ae68a55e7e851f9c2dad12b5940e08645f4ddfeec104cf5c14a009

data/bagit.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Tom Johnson, Francesco Lazzarino, Jamie Little"]
   spec.license = "MIT"
 
-  spec.required_ruby_version = ">= 2.0", "< 3.3"
+  spec.required_ruby_version = ">= 2.0", "< 3.4"
 
   spec.add_dependency "validatable", "~> 1.6"
   spec.add_dependency "docopt", "~> 0.5.0"

data/lib/bagit/bag.rb

@@ -8,9 +8,28 @@ require "bagit/string"
 require "bagit/valid"
 
 module BagIt
+  class FileFinder
+    def self.find(dir)
+      raise NotImplementedError
+    end
+  end
+
+  class StandardFileFinder < FileFinder
+    def self.find(dir)
+      Dir[File.join(dir, "**", "*")].select { |f| File.file? f }
+    end
+  end
+
+  class StandardWithHiddenFileFinder < FileFinder
+    def self.find(dir)
+      Dir.glob(File.join(dir, "**", "*"), File::FNM_DOTMATCH).select { |f| File.file? f }
+    end
+  end
+
   # Represents the state of a bag on a filesystem
   class Bag
     attr_reader :bag_dir
+    attr_reader :detect_hidden
 
     include Validity # Validity functionality
     include Info # bagit & bag info functionality
@@ -18,8 +37,11 @@ module BagIt
     include Fetch # fetch related functionality
 
     # Make a new Bag based at path
-    def initialize(path, info = {}, _create = false)
+    def initialize(path, info = {}, _create = false, detect_hidden = false)
       @bag_dir = path
+      @detect_hidden = detect_hidden
+      @file_finder = @detect_hidden ? StandardWithHiddenFileFinder : StandardFileFinder
+
       # make the dir structure if it doesn't exist
       FileUtils.mkdir bag_dir unless File.directory? bag_dir
       FileUtils.mkdir data_dir unless File.directory? data_dir
@@ -37,7 +59,7 @@ module BagIt
 
     # Return the paths to each bag file relative to bag_dir
     def bag_files
-      Dir[File.join(data_dir, "**", "*")].select { |f| File.file? f }
+      @file_finder.find(data_dir)
     end
 
     # Return the paths to each tag file relative to bag_dir

data/lib/bagit/valid.rb

@@ -33,7 +33,11 @@ module BagIt
 
       empty_manifests.each do |file|
         logger.error("#{file} is manifested but not present".red)
-        errors.add :completeness, "#{file} is manifested but not present"
+        error_message = "#{file} is manifested but not present"
+        if !detect_hidden && file.start_with?(File.join("data", "."))
+          error_message += "; consider turning on hidden file detection"
+        end
+        errors.add :completeness, error_message
       end
       tag_empty_manifests.each do |file|
         logger.error("#{file} is a manifested tag but not present".red)

data/lib/bagit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BagIt
-  VERSION = "0.4.6"
+  VERSION = "0.5.0"
 end

data/spec/bagit_spec.rb

@@ -165,4 +165,31 @@ RSpec.describe BagIt::Bag do
       end
     end
   end
+
+  describe "bag with hidden files" do
+    before do
+      @sandbox = Sandbox.new
+
+      # make the bag
+      @bag_path = File.join @sandbox.to_s, "the_bag"
+      @bag = described_class.new @bag_path, {}, false, true
+
+      # add some files
+      @bag.add_file(".keep") { |io| io.puts "" }
+      @bag.add_file("test.txt") { |io| io.puts "testing testing" }
+    end
+
+    after do
+      @sandbox.cleanup!
+    end
+
+    describe "#bag_files" do
+      it "returns an array including non-hidden and hidden files" do
+        files = @bag.bag_files.map { |f| f.sub(File.join(@bag_path, "data", ""), "") }
+        expect(files).to be_a_kind_of(Array)
+        expect(files).not_to be_empty
+        expect(files).to eq([".keep", "test.txt"])
+      end
+    end
+  end
 end

data/spec/validation_spec.rb

@@ -44,13 +44,17 @@ describe BagIt::Bag do
 
     it "is invalid if there are files that are in the manifest but not in the bag" do
       # add a file and then remove it through the back door
-      @bag.add_file("file-k") { |io| io.puts "time to go" }
+      file_name = "file-k"
+      @bag.add_file(file_name) { |io| io.puts "time to go" }
       @bag.manifest!
 
-      FileUtils.rm File.join(@bag.bag_dir, "data", "file-k")
+      FileUtils.rm File.join(@bag.bag_dir, "data", file_name)
 
       @bag.validate_only("true_for/completeness")
       expect(@bag.errors.on(:completeness)).not_to be_empty
+      expect(@bag.errors.on(:completeness)).to include(
+        "#{File.join("data", file_name)} is manifested but not present"
+      )
       expect(@bag).not_to be_valid
     end
 
@@ -139,4 +143,63 @@ describe BagIt::Bag do
       end
     end
   end
+
+  describe "a bag with unmanifested hidden files" do
+    before do
+      @sandbox = Sandbox.new
+
+      # make a bag with hidden files not manifested
+      @source_bag_path = File.join @sandbox.to_s, "the_bag"
+      @source_bag = described_class.new @source_bag_path, {}, false, false
+      @source_bag.add_file(".keep") { |io| io.puts "" }
+      @source_bag.add_file("test.txt") { |io| io.puts "testing testing" }
+      @source_bag.manifest!
+    end
+
+    after do
+      @sandbox.cleanup!
+    end
+
+    it "fails validation when hidden file detection is on" do
+      @aware_bag = described_class.new @source_bag_path, {}, false, true
+      expect(@aware_bag).to_not be_valid
+      expect(@aware_bag.errors.on(:completeness)).not_to be_empty
+    end
+
+    it "passes validation when hidden file detection is off" do
+      @unaware_bag = described_class.new @source_bag_path, {}, false, false
+      expect(@unaware_bag).to be_valid
+    end
+  end
+
+  describe "a bag with manifested hidden files" do
+    before do
+      @sandbox = Sandbox.new
+
+      # make a bag with hidden files manifested
+      @source_bag_path = File.join @sandbox.to_s, "the_bag"
+      @source_bag = described_class.new @source_bag_path, {}, false, true
+      @source_bag.add_file(".keep") { |io| io.puts "" }
+      @source_bag.add_file("test.txt") { |io| io.puts "testing testing" }
+      @source_bag.manifest!
+    end
+
+    after do
+      @sandbox.cleanup!
+    end
+
+    it "passes validation when hidden file detection is on" do
+      @aware_bag = described_class.new @source_bag_path, {}, false, true
+      expect(@aware_bag).to be_valid
+    end
+
+    it "fails validation when hidden file detection is off, with suggested fix offered" do
+      @unaware_bag = described_class.new @source_bag_path, {}, false, false
+      expect(@unaware_bag).to_not be_valid
+      expect(@unaware_bag.errors.on(:completeness)).not_to be_empty
+      expect(@unaware_bag.errors.on(:completeness)).to include(
+        "data/.keep is manifested but not present; consider turning on hidden file detection"
+      )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bagit
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Tom Johnson, Francesco Lazzarino, Jamie Little
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validatable
@@ -184,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.3'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="