bagit 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fad8acbb5bb1291e22988803875886a17a8fb569
-  data.tar.gz: a85c86ea03545525a408d29b82b6ffdc0de7ac2b
+  metadata.gz: 110811464b7bda7fe4a731155a75b09a4bfedb37
+  data.tar.gz: bd81624253f0d2faff9a80bc58579e18512bc577
 SHA512:
-  metadata.gz: cd98d4c2f70f6cd00d450981657e80e54ba0cb8c6394dd8b7a68069b736be44a4c23780c8bc98cb306c5e62afd3709a15f34c42df45d8613499651fca42923b8
-  data.tar.gz: 42ce0063033e43b1f328785f715b8b4e08a0bca0ae3186e4a505c2cef8a91b8adb694d70276f6abd3da0ab1a5b486c6b8d7651decf76fc86c1fb22230210c3c8
+  metadata.gz: 3754fafd47c4e53a58c7b802ac4761194577dc751ed124fd41179199b009707b169ff36bb144061a94c3494414a40ca47964257871e5d622371efd0c4f99359f
+  data.tar.gz: 10d1c42ed581a0f53018dbca881d9f4adb023d12e229fd6a7ed2c5a190b426e91b11b7ea417ef613b31f7fe6775dce09e71b362cc37205bf457fad91ac821929

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_gem:
+  bixby: bixby_default.yml
+Rails/Delegate:
+  Enabled: false
+Rails/Date:
+  Enabled: false
+RSpec/InstanceVariable:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+Style/Semicolon:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
+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

@@ -5,12 +5,18 @@ Bundler.setup(:default, :development, :test)
 require 'rake'
 require 'rdoc/task'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 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.rspec_opts = %w(--format  documentation --color)
+  t.rspec_opts = %w[--format documentation --color]
 end
 
-task :default => [:spec]
+task default: [:rubocop, :spec]

data/bagit.gemspec

@@ -18,14 +18,15 @@ Gem::Specification.new do |spec|
   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 'rake', '~> 10.4'
-  spec.add_development_dependency 'rspec', '~> 3'
   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.files         = `git ls-files`.split($/)
+  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"]

data/bin/bagit

@@ -31,36 +31,34 @@ 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']
     bag = BagIt::Bag.new(opts['BAGPATH'])
 
-    if opts['--oxum']
-      valid = bag.valid_oxum?
-    else
-      valid = bag.valid?
-    end
+    valid = if opts['--oxum']
+              bag.valid_oxum?
+            else
+              bag.valid?
+            end
 
     if valid
       logger.info(valid)
     else
-      logger.error("#{valid}: #{bag.errors.full_messages.join(', ')}" )
+      logger.error("#{valid}: #{bag.errors.full_messages.join(', ')}")
     end
 
     # validation commands MUST NOT change manifest or bag-info files
@@ -79,35 +77,34 @@ 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|
+    # TODO: add files in nested directories
+    opts['-f'].each do |datafile|
       begin
-        if opts['add'] or opts['new']
+        if opts['add'] || opts['new']
           bag.add_file(File.basename(datafile), datafile)
         elsif opts['delete']
           bag.remove_file(File.basename(datafile))
         end
-      rescue Exception => e
+      rescue StandardError => e
         logger.error("Failed operation on bag file: #{e.message}")
       end
-    }
+    end
   end
 
   # handle adding tag files
   unless opts['-t'].nil?
-    #TODO: add files in nested directories
-    opts['-t'].each { |tagfile|
+    # TODO: add files in nested directories
+    opts['-t'].each do |tagfile|
       begin
-        if opts['add'] or opts['new']
+        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)
@@ -120,20 +117,20 @@ begin
         elsif opts['remove']
           bag.remove_tag_file(File.basename(tagfile))
         end
-      rescue Exception => e
+      rescue StandardError => e
         logger.error("Failed operation on tag file: #{e.message}".red)
       end
-    }
+    end
   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.tagmanifest! if opts['-T'] || !opts['-t'].nil?
 
-  unless opts['-a'].nil?
-    bag.manifest!(algo: opts['<algo>'])
-  else
+  if opts['-a'].nil?
     bag.manifest!
+  else
+    bag.manifest!(algo: opts['<algo>'])
   end
 
 rescue Docopt::Exit => e

data/lib/bagit.rb

@@ -10,5 +10,5 @@ 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'.freeze
 end

data/lib/bagit/bag.rb

@@ -16,23 +16,16 @@ module BagIt
     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
@@ -50,32 +43,32 @@ 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 at the given path relative to data_dir
-    def add_file(relative_path, src_path=nil)
+    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)
+      FileUtils.mkdir_p File.dirname(path)
 
-      if src_path.nil?
-        f = File.open(path, 'w') { |io| yield io }
-      else
-        f = FileUtils::cp src_path, path
-      end
+      f = if src_path.nil?
+            File.open(path, 'w') { |io| yield io }
+          else
+            FileUtils.cp src_path, path
+          end
       write_bag_info
-      return f
+      f
     end
 
     # 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
+      FileUtils.rm path
     end
 
     # Retrieve the IO handle for a file in the bag at a given path relative to
@@ -88,28 +81,28 @@ module BagIt
 
     # 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

data/lib/bagit/fetch.rb

@@ -1,9 +1,7 @@
 require 'open-uri'
 
 module BagIt
-  
   module Fetch
-    
     def fetch_txt_file
       File.join @bag_dir, 'fetch.txt'
     end
@@ -16,35 +14,31 @@ module BagIt
 
     # feth all remote files
     def fetch!
-
       open(fetch_txt_file) do |io|
-        
         io.readlines.each do |line|
-          
-          (url, length, path) = line.chomp.split(/\s+/, 3)
-          
-          add_file(path) do |io|
-            io.write open(url)
+          (url, _length, path) = line.chomp.split(/\s+/, 3)
+
+          add_file(path) do |file_io|
+            file_io.write open(url)
           end
-          
         end
-        
       end
 
-      # rename the old fetch.txt
+      rename_old_fetch_txt(fetch_txt_file)
+      move_current_fetch_txt(fetch_txt_file)
+    end
+
+    def rename_old_fetch_txt(fetch_txt_file)
       Dir["#{fetch_txt_file}.?*"].sort.reverse.each do |f|
-        
         if f =~ /fetch.txt.(\d+)$/
-          new_f = File.join File.dirname(f), "fetch.txt.#{$1.to_i + 1}"
-          FileUtils::mv f, new_f
+          new_f = File.join File.dirname(f), "fetch.txt.#{Regexp.last_match(1).to_i + 1}"
+          FileUtils.mv f, new_f
         end
-        
       end
+    end
 
-      # move the current fetch_txt
-      FileUtils::mv fetch_txt_file, "#{fetch_txt_file}.0"
+    def move_current_fetch_txt(fetch_txt_file)
+      FileUtils.mv fetch_txt_file, "#{fetch_txt_file}.0"
     end
-    
   end
-  
 end

data/lib/bagit/file.rb

@@ -1,19 +1,14 @@
 class File
-
   # Clean out all the empty dirs
-  def File.clean(file_name)
-
-    if File.directory? file_name
-      # clean all subdirs
-      subdirs = Dir.entries(file_name).select { |p| File.directory?(File.join(file_name, p)) }
-      subdirs.reject! { |p| %w{. ..}.include? p }
-      subdirs.each { |sd| File.clean File.join(file_name, sd) }
-
-      # if its empty then delete it
-      contents = Dir.entries(file_name).reject { |p| %w{. ..}.include? p }
-      Dir.delete file_name if contents.empty?
-    end
-    
+  def self.clean(file_name)
+    return unless File.directory? file_name
+    # clean all subdirs
+    subdirs = Dir.entries(file_name).select { |p| File.directory?(File.join(file_name, p)) }
+    subdirs.reject! { |p| %w[. ..].include? p }
+    subdirs.each { |sd| File.clean File.join(file_name, sd) }
+
+    # if its empty then delete it
+    contents = Dir.entries(file_name).reject { |p| %w[. ..].include? p }
+    Dir.delete file_name if contents.empty?
   end
-
 end

data/lib/bagit/info.rb

@@ -1,25 +1,23 @@
 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
@@ -27,16 +25,14 @@ module BagIt
     end
 
     def bag_info
-      begin
-        read_info_file bag_info_txt_file
-      rescue
-        {}
-      end
+      read_info_file bag_info_txt_file
+    rescue
+      {}
     end
 
-    def write_bag_info(hash={})
+    def write_bag_info(hash = {})
       hash = bag_info.merge(hash)
-      hash[@@bag_info_headers[:agent]] = "BagIt Ruby Gem (http://bagit.rubyforge.org)" if hash[@@bag_info_headers[:agent]].nil?
+      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[:oxum]] = payload_oxum
       write_info_file bag_info_txt_file, hash
@@ -61,48 +57,38 @@ module BagIt
 
     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})
+          entries.inject({}) do |hash, line|
+            name, value = line.chomp.split(/\s*:\s*/, 2)
+            hash.merge(name => value)
+          end
         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) do |acc, key|
+          a = hash.keys.grep(/#{key}/i)
+          acc + (a.size > 1 ? a : [])
+        end
 
-      File.open(file, 'w') do |io|
+        raise "Multiple labels (#{dups.to_a.join ', '}) in #{file}" unless dups.empty?
 
-        hash.each do |name, value|
-          simple_entry = "#{name}: #{value.gsub /\s+/, ' '}"
+        File.open(file, 'w') do |io|
+          hash.each do |name, value|
+            simple_entry = "#{name}: #{value.gsub(/\s+/, ' ')}"
 
-          entry = if simple_entry.length > 79
-                    simple_entry.wrap(77).indent(2)
-                  else
-                    simple_entry
-                  end
+            entry = if simple_entry.length > 79
+                      simple_entry.wrap(77).indent(2)
+                    else
+                      simple_entry
+                    end
 
-          io.puts entry
+            io.puts entry
+          end
         end
-
       end
-
-    end
-
   end
-
 end