activemail 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc582cd5c5cb4c6106a7621144e529eb4b52ba2e89abcea488698c7423f4bf5b
-  data.tar.gz: ab394297c1480f88fa5c265f7865fd4ea84118715871e06a2d5b0b9205e68dfe
+  metadata.gz: e81e755f1fae9c74a61005f5a87483c3a1cf561b79003081a134cb687f658004
+  data.tar.gz: 3f669eec79bd3b5df69c83fa3169fafcd7cabcaa014a43ce259399f43d435989
 SHA512:
-  metadata.gz: c0ff68ee11f5a0b880e5eaa5c9f07d41ae163a5863bd8d1fcd26be1a60ad79a438d7ddc0130122411426cb23083e3c46a07092eb94ef89798600b51046032209
-  data.tar.gz: a5f8948b1410fbee84666b37f7b3dfa4358cc72b4cab87404fba8a9638e56e3534bb0492c0103eadde4a4158f6009bc383aba5b620216329e6cc20870254ddc2
+  metadata.gz: c5c47394192f0c8ae3da2c6b1832aa3e5083257d782cbd0593b7c59550c2607298404bde407f418980ec1de9a402e9162a189dcf56cda77cfac90df1fa5a2188
+  data.tar.gz: 1330453b77892f54770c4ba29d2c3a1e05243a5885785d41b2929cbea1ab7bd10ef595c0a442dcdffb83fe394497f3d479f6e7e0d355efc11aa513a86fee243f

data/CHANGELOG.md

@@ -5,11 +5,19 @@ All notable changes to this project are documented here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2026-06-15
+
+### Changed
+
+- Simplified the gem description and README; removed legacy branding.
+- Unified the namespace to `ActiveMail` (gem name = require path = entry file =
+  namespace). Plain `require 'activemail'` now loads everything, so the
+  `require: 'active_mail'` workaround is no longer needed.
+
 ## [1.0.0] - 2026-06-13
 
 First release of **ActiveMail**, an opinionated, plug & play responsive email
-toolkit for Rails. The markup engine derives from `inky-rb` v2 (rebranded to the
-`ActiveMail` namespace); the batteries-included framework layer is new.
+toolkit for Rails.
 
 ### Added
 
@@ -57,4 +65,5 @@ toolkit for Rails. The markup engine derives from `inky-rb` v2 (rebranded to the
 - Rails `>= 7.1` (tested up to 8.1).
 - Nokogiri `>= 1.16`.
 
+[1.0.1]: https://github.com/AdVitam/activemail/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/AdVitam/activemail/releases/tag/v1.0.0

data/README.md

@@ -7,8 +7,7 @@ tokens, automatic CSS inlining, generators, and test-time quality guards — so
 responsive, accessible email renders **out of the box**, with every default
 overridable.
 
-> Not affiliated with Rails core. The name echoes the `Active*` family by
-> convention only.
+A fork and modernization of the now-unmaintained `inky-rb`. Not affiliated with Rails core.
 
 Write this:
 
@@ -43,12 +42,12 @@ renders consistently from Apple Mail to Outlook (Word engine) to Gmail mobile.
 
 ```ruby
 # Gemfile
-gem 'activemail'
+gem 'activemail', '~> 1.0'
 ```
 
 ```bash
 bundle install
-bin/rails g active_mail:install
+bin/rails g activemail:install
 ```
 
 The generator drops a commented initializer, a mailer layout, and wires the
@@ -61,7 +60,7 @@ render. CSS is inlined automatically before delivery.
 ## Configuration
 
 ```ruby
-# config/initializers/active_mail.rb
+# config/initializers/activemail.rb
 ActiveMail.configure do |config|
   config.template_engine  = :erb   # underlying engine for `.html.inky` (default :erb)
   config.column_count     = 12     # grid columns (default 12)
@@ -108,22 +107,22 @@ ActiveMail.tokens.color(:primary) # => "#2a9d8f"
 
 Defaults are neutral (a calm teal `primary`, near-black `text`, white
 `background`, …) and fully overridable. Under Sprockets the SCSS bridge is a
-preprocessed partial; under Propshaft run `rake active_mail:tokens:export` to
-materialize a static `_active_mail_tokens.scss`.
+preprocessed partial; under Propshaft run `rake activemail:tokens:export` to
+materialize a static `_activemail_tokens.scss`.
 
 ## Styling
 
-The framework stylesheet lives at `active_mail/active_mail` and is themed entirely
+The framework stylesheet lives at `activemail/activemail` and is themed entirely
 by tokens — no hard-coded brand colors. It includes a fluid-hybrid grid, component
 hooks (`.button`, `.cta`, `.callout`, `.spacer`, …), utilities, and dark mode.
 
 Override at three levels, cheapest first:
 
 1. **Tokens** (Ruby) — covers most theming.
-2. **`bin/rails g active_mail:styles`** — eject the SCSS partials into your app to
+2. **`bin/rails g activemail:styles`** — eject the SCSS partials into your app to
    edit them; your copies shadow the gem's.
-3. **`bin/rails g active_mail:views`** — eject the default layout + partials
-   (`app/views/layouts/active_mail/*`); a same-named file in your app wins by
+3. **`bin/rails g activemail:views`** — eject the default layout + partials
+   (`app/views/layouts/activemail/*`); a same-named file in your app wins by
    Rails path precedence. Put your logo/header/footer here — those are the app's
    identity, not the gem's.
 
@@ -265,7 +264,7 @@ the matched Nokogiri node (full DOM access) and the already-transformed inner
 HTML; return the replacement markup string. The generator scaffolds one:
 
 ```bash
-bin/rails g active_mail:component Divider
+bin/rails g activemail:component Divider
 ```
 
 The generator namespaces the class as `Components::Divider` (under
@@ -297,19 +296,19 @@ ActiveMail::Core.new(components: { 'button' => MyButton }).release_the_kraken(so
 
 | Generator | Purpose |
 |---|---|
-| `active_mail:install` | Initializer + mailer layout + stylesheet wiring (works zero-config). `--haml` / `--slim` supported. |
-| `active_mail:views` | Eject the default layout + partials for customization. |
-| `active_mail:styles` | Eject the SCSS framework partials for customization. |
-| `active_mail:component NAME` | Scaffold a component class + print its register snippet. |
+| `activemail:install` | Initializer + mailer layout + stylesheet wiring (works zero-config). `--haml` / `--slim` supported. |
+| `activemail:views` | Eject the default layout + partials for customization. |
+| `activemail:styles` | Eject the SCSS framework partials for customization. |
+| `activemail:component NAME` | Scaffold a component class + print its register snippet. |
 
 ## Testing & quality
 
-An **opt-in** layer (never loaded by `require 'active_mail'`). Require it from your
+An **opt-in** layer (never loaded by `require 'activemail'`). Require it from your
 test suite.
 
 ```ruby
 # Minitest — require the assertions module explicitly:
-require 'active_mail/quality/minitest'
+require 'activemail/quality/minitest'
 
 class MailerTest < ActiveSupport::TestCase
   include ActiveMail::Quality::Minitest
@@ -322,7 +321,7 @@ end
 
 ```ruby
 # RSpec — require the matcher (registers be_a_valid_email when RSpec is loaded):
-require 'active_mail/quality/rspec'
+require 'activemail/quality/rspec'
 
 expect(rendered_html).to be_a_valid_email
 ```
@@ -338,7 +337,7 @@ ActiveMail::Quality.configure do |c|
 end
 ```
 
-`rake active_mail:emails:render_all` renders every ActionMailer preview to disk
+`rake activemail:emails:render_all` renders every ActionMailer preview to disk
 for visual diffing and fails on any guard violation among `required_previews`.
 
 ## Email-client compatibility policy

data/app/assets/stylesheets/{active_mail → activemail}/_settings.scss

@@ -1,6 +1,6 @@
 // Semantic aliases mapped from the $am-* token vars. All !default so a host
 // app can pre-declare any value before importing the framework.
-@import "active_mail/active_mail_tokens";
+@import "activemail/activemail_tokens";
 
 // Typography
 $am-font-family: $am-font-body !default;

data/app/assets/stylesheets/{active_mail/active_mail.scss → activemail/activemail.scss}

@@ -1,11 +1,11 @@
 // ActiveMail email framework entry point. Critical styles are inlined by the
 // configured CSS inliner (Gmail mobile strips <style>); only media-query and
 // dark-mode enhancements stay in the <head>.
-@import "active_mail/settings";
-@import "active_mail/grid";
-@import "active_mail/components";
-@import "active_mail/utilities";
-@import "active_mail/dark";
+@import "activemail/settings";
+@import "activemail/grid";
+@import "activemail/components";
+@import "activemail/utilities";
+@import "activemail/dark";
 
 body,
 table,

data/app/helpers/{active_mail → activemail}/styles_helper.rb

@@ -5,12 +5,12 @@ module ActiveMail
   # Embeds the compiled framework CSS as a <style> block so the Premailer adapter
   # (string-only) inlines it — it can't fetch the stylesheet_link_tag's asset URL.
   module StylesHelper
-    FRAMEWORK_STYLESHEET = 'active_mail/active_mail.css'
+    FRAMEWORK_STYLESHEET = 'activemail/activemail.css'
 
     # '' (not raise) when the asset can't be read — degrades to the link fallback,
     # but warns, since the email then ships unstyled.
-    def active_mail_inline_styles
-      css = active_mail_compiled_css
+    def activemail_inline_styles
+      css = activemail_compiled_css
       if css.blank?
         ActiveMail.log_warning('[activemail] framework stylesheet could not be read from the asset pipeline; ' \
                                'email ships without inlined framework CSS')
@@ -22,7 +22,7 @@ module ActiveMail
 
     private
 
-    def active_mail_compiled_css
+    def activemail_compiled_css
       ActiveMail::CompiledStylesheet.read(FRAMEWORK_STYLESHEET)
     end
   end

data/app/views/layouts/{active_mail → activemail}/_footer.html.inky-erb

@@ -4,7 +4,7 @@
     <spacer size="24"></spacer>
     <h-line></h-line>
     <p class="text-muted text-center">
-      <%= I18n.t("active_mail.footer.sent_with", default: "Sent with ActiveMail") %>
+      <%= I18n.t("activemail.footer.sent_with", default: "Sent with ActiveMail") %>
     </p>
   </columns>
 </row>

data/app/views/layouts/{active_mail → activemail}/mailer.html.inky-erb

@@ -16,19 +16,19 @@
     </noscript>
     <![endif]-->
     <%# Embedded so the Premailer adapter (HTML-string only) can inline the framework CSS. %>
-    <%= active_mail_inline_styles %>
-    <%# Fallback for when active_mail_inline_styles cannot read the compiled asset %>
+    <%= activemail_inline_styles %>
+    <%# Fallback for when activemail_inline_styles cannot read the compiled asset %>
     <%# (CDN-only host, compile=false without precompile); redundant otherwise, as the %>
     <%# embed's rules are idempotent once inlined. %>
-    <%= stylesheet_link_tag "active_mail/active_mail", media: "all" %>
+    <%= stylesheet_link_tag "activemail/activemail", media: "all" %>
   </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/active_mail/head" %>
+        <%= render "layouts/activemail/head" %>
         <%= yield %>
-        <%= render "layouts/active_mail/footer" %>
+        <%= render "layouts/activemail/footer" %>
       </container>
     </div>
   </body>

data/lib/{active_mail → activemail}/components/inky.rb

@@ -5,7 +5,7 @@ require_relative 'base'
 
 module ActiveMail
   module Components
-    # Renders a bare <tr> (mirrors inky.js).
+    # Renders a bare <tr>, useful inside hand-written tables.
     class Inky < Base
       extend T::Sig
 

data/lib/{active_mail → activemail}/quality/configuration.rb

@@ -48,7 +48,7 @@ module ActiveMail
       sig { void }
       def initialize
         @guard = T.let(Guard.new, Guard)
-        @output_dir = T.let('tmp/active_mail_previews', String)
+        @output_dir = T.let('tmp/activemail_previews', String)
         @required_previews = T.let([], T::Array[String])
       end
     end

data/lib/{active_mail → activemail}/quality.rb

@@ -9,7 +9,7 @@ require_relative 'quality/preview_renderer'
 
 module ActiveMail
   # Opt-in email-quality layer. Host apps require this explicitly from their test
-  # suite; `require 'active_mail'` must NOT pull it in.
+  # suite; `require 'activemail'` must NOT pull it in.
   module Quality
     extend T::Sig
 

data/lib/{active_mail → activemail}/rails/engine.rb

@@ -2,34 +2,34 @@
 # frozen_string_literal: true
 
 require 'rails/engine'
-require 'active_mail/rails/compiled_stylesheet'
+require 'activemail/rails/compiled_stylesheet'
 
 module ActiveMail
   module Rails
     class Engine < ::Rails::Engine
-      config.annotations.register_extensions('active_mail') { |annotation| /<!--\s*(#{annotation}):?\s*(.*) -->/ } if config.respond_to?(:annotations)
+      config.annotations.register_extensions('activemail') { |annotation| /<!--\s*(#{annotation}):?\s*(.*) -->/ } if config.respond_to?(:annotations)
 
       # Sprockets only compiles whitelisted assets; the framework entry must be
-      # reachable as `stylesheet_link_tag "active_mail/active_mail"` from a host.
-      initializer 'active_mail.assets' do |app|
+      # reachable as `stylesheet_link_tag "activemail/activemail"` from a host.
+      initializer 'activemail.assets' do |app|
         # Propshaft exposes config.assets but no #precompile (Sprockets-only).
         assets = app.config.respond_to?(:assets) ? app.config.assets : nil
-        assets.precompile += %w[active_mail/active_mail.css] if assets.respond_to?(:precompile)
+        assets.precompile += %w[activemail/activemail.css] if assets.respond_to?(:precompile)
       end
 
-      initializer 'active_mail.action_mailer' do
+      initializer 'activemail.action_mailer' do
         ActiveSupport.on_load(:action_mailer) do
-          require 'active_mail/inliner/interceptor'
+          require 'activemail/inliner/interceptor'
           # The interceptor honors config.register_inline_interceptor (and inliner =
           # :null) at delivery time — a boot-time check would precede host config.
           register_interceptor ActiveMail::Inliner::Interceptor
-          # active_mail_inline_styles must be available to mailer layouts/views.
+          # activemail_inline_styles must be available to mailer layouts/views.
           helper ActiveMail::StylesHelper
         end
       end
 
       rake_tasks do
-        load File.expand_path('../../tasks/active_mail.rake', __dir__)
+        load File.expand_path('../../tasks/activemail.rake', __dir__)
       end
     end
   end

data/lib/{active_mail → activemail}/version.rb

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

data/lib/activemail.rb

@@ -1,5 +1,161 @@
 # typed: strict
 # frozen_string_literal: true
 
-# Bundler auto-requires the gem name ('activemail'); the library lives in 'active_mail'.
-require 'active_mail'
+require 'nokogiri'
+require 'sorbet-runtime'
+
+require_relative 'activemail/version'
+require_relative 'activemail/components/base'
+require_relative 'activemail/components/button'
+require_relative 'activemail/components/row'
+require_relative 'activemail/components/columns'
+require_relative 'activemail/components/container'
+require_relative 'activemail/components/inky'
+require_relative 'activemail/components/block_grid'
+require_relative 'activemail/components/menu'
+require_relative 'activemail/components/menu_item'
+require_relative 'activemail/components/center'
+require_relative 'activemail/components/callout'
+require_relative 'activemail/components/spacer'
+require_relative 'activemail/components/h_line'
+require_relative 'activemail/components/wrapper'
+require_relative 'activemail/components/cta'
+require_relative 'activemail/components/info_box'
+require_relative 'activemail/configuration'
+require_relative 'activemail/inliner/interceptor'
+require_relative 'activemail/parse_error_reporter'
+
+module ActiveMail
+  class ParseError < StandardError; end
+
+  class Core
+    extend T::Sig
+
+    # Nokogiri cannot parse a bare <th> outside a <tr>; components that emit
+    # <th> use this placeholder, swapped back at the end.
+    INTERIM_TH_TAG = 'activemail-interim-th'
+    INTERIM_TH_TAG_REGEX = T.let(%r{(?<=<|</)#{Regexp.escape(INTERIM_TH_TAG)}}, Regexp)
+
+    DEFAULT_COMPONENTS = T.let(
+      {
+        'button' => ActiveMail::Components::Button,
+        'row' => ActiveMail::Components::Row,
+        'columns' => ActiveMail::Components::Columns,
+        'container' => ActiveMail::Components::Container,
+        'inky' => ActiveMail::Components::Inky,
+        'block-grid' => ActiveMail::Components::BlockGrid,
+        'menu' => ActiveMail::Components::Menu,
+        'item' => ActiveMail::Components::MenuItem,
+        'center' => ActiveMail::Components::Center,
+        'callout' => ActiveMail::Components::Callout,
+        'spacer' => ActiveMail::Components::Spacer,
+        'h-line' => ActiveMail::Components::HLine,
+        'wrapper' => ActiveMail::Components::Wrapper
+      }.freeze,
+      ActiveMail::ComponentMap
+    )
+
+    sig { returns(Integer) }
+    attr_reader :column_count, :container_width
+
+    sig { returns(T::Hash[String, ActiveMail::Components::Base]) }
+    attr_reader :component_instances
+
+    sig { params(options: T::Hash[Symbol, T.untyped]).void }
+    def initialize(options = {})
+      config = ::ActiveMail.configuration
+      @component_instances = T.let(build_components(config, options[:components]), T::Hash[String, ActiveMail::Components::Base])
+      @column_count = T.let(ActiveMail.assert_positive_dimension!(:column_count, options[:column_count] || config.column_count), Integer)
+      @container_width = T.let(ActiveMail.assert_positive_dimension!(:container_width, options[:container_width] || config.container_width), Integer)
+    end
+
+    # Object, not String: ActionView::OutputBuffer is no longer a String since Rails 7.1.
+    sig { params(html_string: Object).returns(String) }
+    def release_the_kraken(html_string)
+      raws, str = extract_raws(normalize_input(html_string))
+      parse_cmd = ::ActiveMail.full_document?(str) ? :parse : :fragment
+      html = Nokogiri::HTML.public_send(parse_cmd, str)
+      ParseErrorReporter.new(component_instances.keys).call(html.errors)
+      transform_doc(html)
+      string = html.to_html
+      string = string.gsub(INTERIM_TH_TAG_REGEX, 'th')
+      # Needle is a literal U+00A0 (Nokogiri decodes the nbsp entity to one); re-encode
+      # it to the entity for email clients that mishandle raw NBSP bytes.
+      string = string.gsub(' ', '&nbsp;')
+      re_inject_raws(string, raws)
+    end
+
+    sig { params(elem: Nokogiri::XML::Node).returns(Nokogiri::XML::Node) }
+    def transform_doc(elem)
+      if elem.respond_to?(:children)
+        elem.children.each { |child| transform_doc(child) }
+        markup = component_factory(elem)
+        elem.replace(markup) if markup
+      end
+      elem
+    end
+
+    sig { params(node: Nokogiri::XML::Node).returns(T.nilable(String)) }
+    def component_factory(node)
+      component = component_instances[node.name]
+      return unless component
+
+      # Nokogiri::NodeSet has no #join; map to String first.
+      inner = node.children.map(&:to_s).join # rubocop:disable Style/MapJoin
+      component.transform(node, inner)
+    end
+
+    sig { params(string: String).returns([T::Array[String], String]) }
+    def extract_raws(string)
+      raws = []
+      i = 0
+      # Only the tags + content, across lines: surrounding whitespace is left in
+      # place (true pass-through; eating adjacent newlines corrupts <pre>/inline text).
+      regex = %r{< *raw *>([\s\S]*?)</ *raw *>}i
+      str = string
+      while (raw = str.match(regex))
+        raws[i] = T.must(raw[1])
+        str = str.sub(regex, "###RAW#{i}###")
+        i += 1
+      end
+      [raws, str]
+    end
+
+    sig { params(string: String, raws: T::Array[String]).returns(String) }
+    def re_inject_raws(string, raws)
+      str = string
+      raws.each_with_index do |val, i|
+        # Block form: the 2-arg String#sub would expand \0/\1/\& in val.
+        str = str.sub("###RAW#{i}###") { val }
+      end
+      str = str.html_safe if str.respond_to?(:html_safe)
+      str
+    end
+
+    private
+
+    # Internal transpilation details, not public surface (column_count/container_width stay public).
+    private :component_instances, :transform_doc, :component_factory, :extract_raws, :re_inject_raws
+
+    sig { params(config: ActiveMail::Configuration, overrides: T.untyped).returns(T::Hash[String, ActiveMail::Components::Base]) }
+    def build_components(config, overrides)
+      # Lookup is by node name (String); a Symbol key would never match.
+      overrides = (overrides || {}).transform_keys(&:to_s)
+      overrides.each { |tag, klass| ActiveMail::Components.validate_component!(tag, klass) }
+      DEFAULT_COMPONENTS.merge(config.components).merge(overrides).transform_values { |klass| klass.new(self) }
+    end
+
+    sig { params(html_string: Object).returns(String) }
+    def normalize_input(html_string)
+      html_string = html_string.to_s
+      html_string = html_string.dup.force_encoding(Encoding::UTF_8) if html_string.encoding == Encoding::BINARY
+      html_string = ::ActiveMail.scrub_invalid_bytes(html_string) unless html_string.valid_encoding?
+      html_string.gsub(/doctype/i, 'DOCTYPE')
+    end
+  end
+end
+
+if defined?(Rails::Engine)
+  require 'activemail/rails/engine'
+  require 'activemail/rails/template_handler'
+end

data/lib/generators/{active_mail → activemail}/component_generator.rb

@@ -6,7 +6,7 @@ require 'rails/generators/named_base'
 module ActiveMail
   module Generators
     class ComponentGenerator < ::Rails::Generators::NamedBase
-      desc 'Scaffold an ActiveMail component class (rails g active_mail:component Cta)'
+      desc 'Scaffold an ActiveMail component class (rails g activemail:component Cta)'
       source_root File.join(File.dirname(__FILE__), 'templates')
 
       def create_component
@@ -14,7 +14,7 @@ module ActiveMail
       end
 
       def show_register_snippet
-        say "\nRegister the component in config/initializers/active_mail.rb:", :green
+        say "\nRegister the component in config/initializers/activemail.rb:", :green
         say %(  config.register_component "#{tag_name}", Components::#{class_name})
         say '(top-level Components:: — rename the module if it collides in your app)', :yellow
         say "\nThen use <#{tag_name}>…</#{tag_name}> in your ActiveMail views.\n"

data/lib/generators/{active_mail → activemail}/install_generator.rb

@@ -13,7 +13,7 @@ module ActiveMail
       class_option :slim, desc: 'Generate the layout in Slim', type: :boolean
 
       def create_initializer
-        template 'initializer.rb', File.join('config', 'initializers', 'active_mail.rb')
+        template 'initializer.rb', File.join('config', 'initializers', 'activemail.rb')
       end
 
       # A plain mailer.html.erb would win over the generated inky layout; keep it.
@@ -31,12 +31,12 @@ module ActiveMail
 
       def show_readme
         say "\nActiveMail installed.", :green
-        say '  • config/initializers/active_mail.rb — configure tokens, inliner, components.'
+        say '  • config/initializers/activemail.rb — configure tokens, inliner, components.'
         say "  • app/views/layouts/#{layout_name.underscore}.html.inky-#{extension} — your mailer layout."
         say "\nPoint your mailers at the layout, e.g. `layout \"#{layout_name.underscore}\"`, and"
         say "name views *.html.inky-#{extension} to enable ActiveMail markup."
         say "\nCustomize styling via Ruby tokens in the initializer (config.tokens.color/font/spacing),"
-        say 'or run `rails g active_mail:styles` to eject and edit the SCSS partials.'
+        say 'or run `rails g activemail:styles` to eject and edit the SCSS partials.'
       end
 
       private

data/lib/generators/{active_mail → activemail}/styles_generator.rb

@@ -6,12 +6,12 @@ module ActiveMail
   module Generators
     class StylesGenerator < ::Rails::Generators::Base
       desc 'Copy ActiveMail framework SCSS partials into the host app for customization'
-      source_root File.expand_path('../../../app/assets/stylesheets/active_mail', __dir__)
+      source_root File.expand_path('../../../app/assets/stylesheets/activemail', __dir__)
 
-      TARGET_DIR = File.join('app', 'assets', 'stylesheets', 'active_mail')
+      TARGET_DIR = File.join('app', 'assets', 'stylesheets', 'activemail')
 
       # The .scss.erb token bridge is deliberately not ejected: it needs ERB
-      # preprocessing, and tokens come from Ruby config (rake active_mail:tokens:export).
+      # preprocessing, and tokens come from Ruby config (rake activemail:tokens:export).
       def copy_styles
         Dir.children(self.class.source_root).each do |name|
           next if name.end_with?('.erb')
@@ -23,7 +23,7 @@ module ActiveMail
       def show_readme
         say "\nEjected the ActiveMail SCSS partials to #{TARGET_DIR}.", :green
         say 'Token values come from Ruby (config.tokens.color/font/spacing). For a static'
-        say 'SCSS partial of those values, run `rake active_mail:tokens:export`.'
+        say 'SCSS partial of those values, run `rake activemail:tokens:export`.'
       end
     end
   end

data/lib/generators/{active_mail → activemail}/templates/component.rb.tt

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Components
-  # Register in config/initializers/active_mail.rb:
+  # Register in config/initializers/activemail.rb:
   #   config.register_component "<%= tag_name %>", Components::<%= class_name %>
   class <%= class_name %> < ActiveMail::Components::Base
     def transform(node, inner)

data/lib/generators/{active_mail → activemail}/templates/initializer.rb

@@ -27,6 +27,6 @@ ActiveMail.configure do |config|
   # config.tokens.spacing :lg, "32px"
 
   # Register components (built-ins like ActiveMail::Components::Cta, or your own
-  # Components::* from `rails g active_mail:component`).
+  # Components::* from `rails g activemail:component`).
   # config.register_component "cta", ActiveMail::Components::Cta
 end

data/lib/generators/{active_mail → activemail}/templates/mailer_layout.html.inky-erb

@@ -15,9 +15,9 @@
       </xml>
     </noscript>
     <![endif]-->
-    <%%= active_mail_inline_styles %>
-    <%%# Fallback for when active_mail_inline_styles cannot read the compiled asset. %>
-    <%%= stylesheet_link_tag "active_mail/active_mail", media: "all" %>
+    <%%= activemail_inline_styles %>
+    <%%# Fallback for when activemail_inline_styles cannot read the compiled asset. %>
+    <%%= stylesheet_link_tag "activemail/activemail", media: "all" %>
   </head>
 
   <body style="margin:0;padding:0;word-spacing:normal;">

data/lib/generators/{active_mail → activemail}/templates/mailer_layout.html.inky-haml

@@ -8,9 +8,9 @@
     %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]-->
-    = active_mail_inline_styles
-    -# Fallback for when active_mail_inline_styles cannot read the compiled asset.
-    = stylesheet_link_tag "active_mail/active_mail", media: "all"
+    = activemail_inline_styles
+    -# Fallback for when activemail_inline_styles cannot read the compiled asset.
+    = stylesheet_link_tag "activemail/activemail", media: "all"
   %body{style: "margin:0;padding:0;word-spacing:normal;"}
     %div{role: "article", "aria-roledescription" => "email", lang: I18n.locale, style: "width:100%;"}
       %container

data/lib/generators/{active_mail → activemail}/templates/mailer_layout.html.inky-slim

@@ -7,9 +7,9 @@ html lang=I18n.locale xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-
     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]-->
-    = active_mail_inline_styles
-    / Fallback for when active_mail_inline_styles cannot read the compiled asset.
-    = stylesheet_link_tag "active_mail/active_mail", media: "all"
+    = activemail_inline_styles
+    / Fallback for when activemail_inline_styles cannot read the compiled asset.
+    = stylesheet_link_tag "activemail/activemail", media: "all"
   body style="margin:0;padding:0;word-spacing:normal;"
     div role="article" aria-roledescription="email" lang=I18n.locale style="width:100%;"
       container

data/lib/generators/{active_mail → activemail}/views_generator.rb

@@ -6,10 +6,10 @@ module ActiveMail
   module Generators
     class ViewsGenerator < ::Rails::Generators::Base
       desc 'Copy ActiveMail default layout views into the host app for customization'
-      source_root File.expand_path('../../../app/views/layouts/active_mail', __dir__)
+      source_root File.expand_path('../../../app/views/layouts/activemail', __dir__)
 
       def copy_views
-        directory '.', File.join('app', 'views', 'layouts', 'active_mail')
+        directory '.', File.join('app', 'views', 'layouts', 'activemail')
       end
     end
   end

data/lib/tasks/{active_mail.rake → activemail.rake}

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'active_mail'
+require 'activemail'
 require 'fileutils'
 
-namespace :active_mail do
+namespace :activemail do
   namespace :tokens do
     desc 'Export design tokens to a static SCSS partial (for Propshaft apps that cannot preprocess .scss.erb)'
     # :environment so the host initializer's config.tokens overrides are loaded.
     task :export, [:path] => :environment do |_task, args|
-      path = args[:path] || 'app/assets/stylesheets/active_mail/_active_mail_tokens.scss'
+      path = args[:path] || 'app/assets/stylesheets/activemail/_activemail_tokens.scss'
       FileUtils.mkdir_p(File.dirname(path))
       File.write(path, ActiveMail.scss_variables)
       puts "Wrote #{ActiveMail.tokens.colors.size + ActiveMail.tokens.fonts.size + ActiveMail.tokens.spacings.size} tokens to #{path}"
@@ -18,7 +18,7 @@ namespace :active_mail do
   namespace :emails do
     desc 'Render every host mailer preview to disk and run the quality guard on each'
     task render_all: :environment do
-      require 'active_mail/quality/render_all'
+      require 'activemail/quality/render_all'
 
       config = ActiveMail::Quality.config
       output_root = defined?(Rails) && Rails.respond_to?(:root) ? Rails.root.join(config.output_dir) : Pathname(config.output_dir)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activemail
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Advitam
@@ -52,11 +52,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.5'
 description: |
-  ActiveMail turns simple, semantic tags into the bulletproof, MSO-safe table markup
-  email clients require, with a batteries-included Rails layer on top — themeable SCSS,
-  dark mode, design tokens, a pluggable CSS-inliner (premailer/roadie) and generators.
-email:
-- tech@advitam.fr
+  ActiveMail is a plug & play gem for sending beautiful emails, written entirely in Ruby.
+  It turns simple, semantic tags into responsive, bulletproof email markup and ships with
+  modern standards — dark mode and accessibility — out of the box. Batteries included:
+  design tokens, components, automatic CSS inlining, and generators, all overridable.
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,65 +63,64 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- app/assets/stylesheets/active_mail/_active_mail_tokens.scss.erb
-- app/assets/stylesheets/active_mail/_components.scss
-- app/assets/stylesheets/active_mail/_dark.scss
-- app/assets/stylesheets/active_mail/_grid.scss
-- app/assets/stylesheets/active_mail/_settings.scss
-- app/assets/stylesheets/active_mail/_utilities.scss
-- app/assets/stylesheets/active_mail/active_mail.scss
-- app/helpers/active_mail/styles_helper.rb
-- app/views/layouts/active_mail/_footer.html.inky-erb
-- app/views/layouts/active_mail/_head.html.inky-erb
-- app/views/layouts/active_mail/mailer.html.inky-erb
-- lib/active_mail.rb
-- lib/active_mail/components/base.rb
-- lib/active_mail/components/block_grid.rb
-- lib/active_mail/components/button.rb
-- lib/active_mail/components/callout.rb
-- lib/active_mail/components/center.rb
-- lib/active_mail/components/columns.rb
-- lib/active_mail/components/container.rb
-- lib/active_mail/components/cta.rb
-- lib/active_mail/components/h_line.rb
-- lib/active_mail/components/info_box.rb
-- lib/active_mail/components/inky.rb
-- lib/active_mail/components/menu.rb
-- lib/active_mail/components/menu_item.rb
-- lib/active_mail/components/row.rb
-- lib/active_mail/components/spacer.rb
-- lib/active_mail/components/wrapper.rb
-- lib/active_mail/configuration.rb
-- lib/active_mail/inliner/base.rb
-- lib/active_mail/inliner/interceptor.rb
-- lib/active_mail/inliner/null.rb
-- lib/active_mail/inliner/premailer.rb
-- lib/active_mail/inliner/roadie.rb
-- lib/active_mail/libxml.rb
-- lib/active_mail/parse_error_reporter.rb
-- lib/active_mail/quality.rb
-- lib/active_mail/quality/configuration.rb
-- lib/active_mail/quality/guard.rb
-- lib/active_mail/quality/minitest.rb
-- lib/active_mail/quality/preview_renderer.rb
-- lib/active_mail/quality/render_all.rb
-- lib/active_mail/quality/rspec.rb
-- lib/active_mail/rails/compiled_stylesheet.rb
-- lib/active_mail/rails/engine.rb
-- lib/active_mail/rails/template_handler.rb
-- lib/active_mail/tokens.rb
-- lib/active_mail/version.rb
+- app/assets/stylesheets/activemail/_activemail_tokens.scss.erb
+- app/assets/stylesheets/activemail/_components.scss
+- app/assets/stylesheets/activemail/_dark.scss
+- app/assets/stylesheets/activemail/_grid.scss
+- app/assets/stylesheets/activemail/_settings.scss
+- app/assets/stylesheets/activemail/_utilities.scss
+- app/assets/stylesheets/activemail/activemail.scss
+- app/helpers/activemail/styles_helper.rb
+- app/views/layouts/activemail/_footer.html.inky-erb
+- app/views/layouts/activemail/_head.html.inky-erb
+- app/views/layouts/activemail/mailer.html.inky-erb
 - lib/activemail.rb
-- lib/generators/active_mail/component_generator.rb
-- lib/generators/active_mail/install_generator.rb
-- lib/generators/active_mail/styles_generator.rb
-- lib/generators/active_mail/templates/component.rb.tt
-- lib/generators/active_mail/templates/initializer.rb
-- lib/generators/active_mail/templates/mailer_layout.html.inky-erb
-- lib/generators/active_mail/templates/mailer_layout.html.inky-haml
-- lib/generators/active_mail/templates/mailer_layout.html.inky-slim
-- lib/generators/active_mail/views_generator.rb
-- lib/tasks/active_mail.rake
+- lib/activemail/components/base.rb
+- lib/activemail/components/block_grid.rb
+- lib/activemail/components/button.rb
+- lib/activemail/components/callout.rb
+- lib/activemail/components/center.rb
+- lib/activemail/components/columns.rb
+- lib/activemail/components/container.rb
+- lib/activemail/components/cta.rb
+- lib/activemail/components/h_line.rb
+- lib/activemail/components/info_box.rb
+- lib/activemail/components/inky.rb
+- lib/activemail/components/menu.rb
+- lib/activemail/components/menu_item.rb
+- lib/activemail/components/row.rb
+- lib/activemail/components/spacer.rb
+- lib/activemail/components/wrapper.rb
+- lib/activemail/configuration.rb
+- lib/activemail/inliner/base.rb
+- lib/activemail/inliner/interceptor.rb
+- lib/activemail/inliner/null.rb
+- lib/activemail/inliner/premailer.rb
+- lib/activemail/inliner/roadie.rb
+- lib/activemail/libxml.rb
+- lib/activemail/parse_error_reporter.rb
+- lib/activemail/quality.rb
+- lib/activemail/quality/configuration.rb
+- lib/activemail/quality/guard.rb
+- lib/activemail/quality/minitest.rb
+- lib/activemail/quality/preview_renderer.rb
+- lib/activemail/quality/render_all.rb
+- lib/activemail/quality/rspec.rb
+- lib/activemail/rails/compiled_stylesheet.rb
+- lib/activemail/rails/engine.rb
+- lib/activemail/rails/template_handler.rb
+- lib/activemail/tokens.rb
+- lib/activemail/version.rb
+- lib/generators/activemail/component_generator.rb
+- lib/generators/activemail/install_generator.rb
+- lib/generators/activemail/styles_generator.rb
+- lib/generators/activemail/templates/component.rb.tt
+- lib/generators/activemail/templates/initializer.rb
+- lib/generators/activemail/templates/mailer_layout.html.inky-erb
+- lib/generators/activemail/templates/mailer_layout.html.inky-haml
+- lib/generators/activemail/templates/mailer_layout.html.inky-slim
+- lib/generators/activemail/views_generator.rb
+- lib/tasks/activemail.rake
 homepage: https://github.com/AdVitam/activemail
 licenses:
 - MIT
@@ -147,5 +145,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Opinionated, plug & play responsive email toolkit for Rails.
+summary: Plug & play gem to send modern emails, entirely in Ruby, with dark mode and
+  more out of the box.
 test_files: []

data/lib/active_mail.rb

@@ -1,161 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require 'nokogiri'
-require 'sorbet-runtime'
-
-require_relative 'active_mail/version'
-require_relative 'active_mail/components/base'
-require_relative 'active_mail/components/button'
-require_relative 'active_mail/components/row'
-require_relative 'active_mail/components/columns'
-require_relative 'active_mail/components/container'
-require_relative 'active_mail/components/inky'
-require_relative 'active_mail/components/block_grid'
-require_relative 'active_mail/components/menu'
-require_relative 'active_mail/components/menu_item'
-require_relative 'active_mail/components/center'
-require_relative 'active_mail/components/callout'
-require_relative 'active_mail/components/spacer'
-require_relative 'active_mail/components/h_line'
-require_relative 'active_mail/components/wrapper'
-require_relative 'active_mail/components/cta'
-require_relative 'active_mail/components/info_box'
-require_relative 'active_mail/configuration'
-require_relative 'active_mail/inliner/interceptor'
-require_relative 'active_mail/parse_error_reporter'
-
-module ActiveMail
-  class ParseError < StandardError; end
-
-  class Core
-    extend T::Sig
-
-    # Nokogiri cannot parse a bare <th> outside a <tr>; components that emit
-    # <th> use this placeholder, swapped back at the end.
-    INTERIM_TH_TAG = 'active-mail-interim-th'
-    INTERIM_TH_TAG_REGEX = T.let(%r{(?<=<|</)#{Regexp.escape(INTERIM_TH_TAG)}}, Regexp)
-
-    DEFAULT_COMPONENTS = T.let(
-      {
-        'button' => ActiveMail::Components::Button,
-        'row' => ActiveMail::Components::Row,
-        'columns' => ActiveMail::Components::Columns,
-        'container' => ActiveMail::Components::Container,
-        'inky' => ActiveMail::Components::Inky,
-        'block-grid' => ActiveMail::Components::BlockGrid,
-        'menu' => ActiveMail::Components::Menu,
-        'item' => ActiveMail::Components::MenuItem,
-        'center' => ActiveMail::Components::Center,
-        'callout' => ActiveMail::Components::Callout,
-        'spacer' => ActiveMail::Components::Spacer,
-        'h-line' => ActiveMail::Components::HLine,
-        'wrapper' => ActiveMail::Components::Wrapper
-      }.freeze,
-      ActiveMail::ComponentMap
-    )
-
-    sig { returns(Integer) }
-    attr_reader :column_count, :container_width
-
-    sig { returns(T::Hash[String, ActiveMail::Components::Base]) }
-    attr_reader :component_instances
-
-    sig { params(options: T::Hash[Symbol, T.untyped]).void }
-    def initialize(options = {})
-      config = ::ActiveMail.configuration
-      @component_instances = T.let(build_components(config, options[:components]), T::Hash[String, ActiveMail::Components::Base])
-      @column_count = T.let(ActiveMail.assert_positive_dimension!(:column_count, options[:column_count] || config.column_count), Integer)
-      @container_width = T.let(ActiveMail.assert_positive_dimension!(:container_width, options[:container_width] || config.container_width), Integer)
-    end
-
-    # Object, not String: ActionView::OutputBuffer is no longer a String since Rails 7.1.
-    sig { params(html_string: Object).returns(String) }
-    def release_the_kraken(html_string)
-      raws, str = extract_raws(normalize_input(html_string))
-      parse_cmd = ::ActiveMail.full_document?(str) ? :parse : :fragment
-      html = Nokogiri::HTML.public_send(parse_cmd, str)
-      ParseErrorReporter.new(component_instances.keys).call(html.errors)
-      transform_doc(html)
-      string = html.to_html
-      string = string.gsub(INTERIM_TH_TAG_REGEX, 'th')
-      # Needle is a literal U+00A0 (Nokogiri decodes the nbsp entity to one); re-encode
-      # it to the entity for email clients that mishandle raw NBSP bytes.
-      string = string.gsub(' ', '&nbsp;')
-      re_inject_raws(string, raws)
-    end
-
-    sig { params(elem: Nokogiri::XML::Node).returns(Nokogiri::XML::Node) }
-    def transform_doc(elem)
-      if elem.respond_to?(:children)
-        elem.children.each { |child| transform_doc(child) }
-        markup = component_factory(elem)
-        elem.replace(markup) if markup
-      end
-      elem
-    end
-
-    sig { params(node: Nokogiri::XML::Node).returns(T.nilable(String)) }
-    def component_factory(node)
-      component = component_instances[node.name]
-      return unless component
-
-      # Nokogiri::NodeSet has no #join; map to String first.
-      inner = node.children.map(&:to_s).join # rubocop:disable Style/MapJoin
-      component.transform(node, inner)
-    end
-
-    sig { params(string: String).returns([T::Array[String], String]) }
-    def extract_raws(string)
-      raws = []
-      i = 0
-      # Only the tags + content, across lines: surrounding whitespace is left in
-      # place (true pass-through; eating adjacent newlines corrupts <pre>/inline text).
-      regex = %r{< *raw *>([\s\S]*?)</ *raw *>}i
-      str = string
-      while (raw = str.match(regex))
-        raws[i] = T.must(raw[1])
-        str = str.sub(regex, "###RAW#{i}###")
-        i += 1
-      end
-      [raws, str]
-    end
-
-    sig { params(string: String, raws: T::Array[String]).returns(String) }
-    def re_inject_raws(string, raws)
-      str = string
-      raws.each_with_index do |val, i|
-        # Block form: the 2-arg String#sub would expand \0/\1/\& in val.
-        str = str.sub("###RAW#{i}###") { val }
-      end
-      str = str.html_safe if str.respond_to?(:html_safe)
-      str
-    end
-
-    private
-
-    # Internal transpilation details, not public surface (column_count/container_width stay public).
-    private :component_instances, :transform_doc, :component_factory, :extract_raws, :re_inject_raws
-
-    sig { params(config: ActiveMail::Configuration, overrides: T.untyped).returns(T::Hash[String, ActiveMail::Components::Base]) }
-    def build_components(config, overrides)
-      # Lookup is by node name (String); a Symbol key would never match.
-      overrides = (overrides || {}).transform_keys(&:to_s)
-      overrides.each { |tag, klass| ActiveMail::Components.validate_component!(tag, klass) }
-      DEFAULT_COMPONENTS.merge(config.components).merge(overrides).transform_values { |klass| klass.new(self) }
-    end
-
-    sig { params(html_string: Object).returns(String) }
-    def normalize_input(html_string)
-      html_string = html_string.to_s
-      html_string = html_string.dup.force_encoding(Encoding::UTF_8) if html_string.encoding == Encoding::BINARY
-      html_string = ::ActiveMail.scrub_invalid_bytes(html_string) unless html_string.valid_encoding?
-      html_string.gsub(/doctype/i, 'DOCTYPE')
-    end
-  end
-end
-
-if defined?(Rails::Engine)
-  require 'active_mail/rails/engine'
-  require 'active_mail/rails/template_handler'
-end