Module: ActiveRecord::Bitemporal::Bitemporalize

Defined in:
lib/activerecord-bitemporal/bitemporalize.rb

Defined Under Namespace

Modules: ClassMethods, InstanceMethods

Instance Method Summary collapse

Instance Method Details

#bitemporalize(enable_strict_by_validates_bitemporal_id: false, enable_default_scope: true, enable_merge_with_except_bitemporal_default_scope: false, valid_from_key: :valid_from, valid_to_key: :valid_to) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/activerecord-bitemporal/bitemporalize.rb', line 85

def bitemporalize(
  enable_strict_by_validates_bitemporal_id: false,
  enable_default_scope: true,
  enable_merge_with_except_bitemporal_default_scope: false,
  valid_from_key: :valid_from,
  valid_to_key: :valid_to
)
  return if ancestors.include? InstanceMethods

  extend ClassMethods
  include InstanceMethods
  include ActiveRecord::Bitemporal
  include ActiveRecord::Bitemporal::Scope
  include ActiveRecord::Bitemporal::Callbacks
  prepend ActiveRecord::Bitemporal::GlobalID if defined?(::GlobalID)

  if enable_merge_with_except_bitemporal_default_scope
    relation_delegate_class(ActiveRecord::Relation).prepend ActiveRecord::Bitemporal::Relation::MergeWithExceptBitemporalDefaultScope
  end

  if enable_default_scope
    default_scope {
      bitemporal_default_scope
    }
  end

  after_create do
    # MEMO: #update_columns is not call #_update_row (and validations, callbacks)
    update_columns(bitemporal_id_key => swapped_id) unless send(bitemporal_id_key)
    swap_id!(without_clear_changes_information: true)
    @previously_force_updated = false
  end

  after_find do
    self.swap_id! if self.send(bitemporal_id_key).present?
    @previously_force_updated = false
  end

  self.class_attribute :valid_from_key, :valid_to_key, instance_writer: false
  self.valid_from_key = valid_from_key.to_s
  self.valid_to_key = valid_to_key.to_s
  attribute valid_from_key, default: ActiveRecord::Bitemporal::DEFAULT_VALID_FROM
  attribute valid_to_key, default: ActiveRecord::Bitemporal::DEFAULT_VALID_TO
  attribute :transaction_from, default: ActiveRecord::Bitemporal::DEFAULT_TRANSACTION_FROM
  attribute :transaction_to, default: ActiveRecord::Bitemporal::DEFAULT_TRANSACTION_TO

  # Callback hook to `validates :xxx, uniqueness: true`
  const_set(:UniquenessValidator, Class.new(ActiveRecord::Validations::UniquenessValidator) {
    prepend ActiveRecord::Bitemporal::Uniqueness
  })

  # validations
  validates valid_from_key, presence: true
  validates valid_to_key, presence: true
  validates :transaction_from, presence: true
  validates :transaction_to, presence: true
  validate :valid_from_cannot_be_greater_equal_than_valid_to
  validate :transaction_from_cannot_be_greater_equal_than_transaction_to

  validates bitemporal_id_key, uniqueness: true, allow_nil: true, strict: enable_strict_by_validates_bitemporal_id

  prepend_relation_delegate_class ActiveRecord::Bitemporal::Relation
  relation_delegate_class(ActiveRecord::Associations::CollectionProxy).prepend ActiveRecord::Bitemporal::CollectionProxy
end