Module: YummyGuide::Administrate::CollectionHelper

Defined in:
app/helpers/yummy_guide/administrate/collection_helper.rb

Defined Under Namespace

Classes: CollectionTableDefinition

Constant Summary collapse

COLLECTION_CELL_COPY_BLOCK_TAGS =
%w[
  address article aside blockquote div dl dt dd fieldset figcaption figure footer
  form h1 h2 h3 h4 h5 h6 header hr li main nav ol p pre section table tr ul
].freeze
DEFAULT_FIXED_COLUMN_WIDTHS =
{
  id: "4rem",
  month: "6rem",
  assign_group_id: "6rem",
  reservation_type: "7rem",
  short_access_id: "8rem",
  customer: "12rem"
}.freeze
DEFAULT_FIXED_COLUMN_WIDTH =
"8rem"
CONTENT_WIDTH_VALUE =
"max-content"
COPY_CELL_ACTION_WIDTH_OFFSET =
"var(--admin-copy-cell-width-offset, 1.85rem)"
MAX_MOBILE_FIXED_COLUMNS_COUNT =
1

Instance Method Summary collapse

Instance Method Details

#yummy_guide_administrate_build_collection_cell(content:, present_path: nil, target: nil, reference_link: false, text_link: false, leading_actions: nil, copy_text: nil, copy_text_transform: nil) ⇒ Object



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 253

def yummy_guide_administrate_build_collection_cell(content:, present_path: nil, target: nil, reference_link: false, text_link: false, leading_actions: nil, copy_text: nil, copy_text_transform: nil)
  normalized_content = yummy_guide_administrate_collection_cell_content(content)

  {
    content: yummy_guide_administrate_collection_cell_content_with_copy_frame(
      normalized_content,
      content_href: text_link ? present_path : nil,
      reference_href: reference_link ? present_path : nil,
      target: target,
      leading_actions: leading_actions,
      copy_text: copy_text,
      copy_text_transform: copy_text_transform
    ),
    linkable: false
  }
end

#yummy_guide_administrate_collection_actions_column_id(collection_presenter) ⇒ Object



249
250
251
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 249

def yummy_guide_administrate_collection_actions_column_id(collection_presenter)
  yummy_guide_administrate_collection_column_id(collection_presenter, :actions)
end

#yummy_guide_administrate_collection_actions_partial(partial_name) ⇒ Object



306
307
308
309
310
311
312
313
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 306

def yummy_guide_administrate_collection_actions_partial(partial_name)
  if controller.respond_to?(:controller_path)
    controller_partial = "#{controller.controller_path}/#{partial_name}"
    return controller_partial if lookup_context.exists?(controller_partial, [], true)
  end

  "administrate/application/#{partial_name}"
end

#yummy_guide_administrate_collection_attribute_path(attribute:, resource:, namespace:) ⇒ Object



286
287
288
289
290
291
292
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 286

def yummy_guide_administrate_collection_attribute_path(attribute:, resource:, namespace:)
  if yummy_guide_administrate_collection_reference_link?(attribute)
    yummy_guide_administrate_collection_detail_path(attribute.data, namespace: namespace)
  elsif yummy_guide_administrate_collection_text_link?(attribute)
    yummy_guide_administrate_collection_detail_path(resource, namespace: namespace)
  end
end

#yummy_guide_administrate_collection_column_id(collection_presenter, column_name) ⇒ Object



242
243
244
245
246
247
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 242

def yummy_guide_administrate_collection_column_id(collection_presenter, column_name)
  [
    collection_presenter.resource_name,
    column_name
  ].map { |segment| segment.to_s.parameterize(separator: "_") }.join(".")
end

#yummy_guide_administrate_collection_detail_path(resource, namespace:) ⇒ Object



277
278
279
280
281
282
283
284
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 277

def yummy_guide_administrate_collection_detail_path(resource, namespace:)
  return if resource.blank?
  return if respond_to?(:accessible_action?) && !accessible_action?(resource, :show)

  polymorphic_path([namespace, resource])
rescue StandardError
  nil
end

#yummy_guide_administrate_collection_reference_link?(attribute) ⇒ Boolean

Returns:

  • (Boolean)


294
295
296
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 294

def yummy_guide_administrate_collection_reference_link?(attribute)
  attribute.is_a?(::Administrate::Field::BelongsTo) && attribute.data.present?
end

#yummy_guide_administrate_collection_sticky_columns(page:, collection_presenter:, column_names:, column_ids: nil, default_column_widths: {}, saved_column_widths: {}) ⇒ Object



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
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
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 143

def yummy_guide_administrate_collection_sticky_columns(page:, collection_presenter:, column_names:, column_ids: nil, default_column_widths: {}, saved_column_widths: {})
  names = column_names.map(&:to_sym)
  fixed_count = yummy_guide_administrate_collection_fixed_columns_count_for_names(
    page: page,
    column_names: names,
    method_name: :index_fixed_columns_count
  )
  mobile_fixed_count = yummy_guide_administrate_collection_table_mobile_fixed_columns_count_for_names(
    page: page,
    column_names: names
  )
  max_count = [fixed_count, mobile_fixed_count].max
  return {} if max_count.zero?

  base_widths = yummy_guide_administrate_collection_fixed_column_widths(page: page)
  column_ids ||= names.index_with do |name|
    if collection_presenter.respond_to?(:resource_name)
      yummy_guide_administrate_collection_column_id(collection_presenter, name)
    else
      name.to_s
    end
  end
  widths = yummy_guide_administrate_collection_effective_column_widths(
    column_names: names,
    column_ids: column_ids,
    base_widths: base_widths,
    default_column_widths: default_column_widths,
    saved_column_widths: saved_column_widths
  )
  desktop_lefts = yummy_guide_administrate_collection_sticky_lefts(names.first(fixed_count), widths)
  mobile_lefts = yummy_guide_administrate_collection_sticky_lefts(names.first(mobile_fixed_count), widths)

  names.first(max_count).each_with_index.each_with_object({}) do |(name, index), sticky_columns|
    classes = []
    styles = []
    width = widths.fetch(name, yummy_guide_administrate_collection_default_fixed_column_width)

    if index < fixed_count
      classes << "sticky-left"
      classes << "sticky-left--last" if index == fixed_count - 1
      styles << "--sticky-left: #{desktop_lefts.fetch(name)}"
      styles << "--sticky-width: #{width}"
    end

    if index < mobile_fixed_count
      classes << "sticky-left-mobile"
      classes << "sticky-left-mobile--last" if index == mobile_fixed_count - 1
      styles << "--sticky-mobile-left: #{mobile_lefts.fetch(name)}"
      styles << "--sticky-mobile-width: #{width}"
    end

    sticky_columns[name] = {
      class: classes.join(" "),
      style: styles.join("; ")
    }
  end
end

#yummy_guide_administrate_collection_sticky_table_style(page:, column_names:, column_ids: nil, default_column_widths: {}, saved_column_widths: {}) ⇒ Object



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 201

def yummy_guide_administrate_collection_sticky_table_style(page:, column_names:, column_ids: nil, default_column_widths: {}, saved_column_widths: {})
  names = column_names.map(&:to_sym)
  base_widths = yummy_guide_administrate_collection_fixed_column_widths(page: page)
  column_ids ||= names.index_with { |name| name.to_s }
  widths = yummy_guide_administrate_collection_effective_column_widths(
    column_names: names,
    column_ids: column_ids,
    base_widths: base_widths,
    default_column_widths: default_column_widths,
    saved_column_widths: saved_column_widths
  )

  names.first(6).each_with_index.flat_map do |name, index|
    width = widths.fetch(name, yummy_guide_administrate_collection_default_fixed_column_width)
    column_number = index + 1

    [
      "--admin-sticky-col-#{column_number}-width: #{width}",
      "--admin-sticky-mobile-col-#{column_number}-width: #{width}"
    ]
  end.join("; ")
end

#yummy_guide_administrate_collection_table_definition(page:, collection_presenter:, column_names: nil, column_width_storage_scope: nil) ⇒ Object



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 45

def yummy_guide_administrate_collection_table_definition(page:, collection_presenter:, column_names: nil, column_width_storage_scope: nil)
  names = (column_names || collection_presenter.attribute_types.keys).map(&:to_sym)
  widths = yummy_guide_administrate_collection_fixed_column_widths(page: page)
  column_ids = names.index_with do |name|
    yummy_guide_administrate_collection_column_id(collection_presenter, name)
  end
  resolved_column_width_storage_scope = yummy_guide_administrate_collection_column_width_storage_scope(column_width_storage_scope)
  saved_column_widths = yummy_guide_administrate_collection_saved_column_widths(resolved_column_width_storage_scope)
  default_column_widths = yummy_guide_administrate_collection_default_column_widths(page: page)

  CollectionTableDefinition.new(
    column_names: names,
    fixed_columns_count: yummy_guide_administrate_collection_table_fixed_columns_count_for_names(
      page: page,
      column_names: names
    ),
    mobile_fixed_columns_count: yummy_guide_administrate_collection_table_mobile_fixed_columns_count_for_names(
      page: page,
      column_names: names
    ),
    sticky_columns: yummy_guide_administrate_collection_sticky_columns(
      page: page,
      collection_presenter: collection_presenter,
      column_names: names,
      column_ids: column_ids,
      default_column_widths: default_column_widths,
      saved_column_widths: saved_column_widths
    ),
    table_style: yummy_guide_administrate_collection_table_style(
      page: page,
      column_names: names,
      column_ids: column_ids,
      default_column_widths: default_column_widths,
      saved_column_widths: saved_column_widths
    ),
    grid_template_columns: yummy_guide_administrate_collection_grid_template_columns(
      column_names: names,
      widths: widths
    ),
    column_ids: column_ids,
    actions_column_id: yummy_guide_administrate_collection_actions_column_id(collection_presenter),
    adjusted_column_indexes: yummy_guide_administrate_collection_adjusted_column_indexes(
      column_names: names,
      column_ids: column_ids,
      default_column_widths: default_column_widths,
      saved_column_widths: saved_column_widths
    ),
    colgroup_widths: yummy_guide_administrate_collection_colgroup_widths(
      column_names: names,
      column_ids: column_ids,
      default_column_widths: default_column_widths,
      saved_column_widths: saved_column_widths
    )
  )
end

#yummy_guide_administrate_collection_table_fixed_columns_count(page:, collection_presenter:) ⇒ Object



101
102
103
104
105
106
107
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 101

def yummy_guide_administrate_collection_table_fixed_columns_count(page:, collection_presenter:)
  yummy_guide_administrate_collection_fixed_columns_count_for(
    page: page,
    collection_presenter: collection_presenter,
    method_name: :index_fixed_columns_count
  )
end

#yummy_guide_administrate_collection_table_fixed_columns_count_for_names(page:, column_names:) ⇒ Object



122
123
124
125
126
127
128
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 122

def yummy_guide_administrate_collection_table_fixed_columns_count_for_names(page:, column_names:)
  yummy_guide_administrate_collection_fixed_columns_count_for_names(
    page: page,
    column_names: column_names.map(&:to_sym),
    method_name: :index_fixed_columns_count
  )
end

#yummy_guide_administrate_collection_table_mobile_fixed_columns_count(page:, collection_presenter:) ⇒ Object



109
110
111
112
113
114
115
116
117
118
119
120
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 109

def yummy_guide_administrate_collection_table_mobile_fixed_columns_count(page:, collection_presenter:)
  [
    yummy_guide_administrate_collection_fixed_columns_count_for(
      page: page,
      collection_presenter: collection_presenter,
      method_name: :index_mobile_fixed_columns_count
    ),
    MAX_MOBILE_FIXED_COLUMNS_COUNT
  ].min
rescue NoMethodError
  0
end

#yummy_guide_administrate_collection_table_mobile_fixed_columns_count_for_names(page:, column_names:) ⇒ Object



130
131
132
133
134
135
136
137
138
139
140
141
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 130

def yummy_guide_administrate_collection_table_mobile_fixed_columns_count_for_names(page:, column_names:)
  [
    yummy_guide_administrate_collection_fixed_columns_count_for_names(
      page: page,
      column_names: column_names.map(&:to_sym),
      method_name: :index_mobile_fixed_columns_count
    ),
    MAX_MOBILE_FIXED_COLUMNS_COUNT
  ].min
rescue NoMethodError
  0
end

#yummy_guide_administrate_collection_table_style(page:, column_names:, column_ids:, default_column_widths:, saved_column_widths:) ⇒ Object



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 224

def yummy_guide_administrate_collection_table_style(page:, column_names:, column_ids:, default_column_widths:, saved_column_widths:)
  [
    yummy_guide_administrate_collection_sticky_table_style(
      page: page,
      column_names: column_names,
      column_ids: column_ids,
      default_column_widths: default_column_widths,
      saved_column_widths: saved_column_widths
    ),
    yummy_guide_administrate_collection_resizable_table_style(
      column_names: column_names,
      column_ids: column_ids,
      default_column_widths: default_column_widths,
      saved_column_widths: saved_column_widths
    )
  ].reject(&:blank?).join("; ")
end

#yummy_guide_administrate_collection_text_link?(attribute) ⇒ Boolean

Returns:

  • (Boolean)


298
299
300
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 298

def yummy_guide_administrate_collection_text_link?(attribute)
  attribute.respond_to?(:name) && attribute.name.to_s == "id"
end

#yummy_guide_administrate_collection_wrap(content, href:) ⇒ Object



302
303
304
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 302

def yummy_guide_administrate_collection_wrap(content, href:)
  yummy_guide_administrate_collection_link(content, href: href)
end

#yummy_guide_administrate_safe_transliterate_copy_text(text) ⇒ Object



270
271
272
273
274
275
# File 'app/helpers/yummy_guide/administrate/collection_helper.rb', line 270

def yummy_guide_administrate_safe_transliterate_copy_text(text)
  transliterated = ActiveSupport::Inflector.transliterate(text)
  return text if transliterated.count("?") > text.count("?")

  transliterated
end