Class: Avo::BaseCard

Inherits:
Object
  • Object
show all
Includes:
Concerns::VisibleInDashboard
Defined in:
lib/avo/base_card.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Concerns::VisibleInDashboard

#is_hidden?, #is_visible?

Constructor Details

#initialize(dashboard:, options: {}, arguments: {}, index: 0, cols: nil, rows: nil, label: nil, description: nil, refresh_every: nil, visible: nil) ⇒ BaseCard

Returns a new instance of BaseCard.



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/avo/base_card.rb', line 36

def initialize(dashboard:, options: {}, arguments: {}, index: 0, cols: nil, rows: nil, label: nil, description: nil, refresh_every: nil, visible: nil)
  @dashboard = dashboard
  @options = options
  @arguments = arguments
  @index = index
  @cols = cols
  @rows = rows
  @label = label
  @refresh_every = refresh_every
  @description = description
  @visible = visible
end

Instance Attribute Details

#arguments ⇒ Object

Returns the value of attribute arguments.



20
21
22
 
# File 'lib/avo/base_card.rb', line 20

def arguments
  @arguments
end

#dashboard ⇒ Object

Returns the value of attribute dashboard.



18
19
20
 
# File 'lib/avo/base_card.rb', line 18

def dashboard
  @dashboard
end

#index ⇒ Object

Returns the value of attribute index.



21
22
23
 
# File 'lib/avo/base_card.rb', line 21

def index
  @index
end

#options ⇒ Object

Returns the value of attribute options.



19
20
21
 
# File 'lib/avo/base_card.rb', line 19

def options
  @options
end

#params ⇒ Object

Returns the value of attribute params.



22
23
24
 
# File 'lib/avo/base_card.rb', line 22

def params
  @params
end

Class Method Details

.query(&block) ⇒ Object 



31
32
33
 
# File 'lib/avo/base_card.rb', line 31

def query(&block)
  self.query_block = block
end

Instance Method Details

#call_block ⇒ Object 



147
148
149
 
# File 'lib/avo/base_card.rb', line 147

def call_block
  ::Avo::Hosts::CardVisibility.new(block: visible, card: self, parent: dashboard).handle
end

#card_classes ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/avo/base_card.rb', line 74

def card_classes
  result = ""

  # Writing down the classes so TailwindCSS knows not to purge them
  classes_for_cols = {
    1 => " sm:col-span-1",
    2 => " sm:col-span-2",
    3 => " sm:col-span-3",
    4 => " sm:col-span-4",
    5 => " sm:col-span-5",
    6 => " sm:col-span-6"
  }

  classes_for_rows = {
    1 => " h-36",
    2 => " h-72",
    3 => " h-[27rem]",
    4 => " h-[36rem]",
    5 => " h-[45rem]",
    6 => " h-[54rem]"
  }

  result += classes_for_cols[cols.to_i] if classes_for_cols[cols.to_i].present?
  result += classes_for_rows[rows.to_i] if classes_for_rows[rows.to_i].present?

  result
end

#compute_result ⇒ Object 



108
109
110
111
112
113
 
# File 'lib/avo/base_card.rb', line 108

def compute_result
  Avo::Hosts::DashboardCard.new(card: self, dashboard: dashboard, params: params, context: context, range: range, options: options)
    .compute_result

  self
end

#description ⇒ Object 



56
57
58
 
# File 'lib/avo/base_card.rb', line 56

def description
  @description || self.class.description
end

#frame_url(enforced_range: nil, params: {}) ⇒ Object 



68
69
70
71
72
 
# File 'lib/avo/base_card.rb', line 68

def frame_url(enforced_range: nil, params: {})
  enforced_range ||= initial_range || ranges.first

  Avo::App.view_context.avo.dashboard_card_path(dashboard.id, id, turbo_frame: turbo_frame, index: index, range: enforced_range, **params.permit!)
end

#hydrate(dashboard: nil) ⇒ Object 



115
116
117
118
119
 
# File 'lib/avo/base_card.rb', line 115

def hydrate(dashboard: nil)
  @dashboard = dashboard if dashboard.present?

  self
end

#is_card? ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/avo/base_card.rb', line 135

def is_card?
  true
end

#is_divider? ⇒ Boolean

Returns:

  • (Boolean) 


139
140
141
 
# File 'lib/avo/base_card.rb', line 139

def is_divider?
  false
end

#label ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/avo/base_card.rb', line 49

def label
  return @label.to_s if @label.present?
  return self.class.label.to_s if self.class.label.present?

  self.class.id.to_s.humanize
end

#range ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/avo/base_card.rb', line 121

def range
  return params[:range] if params.dig(:range).present?

  return initial_range if initial_range.present?

  ranges.first
end

#refresh_every ⇒ Object 



60
61
62
 
# File 'lib/avo/base_card.rb', line 60

def refresh_every
  @refresh_every || self.class.refresh_every
end

#result(data) ⇒ Object 



129
130
131
132
133
 
# File 'lib/avo/base_card.rb', line 129

def result(data)
  self.result_data = data

  self
end

#turbo_frame ⇒ Object 



64
65
66
 
# File 'lib/avo/base_card.rb', line 64

def turbo_frame
  "#{dashboard.id}_#{id}"
end

#type ⇒ Object 



102
103
104
105
106
 
# File 'lib/avo/base_card.rb', line 102

def type
  return :metric if is_a?(::Avo::Dashboards::MetricCard)
  return :chartkick if is_a?(::Avo::Dashboards::ChartkickCard)
  return :partial if is_a?(::Avo::Dashboards::PartialCard)
end

#visible ⇒ Object 



143
144
145
 
# File 'lib/avo/base_card.rb', line 143

def visible
  @visible || self.class.visible
end