mosaico 1.0.0

data/lib/mosaico/engine.rb

@@ -0,0 +1,72 @@
+require 'rails'
+require 'generated-assets'
+require 'css-rewrite'
+
+module Mosaico
+  class Engine < ::Rails::Engine
+    isolate_namespace Mosaico
+
+    initializer 'mosaico.assets' do |app|
+      app.config.assets.paths << Mosaico.vendor_asset_root.to_s
+
+      ['mosaico/dist/fa', 'mosaico/dist/img'].each do |asset_path|
+        config.assets.precompile += Dir.chdir(Mosaico.vendor_asset_root) do
+          Dir.glob("#{asset_path}/**/*.*")
+        end
+      end
+
+      config.assets.precompile << 'mosaico/logo_transparent.png'
+
+      CssRewrite.configure do |config|
+        config.rewrite(/\A#{Mosaico.vendor_asset_root.to_s}/) do |url|
+          next if url.start_with?('data:')
+          asset_path = Mosaico.url_join('mosaico/dist', URI.parse(url).path)
+
+          if resolved_url = Mosaico.resolve_asset(asset_path)
+            prefix = Rails.application.config.assets.prefix
+            Mosaico.url_join(prefix, resolved_url)
+          end
+        end
+      end
+
+      Mosaico.available_locales.each do |locale|
+        asset_path = "mosaico/translations-#{locale}.js"
+
+        app.config.assets.generated.add(asset_path, precompile: true) do
+          locale_path = Mosaico.vendor_lang_root.join("mosaico-#{locale}.json")
+
+          "window.mosaico = window.mosaico || {};\n" +
+            "window.mosaico.translations = #{File.read(locale_path)};"
+        end
+      end
+
+      Mosaico.locale = I18n.default_locale
+    end
+
+    # https://content.pivotal.io/blog/leave-your-migrations-in-your-rails-engines
+    initializer 'mosaico.append_migrations' do |app|
+      unless app.root.to_s.match(root.to_s)
+        config.paths['db/migrate'].expanded.each do |expanded_path|
+          app.config.paths['db/migrate'] << expanded_path
+        end
+      end
+    end
+
+    initializer 'mosaico.default_config' do |app|
+      TEMPLATE_CLASSES = {
+        'versafix-1' => Mosaico::VersafixTemplate
+      }
+
+      %w(tedc15 tutorial versafix-1).each do |template|
+        Mosaico.register_template(
+          template,
+          Mosaico.vendor_template_root.join(template).to_s,
+          template_class: TEMPLATE_CLASSES.fetch(template, Mosaico::Template)
+        )
+      end
+
+      Mosaico::Engine.config.placeholder_backend = Mosaico::LocalPlaceholderBackend.new
+      Mosaico::Engine.config.image_backend = Mosaico::LocalImageBackend.new
+    end
+  end
+end

data/lib/mosaico/local_backend.rb

@@ -0,0 +1,23 @@
+module Mosaico
+  class LocalBackend
+    attr_reader :base_path, :base_url
+
+    def initialize(base_path, base_url)
+      @base_path = base_path
+      @base_url = base_url
+    end
+
+    def store(source, as:)
+      FileUtils.mkdir_p(base_path)
+      FileUtils.cp(source, File.join(base_path, as))
+    end
+
+    def retrieve(filename)
+      File.join(base_path, filename)
+    end
+
+    def url_to(filename)
+      Mosaico.url_join(base_url, filename)
+    end
+  end
+end

data/lib/mosaico/local_image_backend.rb

@@ -0,0 +1,7 @@
+module Mosaico
+  class LocalImageBackend < LocalBackend
+    def initialize
+      super(Rails.root.join('public/mosaico/images').to_s, '/mosaico/images')
+    end
+  end
+end

data/lib/mosaico/local_placeholder_backend.rb

@@ -0,0 +1,7 @@
+module Mosaico
+  class LocalPlaceholderBackend < LocalBackend
+    def initialize
+      super(Rails.root.join('public/mosaico/placeholders').to_s, '/mosaico/placeholders')
+    end
+  end
+end

data/lib/mosaico/template.rb

@@ -0,0 +1,89 @@
+module Mosaico
+  class Template
+    SRC_REGEX = /src\s*=\s*(?:"([^"]*)"|'([^']*)')/.freeze
+
+    attr_reader :name, :dir, :subdirs, :registered
+
+    def initialize(name, dir, subdirs)
+      @name = name
+      @dir = dir
+      @subdirs = subdirs
+      @registered = false
+    end
+
+    def register!
+      return if registered?
+      before_register
+      @registered = true
+      after_register
+    end
+
+    alias_method :registered?, :registered
+
+    def template_path
+      @template_path ||= File.join(dir, "#{full_name}.html")
+    end
+
+    def template_url
+      Mosaico::Engine.routes.url_helpers.template_path(name)
+    end
+
+    # where the template's thumbnails are stored
+    def edres_path
+      File.join(dir, 'edres')
+    end
+
+    def template_content
+      @template_content ||= begin
+        File.read(template_path).gsub(SRC_REGEX) do
+          if subdirs.any? { |subdir| $1.start_with?("#{subdir}/") }
+            if replacement_url = replacement_asset_url(File.join(dir, $1))
+              next "src='#{replacement_url}'"
+            end
+          end
+
+          "src='#{$1}'"
+        end
+      end
+    end
+
+    def asset_paths
+      @asset_paths ||= list_precomp_assets.each_with_object({}) do |asset_path, ret|
+        short_path = asset_path[(dir.length + 1)..-1]
+        ret[short_path] = Mosaico.resolve_asset(asset_path)
+      end
+    end
+
+    def full_name
+      "template-#{name}"
+    end
+
+    def url
+      Mosaico::Engine.routes.url_helpers.template_path(name)
+    end
+
+    private
+
+    def replacement_asset_url(asset_path)
+      if resolved_asset = Mosaico.resolve_asset(asset_path)
+        prefix = Rails.application.config.assets.prefix
+        Mosaico.url_join(prefix, resolved_asset)
+      end
+    end
+
+    def before_register
+      Rails.application.config.assets.precompile += list_precomp_assets
+    end
+
+    def after_register
+    end
+
+    def list_precomp_assets
+      subdirs.flat_map do |subdir|
+        # only allow images through for now
+        # TODO: what other file types are we going to need?
+        Dir.glob(File.join(dir, subdir, '**/*.{jpg,gif,png}'))
+      end
+    end
+  end
+end

data/lib/mosaico/versafix_template.rb

@@ -0,0 +1,43 @@
+module Mosaico
+  # Unfortunately the versafix-1 template contains several image assets
+  # whose paths contain "google+", which sprockets appears not to like.
+  # Rails will refuse to serve these assets, resulting in errors and
+  # several broken images on the page. This class fixes the issues by
+  # replacing "google+" with "google_plus" and serving renamed assets
+  # on-the-fly. It's more complicated, yes, but means the original image
+  # and template files don't have to be modified.
+  class VersafixTemplate < Template
+    private
+
+    def before_register
+      google_plus_assets.each do |original_asset_path|
+        relative_original_asset_path = original_asset_path.sub(/\A#{Mosaico.vendor_asset_root}\//, '')
+        relative_new_asset_path = relative_original_asset_path.sub('google+', 'google_plus')
+
+        Rails.application.config.assets.generated.add(relative_new_asset_path, precompile: true) do
+          File.binread(original_asset_path)
+        end
+      end
+
+      Rails.application.config.assets.precompile += remaining_assets
+    end
+
+    # called by the superclass (i.e. Template) for each URL in the
+    # template's HTML code (CSS is handled by css-rewrite in engine.rb)
+    def replacement_asset_url(asset_path)
+      super.tap do |replacement_path|
+        if google_plus_assets.include?(asset_path)
+          replacement_path.sub!('google+', 'google_plus')
+        end
+      end
+    end
+
+    def google_plus_assets
+      @google_plus_assets ||= list_precomp_assets.grep(/google+/)
+    end
+
+    def remaining_assets
+      @remaining_assets ||= list_precomp_assets - google_plus_assets
+    end
+  end
+end

data/lib/mosaico/version.rb

@@ -0,0 +1,4 @@
+module Mosaico
+  VERSION = '1.0.0'
+  MOSAICO_VERSION = '0.16.0'
+end

data/lib/tasks/makeThumbs.js.erb

@@ -0,0 +1,57 @@
+"use strict";
+
+// adapted from mosaico's makeThumbs.js grunt task
+
+var grunt = require('grunt');
+var script = './tasks/lib/phantom-thumbnailer-editor.js';
+var phantombin = require('phantomjs-prebuilt').path;
+var outFolder = '<%= @template.edres_path %>';
+var templateFile = 'http://<%= Mosaico.url_join("#{@host}:#{@port}", @template.template_url) %>'
+var renderWidth = 680;
+var outputWidth = 340;
+
+var spawnParams = {
+  cmd: phantombin,
+  args: [
+    script,
+    renderWidth,
+    outputWidth,
+    templateFile,
+    outFolder
+  ]
+};
+
+console.log("Creating thumbnails for <%= @template.template_url %>");
+
+var phantomJSHandle = grunt.util.spawn(spawnParams, function(err, result, code) {
+  if (!err) {
+    return;
+  }
+
+  // Ignore intentional cleanup.
+  if (code === 15 /* SIGTERM */) {
+    return;
+  }
+
+  // If we're here, something went horribly wrong.
+  console.log('PhantomJS threw an error:');
+
+  // Print result to stderr because sometimes the 127 code means that a shared library is missing
+  String(result).split('\n').forEach(function(element) {
+    console.log(element)
+  });
+
+  if (code === 127) {
+    console.log(
+      'In order for this task to work properly, PhantomJS must be installed locally via NPM. ' +
+      'If you\'re seeing this message, generally that means the NPM install has failed. ' +
+      'Please submit an issue providing as much detail as possible at: ' +
+      'https://github.com/gruntjs/grunt-lib-phantomjs/issues'
+    );
+  } else {
+    console.log('PhantomJS exited unexpectedly with exit code ' + code + '.');
+  }
+});
+
+phantomJSHandle.stdout.pipe(process.stdout);
+phantomJSHandle.stderr.pipe(process.stderr);

data/lib/tasks/thumbs.rake

@@ -0,0 +1,35 @@
+require 'erb'
+require 'socket'
+
+namespace :mosaico do
+  task :make_thumbs, [:template_name] => :environment do |_, args|
+    @template = Mosaico.find_template(args.template_name)
+
+    unless @template
+      raise "Template #{args.template_name} has not been registered."
+    end
+
+    @host = ENV.fetch('APP_HOST', 'localhost')
+    @port = ENV.fetch('APP_PORT', 3000).to_i
+
+    begin
+      Socket.tcp(@host, @port, connect_timeout: 5) {}
+    rescue Errno::ECONNREFUSED
+      raise "Couldn't connect to app at #{@host}:#{@port}. Is it running?"
+    end
+
+    script_path = File.expand_path('../makeThumbs.js.erb', __FILE__)
+    script = ERB.new(File.read(script_path)).result(binding)
+
+    Dir.chdir(Mosaico.vendor_asset_root.join('mosaico')) do
+      `npm ls 2>&1`
+
+      if $?.exitstatus != 0
+        puts 'Javascript dependencies are not installed, running `npm install`'
+        system 'npm install'
+      end
+
+      exec("node -e #{Shellwords.escape(script)}")
+    end
+  end
+end

data/mosaico.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'mosaico/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'mosaico'
+  s.summary       = 'The Mosaico email editor on Rails.'
+  s.description   = s.summary
+  s.authors       = ['Cameron Dutro']
+  s.email         = ['cameron@lumoslabs.com']
+  s.homepage      = 'https://github.com/lumoslabs/mosaico-rails'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files ./spec`.split("\n")
+  s.require_paths = ['lib']
+  s.version       = Mosaico::VERSION
+
+  s.add_dependency 'css-rewrite', '~> 2.0'
+  s.add_dependency 'generated-assets', '~> 2.0'
+  s.add_dependency 'mini_magick'
+  s.add_dependency 'mime-types'
+  s.add_dependency 'rails', '>= 4.0'
+end

data/vendor/assets/mosaico-0.16.0/mosaico/.jsbeautifyrc

@@ -0,0 +1,6 @@
+{
+  "js": {
+    "indent_with_tabs": false,
+    "indent_size": 2,
+  }
+}

data/vendor/assets/mosaico-0.16.0/mosaico/.jshintrc

@@ -0,0 +1,8 @@
+{
+  "-W097": false,
+  "-W069": false,
+  "globals": {
+    "require": false,
+    "module": false
+  }
+}

data/vendor/assets/mosaico-0.16.0/mosaico/.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - "6"
+  - "5"
+before_install: npm install -g grunt-cli
+install: npm install

data/vendor/assets/mosaico-0.16.0/mosaico/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+### Are you having issues with Mosaico?
+
+Please make sure:
+- you understand you have to build it and to run a backend server (either the node.js version bundled with this project or the php backend referenced above or write your own)
+- you read this Readme *three* times and followed the instructions
+- you understand I'll close any GitHub issue with insufficient information: if you want help then you'll have to take your time to explain your issue.
+- you don't ask for a binary/executable to be used as a standalone desktop application
+- you understand you can't simply open index.html/editor.html and expect it to work if you don't build the library and don't run a backend server and access that files through the webserver.
+- you don't add off topic comments to an existing issue: if you want to add that you are having the same issue please make sure you are having the same issue described. If you are unsure, open a new issue following the rules (we prefer a duplicated issue than a chaotic issue mixing unrelated things).
+
+##### issues building:
+- take note of the full log of your npm install, and grunt commands output
+- open a GitHub issues saying that you read this doc
+- paste the output from npm install and grunt
+- write your full environment (your operative system name and version, your node version, your npm version)
+
+##### issues running/editing
+if your problem is not with the building then when you open a GitHub issue:
+- make sure you specify if you are using the bundled backend or php backend or any other kind of deployment
+- tell us the browser you are using (name and version) and test at least a *second* browser to tell us if this happen in both or only one (tell us the details about the second browser too).
+- test the same scenario on https://mosaico.io and tell us if you see the same issue
+- if you are having issues running with Apache then specify you installed the php backend from access interpreting and WHY you think you are having problem with mosaico.js and not with that specific backend (did you try with bundled node.js backend?)
+
+##### rendering issues with templates generated by Mosaico
+- open an issue only if you have a screenshot
+- when you open an issue please tell us what template you are using
+- tell which email client show the issue (version, name, operative system)
+- tell us which backend you are using (the bundled one ran with grunt, the php backend referenced above, or your custom backend).
+- if you are sending the email using a different way then most of the times the template gets broken by your way to send it: so try the same thing on mosaico.io and confirm you see the same rendering issues.
+
+### Want to contribute code?
+
+Open an Issue, first, and coordinate with us.
+
+### Contact Us
+
+Please contact us if you have ideas, suggestions or, even better, you want to collaborate on this project or you need COMMERCIAL support: info@mosaico.io . Please DON'T write to this email to get free support: use Git issues for that.

data/vendor/assets/mosaico-0.16.0/mosaico/Dockerfile

@@ -0,0 +1,21 @@
+FROM centos:centos7
+
+RUN yum clean all
+RUN yum -y install epel-release; yum clean all
+RUN yum -y install bzip2 tar git nodejs npm ImageMagick; yum clean all
+
+RUN npm install grunt-cli -g
+
+# only add package.json so npm install will only be needed if we change it.
+COPY package.json /tmp/package.json
+# also add bower because package.json post-install needs it.
+COPY bower.json /tmp/bower.json
+RUN cd /tmp && npm install --unsafe-perm
+RUN mkdir -p /opt/mosaico && cp -a /tmp/node_modules /tmp/bower_components /opt/mosaico/
+
+WORKDIR /opt/mosaico
+COPY . /opt/mosaico
+
+EXPOSE 9006
+
+CMD ["grunt", "default"]