bagit 0.4.3 → 0.4.4

data/lib/bagit/manifest.rb

@@ -1,21 +1,23 @@
-require 'pathname'
-require 'digest/sha1'
-require 'digest/md5'
+# frozen_string_literal: true
+
+require "pathname"
+require "digest/sha1"
+require "digest/md5"
 
 module BagIt
   # Requires response to bag_dir, tag_files, bag_files
   module Manifest
     def encode_filename(s)
-      s = s.gsub(/\r/, '%0D')
-      s = s.gsub(/\n/, '%0A')
+      s = s.gsub(/\r/, "%0D")
+      s = s.gsub(/\n/, "%0A")
       s
     end
 
     # All tag files that are bag manifest files (manifest-[algorithm].txt)
     def manifest_files
-      files = Dir[File.join(@bag_dir, '*')].select do |f|
+      files = Dir[File.join(@bag_dir, "*")].select { |f|
         File.file?(f) && File.basename(f) =~ /^manifest-.*.txt$/
-      end
+      }
       files
     end
 
@@ -25,7 +27,7 @@ module BagIt
     end
 
     # Generate manifest files for all the bag files
-    def manifest!(algo: 'default')
+    def manifest!(algo: "default")
       # nuke all the existing manifest files
       manifest_files.each { |f| FileUtils.rm f }
 
@@ -40,15 +42,15 @@ module BagIt
 
     def write_checksum(checksum_algo:, relative_path:, file:)
       case checksum_algo
-      when 'sha1'
+      when "sha1"
         write_sha1(file, relative_path)
-      when 'md5'
+      when "md5"
         write_md5(file, relative_path)
-      when 'sha256'
+      when "sha256"
         write_sha256(file, relative_path)
-      when 'sha512'
+      when "sha512"
         write_sha256(file, relative_path)
-      when 'default'
+      when "default"
         write_sha1(file, relative_path)
         write_md5(file, relative_path)
       end
@@ -56,29 +58,29 @@ module BagIt
 
     def write_sha1(f, rel_path)
       sha1 = Digest::SHA1.file f
-      File.open(manifest_file(:sha1), 'a') { |io| io.puts "#{sha1} #{rel_path}" }
+      File.open(manifest_file(:sha1), "a") { |io| io.puts "#{sha1} #{rel_path}" }
     end
 
     def write_md5(f, rel_path)
       md5 = Digest::MD5.file f
-      File.open(manifest_file(:md5), 'a') { |io| io.puts "#{md5} #{rel_path}" }
+      File.open(manifest_file(:md5), "a") { |io| io.puts "#{md5} #{rel_path}" }
     end
 
     def write_sha256(f, rel_path)
       sha256 = Digest::SHA256.file f
-      File.open(manifest_file(:sha256), 'a') { |io| io.puts "#{sha256} #{rel_path}" }
+      File.open(manifest_file(:sha256), "a") { |io| io.puts "#{sha256} #{rel_path}" }
     end
 
     def write_sha512(f, rel_path)
       sha512 = Digest::SHA512.file f
-      File.open(manifest_file(:sha512), 'a') { |io| io.puts "#{sha512} #{rel_path}" }
+      File.open(manifest_file(:sha512), "a") { |io| io.puts "#{sha512} #{rel_path}" }
     end
 
     # All tag files that are bag manifest files (tagmanifest-[algorithm].txt)
     def tagmanifest_files
-      files = Dir[File.join(@bag_dir, '*')].select do |f|
+      files = Dir[File.join(@bag_dir, "*")].select { |f|
         File.file?(f) && File.basename(f) =~ /^tagmanifest-.*.txt$/
-      end
+      }
       files
     end
 
@@ -120,7 +122,7 @@ module BagIt
 
         # write file
         if src_path.nil?
-          File.open(f, 'w') { |io| yield io }
+          File.open(f, "w") { |io| yield io }
         else
           FileUtils.cp src_path, f
         end
@@ -137,11 +139,11 @@ module BagIt
 
       # sha1
       sha1 = Digest::SHA1.hexdigest data
-      File.open(tagmanifest_file(:sha1), 'a') { |io| io.puts "#{sha1} #{rel_path}" }
+      File.open(tagmanifest_file(:sha1), "a") { |io| io.puts "#{sha1} #{rel_path}" }
 
       # md5
       md5 = Digest::MD5.hexdigest data
-      File.open(tagmanifest_file(:md5), 'a') { |io| io.puts "#{md5} #{rel_path}" }
+      File.open(tagmanifest_file(:md5), "a") { |io| io.puts "#{md5} #{rel_path}" }
       tag_files
     end
 
@@ -173,7 +175,7 @@ module BagIt
                  Digest::MD5
                else
                  :unknown
-               end
+        end
 
         # check it, an unknown algorithm is always true
         if algo == :unknown

data/lib/bagit/string.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # Some mixed in functionality for String
 class String
   # Wrap a string to lines of a specified width. All existing newlines
   # are not guaranteed to be preserved
   def wrap(width)
-    s = gsub(/\s+/, ' ').strip
+    s = gsub(/\s+/, " ").strip
 
     if s.length > width
       s[0...width] + '\n' + s[width..-1].wrap(width)
@@ -14,7 +16,7 @@ class String
 
   # Indent each line of a string by n spaces
   def indent(n)
-    indent = ' ' * n
+    indent = " " * n
     gsub '\n', "\n#{indent}"
   end
 

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.4"
 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