fixi 0.0.2 → 0.1.0

data/.gitignore

@@ -4,3 +4,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage

data/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,170 @@
+# Overview
+
+Fixi is a command-line utility, written in Ruby, that indexes, verifies, and
+updates checksum information for collections of files.
+
+Tracking fixity is an important part of any digital preservation strategy,
+and fixi aims to help with that in as unobtrusive a manner as possible.
+
+## Features
+
+* Works with any pre-existing directory layout scheme.
+* Keeps the index in a single ".fixi" directory at the root of the collection
+* Supports regular expression-based includes and excludes
+* Supports any combination of md5, sha1, sha256, sha384, and sha512
+* Supports shallow (fast) and deep (checksum-based) fixity checking
+* Support export and import of BagIt bags
+* Supports fast lookups of files by checksum
+
+# Installation
+
+Releases of Fixi are published to rubygems.org, so you can install them the
+usual way:
+
+    [sudo] gem install fixi
+
+Or you can install from source via:
+
+    [sudo] rake install
+
+*NOTE: Fixi uses sqlite3, which will need to be built if it's not already on
+your system.*
+
+If you are using Ubuntu and you get an error about building sqlite, you may
+need to install both the ruby1.9.1-dev and the libsqlite3-dev packages:
+
+    [sudo] apt-get install ruby1.9.1-dev libsqlite3-dev
+
+Similar steps may be necessary for other distros and operating systems.
+
+# General Usage
+    fixi [--version] [--help] <command> [<options>] [<args>]
+
+## Global Options:
+    --version, -v:   Display the version and exit.
+       --help, -h:   Show general or command-specific help
+
+See below for command-specific usage and options.
+
+# add: Add new files to the index
+
+## Usage:
+    fixi add [<options>] [<dir> | <file>]
+
+## Options:
+    --absolute, -a:   Show absolute paths. By default, paths are reported
+                      relative to the index root.
+     --dry-run, -d:   Don't do anything; just report what would be done
+
+# bag: Export files as a new BagIt bag
+
+## Usage:
+    fixi bag [<options>] <input-dir> <output-dir>
+
+## Where:
+    input-dir is an indexed directory whose content should be exported.
+    output-dir is the base directory of the bag to be created.
+
+## Options:
+    --algorithms, -l <s>:   Checksum algorithm(s) to use for the bag. This is a
+                            comma-separated list, which may include md5, sha1,
+                            sha256, sha384, sha512, and must be a subset of the
+                            indexed algorithms. If unspecified, manifests will be
+                            created for all indexed algorithms.
+
+# check: Verify the fixity of files in the index
+
+## Usage:
+    fixi check [<options>] [<dir> | <file>]
+
+## Options:
+    --absolute, -a:   Show absolute paths. By default, paths are reported
+                      relative to the index root.
+     --shallow, -s:   Do shallow comparisons when determining which files have
+                      changed. If specified, only file sizes and mtimes will be
+                      used. By default, checksums will also be computed and
+                      compared if necessary.
+     --verbose, -v:   For modified files, show which attribute changed. By
+                      default, only the path is shown.
+
+# commit: Commit modified files to the index
+
+## Usage:
+    fixi commit [<options>] [<dir> | <file>]
+
+## Options:
+    --absolute, -a:   Show absolute paths. By default, paths are reported
+                      relative to the index root.
+     --dry-run, -d:   Don't do anything; just report what would be done
+     --shallow, -s:   Do shallow comparisons when determining which files have
+                      changed. If specified, only file sizes and mtimes will be
+                      used. By default, checksums will also be computed and
+                      compared if necessary.
+     --verbose, -v:   For modified files, show which attribute changed. By
+                      default, only the path is shown.
+
+# info: Display a summary of the index
+
+## Usage:
+    fixi info [path]
+
+# init: Create a new, empty index
+
+## Usage:
+    fixi init [<options>] [<dir>]
+
+## Options:
+    --algorithms, -l <s>:   Checksum algorithm(s) to use for the index. This is 
+                            a comma-separated list, which may include md5, sha1,
+                            sha256, sha384, and sha512. (Default: sha256)
+
+# ls: List contents of the index
+
+## Usage:
+    fixi ls [<options>] [<dir> | <file>]
+
+## Options:
+    --absolute, -a:   Show absolute paths. By default, paths are reported
+                      relative to the index root.
+        --json, -j:   Like --verbose, but outputs the result as a json array.
+         --md5 <s>:   Restrict list to files with the given md5 checksum
+        --sha1 <s>:   Restrict list to files with the given sha1 checksum
+      --sha256 <s>:   Restrict list to files with the given sha256 checksum
+      --sha384 <s>:   Restrict list to files with the given sha384 checksum
+      --sha512 <s>:   Restrict list to files with the given sha512 checksum
+     --verbose, -v:   Include all information known about each file. By default,
+                      only paths will be listed.
+
+# rm: Delete old files from the index
+
+## Usage:
+    fixi rm [<options>] [<dir> | <file>]
+
+## Options:
+    --absolute, -a:   Show absolute paths. By default, paths are reported
+                      relative to the index root.
+     --dry-run, -d:   Don't do anything; just report what would be done
+
+# sum: Calculate checksum(s) of a file
+
+## Usage:
+    fixi sum [<options>] <file>
+
+## Options:
+    --algorithms, -l <s>:   Checksum algorithm(s) to use. This is a
+                            comma-separated list, which may include md5, sha1,
+                            sha256, sha384, and sha512. At least one must be
+                            specified.
+
+# unbag: Import files from a BagIt bag
+
+## Usage:
+    fixi unbag [<options>] <input-dir> <output-dir>
+
+## Where:
+    input-dir is the base directory of the bag.
+    output-dir is the directory in which to import it.
+
+## Options:
+    --absolute, -a:   Show absolute paths. By default, paths are reported
+                      relative to the index root.

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Default: run specs."
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+end

data/bin/fixi

@@ -1,20 +1,17 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
-require 'trollop'
 require 'fixi'
 
-name = ARGV.shift
-if name == "--help" || name == "-h" || name == "help"
-  name = ARGV.shift
-  if name.nil?
-    puts <<-EOS
+def show_usage_and_exit
+  puts <<-EOS
 usage: fixi [--version] [--help] <command> [<options>] [path]
 
 All commands are scoped to the current directory or the given path, if specified.
 
 Commands:
      add:   #{Fixi::Command::Add.synopsis}
+     bag:   #{Fixi::Command::Bag.synopsis}
    check:   #{Fixi::Command::Check.synopsis}
   commit:   #{Fixi::Command::Commit.synopsis}
     info:   #{Fixi::Command::Info.synopsis}
@@ -22,16 +19,26 @@ Commands:
       ls:   #{Fixi::Command::Ls.synopsis}
       rm:   #{Fixi::Command::Rm.synopsis}
      sum:   #{Fixi::Command::Sum.synopsis}
+   unbag:   #{Fixi::Command::Unbag.synopsis}
 
 See 'fixi help <command>' for more information on a specific command.
-    EOS
-    exit 0
+  EOS
+  exit 0
+end
+
+name = ARGV.shift
+if name == "--help" || name == "-h" || name == "help"
+  name = ARGV.shift
+  if name.nil?
+    show_usage_and_exit
   else
     ARGV.insert(0, "--help")
   end
 elsif name == "--version" || name == "-v"
   puts "fixi version #{Fixi::VERSION}"
   exit 0
+elsif name.nil?
+  show_usage_and_exit
 end
 
 command = Fixi::command name

data/fixi.gemspec

@@ -18,10 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
 
   s.add_runtime_dependency "trollop"
-  s.add_runtime_dependency "sqlite3-ruby"
+  s.add_runtime_dependency "sqlite3"
 end

data/lib/fixi/command/add.rb

@@ -6,9 +6,12 @@ class Fixi::Command::Add
     "Add new files to the index"
   end
 
+  def self.arghelp
+    "[<dir>|<file>]"
+  end
+
   def self.details
-    "This command is scoped to the current directory or the given path,
-      if specified.".pack
+    "If no argument is given, the current directory ('.') is assumed."
   end
 
   def execute args

data/lib/fixi/command/bag.rb

@@ -0,0 +1,94 @@
+require 'trollop'
+require 'fixi/index'
+require 'set'
+require 'fileutils'
+
+class Fixi::Command::Bag
+  def self.synopsis
+    "Export files as a new BagIt bag"
+  end
+
+  def self.arghelp
+    "<input-dir> <output-dir>"
+  end
+
+  def self.details
+    "Where:\n  input-dir is an indexed directory whose content should be exported.\n" +
+      "  output-dir is the base directory of the bag to be created."
+  end
+
+  def execute args
+    opts = Trollop::options args do
+      banner Fixi::Command.banner "bag"
+      opt :algorithms, "Checksum algorithm(s) to use for the bag. This is
+        a comma-separated list, which may include md5, sha1, sha256, sha384,
+        sha512, and must be a subset of the indexed algorithms. If unspecified,
+        manifests will be created for all indexed algorithms.".pack,
+        :short => 'l', :type => :string
+    end
+
+    raise "Must specify input directory." unless args[0] 
+    raise "Must specify output directory." unless args[1]
+    raise "Output directory already exists." if File.exists?(args[1])
+
+    input_dir = File.expand_path(args[0])
+    output_dir = File.expand_path(args[1])
+
+    index = Fixi::Index.new(input_dir)
+    Dir.mkdir(output_dir)
+
+    # if algorithms specified, must be a subset of those indexed
+    opts[:algorithms] ||= index.algorithms
+    set = Set.new(index.algorithms.split(","))
+    subset = Set.new(opts[:algorithms].split(","))
+    raise "Specified algorithm(s) must be a subset of #{index.algorithms}" unless subset.subset?(set)
+
+    manifiles = {}
+    
+    begin
+      # write bag declaration
+      file = File.new(File.join(args[1], "bagit.txt"), "w")
+      file.puts("BagIt-Version: 0.97")
+      file.puts("Tag-File-Character-Encoding: UTF-8")
+      file.close
+
+      # open manifest files for writing
+      opts[:algorithms].split(",").each do |alg|
+        filename = File.join(args[1], "manifest-#{alg}.txt")
+        manifiles[alg] = File.new(filename, "w")
+      end
+
+      # copy all files, preserving attributes
+      index.each(input_dir) do |hash|
+        relpath = hash['relpath']
+        abspath = index.rootpath + '/' + relpath
+        if index.file_in_scope(relpath) && File.exists?(abspath)
+          bagrelpath = "data" + abspath[input_dir.length..-1]
+          destpath = args[1] + "/" + bagrelpath
+          manifiles.each do |alg, file|
+            file.puts("#{hash[alg]} #{bagrelpath}")
+          end
+          begin
+            FileUtils.cp(abspath, destpath, :preserve => true)
+          rescue
+            FileUtils.mkdir_p(File.dirname(destpath))
+            FileUtils.cp(abspath, destpath, :preserve => true)
+          end
+        end
+      end
+
+      data_dir = output_dir + "/data"
+
+      # revisit all dirs under data/, copying orig dir metadata
+      Find.find(data_dir) do |dir|
+        if File.directory?(dir) && dir != data_dir
+          orig_dir = input_dir + dir[data_dir.length..-1]
+          Fixi::set_metadata(dir, File.stat(orig_dir))
+        end
+      end
+    ensure
+      manifiles.each_value { |file| file.close }
+    end
+  end
+
+end

data/lib/fixi/command/check.rb

@@ -5,9 +5,12 @@ class Fixi::Command::Check
     "Verify the fixity of files in the index"
   end
 
+  def self.arghelp
+    "[<dir>|<file>]"
+  end
+
   def self.details
-    "This command is scoped to the current directory or the given path,
-      if specified.".pack
+    "If no argument is given, the current directory ('.') is assumed."
   end
 
   def execute args
@@ -15,6 +18,10 @@ class Fixi::Command::Check
       banner Fixi::Command.banner "check"
       opt :absolute, "Show absolute paths. By default, paths are reported
         relative to the index root.".pack
+      opt :algorithms, "Checksum algorithm(s) to use if shallow isn't specified.
+        This is a comma-separated list, which may include md5, sha1, sha256, sha384,
+        sha512, and must be a subset of the indexed algorithms. If unspecified,
+        defaults to all indexed algorithms.".pack, :short => 'l', :type => :string
       opt :shallow, "Do shallow comparisons when determining which files have
         changed. If specified, only file sizes and mtimes will be used. By 
         default, checksums will also be computed and compared if necessary.".pack
@@ -24,6 +31,12 @@ class Fixi::Command::Check
     path = File.expand_path(args[0] || ".")
     index = Fixi::Index.new(path)
    
+    # if algorithms specified, must be a subset of those indexed
+    opts[:algorithms] ||= index.algorithms
+    set = Set.new(index.algorithms.split(","))
+    subset = Set.new(opts[:algorithms].split(","))
+    raise "Specified algorithm(s) must be a subset of #{index.algorithms}" unless subset.subset?(set)
+
     index.each(args[0]) do |hash|
       relpath = hash['relpath']
       abspath = index.rootpath + '/' + relpath
@@ -38,9 +51,9 @@ class Fixi::Command::Check
             detail = opts[:verbose] ? "mtime=#{Time.at(mtime).utc.iso8601} " : ""
             puts "M #{detail}#{opts[:absolute] ? abspath : relpath}"
           elsif not opts[:shallow]
-            hexdigests = Fixi::hexdigests(Fixi::digests(index.algorithms), abspath)
+            hexdigests = Fixi::hexdigests(Fixi::digests(opts[:algorithms]), abspath)
             i = 0
-            index.algorithms.split(',').each do |algorithm|
+            opts[:algorithms].split(',').each do |algorithm|
               if hexdigests[i] != hash[algorithm]
                 detail = opts[:verbose] ? "#{algorithm}=#{hexdigests[i]} " : ""
                 puts "M #{detail}#{opts[:absolute] ? abspath : relpath}"

data/lib/fixi/command/commit.rb

@@ -7,9 +7,12 @@ class Fixi::Command::Commit
     "Commit modified files to the index"
   end
 
+  def self.arghelp
+    "[<dir>|<file>]"
+  end
+
   def self.details
-    "This command is scoped to the current directory or the given path,
-      if specified.".pack
+    "If no argument is given, the current directory ('.') is assumed."
   end
 
   def execute args

data/lib/fixi/command/info.rb

@@ -6,9 +6,12 @@ class Fixi::Command::Info
     "Display a summary of the index"
   end
 
+  def self.arghelp
+    "[<dir>]"
+  end
+
   def self.details
-    "This command is scoped to the current directory or the given path,
-      if specified.".pack
+    "If no argument is given, the current directory ('.') is assumed."
   end
 
   def execute args

data/lib/fixi/command/init.rb

@@ -6,6 +6,10 @@ class Fixi::Command::Init
     "Create a new, empty index"
   end
 
+  def self.arghelp
+    "[path]"
+  end
+
   def self.details
     "This command is scoped to the current directory or the given path,
       if specified.".pack

data/lib/fixi/command/ls.rb

@@ -6,9 +6,12 @@ class Fixi::Command::Ls
     "List contents of the index"
   end
 
+  def self.arghelp
+    "[<dir>|<file>]"
+  end
+
   def self.details
-    "This command is scoped to the current directory or the given path,
-      if specified.".pack
+    "If no argument is given, the current directory ('.') is assumed."
   end
 
   def execute args

data/lib/fixi/command/rm.rb

@@ -7,9 +7,12 @@ class Fixi::Command::Rm
     "Delete old files from the index"
   end
 
+  def self.arghelp
+    "[<dir>|<file>]"
+  end
+
   def self.details
-    "This command is scoped to the current directory or the given path,
-      if specified.".pack
+    "If no argument is given, the current directory ('.') is assumed."
   end
 
   def execute args

data/lib/fixi/command/sum.rb

@@ -7,8 +7,12 @@ class Fixi::Command::Sum
     "Calculate checksum(s) of a file"
   end
 
+  def self.arghelp
+    "<file>"
+  end
+
   def self.details
-      "This command operates on files and does not require an index to exist."
+    "This command operates on files and does not require an index to exist."
   end
 
   def execute args

data/lib/fixi/command/unbag.rb

@@ -0,0 +1,124 @@
+require 'trollop'
+require 'fixi/index'
+require 'fileutils'
+
+class Fixi::Command::Unbag
+  def self.synopsis
+    "Import files from a BagIt bag"
+  end
+
+  def self.arghelp
+    "<input-dir> <output-dir>"
+  end
+
+  def self.details
+    "Where:\n  input-dir is the base directory of the bag.\n" +
+      "  output-dir is the directory in which to import it."
+  end
+
+  def execute args
+    opts = Trollop::options args do
+      banner Fixi::Command.banner "unbag"
+      opt :absolute, "Show absolute paths. By default, paths are reported
+        relative to the index root.".pack
+    end
+
+    # validate args and bag dir
+    raise "Must specify input directory." unless args[0]
+    raise "Must specify output directory." unless args[1]
+    raise "Output directory already exists." if File.exists?(args[1])
+
+    input_dir = File.expand_path(args[0])
+    output_dir = File.expand_path(args[1])
+
+    index = Fixi::Index.new(File.dirname(output_dir))
+    Dir.mkdir(output_dir)
+
+    data_dir = input_dir + "/data"
+    raise "No data dir found in input dir." unless File.directory?(data_dir)
+
+    # build hash of manifest algorithm => file path
+    manifests = {}
+    indexed_algs = index.algorithms.split(",")
+    Dir.entries(input_dir).each do |child|
+      if child =~ /^manifest-.*\.txt/
+        alg = child[9..(child.length - 5)]
+        if (indexed_algs.include?(alg))
+          manifests[alg] = input_dir + "/" + child
+        end
+      end
+    end
+
+    # copy all data to dest dir, subject to includes and excludes
+    Find.find(data_dir) do |abspath|
+      unless abspath == data_dir
+        relpath = abspath.slice(data_dir.length + 1..-1)
+        destpath = output_dir + "/" + relpath
+        if index.matches_any?(relpath, index.includes)
+          if index.matches_any?(relpath, index.excludes)
+            Find.prune
+          elsif not File.directory?(abspath)
+            begin
+              FileUtils.cp(abspath, destpath, :preserve => true)
+            rescue
+              FileUtils.mkdir_p(File.dirname(destpath))
+              FileUtils.cp(abspath, destpath, :preserve => true)
+            end
+          end
+        else
+          Find.prune unless File.directory?(abspath)
+        end
+      end
+    end
+
+    # revisit all dirs under output_dir, copying orig dir metadata
+    Find.find(output_dir) do |dir|
+      if File.directory?(dir) && dir != output_dir
+        orig_dir = data_dir + dir[output_dir.length..-1]
+        Fixi::set_metadata(dir, File.stat(orig_dir))
+      end
+    end
+
+    # add paths, sizes, and mtimes to db
+    index.find(output_dir) do |abspath|
+      relpath = index.relpath(abspath)
+      index.add(relpath, false)
+    end
+
+    # add manifest entries to db
+    manifests.each do |alg, manifest|
+      IO.foreach(manifest) do |line|
+        i = line.index(" ")
+        if i 
+          digest = line[0..i-1].downcase
+          bagpath = line[i+6..-1].rstrip
+          relpath = index.relpath(output_dir + "/" + bagpath)
+          index.set_digest(relpath, alg, digest)
+        end
+      end
+    end
+
+    # for all new files, compute any required hashes and print A path/etc
+    algs = index.algorithms.split(",")
+    index.each(output_dir) do |hash|
+      relpath = hash['relpath']
+      abspath = index.rootpath + '/' + relpath
+      puts "A #{opts[:absolute] ? abspath : relpath}"
+
+      missing_digests = []
+      algs.each do |alg|
+        missing_digests << alg unless hash[alg]
+      end
+      if missing_digests.size > 0
+        digests = Fixi::digests(missing_digests.join(","))
+        hexdigests = Fixi::hexdigests(digests, abspath)
+        i = 0
+        missing_digests.each do |alg|
+          index.set_digest(relpath, alg, hexdigests[i])
+          i += 1
+        end
+      end
+    end
+
+  end
+end

data/lib/fixi/command.rb

@@ -1,8 +1,9 @@
 module Fixi::Command
   def self.banner(name)
-    "fixi-#{name}: #{const_get(name.capitalize).synopsis}\n\n" +
-      "usage: fixi #{name} [<options>] [path]\n\n" +
-      "#{const_get(name.capitalize).details}\n\n" +
+    n = name.capitalize
+    "fixi-#{name}: #{const_get(n).synopsis}\n\n" +
+      "usage: fixi #{name} [<options>] #{const_get(n).arghelp}\n\n" +
+      "#{const_get(n).details}\n\n" +
       "Options:"
   end
 end

data/lib/fixi/index.rb

@@ -1,7 +1,7 @@
 require 'sqlite3'
 
 class Fixi::Index
-  attr_reader :dotpath, :rootpath, :dbversion, :algorithms
+  attr_reader :dotpath, :rootpath, :dbversion, :algorithms, :includes, :excludes
 
   def initialize(startpath, create=false, algorithms=nil)
     startpath = File.expand_path(startpath || ".")
@@ -141,21 +141,27 @@ class Fixi::Index
     @db.execute(sql, relpath)
   end
 
-  def add(relpath)
+  def set_digest(relpath, alg, val)
+    sql = "update file set #{alg} = '#{val}' where relpath = ?"
+    @db.execute(sql, relpath)
+  end
+
+  def add(relpath, compute_checksums=true)
     abspath = File.join(@rootpath, relpath)
-    sql = "insert into file (relpath, size, mtime, "
-    sql += @algorithms
-    sql += ") values (:relpath, :size, :mtime, "
+    sql = "insert into file (relpath, size, mtime"
+    sql += ", " + @algorithms if compute_checksums
+    sql += ") values (:relpath, :size, :mtime"
     values = Hash.new
     values[:relpath] = relpath
     values[:size] = File.size abspath
     values[:mtime] = File.mtime(abspath).to_i
-    hexdigests = Fixi::hexdigests(Fixi::digests(@algorithms), abspath)
-    i = 0
-    @algorithms.split(",").each do |alg|
-      sql += ", " if i > 0
-      sql += "'" + hexdigests[i] + "'"
-      i += 1
+    if compute_checksums
+      hexdigests = Fixi::hexdigests(Fixi::digests(@algorithms), abspath)
+      i = 0
+      @algorithms.split(",").each do |alg|
+        sql += ", '" + hexdigests[i] + "'"
+        i += 1
+      end
     end
     sql += ")"
     @db.execute(sql, values)
@@ -171,6 +177,13 @@ class Fixi::Index
     puts "Fixi database version #{dbversion}"
   end
 
+  def matches_any?(path, patterns)
+    patterns.each do |pattern|
+      return true if pattern.match(path)
+    end
+    return false
+  end
+
   private
 
   def load_patterns(name)
@@ -185,13 +198,6 @@ class Fixi::Index
     result
   end
 
-  def matches_any?(path, patterns)
-    patterns.each do |pattern|
-      return true if pattern.match(path)
-    end
-    return false
-  end
-
   # Return the first .fixi directory we find while traversing up the tree
   def find_dotpath(path, startpath=path)
     dotpath = File.join(path, ".fixi")

data/lib/fixi/version.rb

@@ -1,3 +1,3 @@
 module Fixi
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/fixi.rb

@@ -39,4 +39,16 @@ module Fixi
     }
     hds
   end
+
+  def self.set_metadata(path, stat)
+    File.utime(stat.atime, stat.mtime, path)
+    begin
+      File.chown(stat.uid, stat.gid, path)
+    rescue Errno::EPERM
+      File.chmod(stat.mode & 01777, path)
+    else
+      File.chmod(stat.mode, path)
+    end
+  end
+
 end

data/spec/lib/fixi/command/init_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Fixi::Command::Init do
+  describe "::synopsis" do
+    it 'should be a non-empty string' do
+      Fixi::Command::Init::synopsis.length.should_not == 0
+    end
+  end
+
+  describe "::details" do
+    it 'should be a non-empty string' do
+      Fixi::Command::Init::details.length.should_not == 0
+    end
+  end
+
+  describe "execute" do
+    include FixiTestHelperMethods
+    before do
+      @command = Fixi::Command::Init.new
+    end
+
+    it "should accept zero args" do
+      capture_stdout
+      @command.execute([])
+      release_stdout
+    end
+
+  end
+end

data/spec/lib/fixi/patch/string_pack_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "String#pack" do
+  it 'should drop leading whitespace' do
+    "\n foo".pack.should == "foo"
+  end
+
+  it 'should drop trailing whitespace' do
+    "\n foo".pack.should == "foo"
+  end
+
+  it 'should turn multi whitespace into one space' do
+    "foo \n\n  bar".pack.should == "foo bar"
+  end
+end

data/spec/lib/fixi_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe Fixi do
+  describe "::command" do
+    it 'should return nil for bogus name' do
+      Fixi::command("bogus").should == nil
+    end
+
+    it 'should return instance for real name' do
+      Fixi::command("init").should_not == nil
+    end
+  end
+
+  describe "::digests" do
+    it 'should raise error for bogus name' do
+      lambda { Fixi::digests("bogus") }.should raise_error
+    end
+
+    it 'should return instance for real name' do
+      Fixi::digests("md5").should_not == nil
+    end
+  end
+
+  describe "::hexdigests" do
+    before(:all) do
+      @file = Tempfile.new('foo')
+      @file.write('foo')
+      @file.close
+    end
+
+    it 'should compute correct single checksum' do
+      hexdigests = Fixi::hexdigests(Fixi::digests("md5"), @file.path)
+      hexdigests.should == ["acbd18db4cc2f85cedef654fccc4a4d8"]
+    end
+
+    it 'should compute correct multi checksum' do
+      hexdigests = Fixi::hexdigests(Fixi::digests("md5,sha1"), @file.path)
+      hexdigests.should == ["acbd18db4cc2f85cedef654fccc4a4d8",
+          "0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33"]
+    end
+
+    after(:all) do
+      @file.unlink
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'fixi'
+
+require 'tempfile'
+
+module FixiTestHelperMethods
+  # Start capturing stdout
+  def capture_stdout
+      @orig_stdout = $stdout
+      @stdout_file = Tempfile.new("stdout")
+      $stdout = @stdout_file
+  end
+
+  # Finish capturing stdout, setting @stdout to have each line of output
+  def release_stdout
+      $stdout = @orig_stdout
+      @stdout_file.rewind
+      @stdout = []
+      @stdout_file.each do |line|
+        @stdout << line
+      end
+      @stdout_file.unlink
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: fixi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Chris Wilper
@@ -10,10 +10,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-08 00:00:00 Z
+date: 2011-12-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: trollop
+  name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -21,10 +21,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
+  name: simplecov
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -32,8 +32,30 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: Keeps an index of checksums and lets you update and verify them
 email: 
 - cwilper@gmail.com
@@ -46,13 +68,15 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README
+- LICENSE
+- README.md
 - Rakefile
 - bin/fixi
 - fixi.gemspec
 - lib/fixi.rb
 - lib/fixi/command.rb
 - lib/fixi/command/add.rb
+- lib/fixi/command/bag.rb
 - lib/fixi/command/check.rb
 - lib/fixi/command/commit.rb
 - lib/fixi/command/info.rb
@@ -60,9 +84,14 @@ files:
 - lib/fixi/command/ls.rb
 - lib/fixi/command/rm.rb
 - lib/fixi/command/sum.rb
+- lib/fixi/command/unbag.rb
 - lib/fixi/index.rb
 - lib/fixi/patch/string_pack.rb
 - lib/fixi/version.rb
+- spec/lib/fixi/command/init_spec.rb
+- spec/lib/fixi/patch/string_pack_spec.rb
+- spec/lib/fixi_spec.rb
+- spec/spec_helper.rb
 homepage: ""
 licenses: []
 
@@ -90,5 +119,8 @@ rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A fixity tracker utility
-test_files: []
-
+test_files: 
+- spec/lib/fixi/command/init_spec.rb
+- spec/lib/fixi/patch/string_pack_spec.rb
+- spec/lib/fixi_spec.rb
+- spec/spec_helper.rb

data/README

@@ -1,19 +0,0 @@
-Fixi - Source Code
-==================
-
-A fixity tracker utility.
-
-Installing From RubyGems.org
-----------------------------
-
-> [sudo] gem install fixi
-
-Installing From Source
-----------------------
-
-> [sudo] rake install
-
-Usage
------
-
-To see usage, after installing, run fixi --help