Module: Sequel::Plugins::Bitemporal

Defined in:
lib/sequel_bitemporal.rb,
lib/sequel/plugins/bitemporal.rb

Defined Under Namespace

Modules: ClassMethods, DatasetMethods, InstanceMethods

Constant Summary collapse

THREAD_POINT_IN_TIME_KEY =
:sequel_plugins_bitemporal_point_in_time
THREAD_NOW_KEY =
:sequel_plugins_bitemporal_now

Class Method Summary collapse

Class Method Details

.as_we_knew_it(time) ⇒ Object



7
8
9
10
11
12
13
14
# File 'lib/sequel/plugins/bitemporal.rb', line 7

def self.as_we_knew_it(time)
  previous = Thread.current[THREAD_POINT_IN_TIME_KEY]
  raise ArgumentError, "requires a block" unless block_given?
  Thread.current[THREAD_POINT_IN_TIME_KEY] = time.to_datetime
  yield
ensure
  Thread.current[THREAD_POINT_IN_TIME_KEY] = previous
end

.at(time) ⇒ Object



21
22
23
24
25
26
27
28
# File 'lib/sequel/plugins/bitemporal.rb', line 21

def self.at(time)
  previous = Thread.current[THREAD_NOW_KEY]
  raise ArgumentError, "requires a block" unless block_given?
  Thread.current[THREAD_NOW_KEY] = time.to_datetime
  yield
ensure
  Thread.current[THREAD_NOW_KEY] = previous
end

.bitemporal_excluded_columnsObject



38
39
40
# File 'lib/sequel/plugins/bitemporal.rb', line 38

def self.bitemporal_excluded_columns
  @bitemporal_excluded_columns ||= [:id, *bitemporal_version_columns]
end

.bitemporal_version_columnsObject



34
35
36
# File 'lib/sequel/plugins/bitemporal.rb', line 34

def self.bitemporal_version_columns
  @bitemporal_version_columns ||= [:master_id, :valid_from, :valid_to, :created_at, :expired_at]
end

.configure(master, opts = {}) ⇒ Object

Raises:

  • (Error)


42
43
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
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/sequel/plugins/bitemporal.rb', line 42

def self.configure(master, opts = {})
  version = opts[:version_class]
  raise Error, "please specify version class to use for bitemporal plugin" unless version
  return version.db.log_info("Version table does not exist for #{version.name}") unless version.db.table_exists?(version.table_name)
  missing = bitemporal_version_columns - version.columns
  raise Error, "bitemporal plugin requires the following missing column#{"s" if missing.size>1} on version class: #{missing.join(", ")}" unless missing.empty?

  if Sequel::Plugins::Bitemporal.pg_jdbc?(master.db)
    master.plugin :pg_typecast_on_load, *master.columns
  elsif Sequel::Plugins::Bitemporal.jdbc?(master.db)
    master.plugin :typecast_on_load, *master.columns
  end

  master.instance_eval do
    @version_class = version
    base_alias = opts.fetch :base_alias do
      name ? underscore(demodulize(name)) : table_name
    end
    @versions_alias = "#{base_alias}_versions".to_sym
    @current_version_alias = "#{base_alias}_current_version".to_sym
    @audit_class = opts[:audit_class]
    @audit_updated_by_method = opts.fetch(:audit_updated_by_method){ :updated_by }
    @propagate_per_column = opts.fetch(:propagate_per_column, false)
    @version_uses_string_nilifier = version.plugins.map(&:to_s).include? "Sequel::Plugins::StringNilifier"
    @excluded_columns = Sequel::Plugins::Bitemporal.bitemporal_excluded_columns
    @excluded_columns += Array opts[:excluded_columns] if opts[:excluded_columns]
    @use_ranges = if opts[:ranges]
      db = self.db
      unless db.database_type==:postgres && db.server_version >= 90200
        raise "Ranges require PostgreSQL 9.2"
      end
      true
    else
      false
    end
  end
  master.class_eval do
    def self.current_versions_dataset
      t = ::Sequel::Plugins::Bitemporal.point_in_time
      n = ::Sequel::Plugins::Bitemporal.now
      version_class.where do
        (created_at <= t) &
        (Sequel.|({expired_at=>nil}, expired_at > t)) &
        (valid_from <= n) &
        (valid_to > n)
      end
    end
  end
  master.one_to_many :versions, class: version, key: :master_id, graph_alias_base: master.versions_alias
  master.one_to_one :current_version, class: version, key: :master_id, graph_alias_base: master.current_version_alias, :graph_block=>(proc do |j, lj, js|
    t = Sequel.delay{ ::Sequel::Plugins::Bitemporal.point_in_time }
    n = Sequel.delay{ ::Sequel::Plugins::Bitemporal.now }
    if master.use_ranges
      master.existence_range_contains(t, j) &
      master.validity_range_contains(n, j)
    else
      e = Sequel.qualify j, :expired_at
      (Sequel.qualify(j, :created_at) <= t) &
      (Sequel.|({e=>nil}, e > t)) &
      (Sequel.qualify(j, :valid_from) <= n) &
      (Sequel.qualify(j, :valid_to) > n)
    end
  end) do |ds|
    t = Sequel.delay{ ::Sequel::Plugins::Bitemporal.point_in_time }
    n = Sequel.delay{ ::Sequel::Plugins::Bitemporal.now }
    if master.use_ranges
      ds.where(master.existence_range_contains(t) & master.validity_range_contains(n))
    else
      ds.where do
        (created_at <= t) &
        (Sequel.|({expired_at=>nil}, expired_at > t)) &
        (valid_from <= n) &
        (valid_to > n)
      end
    end
  end
  master.def_dataset_method :with_current_version do
    eager_graph(:current_version).where(
      Sequel.negate(
        Sequel.qualify(model.current_version_alias, :id) => nil
      )
    )
  end
  master.one_to_many :current_or_future_versions, class: version, key: :master_id, :graph_block=>(proc do |j, lj, js|
    t = Sequel.delay{ ::Sequel::Plugins::Bitemporal.point_in_time }
    n = Sequel.delay{ ::Sequel::Plugins::Bitemporal.now }
    if master.use_ranges
      master.existence_range_contains(t, j) &
      (Sequel.qualify(j, :valid_to) > n) &
      (Sequel.qualify(j, :valid_from) != Sequel.qualify(j, :valid_to))
    else
      e = Sequel.qualify j, :expired_at
      (Sequel.qualify(j, :created_at) <= t) &
      Sequel.|({e=>nil}, e > t) &
      (Sequel.qualify(j, :valid_to) > n) &
      (Sequel.qualify(j, :valid_from) != Sequel.qualify(j, :valid_to))
    end
  end) do |ds|
    t = Sequel.delay{ ::Sequel::Plugins::Bitemporal.point_in_time }
    n = Sequel.delay{ ::Sequel::Plugins::Bitemporal.now }
    if master.use_ranges
      existence_conditions = master.existence_range_contains t
      ds.where{ existence_conditions & (:valid_to > n) & (:valid_from != :valid_to) }
    else
      ds.where do
        (created_at <= t) &
        Sequel.|({expired_at=>nil}, expired_at > t) &
        (valid_to > n) &
        (valid_from != valid_to)
      end
    end
  end
  master.def_dataset_method :with_current_or_future_versions do
    eager_graph(:current_or_future_versions).where(
      Sequel.negate(current_or_future_versions__id: nil)
    )
  end
  version.many_to_one :master, class: master, key: :master_id
  version.class_eval do
    if Sequel::Plugins::Bitemporal.pg_jdbc?(master.db)
      plugin :pg_typecast_on_load, *columns
    elsif Sequel::Plugins::Bitemporal.jdbc?(master.db)
      plugin :typecast_on_load, *columns
    end

    def current?
      t = ::Sequel::Plugins::Bitemporal.point_in_time
      n = ::Sequel::Plugins::Bitemporal.now
      !new? &&
      created_at.to_datetime<=t &&
      (expired_at.nil? || expired_at.to_datetime>t) &&
      valid_from.to_datetime<=n &&
      valid_to.to_datetime>n
    end
    def destroy(opts={})
      expand_previous_version = opts.fetch(:expand_previous_version){
        valid_from.to_datetime>::Sequel::Plugins::Bitemporal.now
      }
      master.destroy_version self, expand_previous_version
    end
  end
  unless opts[:delegate]==false
    (version.columns-master.columns-master.excluded_columns).each do |column|
      master.class_eval <<-EOS
        def #{column}
          pending_or_current_version.#{column} if pending_or_current_version
        end
      EOS
    end
  end
end

.jdbc?(db) ⇒ Boolean

Returns:

  • (Boolean)


10
11
12
# File 'lib/sequel_bitemporal.rb', line 10

def self.jdbc?(db)
  db.adapter_scheme==:jdbc
end

.jruby?Boolean

Returns:

  • (Boolean)


6
7
8
# File 'lib/sequel_bitemporal.rb', line 6

def self.jruby?
  (defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby') || defined?(JRUBY_VERSION)
end

.nowObject



30
31
32
# File 'lib/sequel/plugins/bitemporal.rb', line 30

def self.now
  Thread.current[THREAD_NOW_KEY] || DateTime.now
end

.pg_jdbc?(db) ⇒ Boolean

Returns:

  • (Boolean)


14
15
16
# File 'lib/sequel_bitemporal.rb', line 14

def self.pg_jdbc?(db)
  db.database_type==:postgres && jdbc?(db)
end

.point_in_timeObject



16
17
18
# File 'lib/sequel/plugins/bitemporal.rb', line 16

def self.point_in_time
  Thread.current[THREAD_POINT_IN_TIME_KEY] || DateTime.now
end