moab-versioning 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29bcc835c352dfeebb39b066f380e14bd37cb1ca
-  data.tar.gz: 31912b340a667715ae00a76cfaa657962ceb73fb
+  metadata.gz: 314bede5bec369d49b3173b4cb6ca49b67dad86c
+  data.tar.gz: 2efefdc7fa3a28b69e45778fd1a373be555d4a4b
 SHA512:
-  metadata.gz: f468a3db4861d818ac143289f0a83372f23174bd0c1ff7122a69167406d8e566c049bb80a591f0b4876d50596b083e9de20913ff0ecc6f878611dcbd3d23d1e3
-  data.tar.gz: d906f907c719f412e7572d659b6ea22b2a4afa9d216f1960f437fd79774406285fae3d813c2abed36cc188a35a897495010351defa8122cd44f38e17143e4b3c
+  metadata.gz: 26daf2d5fa9f5a859676313a180ba5c73acb2e441b73cdfb6cdafc847e043521764e469512f364dead19fb0ea5d3d095f5e666d97f3362112ca08cb8b5d93685
+  data.tar.gz: 9638f3dcec4715d837abde7bc3c7f28713553692482b1ea3b93c3d654000bd6fb0cc6100af01266bc0aec94863c3f006ae9177117b4d3667af38accc67dd4925

data/lib/moab/bagger.rb

@@ -6,8 +6,10 @@ module Moab
   # A class used to create a BagIt package from a version inventory and a set of source files.
   # The {#fill_bag} method is called with a package_mode parameter that specifies
   # whether the bag is being created for deposit into the repository or is to contain the output of a version reconstruction.
-  # * In <b>:depositor</b> mode, the version inventory is filtered using the digital object's signature catalog so that only new files are included
-  # * In <b>:reconstructor</b> mode, the version inventory and signature catalog are used together to regenerate the complete set of files for the version.
+  # * In <b>:depositor</b> mode, the version inventory is filtered using the digital object's signature catalog so that only
+  #  new files are included
+  # * In <b>:reconstructor</b> mode, the version inventory and signature catalog are used together to regenerate the complete
+  #  set of files for the version.
   #
   # ====Data Model
   # * {StorageRepository} = represents a digital object repository storage node

data/lib/moab/file_inventory.rb

@@ -156,7 +156,8 @@ module Moab
     end
 
     # @api internal
-    # @return [String] Returns either the version ID (if inventory is a version manifest) or the name of the directory that was harvested to create the inventory
+    # @return [String] Returns either the version ID (if inventory is a version manifest) or the name of the directory
+    #  that was harvested to create the inventory
     def data_source
       data_source = (groups.collect { |g| g.data_source.to_s }).join('|')
       if data_source.start_with?('contentMetadata')

data/lib/moab/signature_catalog.rb

@@ -118,7 +118,10 @@ module Moab
     # @return [String] The object-relative path of the file having the specified signature
     def catalog_filepath(file_signature)
       catalog_entry = @signature_hash[file_signature]
-      raise FileNotFoundException, "catalog entry not found for #{file_signature.fixity.inspect} in #{@digital_object_id} - #{@version_id}" if catalog_entry.nil?
+      if catalog_entry.nil?
+        msg = "catalog entry not found for #{file_signature.fixity.inspect} in #{@digital_object_id} - #{@version_id}"
+        raise FileNotFoundException, msg
+      end
       catalog_entry.storage_path
     end
 

data/lib/moab/storage_object_version.rb

@@ -73,7 +73,10 @@ module Moab
     def find_filepath(file_category, file_id)
       this_version_filepath = file_pathname(file_category, file_id)
       return this_version_filepath if this_version_filepath.exist?
-      raise FileNotFoundException, "manifest file #{file_id} not found for #{@storage_object.digital_object_id} - #{@version_id}" if file_category == 'manifest'
+      if file_category == 'manifest'
+        msg = "manifest file #{file_id} not found for #{@storage_object.digital_object_id} - #{@version_id}"
+        raise FileNotFoundException, msg
+      end
       file_signature = file_inventory('version').file_signature(file_category, file_id)
       catalog_filepath = signature_catalog.catalog_filepath(file_signature)
       @storage_object.storage_filepath(catalog_filepath)

data/lib/moab/storage_repository.rb

@@ -102,6 +102,22 @@ module Moab
       storage_object
     end
 
+    # @param object_id [String] The identifier of the digital object whose size is desired
+    # @param include_deposit [Boolean] specifies whether to look in deposit areas for objects in process of initial ingest
+    # @return [Integer] the size occupied on disk by the storage object, in bytes.  this is the entire moab (all versions).
+    def object_size(object_id, include_deposit=false)
+      storage_pathname = find_storage_object(object_id, include_deposit).object_pathname
+      size = 0
+      Find.find(storage_pathname) do |path|
+        if FileTest.directory?(path)
+          Find.prune if File.basename(path)[0] == '.'
+        else
+          size += FileTest.size(path)
+        end
+      end
+      size
+    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.

data/lib/moab/storage_services.rb

@@ -45,6 +45,13 @@ module Moab
       @@repository.find_storage_object(object_id, include_deposit)
     end
 
+    # @param object_id [String] The identifier of the digital object whose size is desired
+    # @param include_deposit [Boolean] specifies whether to look in deposit areas for objects in process of initial ingest
+    # @return [Integer] the size occupied on disk by the storage object, in bytes.  this is the entire moab (all versions).
+    def self.object_size(object_id, include_deposit=false)
+      @@repository.object_size(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.

data/lib/stanford/storage_services.rb

@@ -9,8 +9,10 @@ module Stanford
     @@repository = Stanford::StorageRepository.new
 
     # @param new_content_metadata [String] The content metadata to be compared to the base
-    # @param object_id [String] The digital object identifier of the object whose version inventory is the basis of the comparison
-    # @param subset [String] Speciifes which subset of files to list in the inventories extracted from the contentMetadata (all|preserve|publish|shelve)
+    # @param object_id [String] The digital object identifier of the object whose version inventory is the basis of the
+    #  comparison
+    # @param subset [String] Speciifes which subset of files to list in the inventories extracted from the
+    #  contentMetadata (all|preserve|publish|shelve)
     # @param base_version [Integer] The ID of the version whose inventory is the basis of, if nil use latest version
     # @return [FileInventoryDifference] The report of differences between the content metadata and the specified version
     def self.compare_cm_to_version(new_content_metadata, object_id, subset, base_version=nil)
@@ -63,4 +65,4 @@ module Stanford
 
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moab-versioning
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Darren Weber
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: confstruct
@@ -153,6 +153,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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
@@ -181,6 +195,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
 description: Contains classes to process digital object version content and metadata
 email:
 - darren.weber@stanford.edu
@@ -245,10 +287,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby implementation of digital object versioning toolkit used by the SULAIR
   Digital Library
 test_files: []
-has_rdoc: