Class: Miasma::Types::Model

Inherits:

Data

• Object
• Data
• Miasma::Types::Model

show all

Includes:

Utils::Memoization

Defined in:

lib/miasma/types/model.rb

Overview

Instance Attribute Summary (collapse)

• - (Miasma::Types::Api) api readonly

  Underlying service API.

Class Method Summary (collapse)

• + (Model) from_json(api, json)

  Build new model from JSON.

Instance Method Summary (collapse)

• - (Object) _memo included from Utils::Memoization
• - (TrueClass) clear_memoizations! included from Utils::Memoization

  Remove all memoized values.

• - (TrueClass, FalseClass) destroy

  Destroy the model.

• - (String, Integer) id?
• - (self) initialize(api, model_data = nil) constructor

  Build new model.

• - (Object) memoize(key, direct = false) { ... } included from Utils::Memoization

  Memoize data.

• - (TrueClass, FalseClass) persisted?

  Model is persisted.

• - (self) reload

  Reload the underlying data for model.

• - (TrueClass, FalseClass) save

  Save changes to the model.

• - (NilClass) unmemoize(key, direct = false) included from Utils::Memoization

  Remove memoized value.

34
35
36
37
38
39
40
41
42
43
44
45

# File 'lib/miasma/types/model.rb', line 34

def initialize(api, model_data=nil)
  @api = api
  @data = Smash.new
  @dirty = Smash.new
  if(model_data)
    if(model_data.is_a?(Hash))
      load_data(model_data) unless model_data.empty?
    else
      raise TypeError.new "Expecting `model_data` to be of type `Hash`. Received: `#{model_data.class}`"
    end
  end
end

12
13
14

# File 'lib/miasma/types/model.rb', line 12

def api
  @api
end

21
22
23
24
25

# File 'lib/miasma/types/model.rb', line 21

def from_json(api, json)
  instance = self.new(api)
  instance.from_json(json)
  instance
end

64
65
66
67
68
69
70
71
72

# File 'lib/miasma/types/model.rb', line 64

def destroy
  if(persisted?)
    perform_destroy
    reload
    true
  else
    false
  end
end

89
90
91

# File 'lib/miasma/types/model.rb', line 89

def id?
  data[:id] || dirty[:id]
end

84
85
86

# File 'lib/miasma/types/model.rb', line 84

def persisted?
  id?
end

77
78
79
80
81

# File 'lib/miasma/types/model.rb', line 77

def reload
  clear_memoizations!
  perform_reload
  self
end

51
52
53
54
55
56
57
58

# File 'lib/miasma/types/model.rb', line 51

def save
  if(dirty?)
    perform_save
    reload
  else
    false
  end
end