bagit 0.4.3 → 0.4.5

data/lib/bagit/valid.rb

@@ -1,7 +1,9 @@
-require 'validatable'
-require 'open-uri'
-require 'cgi'
-require 'logger'
+# frozen_string_literal: true
+
+require "validatable"
+require "open-uri"
+require "cgi"
+require "logger"
 
 module BagIt
   class Bag
@@ -12,8 +14,8 @@ module BagIt
 
   module Validity
     def decode_filename(s)
-      s = s.gsub('%0D', "\r")
-      s = s.gsub('%0A', "\n")
+      s = s.gsub("%0D", "\r")
+      s = s.gsub("%0A", "\n")
       s
     end
 
@@ -88,52 +90,52 @@ module BagIt
 
     protected
 
-      # Returns all files in the instance that are not manifested
-      def unmanifested_files
-        mfs = manifested_files.map { |f| File.join bag_dir, f }
-        bag_files.reject { |f| mfs.member? f }
-      end
+    # Returns all files in the instance that are not manifested
+    def unmanifested_files
+      mfs = manifested_files.map { |f| File.join bag_dir, f }
+      bag_files.reject { |f| mfs.member? f }
+    end
 
-      # Returns a list of manifested files that are not present
-      def empty_manifests
-        bfs = bag_files
-        manifested_files.reject { |f| bfs.member? File.join(bag_dir, f) }
-      end
+    # Returns a list of manifested files that are not present
+    def empty_manifests
+      bfs = bag_files
+      manifested_files.reject { |f| bfs.member? File.join(bag_dir, f) }
+    end
 
-      # Returns a list of tag manifested files that are not present
-      def tag_empty_manifests
-        empty = []
-        tag_manifested_files.each do |f|
-          empty.push f unless File.exist?(File.join(bag_dir, f))
-        end
-        empty
+    # Returns a list of tag manifested files that are not present
+    def tag_empty_manifests
+      empty = []
+      tag_manifested_files.each do |f|
+        empty.push f unless File.exist?(File.join(bag_dir, f))
       end
+      empty
+    end
 
-      # Returns a list of all files present in the manifest files
-      def manifested_files
-        manifest_files.inject([]) do |acc, mf|
-          files = File.open(mf) do |io|
-            io.readlines.map do |line|
-              _digest, path = line.chomp.split(/\s+/, 2)
-              decode_filename(path)
-            end
+    # Returns a list of all files present in the manifest files
+    def manifested_files
+      manifest_files.inject([]) do |acc, mf|
+        files = File.open(mf) { |io|
+          io.readlines.map do |line|
+            _digest, path = line.chomp.split(/\s+/, 2)
+            decode_filename(path)
           end
+        }
 
-          (acc + files).uniq
-        end
+        (acc + files).uniq
       end
+    end
 
-      # Returns a list of all files in the tag manifest files
-      def tag_manifested_files
-        tagmanifest_files.inject([]) do |acc, mf|
-          files = File.open(mf) do |io|
-            io.readlines.map do |line|
-              _digest, path = line.chomp.split(/\s+/, 2)
-              path
-            end
+    # Returns a list of all files in the tag manifest files
+    def tag_manifested_files
+      tagmanifest_files.inject([]) do |acc, mf|
+        files = File.open(mf) { |io|
+          io.readlines.map do |line|
+            _digest, path = line.chomp.split(/\s+/, 2)
+            path
           end
-          (acc + files).uniq
-        end
+        }
+        (acc + files).uniq
       end
+    end
   end
 end

data/lib/bagit/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BagIt
-  VERSION = "0.4.3".freeze
+  VERSION = "0.4.5"
 end

data/lib/bagit.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 # == About bagit.rb
 # Author::    Francesco Lazzarino  (mailto:flazzarino@gmail.com)
 # Functionality conforms to the BagIt Spec v0.96:
 # http://www.cdlib.org/inside/diglib/bagit/bagitspec.html
 
-require 'bagit/bag'
-require 'bagit/version'
-require 'fileutils'
-require 'date'
-require 'logger'
+require "bagit/bag"
+require "bagit/version"
+require "fileutils"
+require "date"
+require "logger"
 module BagIt
   # The version of the BagIt specification the code is conforming to.
-  SPEC_VERSION = '0.97'.freeze
+  SPEC_VERSION = "0.97"
 end

data/spec/bagit_spec.rb

@@ -1,13 +1,14 @@
-# coding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 # based on v0.96 http://www.cdlib.org/inside/diglib/bagit/bagitspec.html
 RSpec.describe BagIt::Bag do
-  describe 'empty bag' do
+  describe "empty bag" do
     before do
       @sandbox = Sandbox.new
       # make the bag
-      @bag_path = File.join @sandbox.to_s, 'the_bag'
+      @bag_path = File.join @sandbox.to_s, "the_bag"
       @bag = described_class.new @bag_path
     end
 
@@ -20,16 +21,16 @@ RSpec.describe BagIt::Bag do
     end
   end
 
-  describe 'bag with files' do
+  describe "bag with files" do
     before do
       @sandbox = Sandbox.new
 
       # make the bag
-      @bag_path = File.join @sandbox.to_s, 'the_bag'
+      @bag_path = File.join @sandbox.to_s, "the_bag"
       @bag = described_class.new @bag_path
 
       # add some files
-      File.open('/dev/urandom') do |rio|
+      File.open("/dev/urandom") do |rio|
         10.times do |n|
           @bag.add_file("file-#{n}-💩
 ") { |io| io.write rio.read(16) }
@@ -50,39 +51,39 @@ RSpec.describe BagIt::Bag do
     end
 
     it "has a sub-directory called data" do
-      data_path = File.join @bag_path, 'data'
+      data_path = File.join @bag_path, "data"
       expect(File.directory?(data_path)).to be true
     end
 
     describe "#add_file" do
       it "allows addition of files via io" do
-        @bag.add_file("foo") { |io| io.puts 'all alone' }
+        @bag.add_file("foo") { |io| io.puts "all alone" }
         expect(File.join(@bag_path, "data", "foo")).to exist_on_fs
       end
 
       it "allows addition of files via copy" do
-        src_path = File.join @sandbox.to_s, 'somefile'
-        File.open(src_path, 'w') { |io| io.puts "something" }
-        @bag.add_file("foo", src_path) { |io| io.puts 'all alone' }
+        src_path = File.join @sandbox.to_s, "somefile"
+        File.open(src_path, "w") { |io| io.puts "something" }
+        @bag.add_file("foo", src_path) { |io| io.puts "all alone" }
         expect(File.join(@bag_path, "data", "foo")).to exist_on_fs
       end
 
       it "allows addition of files with deep paths" do
-        @bag.add_file("deep/dir/structure/file") { |io| io.puts 'all alone' }
+        @bag.add_file("deep/dir/structure/file") { |io| io.puts "all alone" }
         expect(File.join(@bag_path, "data", "deep/dir/structure/file")).to exist_on_fs
       end
 
       it "does not allow overwriting of files" do
-        expect do
+        expect {
           @bag.add_file("file-0-💩
-") { |io| io.puts 'overwrite!' }
-        end.to raise_error(RuntimeError)
+") { |io| io.puts "overwrite!" }
+        }.to raise_error(RuntimeError)
       end
 
       it "updates the payload oxum" do
-        oxum_count = @bag.bag_info["Payload-Oxum"].split('.')[1].to_i
-        @bag.add_file("foo") { |io| io.puts 'all alone' }
-        expect(@bag.bag_info["Payload-Oxum"].split('.')[1].to_i).to eq(oxum_count + 1)
+        oxum_count = @bag.bag_info["Payload-Oxum"].split(".")[1].to_i
+        @bag.add_file("foo") { |io| io.puts "all alone" }
+        expect(@bag.bag_info["Payload-Oxum"].split(".")[1].to_i).to eq(oxum_count + 1)
       end
     end
 
@@ -95,14 +96,14 @@ RSpec.describe BagIt::Bag do
     describe "#get" do
       describe "file not in bag" do
         it "returns nil" do
-          expect(@bag.get('foobar')).to be_nil
+          expect(@bag.get("foobar")).to be_nil
         end
       end
 
       describe "file in bag" do
         before do
-          @contents = 'all alone'
-          @bag.add_file("foo") { |io| io << 'all alone' }
+          @contents = "all alone"
+          @bag.add_file("foo") { |io| io << "all alone" }
           @file = @bag.get("foo")
         end
 
@@ -135,10 +136,10 @@ RSpec.describe BagIt::Bag do
       end
 
       it "returns relative paths to all files in the data directory" do
-        expect(@paths).to match_array((0..9).collect do |x|
+        expect(@paths).to match_array((0..9).collect { |x|
                                         "file-#{x}-💩
 "
-                                      end)
+                                      })
       end
     end
 
@@ -148,19 +149,19 @@ RSpec.describe BagIt::Bag do
       end
 
       it "accurately specifys the number of payload files" do
-        @bag.add_tag_file('non-payload') { |f| f.puts "I shouldn't count in the oxum" }
-        @bag.payload_oxum.split('.')[1] == @bag.bag_files.count
+        @bag.add_tag_file("non-payload") { |f| f.puts "I shouldn't count in the oxum" }
+        @bag.payload_oxum.split(".")[1] == @bag.bag_files.count
       end
     end
 
     describe "#gc!" do
       it "cleans up empty directories" do
         f = File.join "1", "2", "3", "file"
-        @bag.add_file(f) { |io| io.puts 'all alone' }
+        @bag.add_file(f) { |io| io.puts "all alone" }
         @bag.remove_file f
-        expect(File.exist?(File.dirname(File.join(@bag_path, 'data', f)))).to be true
+        expect(File.exist?(File.dirname(File.join(@bag_path, "data", f)))).to be true
         @bag.gc!
-        expect(File.exist?(File.dirname(File.join(@bag_path, 'data', f)))).to be false
+        expect(File.exist?(File.dirname(File.join(@bag_path, "data", f)))).to be false
       end
     end
   end

data/spec/fetch_spec.rb

@@ -1,15 +1,16 @@
-# coding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe BagIt::Bag do
   before do
     @sandbox = Sandbox.new
     # make the bag
-    @bag_path = File.join @sandbox.to_s, 'the_bag'
+    @bag_path = File.join @sandbox.to_s, "the_bag"
     @bag = described_class.new(@bag_path)
 
     # add some files
-    File.open('/dev/urandom') do |rio|
+    File.open("/dev/urandom") do |rio|
       10.times do |n|
         @bag.add_file("file-#{n}-💩
       end
@@ -21,11 +22,11 @@ describe BagIt::Bag do
     end
 
     before do
-      @bag.add_remote_file('http://www.gnu.org/graphics/heckert_gnu.small.png', 'gnu.png', 6322,
-                           '390c0a30976f899cbdf951eab5cce60fe9743ac9',
-                           'a3bd7ab2442028bb91b51d9f6722ec98')
+      @bag.add_remote_file("http://www.gnu.org/graphics/heckert_gnu.small.png", "gnu.png", 6322,
+        "390c0a30976f899cbdf951eab5cce60fe9743ac9",
+        "a3bd7ab2442028bb91b51d9f6722ec98")
 
-      path = File.join @bag_path, 'fetch.txt'
+      path = File.join @bag_path, "fetch.txt"
       @lines = File.open(path, &:readlines)
     end
 
@@ -34,18 +35,18 @@ describe BagIt::Bag do
     end
 
     it "only contains lines of the format URL LENGTH FILENAME" do
-      @lines.each { |line| expect(line.chomp).to match(/^[^\s]+\s+(\d+|\-)\s+[^\s]+$/) }
+      @lines.each { |line| expect(line.chomp).to match(/^[^\s]+\s+(\d+|-)\s+[^\s]+$/) }
     end
 
     it "contains manifested files" do
-      path = File.join @bag_path, 'manifest-sha1.txt'
+      path = File.join @bag_path, "manifest-sha1.txt"
       data = File.open(path, &:read)
-      expect(data).to include('gnu.png')
+      expect(data).to include("gnu.png")
     end
 
     it "is gone when fetch is complete" do
       @bag.fetch!
-      expect(File.exist?(File.join(@bag_path, 'fetch.txt'))).not_to be true
+      expect(File.exist?(File.join(@bag_path, "fetch.txt"))).not_to be true
     end
   end
 end

data/spec/manifest_spec.rb

@@ -1,5 +1,6 @@
-# coding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe BagIt::Bag do
   describe "BagIt Manifests" do
@@ -7,13 +8,14 @@ describe BagIt::Bag do
       @sandbox = Sandbox.new
 
       # make the bag
-      @bag_path = File.join @sandbox.to_s, 'the_bag'
+      @bag_path = File.join @sandbox.to_s, "the_bag"
       @bag = described_class.new @bag_path
 
       # add some files
-      File.open('/dev/urandom') do |rio|
+      File.open("/dev/urandom") do |rio|
         10.times do |n|
-          @bag.add_file("file-#{n}-💩
+          @bag.add_file("file-#{n}-💩
+") { |io| io.write rio.read(16) }
           @bag.add_tag_file("tag-#{n}") { |io| io.write rio.read(16) }
         end
       end
@@ -25,13 +27,16 @@ describe BagIt::Bag do
 
     shared_examples_for "a manifest file" do
       before do
-        pattern = File.join @bag_path, '*manifest-*.txt'
+        pattern = File.join @bag_path, "*manifest-*.txt"
         @manifest_files = Dir.glob pattern
       end
 
       it "has a valid algorithm in the name (at least md5 or sha1)" do
-        algorithms = @manifest_files.map { |mf| mf =~ /manifest-(.*).txt$/; Regexp.last_match(1) }
-        algorithms.each { |a| expect(a).to be_in('md5', 'sha1') }
+        algorithms = @manifest_files.map { |mf|
+          mf =~ /manifest-(.*).txt$/
+          Regexp.last_match(1)
+        }
+        algorithms.each { |a| expect(a).to be_in("md5", "sha1") }
       end
 
       it "is not an empty file" do
@@ -47,7 +52,7 @@ describe BagIt::Bag do
       end
 
       it "validates after adding a file and remanifesting" do
-        @bag.add_file('newfile.txt') { |io| io.puts("new file to remanifest") }
+        @bag.add_file("newfile.txt") { |io| io.puts("new file to remanifest") }
         @bag.manifest!
         expect(@bag).to be_valid
       end

data/spec/spec_helper.rb

@@ -1,25 +1,27 @@
-require 'rubygems'
-require 'bundler'
-require 'coveralls'
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+require "coveralls"
 
 Bundler.require(:default, :test)
 
 Coveralls.wear!
 
-require File.expand_path('./util/bagit_matchers', File.dirname(__FILE__))
+require File.expand_path("./util/bagit_matchers", File.dirname(__FILE__))
 
 RSpec.configure do |config|
   config.include(BagitMatchers)
 end
 
-$LOAD_PATH.unshift File.expand_path('../lib', File.dirname(__FILE__))
-require 'bagit'
+$LOAD_PATH.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require "bagit"
 
-require 'tempfile'
+require "tempfile"
 
 class Sandbox
   def initialize
-    tf = Tempfile.open 'sandbox'
+    tf = Tempfile.open "sandbox"
     @path = tf.path
     tf.close!
     FileUtils.mkdir @path

data/spec/tag_info_spec.rb

@@ -1,5 +1,6 @@
-# coding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe BagIt::Bag do
   describe "Tag Info Files" do
@@ -7,11 +8,11 @@ describe BagIt::Bag do
       @sandbox = Sandbox.new
 
       # make the bag
-      @bag_path = File.join @sandbox.to_s, 'the_bag'
+      @bag_path = File.join @sandbox.to_s, "the_bag"
       @bag = described_class.new @bag_path
 
       # add some files
-      File.open('/dev/urandom') do |rio|
+      File.open("/dev/urandom") do |rio|
         10.times do |n|
           @bag.add_file("file-#{n}-💩
         end
@@ -24,12 +25,12 @@ describe BagIt::Bag do
 
     describe "bagit.txt" do
       before do
-        path = File.join @bag_path, 'bagit.txt'
+        path = File.join @bag_path, "bagit.txt"
         @lines = File.open(path, &:readlines)
       end
 
       it "creates a file bagit.txt on bag initialization" do
-        expect(File.join(@bag_path, 'bagit.txt')).to exist_on_fs
+        expect(File.join(@bag_path, "bagit.txt")).to exist_on_fs
       end
 
       it "has exactly two lines" do
@@ -49,7 +50,7 @@ describe BagIt::Bag do
 
     describe "bag-info.txt" do
       before do
-        path = File.join @bag_path, 'bag-info.txt'
+        path = File.join @bag_path, "bag-info.txt"
         @lines = File.open(path, &:readlines)
       end
 
@@ -62,20 +63,20 @@ describe BagIt::Bag do
       end
 
       it "is case insensitive with respect to LABELs" do
-        expect { @bag.write_bag_info 'foo' => 'lowercase', 'Foo' => 'capital' }.to raise_error(/Multiple labels/)
+        expect { @bag.write_bag_info "foo" => "lowercase", "Foo" => "capital" }.to raise_error(/Multiple labels/)
       end
 
       it "folds long VALUEs" do
-        longline = <<LOREM
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
-  eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enimad
-  minim veniam, quis nostrud exercitation ullamco laboris nisi ut
-  aliquip ex ea commodo consequat. Duis aute irure dolor in
-  reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
-  pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
-  culpa qui officia deserunt mollit anim id est laborum.
-LOREM
-        @bag.write_bag_info 'Lorem' => longline
+        longline = <<~LOREM
+          Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+            eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enimad
+            minim veniam, quis nostrud exercitation ullamco laboris nisi ut
+            aliquip ex ea commodo consequat. Duis aute irure dolor in
+            reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+            pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+            culpa qui officia deserunt mollit anim id est laborum.
+        LOREM
+        @bag.write_bag_info "Lorem" => longline
         expect(@bag.bag_info.keys.length).to eq(4) # this isn't a great test. Changed it from 1 to 4 because unrelated changes caused failure.
       end
 
@@ -92,10 +93,10 @@ LOREM
         expect(@bag.bag_info.keys).to include("Payload-Oxum")
       end
       it "does not override any previous values" do
-        path = File.join @bag_path, 'bag-info.txt'
-        @bag.write_bag_info 'Bag-Software-Agent' => 'Some Other Agent'
-        @bag.write_bag_info 'Source-Organization' => 'Awesome Inc.'
-        @bag.write_bag_info 'Bagging-Date' => '1901-01-01'
+        path = File.join @bag_path, "bag-info.txt"
+        @bag.write_bag_info "Bag-Software-Agent" => "Some Other Agent"
+        @bag.write_bag_info "Source-Organization" => "Awesome Inc."
+        @bag.write_bag_info "Bagging-Date" => "1901-01-01"
         @bag.write_bag_info
         contents = File.open(path).read
         expect(contents).to include "Some Other Agent"
@@ -103,19 +104,19 @@ LOREM
         expect(contents).to include "1901-01-01"
       end
       it "overrides previous tags when they collide with new ones" do
-        path = File.join @bag_path, 'bag-info.txt'
-        @bag.write_bag_info 'Source-Organization' => 'Awesome Inc.'
-        @bag.write_bag_info 'Source-Organization' => 'Awesome LLC.'
+        path = File.join @bag_path, "bag-info.txt"
+        @bag.write_bag_info "Source-Organization" => "Awesome Inc."
+        @bag.write_bag_info "Source-Organization" => "Awesome LLC."
         contents = File.open(path).read
         expect(contents).to include "Awesome LLC."
         expect(contents).not_to include "Awesome Inc."
       end
       it "contains values passed to bag" do
-        hash = { "Bag-Software-Agent" => "rspec",
-                 "Bagging-Date" => "2012-11-21",
-                 "Contact-Name" => "Willis Corto",
-                 "Some-Tag" => "Some Value" }
-        bag_with_info = described_class.new(@bag_path + '2', hash)
+        hash = {"Bag-Software-Agent" => "rspec",
+                "Bagging-Date" => "2012-11-21",
+                "Contact-Name" => "Willis Corto",
+                "Some-Tag" => "Some Value"}
+        bag_with_info = described_class.new(@bag_path + "2", hash)
         hash.each do |key, value|
           expect(bag_with_info.bag_info[key]).to eq(value)
         end

data/spec/tag_spec.rb

@@ -1,5 +1,6 @@
-# coding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe BagIt::Bag do
   describe "Tag Specs" do
@@ -7,11 +8,11 @@ describe BagIt::Bag do
       @sandbox = Sandbox.new
 
       # make the bag
-      @bag_path = File.join @sandbox.to_s, 'the_bag'
+      @bag_path = File.join @sandbox.to_s, "the_bag"
       @bag = described_class.new(@bag_path)
 
       # add some files
-      File.open('/dev/urandom') do |rio|
+      File.open("/dev/urandom") do |rio|
         10.times do |n|
           @bag.add_file("file-#{n}-💩
           @bag.add_tag_file("tag-#{n}") { |io| io.write rio.read(16) }
@@ -24,11 +25,11 @@ describe BagIt::Bag do
     end
     describe "#add_tag_file" do
       it "allows addition of tag files via io" do
-        @bag.add_tag_file("foo") { |io| io.puts 'all alone' }
+        @bag.add_tag_file("foo") { |io| io.puts "all alone" }
         expect(File.join(@bag_path, "foo")).to exist_on_fs
       end
       it "allows addition of bag files within directories using io" do
-        @bag.add_tag_file("fedora/foo") { |io| io.puts 'all alone' }
+        @bag.add_tag_file("fedora/foo") { |io| io.puts "all alone" }
         expect(File.join(@bag_path, "fedora", "foo")).to exist_on_fs
       end
       it "allows addition of deep tag files" do
@@ -36,12 +37,12 @@ describe BagIt::Bag do
         expect(File.join(@bag_path, "fedora", "foo", "newfoo", "deep")).to exist_on_fs
       end
       it "does not allow overwriting of tag files" do
-        expect { @bag.add_tag_file("tag-0") { |io| io.puts 'overwrite!' } }.to raise_error(RuntimeError)
+        expect { @bag.add_tag_file("tag-0") { |io| io.puts "overwrite!" } }.to raise_error(RuntimeError)
       end
       it "allows addition of tag files via copy" do
-        src_path = File.join @sandbox.to_s, 'somefile'
-        File.open(src_path, 'w') { |io| io.puts "something" }
-        @bag.add_tag_file("foo", src_path) { |io| io.puts 'all alone' }
+        src_path = File.join @sandbox.to_s, "somefile"
+        File.open(src_path, "w") { |io| io.puts "something" }
+        @bag.add_tag_file("foo", src_path) { |io| io.puts "all alone" }
         expect(File.join(@bag_path, "foo")).to exist_on_fs
       end
     end

data/spec/util/bagit_matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BagitMatchers
   class BeIn
     def initialize(*expected_collection)