activemail 2.0.0 → 2.1.0

data/lib/activemail/quality/rule_exemptions.rb

@@ -0,0 +1,49 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+require_relative 'guard'
+
+module ActiveMail
+  module Quality
+    # Rules a preview is exempt from, keyed by preview name (every email of it) or by
+    # preview key ("preview_name#email"); values are rule names, built-in or custom.
+    module RuleExemptions
+      extend T::Sig
+
+      sig { returns(T::Hash[String, T::Array[Symbol]]) }
+      def rule_exemptions
+        exemptions.dup.freeze
+      end
+
+      sig { params(value: T.untyped).void }
+      def rule_exemptions=(value)
+        Kernel.raise TypeError, "rule_exemptions must be a Hash, got #{value.class}" unless value.is_a?(Hash)
+
+        exemptions = value.to_h { |key, rules| [key.to_s.freeze, Kernel.Array(rules).map(&:to_sym).freeze] }
+        @exemptions = T.let(exemptions, T.nilable(T::Hash[String, T::Array[Symbol]]))
+      end
+
+      sig { params(key: String).returns(T::Array[Symbol]) }
+      def exempt_rules_for(key)
+        by_key = exemptions.fetch(key, Guard::NO_SKIP)
+        by_name = exemptions.fetch(key.split('#', 2).first.to_s, Guard::NO_SKIP)
+        by_key.empty? ? by_name : by_key | by_name
+      end
+
+      # Called before any preview renders: a bad name would otherwise surface as a render failure, or a skip.
+      sig { params(guard: Guard).void }
+      def check_exemptions!(guard)
+        exemptions.each_value { |rules| guard.check_skippable!(rules) }
+      end
+
+      private
+
+      sig { returns(T::Hash[String, T::Array[Symbol]]) }
+      def exemptions
+        @exemptions ||= T.let({}, T.nilable(T::Hash[String, T::Array[Symbol]]))
+      end
+    end
+  end
+end

data/lib/activemail/tokens/defaults.rb

@@ -36,7 +36,8 @@ module ActiveMail
         sm: '8px',
         md: '16px',
         lg: '24px',
-        xl: '40px'
+        xl: '40px',
+        container_gutter: '16px'
       }.freeze,
       TokenMap
     )

data/lib/activemail/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module ActiveMail
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/lib/generators/activemail/templates/mailer_layout.html.inky-erb

@@ -1,27 +1,13 @@
 <!DOCTYPE html>
 <html lang="<%%= I18n.locale %>" xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
-  <head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <meta name="x-apple-disable-message-reformatting">
-    <meta name="color-scheme" content="light dark">
-    <meta name="supported-color-schemes" content="light dark">
-    <!--[if mso]>
-    <noscript>
-      <xml>
-        <o:OfficeDocumentSettings>
-          <o:PixelsPerInch>96</o:PixelsPerInch>
-        </o:OfficeDocumentSettings>
-      </xml>
-    </noscript>
-    <![endif]-->
-    <%%= activemail_inline_styles %>
-  </head>
+  <%%= render "layouts/activemail/document_head" %>
 
   <body style="margin:0;padding:0;word-spacing:normal;">
     <div role="article" aria-roledescription="email" lang="<%%= I18n.locale %>" style="width:100%;">
       <container>
+        <%%= render "layouts/activemail/head" %>
         <%%= yield %>
+        <%%= render "layouts/activemail/footer" %>
       </container>
     </div>
   </body>

data/lib/generators/activemail/templates/mailer_layout.html.inky-haml

@@ -1,15 +1,9 @@
 !!!
 %html{lang: I18n.locale, xmlns: "http://www.w3.org/1999/xhtml", "xmlns:v" => "urn:schemas-microsoft-com:vml", "xmlns:o" => "urn:schemas-microsoft-com:office:office"}
-  %head
-    %meta{charset: "utf-8"}
-    %meta{name: "viewport", content: "width=device-width, initial-scale=1"}
-    %meta{name: "x-apple-disable-message-reformatting"}
-    %meta{name: "color-scheme", content: "light dark"}
-    %meta{name: "supported-color-schemes", content: "light dark"}
-    :plain
-      <!--[if mso]><noscript><xml><o:OfficeDocumentSettings><o:PixelsPerInch>96</o:PixelsPerInch></o:OfficeDocumentSettings></xml></noscript><![endif]-->
-    = activemail_inline_styles
+  = render "layouts/activemail/document_head"
   %body{style: "margin:0;padding:0;word-spacing:normal;"}
     %div{role: "article", "aria-roledescription" => "email", lang: I18n.locale, style: "width:100%;"}
       %container
+        = render "layouts/activemail/head"
         = yield
+        = render "layouts/activemail/footer"

data/lib/generators/activemail/templates/mailer_layout.html.inky-slim

@@ -1,14 +1,9 @@
 doctype html
 html lang=I18n.locale xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office"
-  head
-    meta charset="utf-8"
-    meta name="viewport" content="width=device-width, initial-scale=1"
-    meta name="x-apple-disable-message-reformatting"
-    meta name="color-scheme" content="light dark"
-    meta name="supported-color-schemes" content="light dark"
-    | <!--[if mso]><noscript><xml><o:OfficeDocumentSettings><o:PixelsPerInch>96</o:PixelsPerInch></o:OfficeDocumentSettings></xml></noscript><![endif]-->
-    = activemail_inline_styles
+  = render "layouts/activemail/document_head"
   body style="margin:0;padding:0;word-spacing:normal;"
     div role="article" aria-roledescription="email" lang=I18n.locale style="width:100%;"
       container
+        = render "layouts/activemail/head"
         = yield
+        = render "layouts/activemail/footer"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activemail
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Advitam
@@ -90,6 +90,7 @@ files:
 - app/assets/stylesheets/activemail/_utilities.scss
 - app/assets/stylesheets/activemail/activemail.scss
 - app/helpers/active_mail/styles_helper.rb
+- app/views/layouts/activemail/_document_head.html.erb
 - app/views/layouts/activemail/_footer.html.inky-erb
 - app/views/layouts/activemail/_head.html.inky-erb
 - app/views/layouts/activemail/mailer.html.inky-erb
@@ -122,20 +123,24 @@ files:
 - lib/activemail/inliner/base.rb
 - lib/activemail/inliner/null.rb
 - lib/activemail/inliner/premailer.rb
+- lib/activemail/inliner/premailer/document.rb
 - lib/activemail/inliner/roadie.rb
 - lib/activemail/libxml.rb
 - lib/activemail/parse_error_reporter.rb
 - lib/activemail/pipeline.rb
 - lib/activemail/quality.rb
+- lib/activemail/quality/builtin_message_rules.rb
 - lib/activemail/quality/builtin_rules.rb
 - lib/activemail/quality/configuration.rb
 - lib/activemail/quality/guard.rb
 - lib/activemail/quality/minitest.rb
 - lib/activemail/quality/output_dir.rb
+- lib/activemail/quality/output_filter.rb
 - lib/activemail/quality/preview_renderer.rb
 - lib/activemail/quality/render_all.rb
 - lib/activemail/quality/rspec.rb
 - lib/activemail/quality/rule.rb
+- lib/activemail/quality/rule_exemptions.rb
 - lib/activemail/rails/engine.rb
 - lib/activemail/rails/rendering.rb
 - lib/activemail/rails/template_handler.rb