Class: JunglePath::DBModel::Table

Inherits:
Object
  • Object
show all
Defined in:
lib/jungle_path/gen/api.rb,
lib/jungle_path/db_model/temp.rb,
lib/jungle_path/db_model/table.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hash = nil, mark_as_modified_if_changed = true, transform_params = false) ⇒ Table

Returns a new instance of Table.



343
344
345
346
347
348
349
350
 
# File 'lib/jungle_path/db_model/temp.rb', line 343

def initialize(hash=nil, mark_as_modified_if_changed=true, transform_params=false)
  @values = {}
  @secure = true
  _columns.keys.each do |key| @values[key] = nil end
  @modified = Set.new # holds hash keys of modified values.
  hash = DBModel::Params.transform(hash, _columns) if transform_params
  _consume_hash(hash, mark_as_modified_if_changed) if hash
end

Class Method Details

.alternate_key_columns ⇒ Object 



44
45
46
 
# File 'lib/jungle_path/db_model/temp.rb', line 44

def self.alternate_key_columns
  @alternate_key_columns
end

.columns ⇒ Object 



24
25
26
 
# File 'lib/jungle_path/db_model/temp.rb', line 24

def self.columns
  @columns
end

.columns_alphabetical_order ⇒ Object 



28
29
30
 
# File 'lib/jungle_path/db_model/temp.rb', line 28

def self.columns_alphabetical_order
  @columns.values.clone.sort { |a,b| a.name <=> b.name }
end

.columns_sequence_order ⇒ Object 



32
33
34
 
# File 'lib/jungle_path/db_model/temp.rb', line 32

def self.columns_sequence_order
  @columns.values.clone.sort { |a,b| a.sequence <=> b.sequence }
end

.define(*column_defs) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/jungle_path/db_model/temp.rb', line 187

def self.define(*column_defs)
  set_columns

  column_defs.each do |column_def|
    # one column_def may produce multiple actual columns:
    columns = Column.get_column_def_columns(column_def, @sequence)
    columns.each do |column|
      @sequence = column.sequence + 1
      self.columns[column.name] = column
      self.primary_key_columns[column.name] = column if column.primary_key?
      self.alternate_key_columns[column.name] = column if column.alternate_key?
      self.foreign_key_columns[column.name] = column if column.foreign_key?

      if column.foreign_key?
        hash = self.foreign_key_columns_by_table_name
        sub_hash = hash[column.foreign_key_table_name]
        sub_hash = {} unless sub_hash
        sub_hash[column.name] = column
        hash[column.foreign_key_table_name] = sub_hash
      end

      if column.tags
        column.tags.each do |tag|
          tagged_columns = @tagged_columns[tag] || Set.new
          tagged_columns.add(column)
          @tagged_columns[tag] = tagged_columns
        end
      end

      self.references << column.foreign_key_table_name if column.foreign_key? and column.foreign_key_table_name != self.table_name
      self.secure_columns[column.name] = column if column.secure?
      self.non_audit_columns[column.name] = column unless column.is_audit_column?
      #attr_accessor column.name
      define_method(column.name) do
        @values[column.name]
      end
      define_method("#{column.name}=") do |value|
        if value != @values[column.name]
          @values[column.name] = value
          @modified.add(column.name)
        end
      end
    end
    self.primary_key_columns.values[0].calculated = true if self.primary_key_columns.length == 1
  end

  define_method("_values") do
    @values
  end

  define_method("_modified") do
    @modified
  end

  define_method("_modified_hash") do
    hash = {}
    @modified.each do |key|
      hash[key] = @values[key]
    end
    hash
  end

  define_method("_has_value_hash") do
    hash = {}
    @values.each do |key, value|
      hash[key] = value unless value == nil
    end
    hash
  end

  define_method("_primary_key") do
    primary_key = {}
    _primary_key_columns.keys.each do |key|
      primary_key[key] = @values[key]
    end
    primary_key
  end

  define_method("_alternate_key") do
    alternate_key = {}
    _alternate_key_columns.keys.each do |key|
      alternate_key[key] = @values[key]
    end
    alternate_key
  end

  define_method("_consume_hash") do |hash, mark_as_modified_if_changed=true|
    @values.each do |key, value|
      if hash.has_key?(key) and @values[key] != hash[key]
        @values[key] = hash[key]
        @modified.add(key) if mark_as_modified_if_changed
      end
    end
  end

  define_method("_columns") do
    self.class.columns
  end

  define_method("_primary_key_columns") do
    self.class.primary_key_columns
  end

  define_method("_alternate_key_columns") do
    self.class.alternate_key_columns
  end

  define_method("_foreign_key_columns") do
    self.class.foreign_key_columns
  end

  define_method("_secure_columns") do
    self.class.secure_columns
  end

  define_method("_tagged_columns") do
    self.class.tagged_columns
  end

  define_method("_table_name") do
    self.class.table_name
  end

  define_method("_secure?") do
    @secure
  end

  define_method("_secure=") do |value|
    @secure = value
  end

  define_method("to_hash") do
    #puts "#{_table_name} to_hash."
    return @values.clone if _secure_columns.length == 0 or !_secure?
    hash = {}
    puts "stripping secure columns!"
    @values.each do |key, value|
      hash[key] = value unless _secure_columns.has_key?(key)
    end
    hash
  end

  define_method("to_h") do
    # ruby way :)
    to_hash
  end

  define_method("to_json") do |arg=nil|
    #puts "#{_table_name} to_json."
    #puts "to_json - arg: #{arg.class}" if arg
    json = JsonWrap.dump self
    #puts json
    json
  end
end

.description ⇒ Object 



89
90
91
 
# File 'lib/jungle_path/db_model/temp.rb', line 89

def self.description
  @description
end

.description=(value) ⇒ Object 



93
94
95
 
# File 'lib/jungle_path/db_model/temp.rb', line 93

def self.description=(value)
  @description = value
end

.foreign_key_columns ⇒ Object 



48
49
50
 
# File 'lib/jungle_path/db_model/temp.rb', line 48

def self.foreign_key_columns
  @foreign_key_columns
end

.foreign_key_columns_by_table_name ⇒ Object 



52
53
54
 
# File 'lib/jungle_path/db_model/temp.rb', line 52

def self.foreign_key_columns_by_table_name
  @foreign_key_columns_by_table_name
end

.has_no_references? ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/jungle_path/db_model/temp.rb', line 73

def self.has_no_references?
  !self.has_references?
end

.has_no_view_references? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/jungle_path/db_model/temp.rb', line 141

def self.has_no_view_references?
  !self.has_view_references?
end

.has_reference_to?(table) ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/jungle_path/db_model/temp.rb', line 65

def self.has_reference_to?(table)
  @references.member?(table.table_name)
end

.has_references? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/jungle_path/db_model/temp.rb', line 69

def self.has_references?
  !@references.empty?
end

.has_view_reference_to?(table) ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
128
129
130
131
 
# File 'lib/jungle_path/db_model/temp.rb', line 125

def self.has_view_reference_to?(table)
  if @view_references
    @view_references.member?(table.table_name)
  else
    has_reference_to?(table)
  end
end

.has_view_references? ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
136
137
138
139
 
# File 'lib/jungle_path/db_model/temp.rb', line 133

def self.has_view_references?
  if @view_references
    !@view_references.empty?
  else
    has_references?
  end
end

.inherited(sub_class) ⇒ Object 



145
146
147
148
 
# File 'lib/jungle_path/db_model/temp.rb', line 145

def self.inherited(sub_class)
  sub_class.set_columns #setup subclass with particular class instance vars.
  @models[sub_class.table_name] = sub_class #keep a list of all subclasses.
end

.is_view? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
100
101
102
103
 
# File 'lib/jungle_path/db_model/temp.rb', line 97

def self.is_view?
  if @view_sql
    true
  else
    false
  end
end

.model_sort(list, result = Set.new, level = 0) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/jungle_path/db_model/temp.rb', line 164

def self.model_sort(list, result=Set.new, level=0)
  # return array of table names sorted in dependency order (not alphabetical order).
  #puts "level: #{level}."
  remaining = []
  list.each do |value|
    #puts "\tvalue: #{value.table_name}. references: #{value.references.to_a}."
    if value.has_no_view_references?
      #puts "\tadding: #{value.table_name}."
      result << value.table_name
    elsif value.view_references.subset? result
      #puts "\tadding: #{value.table_name}."
      result << value.table_name
    else
      remaining << value
    end
  end
  #puts "\tresult: #{result.length}: #{result.to_a}."
  #puts "\tremaining: #{remaining.length}: #{remaining}."
  return [] if level > 10 #something is wrong!!!
  result = self.model_sort(remaining, result, level + 1) if remaining.length > 0
  result
end

.models ⇒ Object 



150
151
152
 
# File 'lib/jungle_path/db_model/temp.rb', line 150

def self.models
  @models
end

.models_alphabetical_order ⇒ Object 



154
155
156
 
# File 'lib/jungle_path/db_model/temp.rb', line 154

def self.models_alphabetical_order
  @models.values.clone.sort { |a,b| a.table_name <=> b.table_name }
end

.models_dependent_order ⇒ Object 



158
159
160
161
162
 
# File 'lib/jungle_path/db_model/temp.rb', line 158

def self.models_dependent_order
  result = self.model_sort(@models.values.clone)
  # map array of table names into an array of table (model) classes.
  result.map {|key| @models[key]}
end

.non_audit_columns ⇒ Object 



36
37
38
 
# File 'lib/jungle_path/db_model/temp.rb', line 36

def self.non_audit_columns
  @non_audit_columns
end

.original_table_name ⇒ Object 



87
88
89
 
# File 'lib/jungle_path/db_model/table.rb', line 87

def self.original_table_name
  @table_name
end

.override_table_name ⇒ Object 



91
92
93
 
# File 'lib/jungle_path/db_model/table.rb', line 91

def self.override_table_name
  @override_table_name
end

.override_table_name=(value) ⇒ Object 



95
96
97
98
99
 
# File 'lib/jungle_path/db_model/table.rb', line 95

def self.override_table_name=(value)
  tmp = nil
  tmp = value.to_sym if value
  @override_table_name = tmp
end

.plural_table_name ⇒ Object 



85
86
87
 
# File 'lib/jungle_path/db_model/temp.rb', line 85

def self.plural_table_name
  "#{@table_name}s"
end

.primary_key_columns ⇒ Object 



40
41
42
 
# File 'lib/jungle_path/db_model/temp.rb', line 40

def self.primary_key_columns
  @primary_key_columns
end

.references ⇒ Object 



61
62
63
 
# File 'lib/jungle_path/db_model/temp.rb', line 61

def self.references
  @references
end

.secure_columns ⇒ Object 



77
78
79
 
# File 'lib/jungle_path/db_model/temp.rb', line 77

def self.secure_columns
  @secure_columns
end

.set_columns ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/jungle_path/db_model/temp.rb', line 8

def self.set_columns
  @columns = {}
  @non_audit_columns = {}
  @primary_key_columns = {}
  @alternate_key_columns = {}
  @foreign_key_columns = {}
  @foreign_key_columns_by_table_name = {}
  @references = Set.new
  @secure_columns = {}
  @unique_indexes = []
  @indexes = []
  @table_name = self.name.split('::').last.underscore.to_sym
  @tagged_columns = {}
  @sequence = 0
end

.table_name ⇒ Object 



81
82
83
 
# File 'lib/jungle_path/db_model/temp.rb', line 81

def self.table_name
  @table_name
end

.tagged_columns ⇒ Object 



56
57
58
59
 
# File 'lib/jungle_path/db_model/temp.rb', line 56

def self.tagged_columns
  #call like: TableClass.tagged_columns[:my_tag] to return set of columns having given tag.
  @tagged_columns
end

.template_model_name ⇒ Object 



18
19
20
 
# File 'lib/jungle_path/gen/api.rb', line 18

def self.template_model_name
  "Model::#{self.name.split('::').last}"
end

.template_new ⇒ Object

Adds useful methods to Table class for use when generating API and Model code:



9
10
11
 
# File 'lib/jungle_path/gen/api.rb', line 9

def self.template_new
  "#{self.name}.new"
end

.template_params_pk_hash ⇒ Object 



22
23
24
25
26
27
28
29
 
# File 'lib/jungle_path/gen/api.rb', line 22

def self.template_params_pk_hash
  #{id: p[:id]}
  array = []
  self.primary_key_columns.keys.each do |key|
    array << "#{key}: p[:#{key}]"
  end
  "{#{array.join(',')}}"
end

.template_pk_url ⇒ Object 



13
14
15
16
 
# File 'lib/jungle_path/gen/api.rb', line 13

def self.template_pk_url
  pk = self.primary_key_columns.keys.map {|key| "/:#{key}"}
  pk.join
end

.view ⇒ Object 



121
122
123
 
# File 'lib/jungle_path/db_model/table.rb', line 121

def self.view
  @view
end

.view=(value) ⇒ Object 



125
126
127
 
# File 'lib/jungle_path/db_model/table.rb', line 125

def self.view=(value)
  @view = value
end

.view_references ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/jungle_path/db_model/temp.rb', line 113

def self.view_references
  if @view_references
    @view_references
  else
    references
  end
end

.view_references=(array_of_table_names) ⇒ Object 



121
122
123
 
# File 'lib/jungle_path/db_model/temp.rb', line 121

def self.view_references=(array_of_table_names)
  @view_references = Set.new(array_of_table_names)
end

.view_sql ⇒ Object 



105
106
107
 
# File 'lib/jungle_path/db_model/temp.rb', line 105

def self.view_sql
  @view_sql
end

.view_sql=(value) ⇒ Object 



109
110
111
 
# File 'lib/jungle_path/db_model/temp.rb', line 109

def self.view_sql=(value)
  @view_sql = value
end