Module: Mosaico

Defined in:
lib/mosaico.rb,
lib/mosaico/engine.rb,
lib/mosaico/version.rb,
lib/mosaico/mce_skin.rb,
lib/mosaico/template.rb,
app/models/mosaico/image.rb,
lib/mosaico/local_backend.rb,
app/models/mosaico/project.rb,
lib/mosaico/versafix_template.rb,
lib/mosaico/local_image_backend.rb,
app/models/mosaico/uploaded_image.rb,
lib/mosaico/active_storage_backend.rb,
app/models/mosaico/placeholder_image.rb,
lib/mosaico/local_placeholder_backend.rb,
app/helpers/mosaico/application_helper.rb,
lib/mosaico/active_storage_image_backend.rb,
app/controllers/mosaico/images_controller.rb,
app/controllers/mosaico/projects_controller.rb,
app/controllers/mosaico/templates_controller.rb,
app/controllers/mosaico/application_controller.rb,
lib/mosaico/active_storage_placeholder_backend.rb

Defined Under Namespace

Modules: ApplicationHelper Classes: ActiveStorageBackend, ActiveStorageImageBackend, ActiveStoragePlaceholderBackend, ApplicationController, Engine, Image, ImagesController, LocalBackend, LocalImageBackend, LocalPlaceholderBackend, MceSkin, PlaceholderImage, Project, ProjectsController, Template, TemplatesController, UploadedImage, VersafixTemplate

Constant Summary collapse

DEFAULT_LOCALE =
:en
VERSION =
'2.0.0'
MOSAICO_VERSION =
'0.16.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.default_localeObject



169
170
171
# File 'lib/mosaico.rb', line 169

def default_locale
  @default_locale ||= DEFAULT_LOCALE
end

.sprockets_taskObject

Returns the value of attribute sprockets_task.



38
39
40
# File 'lib/mosaico.rb', line 38

def sprockets_task
  @sprockets_task
end

Class Method Details

.available_localesObject



147
148
149
150
151
152
153
154
155
# File 'lib/mosaico.rb', line 147

def available_locales
  @available_locales ||= begin
    Dir.chdir(vendor_lang_root) do
      Dir.glob('*.json').map do |file|
        file.chomp(File.extname(file)).sub('mosaico-', '').to_sym
      end
    end
  end
end

.find_template(name) ⇒ Object



44
45
46
# File 'lib/mosaico.rb', line 44

def find_template(name)
  templates[name]
end

.localeObject



157
158
159
# File 'lib/mosaico.rb', line 157

def locale
  @locale ||= default_locale
end

.locale=(new_locale) ⇒ Object



161
162
163
164
165
166
167
# File 'lib/mosaico.rb', line 161

def locale=(new_locale)
  @locale = if available_locales.include?(new_locale.to_sym)
    new_locale.to_sym
  else
    default_locale
  end
end

.mce_plugin_assetsObject



82
83
84
85
86
87
88
89
# File 'lib/mosaico.rb', line 82

def mce_plugin_assets
  @mce_plugin_assets ||= Dir.chdir(Mosaico.vendor_asset_root) do
    Dir.glob(File.join(*%w(mosaico dist vendor plugins * plugin.js))).each_with_object({}) do |asset_path, ret|
      name = File.dirname(asset_path).split(File::SEPARATOR).last
      ret[name] = resolve_asset(asset_path)
    end
  end
end

.mce_skin_assetsObject



100
101
102
103
104
# File 'lib/mosaico.rb', line 100

def mce_skin_assets
  @mce_skin_assets ||= mce_skins.each_with_object({}) do |(name, skin), ret|
    ret[name] = skin.asset_paths
  end
end

.mce_skinsObject



106
107
108
109
110
111
112
113
# File 'lib/mosaico.rb', line 106

def mce_skins
  @mce_skins ||= Dir.chdir(Mosaico.vendor_asset_root) do
    Dir.glob(File.join(*%w(mosaico dist vendor skins *))).each_with_object({}) do |skin_path, ret|
      name = File.basename(skin_path)
      ret[name] = Mosaico::MceSkin.new(name, skin_path)
    end
  end
end

.mce_theme_assetsObject



91
92
93
94
95
96
97
98
# File 'lib/mosaico.rb', line 91

def mce_theme_assets
  @mce_theme_assets ||= Dir.chdir(Mosaico.vendor_asset_root) do
    Dir.glob(File.join(*%w(mosaico dist vendor themes * theme.js))).each_with_object({}) do |asset_path, ret|
      name = File.dirname(asset_path).split(File::SEPARATOR).last
      ret[name] = resolve_asset(asset_path)
    end
  end
end

.register_template(name, dir, subdirs: ['edres', 'img'], template_class: Template) ⇒ Object



40
41
42
# File 'lib/mosaico.rb', line 40

def register_template(name, dir, subdirs: ['edres', 'img'], template_class: Template)
  templates[name] = template_class.new(name, dir, subdirs).tap(&:register!)
end

.resolve_asset(asset_path) ⇒ Object



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/mosaico.rb', line 115

def resolve_asset(asset_path)
  uri = URI.parse(asset_path.gsub(File::SEPARATOR, '/'))

  if Rails.application.config.assets.compile || Mosaico.sprockets_task
    env = Rails.application.assets || Mosaico.sprockets_task.environment
    asset = env.find_asset(uri.path)

    path = if Rails.application.config.assets.digest
      asset.try(&:digest_path)
    else
      asset.try(&:logical_path)
    end

    return nil unless path
    uri.path = path
    uri.to_s
  else
    parts = uri.path.split('/')

    0.upto(parts.size - 1) do |i|
      candidate = File.join(*parts[i..-1])

      if found = Rails.application.assets_manifest.assets[candidate]
        uri.path = found
        return uri.to_s
      end
    end

    nil
  end
end

.templatesObject



48
49
50
# File 'lib/mosaico.rb', line 48

def templates
  @templates ||= {}
end

.url_join(*segments) ⇒ Object



72
73
74
75
76
77
78
79
80
# File 'lib/mosaico.rb', line 72

def url_join(*segments)
  segments.compact!

  # this regex strips off leading and trailing forward slashes
  joined = segments.map { |p| p.sub(/\A\/?(.*?)\/?\z/, "\\1") }.join('/')

  # handle absolute URLs
  segments.first.start_with?('/') ? "/#{joined}" : joined
end

.vendor_asset_rootObject



52
53
54
55
56
# File 'lib/mosaico.rb', line 52

def vendor_asset_root
  @vendor_asset_root ||= Mosaico::Engine.root.join(
    'vendor', 'assets', "mosaico-#{Mosaico::MOSAICO_VERSION}"
  )
end

.vendor_font_rootObject



66
67
68
69
70
# File 'lib/mosaico.rb', line 66

def vendor_font_root
  @vendor_font_root ||= Mosaico::Engine.root.join(
    'vendor', 'assets', 'fonts'
  )
end

.vendor_lang_rootObject



62
63
64
# File 'lib/mosaico.rb', line 62

def vendor_lang_root
  @vendor_lang_root ||= vendor_asset_root.join('mosaico', 'dist', 'lang')
end

.vendor_template_rootObject



58
59
60
# File 'lib/mosaico.rb', line 58

def vendor_template_root
  @vendor_template_root ||= vendor_asset_root.join('mosaico', 'templates')
end