bagit 0.3.5 → 0.4.4

data/lib/bagit/string.rb

@@ -1,27 +1,27 @@
+# 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)
     else
       s
     end
-
   end
 
   # Indent each line of a string by n spaces
   def indent(n)
-    indent = ' ' * n
+    indent = " " * n
     gsub '\n', "\n#{indent}"
   end
 
-# Colorize logs
- def color(color_code)
+  # Colorize logs
+  def color(color_code)
     "\e[#{color_code}m#{self}\e[0m"
   end
 

data/lib/bagit/valid.rb

@@ -1,32 +1,31 @@
-require 'validatable'
-require 'open-uri'
-require 'cgi'
-require 'logger'
+# frozen_string_literal: true
 
-module BagIt
+require "validatable"
+require "open-uri"
+require "cgi"
+require "logger"
 
+module BagIt
   class Bag
     include Validatable
-    validates_true_for :consistency, :logic => Proc.new { consistent? }
-    validates_true_for :completeness, :logic => Proc.new { complete? }
+    validates_true_for :consistency, logic: proc { consistent? }
+    validates_true_for :completeness, logic: proc { complete? }
   end
 
   module Validity
     def decode_filename(s)
-      s = s.gsub('%0D',"\r")
-      s = s.gsub('%0A',"\n")
-      return s
+      s = s.gsub("%0D", "\r")
+      s = s.gsub("%0A", "\n")
+      s
     end
-    
+
     # Return true if the manifest cover all files and all files are
     # covered.
     def complete?
       logger = Logger.new(STDOUT)
 
-      if manifest_files == []
-        errors.add  :completeness, "there are no manifest files"
-      end
-      
+      errors.add :completeness, "there are no manifest files" if manifest_files == []
+
       unmanifested_files.each do |file|
         logger.error("#{file} is present but not manifested".red)
         errors.add :completeness, "#{file} is present but not manifested"
@@ -44,38 +43,39 @@ module BagIt
       errors.on(:completeness).nil?
     end
 
+    def manifest_type(type)
+      case type
+      when /sha1/i
+        Digest::SHA1
+      when /md5/i
+        Digest::MD5
+      when /sha256/i
+        Digest::SHA256
+      when /sha384/i
+        Digest::SHA384
+      when /sha512/i
+        Digest::SHA512
+      else
+        raise ArgumentError, "Algorithm #{manifest_type} is not supported."
+      end
+    end
+
     # Return true if all manifested files message digests match.
     def consistent?
-      (manifest_files|tagmanifest_files).each do |mf|
+      (manifest_files | tagmanifest_files).each do |mf|
         # get the algorithm implementation
         File.basename(mf) =~ /manifest-(.+).txt$/
-        manifest_type = $1
-        algo = case manifest_type
-               when /sha1/i
-                 Digest::SHA1
-               when /md5/i
-                 Digest::MD5
-               when /sha256/i
-                 Digest::SHA256
-               when /sha384/i
-                 Digest::SHA384
-               when /sha512/i
-                 Digest::SHA512
-               else
-                 raise ArgumentError.new("Algorithm #{manifest_type} is not supported.")
-               end
+        type = Regexp.last_match(1)
+        algo = manifest_type(type)
         # Check every file in the manifest
         File.open(mf) do |io|
           io.each_line do |line|
-            expected, path = line.chomp.split /\s+/, 2
+            expected, path = line.chomp.split(/\s+/, 2)
             file = File.join(bag_dir, decode_filename(path))
 
-            if File.exist? file
-              actual = algo.file(file).hexdigest
-              if expected.downcase != actual         
-                errors.add :consistency, "expected #{file} to have #{algo}: #{expected}, actual is #{actual}"
-              end
-            end
+            next unless File.exist? file
+            actual = algo.file(file).hexdigest
+            errors.add :consistency, "expected #{file} to have #{algo}: #{expected}, actual is #{actual}" if expected.downcase != actual
           end
         end
       end
@@ -89,7 +89,7 @@ module BagIt
     end
 
     protected
-    
+
     # Returns all files in the instance that are not manifested
     def unmanifested_files
       mfs = manifested_files.map { |f| File.join bag_dir, f }
@@ -101,47 +101,41 @@ module BagIt
       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|
-        if !File.exists?(File.join(bag_dir,f))
-          empty.push f
-        end
+        empty.push f unless File.exist?(File.join(bag_dir, f))
       end
-      return empty
+      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|
-
+        files = File.open(mf) { |io|
           io.readlines.map do |line|
-            digest, path = line.chomp.split /\s+/, 2
+            _digest, path = line.chomp.split(/\s+/, 2)
             decode_filename(path)
           end
-
-        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|
+        files = File.open(mf) { |io|
           io.readlines.map do |line|
-            digest, path = line.chomp.split /\s+/, 2
+            _digest, path = line.chomp.split(/\s+/, 2)
             path
           end
-        end
-        (acc+files).uniq
+        }
+        (acc + files).uniq
       end
     end
-
   end
-
 end

data/lib/bagit/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BagIt
-  VERSION = "0.3.5"
+  VERSION = "0.4.4"
 end

data/spec/bagit_spec.rb

@@ -1,35 +1,36 @@
-# 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
-describe BagIt::Bag do
-  describe 'empty bag' do
-    before(:each) do
+RSpec.describe BagIt::Bag do
+  describe "empty bag" do
+    before do
       @sandbox = Sandbox.new
       # make the bag
-      @bag_path = File.join @sandbox.to_s, 'the_bag'
-      @bag = BagIt::Bag.new @bag_path
+      @bag_path = File.join @sandbox.to_s, "the_bag"
+      @bag = described_class.new @bag_path
     end
 
-    after(:each) do
+    after do
       @sandbox.cleanup!
     end
 
-    it "should be empty" do
+    it "is empty" do
       expect(@bag).to be_empty
     end
   end
 
-  describe 'bag with files' do
-    before(:each) do
+  describe "bag with files" do
+    before do
       @sandbox = Sandbox.new
 
       # make the bag
-      @bag_path = File.join @sandbox.to_s, 'the_bag'
-      @bag = BagIt::Bag.new @bag_path
+      @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) }
@@ -37,82 +38,84 @@ describe BagIt::Bag do
       end
     end
 
-    after(:each) do
+    after do
       @sandbox.cleanup!
     end
 
-    it "should be a directory" do
+    it "is a directory" do
       expect(File.directory?(@bag_path)).to be true
     end
 
-    it "should not be empty" do
+    it "is not be empty" do
       expect(@bag).not_to be_empty
     end
 
-    it "should have a sub-directory called data" do
-      data_path = File.join @bag_path, 'data'
+    it "has a sub-directory called data" do
+      data_path = File.join @bag_path, "data"
       expect(File.directory?(data_path)).to be true
     end
 
     describe "#add_file" do
-      it "should allow addition of files via io" do
-        @bag.add_file("foo") { |io| io.puts 'all alone' }
+      it "allows addition of files via io" do
+        @bag.add_file("foo") { |io| io.puts "all alone" }
         expect(File.join(@bag_path, "data", "foo")).to exist_on_fs
       end
 
-      it "should allow 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' }
+      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" }
         expect(File.join(@bag_path, "data", "foo")).to exist_on_fs
       end
 
-      it "should allow addition of files with deep paths" do
-        @bag.add_file("deep/dir/structure/file") { |io| io.puts 'all alone' }
+      it "allows addition of files with deep paths" do
+        @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 "should not allow overwriting of files" do
-        expect { @bag.add_file("file-0-💩
-") { |io| io.puts 'overwrite!' } }.to raise_error(RuntimeError)
+      it "does not allow overwriting of files" do
+        expect {
+          @bag.add_file("file-0-💩
+") { |io| io.puts "overwrite!" }
+        }.to raise_error(RuntimeError)
       end
 
-      it "should update 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)
+      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)
       end
     end
 
     describe "#remove_file" do
-      it "should raise an error when deleing non existant files" do
+      it "raises an error when deleing non existant files" do
         expect { @bag.remove_file("file-x") }.to raise_error(RuntimeError)
       end
     end
 
     describe "#get" do
       describe "file not in bag" do
-        it "should return nil" do
-          expect(@bag.get('foobar')).to be_nil
+        it "returns nil" do
+          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
 
-        it "should return an IO object for the given path" do
+        it "returns an IO object for the given path" do
           expect(@file).to be_a_kind_of(IO)
         end
 
-        it "should have the same content as the file added" do
+        it "has the same content as the file added" do
           expect(@file.read).to eq(@contents)
         end
 
-        it "should accept an optional leading slash or ./" do
+        it "accepts an optional leading slash or ./" do
           expect(@bag.get("/foo").read).to eq(@contents)
           expect(@bag.get("./foo").read).to eq(@contents)
         end
@@ -124,7 +127,7 @@ describe BagIt::Bag do
         @paths = @bag.paths
       end
 
-      it "should return a non-empty Array of Strings" do
+      it "returns a non-empty Array of Strings" do
         expect(@paths).to be_a_kind_of(Array)
         expect(@paths).not_to be_empty
         @paths.each do |p|
@@ -132,31 +135,33 @@ describe BagIt::Bag do
         end
       end
 
-      it "should return relative paths to all files in the data directory" do
-        expect(@paths).to match_array((0..9).collect { |x| "file-#{x}-💩
-" })
+      it "returns relative paths to all files in the data directory" do
+        expect(@paths).to match_array((0..9).collect { |x|
+                                        "file-#{x}-💩
+"
+                                      })
       end
     end
 
     describe "#payload-oxum" do
-      it "should return a valid oxum" do
+      it "returns a valid oxum" do
         expect(@bag.payload_oxum).to match(/^[0-9]+\.[0-9]+$/)
       end
 
-      it "should accurately specify 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
+      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
       end
     end
 
     describe "#gc!" do
-      it "should clean up empty directories" 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,57 +1,52 @@
-# coding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe "fetch.txt" do
-
-  before(:each) do
+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 = BagIt::Bag.new @bag_path
+    @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
-
     end
-
-  end
-
-  after(:each) do
-    @sandbox.cleanup!
   end
+  describe "fetch.txt" do
+    after do
+      @sandbox.cleanup!
+    end
 
-  before(:each) do
-    @bag.add_remote_file('http://www.gnu.org/graphics/heckert_gnu.small.png', 'gnu.png', 6322,
-                         '390c0a30976f899cbdf951eab5cce60fe9743ac9',
-                         'a3bd7ab2442028bb91b51d9f6722ec98')
+    before do
+      @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'
-    @lines = File.open(path) { |io| io.readlines }
-  end
+      path = File.join @bag_path, "fetch.txt"
+      @lines = File.open(path, &:readlines)
+    end
 
-  it "should not be empty" do
-    expect(@lines).not_to be_empty
-  end
+    it "isn't empty" do
+      expect(@lines).not_to be_empty
+    end
 
-  it "should only contain lines of the format URL LENGTH FILENAME" do
-    @lines.each { |line| expect(line.chomp).to match(/^[^\s]+\s+(\d+|\-)\s+[^\s]+$/) }
-  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]+$/) }
+    end
 
-  it "should contain manifested files" do
-    path = File.join @bag_path, 'manifest-sha1.txt'
-    data = File.open(path) { |io| io.read }
-    expect(data).to include('gnu.png')
-  end
+    it "contains manifested files" do
+      path = File.join @bag_path, "manifest-sha1.txt"
+      data = File.open(path, &:read)
+      expect(data).to include("gnu.png")
+    end
 
-  it "should be gone when fetch is complete" do
-    @bag.fetch!
-    expect(File.exist?(File.join(@bag_path, 'fetch.txt'))).not_to be true
+    it "is gone when fetch is complete" do
+      @bag.fetch!
+      expect(File.exist?(File.join(@bag_path, "fetch.txt"))).not_to be true
+    end
   end
-
 end