bagit 0.3.2 → 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3aca61bf93d7ec24641cb785afe5ca9da63dcf2b
+  data.tar.gz: 5a815665d9cb46247aec70522c0e6cf40105078c
+SHA512:
+  metadata.gz: af6d60e6d0693611d3d76e38869e8b8c985d9426adc101b17586ee06f8c200fb6975ca7f2af274a9834dc023bb94a0aa4443c26403278cc8045be35cc70975e3
+  data.tar.gz: 6fe5d3a1bf5832e16c7a072b6529cd18c63425f3d2f754469276efc37f0df049c35d2af4f5baee41448213b81d3c85b9b0b46fceb4c980136ca088b67de642ed

data/.travis.yml

@@ -1,8 +1,6 @@
 rvm:
-  - "1.9.3"
-  - "1.9.2"
-  - "1.8.7"
-
+ - 2.3
+ - 2.2
 branches:
-  only:
+ only:
     - master

data/README.md

@@ -1,23 +1,21 @@
 BagIt (for ruby)
 ================
 
-[![Build Status](https://secure.travis-ci.org/no-reply/bagit.png)](http://travis-ci.org/no-reply/bagit)
+[![Build Status](https://travis-ci.org/tipr/bagit.svg?branch=master)](http://travis-ci.org/tipr/bagit) [![Coverage Status](https://coveralls.io/repos/github/tipr/bagit/badge.svg?branch=master)](https://coveralls.io/github/tipr/bagit?branch=master)
 
-Based on the [BagItspec v0.97](https://confluence.ucop.edu/display/Curation/BagIt).
+This is a Ruby library and command line utility for creating BagIt archives based on the [BagItspec v0.97](https://confluence.ucop.edu/display/Curation/BagIt).
 
 Supported Features:
 -------------------
-* bag compiling
-* manifest & tagmanifest generation
-* generation of tag files bag-info.txt and bagit.txt
-* fetching remote files (fetch.txt)
-* bag validation
+* Bag creation
+* Manifest & tagmanifest generation
+* Generation of tag files bag-info.txt and bagit.txt
+* Fetching remote files (fetch.txt)
+* Bag validation
 
 Installation
 ------------
-    % gem install bagit validatable
-The rubyforge gem is deprecated.
-
+    # gem install bagit validatable
 
 Example: making a bag
 ---------------------
@@ -54,17 +52,9 @@ Console Tool
     # for other commands
     bagit --help
 
-TODO
-----
-* deep directory add/delete for bag and tag files in console tools
-* better holy bag (fetch.txt) generation
-* better error reporting.
-
----
-
 Copyright © 2009, [Francesco Lazzarino](mailto:flazzarino@gmail.com).
 
-Current maintainer: [Tom Johnson](mailto:thomas.johnson@oregonstate.edu).
+Current maintainer: [Jamie Little](mailto:jamie@jamielittle.org).
 
 Initial development sponsored by [Florida Center for Library Automation](http://www.fcla.edu).
 

data/Rakefile

@@ -10,7 +10,7 @@ Bundler::GemHelper.install_tasks
 
 RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/**/*_spec.rb'
-  t.rspec_opts = %w(-fs --color)
+  t.rspec_opts = %w(--format  documentation --color)
 end
 
 task :default => [:spec]

data/bagit.gemspec

@@ -8,17 +8,20 @@ Gem::Specification.new do |spec|
   spec.version     = BagIt::VERSION
   spec.summary     = "BagIt package generation and validation"
   spec.description = "Ruby Library and Command Line tools for bagit"
-  spec.email       = "johnson.tom@gmail.com"
+  spec.email       = "jamie@jamielittle.org"
   spec.homepage    = 'http://github.com/tipr/bagit'
-  spec.authors     = ["Tom Johnson, Francesco Lazzarino"]
+  spec.authors     = ["Tom Johnson, Francesco Lazzarino, Jamie Little"]
   spec.license     = "MIT"
 
+  spec.required_ruby_version = '~> 2.0'
+  
   spec.add_dependency 'validatable', '~> 1.6'
   spec.add_dependency 'docopt', '~> 0.5.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'coveralls'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/bin/bagit

@@ -2,6 +2,9 @@
 
 require 'bagit'
 require 'docopt'
+require 'logger'
+
+logger = Logger.new(STDOUT)
 
 doc = <<DOCOPT
 BagIt.
@@ -37,17 +40,23 @@ DOCOPT
 
 begin
   opts = Docopt::docopt(doc, version: BagIt::VERSION)
-  
-  bag = BagIt::Bag.new(opts['BAGPATH'])
 
+  unless opts['validate']
+    bag = BagIt::Bag.new(opts['BAGPATH'])
+  end
   #####################################
   # commands that don't alter the bag #
   #####################################
   if opts['validate']
-    if opts['--oxum']
-      puts bag.valid_oxum?.to_s
+    if File.exists?(opts['BAGPATH']+'/bag-info.txt') && File.directory?(opts['BAGPATH']+'/data') && File.exists?(opts['BAGPATH']+'/manifest-md5.txt') || File.exists?(opts['BAGPATH']+'/manifest-sha1.txt')
+      bag = BagIt::Bag.new(opts['BAGPATH'])
+      if opts['--oxum']
+        logger.info(bag.valid_oxum?.to_s)
+      else
+        logger.info(bag.valid?.to_s)
+      end
     else
-      puts bag.valid?.to_s
+      logger.error("Not a valid bag")
     end
     # validation commands MUST NOT change manifest or bag-info files
     exit
@@ -83,7 +92,7 @@ begin
           bag.remove_file(File.basename(datafile))
         end
       rescue Exception => e
-        puts "Failed operation on bag file: #{e.message}"
+        logger.error("Failed operation on bag file: #{e.message}")
       end
     }  
   end
@@ -107,7 +116,7 @@ begin
           bag.remove_tag_file(File.basename(tagfile))
         end
       rescue Exception => e
-        puts "Failed operation on tag file: #{e.message}"
+        logger.error("Failed operation on tag file: #{e.message}".red)
       end
     }
   end
@@ -118,6 +127,6 @@ begin
   bag.manifest!
 
 rescue Docopt::Exit => e
-  puts e.message
+  logger.error(e.message.red)
 end
 

data/lib/bagit.rb

@@ -7,7 +7,7 @@ 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'

data/lib/bagit/bag.rb

@@ -6,7 +6,6 @@ require 'bagit/string'
 require 'bagit/valid'
 
 module BagIt
-
   # Represents the state of a bag on a filesystem
   class Bag
     attr_reader :bag_dir
@@ -17,9 +16,10 @@ module BagIt
     include Fetch               # fetch related functionality
 
     # Make a new Bag based at path
-    def initialize(path, info={})
+    def initialize(path, info={}, create=false)
+    
+        
       @bag_dir = path
-
       # 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
@@ -32,6 +32,7 @@ module BagIt
       unless File.exist? bag_info_txt_file
         write_bag_info(info)
       end
+     
     end
 
     # Return the path to the data directory

data/lib/bagit/manifest.rb

@@ -6,7 +6,13 @@ 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')
+     return s
+    end
 
+  
     # All tag files that are bag manifest files (manifest-[algorithm].txt)
     def manifest_files
       files = Dir[File.join(@bag_dir, '*')].select { |f|
@@ -28,8 +34,8 @@ module BagIt
 
       # manifest each tag file for each algorithm
       bag_files.each do |f|
-        rel_path = Pathname.new(f).relative_path_from(Pathname.new(bag_dir)).to_s
-
+        rel_path = encode_filename(Pathname.new(f).relative_path_from(Pathname.new(bag_dir)).to_s)
+        
         # sha1
         sha1 = Digest::SHA1.file f
         File.open(manifest_file(:sha1), 'a') { |io| io.puts "#{sha1} #{rel_path}" }

data/lib/bagit/string.rb

@@ -13,11 +13,23 @@ class String
     end
 
   end
-  
+
   # Indent each line of a string by n spaces
   def indent(n)
     indent = ' ' * n
     gsub '\n', "\n#{indent}"
   end
 
+# Colorize logs
+ def color(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    color(31)
+  end
+
+  def green
+    color(32)
+  end
 end

data/lib/bagit/valid.rb

@@ -1,4 +1,7 @@
 require 'validatable'
+require 'open-uri'
+require 'cgi'
+require 'logger'
 
 module BagIt
 
@@ -9,19 +12,32 @@ module BagIt
   end
 
   module Validity
-
+    def decode_filename(s)
+      s = s.gsub('%0D',"\r")
+      s = s.gsub('%0A',"\n")
+      return 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
+      
       unmanifested_files.each do |file|
+        logger.error("#{file} is present but not manifested".red)
         errors.add :completeness, "#{file} is present but not manifested"
       end
 
       empty_manifests.each do |file|
+        logger.error("#{file} is manifested but not present".red)
         errors.add :completeness, "#{file} is manifested but not present"
       end
       tag_empty_manifests.each do |file|
+        logger.error("#{file} is a manifested tag but not present".red)
         errors.add :completeness, "#{file} is a manifested tag but not present"
       end
 
@@ -33,22 +49,32 @@ module BagIt
       (manifest_files|tagmanifest_files).each do |mf|
         # get the algorithm implementation
         File.basename(mf) =~ /manifest-(.+).txt$/
-        algo = case $1
+        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
-                 :unknown
+                 raise ArgumentError.new("Algorithm #{manifest_type} is not supported.")
                end
         # Check every file in the manifest
         File.open(mf) do |io|
           io.each_line do |line|
             expected, path = line.chomp.split /\s+/, 2
-            file = File.join(bag_dir, path)
+            file = File.join(bag_dir, decode_filename(path))
+
             if File.exist? file
+
               actual = algo.file(file).hexdigest
               if expected != actual
+                
                 errors.add :consistency, "expected #{file} to have #{algo}: #{expected}, actual is #{actual}"
               end
             end
@@ -56,7 +82,6 @@ module BagIt
         end
       end
 
-
       errors.on(:consistency).nil?
     end
 
@@ -66,7 +91,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 }
@@ -97,7 +122,7 @@ module BagIt
 
           io.readlines.map do |line|
             digest, path = line.chomp.split /\s+/, 2
-            path
+            decode_filename(path)
           end
 
         end

data/lib/bagit/version.rb

@@ -1,3 +1,3 @@
 module BagIt
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

data/spec/bagit_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 # based on v0.96 http://www.cdlib.org/inside/diglib/bagit/bagitspec.html
@@ -15,11 +16,10 @@ describe BagIt::Bag do
     end
 
     it "should be empty" do
-      @bag.should be_empty
+      expect(@bag).to be_empty
     end
   end
 
-
   describe 'bag with files' do
     before(:each) do
       @sandbox = Sandbox.new
@@ -31,7 +31,8 @@ describe BagIt::Bag do
       # add some files
       File.open('/dev/urandom') do |rio|
         10.times do |n|
-          @bag.add_file("file-#{n}") { |io| io.write rio.read(16) }
+          @bag.add_file("file-#{n}-💩
+") { |io| io.write rio.read(16) }
         end
       end
     end
@@ -41,57 +42,58 @@ describe BagIt::Bag do
     end
 
     it "should be a directory" do
-      File.directory?(@bag_path).should be_true
+      expect(File.directory?(@bag_path)).to be true
     end
 
     it "should not be empty" do
-      @bag.should_not be_empty
+      expect(@bag).not_to be_empty
     end
 
     it "should have a sub-directory called data" do
       data_path = File.join @bag_path, 'data'
-      File.directory?(data_path).should be_true
+      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' }
-        File.join(@bag_path, "data", "foo").should exist_on_fs
+        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' }
-        File.join(@bag_path, "data", "foo").should exist_on_fs
+        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' }
-        File.join(@bag_path, "data", "deep/dir/structure/file").should exist_on_fs
+        expect(File.join(@bag_path, "data", "deep/dir/structure/file")).to exist_on_fs
       end
 
       it "should not allow overwriting of files" do
-        lambda { @bag.add_file("file-0") { |io| io.puts 'overwrite!' } }.should raise_error
+        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' }
-        @bag.bag_info["Payload-Oxum"].split('.')[1].to_i.should == oxum_count + 1
+        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
-        lambda { @bag.remove_file("file-x") }.should raise_error
+        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
-          @bag.get('foobar').should be_nil
+          expect(@bag.get('foobar')).to be_nil
         end
       end
 
@@ -103,16 +105,16 @@ describe BagIt::Bag do
         end
 
         it "should return an IO object for the given path" do
-          @file.should be_a_kind_of(IO)
+          expect(@file).to be_a_kind_of(IO)
         end
 
         it "should have the same content as the file added" do
-          @file.read.should == @contents
+          expect(@file.read).to eq(@contents)
         end
 
         it "should accept an optional leading slash or ./" do
-          @bag.get("/foo").read.should == @contents
-          @bag.get("./foo").read.should == @contents
+          expect(@bag.get("/foo").read).to eq(@contents)
+          expect(@bag.get("./foo").read).to eq(@contents)
         end
       end
     end
@@ -123,21 +125,22 @@ describe BagIt::Bag do
       end
 
       it "should return a non-empty Array of Strings" do
-        @paths.should be_a_kind_of(Array)
-        @paths.should_not be_empty
+        expect(@paths).to be_a_kind_of(Array)
+        expect(@paths).not_to be_empty
         @paths.each do |p|
-          p.should be_a_kind_of(String)
+          expect(p).to be_a_kind_of(String)
         end
       end
 
       it "should return relative paths to all files in the data directory" do
-        @paths.should =~ (0..9).collect { |x| "file-#{x}" }
+        expect(@paths).to match_array((0..9).collect { |x| "file-#{x}-💩
+" })
       end
     end
 
     describe "#payload-oxum" do
       it "should return a valid oxum" do
-        @bag.payload_oxum.should =~ /^[0-9]+\.[0-9]+$/
+        expect(@bag.payload_oxum).to match(/^[0-9]+\.[0-9]+$/)
       end
 
       it "should accurately specify the number of payload files" do
@@ -151,9 +154,9 @@ describe BagIt::Bag do
         f = File.join "1", "2", "3", "file"
         @bag.add_file(f) { |io| io.puts 'all alone' }
         @bag.remove_file f
-        File.exist?(File.dirname(File.join(@bag_path, 'data', f))).should be_true
+        expect(File.exist?(File.dirname(File.join(@bag_path, 'data', f)))).to be true
         @bag.gc!
-        File.exist?(File.dirname(File.join(@bag_path, 'data', f))).should 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,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 describe "fetch.txt" do
@@ -14,7 +15,7 @@ describe "fetch.txt" do
     File.open('/dev/urandom') do |rio|
 
       10.times do |n|
-        @bag.add_file("file-#{n}") { |io| io.write rio.read(16) }
+        @bag.add_file("file-#{n}-💩
       end
 
     end
@@ -35,22 +36,22 @@ describe "fetch.txt" do
   end
 
   it "should not be empty" do
-    @lines.should_not be_empty
+    expect(@lines).not_to be_empty
   end
 
   it "should only contain lines of the format URL LENGTH FILENAME" do
-    @lines.each { |line| line.chomp.should =~ /^[^\s]+\s+(\d+|\-)\s+[^\s]+$/ }
+    @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 }
-    data.should include('gnu.png')
+    expect(data).to include('gnu.png')
   end
 
   it "should be gone when fetch is complete" do
     @bag.fetch!
-    File.exist?(File.join(@bag_path, 'fetch.txt')).should_not be_true
+    expect(File.exist?(File.join(@bag_path, 'fetch.txt'))).not_to be true
   end
 
 end

data/spec/manifest_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 describe "BagIt Manifests" do
@@ -14,10 +15,13 @@ describe "BagIt Manifests" do
     File.open('/dev/urandom') do |rio|
 
       10.times do |n|
-        @bag.add_file("file-#{n}") { |io| io.write rio.read(16) }
+        @bag.add_file("file-#{n}-💩
         @bag.add_tag_file("tag-#{n}") { |io| io.write rio.read(16) }
       end
 
+      
+     
+      
     end
 
   end
@@ -35,17 +39,17 @@ describe "BagIt Manifests" do
 
     it "should have valid algorithm in the name (at least md5 or sha1)" do
       algorithms = @manifest_files.map { |mf| mf =~ /manifest-(.*).txt$/; $1 }
-      algorithms.each { |a| a.should be_in('md5', 'sha1') }
+      algorithms.each { |a| expect(a).to be_in('md5', 'sha1') }
     end
 
     it "should not be an empty file" do
-      @manifest_files.each { |mf| File.size(mf).should_not == 0 }
+      @manifest_files.each { |mf| expect(File.size(mf)).not_to eq(0) }
     end
 
     it "should only contain lines of the format CHECKSUM FILENAME" do
       @manifest_files.each do |file|
         File.open(file) do |io|
-          io.each_line { |line| line.chomp.should =~ /^[a-fA-F0-9]+\s+[^\s].+$/ }
+          io.each_line { |line| expect(line).to match(/^[a-fA-F0-9]+\s+[^\s].+$/) }
         end
       end
     end
@@ -53,7 +57,7 @@ describe "BagIt Manifests" do
     it "should validate after adding a file and remanifesting" do
       @bag.add_file('newfile.txt') { |io| io.puts("new file to remanifest") }
       @bag.manifest!
-      @bag.should be_valid
+      expect(@bag).to be_valid
     end
 
   end
@@ -67,14 +71,14 @@ describe "BagIt Manifests" do
     it_behaves_like "a manifest file"
 
     it "should have a manifest file" do
-      @bag.manifest_files.should_not be_empty
+      expect(@bag.manifest_files).not_to be_empty
     end
 
     it "should only contain bag files" do
       @bag.manifest_files.each do |mf|
         File.open(mf) do |io|
           io.each_line do |line|
-            line.chomp.should =~ /^[a-f0-9]+\s+data\/[^\s].+$/
+            expect(line.chomp).to match(/^[a-f0-9]+\s+data\/[^\s].+$/)
           end
         end
       end
@@ -91,30 +95,30 @@ describe "BagIt Manifests" do
     it_should_behave_like "a manifest file"
 
     it "should have a tag manifest file" do
-      @bag.tagmanifest_files.should_not be_empty
+      expect(@bag.tagmanifest_files).not_to be_empty
     end
     it "should only contain tag files" do
       @bag.tagmanifest_files.each do |mf|
         File.open(mf) do |io|
           io.each_line do |line|
-            line.chomp.should =~ /^[a-fA-F0-9]+\s+(?!data\/)[^\s].+$/
+            expect(line.chomp).to match(/^[a-fA-F0-9]+\s+(?!data\/)[^\s].+$/)
           end
         end
       end
     end
     it "should contain manifest and bag info files" do
       @bag.tagmanifest_files.each do |mf|
-        File.open(mf).read.should include(File.basename(@bag.bag_info_txt_file))
-        File.open(mf).read.should include(File.basename(@bag.bagit_txt_file))
+        expect(File.open(mf).read).to include(File.basename(@bag.bag_info_txt_file))
+        expect(File.open(mf).read).to include(File.basename(@bag.bagit_txt_file))
         @bag.manifest_files.each do |man|
-          File.open(mf).read.should include(man)
+          expect(File.open(mf).read).to include(man)
         end
       end
     end
     it "should not contain the untracked tag file" do
       @bag.tagmanifest_files.each do |mf|
         File.open(mf) do |io|
-          io.read.should_not include "tag-notrack"
+          expect(io.read).not_to include "tag-notrack"
         end
       end
     end
@@ -124,16 +128,16 @@ describe "BagIt Manifests" do
         @bag.delete_tag_file "tag-2"
       end
       it "should still have the untracked tag file on the file system" do
-        File.join(@bag_path, "tag-1").should exist_on_fs
+        expect(File.join(@bag_path, "tag-1")).to exist_on_fs
       end
       it "should not have the deleted tag file on the file system" do
-        File.join(@bag_path, "tag-2").should_not exist_on_fs
+        expect(File.join(@bag_path, "tag-2")).not_to exist_on_fs
       end
       it "should not have the removed or deleted tag files in the manifest" do
         @bag.tagmanifest_files.each do |mf|
           File.open(mf) do |io|
-            io.read.should_not include "tag-1"
-            io.read.should_not include "tag-2"
+            expect(io.read).not_to include "tag-1"
+            expect(io.read).not_to include "tag-2"
           end
         end
       end

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
 require 'rubygems'
 require 'bundler'
+require 'coveralls'
+
 Bundler.require(:default, :test)
 
+Coveralls.wear!
+
 require File.expand_path('./util/bagit_matchers', File.dirname(__FILE__))
 
 RSpec.configure do |config|

data/spec/tag_info_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 describe "Tag Info Files" do
@@ -13,7 +14,7 @@ describe "Tag Info Files" do
     # add some files
     File.open('/dev/urandom') do |rio|
       10.times do |n|
-        @bag.add_file("file-#{n}") { |io| io.write rio.read(16) }
+        @bag.add_file("file-#{n}-💩
       end
     end
 
@@ -31,21 +32,21 @@ describe "Tag Info Files" do
     end
 
     it "should create a file bagit.txt on bag initialization" do
-      File.join(@bag_path, 'bagit.txt').should exist_on_fs
+      expect(File.join(@bag_path, 'bagit.txt')).to exist_on_fs
     end
 
     it "should have exactly two lines" do
-      @lines.size.should == 2
+      expect(@lines.size).to eq(2)
     end
 
     it "should have a bagit version" do
       a = @lines.select { |line| line.chomp =~ /BagIt-Version:\s*\d+\.\d+/ }
-      a.should_not be_empty
+      expect(a).not_to be_empty
     end
 
     it "should have a tag file encoding" do
       a = @lines.select { |line| line.chomp =~ /Tag-File-Character-Encoding:\s*.+/ }
-      a.should_not be_empty
+      expect(a).not_to be_empty
     end
 
   end
@@ -58,16 +59,16 @@ describe "Tag Info Files" do
     end
 
     it "should not be empty" do
-      @lines.should_not be_empty
+      expect(@lines).not_to be_empty
     end
 
     it "should contain lines of the format LABEL: VALUE (like an email header)" do
-      @lines.each { |line| line.chomp.should =~ /^[^\s]+\s*:\s+.*$/ }
+      @lines.each { |line| expect(line.chomp).to match(/^[^\s]+\s*:\s+.*$/) }
     end
 
     it "should be case insensitive with respect to LABELs" do
       path = File.join @bag_path, 'bag-info.txt'
-      lambda { @bag.write_bag_info 'foo' => 'lowercase', 'Foo' => 'capital' }.should raise_error(/Multiple labels/)
+      expect { @bag.write_bag_info 'foo' => 'lowercase', 'Foo' => 'capital' }.to raise_error(/Multiple labels/)
     end
 
     it "should fold long VALUEs" do
@@ -81,20 +82,20 @@ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
   culpa qui officia deserunt mollit anim id est laborum.
 LOREM
       @bag.write_bag_info 'Lorem' => longline
-      @bag.bag_info.keys.length.should == 4 # this isn't a great test. Changed it from 1 to 4 because unrelated changes caused failure.
+      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
 
     it "should specify a bag software agent" do
-      @bag.bag_info.keys.should include("Bag-Software-Agent")
+      expect(@bag.bag_info.keys).to include("Bag-Software-Agent")
     end
 
     it "should contain a valid bagging date" do
-      @bag.bag_info.keys.should include("Bagging-Date")
+      expect(@bag.bag_info.keys).to include("Bagging-Date")
       @bag.bag_info["Bagging-Date"] =~ /^^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
     end
 
     it "should contain a payload oxum" do
-      @bag.bag_info.keys.should include("Payload-Oxum")
+      expect(@bag.bag_info.keys).to include("Payload-Oxum")
     end
     it "should not override any previous values" do
       path = File.join @bag_path, 'bag-info.txt'
@@ -103,17 +104,17 @@ LOREM
       @bag.write_bag_info 'Bagging-Date' => '1901-01-01'
       @bag.write_bag_info
       contents = File.open(path).read
-      contents.should include "Some Other Agent"
-      contents.should include "Awesome Inc."
-      contents.should include "1901-01-01"
+      expect(contents).to include "Some Other Agent"
+      expect(contents).to include "Awesome Inc."
+      expect(contents).to include "1901-01-01"
     end
     it "should override 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.'
       contents = File.open(path).read
-      contents.should include "Awesome LLC."
-      contents.should_not include "Awesome Inc."
+      expect(contents).to include "Awesome LLC."
+      expect(contents).not_to include "Awesome Inc."
     end
     it "should contain values passed to bag" do
       hash = {"Bag-Software-Agent" => "rspec",
@@ -123,7 +124,7 @@ LOREM
       }
       bag_with_info = BagIt::Bag.new(@bag_path + '2', hash)
       hash.each do |key, value|
-        bag_with_info.bag_info[key].should == value
+        expect(bag_with_info.bag_info[key]).to eq(value)
       end
     end
 

data/spec/tag_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 describe "Tag Specs" do
@@ -14,7 +15,7 @@ describe "Tag Specs" do
     File.open('/dev/urandom') do |rio|
 
       10.times do |n|
-        @bag.add_file("file-#{n}") { |io| io.write rio.read(16) }
+        @bag.add_file("file-#{n}-💩
         @bag.add_tag_file("tag-#{n}") { |io| io.write rio.read(16)}
       end
 
@@ -28,34 +29,34 @@ describe "Tag Specs" do
   describe "#add_tag_file" do
     it "should allow addition of tag files via io" do
       @bag.add_tag_file("foo") { |io| io.puts 'all alone' }
-      File.join(@bag_path, "foo").should exist_on_fs
+      expect(File.join(@bag_path, "foo")).to exist_on_fs
     end
     it "should allow addition of bag files within directories using io" do
       @bag.add_tag_file("fedora/foo") { |io| io.puts 'all alone' }
-      File.join(@bag_path, "fedora","foo").should exist_on_fs
+      expect(File.join(@bag_path, "fedora","foo")).to exist_on_fs
     end
     it "should allow addition of deep tag files" do
       @bag.add_tag_file("fedora/foo/newfoo/deep") {|io| io.puts "woah that's deep"}
-      File.join(@bag_path,"fedora","foo","newfoo","deep").should exist_on_fs
+      expect(File.join(@bag_path,"fedora","foo","newfoo","deep")).to exist_on_fs
     end
     it "should not allow overwriting of tag files" do
-      lambda { @bag.add_tag_file("tag-0") { |io| io.puts 'overwrite!' } }.should raise_error
+      expect { @bag.add_tag_file("tag-0") { |io| io.puts 'overwrite!' } }.to raise_error(RuntimeError)
     end
     it "should allow 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' }
-      File.join(@bag_path, "foo").should exist_on_fs
+      expect(File.join(@bag_path, "foo")).to exist_on_fs
     end
   end
   describe "#remove_tag_file" do
     it "should raise an error when removing non existant files" do
-      lambda { @bag.remove_tag_file("file-x") }.should raise_error
+      expect { @bag.remove_tag_file("file-x") }.to raise_error(RuntimeError)
     end
   end
   describe "#delete_tag_file" do
     it "should raise an error when deleting non existant tag files" do
-      lambda { @bag.delete_tag_file("file-x") }.should raise_error
+      expect { @bag.delete_tag_file("file-x") }.to raise_error(RuntimeError)
   end
   end
-end
+end

data/spec/util/bagit_matchers.rb

@@ -1,6 +1,7 @@
 module BagitMatchers
 
-  class BeIn
+  class BeIn 
+
 
     def initialize(*expected_collection)
       @expected = expected_collection
@@ -15,9 +16,10 @@ module BagitMatchers
       "expected <#{@target}> to be in collection <#{@expected}>"
     end
 
-    def negative_failure_message
+    def failure_message_when_negated
       "expected <#{@target}> to not be in collection <#{@expected}>"
     end
+    alias negative_failure_message failure_message_when_negated
 
   end
 
@@ -25,7 +27,8 @@ module BagitMatchers
     BeIn.new(*expected_collection)
   end
 
-  class ExistOnFS
+  class ExistOnFS 
+
 
     def matches?(target)
       @target = target
@@ -36,14 +39,18 @@ module BagitMatchers
       "expected <#{@target}> to exist, but it doesn't"
     end
 
-    def negative_failure_message
+    def failure_message_when_negated
       "expected <#{@target}> to not exist but it does"
     end
+    alias negative_failure_message failure_message_when_negated
 
   end
 
-  def exist_on_fs
+  def exist_on_fs 
     ExistOnFS.new
   end
 
+  
+
+
 end

data/spec/validation_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 describe "a valid bag" do
@@ -14,7 +15,8 @@ describe "a valid bag" do
     File.open('/dev/urandom') do |rio|
 
       10.times do |n|
-        @bag.add_file("file-#{n}") { |io| io.write rio.read(16) }
+        @bag.add_file("file-#{n}-💩
+") { |io| io.write rio.read(16) }
         @bag.add_tag_file("tag-#{n}") { |io| io.write rio.read(16) }
       end
 
@@ -28,21 +30,21 @@ describe "a valid bag" do
   end
 
   it "should validate with no errors" do
-    @bag.should be_valid
+    expect(@bag).to be_valid
   end
 
-  it "should not be lewd (some file is not covered by the manifest)" do
+  it "should be invalid if there is a file that's in the bag, but not in the manifest" do
     # add a file into the bag through the back door
     File.open(File.join(@bag.data_dir, 'not-manifested'), 'w') do |io|
       io.puts 'nothing to see here, move along'
     end
 
     @bag.validate_only('true_for/completeness')
-    @bag.errors.on(:completeness).should_not be_empty
-    @bag.should_not be_valid
+    expect(@bag.errors.on(:completeness)).not_to be_empty
+    expect(@bag).not_to be_valid
   end
 
-  it "should not be prude (the manifest covers files that do not exist)" do
+  it "should be 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' }
     @bag.manifest!
@@ -50,17 +52,17 @@ describe "a valid bag" do
     FileUtils::rm File.join(@bag.bag_dir, 'data', 'file-k')
 
     @bag.validate_only('true_for/completeness')
-    @bag.errors.on(:completeness).should_not be_empty
-    @bag.should_not be_valid
+    expect(@bag.errors.on(:completeness)).not_to be_empty
+    expect(@bag).not_to be_valid
   end
 
-  it "should be consistent (fixity)" do
+  it "should be invalid if there is a fixity problem" do
     # tweak a file through the back door
     File.open(@bag.bag_files[0], 'a') { |io| io.puts 'oops!' }
 
     @bag.validate_only('true_for/consistency')
-    @bag.errors.on(:consistency).should_not be_empty
-    @bag.should_not be_valid
+    expect(@bag.errors.on(:consistency)).not_to be_empty
+    expect(@bag).not_to be_valid
   end
 
   it "should calculate sha1 correctly for a big file" do
@@ -79,25 +81,52 @@ describe "a valid bag" do
         checksums[path] = fixity
     end
     expected = checksums['data/big-data-file']
-    expected.should == '12be64c30968bb90136ee695dc58f4b2276968c6'
+    expect(expected).to eq('12be64c30968bb90136ee695dc58f4b2276968c6')
   end
 
   it "should validate by oxum when needed" do
-    @bag.valid_oxum?.should == true
+    expect(@bag.valid_oxum?).to eq(true)
   end
 
+   it "should raise an sensible error when the manifest algorithm is unknown" do
+     # add a manifest with an unsupported algorithm
+     File.open(File.join(@bag.bag_dir, 'manifest-sha999.txt'), 'w') do |io|
+       io.puts "digest-does-not-matter data/file-0\n"
+     end
+     expect { @bag.valid? }.to raise_error ArgumentError
+   end
+  
   it "should validate false by oxum when file count is incorrect" do
     # tweak oxum through backdoor
     File.open(@bag.bag_info_txt_file, 'a') { |f| f.write "Payload-Oxum: " + @bag.bag_info["Payload-Oxum"].split('.')[0] + '.0' }
-    @bag.valid_oxum?.should == false
+    expect(@bag.valid_oxum?).to eq(false)
   end
 
   it "should validate false by oxum when octetstream size is incorrect" do
     # tweak oxum through backdoor
     File.open(@bag.bag_info_txt_file, 'a') { |f| f.write "Payload-Oxum: 1." + @bag.bag_info["Payload-Oxum"].split('.')[1] }
-    @bag.valid_oxum?.should == false
+    expect(@bag.valid_oxum?).to eq(false)
   end
 
+   describe "tag manifest validation" do
+    it "should be invalid if there are no manifest files at all even when there are no files" do
+      #remove all files, tag/manifest files & tagmanifest files through the back door
+      @bag.bag_files.each do |bag_file|
+        FileUtils::rm bag_file
+      end
+      @bag.tag_files.each do |tag_file|
+        FileUtils::rm tag_file
+      end
+      @bag.tagmanifest_files.each do |tagmanifest_file|
+        FileUtils::rm tagmanifest_file
+      end
+
+      # @bag.should_not be_valid
+      expect(@bag).not_to be_valid
+      expect(@bag.errors.on(:completeness)).not_to be_empty
+    end
+   end
+
   describe "tag manifest validation" do
     it "should be invalid if listed tag file does not exist" do
       # add a file and then remove it through the back door
@@ -107,8 +136,8 @@ describe "a valid bag" do
       FileUtils::rm File.join(@bag.bag_dir, 'tag-k')
 
       # @bag.should_not be_valid
-      @bag.should_not be_valid
-      @bag.errors.on(:completeness).should_not be_empty
+      expect(@bag).not_to be_valid
+      expect(@bag.errors.on(:completeness)).not_to be_empty
     end
   end
 

metadata

@@ -1,106 +1,108 @@
 --- !ruby/object:Gem::Specification
 name: bagit
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.3.4
 platform: ruby
 authors:
-- Tom Johnson, Francesco Lazzarino
+- Tom Johnson, Francesco Lazzarino, Jamie Little
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validatable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: docopt
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby Library and Command Line tools for bagit
-email: johnson.tom@gmail.com
+email: jamie@jamielittle.org
 executables:
 - bagit
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -112,6 +114,7 @@ files:
 - lib/bagit/fetch.rb
 - lib/bagit/file.rb
 - lib/bagit/info.rb
+- lib/bagit/log.rb
 - lib/bagit/manifest.rb
 - lib/bagit/string.rb
 - lib/bagit/valid.rb
@@ -127,27 +130,26 @@ files:
 homepage: http://github.com/tipr/bagit
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: BagIt package generation and validation
 test_files:
 - spec/bagit_spec.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use ruby-1.9.3@bagit --create