Module: Jobshop::Helpers::Migration

Defined in:
lib/jobshop/helpers/migration.rb

Instance Method Summary collapse

Instance Method Details

#create_table_with_auditing(table_name, *args) ⇒ Object

rubocop: disable Metrics/MethodLength



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
 
# File 'lib/jobshop/helpers/migration.rb', line 58

def create_table_with_auditing(table_name, *args) # rubocop: disable Metrics/MethodLength
  options = args.extract_options!
  primary_key_columns = options.delete(:primary_key)

  if primary_key_columns.is_a?(Hash)
    primary_key = []
    types = []

    primary_key_columns.each do |name, type|
      primary_key.push(name)
      types.push(type)
    end
  else
    primary_key = Array(primary_key_columns)
    types = Array.new(primary_key.count, :uuid)
  end

  primary_key_hash = Hash[primary_key.zip(types)]
  auditing_table_name = table_name.to_s.singularize.concat("_auditing")
  args << options

  create_table(table_name, id: false) do |t|
    # Put version column first because it is an auditing column
    t.bigint :version

    primary_key_hash.each { |name, type| t.send(type, name, null: false) }
    t.index primary_key, unique: true, name: :"idx_#{table_name}_pkey"

    # Preserve column order from migration
    yield t
  end

  idx_table_name_pkey table_name

  create_table(auditing_table_name, id: false) do |t|
    # Put auditing columns first for the trigger to work properly
    # Do not set a default on the primary key because the trigger sets it
    # If the trigger fails to set the ID then this should probably blow up
    t.uuid :auditing_id, null: false
    t.index :auditing_id, unique: true,
      name: :"idx_#{auditing_table_name}_pkey"

    # Called audited_at so it does not conflict with created_at on the
    # model being audited
    t.datetime :audited_at, null: false

    # Version being audited
    t.bigint :version

    # Put primary keys after auditing columns
    primary_key_hash.each { |name, type| t.send(type, name, null: false) }

    # Preserve column order and put everything else last
    yield t
  end

  idx_table_name_pkey auditing_table_name
  foreign_key auditing_table_name, table_name, primary_key

  execute <<~SQL
    CREATE
      TRIGGER before_audit_#{table_name}
      BEFORE INSERT OR UPDATE
        ON #{table_name}
        FOR EACH ROW EXECUTE PROCEDURE
          prepare_auditable();

    CREATE
      TRIGGER #{table_name}_process_audit
      AFTER INSERT OR UPDATE
        ON #{table_name}
        FOR EACH ROW EXECUTE PROCEDURE
          process_auditable('#{auditing_table_name}');
  SQL
end

#fk_created_by(table_name) ⇒ Object 



17
18
19
20
21
22
 
# File 'lib/jobshop/helpers/migration.rb', line 17

def fk_created_by(table_name)
  foreign_key table_name, :jobshop_people, {
    organization_id: :organization_id,
    created_by_id: :person_id
  }
end

#fk_organization(table_name) ⇒ Object 



13
14
15
 
# File 'lib/jobshop/helpers/migration.rb', line 13

def fk_organization(table_name)
  foreign_key table_name, :jobshop_organizations, :organization_id
end

#foreign_key(table_name, reference_table, columns, options = "") ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/jobshop/helpers/migration.rb', line 34

def foreign_key(table_name, reference_table, columns, options = "")
  if columns.is_a?(Hash)
    keys = []
    references = []

    columns.each do |k, v|
      keys.push(k)
      references.push(v)
    end
  else
    keys = references = Array(columns)
  end

  constraint_name = "fk_#{table_name}_#{keys.join('_')}"

  execute <<~SQL
    ALTER TABLE #{table_name}
      ADD CONSTRAINT #{constraint_name}
        FOREIGN KEY (#{keys.join(", ")})
        REFERENCES #{reference_table} (#{references.join(", ")})
        #{options};
  SQL
end

#idx_table_name_pkey(table_name) ⇒ Object 



6
7
8
9
10
11
 
# File 'lib/jobshop/helpers/migration.rb', line 6

def idx_table_name_pkey(table_name)
  execute <<~SQL
    ALTER TABLE #{table_name}
      ADD PRIMARY KEY USING INDEX idx_#{table_name}_pkey;
  SQL
end

#nested_set_attrs(table_name) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/jobshop/helpers/migration.rb', line 24

def nested_set_attrs(table_name)
  reference_column = table_name.sub(/jobshop_/, "").singularize + "_id"
  add_column table_name, :parent_id, :uuid
  add_column table_name, :lft, :uuid
  add_column table_name, :rgt, :uuid

  foreign_key table_name, table_name, { organization_id: :organization_id,
                                        parent_id: reference_column }
end