Class: Menilite::Model

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

Defined Under Namespace

Classes: ActionInfo, FieldInfo, PresenceValidator, 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}_id"] = fields[info.name] if fields.has_key?(info.name)
  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



298
299
300
301
# File 'lib/menilite/model.rb', line 298

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

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



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

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

      Browser::HTTP.post(action_url, post_data.to_json) do
        on :success do |res|
          callback.call(:success, res) if callback
        end

        on :failure do |res|
          if callback
            if res.json[:result] == 'validation_error'
              callback.call(:validation_error, Menilite::ValidationError.new(res.json[:messages]))
            else
              callback.call(:failure, res)
            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



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

def action_info
  @action_info ||= {}
end

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



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

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

.delete_allObject



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

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

.fetch(filter: {}, order: nil) ⇒ Object



133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/menilite/model.rb', line 133

def fetch(filter: {}, order: nil)
  self.init
  filter = filter.map{|k, v| type_convert(k.to_sym, v) }.to_h

  if_server do
    filter.merge!(privilege_filter)
  end

  store.fetch(self, filter: filter, order: order) do |list|
    yield list if block_given?
    list
  end
end

.field(name, type = :string, params = {}) ⇒ Object



173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
# File 'lib/menilite/model.rb', line 173

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

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

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

  self.instance_eval do
    if type == :reference
      field_name = "#{name}_id"

      define_method(name) do
        id = @fields[field_name.to_sym]
        next nil unless id
        model_class = Object.const_get(name.to_s.camel_case)
        model_class[id]
      end

      define_method(name.to_s + "=") do |value|
        @fields[field_name.to_sym] = value.id
      end
    else
      field_name = name.to_s
    end

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

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

.field_infoObject



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

def field_info
  @field_info ||= {}
end

.find(id) ⇒ Object



286
287
288
289
290
291
292
293
294
295
296
# File 'lib/menilite/model.rb', line 286

def find(id)
  self.init

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

end

.inherited(child) ⇒ Object



167
168
169
# File 'lib/menilite/model.rb', line 167

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

.initObject



98
99
100
101
102
103
# File 'lib/menilite/model.rb', line 98

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

.max(field_name) ⇒ Object



303
304
305
306
# File 'lib/menilite/model.rb', line 303

def max(field_name)
  self.init
  store.max(self, field_name)
end

.permit(privileges) ⇒ Object



308
309
310
311
312
313
314
315
316
317
# File 'lib/menilite/model.rb', line 308

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



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

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

.storeObject



159
160
161
# File 'lib/menilite/model.rb', line 159

def store
  Store.instance
end

.subclassesObject



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

def subclasses
  @subclasses ||= {}
end

.type_convert(key, value) ⇒ Object



147
148
149
150
151
152
153
154
155
156
157
# File 'lib/menilite/model.rb', line 147

def type_convert(key, value)
  field_info = self.field_info[key] || self.field_info[key.to_s.sub(/_id\z/,'').to_sym]
  raise "no such field #{key} in #{self}" unless field_info
  converted = case field_info.type
              when :boolean
                value.is_a?(String) ? (value == 'true' ? true : false) : value
              else
                value
              end
  [key, converted]
end

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



277
278
279
280
281
282
283
284
# File 'lib/menilite/model.rb', line 277

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

.validatorsObject



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

def validators
  @validators ||= {}
end

Instance Method Details

#handle_event(event, field_name, value) ⇒ Object



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

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



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

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



392
393
394
# File 'lib/menilite/model.rb', line 392

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

#to_json(arg) ⇒ Object



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

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

#type_validate(name, value) ⇒ Object



372
373
374
375
376
377
378
# File 'lib/menilite/model.rb', line 372

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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
# File 'lib/menilite/model.rb', line 340

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) }
    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) { value.nil? || validate_reference(value, name) }
    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



380
381
382
383
384
385
# File 'lib/menilite/model.rb', line 380

def validate(name, value)
  validators = self.class.validators[name]
  if validators
    messages = validators.select(&:enabled?).map {|validator| validator.validate(value) }.compact
  end
end

#validate_allObject



387
388
389
390
# File 'lib/menilite/model.rb', line 387

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

#validate_reference(value, name) ⇒ Object



365
366
367
368
369
370
# File 'lib/menilite/model.rb', line 365

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