bagit 0.3.5 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e581d4e4b632ebf75e7958de8dffef75425e695d
-  data.tar.gz: cacad3cbb8385dc5600732730ede21751683d034
+SHA256:
+  metadata.gz: 4b4fd9e3eb682521a82c7cd25ad0320088fba8fa907876a48c39320e2b245478
+  data.tar.gz: ec3971461e6304cc457e50323b369ce0d61a6b3df5f3ac445601c9f34d456f67
 SHA512:
-  metadata.gz: 385db1340cf4707f0ffa118d515b1d1d5739abc15750758466bce2b3f8d34bc221da766f3f353c3d095c27f1f20f63b6dab951a4d2e638b47174bc126fdc3f5a
-  data.tar.gz: 0577b97788dc9cd9871760653b380c719a7eb9192391c57e5632b6ef56855fca2ddcdb92ba2932a4b692417fe8167f0a0b2f5a5376456b0399c27012818c6393
+  metadata.gz: 78dff8b4378080349c13e9794302792e981f36db37f67e206658c554ecf0e025ba3c4332a5cd9f53f48a53935c5cbce9fb4435f28badccd0dacdf556b9ef30e7
+  data.tar.gz: 98828d498d5fdb72551587d4a4b766a579470e911d0056debe8098f9a59cd89c04cd2e1e204f02332b3a0813e2b3967a2ac7f6bae91895463bb7144590e54fb4

data/.gitignore

@@ -8,4 +8,5 @@ vendor
 Gemfile.lock
 .bundle
 .project
-.idea
+.idea
+coverage

data/.travis.yml

@@ -1,6 +1,5 @@
 rvm:
- - 2.3
- - 2.2
+ - 2.5
 branches:
  only:
     - master

data/Gemfile

@@ -1,3 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-gemspec
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -30,7 +30,7 @@ Example: making a bag
     end
 
     # generate the manifest and tagmanifest files
-    bag.manifest!
+    bag.manifest!(algo: 'sha256')
 
 Example: validating an existing bag
 -----------------------------------

data/Rakefile

@@ -1,16 +1,19 @@
-require 'rubygems'
-require 'bundler/setup'
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
 Bundler.setup(:default, :development, :test)
 
-require 'rake'
-require 'rdoc/task'
-require 'rspec/core/rake_task'
+require "rake"
+require "rdoc/task"
+require "rspec/core/rake_task"
+require "standard/rake"
 
 Bundler::GemHelper.install_tasks
 
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
-  t.rspec_opts = %w(--format  documentation --color)
+  t.pattern = "spec/**/*_spec.rb"
+  t.rspec_opts = %w[--format documentation --color]
 end
 
-task :default => [:spec]
+task default: [:standard, :spec]

data/bagit.gemspec

@@ -1,30 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bagit/version'
+require "bagit/version"
 
 Gem::Specification.new do |spec|
-  spec.name        = "bagit"
-  spec.version     = BagIt::VERSION
-  spec.summary     = "BagIt package generation and validation"
+  spec.name = "bagit"
+  spec.version = BagIt::VERSION
+  spec.summary = "BagIt package generation and validation"
   spec.description = "Ruby Library and Command Line tools for bagit"
-  spec.email       = "jamie@jamielittle.org"
-  spec.homepage    = 'http://github.com/tipr/bagit'
-  spec.authors     = ["Tom Johnson, Francesco Lazzarino, Jamie Little"]
-  spec.license     = "MIT"
+  spec.email = "jamie@jamielittle.org"
+  spec.homepage = "http://github.com/tipr/bagit"
+  spec.authors = ["Tom Johnson, Francesco Lazzarino, Jamie Little"]
+  spec.license = "MIT"
+
+  spec.required_ruby_version = "~> 2.0"
 
-  spec.required_ruby_version = '~> 2.0'
-  
-  spec.add_dependency 'validatable', '~> 1.6'
-  spec.add_dependency 'docopt', '~> 0.5.0'
+  spec.add_dependency "validatable", "~> 1.6"
+  spec.add_dependency "docopt", "~> 0.5.0"
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.4'
-  spec.add_development_dependency 'rspec', '~> 3'
-  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "standard"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 end

data/bin/bagit

@@ -1,24 +1,25 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bagit'
 require 'docopt'
 require 'logger'
-
 logger = Logger.new(STDOUT)
 
 doc = <<DOCOPT
 BagIt.
 
-Usage: 
-  bagit add [-f <file>...] [-t <tagfile>...] BAGPATH
+Usage:
+  bagit add [-f <file>...] [-t <tagfile>...] [-a <algo>] BAGPATH
   bagit delete [-f <file>...] [-t <tagfile>...] BAGPATH
   bagit remove [-t <tagfile>...] BAGPATH
-  bagit validate [-o] BAGPATH 
+  bagit validate [-o] BAGPATH
   bagit manifest [-T] BAGPATH
-  bagit list [--tags | --all] BAGPATH 
+  bagit list [--tags | --all] BAGPATH
   bagit -h | --version
 
 Options:
+  -a             A selected hashing algorithm. (md5, sha1, sha256)
   -h --help      Show this help screen.
   --version      Show version.
   -f <file>      File to add to/delete from bag. Repeatable.
@@ -30,34 +31,36 @@ Options:
 
 DOCOPT
 
-  # Possible commands for bag-info write
-  # 
-  # bagit new [--source-organization <org>] [--organization-address <org-addr>] [--contact-name <contact>] 
-  #             [--contact-phone <phone>] [--contact-email <email>] [--external-description <ext-desc>] 
-  #             [--external-identifier <ext-id>] [--group-identifier <group-id>] [--count <count>] 
-  #             [--internal-sender-identifier <sender-id>] [--internal-sender-description <sender-desc>] 
-  #             [--bag-info-entry <label> <value>] [-f <file>...] [-t <tagfile>...] BAGPATH
+# Possible commands for bag-info write
+#
+# bagit new [--source-organization <org>] [--organization-address <org-addr>] [--contact-name <contact>]
+#             [--contact-phone <phone>] [--contact-email <email>] [--external-description <ext-desc>]
+#             [--external-identifier <ext-id>] [--group-identifier <group-id>] [--count <count>]
+#             [--internal-sender-identifier <sender-id>] [--internal-sender-description <sender-desc>]
+#             [--bag-info-entry <label> <value>] [-f <file>...] [-t <tagfile>...] BAGPATH
 
 begin
-  opts = Docopt::docopt(doc, version: BagIt::VERSION)
+  opts = Docopt.docopt(doc, version: BagIt::VERSION)
 
-  unless opts['validate']
-    bag = BagIt::Bag.new(opts['BAGPATH'])
-  end
+  bag = BagIt::Bag.new(opts['BAGPATH']) unless opts['validate']
   #####################################
   # commands that don't alter the bag #
   #####################################
   if opts['validate']
-    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
+    bag = BagIt::Bag.new(opts['BAGPATH'])
+
+    valid = if opts['--oxum']
+              bag.valid_oxum?
+            else
+              bag.valid?
+            end
+
+    if valid
+      logger.info(valid)
     else
-      logger.error("Not a valid bag")
+      logger.error("#{valid}: #{bag.errors.full_messages.join(', ')}")
     end
+
     # validation commands MUST NOT change manifest or bag-info files
     exit
   end
@@ -74,59 +77,52 @@ begin
     exit
   end
 
-
   ######################################
   # commands that may cause data loss! #
   ######################################
 
-  #TODO: implement delete for data and tag files; remove for tag files.
+  # TODO: implement delete for data and tag files; remove for tag files.
 
   # handle add/delete bag data files
-  unless opts['-f'].nil? 
-    #TODO: add files in nested directories
-    opts['-f'].each { |datafile|
-      begin
-        if opts['add'] or opts['new']
-          bag.add_file(File.basename(datafile), datafile)
-        elsif opts['delete']
-          bag.remove_file(File.basename(datafile))
-        end
-      rescue Exception => e
-        logger.error("Failed operation on bag file: #{e.message}")
-      end
-    }  
+  opts['-f']&.each do |datafile|
+    if opts['add'] || opts['new']
+      bag.add_file(File.basename(datafile), datafile)
+    elsif opts['delete']
+      bag.remove_file(File.basename(datafile))
+    end
+  rescue StandardError => e
+    logger.error("Failed operation on bag file: #{e.message}")
   end
 
   # handle adding tag files
-  unless opts['-t'].nil? 
-    #TODO: add files in nested directories
-    opts['-t'].each { |tagfile|
-      begin
-        if opts['add'] or opts['new']
-          # if it does, try to manifest it
-          if File.exist?(File.join(bag.bag_dir, File.basename(tagfile)))
-            bag.add_tag_file(tagfile)
-            # otherwise, add it
-          else
-            bag.add_tag_file(File.basename(tagfile), tagfile)
-          end
-        elsif opts['delete']
-          bag.delete_tag_file(File.basename(tagfile))
-        elsif opts['remove']
-          bag.remove_tag_file(File.basename(tagfile))
-        end
-      rescue Exception => e
-        logger.error("Failed operation on tag file: #{e.message}".red)
+  opts['-t']&.each do |tagfile|
+    if opts['add'] || opts['new']
+      # if it does, try to manifest it
+      if File.exist?(File.join(bag.bag_dir, File.basename(tagfile)))
+        bag.add_tag_file(tagfile)
+        # otherwise, add it
+      else
+        bag.add_tag_file(File.basename(tagfile), tagfile)
       end
-    }
+    elsif opts['delete']
+      bag.delete_tag_file(File.basename(tagfile))
+    elsif opts['remove']
+      bag.remove_tag_file(File.basename(tagfile))
+    end
+  rescue StandardError => e
+    logger.error("Failed operation on tag file: #{e.message}".red)
   end
 
   # if we haven't quit yet, we need to re-manifest
-  # only do tags if tag files have been explictly added/removed or it is explictly called 
-  bag.tagmanifest! if opts['-T'] or not opts['-t'].nil?
-  bag.manifest!
+  # only do tags if tag files have been explictly added/removed or it is explictly called
+  bag.tagmanifest! if opts['-T'] || !opts['-t'].nil?
+
+  if opts['-a'].nil?
+    bag.manifest!
+  else
+    bag.manifest!(algo: opts['<algo>'])
+  end
 
 rescue Docopt::Exit => e
   logger.error(e.message.red)
 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'
+  SPEC_VERSION = "0.97"
 end

data/lib/bagit/bag.rb

@@ -1,48 +1,43 @@
-require 'bagit/fetch'
-require 'bagit/file'
-require 'bagit/info'
-require 'bagit/manifest'
-require 'bagit/string'
-require 'bagit/valid'
+# frozen_string_literal: true
+
+require "bagit/fetch"
+require "bagit/file"
+require "bagit/info"
+require "bagit/manifest"
+require "bagit/string"
+require "bagit/valid"
 
 module BagIt
   # Represents the state of a bag on a filesystem
   class Bag
     attr_reader :bag_dir
 
-    include Validity            # Validity functionality
-    include Info                # bagit & bag info functionality
-    include Manifest            # manifest related functionality
-    include Fetch               # fetch related functionality
+    include Validity # Validity functionality
+    include Info # bagit & bag info functionality
+    include Manifest # manifest related functionality
+    include Fetch # fetch related functionality
 
     # Make a new Bag based at path
-    def initialize(path, info={}, create=false)
-    
-        
+    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
+      FileUtils.mkdir bag_dir unless File.directory? bag_dir
+      FileUtils.mkdir data_dir unless File.directory? data_dir
 
       # write some tag info if its not there
-      unless File.exist? bagit_txt_file
-        write_bagit("BagIt-Version" => SPEC_VERSION, "Tag-File-Character-Encoding" => "UTF-8")
-      end
+      write_bagit("BagIt-Version" => SPEC_VERSION, "Tag-File-Character-Encoding" => "UTF-8") unless File.exist? bagit_txt_file
 
-      unless File.exist? bag_info_txt_file
-        write_bag_info(info)
-      end
-     
+      write_bag_info(info) unless File.exist? bag_info_txt_file
     end
 
     # Return the path to the data directory
     def data_dir
-      File.join @bag_dir, 'data'
+      File.join @bag_dir, "data"
     end
 
     # Return the paths to each bag file relative to bag_dir
     def bag_files
-      Dir[File.join(data_dir, '**', '*')].select { |f| File.file? f }
+      Dir[File.join(data_dir, "**", "*")].select { |f| File.file? f }
     end
 
     # Return the paths to each tag file relative to bag_dir
@@ -50,65 +45,66 @@ module BagIt
       files = []
       if tagmanifest_files != []
         File.open(tagmanifest_files.first) do |f|
-          f.each_line{|line| files << File.join(@bag_dir, line.split(' ')[1])}
+          f.each_line { |line| files << File.join(@bag_dir, line.split(" ")[1]) }
         end
       end
       files
     end
 
-    # Add a bag file
-    def add_file(base_path, src_path=nil)
-      path = File.join(data_dir, base_path)
-      raise "Bag file exists: #{base_path}" if File.exist? path
-      FileUtils::mkdir_p File.dirname(path)
+    # Add a bag file at the given path relative to data_dir
+    def add_file(relative_path, src_path = nil)
+      path = File.join(data_dir, relative_path)
+      raise "Bag file exists: #{relative_path}" if File.exist? path
+      FileUtils.mkdir_p File.dirname(path)
 
-      if src_path.nil?
-        f = File.open(path, 'w') { |io| yield io }
+      f = if src_path.nil?
+        File.open(path, "w") { |io| yield io }
       else
-        f = FileUtils::cp src_path, path
+        FileUtils.cp src_path, path
       end
       write_bag_info
-      return f
+      f
     end
 
-    # Remove a bag file
-    def remove_file(base_path)
-      path = File.join(data_dir, base_path)
-      raise "Bag file does not exist: #{base_path}" unless File.exist? path
-      FileUtils::rm path
+    # Remove a bag file at the given path relative to data_dir
+    def remove_file(relative_path)
+      path = File.join(data_dir, relative_path)
+      raise "Bag file does not exist: #{relative_path}" unless File.exist? path
+      FileUtils.rm path
     end
 
-    # Retrieve the IO handle for a file in the bag
-    def get(base_path)
-      path = File.join(data_dir, base_path)
+    # Retrieve the IO handle for a file in the bag at a given path relative to
+    # data_dir
+    def get(relative_path)
+      path = File.join(data_dir, relative_path)
       return nil unless File.exist?(path)
       File.open(path)
     end
 
     # Test if this bag is empty (no files)
     def empty?
-      self.bag_files.empty?
+      bag_files.empty?
     end
 
     # Get all bag file paths relative to the data dir
     def paths
-      self.bag_files.collect { |f| f.sub(data_dir + '/', '') }
+      bag_files.collect { |f| f.sub(data_dir + "/", "") }
     end
 
     # Get the Oxum for the payload files
     def payload_oxum
       bytes = 0
       bag_files.each do |f|
-        #TODO: filesystem quirks? Are we getting the stream size or the size on disk?
+        # TODO: filesystem quirks? Are we getting the stream size or the size on disk?
         bytes += File.size(f)
       end
-      return bytes.to_s + '.' + bag_files.count.to_s
+      bytes.to_s + "." + bag_files.count.to_s
     end
 
     # Remove all empty directory trees from the bag
     def gc!
       Dir.entries(data_dir).each do |f|
-        unless %w{.. .}.include? f
+        unless %w[.. .].include? f
           abs_path = File.join data_dir, f
           File.clean abs_path
         end