bagit 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 110811464b7bda7fe4a731155a75b09a4bfedb37
-  data.tar.gz: bd81624253f0d2faff9a80bc58579e18512bc577
+SHA256:
+  metadata.gz: e7fadd34fdac2ef57b5f9dd0746566eab445503621052ceba3106519e3961cbe
+  data.tar.gz: 9e80ad8ca552eac4267620e420b3467cefa46cf88955b94697b6e0dfda060ccb
 SHA512:
-  metadata.gz: 3754fafd47c4e53a58c7b802ac4761194577dc751ed124fd41179199b009707b169ff36bb144061a94c3494414a40ca47964257871e5d622371efd0c4f99359f
-  data.tar.gz: 10d1c42ed581a0f53018dbca881d9f4adb023d12e229fd6a7ed2c5a190b426e91b11b7ea417ef613b31f7fe6775dce09e71b362cc37205bf457fad91ac821929
+  metadata.gz: 390236a9a4aa9cf50374d016b5fe14f11ec56c6430cdf6e36ec6160a5ceb95abb49b5c17733ad1fe1b598209bd9c1c9bcf8b14f356fb3d6bd6fabd2f5de91252
+  data.tar.gz: ff17dd90c78f4c9ba25ca49d2952ca0b87078a27756368f2948dadbd5f4318a5afa43b1569190fefabfa554812c902e6df5e26358b31bf91d2490db032742d94

data/.gitignore

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

data/Gemfile

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

data/Rakefile

@@ -1,22 +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 'rubocop/rake_task'
+require "rake"
+require "rdoc/task"
+require "rspec/core/rake_task"
+require "standard/rake"
 
 Bundler::GemHelper.install_tasks
 
-desc 'Run rubocop'
-task :rubocop do
-  RuboCop::RakeTask.new
-end
-
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
+  t.pattern = "spec/**/*_spec.rb"
   t.rspec_opts = %w[--format documentation --color]
 end
 
-task default: [:rubocop, :spec]
+task default: [:standard, :spec]

data/bagit.gemspec

@@ -1,33 +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", "< 3.2"
 
-  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 'bixby'
-  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', '~> 10.4'
-  spec.add_development_dependency 'rspec', '~> 3'
+  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($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.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,9 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bagit'
 require 'docopt'
 require 'logger'
-require 'pry'
 logger = Logger.new(STDOUT)
 
 doc = <<DOCOPT
@@ -84,43 +84,33 @@ begin
   # 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 do |datafile|
-      begin
-        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
+  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 do |tagfile|
-      begin
-        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)
+  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

data/lib/bagit/bag.rb

@@ -1,19 +1,21 @@
-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)
@@ -30,12 +32,12 @@ module BagIt
 
     # 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
@@ -43,7 +45,7 @@ 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
@@ -56,10 +58,10 @@ module BagIt
       FileUtils.mkdir_p File.dirname(path)
 
       f = if src_path.nil?
-            File.open(path, 'w') { |io| yield io }
-          else
-            FileUtils.cp src_path, path
-          end
+        File.open(path, "w") { |io| yield io }
+      else
+        FileUtils.cp src_path, path
+      end
       write_bag_info
       f
     end
@@ -86,7 +88,7 @@ module BagIt
 
     # Get all bag file paths relative to the data dir
     def paths
-      bag_files.collect { |f| f.sub(data_dir + '/', '') }
+      bag_files.collect { |f| f.sub(data_dir + "/", "") }
     end
 
     # Get the Oxum for the payload files
@@ -96,7 +98,7 @@ module BagIt
         # TODO: filesystem quirks? Are we getting the stream size or the size on disk?
         bytes += File.size(f)
       end
-      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

data/lib/bagit/fetch.rb

@@ -1,25 +1,27 @@
-require 'open-uri'
+# frozen_string_literal: true
+
+require "open-uri"
 
 module BagIt
   module Fetch
     def fetch_txt_file
-      File.join @bag_dir, 'fetch.txt'
+      File.join @bag_dir, "fetch.txt"
     end
 
     def add_remote_file(url, path, size, sha1, md5)
-      open(fetch_txt_file, 'a') { |io| io.puts "#{url} #{size || '-'} #{path}" }
-      open(manifest_file('sha1'), 'a') { |io| io.puts "#{sha1} #{File.join 'data', path}" }
-      open(manifest_file('md5'), 'a') { |io| io.puts "#{md5} #{File.join 'data', path}" }
+      File.open(fetch_txt_file, "a") { |io| io.puts "#{url} #{size || "-"} #{path}" }
+      File.open(manifest_file("sha1"), "a") { |io| io.puts "#{sha1} #{File.join "data", path}" }
+      File.open(manifest_file("md5"), "a") { |io| io.puts "#{md5} #{File.join "data", path}" }
     end
 
     # feth all remote files
     def fetch!
-      open(fetch_txt_file) do |io|
+      File.open(fetch_txt_file) do |io|
         io.readlines.each do |line|
           (url, _length, path) = line.chomp.split(/\s+/, 3)
 
           add_file(path) do |file_io|
-            file_io.write open(url)
+            file_io.write URI.open(url)
           end
         end
       end
@@ -29,7 +31,7 @@ module BagIt
     end
 
     def rename_old_fetch_txt(fetch_txt_file)
-      Dir["#{fetch_txt_file}.?*"].sort.reverse.each do |f|
+      Dir["#{fetch_txt_file}.?*"].sort.reverse_each do |f|
         if f =~ /fetch.txt.(\d+)$/
           new_f = File.join File.dirname(f), "fetch.txt.#{Regexp.last_match(1).to_i + 1}"
           FileUtils.mv f, new_f

data/lib/bagit/file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class File
   # Clean out all the empty dirs
   def self.clean(file_name)

data/lib/bagit/info.rb

@@ -1,27 +1,29 @@
-require 'set'
+# frozen_string_literal: true
+
+require "set"
 
 module BagIt
   module Info
     @@bag_info_headers = {
-      agent: 'Bag-Software-Agent',
-      org: 'Source-Organization',
-      org_addr: 'Organization-Address',
-      contact_name: 'Contact-Name',
-      contact_phone: 'Contact-Phone',
-      contact_email: 'Contact-Email',
-      ext_desc: 'External-Description',
-      ext_id: 'External-Identifier',
-      size: 'Bag-Size',
-      group_id: 'Bag-Group-Identifier',
-      group_count: 'Bag-Count',
-      sender_id: 'Internal-Sender-Identifier',
-      int_desc: 'Internal-Sender-Description',
-      date: 'Bagging-Date',
-      oxum: 'Payload-Oxum'
+      agent: "Bag-Software-Agent",
+      org: "Source-Organization",
+      org_addr: "Organization-Address",
+      contact_name: "Contact-Name",
+      contact_phone: "Contact-Phone",
+      contact_email: "Contact-Email",
+      ext_desc: "External-Description",
+      ext_id: "External-Identifier",
+      size: "Bag-Size",
+      group_id: "Bag-Group-Identifier",
+      group_count: "Bag-Count",
+      sender_id: "Internal-Sender-Identifier",
+      int_desc: "Internal-Sender-Description",
+      date: "Bagging-Date",
+      oxum: "Payload-Oxum"
     }
 
     def bag_info_txt_file
-      File.join bag_dir, 'bag-info.txt'
+      File.join bag_dir, "bag-info.txt"
     end
 
     def bag_info
@@ -33,13 +35,13 @@ module BagIt
     def write_bag_info(hash = {})
       hash = bag_info.merge(hash)
       hash[@@bag_info_headers[:agent]] = "BagIt Ruby Gem (https://github.com/tipr/bagit)" if hash[@@bag_info_headers[:agent]].nil?
-      hash[@@bag_info_headers[:date]] = Date.today.strftime('%Y-%m-%d') if hash[@@bag_info_headers[:date]].nil?
+      hash[@@bag_info_headers[:date]] = Date.today.strftime("%Y-%m-%d") if hash[@@bag_info_headers[:date]].nil?
       hash[@@bag_info_headers[:oxum]] = payload_oxum
       write_info_file bag_info_txt_file, hash
     end
 
     def bagit_txt_file
-      File.join bag_dir, 'bagit.txt'
+      File.join bag_dir, "bagit.txt"
     end
 
     def bagit
@@ -51,44 +53,44 @@ module BagIt
     end
 
     def update_bag_date
-      hash["Bagging-Date"] = Date.today.strftime('%Y-%m-%d')
+      hash["Bagging-Date"] = Date.today.strftime("%Y-%m-%d")
       write_bag_info(hash)
     end
 
     protected
 
-      def read_info_file(file)
-        File.open(file) do |io|
-          entries = io.read.split(/\n(?=[^\s])/)
+    def read_info_file(file)
+      File.open(file) do |io|
+        entries = io.read.split(/\n(?=[^\s])/)
 
-          entries.inject({}) do |hash, line|
-            name, value = line.chomp.split(/\s*:\s*/, 2)
-            hash.merge(name => value)
-          end
+        entries.inject({}) do |hash, line|
+          name, value = line.chomp.split(/\s*:\s*/, 2)
+          hash.merge(name => value)
         end
       end
+    end
 
-      def write_info_file(file, hash)
-        dups = hash.keys.inject(Set.new) do |acc, key|
-          a = hash.keys.grep(/#{key}/i)
-          acc + (a.size > 1 ? a : [])
-        end
-
-        raise "Multiple labels (#{dups.to_a.join ', '}) in #{file}" unless dups.empty?
+    def write_info_file(file, hash)
+      dups = hash.keys.inject(Set.new) { |acc, key|
+        a = hash.keys.grep(/#{key}/i)
+        acc + (a.size > 1 ? a : [])
+      }
 
-        File.open(file, 'w') do |io|
-          hash.each do |name, value|
-            simple_entry = "#{name}: #{value.gsub(/\s+/, ' ')}"
+      raise "Multiple labels (#{dups.to_a.join ", "}) in #{file}" unless dups.empty?
 
-            entry = if simple_entry.length > 79
-                      simple_entry.wrap(77).indent(2)
-                    else
-                      simple_entry
-                    end
+      File.open(file, "w") do |io|
+        hash.each do |name, value|
+          simple_entry = "#{name}: #{value.gsub(/\s+/, " ")}"
 
-            io.puts entry
+          entry = if simple_entry.length > 79
+            simple_entry.wrap(77).indent(2)
+          else
+            simple_entry
           end
+
+          io.puts entry
         end
       end
+    end
   end
 end

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