bagit 0.3.0.pre → 0.3.0

data/README.md

@@ -45,9 +45,18 @@ Example: validating an existing bag
       puts "#{existing_base_path} is not valid"
     end
 
+Console Tool
+------------
+    # create a new bag/add files to existing bag
+    bagit add -f file1 file2 -t tagfile1 tagfile2 ./path/to/bag	
+    # validate
+    bagit validate ./path/to/bag
+    # for other commands
+    bagit --help
+
 TODO
 ----
-* command line tools for common tasks
+* deep directory add/delete for bag and tag files in console tools
 * better holy bag (fetch.txt) generation
 * better error reporting.
 
@@ -55,8 +64,8 @@ TODO
 
 Copyright © 2009, [Francesco Lazzarino](mailto:flazzarino@gmail.com).
 
-Current Maintainer: [Tom Johnson](mailto:thomas.johnson@oregonstate.edu).
+Current maintainer: [Tom Johnson](mailto:thomas.johnson@oregonstate.edu).
 
-Sponsored by [Florida Center for Library Automation](http://www.fcla.edu).
+Initial development sponsored by [Florida Center for Library Automation](http://www.fcla.edu).
 
 See LICENSE.txt for terms.

data/bagit.gemspec

@@ -1,7 +1,7 @@
 
 BAGIT_SPEC = Gem::Specification.new do |spec|
   spec.name        = "bagit"
-  spec.version     = '0.3.0.pre'
+  spec.version     = '0.3.0'
   spec.summary     = "BagIt package generation and validation"
   spec.description = "Ruby Library and Command Line tools for bagit"
   spec.email       = "johnson.tom@gmail.com"
@@ -11,4 +11,5 @@ BAGIT_SPEC = Gem::Specification.new do |spec|
   spec.add_dependency 'validatable', '~> 1.6'
 
   spec.files = %w(Rakefile README.md LICENSE.txt bagit.gemspec) + Dir["lib/**/*.rb"]
+  spec.executables << 'bagit'
 end

data/bin/bagit

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+
+require 'bagit'
+require 'docopt'
+
+doc = <<DOCOPT
+BagIt.
+
+Usage: 
+  #{__FILE__} add [-f <file>...] [-t <tagfile>...] BAGPATH
+  #{__FILE__} delete [-f <file>...] [-t <tagfile>...] BAGPATH
+  #{__FILE__} remove [-t <tagfile>...] BAGPATH
+  #{__FILE__} validate [-o] BAGPATH 
+  #{__FILE__} manifest [-T] BAGPATH
+  #{__FILE__} list [--tags | --all] BAGPATH 
+  #{__FILE__} -h | --version
+
+Options:
+  -h --help      Show this help screen.
+  --version      Show version.
+  -f <file>      File to add to/delete from bag. Repeatable.
+  -t <tag_file>  Tag (metadata) file to add to/delete/remove from bag. Repeatable.
+  -T             Force regeneration of tag manifest files.
+  -o --oxum      Validate against oxum only (quick validate).
+  --tags         List tag files.
+  --all          List all data and tag files.
+
+DOCOPT
+
+  # Possible commands for bag-info write
+  # 
+  # #{__FILE__} 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 0.3.0')
+  
+  bag = BagIt::Bag.new(opts['BAGPATH'])
+
+  #####################################
+  # commands that don't alter the bag #
+  #####################################
+  if opts['validate']
+    if opts['--oxum']
+      puts bag.valid_oxum?.to_s
+    else
+      puts bag.valid?.to_s
+    end
+    # validation commands MUST NOT change manifest or bag-info files
+    exit
+  end
+
+  if opts['list']
+    files = bag.bag_files
+    if opts['--tags']
+      files = bag.tag_files
+    elsif opts['--all']
+      files = bag.bag_files + bag.tag_files
+    end
+    files.each { |f| puts f }
+    # quit here, too
+    exit
+  end
+
+
+  ######################################
+  # commands that may cause data loss! #
+  ######################################
+
+  #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
+        puts "Failed operation on bag file: #{e.message}"
+      end
+    }  
+  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
+        puts "Failed operation on tag file: #{e.message}"
+      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.manifest!
+
+rescue Docopt::Exit => e
+  puts e.message
+end
+

data/lib/bagit/manifest.rb

@@ -124,8 +124,7 @@ module BagIt
     def delete_tag_file(path)
       filepath = File.join(@bag_dir, path)
       raise "Tag file does not exist: #{path}" unless File.exist? filepath
-      #TODO: delete tags even when they are not in the manifest
-      remove_tag_file(path)
+      remove_tag_file(path) if tag_files.include?(path)
       FileUtils::rm filepath
     end
 

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: bagit
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre
+  version: 0.3.0
+  prerelease: 
 platform: ruby
 authors:
 - Tom Johnson, Francesco Lazzarino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validatable
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,13 +22,15 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 description: Ruby Library and Command Line tools for bagit
 email: johnson.tom@gmail.com
-executables: []
+executables:
+- bagit
 extensions: []
 extra_rdoc_files: []
 files:
@@ -35,35 +39,36 @@ files:
 - LICENSE.txt
 - bagit.gemspec
 - lib/bagit.rb
-- lib/bagit/bag.rb
 - lib/bagit/string.rb
+- lib/bagit/fetch.rb
 - lib/bagit/manifest.rb
 - lib/bagit/info.rb
 - lib/bagit/file.rb
 - lib/bagit/valid.rb
-- lib/bagit/fetch.rb
+- lib/bagit/bag.rb
+- bin/bagit
 homepage: http://github.com/tipr/bagit
 licenses: []
-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'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: BagIt package generation and validation
 test_files: []
-has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjFkNDZjYTUzYmMyOGZlMWZiOGM5YTJiMGU3ODM1ODRkNzYzZTY1OA==
-  data.tar.gz: !binary |-
-    NzU1ODcwNmZhZTI4NmE1YWJmMjNhN2FiNmYwNTFlMzhmMDFjZjY5OA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZWJjMjYyYjk5NTMzNDgzMmYyNDE3NjM2YWRjNWUxMzk2NzM4NzAwMWVkY2Qy
-    ODRiODllOGRkZmE5YTYxN2Q5NGZjNjdjZTMwZDdjNGJlMTY5NTFkOWVhMGMy
-    MGJhYjFlNzAwNWQ2NmI5ZDk5ZDUxN2VkNDQxNjY0YTNmYjI1YTc=
-  data.tar.gz: !binary |-
-    YWFhNTcwZWU3OGU4Y2NiNzQ0NjYzM2ZjZmZjMmVlZDRiNTk2YjBlOWE4ZTkx
-    NTM0Y2MxMmI1ZDhkMzYxOWY2OTNkOTQ1NGJmYWIwY2YwNzYwZjNiNmE3YWM4
-    YmYwODE4Yzc5MWVmMjhmZDM4YzY4OWZlZmQ3Y2RiODdhYjA4Mjc=