moab-versioning 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: fe7dbe157c6bc9418f8b336b65431a1266ca4375
-  data.tar.gz: 5328ef34ef060962cf9598001c6d146cde7afdc3
-SHA512:
-  metadata.gz: 79893b2a0f5b5d5791cee7ef9d26213d2f6876ea32f71a258d6d3030982fa8a6824f5285de20e343775ca1dc4625cbc16d32c793182116f830c7a4065dd5c5ce
-  data.tar.gz: e73bae98354c6001887a6a1fa24589919e696596c74ffdaac0b3132b123c761fea0850e5000d3795443af49b696a3e4cbc92567d4ccb7fa5020f1cbfa7aeb191
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjAyMmUwOGNiOGYzN2U4ZGQyMDNkNGE2ZDM5Y2IxMTc0OTdiZDY0Yg==
+  data.tar.gz: !binary |-
+    NDlmOGZjNmY1ZDZjMjk0ODIyNTYwYjk5Njk5ZTYwMjE2NGY1MGM0ZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTU0MjllMzVmNzk4NGIyNzczN2I5MzU5ODkwNGViZTlmMjAyM2MxZTQwMTI5
+    OTUxZTg4NTk2MTdiYzM1NjYwOGU3OGE4NmUyODExNjU1YmY3OThkMzU1MGJh
+    YTIzOWZmOGM0N2ZiZTNjODEwMDY4MjZiZjFhN2MzZTBiNTA4ZGI=
+  data.tar.gz: !binary |-
+    ZDE2NDAwOWU0YzJkOTRiNWY4ZGJmZDY4OGE3MjNhZmFjMmUzMTkyY2JkYTkx
+    NTk3ZmRiOGFmMGJkNmY3NmY2YWFkODBiMWQyOWYwM2JiNDQyMmQ5YTdmYWFl
+    MTU1MGZjZTBkNmNkM2I3ZjdhN2Y0MDlkMzA2ZGM3ZTdjNWY5ZTQ=

data/lib/moab/config.rb

@@ -2,19 +2,11 @@ require 'moab'
 
 module Moab
 
-  #class Configuration < Confstruct::Configuration
-  #
-  #  def configure(*args, &block)
-  #    super(*args, &block)
-  #
-  #    # Whatever you want to do after configuration
-  #    # Something.initialize(self.repository_home)
-  #  end
-  #end
-
   # @return [Confstruct::Configuration] the configuration data
   Config = Confstruct::Configuration.new do
-      repository_home  nil
+      storage_roots nil
+      storage_trunk nil
+      deposit_trunk nil
       path_method :druid_tree
   end
 

data/lib/moab/file_group_difference.rb

@@ -21,9 +21,11 @@ module Moab
   # are further categorized as follows:
   # * <i>identical</i> = signature and file path is the same in both basis and other file group
   # * <i>renamed</i> = signature is unchanged, but the path has moved
-  # * <i>modified</i> = path is present in both groups, but the signature has changed
-  # * <i>deleted</i> = signature and path are only in the basis inventory
+  # * <i>copyadded</i> = duplicate copy of file was added
+  # * <i>copydeleted</i> = duplicate copy of file was deleted
+  # * <i>modified</i> = path is same in both groups, but the signature has changed
   # * <i>added</i> = signature and path are only in the other inventor
+  # * <i>deleted</i> = signature and path are only in the basis inventory
   #
   # ====Data Model
   # * {FileInventoryDifference} = compares two {FileInventory} instances based on file signatures and pathnames
@@ -40,9 +42,19 @@ module Moab
     # The name of the XML element used to serialize this objects data
     tag 'fileGroupDifference'
 
+    # @return [Hash<Symbol,FileGroupDifferenceSubset>] A set of containers (one for each change type),
+    #    each of which contains a collection of file-level differences having that change type.
+    attr_accessor :subset_hash
+
+    # @param change [String] the change type to search for
+    # @return [FileGroupDifferenceSubset] Find a specified subset of changes
+    def subset(change)
+      @subset_hash[change.to_sym]
+    end
+
     # (see Serializable#initialize)
     def initialize(opts={})
-      @subsets = Array.new
+      @subset_hash = OrderedHash.new {|hash, key| hash[key] = FileGroupDifferenceSubset.new(:change => key.to_s)}
       super(opts)
     end
 
@@ -55,43 +67,80 @@ module Moab
     attribute :difference_count, Integer, :tag => 'differenceCount', :on_save => Proc.new { |i| i.to_s }
 
     def difference_count
-      @renamed + @modified + @deleted +@added
+      count = 0
+      @subset_hash.each do |type,subset|
+        count += subset.count if type != :identical
+      end
+      count
     end
 
     # @attribute
     # @return [Integer] How many files were unchanged
     attribute :identical, Integer, :on_save => Proc.new { |n| n.to_s }
+    def identical
+      @subset_hash[:identical].count
+    end
+
+    # @attribute
+    # @return [Integer] How many duplicate copies of files were added
+    attribute :copyadded, Integer, :on_save => Proc.new { |n| n.to_s }
+    def copyadded
+      @subset_hash[:copyadded].count
+    end
+
+    # @attribute
+    # @return [Integer] How many duplicate copies of files were deleted
+    attribute :copydeleted, Integer, :on_save => Proc.new { |n| n.to_s }
+    def copydeleted
+      @subset_hash[:copydeleted].count
+    end
 
     # @attribute
     # @return [Integer] How many files were renamed
     attribute :renamed, Integer, :on_save => Proc.new { |n| n.to_s }
+    def renamed
+      @subset_hash[:renamed].count
+    end
 
     # @attribute
     # @return [Integer] How many files were modified
     attribute :modified, Integer, :on_save => Proc.new { |n| n.to_s }
-
-    # @attribute
-    # @return [Integer] How many files were deleted
-    attribute :deleted, Integer, :on_save => Proc.new { |n| n.to_s }
+    def modified
+      @subset_hash[:modified].count
+    end
 
     # @attribute
     # @return [Integer] How many files were added
     attribute :added, Integer, :on_save => Proc.new { |n| n.to_s }
+    def added
+      @subset_hash[:added].count
+    end
+
+    # @attribute
+    # @return [Integer] How many files were deleted
+    attribute :deleted, Integer, :on_save => Proc.new { |n| n.to_s }
+    def deleted
+      @subset_hash[:deleted].count
+    end
 
     # @attribute
     # @return [Array<FileGroupDifferenceSubset>] A set of Arrays (one for each change type),
     #    each of which contains an collection of file-level differences having that change type.
     has_many :subsets, FileGroupDifferenceSubset, :tag => 'subset'
 
-    # @param change [String] the change type to search for
-    # @return [FileGroupDifferenceSubset] Find a specified subset of changes
-    def subset(change)
-      @subsets.find{ |subset| subset.change == change}
+    def subsets
+      @subset_hash.values
+    end
+
+    def subsets=(array)
+      if array
+        array.each{|subset| @subset_hash[subset.change.to_sym] = subset}
+      end
     end
 
     # @return [Array<String>] The data fields to include in summary reports
     def summary_fields
-      %w{group_id difference_count identical renamed modified deleted added}
+      %w{group_id difference_count identical copyadded copydeleted renamed modified deleted added}
     end
 
 
@@ -99,49 +148,17 @@ module Moab
     # @return [FileGroupDifference] Clone just this element for inclusion in a versionMetadata structure
     def summary()
       FileGroupDifference.new(
-          :group_id => @group_id,
-          :identical => @identical,
-          :renamed => @renamed,
-          :modified => @modified,
-          :deleted => @deleted,
-          :added => @added
+          :group_id => group_id,
+          :identical => identical,
+          :copyadded => copyadded,
+          :copydeleted => copydeleted,
+          :renamed => renamed,
+          :modified => modified,
+          :added => added,
+          :deleted => deleted
       )
     end
 
-
-    # @return [Hash<Symbol,Array>] Sets of filenames grouped by change type for use in performing file or metadata operations
-    def file_deltas()
-      # The hash to be returned
-      deltas = Hash.new
-      # Container for a files whose checksums matched across versions, but may have copies removed, added, or renamed
-      copied = Hash.new {|hash, key| hash[key] = {:basis=>Array.new , :other=>Array.new} }
-      # Capture the filename data
-      @subsets.each  do |subset|
-        case subset.change
-          when "added"
-            deltas[:added] = subset.files.collect {|file| file.other_path}
-          when "deleted"
-            deltas[:deleted] = subset.files.collect {|file| file.basis_path}
-          when "modified"
-            deltas[:modified] = subset.files.collect {|file| file.basis_path}
-          when "identical"
-            subset.files.each  do |instance|
-              signature = instance.signatures[0]
-              copied[signature][:basis] << instance.basis_path
-              copied[signature][:other] << instance.basis_path
-            end
-          when "renamed"
-            subset.files.each  do |instance|
-              signature = instance.signatures[0]
-              copied[signature][:basis] << instance.basis_path unless (instance.basis_path.nil? or instance.basis_path.empty?)
-              copied[signature][:other] << instance.other_path unless (instance.other_path.nil? or instance.other_path.empty?)
-            end
-        end
-      end
-      deltas[:copied] = copied.values
-      deltas
-    end
-
     # @api internal
     # @param basis_hash [Hash] The first hash being compared
     # @param other_hash [Hash] The second hash being compared
@@ -177,17 +194,18 @@ module Moab
 
     # @api internal
     # @param (see #compare_file_groups)
-    # @return [void] For signatures that are present in both groups,
+    # @return [FileGroupDifference] For signatures that are present in both groups,
     #   report which file instances are identical or renamed
     def compare_matching_signatures(basis_group, other_group)
       matching_signatures = matching_keys(basis_group.signature_hash, other_group.signature_hash)
       tabulate_unchanged_files(matching_signatures, basis_group.signature_hash, other_group.signature_hash)
       tabulate_renamed_files(matching_signatures, basis_group.signature_hash, other_group.signature_hash)
+      self
     end
 
     # @api internal
     # @param (see #compare_file_groups)
-    # @return [void] For signatures that are present in only one or the other group,
+    # @return [FileGroupDifference] For signatures that are present in only one or the other group,
     #   report which file instances are modified, deleted, or added
     def compare_non_matching_signatures(basis_group, other_group)
       basis_only_signatures = basis_only_keys(basis_group.signature_hash, other_group.signature_hash)
@@ -195,8 +213,9 @@ module Moab
       basis_path_hash = basis_group.path_hash_subset(basis_only_signatures)
       other_path_hash = other_group.path_hash_subset(other_only_signatures)
       tabulate_modified_files(basis_path_hash, other_path_hash)
-      tabulate_deleted_files(basis_path_hash, other_path_hash)
       tabulate_added_files(basis_path_hash, other_path_hash)
+      tabulate_deleted_files(basis_path_hash, other_path_hash)
+      self
     end
 
     # @api internal
@@ -205,10 +224,9 @@ module Moab
     #   Signature to file path mapping from the file group that is the basis of the comparison
     # @param other_signature_hash [OrderedHash<FileSignature, FileManifestation>]
     #   Signature to file path mapping from the file group that is the being compared to the basis group
-    # @return [FileGroupDifferenceSubset]
+    # @return [FileGroupDifference]
     #   Container for reporting the set of file-level differences of type 'identical'
     def tabulate_unchanged_files(matching_signatures, basis_signature_hash, other_signature_hash)
-      unchanged_files = Array.new
       matching_signatures.each do |signature|
         basis_paths = basis_signature_hash[signature].paths
         other_paths = other_signature_hash[signature].paths
@@ -218,14 +236,10 @@ module Moab
           fid.basis_path = path
           fid.other_path = "same"
           fid.signatures << signature
-          unchanged_files << fid
+          @subset_hash[:identical].files << fid
         end
       end
-      unchanged_subset = FileGroupDifferenceSubset.new(:change => 'identical')
-      unchanged_subset.files = unchanged_files
-      @subsets << unchanged_subset
-      @identical = unchanged_subset.count
-      unchanged_subset
+      self
     end
 
 
@@ -235,10 +249,9 @@ module Moab
     #   Signature to file path mapping from the file group that is the basis of the comparison
     # @param other_signature_hash [OrderedHash<FileSignature, FileManifestation>]
     #   Signature to file path mapping from the file group that is the being compared to the basis group
-    # @return [FileGroupDifferenceSubset]
-    #   Container for reporting the set of file-level differences of type 'renamed'
+    # @return [FileGroupDifference]
+    #   Container for reporting the set of file-level differences of type 'renamed','copyadded', or 'copydeleted'
     def tabulate_renamed_files(matching_signatures, basis_signature_hash, other_signature_hash)
-      renamed_files = Array.new
       matching_signatures.each do |signature|
         basis_paths = basis_signature_hash[signature].paths
         other_paths = other_signature_hash[signature].paths
@@ -246,18 +259,23 @@ module Moab
         other_only_paths = other_paths - basis_paths
         maxsize = [basis_only_paths.size, other_only_paths.size].max
         (0..maxsize-1).each do |n|
-          fid = FileInstanceDifference.new(:change => 'renamed')
+          fid = FileInstanceDifference.new()
           fid.basis_path = basis_only_paths[n]
           fid.other_path = other_only_paths[n]
           fid.signatures << signature
-          renamed_files << fid
+          case true
+            when fid.basis_path.nil?
+              fid.change = 'copyadded'
+              fid.basis_path = basis_paths[0]
+            when fid.other_path.nil?
+              fid.change = 'copydeleted'
+            else
+              fid.change = 'renamed'
+          end
+          @subset_hash[fid.change.to_sym].files << fid
         end
       end
-      renamed_subset = FileGroupDifferenceSubset.new(:change => 'renamed')
-      renamed_subset.files = renamed_files
-      @subsets << renamed_subset
-      @renamed = renamed_subset.count
-      renamed_subset
+      self
     end
 
 
@@ -266,23 +284,18 @@ module Moab
     #   The file paths and associated signatures for manifestations appearing only in the basis group
     # @param other_path_hash [OrderedHash<String,FileSignature>]
     #   The file paths and associated signatures for manifestations appearing only in the other group
-    # @return [FileGroupDifferenceSubset]
+    # @return [FileGroupDifference]
     #   Container for reporting the set of file-level differences of type 'modified'
     def tabulate_modified_files(basis_path_hash, other_path_hash)
-      modified_files = Array.new
       matching_keys(basis_path_hash, other_path_hash).each do |path|
         fid = FileInstanceDifference.new(:change => 'modified')
         fid.basis_path = path
         fid.other_path = "same"
         fid.signatures << basis_path_hash[path]
         fid.signatures << other_path_hash[path]
-        modified_files << fid
+        @subset_hash[:modified].files << fid
       end
-      modified_subset = FileGroupDifferenceSubset.new(:change => 'modified')
-      modified_subset.files = modified_files
-      @subsets << modified_subset
-      @modified = modified_subset.count
-      modified_subset
+      self
     end
 
     # @api internal
@@ -290,45 +303,78 @@ module Moab
     #   The file paths and associated signatures for manifestations appearing only in the basis group
     # @param other_path_hash [OrderedHash<String,FileSignature>]
     #   The file paths and associated signatures for manifestations appearing only in the other group
-    # @return [FileGroupDifferenceSubset]
+    # @return [FileGroupDifference]
+    #   Container for reporting the set of file-level differences of type 'added'
+    def tabulate_added_files(basis_path_hash, other_path_hash)
+      other_only_keys(basis_path_hash, other_path_hash).each do |path|
+        fid = FileInstanceDifference.new(:change => 'added')
+        fid.basis_path = ""
+        fid.other_path = path
+        fid.signatures << other_path_hash[path]
+        @subset_hash[:added].files << fid
+      end
+      self
+    end
+
+    # @api internal
+    # @param basis_path_hash [OrderedHash<String,FileSignature>]
+    #   The file paths and associated signatures for manifestations appearing only in the basis group
+    # @param other_path_hash [OrderedHash<String,FileSignature>]
+    #   The file paths and associated signatures for manifestations appearing only in the other group
+    # @return [FileGroupDifference]
     #   Container for reporting the set of file-level differences of type 'deleted'
     def tabulate_deleted_files(basis_path_hash, other_path_hash)
-      deleted_files = Array.new
       basis_only_keys(basis_path_hash, other_path_hash).each do |path|
         fid = FileInstanceDifference.new(:change => 'deleted')
         fid.basis_path = path
         fid.other_path = ""
         fid.signatures << basis_path_hash[path]
-        deleted_files << fid
+        @subset_hash[:deleted].files << fid
       end
-      deleted_subset = FileGroupDifferenceSubset.new(:change => 'deleted')
-      deleted_subset.files = deleted_files
-      @subsets << deleted_subset
-      @deleted = deleted_subset.count
-      deleted_subset
+      self
     end
 
-    # @api internal
-    # @param basis_path_hash [OrderedHash<String,FileSignature>]
-    #   The file paths and associated signatures for manifestations appearing only in the basis group
-    # @param other_path_hash [OrderedHash<String,FileSignature>]
-    #   The file paths and associated signatures for manifestations appearing only in the other group
-    # @return [FileGroupDifferenceSubset]
-    #   Container for reporting the set of file-level differences of type 'added'
-    def tabulate_added_files(basis_path_hash, other_path_hash)
-      added_files = Array.new
-      other_only_keys(basis_path_hash, other_path_hash).each do |path|
-        fid = FileInstanceDifference.new(:change => 'added')
-        fid.basis_path = ""
-        fid.other_path = path
-        fid.signatures << other_path_hash[path]
-        added_files << fid
+    # @return [Hash<Symbol,Array>] Sets of filenames grouped by change type for use in performing file or metadata operations
+    def file_deltas()
+      # The hash to be returned
+      deltas = Hash.new {|hash, key| hash[key] = []}
+      # case where other_path is empty or 'same'.  (create array of strings)
+      [:identical, :modified, :deleted, :copydeleted].each do |change|
+        deltas[change].concat @subset_hash[change].files.collect{|file| file.basis_path}
       end
-      added_subset = FileGroupDifferenceSubset.new(:change => 'added')
-      added_subset.files = added_files
-      @subsets << added_subset
-      @added = added_subset.count
-      added_subset
+      # case where basis_path and other_path are both present.  (create array of arrays)
+      [:copyadded, :renamed].each do |change|
+        deltas[change].concat @subset_hash[change].files.collect{|file| [file.basis_path,file.other_path]}
+      end
+      # case where basis_path is empty.  (create array of strings)
+      [:added].each do |change|
+        deltas[change].concat @subset_hash[change].files.collect{|file| file.other_path}
+      end
+      deltas
+    end
+
+    # @param [Array<Array<String>>] filepairs The set of oldname, newname pairs for all files being renamed
+    # @return [Boolean] Test whether any of the new names are the same as one of the old names,
+    #    such as would be true for insertion of a new file into a page sequence, or a circular rename.
+    #    In such a case, return true, indicating that use of intermediate temporary files would be required
+    #    when updating a copy of an object's files at a given location.
+    def rename_require_temp_files(filepairs)
+      # Split the filepairs into two arrays
+      oldnames = []
+      newnames = []
+      filepairs.each do |old,new|
+        oldnames << old
+        newnames << new
+      end
+      # Are any of the filenames the same in set of oldnames and set of newnames?
+      intersection = oldnames & newnames
+      intersection.count > 0
+    end
+
+    # @param [Array<Array<String>>] filepairs The set of oldname, newname pairs for all files being renamed
+    # @return [Array<Array<String>>] a set of file triples containing oldname, tempname, newname
+    def rename_tempfile_triplets(filepairs)
+      filepairs.collect{|old,new| [old, new, "#{new}-#{Time.now.strftime('%Y%m%d%H%H%S')}-tmp"]}
     end
 
   end

data/lib/moab/storage_object.rb

@@ -25,6 +25,9 @@ module Moab
     # @return [Pathname] The location of the object's storage home directory
     attr_accessor :object_pathname
 
+    # @return [Pathname] The location of the storage filesystem that contains (or will contain) the object
+    attr_accessor :storage_root
+
     # @param object_id [String] The digital object identifier
     # @param object_dir [Pathname,String] The location of the object's storage home directory
     def initialize(object_id, object_dir, mkpath=false)
@@ -44,12 +47,22 @@ module Moab
         @object_pathname.mkpath
     end
 
+    # @return [Pathname] The absolute location of the area in which bags are deposited
+    def deposit_home
+      storage_root.join(StorageServices.deposit_trunk)
+    end
+
+    # @return [Pathname] The absolute location of this object's deposit bag
+    def deposit_bag_pathname
+      deposit_home.join(StorageServices.deposit_branch(digital_object_id))
+    end
+
     # @api external
     # @param bag_dir [Pathname,String] The location of the bag to be ingested
     # @return [void] Ingest a new object version contained in a bag into this objects storage area
     # @example {include:file:spec/features/storage/ingest_spec.rb}
-    def ingest_bag(bag_dir)
-      bag_dir = Pathname.new(bag_dir)
+    def ingest_bag(bag_dir=deposit_bag_pathname)
+      bag_dir = Pathname(bag_dir)
       current_version = StorageObjectVersion.new(self,current_version_id)
       current_inventory = current_version.file_inventory('version')
       new_version = StorageObjectVersion.new(self,current_version_id + 1)
@@ -116,6 +129,7 @@ module Moab
     # @return [Array<Integer>] The list of all version ids for this object
     def version_id_list
       list = Array.new
+      return list unless @object_pathname.exist?
       @object_pathname.children.each do |dirname|
         vnum = dirname.basename.to_s
         if vnum.match /^v(\d+)$/

data/lib/moab/storage_repository.rb

@@ -5,7 +5,7 @@ module Moab
   # A class to represent the SDR repository store
   #
   # ====Data Model
-  # * <b>{StorageRepository} = represents a digital object repository storage node</b>
+  # * <b>{StorageRepository} = represents the digital object repository storage areas</b>
   #   * {StorageServices} = supports application layer access to the repository's objects, data, and metadata
   #   * {StorageObject} = represents a digital object's repository storage location and ingest/dissemination methods
   #     * {StorageObjectVersion} [1..*] = represents a version subdirectory within an object's home directory
@@ -15,35 +15,109 @@ module Moab
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class StorageRepository
 
-   # @return [Pathname] The location of the root directory of the repository storage node
-    def repository_home
-      Pathname.new(Moab::Config.repository_home)
+    #Note that Moab::Config is not initialized from environment config file until after this object is initialized by StorageServices
+    #   (see sequence of requires in spec_helper.rb and in applications that use)
+
+    # @return [Array<Pathname>] The list of filesystem root paths in which objects are stored
+    def storage_roots
+      unless defined?(@storage_roots)
+        raise "Moab::Config.storage_roots not found in config file" if Moab::Config.storage_roots.nil?
+        @storage_roots = [Moab::Config.storage_roots].flatten.collect{|filesystem| Pathname(filesystem)}
+        raise "Moab::Config.storage_roots empty" if  @storage_roots.empty?
+        @storage_roots.each{|root| raise "Storage root #{root} not found on system" unless root.exist?}
+      end
+      @storage_roots
     end
 
-    # @param object_id [String] The identifier of the digital object whose version is desired
-    # @return [StorageObject] The representation of the desired object storage directory
-    def storage_object(object_id, create=false)
-      object_pathname = storage_object_pathname(object_id)
-      if object_pathname.exist?
-        StorageObject.new(object_id, object_pathname)
-      elsif create
-        object_pathname.mkpath
-        StorageObject.new(object_id, object_pathname)
-      else
-        raise Moab::ObjectNotFoundException, "No object found for #{object_id} at #{object_pathname}"
+    # @return [String] The trunk segment of the object storage path
+    def storage_trunk
+      unless defined?(@storage_trunk)
+        raise "oab::Config.storage_trunk not found in config file" if Moab::Config.storage_trunk.nil?
+        @storage_trunk  = Moab::Config.storage_trunk
       end
+      @storage_trunk
     end
 
-    # @param object_id [String] The identifier of the digital object whose version is desired
-    # @return [Pathname] The location of the desired object's home directory (default=pairtree)
-    def storage_object_pathname(object_id)
+   # @param object_id [String] The identifier of the digital object
+    # @return [String] The branch segment of the object storage path
+    def storage_branch(object_id)
       #todo This method should be customized, or overridden in a subclass
+      # split a object ID into 2-character segments, followed by a copy of the object ID
       # for a more sophisticated pairtree implementation see https://github.com/microservices/pairtree
       path_segments = object_id.scan(/..?/) << object_id
-      object_path = path_segments.join(File::SEPARATOR).gsub(/:/,'_')
-      repository_home.join(object_path)
+      path_segments.join(File::SEPARATOR).gsub(/:/,'_')
+    end
+
+    # @return [String] The trunk segment of the object deposit path
+    def deposit_trunk
+      unless defined?(@deposit_trunk)
+        # do not raise error.  this parameter will be ignored if missing
+        # raise "Moab::Config.deposit_trunk not found in config file" if Moab::Config.deposit_trunk.nil?
+        @deposit_trunk  = Moab::Config.deposit_trunk
+      end
+      @deposit_trunk
+    end
+
+    # @param object_id [String] The identifier of the digital object
+    # @return [Pathname] The branch segment of the object deposit path
+    def deposit_branch(object_id)
+       #todo This method should be customized, or overridden in a subclass
+      object_id
+    end
+
+    # @param object_id [String] The identifier of the digital object whose version is desired
+    # @param include_deposit [Boolean] specifies whether to look in deposit areas for objects in process of initial ingest
+    # @return [Pathname] The location of the desired object's home directory (default=pairtree)
+    def find_storage_root(object_id, include_deposit=false)
+      # Search for the object's home directory in the storage areas
+      branch = storage_branch(object_id)
+      storage_roots.each do |root|
+        root_trunk = root.join(storage_trunk)
+        raise "Storage area not found at #{root_trunk}" unless root_trunk.exist?
+        root_trunk_branch = root_trunk.join(branch)
+        return root if root_trunk_branch.exist?
+      end
+      # Search for the object's directory in the deposit areas
+      if include_deposit and deposit_trunk
+        branch = deposit_branch(object_id)
+        storage_roots.each do |root|
+          root_trunk = root.join(deposit_trunk)
+          raise "Deposit area not found at #{root_trunk}" unless root_trunk.exist?
+          root_trunk_branch = root_trunk.join(branch)
+          return root if root_trunk_branch.exist?
+        end
+      end
+      # object not found, will store new objects in the newest (most empty) filesystem
+      storage_roots.last
+    end
+
+    # @param object_id [String] The identifier of the digital object whose version is desired
+    # @param include_deposit [Boolean] specifies whether to look in deposit areas for objects in process of initial ingest
+    # @return [StorageObject] The representation of a digitial object's  storage directory, which might not exist yet.
+    def find_storage_object(object_id, include_deposit=false)
+      root = find_storage_root(object_id, include_deposit)
+      storage_pathname = root.join(storage_trunk, storage_branch(object_id))
+      storage_object = StorageObject.new(object_id, storage_pathname)
+      storage_object.storage_root = root
+      storage_object
+    end
+
+    # @param object_id [String] The identifier of the digital object whose version is desired
+    # @param create [Boolean] If true, the object home directory should be created if it does not exist
+    # @return [StorageObject] The representation of a digitial object's storage directory, which must exist.
+    def storage_object(object_id, create=false)
+    storage_object = find_storage_object(object_id)
+    unless storage_object.object_pathname.exist?
+      if create
+          storage_object.object_pathname.mkpath
+        else
+          raise Moab::ObjectNotFoundException, "No storage object found for #{object_id}"
+      end
+    end
+    storage_object
     end
 
+    # @depricated Please use StorageObject#ingest_bag
     # @param druid [String] The object identifier
     # @return [void] transfer the object to the preservation repository
     def store_new_object_version(druid, bag_pathname )

data/lib/moab/storage_services.rb

@@ -18,6 +18,40 @@ module Moab
     # @return [StorageRepository] an instance of the interface to SDR storage
     @@repository = Moab::StorageRepository.new
 
+    def self.repository
+      @@repository
+    end
+
+    # @return [Array<Pathname>] A list of the filesystems currently used for storage
+    def self.storage_roots
+      @@repository.storage_roots
+    end
+
+    # @return [String] The trunk segment of the object deposit path
+    def self.deposit_trunk
+      @@repository.deposit_trunk
+    end
+
+    # @param object_id [String] The identifier of the digital object
+    # @return [Pathname] The branch segment of the object deposit path
+    def self.deposit_branch(object_id)
+      @@repository.deposit_branch(object_id)
+    end
+
+    # @param object_id [String] The identifier of the digital object
+    # @param [Object] include_deposit
+    # @return [StorageObject] The representation of a digitial object's  storage directory, which might not exist yet.
+    def self.find_storage_object(object_id, include_deposit=false)
+      @@repository.find_storage_object(object_id, include_deposit)
+    end
+
+    # @param object_id [String] The identifier of the digital object whose version is desired
+    # @param create [Boolean] If true, the object home directory should be created if it does not exist
+    # @return [StorageObject] The representation of a digitial object's storage directory, which must exist.
+    def self.storage_object(object_id, create=false)
+      @@repository.storage_object(object_id, create)
+    end
+
     # @param object_id [String] The digital object identifier of the object
     # @return [String] the location of the storage object
     def self.object_path(object_id)

data/lib/monkey_patches.rb

@@ -23,6 +23,8 @@ class Time
     case datetime
       when nil
         nil
+      when ""
+        nil
       when String
         Time.parse(datetime)
       when Time

data/lib/stanford/storage_repository.rb

@@ -5,23 +5,29 @@ module Stanford
   # A class to represent the SDR repository store
   #
   # ====Data Model
-  # * <b>{StorageRepository} = represents a digital object repository storage node</b>
+  # * <b>{StorageRepository} = represents the digital object repository storage areas</b>
   #
   # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class StorageRepository < Moab::StorageRepository
 
-    # @param object_id [String] The identifier of the digital object whose version is desired
-    # @return [Pathname] The location of the desired object's home directory
-    def storage_object_pathname(object_id)
+    # @param object_id [String] The identifier of the digital object
+    # @return [String] The branch segment of the object storage path
+    def storage_branch(object_id)
       case Moab::Config.path_method.to_s
         when 'druid_tree'
-          repository_home.join(druid_tree(object_id))
+          druid_tree(object_id)
         when 'druid'
-          repository_home.join(object_id.split(/:/)[-1])
+          object_id.split(/:/)[-1]
       end
     end
 
+    # @param object_id [String] The identifier of the digital object
+    # @return [Pathname] The branch segment of the object deposit path
+    def deposit_branch(object_id)
+      object_id.split(/:/)[-1]
+    end
+
     # @param object_id [String] The identifier of the digital object whose path is requested
     # @return [String] the druid tree directory path based on the given object identifier.
     def druid_tree(object_id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moab-versioning
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Richard Anderson
@@ -10,174 +10,174 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: confstruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hashery
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: happymapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: systemu
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Contains classes to process digital object version content and metadata
@@ -233,17 +233,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Ruby implmentation of digital object versioning toolkit used by the SULAIR