Class: Menilite::Model

Inherits:
Object
  • Object
show all
Extended by:
Helper
Includes:
Helper
Defined in:
lib/menilite/model.rb,
lib/menilite/model/association.rb

Defined Under Namespace

Classes: ActionInfo, Association, FieldInfo, PresenceValidator, UnacquiredDataAccess, UniqueValidator, Validator, Validators

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helper

client?, if_client, if_server, server?

Constructor Details

#initialize(fields = {}) ⇒ Model

Returns a new instance of Model.



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
# File 'lib/menilite/model.rb', line 32

def initialize(fields = {})
  self.class.init

  if server?
    fields = fields.map{|k,v| [k.to_sym, v] }.to_h
  end

  @guid = fields.delete(:id) || SecureRandom.uuid

  self.class.field_info.select{|_, i| i.type == :reference}.each do |name, info|
    fields[name] = Association.new(info.params[:class])
    fields[name].load(fields["#{name}_id".to_sym]) if fields["#{name}_id".to_sym]
  end

  fields.each{|k, v| type_validate(k, v) }
  fields = fields.map{|k,v| [k, convert_value(self.class.field_info[k].type, v)] }.to_h
  if server?
    fields.merge!(self.class.privilege_fields)
  end

  defaults = self.class.field_info.map{|k, d| [d.name, d.params[:default]] if d.params.has_key?(:default) }.compact.to_h
  fields = defaults.merge(fields)
  @fields = defaults.merge(fields)
  @listeners = {}
end

Instance Attribute Details

#fieldsObject (readonly)

Returns the value of attribute fields.



30
31
32
# File 'lib/menilite/model.rb', line 30

def fields
  @fields
end

Class Method Details

.[](id) ⇒ Object



164
165
166
167
# File 'lib/menilite/model.rb', line 164

def [](id)
  self.init
  store.find(self, id)
end

.action(name, options = {}, &block) ⇒ Object



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
# File 'lib/menilite/model.rb', line 249

def action(name, options = {}, &block)
  action_info[name.to_s] = ActionInfo.new(name, block.parameters, options)
  if server?
    self.instance_eval do
      if options[:class]
        define_singleton_method(name, block)
      else
        define_method(name, block)
      end
    end
  else
    method = Proc.new do |model, *args, &callback| # todo: should adopt keyword parameters
      action_url = options[:save] || options[:class] ? "/api/#{self}/#{name}" : "/api/#{self}/#{model.id}/#{name}"
      post_data = { args: args }

      if options[:save]
        begin
          model.validate_all
        rescue => e
          callback.call(:validation_error, e) if callback
          return
        end
        post_data[:model] = model.to_h
      end

      Menilite::Http.post_json(action_url, post_data) do
        on :success do |res|
          callback.call(:success, res) if callback
        end

        on :failure do |res|
          if callback
            res.json.then do |json|
              json = JSON.from_object(json)
              if json[:result] == 'validation_error'
                callback.call(:validation_error, Menilite::ValidationError.new(json[:messages]))
              else
                callback.call(:failure, json)
              end
            end
          end
        end
      end
    end
    self.instance_eval do
      if options[:class]
        define_singleton_method(name) {|*args, &callback| method.call(self, *args, &callback) }
      else
        define_method(name) {|*args, &callback| method.call(self, *args, &callback) }
      end
    end
  end
end

.action_infoObject



113
114
115
# File 'lib/menilite/model.rb', line 113

def action_info
  @action_info ||= {}
end

.create(fields = {}, &block) ⇒ Object



127
128
129
130
# File 'lib/menilite/model.rb', line 127

def create(fields={}, &block)
  self.init
  self.new(fields).save(&block)
end

.delete(id, &block) ⇒ Object



132
133
134
135
# File 'lib/menilite/model.rb', line 132

def delete(id, &block)
  self.init
  store.delete(self, filter: {id: id}, &block)
end

.delete_allObject



137
138
139
140
# File 'lib/menilite/model.rb', line 137

def delete_all
  self.init
  store.delete_all(self)
end

.fetch!(filter: {}, order: nil, includes: nil, &block) ⇒ Object



169
170
171
172
173
174
175
176
177
# File 'lib/menilite/model.rb', line 169

def fetch!(filter: {}, order: nil, includes: nil, &block)
  raise 'method is block required' unless block_given?

  self.init

  store.fetch!(self, filter: convert_fileter(filter), order: order, includes: includes) do |list|
    yield list
  end
end

.field(name, type = :string, params = {}) ⇒ 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
# File 'lib/menilite/model.rb', line 200

def field(name, type = :string, params = {})
  params.merge!(client: true, server: true)

  if client?
    return unless params[:client]
  else
    return unless params[:server]
  end

  field_info[name] = FieldInfo.new(self, name, type, params)
  if type == :reference
    field_info["#{name}_id".to_sym] = FieldInfo.new(self, "#{name}_id", :id, {})
  end

  self.instance_eval do
    if type == :reference
      define_method("#{name}_id") do
        @fields[name.to_sym].id
      end

      define_method("#{name}_id=") do |value|
        @fields[name.to_sym].load(value)
      end
    end

    define_method(name) do
      value = @fields[name.to_sym]
      if type.is_a?(Hash) && type.keys.first == :enum
        value = type[:enum][value]
      end
      value
    end

    define_method("#{name}=") do |value|
      unless type_validator(type).call(value, name)
        raise TypeError.new("type error: field name: #{name}, value: #{value}")
      end
      if type == :reference
        @fields[name.to_sym].assign convert_value(type, value)
      else
        @fields[name.to_sym] = convert_value(type, value)
      end
      handle_event(:change, name.to_sym, value)
    end
  end
end

.field_infoObject



109
110
111
# File 'lib/menilite/model.rb', line 109

def field_info
  @field_info ||= {}
end

.find(id) ⇒ Object



155
156
157
158
159
160
161
162
# File 'lib/menilite/model.rb', line 155

def find(id)
  case id
  when String
    self[id]
  when Hash
    self.fetch(filter:id).first
  end
end

.inherited(child) ⇒ Object



196
197
198
# File 'lib/menilite/model.rb', line 196

def inherited(child)
  subclasses[child] = false
end

.initObject



102
103
104
105
106
107
# File 'lib/menilite/model.rb', line 102

def init
  if Model.subclasses.has_key?(self) && !Model.subclasses[self]
    store.register(self)
    Model.subclasses[self] = true
  end
end

.max!(field_name, &block) ⇒ Object



179
180
181
182
183
184
185
186
# File 'lib/menilite/model.rb', line 179

def max!(field_name, &block)
  raise 'method is block required' unless block_given?

  self.init
  store.max!(self, field_name) do |max|
    yield max
  end
end

.permit(privileges) ⇒ Object



312
313
314
315
316
317
318
319
320
321
# File 'lib/menilite/model.rb', line 312

def permit(privileges)
  Menilite.if_server do
    case privileges
    when Array
      self.privileges.push(*privileges)
    when Symbol, String
      self.privileges << privileges
    end
  end
end

.save(collection, &block) ⇒ Object



121
122
123
124
125
# File 'lib/menilite/model.rb', line 121

def save(collection, &block)
  self.init
  collection.each {|obj| obj.validate_all }
  self.store.save(collection, &block)
end

.storeObject



188
189
190
# File 'lib/menilite/model.rb', line 188

def store
  Store.instance
end

.subclassesObject



192
193
194
# File 'lib/menilite/model.rb', line 192

def subclasses
  @subclasses ||= {}
end

.validation(field_name, params = {}, &block) ⇒ Object



303
304
305
306
307
308
309
310
# File 'lib/menilite/model.rb', line 303

def validation(field_name, params = {}, &block)
  params.each do |k, v|
    if validator = Validators[k, v]
      self.field_info[field_name].validators << validator.new(self, field_name)
    end
  end
  self.field_info[field_name].validators << Validator.new(self, field_name, &block) if block
end

.validatorsObject



117
118
119
# File 'lib/menilite/model.rb', line 117

def validators
  @validators ||= {}
end

Instance Method Details

#[](key) ⇒ Object



420
421
422
423
424
425
426
# File 'lib/menilite/model.rb', line 420

def [](key)
  if self.class.field_info.has_key?(key.to_sym) || self.class.field_info.has_key?("#{key}_id".to_sym)
    self.send(key)
  else
    raise ArgumentError.new("field '#{name}' is not defind")
  end
end

#delete!(&block) ⇒ Object



84
85
86
# File 'lib/menilite/model.rb', line 84

def delete!(&block)
  self.class.delete(self.id, &block)
end

#handle_event(event, field_name, value) ⇒ Object



92
93
94
95
96
97
# File 'lib/menilite/model.rb', line 92

def handle_event(event, field_name, value)
  get_listeners(event, field_name).each do |listener|
    listener.call(value)
  end
  value
end

#idObject



58
59
60
# File 'lib/menilite/model.rb', line 58

def id
  @guid
end

#on(event, *field_names, &block) ⇒ Object



88
89
90
# File 'lib/menilite/model.rb', line 88

def on(event, *field_names, &block)
  field_names.each {|file_name| set_listener(event, file_name, &block) }
end

#save(&block) ⇒ Object



62
63
64
65
66
# File 'lib/menilite/model.rb', line 62

def save(&block)
  self.validate_all
  self.class.store.save(self, &block)
  self
end

#to_hObject



428
429
430
# File 'lib/menilite/model.rb', line 428

def to_h
  @fields.merge(id: @guid)
end

#to_json(arg) ⇒ Object



432
433
434
# File 'lib/menilite/model.rb', line 432

def to_json(arg)
  @fields.merge(id: @guid).to_json
end

#type_validate(name, value) ⇒ Object



403
404
405
406
407
408
409
# File 'lib/menilite/model.rb', line 403

def type_validate(name, value)
  field_info = self.class.field_info[name]
  field_info or raise ArgumentError.new("field '#{name}' is not defind")

  type_validator = type_validator(field_info.type)
  type_validator.call(value, field_info.name) or raise TypeError.new("type error: field_name: #{field_info.name}, value: #{value}")
end

#type_validator(type) ⇒ Object



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
# File 'lib/menilite/model.rb', line 369

def type_validator(type)
  case type
    when :string
      -> (value, name) { value.nil? || value.is_a?(String) }
    when :int
      -> (value, name) { value.nil? || value.is_a?(Integer) }
    when :boolean
      -> (value, name) { value.nil? || value == true || value == false }
    when :date
      -> (value, name) { value.nil? || value.is_a?(Date) || value.is_a?(String) }
    when :time
      -> (value, name) { value.nil? || value.is_a?(Time) || value.is_a?(String) }
    when Hash
      if type.keys.first == :enum
        -> (value, name) { value.nil? || value.is_a?(Integer) || type[:enum].include?(value) }
      else
        raise TypeError.new("type error")
      end
    when :reference
      -> (value, name) { client? || value.nil? || validate_reference(value, name) || value.is_a?(Association) }
    when :id
      -> (value, name) { value.nil? || value.is_a?(String) }
    else
      raise TypeError.new("type error. type: #{type.inspect}")
  end
end

#update(data) ⇒ Object



68
69
70
71
72
73
74
75
76
77
# File 'lib/menilite/model.rb', line 68

def update(data)
  case data
  when self.class
    @fields.merge!(data.fields)
  when Hash
    @fields.merge!(data.map{|k, v| resolve_references(k, v) }.to_h)
  when String
    @fields.merge!(JSON.parse(json))
  end
end

#update!(data, &block) ⇒ Object



79
80
81
82
# File 'lib/menilite/model.rb', line 79

def update!(data, &block)
  self.update(data)
  self.save(&block)
end

#validate(name, value) ⇒ Object



411
412
413
# File 'lib/menilite/model.rb', line 411

def validate(name, value)
  self.class.field_info[name].valudate(self, value)
end

#validate_allObject



415
416
417
418
# File 'lib/menilite/model.rb', line 415

def validate_all
  messages = self.class.field_info.flat_map {|k, info| info.validate(self, self.fields[k]) }.compact
  messages.empty? or raise ValidationError.new(messages)
end

#validate_reference(value, name) ⇒ Object



396
397
398
399
400
401
# File 'lib/menilite/model.rb', line 396

def validate_reference(value, name)
  return false unless value.is_a?(String) || value.is_a?(Menilite::Model)

  model_class = Object.const_get(name.to_s.camel_case)
  not model_class[value].nil?
end