Module: PaperTrailDiff::Endpoint

Defined in:
lib/paper_trail_diff/endpoint.rb,
sig/generated/paper_trail_diff/endpoint.rbs

Overview

Validates and describes explicit PaperTrail-version and live-record endpoints.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.identity(endpoint) ⇒ Object

Signature:

  • (untyped) -> Array[String]



66
67
68
69
70
71
72
73
74
 
# File 'lib/paper_trail_diff/endpoint.rb', line 66

def identity(endpoint)
  if version?(endpoint)
    [endpoint.item_type.to_s, endpoint.item_id.to_s]
  elsif record?(endpoint)
    [endpoint.class.base_class.name.to_s, endpoint.id.to_s]
  else
    raise InvalidEndpointError, 'expected a PaperTrail version or persisted record endpoint'
  end
end

.model_class(version) ⇒ Object

Signature:

  • (untyped) -> untyped



77
78
79
80
81
82
83
 
# File 'lib/paper_trail_diff/endpoint.rb', line 77

def model_class(version)
  subtype = version.item_subtype if version.respond_to?(:item_subtype)
  model_type = subtype.to_s.empty? ? version.item_type.to_s : subtype.to_s
  Object.const_get(model_type)
rescue NameError => e
  raise InvalidEndpointError, "cannot resolve endpoint model: #{model_type}", cause: e
end

.record?(endpoint) ⇒ Boolean

Signature:

  • (untyped) -> bool

Returns:

  • (Boolean) 


58
59
60
61
62
63
 
# File 'lib/paper_trail_diff/endpoint.rb', line 58

def record?(endpoint)
  !version?(endpoint) &&
    endpoint.respond_to?(:persisted?) &&
    endpoint.respond_to?(:destroyed?) &&
    endpoint.class.respond_to?(:base_class)
end

.reload_record(record) ⇒ Object

Signature:

  • (untyped) -> untyped



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/paper_trail_diff/endpoint.rb', line 86

def reload_record(record)
  validate_record!(record)
  record.class.unscoped.find(record.id)
rescue StandardError => e
  active_record = Object.const_get(:ActiveRecord) #: untyped
  record_not_found = active_record.const_get(:RecordNotFound) #: untyped
  raise unless e.is_a?(record_not_found)

  message = 'current record endpoint could not be reloaded from the database'
  raise InvalidEndpointError, message, cause: e
end

.validate!(endpoint) ⇒ Object

Signature:

  • (untyped) -> void



44
45
46
47
48
 
# File 'lib/paper_trail_diff/endpoint.rb', line 44

def validate!(endpoint)
  return if version?(endpoint)

  validate_record!(endpoint)
end

.validate_order!(from_endpoint, to_endpoint) ⇒ Object

Two versions carry no visible cue about which is earlier, so transposing them is easy to do by accident and impossible to detect afterwards: the result is a valid inverse diff and carries no direction of its own. It is also redundant, because the two orders differ only in which side of each change is from. A current-record endpoint is exempt: it is self-evidently the live state, so putting it first is a deliberate reverse comparison.

Signature:

  • (untyped, untyped) -> void

Raises:



27
28
29
30
31
32
33
 
# File 'lib/paper_trail_diff/endpoint.rb', line 27

def validate_order!(from_endpoint, to_endpoint)
  return unless reversed_versions?(from_endpoint, to_endpoint)

  raise ReversedEndpointsError,
        'version endpoints must be given in chronological order; ' \
        'swap them to read the same difference in the other direction'
end

.validate_pair!(from_endpoint, to_endpoint) ⇒ Object

Signature:

  • (untyped, untyped) -> void



10
11
12
13
14
15
16
17
18
 
# File 'lib/paper_trail_diff/endpoint.rb', line 10

def validate_pair!(from_endpoint, to_endpoint)
  validate!(from_endpoint)
  validate!(to_endpoint)
  unless identity(from_endpoint) == identity(to_endpoint)
    raise VersionMismatchError, 'endpoints must belong to the same PaperTrail item'
  end

  validate_order!(from_endpoint, to_endpoint)
end

.version?(endpoint) ⇒ Boolean

Signature:

  • (untyped) -> bool

Returns:

  • (Boolean) 


51
52
53
54
55
 
# File 'lib/paper_trail_diff/endpoint.rb', line 51

def version?(endpoint)
  endpoint.respond_to?(:reify) &&
    endpoint.respond_to?(:item_type) &&
    endpoint.respond_to?(:item_id)
end

Instance Method Details

#self?.identity ⇒ Array[String]

: (untyped) -> Array

Parameters:

  • (Object)

Returns:

  • (Array[String]) 


31
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 31

def self?.identity: (untyped) -> Array[String]

#self?.model_class ⇒ Object

: (untyped) -> untyped

Parameters:

  • (Object)

Returns:

  • (Object) 


34
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 34

def self?.model_class: (untyped) -> untyped

#self?.record? ⇒ Boolean

: (untyped) -> bool

Parameters:

  • (Object)

Returns:

  • (Boolean) 


28
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 28

def self?.record?: (untyped) -> bool

#self?.reload_record ⇒ Object

: (untyped) -> untyped

Parameters:

  • (Object)

Returns:

  • (Object) 


37
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 37

def self?.reload_record: (untyped) -> untyped

#self?.reversed_versions? ⇒ Boolean

: (untyped, untyped) -> bool

Parameters:

  • (Object)
  • (Object)

Returns:

  • (Boolean) 


19
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 19

def self?.reversed_versions?: (untyped, untyped) -> bool

#self?.validate! ⇒ void

This method returns an undefined value.

: (untyped) -> void

Parameters:

  • (Object) 


22
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 22

def self?.validate!: (untyped) -> void

#self?.validate_order! ⇒ void

This method returns an undefined value.

Two versions carry no visible cue about which is earlier, so transposing them is easy to do by accident and impossible to detect afterwards: the result is a valid inverse diff and carries no direction of its own. It is also redundant, because the two orders differ only in which side of each change is from. A current-record endpoint is exempt: it is self-evidently the live state, so putting it first is a deliberate reverse comparison. : (untyped, untyped) -> void

Parameters:

  • (Object)
  • (Object) 


16
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 16

def self?.validate_order!: (untyped, untyped) -> void

#self?.validate_pair! ⇒ void

This method returns an undefined value.

: (untyped, untyped) -> void

Parameters:

  • (Object)
  • (Object) 


7
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 7

def self?.validate_pair!: (untyped, untyped) -> void

#self?.validate_record! ⇒ void

This method returns an undefined value.

: (untyped) -> void

Parameters:

  • (Object) 


40
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 40

def self?.validate_record!: (untyped) -> void

#self?.version? ⇒ Boolean

: (untyped) -> bool

Parameters:

  • (Object)

Returns:

  • (Boolean) 


25
 
# File 'sig/generated/paper_trail_diff/endpoint.rbs', line 25

def self?.version?: (untyped) -> bool