bagit 0.3.5 → 0.4.4

data/spec/tag_spec.rb

@@ -1,62 +1,60 @@
-# coding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe "Tag Specs" do
+require "spec_helper"
 
-  before(:each) do
+describe BagIt::Bag do
+  describe "Tag Specs" do
+    before do
+      @sandbox = Sandbox.new
 
-    @sandbox = Sandbox.new
+      # make the bag
+      @bag_path = File.join @sandbox.to_s, "the_bag"
+      @bag = described_class.new(@bag_path)
 
-    # make the bag
-    @bag_path = File.join @sandbox.to_s, 'the_bag'
-    @bag = BagIt::Bag.new @bag_path
-
-    # add some files
-    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)}
+      # add some files
+      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) }
+        end
       end
-
     end
 
-  end
-
-  after(:each) do
-    @sandbox.cleanup!
-  end
-  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' }
-      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' }
-      expect(File.join(@bag_path, "fedora","foo")).to exist_on_fs
+    after do
+      @sandbox.cleanup!
     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"}
-      expect(File.join(@bag_path,"fedora","foo","newfoo","deep")).to exist_on_fs
-    end
-    it "should not allow overwriting of tag files" do
-      expect { @bag.add_tag_file("tag-0") { |io| io.puts 'overwrite!' } }.to raise_error(RuntimeError)
+    describe "#add_tag_file" do
+      it "allows addition of tag files via io" do
+        @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" }
+        expect(File.join(@bag_path, "fedora", "foo")).to exist_on_fs
+      end
+      it "allows addition of deep tag files" do
+        @bag.add_tag_file("fedora/foo/newfoo/deep") { |io| io.puts "woah that's deep" }
+        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)
+      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" }
+        expect(File.join(@bag_path, "foo")).to exist_on_fs
+      end
     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' }
-      expect(File.join(@bag_path, "foo")).to exist_on_fs
+    describe "#remove_tag_file" do
+      it "raises an error when removing non existant files" do
+        expect { @bag.remove_tag_file("file-x") }.to raise_error(RuntimeError)
+      end
     end
-  end
-  describe "#remove_tag_file" do
-    it "should raise an error when removing non existant files" do
-      expect { @bag.remove_tag_file("file-x") }.to raise_error(RuntimeError)
+    describe "#delete_tag_file" do
+      it "raises an error when deleting non existant tag files" do
+        expect { @bag.delete_tag_file("file-x") }.to raise_error(RuntimeError)
+      end
     end
   end
-  describe "#delete_tag_file" do
-    it "should raise an error when deleting non existant tag files" do
-      expect { @bag.delete_tag_file("file-x") }.to raise_error(RuntimeError)
-  end
-  end
 end

data/spec/util/bagit_matchers.rb

@@ -1,8 +1,7 @@
-module BagitMatchers
-
-  class BeIn 
-
+# frozen_string_literal: true
 
+module BagitMatchers
+  class BeIn
     def initialize(*expected_collection)
       @expected = expected_collection
     end
@@ -20,16 +19,13 @@ module BagitMatchers
       "expected <#{@target}> to not be in collection <#{@expected}>"
     end
     alias negative_failure_message failure_message_when_negated
-
   end
 
   def be_in(*expected_collection)
     BeIn.new(*expected_collection)
   end
 
-  class ExistOnFS 
-
-
+  class ExistOnFS
     def matches?(target)
       @target = target
       File.exist? target
@@ -43,14 +39,9 @@ module BagitMatchers
       "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,144 +1,142 @@
-# coding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe "a valid bag" do
+require "spec_helper"
 
-  before(:each) do
+describe BagIt::Bag do
+  describe "a valid bag" do
+    before do
+      @sandbox = Sandbox.new
 
-    @sandbox = Sandbox.new
+      # make the bag
+      @bag_path = File.join @sandbox.to_s, "the_bag"
+      @bag = described_class.new @bag_path
 
-    # make the bag
-    @bag_path = File.join @sandbox.to_s, 'the_bag'
-    @bag = BagIt::Bag.new @bag_path
-
-    # add some files
-    File.open('/dev/urandom') do |rio|
-
-      10.times do |n|
-        @bag.add_file("file-#{n}-💩
+      # 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_tag_file("tag-#{n}") { |io| io.write rio.read(16) }
+          @bag.add_tag_file("tag-#{n}") { |io| io.write rio.read(16) }
+        end
       end
 
+      @bag.manifest!
     end
 
-    @bag.manifest!
-  end
+    after do
+      @sandbox.cleanup!
+    end
 
-  after(:each) do
-    @sandbox.cleanup!
-  end
+    it "validates with no errors" do
+      expect(@bag).to be_valid
+    end
 
-  it "should validate with no errors" do
-    expect(@bag).to be_valid
-  end
+    it "is 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
 
-  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'
+      @bag.validate_only("true_for/completeness")
+      expect(@bag.errors.on(:completeness)).not_to be_empty
+      expect(@bag).not_to be_valid
     end
 
-    @bag.validate_only('true_for/completeness')
-    expect(@bag.errors.on(:completeness)).not_to be_empty
-    expect(@bag).not_to be_valid
-  end
-
-  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!
+    it "is invalid if there are files that are in the manifest but not in the bag" do
+      # add a file and then remove it through the back door
+      @bag.add_file("file-k") { |io| io.puts "time to go" }
+      @bag.manifest!
 
-    FileUtils::rm File.join(@bag.bag_dir, 'data', 'file-k')
+      FileUtils.rm File.join(@bag.bag_dir, "data", "file-k")
 
-    @bag.validate_only('true_for/completeness')
-    expect(@bag.errors.on(:completeness)).not_to be_empty
-    expect(@bag).not_to be_valid
-  end
+      @bag.validate_only("true_for/completeness")
+      expect(@bag.errors.on(:completeness)).not_to be_empty
+      expect(@bag).not_to be_valid
+    end
 
-  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!' }
+    it "is 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')
-    expect(@bag.errors.on(:consistency)).not_to be_empty
-    expect(@bag).not_to be_valid
-  end
+      @bag.validate_only("true_for/consistency")
+      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
-    @bag.add_file 'big-data-file' do |fh|
-      count = 0
-      while count < 1024 * 512 do
-        fh.write "1" * 1024
-        count += 1
+    it "calculates sha1 correctly for a big file" do
+      @bag.add_file "big-data-file" do |fh|
+        count = 0
+        while count < 1024 * 512
+          fh.write "1" * 1024
+          count += 1
+        end
       end
-    end
-    @bag.manifest!
-    sha1_manifest = File.join @bag_path, 'manifest-sha1.txt'
-    checksums = {}
-    File.open(sha1_manifest).each_line do |line|
-        fixity, path = line.split(' ')
+      @bag.manifest!
+      sha1_manifest = File.join @bag_path, "manifest-sha1.txt"
+      checksums = {}
+      File.open(sha1_manifest).each_line do |line|
+        fixity, path = line.split(" ")
         checksums[path] = fixity
+      end
+      expected = checksums["data/big-data-file"]
+      expect(expected).to eq("12be64c30968bb90136ee695dc58f4b2276968c6")
     end
-    expected = checksums['data/big-data-file']
-    expect(expected).to eq('12be64c30968bb90136ee695dc58f4b2276968c6')
-  end
 
-  it "should validate by oxum when needed" do
-    expect(@bag.valid_oxum?).to eq(true)
-  end
+    it "validates by oxum when needed" do
+      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' }
-    expect(@bag.valid_oxum?).to eq(false)
-  end
+    it "raises a 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 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] }
-    expect(@bag.valid_oxum?).to eq(false)
-  end
+    it "validates 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" }
+      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
+    it "validates 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] }
+      expect(@bag.valid_oxum?).to eq(false)
+    end
 
-      # @bag.should_not be_valid
-      expect(@bag).not_to be_valid
-      expect(@bag.errors.on(:completeness)).not_to be_empty
+    describe "tag manifest validation" do
+      it "is 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
-   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
-      @bag.add_tag_file("tag-k") { |io| io.puts 'time to go' }
-      @bag.tagmanifest!
+    describe "tag manifest validation" do
+      it "is invalid if listed tag file does not exist" do
+        # add a file and then remove it through the back door
+        @bag.add_tag_file("tag-k") { |io| io.puts "time to go" }
+        @bag.tagmanifest!
 
-      FileUtils::rm File.join(@bag.bag_dir, 'tag-k')
+        FileUtils.rm File.join(@bag.bag_dir, "tag-k")
 
-      # @bag.should_not be_valid
-      expect(@bag).not_to be_valid
-      expect(@bag.errors.on(:completeness)).not_to be_empty
+        # @bag.should_not be_valid
+        expect(@bag).not_to be_valid
+        expect(@bag.errors.on(:completeness)).not_to be_empty
+      end
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bagit
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.4
 platform: ruby
 authors:
 - Tom Johnson, Francesco Lazzarino, Jamie Little
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validatable
@@ -52,20 +52,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,8 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: BagIt package generation and validation