Class: Fortnox::API::Model::Base

Inherits:
Types::Model show all
Defined in:
lib/fortnox/api/models/base.rb

Direct Known Subclasses

Article, Customer, Document, Label, Project, TermsOfPayment, Unit

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Types::Model

#initialize

Constructor Details

This class inherits a constructor from Fortnox::API::Types::Model

Instance Attribute Details

#parent ⇒ Object 



94
95
96
 
# File 'lib/fortnox/api/models/base.rb', line 94

def parent
  @parent || self.class.new(self.class::STUB.dup)
end

#unsaved ⇒ Object

TODO(jonas): Restructure this class a bit, it is not very readable.



13
14
15
 
# File 'lib/fortnox/api/models/base.rb', line 13

def unsaved
  @unsaved
end

Class Method Details

.attribute(name, *args) ⇒ Object 



16
17
18
19
20
21
22
 
# File 'lib/fortnox/api/models/base.rb', line 16

def self.attribute(name, *args)
  define_method("#{name}?") do
    !send(name).nil?
  end

  super
end

.new(hash = {}) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/fortnox/api/models/base.rb', line 24

def self.new(hash = {})
  begin
    obj = preserve_meta_properties(hash) do
      super(hash)
    end
  rescue Dry::Struct::Error => e
    raise Fortnox::API::AttributeError, e
  end

  IceNine.deep_freeze(obj)
end

.preserve_meta_properties(hash) ⇒ Object

dry-types filter anything that isn’t specified as an attribute on the class that is being instantiated. This wrapper preserves the meta properties we need to track object state during that initialisation and sets them on the object after dry-types is done with it.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/fortnox/api/models/base.rb', line 102

def self.preserve_meta_properties(hash)
  is_unsaved = hash.delete(:unsaved) { true }
  is_new = hash.delete(:new) { true }
  parent = hash.delete(:parent) { nil }

  obj = yield

  # TODO: remove new, unsaved, saved
  obj.instance_variable_set(:@unsaved, is_unsaved)
  obj.instance_variable_set(:@saved, !is_unsaved)
  obj.instance_variable_set(:@new, is_new)
  obj.instance_variable_set(:@parent, parent)

  obj
end

.stub ⇒ Object 



36
37
38
 
# File 'lib/fortnox/api/models/base.rb', line 36

def self.stub
  new(self::STUB.dup)
end

Instance Method Details

#==(other) ⇒ Object

Generic comparison, by value, use .eql? or .equal? for object identity.



77
78
79
80
 
# File 'lib/fortnox/api/models/base.rb', line 77

def ==(other)
  return false unless other.is_a? self.class
  to_hash == other.to_hash
end

#attributes(*options) ⇒ Object

This filtering logic could be improved since it is currently O(N*M).



45
46
47
48
49
50
51
52
53
 
# File 'lib/fortnox/api/models/base.rb', line 45

def attributes(*options)
  return self.class.schema if options.nil?

  options = Array(options)

  self.class.schema.find_all do |_name, attribute|
    options.all? { |option| attribute.is?(option) }
  end
end

#new? ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/fortnox/api/models/base.rb', line 82

def new?
  @new
end

#parent? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/fortnox/api/models/base.rb', line 90

def parent?
  !@parent.nil?
end

#saved? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/fortnox/api/models/base.rb', line 86

def saved?
  @saved
end

#to_hash(recursive = false) ⇒ Object 



55
56
57
58
59
60
61
62
 
# File 'lib/fortnox/api/models/base.rb', line 55

def to_hash(recursive = false)
  return super() if recursive

  self.class.schema.each_with_object({}) do |key, result|
      # Only output attributes that have a value set
      result[key.name] = self[key.name] if self.send("#{key.name}?")
  end
end

#unique_id ⇒ Object 



40
41
42
 
# File 'lib/fortnox/api/models/base.rb', line 40

def unique_id
  send(self.class::UNIQUE_ID)
end

#update(hash) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/fortnox/api/models/base.rb', line 64

def update(hash)
  old_attributes = to_hash
  new_attributes = old_attributes.merge(hash)

  return self if new_attributes == old_attributes

  new_hash = new_attributes.delete_if { |_, value| value.nil? }
  new_hash[:new] = @new
  new_hash[:parent] = self
  self.class.new(new_hash)
end