bagit 0.1.0 → 0.2.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Francesco Lazzarino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+BagIt (for ruby)
+================
+
+Based on the [BagItspec v0.96](https://confluence.ucop.edu/display/Curation/BagIt).
+
+Supported Features:
+-------------------
+* bag compiling
+* manifest & tagmanifest generation
+* generation of tag files bag-info.txt and bagit.txt
+* fetching remote files (fetch.txt)
+* bag validation
+
+Installation
+------------
+    % gem install bagit validatable
+The rubyforge gem is deprecated.
+
+
+Example: making a bag
+---------------------
+    require 'bagit'
+
+    # make a new bag at base_path
+    bag = BagIt::Bag.new base_path
+
+    # make a new file
+    bag.add_file("samplefile") do |io|
+      io.puts "Hello Bag!"
+    end
+
+    # generate the manifest and tagmanifest files
+    bag.manifest!
+
+Example: validating an existing bag
+-----------------------------------
+
+    bag = BagIt::Bag.new existing_base_path
+
+    if bag.valid?
+      puts "#{existing_base_path} is valid"
+    else
+      puts "#{existing_base_path} is not valid"
+    end
+
+TODO
+----
+* command line tools for common tasks
+* better holy bag (fetch.txt) generation
+* better error reporting.
+* poor mans' checksum
+
+---
+
+Copyright © 2009, [Francesco Lazzarino](mailto:flazzarino@gmail.com).
+
+Sponsored by [Florida Center for Library Automation](http://www.fcla.edu).
+
+See LICENSE.txt for terms.

data/Rakefile

@@ -1,14 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup(:default, :development, :test)
+
 require 'rake'
-require 'rake/rdoctask'
-require 'spec/rake/spectask'
-
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.libs << 'lib'
-  t.libs << 'spec'
-  t.spec_opts << "--color"
-#   t.warning = true
-#   t.rcov = true
-#   t.rcov_opts += ["-x /Library", "-x spec"]
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = %w(-fs --color)
 end
 
 task :default => [:spec]

data/bagit.gemspec

@@ -1,20 +1,13 @@
-require 'semver'
-
-Gem::Specification.new do |spec|
-  spec.name = "bagit"
-  spec.version = SemVer.find.format '%M.%m.%p'
-  spec.summary = "BagIt package generation and validation"
+BAGIT_SPEC = Gem::Specification.new do |spec|
+  spec.name        = "bagit"
+  spec.version     = '0.2.0'
+  spec.summary     = "BagIt package generation and validation"
   spec.description = "Ruby Library and Command Line tools for bagit"
-  spec.email = "flazzarino@gmail.com"
-  spec.homepage = 'http://github.com/flazz/bagit'
-  spec.authors = ["Francesco Lazzarino"]
+  spec.email       = "flazzarino@gmail.com"
+  spec.homepage    = 'http://github.com/flazz/bagit'
+  spec.authors     = ["Francesco Lazzarino"]
 
-  spec.files = ["Rakefile", "bagit.gemspec", "lib/bagit/bag.rb",
-                "lib/bagit/fetch.rb", "lib/bagit/file.rb",
-                "lib/bagit/info.rb", "lib/bagit/manifest.rb",
-                "lib/bagit/string.rb", "lib/bagit/valid.rb",
-                "lib/bagit.rb" ]
+  spec.add_dependency 'validatable', '~> 1.6'
 
-  spec.has_rdoc = true
-  spec.add_dependency 'semver', '~> 0.1.0'
+  spec.files = %w(Rakefile README.md LICENSE.txt bagit.gemspec) + Dir["lib/**/*.rb"]
 end

data/lib/bagit.rb

@@ -7,5 +7,5 @@ require 'bagit/bag'
 
 module BagIt
   # The version of the BagIt specification the code is conforming to.
-  SPEC_VERSION = '0.96'             
+  SPEC_VERSION = '0.96'
 end

data/lib/bagit/bag.rb

@@ -9,7 +9,6 @@ module BagIt
 
   # Represents the state of a bag on a filesystem
   class Bag
-
     attr_reader :bag_dir
 
     include Validity            # Validity functionality
@@ -24,7 +23,7 @@ module BagIt
       # 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
-      
+
       # 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")
@@ -33,7 +32,6 @@ module BagIt
       unless File.exist? bag_info_txt_file
         write_bag_info('Bag-Software-Agent' => "BagIt Ruby Gem (http://bagit.rubyforge.org)")
       end
-      
     end
 
     # Return the path to the data directory
@@ -62,30 +60,40 @@ module BagIt
       else
         FileUtils::cp src_path, path
       end
-      
     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
     end
-
+    
+    # Retrieve the IO handle for a file in the bag
+    def get(base_path)
+      path = File.join(data_dir, base_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?
+    end
+    
+    # Get all bag file paths relative to the data dir
+    def paths
+      self.bag_files.collect { |f| f.sub(data_dir + '/', '') }
+    end
+    
     # Remove all empty directory trees from the bag
     def gc!
-      
       Dir.entries(data_dir).each do |f|
-        
         unless %w{.. .}.include? f
           abs_path = File.join data_dir, f
           File.clean abs_path
         end
-        
       end
-      
     end
-
   end
-
 end

data/lib/bagit/valid.rb

@@ -1,12 +1,11 @@
-require 'rubygems'
 require 'validatable'
 
 module BagIt
 
   class Bag
     include Validatable
-    validates_true_for :consistency, :logic => lambda { complete? }
-    validates_true_for :completeness, :logic => lambda { consistent? }
+    validates_true_for :consistency, :logic => Proc.new { complete? }
+    validates_true_for :completeness, :logic => Proc.new { consistent? }
   end
 
   module Validity

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: bagit
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors: 
 - Francesco Lazzarino
@@ -15,23 +10,17 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-28 00:00:00 -04:00
-default_executable: 
+date: 2011-06-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: semver
+  name: validatable
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 1
-        - 0
-        version: 0.1.0
+        version: "1.6"
   type: :runtime
   version_requirements: *id001
 description: Ruby Library and Command Line tools for bagit
@@ -44,6 +33,8 @@ extra_rdoc_files: []
 
 files: 
 - Rakefile
+- README.md
+- LICENSE.txt
 - bagit.gemspec
 - lib/bagit/bag.rb
 - lib/bagit/fetch.rb
@@ -53,7 +44,6 @@ files:
 - lib/bagit/string.rb
 - lib/bagit/valid.rb
 - lib/bagit.rb
-has_rdoc: true
 homepage: http://github.com/flazz/bagit
 licenses: []
 
@@ -67,23 +57,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.3
 signing_key: 
 specification_version: 3
 summary: BagIt package generation and validation