mosaico 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eb08eed391dc9fdea93dfd8112abada6639bc06a
-  data.tar.gz: c26b82633c819545823c7572b3005e54b7156af1
+SHA256:
+  metadata.gz: 9f24bd21927feca6f9b818cb92fb1824b4a51c346bb9d7b516e6abc366e981b6
+  data.tar.gz: e0b8659be267714ed2357fc522559ea0a303d90b4e2f35c91e6c80fa4aa54723
 SHA512:
-  metadata.gz: f5e720c0531c1e0a8274fe4ec630382994b76b08d769c17d4bbb5772e0ef7e4bfef9a57c29ef9123377fe13c60d56e6b63daedc93afd8e5a7e15d2b6547d7ba8
-  data.tar.gz: 6ba2611446a7b050de4f643b9e9cbcf8f78fd9adeb8fd199142f607e1fd592234628a513e21f00a83fc1842abc2b8e13802803fccea4df43c193e7c967bd73ae
+  metadata.gz: ea656ff0a7834a5c2e7a32bdf63747747a7f2a4fc9537b24e698394a02c082b955f2e32bd61e33ed21d6f032e31406a29c9ac5791a8b61f61651217206a64399
+  data.tar.gz: 1d8d99904cc9150c54e5a57268989d5f943214455870b79f09fdc8af1f4765aac9486003006a90df236a828071198bedf278f0e700e5ea259727e9aacf6ade30

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+2.0.0
+===
+* Switched to ActiveStorage as the default image backend. Accordingly, mosaico-rails now supports Rails >= 5.2.
+
 1.1.1
 ===
 * Fixed asset delivery for custom templates.

data/README.md

@@ -48,8 +48,17 @@ You should be able to drag blocks from the list on the left into the center comp
 
 Getting up and running is really only the first step. You'll probably want to configure Mosaico to actually send email in a production environment. See the remaining sections for guidance.
 
+### Upgrading from version 1 to version 2
+
+We've introduced a new default image backend since v2.0.0. If you are upgrading from v1, you will have to add the following code in order to keep your current image backend, i.e. to avoid broken images. Create an initializer in config/initializers/mosaico.rb and add these lines:
+
+```ruby
+Mosaico::Engine.config.placeholder_backend = Mosaico::LocalPlaceholderBackend.new
+Mosaico::Engine.config.image_backend = Mosaico::LocalImageBackend.new
+```
+
 ### Custom Image Backends
-Uploading images within a Mosaico template is easy - just drag and drop from your filesystem onto any image placeholder. Behind the scenes, Mosaico is resizing and storing the images in the configured storage backend. The default storage backend is just your local filesystem. Images are stored in public/mosaico/images. In a production environment, you'll probably want images to be uploaded to a third-party service like Amazon's S3 or Google Cloud Storage. Unfortunately backends for these services aren't included with Mosaico (I'd glady welcome a pull request). Creating a storage backend is easy though - you just have to implement several methods. For example, here's the skeleton for an S3 backend:
+Uploading images within a Mosaico template is easy - just drag and drop from your filesystem onto any image placeholder. Behind the scenes, Mosaico is resizing and storing the images in the configured storage backend. The default storage backend is just your application's ActiveStorage service. Images are stored with mosaico/images/ and mosaico/placeholders/ as path prefix or key prefix. ActiveStorage comes with support for local storage as well as thrid-party service like Amazon's S3 or Google Cloud Storage. You may want to customize how images are to be uploaded and stored. Creating a storage backend is easy though - you just have to implement several methods. For example, here's the skeleton for an custom S3 backend:
 
 ```ruby
 module Mosaico
@@ -178,4 +187,4 @@ Licensed under the GPLv3 license.
 ### Authors
 
 1.  This gem: Cameron Dutro [@camertron](http://twitter.com/camertron)
-2.  mosaico: Void Labs, it's [on github](https://github.com/voidlabs/mosaico)
+2.  mosaico: Void Labs, it's [on github](https://github.com/voidlabs/mosaico)

data/app/controllers/mosaico/images_controller.rb

@@ -2,6 +2,8 @@ require 'mini_magick'
 
 module Mosaico
   class ImagesController < ::Mosaico::ApplicationController
+    before_action :set_active_storage_host
+
     def create
       files = params[:files].map do |file|
         dest_file = File.basename(file.tempfile.path)
@@ -138,5 +140,9 @@ module Mosaico
     def placeholder_seed
       Mosaico::Engine.root.join('lib', 'mosaico', 'placeholder.png').to_s
     end
+
+    def set_active_storage_host
+      ActiveStorage::Current.host = request.base_url
+    end
   end
 end

data/lib/mosaico/active_storage_backend.rb

@@ -0,0 +1,31 @@
+module Mosaico
+  class ActiveStorageBackend
+    attr_reader :service, :path_prefix
+
+    def initialize(service, path_prefix)
+      @service = service
+      @path_prefix = path_prefix
+    end
+
+    def store(source, as:)
+      key = "#{path_prefix}/#{as}"
+      @service.upload(key, open(source))
+    end
+
+    def retrieve(file)
+      key = "#{path_prefix}/#{file}"
+      data = @service.download(key)
+
+      tmp_file = Tempfile.new(file, :encoding => 'ascii-8bit')
+      tmp_file.write(data)
+      tmp_file.close
+
+      tmp_file.path
+    end
+
+    def url_to(file)
+      key = "#{path_prefix}/#{file}"
+      @service.url(key, filename: ActiveStorage::Filename.new(file), expires_in: 1.week, disposition: :inline, content_type: nil)
+    end
+  end
+end

data/lib/mosaico/active_storage_image_backend.rb

@@ -0,0 +1,7 @@
+module Mosaico
+  class ActiveStorageImageBackend < ActiveStorageBackend
+    def initialize
+      super(ActiveStorage::Blob.service, '/mosaico/images')
+    end
+  end
+end

data/lib/mosaico/active_storage_placeholder_backend.rb

@@ -0,0 +1,7 @@
+module Mosaico
+  class ActiveStoragePlaceholderBackend < ActiveStorageBackend
+    def initialize
+      super(ActiveStorage::Blob.service, '/mosaico/placeholders')
+    end
+  end
+end

data/lib/mosaico/engine.rb

@@ -92,8 +92,13 @@ module Mosaico
         )
       end
 
-      Mosaico::Engine.config.placeholder_backend = Mosaico::LocalPlaceholderBackend.new
-      Mosaico::Engine.config.image_backend = Mosaico::LocalImageBackend.new
+      Mosaico::Engine.config.placeholder_backend = nil
+      Mosaico::Engine.config.image_backend = nil
+
+      config.after_initialize do
+        Mosaico::Engine.config.placeholder_backend ||= Mosaico::ActiveStoragePlaceholderBackend.new
+        Mosaico::Engine.config.image_backend ||= Mosaico::ActiveStorageImageBackend.new
+      end
     end
   end
 end

data/lib/mosaico/version.rb

@@ -1,4 +1,4 @@
 module Mosaico
-  VERSION = '1.1.1'
+  VERSION = '2.0.0'
   MOSAICO_VERSION = '0.16.0'
 end

data/lib/mosaico.rb

@@ -24,9 +24,12 @@ end
 module Mosaico
   DEFAULT_LOCALE = :en
 
-  autoload :LocalImageBackend,       'mosaico/local_image_backend'
-  autoload :LocalPlaceholderBackend, 'mosaico/local_placeholder_backend'
-  autoload :LocalBackend,            'mosaico/local_backend'
+  autoload :LocalImageBackend,               'mosaico/local_image_backend'
+  autoload :LocalPlaceholderBackend,         'mosaico/local_placeholder_backend'
+  autoload :LocalBackend,                    'mosaico/local_backend'
+  autoload :ActiveStorageImageBackend,       'mosaico/active_storage_image_backend'
+  autoload :ActiveStoragePlaceholderBackend, 'mosaico/active_storage_placeholder_backend'
+  autoload :ActiveStorageBackend,            'mosaico/active_storage_backend'
 
   class << self
     include Mosaico::Engine.routes.url_helpers

data/mosaico.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'generated-assets', '~> 2.0'
   s.add_dependency 'mini_magick'
   s.add_dependency 'mime-types'
-  s.add_dependency 'rails', '>= 4.0'
+  s.add_dependency 'rails', '>= 5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mosaico
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Cameron Dutro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2022-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: css-rewrite
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 description: The Mosaico email editor on Rails.
 email:
 - cameron@lumoslabs.com
@@ -120,6 +120,9 @@ files:
 - db/migrate/20170817202255_add_images.rb
 - db/migrate/20170824233755_add_projects.rb
 - lib/mosaico.rb
+- lib/mosaico/active_storage_backend.rb
+- lib/mosaico/active_storage_image_backend.rb
+- lib/mosaico/active_storage_placeholder_backend.rb
 - lib/mosaico/engine.rb
 - lib/mosaico/local_backend.rb
 - lib/mosaico/local_image_backend.rb
@@ -517,7 +520,7 @@ files:
 homepage: https://github.com/lumoslabs/mosaico-rails
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -532,9 +535,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.5
-signing_key: 
+rubygems_version: 3.3.19
+signing_key:
 specification_version: 4
 summary: The Mosaico email editor on Rails.
 test_files: []