Class: Knj::Datarow

Inherits:
Object show all
Defined in:
lib/knj/datarow.rb

Direct Known Subclasses

Translations::Translation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(d) ⇒ Datarow

Returns a new instance of Datarow.



457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/knj/datarow.rb', line 457

def initialize(d)
  @ob = d.ob
  @db = d.ob.db
  raise "No ob given." if !@ob
  
  if d.data.is_a?(Hash)
    @data = d.data
  elsif d.data
    @data = {:id => d.data}
    self.reload
  else
    raise Knj::Errors::InvalidData, "Could not figure out the data from '#{d.data.class.name}'."
  end
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



2
3
4
 
# File 'lib/knj/datarow.rb', line 2

def data
  @data
end

#db ⇒ Object (readonly)

Returns the value of attribute db.



2
3
4
 
# File 'lib/knj/datarow.rb', line 2

def db
  @db
end

#ob ⇒ Object (readonly)

Returns the value of attribute ob.



2
3
4
 
# File 'lib/knj/datarow.rb', line 2

def ob
  @ob
end

Class Method Details

.classname ⇒ Object 



443
444
445
 
# File 'lib/knj/datarow.rb', line 443

def self.classname
  return @classname
end

.classname=(newclassname) ⇒ Object 



447
448
449
 
# File 'lib/knj/datarow.rb', line 447

def self.classname=(newclassname)
  @classname = newclassname
end

.columns_sqlhelper_args ⇒ Object 



196
197
198
 
# File 'lib/knj/datarow.rb', line 196

def self.columns_sqlhelper_args
  return @columns_sqlhelper_args
end

.define_bool_methods(args) ⇒ Object 



303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/knj/datarow.rb', line 303

def self.define_bool_methods(args)
  #Spawns a method on the class which returns true if the data is 1.
  method_name = "#{args[:col_name]}?".to_sym
  
  if args[:inst_methods].index(method_name) == nil
    define_method(method_name) do
      return true if self[args[:col_name].to_sym].to_s == "1"
      return false
    end
  end
end

.define_date_methods(args) ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/knj/datarow.rb', line 315

def self.define_date_methods(args)
  method_name = "#{args[:col_name]}_str".to_sym
  if args[:inst_methods].index(method_name) == nil
    define_method(method_name) do |*method_args|
      if Knj::Datet.is_nullstamp?(self[args[:col_name].to_sym])
        return @ob.events.call(:no_date, self.class.name)
      end
      
      return Knj::Datet.in(self[args[:col_name].to_sym]).out(*method_args)
    end
  end
  
  method_name = "#{args[:col_name]}".to_sym
  if args[:inst_methods].index(method_name) == nil
    define_method(method_name) do |*method_args|
      return false if Knj::Datet.is_nullstamp?(self[args[:col_name].to_sym])
      return Knj::Datet.in(self[args[:col_name].to_sym])
    end
  end
end

.define_numeric_methods(args) ⇒ Object 



336
337
338
339
340
341
342
343
 
# File 'lib/knj/datarow.rb', line 336

def self.define_numeric_methods(args)
  method_name = "#{args[:col_name]}_format"
  if args[:inst_methods].index(method_name) == nil
    define_method(method_name) do |*method_args|
      return Knj::Locales.number_out(self[args[:col_name].to_sym], *method_args)
    end
  end
end

.define_text_methods(args) ⇒ Object 



345
346
347
348
349
350
351
352
 
# File 'lib/knj/datarow.rb', line 345

def self.define_text_methods(args)
  method_name = "by_#{args[:col_name]}".to_sym
  if args[:inst_methods].index(method_name) == nil and RUBY_VERSION.to_s.slice(0, 3) != "1.8"
    define_singleton_method(method_name) do |arg|
      return d.ob.get_by(self.table, {args[:col_name].to_s => arg})
    end
  end
end

.define_time_methods(args) ⇒ Object 



354
355
356
357
358
359
360
361
 
# File 'lib/knj/datarow.rb', line 354

def self.define_time_methods(args)
  method_name = "#{args[:col_name]}_dbt"
  if args[:inst_methods].index(method_name) == nil
    define_method(method_name) do
      return Knj::Db::Dbtime.new(self[args[:col_name].to_sym])
    end
  end
end

.define_translation_methods(args) ⇒ Object

Various methods to define methods based on the columns for the datarow.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/knj/datarow.rb', line 282

def self.define_translation_methods(args)
  define_method("#{args[:val_dc]}=") do |newtransval|
    _kas.trans_set(self, {
      args[:val] => newtransval
    })
  end
  
  define_method("#{args[:val_dc]}") do
    return _kas.trans(self, args[:val])
  end
  
  define_method("#{args[:val_dc]}_html") do
    str = _kas.trans(self, args[:val])
    if str.to_s.strip.length <= 0
      return "[no translation for #{args[:val]}]"
    end
    
    return str
  end
end

.depending_data ⇒ Object 



9
10
11
12
 
# File 'lib/knj/datarow.rb', line 9

def self.depending_data
  @depending_data = [] if !@depending_data
  return @depending_data
end

.has_many(arr) ⇒ Object

This is used to define datarows that this object can have a lot of.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
 
# File 'lib/knj/datarow.rb', line 26

def self.has_many(arr)
  arr.each do |val|
    if val.is_a?(Array)
      classname, colname, methodname = *val
    elsif val.is_a?(Hash)
      classname = val[:class]
      colname = val[:col]
      methodname = val[:method]
      
      if val[:depends]
        depending_data << {
          :colname => colname,
          :classname => classname
        }
      end
    else
      raise "Unknown argument: '#{val.class.name}'."
    end
    
    if val.is_a?(Hash) and val.key?(:where)
      where_args = val[:where]
    else
      where_args = nil
    end
    
    raise "No classname given." if !classname
    methodname = "#{classname.to_s.downcase}s".to_sym if !methodname
    
    define_method(methodname) do |*args, &block|
      if args and args[0]
        list_args = args[0] 
      else
        list_args = {}
      end
      
      list_args.merge!(where_args) if where_args
      list_args[colname.to_s] = self.id
      
      return @ob.list(classname, list_args, &block)
    end
    
    define_method("#{methodname}_count".to_sym) do |*args|
      list_args = args[0] if args and args[0]
      list_args = {} if !list_args
      list_args[colname.to_s] = self.id
      list_args["count"] = true
      
      return @ob.list(classname, list_args)
    end
    
    define_method("#{methodname}_last".to_sym) do |args|
      args = {} if !args
      return @ob.list(classname, {"orderby" => [["id", "desc"]], "limit" => 1}.merge(args))
    end
    
    self.joined_tables(
      classname => {
        :where => {
          colname.to_s => {:type => "col", :name => :id}
        }
      }
    )
  end
end

.has_one(arr) ⇒ Object

This define is this object has one element of another datarow-class. It define various methods and joins based on that.



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
 
# File 'lib/knj/datarow.rb', line 92

def self.has_one(arr)
  arr.each do |val|
    methodname = nil
    colname = nil
    classname = nil
    
    if val.is_a?(Symbol)
      classname = val
      methodname = val.to_s.downcase.to_sym
      colname = "#{val.to_s.downcase}_id".to_sym
    elsif val.is_a?(Array)
      classname, colname, methodname = *val
    elsif val.is_a?(Hash)
      classname, colname, methodname = val[:class], val[:col], val[:method]
      
      if val[:required]
        colname = "#{classname.to_s.downcase}_id".to_sym if !colname
        required_data << {
          :col => colname,
          :class => classname
        }
      end
    else
      raise "Unknown argument-type: '#{arr.class.name}'."
    end
    
    methodname = classname.to_s.downcase if !methodname
    colname = "#{classname.to_s.downcase}_id".to_sym if !colname
    
    define_method(methodname) do
      return @ob.get_try(self, colname, classname)
    end
    
    methodname_html = "#{methodname.to_s}_html".to_sym
    define_method(methodname_html) do |*args|
      obj = self.send(methodname)
      return @ob.events.call(:no_html, classname) if !obj
      
      raise "Class '#{classname}' does not have a 'html'-method." if !obj.respond_to?(:html)
      return obj.html(*args)
    end
    
    self.joined_tables(
      classname => {
        :where => {
          "id" => {:type => "col", :name => colname}
        }
      }
    )
  end
end

.has_translation(arr) ⇒ Object

This method initializes joins, sets methods to update translations and makes the translations automatically be deleted when the object is deleted.



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
 
# File 'lib/knj/datarow.rb', line 145

def self.has_translation(arr)
  @translations = [] if !@translations
  
  arr.each do |val|
    @translations << val
    
    val_dc = val.to_s.downcase
    table_name = "Translation_#{val_dc}".to_sym
    
    joined_tables(
      table_name => {
        :where => {
          "object_class" => self.name,
          "object_id" => {:type => "col", :name => "id"},
          "key" => val.to_s,
          "locale" => proc{|d| _session[:locale]}
        },
        :parent_table => :Translation,
        :datarow => Knj::Translations::Translation,
        :ob => @ob
      }
    )
    
    self.define_translation_methods(:val => val, :val_dc => val_dc)
  end
end

.is_nullstamp?(stamp) ⇒ Boolean

This tests if a certain string is a date-null-stamp.

Returns:

  • (Boolean) 


20
21
22
23
 
# File 'lib/knj/datarow.rb', line 20

def self.is_nullstamp?(stamp)
  return true if !stamp or stamp == "0000-00-00 00:00:00" or stamp == "0000-00-00"
  return false
end

.joined_tables(hash) ⇒ Object 



177
178
179
180
 
# File 'lib/knj/datarow.rb', line 177

def self.joined_tables(hash)
  @columns_joined_tables = {} if !@columns_joined_tables
  @columns_joined_tables.merge!(hash)
end

.list(d, &block) ⇒ Object 



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/knj/datarow.rb', line 363

def self.list(d, &block)
  ec_col = d.db.enc_col
  ec_table = d.db.enc_table
  
  table_str = "#{ec_table}#{d.db.esc_table(self.table)}#{ec_table}"
  
  if d.args["count"]
    count = true
    d.args.delete("count")
    sql = "SELECT COUNT(#{table_str}.#{ec_col}id#{ec_col}) AS count"
  elsif d.args["select_col_as_array"]
    select_col_as_array = true
    sql = "SELECT #{table_str}.#{ec_col}#{d.args["select_col_as_array"]}#{ec_col} AS id"
    d.args.delete("select_col_as_array")
  else
    sql = "SELECT #{table_str}.*"
  end
  
  ret = self.list_helper(d)
  
  sql << " FROM #{table_str}"
  sql << ret[:sql_joins]
  sql << " WHERE 1=1"
  sql << ret[:sql_where]
  
  d.args.each do |key, val|
    case key
      when "return_sql"
        #ignore
      else
        raise "Invalid key: '#{key}' for '#{self.name}'."
    end
  end
  
  #The count will bug if there is a group-by-statement.
  grp_shown = false
  if !count and !ret[:sql_groupby]
    sql << " GROUP BY #{table_str}.#{ec_col}id#{ec_col}"
    grp_shown = true
  end
  
  if ret[:sql_groupby]
    if !grp_shown
      sql << " GROUP BY"
    else
      sql << ", "
    end
    
    sql << ret[:sql_groupby]
  end
  
  sql << ret[:sql_order]
  sql << ret[:sql_limit]
  
  return sql.to_s if d.args["return_sql"]
  
  if select_col_as_array
    ids = [] if !block
    d.db.q(sql) do |data|
      if block
        block.call(data[:id])
      else
        ids << data[:id]
      end
    end
    
    if !block
      return ids
    else
      return nil
    end
  elsif count
    ret = d.db.query(sql).fetch
    return ret[:count].to_i if ret
    return 0
  end
  
  return d.ob.list_bysql(self.classname, sql, &block)
end

.list_helper(d) ⇒ Object 



451
452
453
454
455
 
# File 'lib/knj/datarow.rb', line 451

def self.list_helper(d)
  self.load_columns(d) if !@columns_sqlhelper_args
  @columns_sqlhelper_args[:table] = @table if @table
  return d.ob.sqlhelper(d.args, @columns_sqlhelper_args)
end

.load_columns(d) ⇒ Object 



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
 
# File 'lib/knj/datarow.rb', line 200

def self.load_columns(d)
  @ob = d.ob if !@ob
  
  if !@classname
    if match = self.name.match(/($|::)([A-z\d_]+?)$/)
      @classname = match[2].to_sym 
    else
      @classname = self.name.to_sym
    end
  end
  
  @mutex = Mutex.new if !@mutex
  
  @mutex.synchronize do
    inst_methods = self.instance_methods(false)
    
    sqlhelper_args = {
      :db => d.db,
      :table => table,
      :cols_bools => [],
      :cols_date => [],
      :cols_dbrows => [],
      :cols_num => [],
      :cols_str => [],
      :cols => {}
    }
    
    sqlhelper_args[:table] = @table if @table
    
    d.db.tables[table].columns do |col_obj|
      col_name = col_obj.name
      col_type = col_obj.type
      col_type = "int" if col_type == "bigint" or col_type == "tinyint" or col_type == "mediumint" or col_type == "smallint"
      sqlhelper_args[:cols][col_name] = true
      
      self.define_bool_methods(:inst_methods => inst_methods, :col_name => col_name)
      
      if col_type == "enum" and col_obj.maxlength == "'0','1'"
        sqlhelper_args[:cols_bools] << col_name
      elsif col_type == "int" and col_name.slice(-3, 3) == "_id"
        sqlhelper_args[:cols_dbrows] << col_name
      elsif col_type == "int" or col_type == "bigint" or col_type == "decimal"
        sqlhelper_args[:cols_num] << col_name
      elsif col_type == "varchar" or col_type == "text" or col_type == "enum"
        sqlhelper_args[:cols_str] << col_name
      elsif col_type == "date" or col_type == "datetime"
        sqlhelper_args[:cols_date] << col_name
        self.define_date_methods(:inst_methods => inst_methods, :col_name => col_name)
      end
      
      if col_type == "int" or col_type == "decimal"
        self.define_numeric_methods(:inst_methods => inst_methods, :col_name => col_name)
      end
      
      if col_type == "int" or col_type == "varchar"
        self.define_text_methods(:inst_methods => inst_methods, :col_name => col_name)
      end
      
      if col_type == "time"
        self.define_time_methods(:inst_methods => inst_methods, :col_name => col_name)
      end
    end
    
    if @columns_joined_tables
      @columns_joined_tables.each do |table_name, table_data|
        table_data[:where].each do |key, val|
          val[:table] = self.table.to_sym if val.is_a?(Hash) and !val.key?(:table) and val[:type] == "col"
        end
        
        table_data[:datarow] = @ob.args[:module].const_get(table_name.to_sym) if !table_data.key?(:datarow)
      end
      
      sqlhelper_args[:joined_tables] = @columns_joined_tables
    end
    
    @columns_sqlhelper_args = sqlhelper_args
  end
  
  self.init_class(d) if self.respond_to?(:init_class)
end

.required_data ⇒ Object 



4
5
6
7
 
# File 'lib/knj/datarow.rb', line 4

def self.required_data
  @required_data = [] if !@required_data
  return @required_data
end

.table ⇒ Object 



182
183
184
185
 
# File 'lib/knj/datarow.rb', line 182

def self.table
  return @table if @table
  return self.name.split("::").last
end

.table=(newtable) ⇒ Object 



187
188
189
190
 
# File 'lib/knj/datarow.rb', line 187

def self.table=(newtable)
  @table = newtable
  @columns_sqlhelper_args[:table] = @table if @columns_sqlhelper_args.is_a?(Hash)
end

.translations ⇒ Object

This returns all translations for this datarow-class.



173
174
175
 
# File 'lib/knj/datarow.rb', line 173

def self.translations
  return @translations
end

Instance Method Details

#[](key) ⇒ Object

Returns a specific data from the object by key.



516
517
518
519
520
521
 
# File 'lib/knj/datarow.rb', line 516

def [](key)
  raise "Key was not a symbol: '#{key.class.name}'." if !key.is_a?(Symbol)
  raise "No data was loaded on the object? Maybe you are trying to call a deleted object?" if !@data
  return @data[key] if @data.key?(key)
  raise "No such key: '#{key}'."
end

#[]=(key, value) ⇒ Object

Writes/updates a keys value on the object.



524
525
526
527
 
# File 'lib/knj/datarow.rb', line 524

def []=(key, value)
  self.update(key.to_sym => value)
  self.reload
end

#deleted? ⇒ Boolean

Returns true if the object has been deleted.

Returns:

  • (Boolean) 


510
511
512
513
 
# File 'lib/knj/datarow.rb', line 510

def deleted?
  return true if !@ob and !@data
  return false
end

#destroy ⇒ Object

Forcefully destroys the object. This is done after deleting it and should not be called manually.



493
494
495
496
497
 
# File 'lib/knj/datarow.rb', line 493

def destroy
  @ob = nil
  @db = nil
  @data = nil
end

#each(&args) ⇒ Object

Loops through the data on the object.



564
565
566
 
# File 'lib/knj/datarow.rb', line 564

def each(&args)
  return @data.each(&args)
end

#has_key?(key) ⇒ Boolean

Alias for key?

Returns:

  • (Boolean) 


500
501
502
 
# File 'lib/knj/datarow.rb', line 500

def has_key?(key)
  return @data.key?(key.to_sym)
end

#id ⇒ Object

Returns the objects ID.



530
531
532
533
 
# File 'lib/knj/datarow.rb', line 530

def id
  raise "No data on object." if !@data
  return @data[:id]
end

#is_knj? ⇒ Boolean

This helps various parts of the framework determine if this is a datarow class without requiring it.

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/knj/datarow.rb', line 15

def is_knj?
  return true
end

#key?(key) ⇒ Boolean

Returns true if that key exists on the object.

Returns:

  • (Boolean) 


505
506
507
 
# File 'lib/knj/datarow.rb', line 505

def key?(key)
  return @data.key?(key.to_sym)
end

#name ⇒ Object Also known as: title

Tries to figure out, and returns, the possible name or title for the object.



536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/knj/datarow.rb', line 536

def name
  if @data.key?(:title)
    return @data[:title]
  elsif @data.key?(:name)
    return @data[:name]
  end
  
  obj_methods = self.class.instance_methods(false)
  [:name, :title].each do |method_name|
    return self.method(method_name).call if obj_methods.index(method_name)
  end
  
  raise "Couldnt figure out the title/name of the object on class #{self.class.name}."
end

#name_html ⇒ Object

Calls the name-method and returns a HTML-escaped value. Also “[no name]” if the name is empty.



552
553
554
555
556
557
558
559
 
# File 'lib/knj/datarow.rb', line 552

def name_html
  name_str = self.name.to_s
  if name_str.length <= 0
    name_str = "[no name]"
  end
  
  return name_str
end

#reload ⇒ Object

Reloads the data from the database.



473
474
475
476
477
478
479
480
 
# File 'lib/knj/datarow.rb', line 473

def reload
  data = @db.single(self.table, {:id => @data[:id]})
  if !data
    raise Knj::Errors::NotFound, "Could not find any data for the object with ID: '#{@data[:id]}' in the table '#{self.table}'."
  end
  
  @data = data
end

#table ⇒ Object 



192
193
194
 
# File 'lib/knj/datarow.rb', line 192

def table
  return self.class.table
end

#update(newdata) ⇒ Object

Writes/updates new data for the object.



483
484
485
486
487
488
489
490
 
# File 'lib/knj/datarow.rb', line 483

def update(newdata)
  @db.update(self.table, newdata, {:id => @data[:id]})
  self.reload
  
  if @ob
    @ob.call("object" => self, "signal" => "update")
  end
end