moab-versioning 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc968b3f2a7ec6e2062d2deb950cf760201ed978
-  data.tar.gz: 78964058caf89d2cda709cb61fdab039dfff3fac
+  metadata.gz: 29bcc835c352dfeebb39b066f380e14bd37cb1ca
+  data.tar.gz: 31912b340a667715ae00a76cfaa657962ceb73fb
 SHA512:
-  metadata.gz: 125858b5eeb23be2f7e1d0fd4eea84bf7d864d91f223db916a1d8f7ea4832b3ceaf58c013da0a5e2afe175382f5ccbce43a5980087b43fb06e5d2806b5f79808
-  data.tar.gz: 9a3af9b77af753dddc5c82a8f8a51d74eb9e053656c7b91d43e1de2cbcf7d76528e110dac58dfa9a5740c04874733a04c6b26b284795c50b7c5f8144d75408a0
+  metadata.gz: f468a3db4861d818ac143289f0a83372f23174bd0c1ff7122a69167406d8e566c049bb80a591f0b4876d50596b083e9de20913ff0ecc6f878611dcbd3d23d1e3
+  data.tar.gz: d906f907c719f412e7572d659b6ea22b2a4afa9d216f1960f437fd79774406285fae3d813c2abed36cc188a35a897495010351defa8122cd44f38e17143e4b3c

data/lib/moab.rb

@@ -32,7 +32,6 @@ module Moab
 end
 
 require 'serializer'
-include Serializer
 require 'confstruct/configuration'
 require 'moab/config'
 require 'moab/utc_time'

data/lib/moab/file_group.rb

@@ -15,7 +15,7 @@ module Moab
   #
   # @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 FileGroup < Serializable
+  class FileGroup < Serializer::Serializable
 
     include HappyMapper
 

data/lib/moab/file_group_difference.rb

@@ -36,7 +36,7 @@ module Moab
   #
   # @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 FileGroupDifference < Serializable
+  class FileGroupDifference < Serializer::Serializable
     include HappyMapper
 
     # The name of the XML element used to serialize this objects data

data/lib/moab/file_group_difference_subset.rb

@@ -13,7 +13,7 @@ module Moab
   #
   # @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 FileGroupDifferenceSubset < Serializable
+  class FileGroupDifferenceSubset < Serializer::Serializable
     include HappyMapper
 
     # The name of the XML element used to serialize this objects data

data/lib/moab/file_instance.rb

@@ -13,7 +13,7 @@ module Moab
   #
   # @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 FileInstance < Serializable
+  class FileInstance < Serializer::Serializable
 
     include HappyMapper
 

data/lib/moab/file_instance_difference.rb

@@ -20,7 +20,7 @@ module Moab
   #
   # @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 FileInstanceDifference  < Serializable
+  class FileInstanceDifference  < Serializer::Serializable
 
     include HappyMapper
 

data/lib/moab/file_inventory.rb

@@ -28,7 +28,7 @@ module Moab
   # @example {include:file:spec/fixtures/derivatives/manifests/v3/versionInventory.xml}
   # @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 FileInventory < Manifest
+  class FileInventory < Serializer::Manifest
 
     include HappyMapper
 

data/lib/moab/file_inventory_difference.rb

@@ -17,7 +17,7 @@ module Moab
   # @example {include:file:spec/fixtures/derivatives/manifests/all/fileInventoryDifference.xml}
   # @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 FileInventoryDifference < Manifest
+  class FileInventoryDifference < Serializer::Manifest
 
     include HappyMapper
 

data/lib/moab/file_manifestation.rb

@@ -17,7 +17,7 @@ module Moab
   #
   # @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 FileManifestation < Serializable
+  class FileManifestation < Serializer::Serializable
     include HappyMapper
 
     # The name of the XML element used to serialize this objects data

data/lib/moab/file_signature.rb

@@ -39,7 +39,7 @@ module Moab
   #
   # @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 FileSignature < Serializable
+  class FileSignature < Serializer::Serializable
 
     include HappyMapper
 

data/lib/moab/signature_catalog.rb

@@ -25,7 +25,7 @@ module Moab
   # @see Bagger
   # @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 SignatureCatalog < Manifest
+  class SignatureCatalog < Serializer::Manifest
     include HappyMapper
 
     # The name of the XML element used to serialize this objects data

data/lib/moab/signature_catalog_entry.rb

@@ -13,7 +13,7 @@ module Moab
   #
   # @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 SignatureCatalogEntry < Serializable
+  class SignatureCatalogEntry < Serializer::Serializable
 
     include HappyMapper
 

data/lib/{moab_stanford.rb → moab/stanford.rb}

@@ -1,5 +1,4 @@
 require 'moab'
-include Moab
 require 'stanford/content_inventory'
 require 'stanford/dor_metadata'
 require 'stanford/storage_repository'

data/lib/moab/version_metadata.rb

@@ -12,7 +12,7 @@ module Moab
   # @example {include:file:spec/fixtures/data/jq937jp0017/v3/metadata/versionMetadata.xml}
   # @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 VersionMetadata < Manifest
+  class VersionMetadata < Serializer::Manifest
 
     include HappyMapper
 

data/lib/moab/version_metadata_entry.rb

@@ -11,7 +11,7 @@ module Moab
   #
   # @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 VersionMetadataEntry < Serializable
+  class VersionMetadataEntry < Serializer::Serializable
 
     include HappyMapper
 

data/lib/moab/version_metadata_event.rb

@@ -13,7 +13,7 @@ module Moab
   # @see VersionMetadataEntry
   # @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 VersionMetadataEvent < Serializable
+  class VersionMetadataEvent < Serializer::Serializable
 
     include HappyMapper
 

data/lib/serializer/manifest.rb

@@ -10,7 +10,7 @@ module Serializer
   # @see Serializable
   # @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 Manifest < Serializable
+  class Manifest < Serializer::Serializable
 
     include HappyMapper
 

data/lib/serializer/serializable.rb

@@ -146,7 +146,7 @@ module Serializer
         when 2
           ltag, left, rtag, right = :left, hashes[0], :right, hashes[1]
         else
-          raise "wrong number of arguments (expected 2 or 4)"
+          raise ArgumentError, "wrong number of arguments (#{hashes.length} for 2 or 4)"
       end
       (left.keys | right.keys).each do |k|
         if left[k] != right[k]

data/lib/stanford/active_fedora_object.rb

@@ -1,4 +1,4 @@
-require 'moab_stanford'
+require 'moab/stanford'
 
 module Stanford
 

data/lib/stanford/content_inventory.rb

@@ -1,4 +1,4 @@
-require 'moab_stanford'
+require 'moab/stanford'
 
 module Stanford
 
@@ -24,7 +24,7 @@ module Stanford
       # Many of these objects have contentMetadata with no child elements, such as this:
       #    <contentMetadata objectId="bd608mj3166" type="file"/>
       # but there are also objects that have no datasteam of this name at all
-      cm_inventory = FileInventory.new(:type=>"version",:digital_object_id=>object_id, :version_id=>version_id)
+      cm_inventory = Moab::FileInventory.new(:type=>"version",:digital_object_id=>object_id, :version_id=>version_id)
       content_group = group_from_cm(content_metadata, subset)
       cm_inventory.groups << content_group
       cm_inventory
@@ -50,7 +50,7 @@ module Stanford
         else
             raise "Unknown disposition subset (#{subset})"
         end
-      content_group = FileGroup.new(:group_id=>'content', :data_source => "contentMetadata-#{subset}")
+      content_group = Moab::FileGroup.new(:group_id=>'content', :data_source => "contentMetadata-#{subset}")
       nodeset.each do |file_node|
         signature = generate_signature(file_node)
         instance = generate_instance(file_node)
@@ -63,7 +63,7 @@ module Stanford
     # @param node [Nokogiri::XML::Node] The XML node containing file information
     # @return [FileSignature] The {FileSignature} object generated from the XML data
     def generate_signature(node)
-      signature = FileSignature.new()
+      signature = Moab::FileSignature.new()
       signature.size = node.attributes['size'].content
       checksum_nodes = node.xpath('checksum')
       checksum_nodes.each do |checksum_node|
@@ -83,7 +83,7 @@ module Stanford
     # @param node (see #generate_signature)
     # @return [FileInstance] The {FileInstance} object generated from the XML data
     def generate_instance(node)
-      instance = FileInstance.new()
+      instance = Moab::FileInstance.new()
       instance.path = node.attributes['id'].content
       instance.datetime = node.attributes['datetime'].content rescue nil
       instance
@@ -175,8 +175,8 @@ module Stanford
       return nil if content_metadata.nil?
       return content_metadata if content_group.nil? or content_group.files.size < 1
       signature_for_path = content_group.path_hash
-      @type_for_name = FileSignature.checksum_type_for_name
-      @names_for_type = FileSignature.checksum_names_for_type
+      @type_for_name = Moab::FileSignature.checksum_type_for_name
+      @names_for_type = Moab::FileSignature.checksum_names_for_type
       ng_doc = Nokogiri::XML(content_metadata) { |x| x.noblanks }
       nodeset = ng_doc.xpath("//file")
       nodeset.each do |file_node|

data/lib/stanford/dor_metadata.rb

@@ -1,4 +1,4 @@
-require 'moab_stanford'
+require 'moab/stanford'
 
 module Stanford
 
@@ -33,11 +33,11 @@ module Stanford
     # @return [FileInventory]  Inventory of the files under the specified directory
     def inventory_from_directory(directory, version_id=nil)
       version_id ||= @version_id
-      version_inventory = FileInventory.new(:type=>'version',:digital_object_id=>@digital_object_id, :version_id=>version_id)
+      version_inventory = Moab::FileInventory.new(:type=>'version',:digital_object_id=>@digital_object_id, :version_id=>version_id)
       content_metadata = IO.read(File.join(directory,'contentMetadata.xml'))
-      content_group = ContentInventory.new.group_from_cm(content_metadata, 'preserve' )
+      content_group = Stanford::ContentInventory.new.group_from_cm(content_metadata, 'preserve' )
       version_inventory.groups << content_group
-      metadata_group = FileGroup.new(:group_id=>'metadata').group_from_directory(directory)
+      metadata_group = Moab::FileGroup.new(:group_id=>'metadata').group_from_directory(directory)
       version_inventory.groups << metadata_group
       version_inventory
     end

data/lib/stanford/storage_repository.rb

@@ -1,4 +1,4 @@
-require 'moab_stanford'
+require 'moab/stanford'
 
 module Stanford
 

data/lib/stanford/storage_services.rb

@@ -1,4 +1,4 @@
-require 'moab_stanford'
+require 'moab/stanford'
 
 module Stanford
 
@@ -14,20 +14,20 @@ module Stanford
     # @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)
-      new_inventory = ContentInventory.new.inventory_from_cm(new_content_metadata, object_id, subset)
+      new_inventory = Stanford::ContentInventory.new.inventory_from_cm(new_content_metadata, object_id, subset)
       begin
         # ObjectNotFoundException is raised if the object does not exist in storage
         base_version ||= self.current_version(object_id)
         # FileNotFoundException is raised if object exists but has no contentMetadata file
         base_cm_pathname = self.retrieve_file('metadata', 'contentMetadata.xml', object_id, base_version)
-        base_inventory = ContentInventory.new.inventory_from_cm(base_cm_pathname.read, object_id, subset, base_version)
+        base_inventory = Stanford::ContentInventory.new.inventory_from_cm(base_cm_pathname.read, object_id, subset, base_version)
       rescue Moab::ObjectNotFoundException, Moab::FileNotFoundException
         # Create a skeletal FileInventory object, containing no file entries
-        storage_object = StorageObject.new(object_id, 'dummy')
-        base_version = StorageObjectVersion.new(storage_object,0)
+        storage_object = Moab::StorageObject.new(object_id, 'dummy')
+        base_version = Moab::StorageObjectVersion.new(storage_object,0)
         base_inventory = base_version.file_inventory('version')
       end
-      diff = FileInventoryDifference.new.compare(base_inventory, new_inventory)
+      diff = Moab::FileInventoryDifference.new.compare(base_inventory, new_inventory)
       metadata_diff = diff.group_difference('metadata')
       diff.group_differences.delete(metadata_diff) if metadata_diff
       diff
@@ -38,15 +38,15 @@ module Stanford
     # @param version_id [Integer] The ID of the version whose signature catalog is to be used, if nil use latest version
     # @return [FileInventory] The versionAddtions report showing which files are new or modified in the content metadata
     def self.cm_version_additions(new_content_metadata, object_id, version_id=nil)
-      new_inventory = ContentInventory.new.inventory_from_cm(new_content_metadata, object_id, 'preserve')
+      new_inventory = Stanford::ContentInventory.new.inventory_from_cm(new_content_metadata, object_id, 'preserve')
       begin
         # ObjectNotFoundException is raised if the object does not exist in storage
         version_id ||= self.current_version(object_id)
         storage_object_version = @@repository.storage_object(object_id).find_object_version(version_id)
         signature_catalog = storage_object_version.signature_catalog
       rescue Moab::ObjectNotFoundException
-        storage_object = StorageObject.new(object_id, 'dummy')
-        base_version = StorageObjectVersion.new(storage_object,0)
+        storage_object = Moab::StorageObject.new(object_id, 'dummy')
+        base_version = Moab::StorageObjectVersion.new(storage_object,0)
         signature_catalog = base_version.signature_catalog
       end
       signature_catalog.version_additions(new_inventory)
@@ -58,7 +58,7 @@ module Stanford
     def self.cm_remediate(object_id, version_id=nil)
       cm = self.retrieve_file('metadata', 'contentMetadata.xml', object_id, version_id)
       group = self.retrieve_file_group('content', object_id, version_id)
-      ContentInventory.new.remediate_content_metadata(cm,group)
+      Stanford::ContentInventory.new.remediate_content_metadata(cm,group)
     end
 
   end

data/lib/tools/api_doc_generator.rb

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'pathname'
 require 'yard'
 include YARD
-require 'moab_stanford'
+require 'moab/stanford'
 include Serializer
 include Moab
 include Stanford

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moab-versioning
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Darren Weber
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-19 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: confstruct
@@ -203,6 +203,7 @@ files:
 - lib/moab/file_signature.rb
 - lib/moab/signature_catalog.rb
 - lib/moab/signature_catalog_entry.rb
+- lib/moab/stanford.rb
 - lib/moab/storage_object.rb
 - lib/moab/storage_object_version.rb
 - lib/moab/storage_repository.rb
@@ -212,7 +213,6 @@ files:
 - lib/moab/version_metadata.rb
 - lib/moab/version_metadata_entry.rb
 - lib/moab/version_metadata_event.rb
-- lib/moab_stanford.rb
 - lib/serializer.rb
 - lib/serializer/manifest.rb
 - lib/serializer/serializable.rb
@@ -235,9 +235,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -245,9 +245,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.4.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: