Class: Kennel::Models::Base

Inherits:
Object
  • Object
show all
Extended by:
SubclassTracking
Defined in:
lib/kennel/models/base.rb

Direct Known Subclasses

Dash, Monitor, Project, Screen, Team

Constant Summary collapse

LOCK = 
"\u{1F512}"
READONLY_ATTRIBUTES = 
[
  :deleted, :matching_downtimes, :id, :created, :created_at, :creator, :org_id, :modified,
  :overall_state_modified, :overall_state, :api_resource
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from SubclassTracking

recursive_subclasses, subclasses

Constructor Details

#initialize(options = {}) ⇒ Base

Returns a new instance of Base.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/kennel/models/base.rb', line 50

def initialize(options = {})
  validate_options(options)

  options.each do |name, block|
    self.class.validate_setting_exists name
    define_singleton_method name, &block
  end

  @invocation_location = caller.detect { |l| l.start_with?(Dir.pwd) }
end

Class Method Details

.defaults(options) ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/kennel/models/base.rb', line 31

def defaults(options)
  options.each do |name, block|
    validate_setting_exists name
    define_method name, &block
  end
end

.inherited(child) ⇒ Object 



38
39
40
41
 
# File 'lib/kennel/models/base.rb', line 38

def inherited(child)
  super
  child.instance_variable_set(:@set, (@set || []).dup)
end

.settings(*names) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/kennel/models/base.rb', line 16

def settings(*names)
  duplicates = (@set & names)
  if duplicates.any?
    raise ArgumentError, "Settings #{duplicates.map(&:inspect).join(", ")} are already defined"
  end

  @set.concat names
  names.each do |name|
    next if method_defined?(name)
    define_method name do
      raise ArgumentError, "Trying to call #{name} for #{self.class} but it was never set or passed as option"
    end
  end
end

.validate_setting_exists(name) ⇒ Object

Raises:

  • (ArgumentError) 


43
44
45
46
47
 
# File 'lib/kennel/models/base.rb', line 43

def validate_setting_exists(name)
  return if !@set || @set.include?(name)
  supported = @set.map(&:inspect)
  raise ArgumentError, "Unsupported setting #{name.inspect}, supported settings are #{supported.join(", ")}"
end

Instance Method Details

#diff(actual) ⇒ Object 



76
77
78
79
80
81
82
83
84
 
# File 'lib/kennel/models/base.rb', line 76

def diff(actual)
  expected = as_json
  expected.delete(:id)

  READONLY_ATTRIBUTES.each { |k| actual.delete k }

  diff = HashDiff.diff(actual, expected, use_lcs: false)
  diff if diff.any?
end

#kennel_id ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/kennel/models/base.rb', line 61

def kennel_id
  name = self.class.name
  if name.start_with?("Kennel::")
    message = +"Set :kennel_id"
    message << " for project #{project.kennel_id}" if defined?(project)
    message << " on #{@invocation_location}" if @invocation_location
    raise ArgumentError, message
  end
  @kennel_id ||= Utils.snake_case name
end

#name ⇒ Object 



72
73
74
 
# File 'lib/kennel/models/base.rb', line 72

def name
  self.class.name
end

#tracking_id ⇒ Object 



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

def tracking_id
  "#{project.kennel_id}:#{kennel_id}"
end