Class: Moab::FileInstanceDifference

Inherits:

Serializer::Serializable

• Object
• Serializer::Serializable
• Moab::FileInstanceDifference

Includes:

HappyMapper

Defined in:

lib/moab/file_instance_difference.rb

Overview

Note:

Copyright © 2012 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved. See LICENSE for details.

A container for recording difference information at the file level

• If there was no change, the change type is set to identical

• If the signature is unchanged, but the path has moved, the change type is set to renamed

• If path is unchanged, but the signature has changed, the change type is set to modified and

both signatures are reported

• If the signature and path are only in the basis inventory, the change type is set to deleted

• If the signature and path are only in the other inventory, the change type is set to added

This is a child element of FileGroupDifferenceSubset, which is in turn a descendent of FileInventoryDifference, the documentation of which contains a full example

Data Model

• FileInventoryDifference = compares two FileInventory instances based on file signatures and pathnames

  • FileGroupDifference [1..*] = performs analysis and reports differences between two matching FileGroup objects

    • FileGroupDifferenceSubset [1..5] = collects a set of file-level differences of a give change type

      • FileInstanceDifference [1..*] = contains difference information at the file level

        • FileSignature [1..2] = contains the file signature(s) of two file instances being compared

Instance Attribute Summary

• #basis_path ⇒ String

  The file’s path in the basis inventory (usually for an old version).

• #change ⇒ String

  The type of file change.

• #other_path ⇒ String

  The file’s path in the other inventory (usually for an new version) compared against the basis.

• #signatures ⇒ Array<FileSignature>

  The fixity data of the file manifestation(s) (plural if change was a content modification).

Instance Method Summary

• #initialize(opts = {}) ⇒ FileInstanceDifference constructor

  A new instance of FileInstanceDifference.

Methods inherited from Serializer::Serializable

#array_to_hash, deep_diff, #diff, #key, #key_name, #summary, #to_hash, #to_json, #to_yaml, #variable_names, #variables

Constructor Details

#initialize(opts = {}) ⇒ FileInstanceDifference

Returns a new instance of FileInstanceDifference.

# File 'lib/moab/file_instance_difference.rb', line 28

def initialize(opts = {})
  @signatures = []
  super(opts)
end

Instance Attribute Details

#basis_path ⇒ String

Returns The file’s path in the basis inventory (usually for an old version).

Returns:

• (String) —

  The file’s path in the basis inventory (usually for an old version)

# File 'lib/moab/file_instance_difference.rb', line 39

attribute :basis_path, String, :tag => 'basisPath', :on_save => proc { |s| s.to_s }

#change ⇒ String

Returns The type of file change.

Returns:

• (String) —

  The type of file change

# File 'lib/moab/file_instance_difference.rb', line 35

attribute :change, String

#other_path ⇒ String

Returns The file’s path in the other inventory (usually for an new version) compared against the basis.

Returns:

• (String) —

  The file’s path in the other inventory (usually for an new version) compared against the basis

# File 'lib/moab/file_instance_difference.rb', line 43

attribute :other_path, String, :tag => 'otherPath', :on_save => proc { |s| s.to_s }

#signatures ⇒ Array<FileSignature>

Returns The fixity data of the file manifestation(s) (plural if change was a content modification).

Returns:

• (Array<FileSignature>) —

  The fixity data of the file manifestation(s) (plural if change was a content modification)

# File 'lib/moab/file_instance_difference.rb', line 47

has_many :signatures, FileSignature, :tag => 'fileSignature'