Class: ThemeSerializer

Inherits:
BasicThemeSerializer show all
Defined in:
app/serializers/theme_serializer.rb

Instance Method Summary collapse

Methods inherited from BasicThemeSerializer

#default, #include_default?

Methods inherited from ApplicationSerializer

expire_cache_fragment!, fragment_cache

Methods inherited from ActiveModel::Serializer

#include!

Constructor Details

#initialize(theme, options = {}) ⇒ ThemeSerializer

Returns a new instance of ThemeSerializer.



28
29
30
31
32
33
34
# File 'app/serializers/theme_serializer.rb', line 28

def initialize(theme, options = {})
  super
  @include_theme_field_values = options[:include_theme_field_values] || false
  @errors = []

  object.theme_fields.each { |o| @errors << o.error if o.error }
end

Instance Method Details

#child_themesObject



58
59
60
# File 'app/serializers/theme_serializer.rb', line 58

def child_themes
  object.child_themes
end

#descriptionObject



87
88
89
# File 'app/serializers/theme_serializer.rb', line 87

def description
  object.internal_translations.find { |t| t.key == "theme_metadata.description" }&.value
end

#errorsObject



79
80
81
# File 'app/serializers/theme_serializer.rb', line 79

def errors
  @errors
end

#include_child_themes?Boolean

Returns:

  • (Boolean)


75
76
77
# File 'app/serializers/theme_serializer.rb', line 75

def include_child_themes?
  !object.component?
end

#include_disabled_at?Boolean

Returns:

  • (Boolean)


91
92
93
# File 'app/serializers/theme_serializer.rb', line 91

def include_disabled_at?
  object.component? && !object.enabled?
end

#include_disabled_by?Boolean

Returns:

  • (Boolean)


95
96
97
# File 'app/serializers/theme_serializer.rb', line 95

def include_disabled_by?
  include_disabled_at?
end

#include_errors?Boolean

Returns:

  • (Boolean)


83
84
85
# File 'app/serializers/theme_serializer.rb', line 83

def include_errors?
  @errors.present?
end

#include_theme_field_values?Boolean

Returns:

  • (Boolean)


44
45
46
47
48
49
# File 'app/serializers/theme_serializer.rb', line 44

def include_theme_field_values?
  # This is passed into each `ThemeFieldSerializer` to determine if `value` will be serialized.
  # We only want to serialize if we are viewing staff_action_logs (for diffing changes), or if
  # the theme is a local theme, so the saved values appear in the theme field editor.
  @include_theme_field_values || object.remote_theme_id.nil?
end

#parent_themesObject



62
63
64
# File 'app/serializers/theme_serializer.rb', line 62

def parent_themes
  object.parent_themes
end

#screenshot_urlObject



51
52
53
54
55
56
# File 'app/serializers/theme_serializer.rb', line 51

def screenshot_url
  object
    .theme_fields
    .find { |field| field.type_id == ThemeField.types[:theme_screenshot_upload_var] }
    &.upload_url
end

#settingsObject



66
67
68
69
70
71
72
73
# File 'app/serializers/theme_serializer.rb', line 66

def settings
  object.settings.map do |_name, setting|
    ThemeSettingsSerializer.new(setting, scope:, root: false)
  end
rescue ThemeSettingsParser::InvalidYaml => e
  @errors << e.message
  nil
end

#theme_fieldsObject



36
37
38
39
40
41
42
# File 'app/serializers/theme_serializer.rb', line 36

def theme_fields
  ActiveModel::ArraySerializer.new(
    object.theme_fields,
    each_serializer: ThemeFieldSerializer,
    include_value: include_theme_field_values?,
  ).as_json
end