Class: OriginRelationship

Inherits:
ApplicationRecord show all
Includes:
Housekeeping, Shared::IsData, Shared::PolymorphicAnnotator
Defined in:
app/models/origin_relationship.rb

Overview

An OriginRelationship asserts that one object is derived_from another.

The old object is the source_of or origin_of the new object. The new object originates_from the old_object.

Currently these combinations are planned (* not implemented):

old_object / new_object

  • field_observation / collection_object

collection_object / collection_object collection_object / extract

  • collection_object / part_of (anatomy)

  • part_of / part_of

  • part_of / extract

extract / extract extract / sequence sequence / sequence

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Shared::PolymorphicAnnotator

#annotated_object_is_persisted?

Methods included from Shared::IsData

#errors_excepting, #full_error_messages_excepting, #identical, #is_community?, #is_destroyable?, #is_editable?, #is_in_use?, #is_in_users_projects?, #metamorphosize, #similar

Methods included from Housekeeping

#has_polymorphic_relationship?

Methods inherited from ApplicationRecord

transaction_with_retry

Instance Attribute Details

#new_object_id ⇒ Integer

Returns id of the new (original) object.

Returns:

  • (Integer) —

    id of the new (original) object



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'app/models/origin_relationship.rb', line 44

class OriginRelationship < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::PolymorphicAnnotator

  polymorphic_annotates('old_object', presence_validate: false)
  polymorphic_annotates('new_object', presence_validate: false)

  acts_as_list scope: [:project_id, :old_object_id, :old_object_type]

  belongs_to :old_object, polymorphic: true
  belongs_to :new_object, polymorphic: true

  # The two validations, and the inclusion of the Shared::OriginRelationship code
  # ensure that new/old objects are indeed ones that are allowed (otherwise we will get Raises, which means the UI is messed up)
  validates_presence_of :new_object
  validates_presence_of :old_object

  validate :old_object_responds
  validate :new_object_responds
  validate :pairing_is_allowed, unless: -> {!errors.empty?}

  validate :not_a_clone

  private

  def old_object_responds
    errors.add(:old_object, "#{old_object.class.name} is not a legal part of an origin relationship") if !(old_object.class < Shared::OriginRelationship)
  end

  def new_object_responds
    errors.add(:new_object, "#{new_object.class.name} is not a legal part of an origin relationship") if !(new_object.class < Shared::OriginRelationship)
  end

  def pairing_is_allowed
    errors.add(:old_object, "#{old_object_type} is not a valid origin relationship old object of a #{old_object.class.name}") if !new_object.valid_old_object_classes.include?(old_object.class.name)
    errors.add(:new_object, "#{new_object_type} is not a valid origin relationship new object of a #{new_object.class.name}") if !old_object.valid_new_object_classes.include?(new_object.class.name)
  end

  def not_a_clone
    if (old_object == new_object) || ((old_object_type == new_object_type) && (old_object_id == new_object_id))
      errors.add(:old_object, 'objects can not be cloned (related to each other)')
    end
  end

end

#new_object_type ⇒ Integer

Returns type of the new (original) object.

Returns:

  • (Integer) —

    type of the new (original) object



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'app/models/origin_relationship.rb', line 44

class OriginRelationship < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::PolymorphicAnnotator

  polymorphic_annotates('old_object', presence_validate: false)
  polymorphic_annotates('new_object', presence_validate: false)

  acts_as_list scope: [:project_id, :old_object_id, :old_object_type]

  belongs_to :old_object, polymorphic: true
  belongs_to :new_object, polymorphic: true

  # The two validations, and the inclusion of the Shared::OriginRelationship code
  # ensure that new/old objects are indeed ones that are allowed (otherwise we will get Raises, which means the UI is messed up)
  validates_presence_of :new_object
  validates_presence_of :old_object

  validate :old_object_responds
  validate :new_object_responds
  validate :pairing_is_allowed, unless: -> {!errors.empty?}

  validate :not_a_clone

  private

  def old_object_responds
    errors.add(:old_object, "#{old_object.class.name} is not a legal part of an origin relationship") if !(old_object.class < Shared::OriginRelationship)
  end

  def new_object_responds
    errors.add(:new_object, "#{new_object.class.name} is not a legal part of an origin relationship") if !(new_object.class < Shared::OriginRelationship)
  end

  def pairing_is_allowed
    errors.add(:old_object, "#{old_object_type} is not a valid origin relationship old object of a #{old_object.class.name}") if !new_object.valid_old_object_classes.include?(old_object.class.name)
    errors.add(:new_object, "#{new_object_type} is not a valid origin relationship new object of a #{new_object.class.name}") if !old_object.valid_new_object_classes.include?(new_object.class.name)
  end

  def not_a_clone
    if (old_object == new_object) || ((old_object_type == new_object_type) && (old_object_id == new_object_id))
      errors.add(:old_object, 'objects can not be cloned (related to each other)')
    end
  end

end

#old_object_id ⇒ Integer

Returns id of the old (original) object.

Returns:

  • (Integer) —

    id of the old (original) object



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'app/models/origin_relationship.rb', line 44

class OriginRelationship < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::PolymorphicAnnotator

  polymorphic_annotates('old_object', presence_validate: false)
  polymorphic_annotates('new_object', presence_validate: false)

  acts_as_list scope: [:project_id, :old_object_id, :old_object_type]

  belongs_to :old_object, polymorphic: true
  belongs_to :new_object, polymorphic: true

  # The two validations, and the inclusion of the Shared::OriginRelationship code
  # ensure that new/old objects are indeed ones that are allowed (otherwise we will get Raises, which means the UI is messed up)
  validates_presence_of :new_object
  validates_presence_of :old_object

  validate :old_object_responds
  validate :new_object_responds
  validate :pairing_is_allowed, unless: -> {!errors.empty?}

  validate :not_a_clone

  private

  def old_object_responds
    errors.add(:old_object, "#{old_object.class.name} is not a legal part of an origin relationship") if !(old_object.class < Shared::OriginRelationship)
  end

  def new_object_responds
    errors.add(:new_object, "#{new_object.class.name} is not a legal part of an origin relationship") if !(new_object.class < Shared::OriginRelationship)
  end

  def pairing_is_allowed
    errors.add(:old_object, "#{old_object_type} is not a valid origin relationship old object of a #{old_object.class.name}") if !new_object.valid_old_object_classes.include?(old_object.class.name)
    errors.add(:new_object, "#{new_object_type} is not a valid origin relationship new object of a #{new_object.class.name}") if !old_object.valid_new_object_classes.include?(new_object.class.name)
  end

  def not_a_clone
    if (old_object == new_object) || ((old_object_type == new_object_type) && (old_object_id == new_object_id))
      errors.add(:old_object, 'objects can not be cloned (related to each other)')
    end
  end

end

#old_object_type ⇒ Integer

Returns type of the old (original) object.

Returns:

  • (Integer) —

    type of the old (original) object



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'app/models/origin_relationship.rb', line 44

class OriginRelationship < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::PolymorphicAnnotator

  polymorphic_annotates('old_object', presence_validate: false)
  polymorphic_annotates('new_object', presence_validate: false)

  acts_as_list scope: [:project_id, :old_object_id, :old_object_type]

  belongs_to :old_object, polymorphic: true
  belongs_to :new_object, polymorphic: true

  # The two validations, and the inclusion of the Shared::OriginRelationship code
  # ensure that new/old objects are indeed ones that are allowed (otherwise we will get Raises, which means the UI is messed up)
  validates_presence_of :new_object
  validates_presence_of :old_object

  validate :old_object_responds
  validate :new_object_responds
  validate :pairing_is_allowed, unless: -> {!errors.empty?}

  validate :not_a_clone

  private

  def old_object_responds
    errors.add(:old_object, "#{old_object.class.name} is not a legal part of an origin relationship") if !(old_object.class < Shared::OriginRelationship)
  end

  def new_object_responds
    errors.add(:new_object, "#{new_object.class.name} is not a legal part of an origin relationship") if !(new_object.class < Shared::OriginRelationship)
  end

  def pairing_is_allowed
    errors.add(:old_object, "#{old_object_type} is not a valid origin relationship old object of a #{old_object.class.name}") if !new_object.valid_old_object_classes.include?(old_object.class.name)
    errors.add(:new_object, "#{new_object_type} is not a valid origin relationship new object of a #{new_object.class.name}") if !old_object.valid_new_object_classes.include?(new_object.class.name)
  end

  def not_a_clone
    if (old_object == new_object) || ((old_object_type == new_object_type) && (old_object_id == new_object_id))
      errors.add(:old_object, 'objects can not be cloned (related to each other)')
    end
  end

end

#position ⇒ Integer

Returns order relative to old object.

Returns:

  • (Integer) —

    order relative to old object



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'app/models/origin_relationship.rb', line 44

class OriginRelationship < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::PolymorphicAnnotator

  polymorphic_annotates('old_object', presence_validate: false)
  polymorphic_annotates('new_object', presence_validate: false)

  acts_as_list scope: [:project_id, :old_object_id, :old_object_type]

  belongs_to :old_object, polymorphic: true
  belongs_to :new_object, polymorphic: true

  # The two validations, and the inclusion of the Shared::OriginRelationship code
  # ensure that new/old objects are indeed ones that are allowed (otherwise we will get Raises, which means the UI is messed up)
  validates_presence_of :new_object
  validates_presence_of :old_object

  validate :old_object_responds
  validate :new_object_responds
  validate :pairing_is_allowed, unless: -> {!errors.empty?}

  validate :not_a_clone

  private

  def old_object_responds
    errors.add(:old_object, "#{old_object.class.name} is not a legal part of an origin relationship") if !(old_object.class < Shared::OriginRelationship)
  end

  def new_object_responds
    errors.add(:new_object, "#{new_object.class.name} is not a legal part of an origin relationship") if !(new_object.class < Shared::OriginRelationship)
  end

  def pairing_is_allowed
    errors.add(:old_object, "#{old_object_type} is not a valid origin relationship old object of a #{old_object.class.name}") if !new_object.valid_old_object_classes.include?(old_object.class.name)
    errors.add(:new_object, "#{new_object_type} is not a valid origin relationship new object of a #{new_object.class.name}") if !old_object.valid_new_object_classes.include?(new_object.class.name)
  end

  def not_a_clone
    if (old_object == new_object) || ((old_object_type == new_object_type) && (old_object_id == new_object_id))
      errors.add(:old_object, 'objects can not be cloned (related to each other)')
    end
  end

end

#project_id ⇒ Integer

Returns the project ID.

Returns:

  • (Integer) —

    the project ID



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'app/models/origin_relationship.rb', line 44

class OriginRelationship < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::PolymorphicAnnotator

  polymorphic_annotates('old_object', presence_validate: false)
  polymorphic_annotates('new_object', presence_validate: false)

  acts_as_list scope: [:project_id, :old_object_id, :old_object_type]

  belongs_to :old_object, polymorphic: true
  belongs_to :new_object, polymorphic: true

  # The two validations, and the inclusion of the Shared::OriginRelationship code
  # ensure that new/old objects are indeed ones that are allowed (otherwise we will get Raises, which means the UI is messed up)
  validates_presence_of :new_object
  validates_presence_of :old_object

  validate :old_object_responds
  validate :new_object_responds
  validate :pairing_is_allowed, unless: -> {!errors.empty?}

  validate :not_a_clone

  private

  def old_object_responds
    errors.add(:old_object, "#{old_object.class.name} is not a legal part of an origin relationship") if !(old_object.class < Shared::OriginRelationship)
  end

  def new_object_responds
    errors.add(:new_object, "#{new_object.class.name} is not a legal part of an origin relationship") if !(new_object.class < Shared::OriginRelationship)
  end

  def pairing_is_allowed
    errors.add(:old_object, "#{old_object_type} is not a valid origin relationship old object of a #{old_object.class.name}") if !new_object.valid_old_object_classes.include?(old_object.class.name)
    errors.add(:new_object, "#{new_object_type} is not a valid origin relationship new object of a #{new_object.class.name}") if !old_object.valid_new_object_classes.include?(new_object.class.name)
  end

  def not_a_clone
    if (old_object == new_object) || ((old_object_type == new_object_type) && (old_object_id == new_object_id))
      errors.add(:old_object, 'objects can not be cloned (related to each other)')
    end
  end

end

Instance Method Details

#new_object_responds ⇒ Object (private) 



74
75
76
 
# File 'app/models/origin_relationship.rb', line 74

def new_object_responds
  errors.add(:new_object, "#{new_object.class.name} is not a legal part of an origin relationship") if !(new_object.class < Shared::OriginRelationship)
end

#not_a_clone ⇒ Object (private) 



83
84
85
86
87
 
# File 'app/models/origin_relationship.rb', line 83

def not_a_clone
  if (old_object == new_object) || ((old_object_type == new_object_type) && (old_object_id == new_object_id))
    errors.add(:old_object, 'objects can not be cloned (related to each other)')
  end
end

#old_object_responds ⇒ Object (private) 



70
71
72
 
# File 'app/models/origin_relationship.rb', line 70

def old_object_responds
  errors.add(:old_object, "#{old_object.class.name} is not a legal part of an origin relationship") if !(old_object.class < Shared::OriginRelationship)
end

#pairing_is_allowed ⇒ Object (private) 



78
79
80
81
 
# File 'app/models/origin_relationship.rb', line 78

def pairing_is_allowed
  errors.add(:old_object, "#{old_object_type} is not a valid origin relationship old object of a #{old_object.class.name}") if !new_object.valid_old_object_classes.include?(old_object.class.name)
  errors.add(:new_object, "#{new_object_type} is not a valid origin relationship new object of a #{new_object.class.name}") if !old_object.valid_new_object_classes.include?(new_object.class.name)
end