react-email-rails 0.1.0

data/lib/generators/react_email_rails/email_generator.rb

@@ -0,0 +1,224 @@
+require("rails/generators/named_base")
+require("json")
+require("open3")
+require("timeout")
+
+module ReactEmailRails; end
+module ReactEmailRails::Generators; end
+
+class ReactEmailRails::Generators::EmailGenerator < Rails::Generators::NamedBase
+  source_root(File.expand_path("templates/email", __dir__))
+
+  argument(:actions, type: :array, default: [], banner: "method method")
+
+  class_option(
+    :skip_preview,
+    type: :boolean,
+    default: false,
+    desc: "Skip creating the mailer preview",
+  )
+  class_option(
+    :skip_test,
+    type: :boolean,
+    default: false,
+    desc: "Skip creating the mailer test",
+  )
+  class_option(
+    :emails_path,
+    type: :string,
+    desc: "Directory containing React Email components",
+  )
+  class_option(
+    :extension,
+    type: :string,
+    desc: "React Email component extension, such as tsx or jsx",
+  )
+
+  check_class_collision(suffix: "Mailer")
+
+  def create_mailer_file
+    template("mailer.rb", File.join("app/mailers", class_path, "#{file_name}_mailer.rb"))
+
+    in_root do
+      if behavior == :invoke && !File.exist?(application_mailer_file_name)
+        template("application_mailer.rb", application_mailer_file_name)
+      end
+    end
+  end
+
+  def copy_email_components
+    empty_directory(component_base_path)
+
+    actions.each do |action|
+      @action = action
+      @component_name = action.camelize
+      @path = File.join(component_base_path, "#{action}#{component_extension}")
+      template("component.tsx", @path)
+    end
+  end
+
+  def create_test_file
+    return if options[:skip_test]
+
+    template("mailer_test.rb", File.join("test/mailers", class_path, "#{file_name}_mailer_test.rb"))
+  end
+
+  def create_preview_file
+    return if options[:skip_preview]
+
+    template("mailer_preview.rb", File.join("test/mailers/previews", class_path, "#{file_name}_mailer_preview.rb"))
+  end
+
+  private
+
+  def file_name
+    @_file_name ||= super.sub(/_mailer\z/i, "")
+  end
+
+  def mailer_file_path
+    "#{file_path}_mailer"
+  end
+
+  def component_base_path
+    File.join(emails_path, "#{file_path}_mailer")
+  end
+
+  def emails_path
+    @emails_path ||= normalize_emails_path(
+      options[:emails_path].presence ||
+        vite_plugin_metadata.dig("emails", "path") ||
+        emails_path_from_vite_config ||
+        "app/javascript/emails",
+    )
+  end
+
+  def component_extension
+    @component_extension ||= normalize_extension(
+      options[:extension].presence ||
+        vite_plugin_metadata.dig("emails", "extensions")&.first ||
+        extension_from_vite_config ||
+        extension_from_existing_email_components ||
+        extension_from_existing_app_components ||
+        extension_from_typescript_signal ||
+        ".tsx",
+    )
+  end
+
+  def application_mailer_file_name
+    @_application_mailer_file_name ||= if mountable_engine?
+      "app/mailers/#{namespaced_path}/application_mailer.rb"
+    else
+      "app/mailers/application_mailer.rb"
+    end
+  end
+
+  def vite_plugin_metadata
+    @vite_plugin_metadata ||= begin
+      command = vite_config_command
+      if command
+        stdout, _stderr, status = Timeout.timeout(10) do
+          Open3.capture3(command, chdir: destination_root)
+        end
+
+        status.success? ? JSON.parse(stdout) : {}
+      else
+        {}
+      end
+    rescue JSON::ParserError, Timeout::Error
+      {}
+    end
+  end
+
+  def vite_config_command
+    [
+      "node_modules/.bin/react-email-rails-config",
+      "node_modules/.bin/react-email-rails-config.cmd",
+    ].find { |path| File.exist?(File.join(destination_root, path)) }
+  end
+
+  def emails_path_from_vite_config
+    source = vite_config_source
+    return unless source
+
+    source[
+      /reactEmailRails\s*\(\s*\{.*?emails:\s*["']([^"']+)["']/m,
+      1,
+    ] || source[
+      /reactEmailRails\s*\(\s*\{.*?emails:\s*\{.*?path:\s*["']([^"']+)["']/m,
+      1,
+    ]
+  end
+
+  def extension_from_vite_config
+    source = vite_config_source
+    return unless source
+
+    source[
+      /reactEmailRails\s*\(\s*\{.*?emails:\s*\{.*?extension:\s*["']([^"']+)["']/m,
+      1,
+    ] || source[
+      /reactEmailRails\s*\(\s*\{.*?emails:\s*\{.*?extension:\s*\[\s*["']([^"']+)["']/m,
+      1,
+    ]
+  end
+
+  def vite_config_source
+    @vite_config_source ||= begin
+      path = [
+        "vite.config.ts",
+        "vite.config.mts",
+        "vite.config.js",
+        "vite.config.mjs",
+        "vite.config.cts",
+        "vite.config.cjs",
+      ].find { |candidate| File.exist?(File.join(destination_root, candidate)) }
+
+      File.read(File.join(destination_root, path)) if path
+    end
+  end
+
+  def extension_from_existing_email_components
+    dominant_extension(Dir[File.join(destination_root, emails_path, "**/*.{tsx,jsx}")])
+  end
+
+  def extension_from_existing_app_components
+    dominant_extension(Dir[File.join(destination_root, "app/javascript/**/*.{tsx,jsx}")])
+  end
+
+  def dominant_extension(paths)
+    paths
+      .map { |path| File.extname(path) }
+      .select { |extension| [".tsx", ".jsx"].include?(extension) }
+      .tally
+      .max_by { |_extension, count| count }
+      &.first
+  end
+
+  def extension_from_typescript_signal
+    return ".tsx" if File.exist?(File.join(destination_root, "tsconfig.json"))
+
+    package_path = File.join(destination_root, "package.json")
+    return unless File.exist?(package_path)
+
+    package = JSON.parse(File.read(package_path))
+    dependencies = package.fetch("dependencies", {}).merge(package.fetch("devDependencies", {}))
+    ".tsx" if dependencies.key?("typescript")
+  rescue JSON::ParserError
+    nil
+  end
+
+  def normalize_emails_path(path)
+    path.to_s.delete_prefix("/").delete_suffix("/")
+  end
+
+  def normalize_extension(extension)
+    extension = extension.to_s
+    extension = ".#{extension}" unless extension.start_with?(".")
+
+    unless extension.match?(/\A\.[a-zA-Z0-9_.-]+\z/)
+      raise(Thor::Error, "Invalid React Email component extension: #{extension.inspect}")
+    end
+
+    extension
+  end
+end

data/lib/generators/react_email_rails/install_generator.rb

@@ -0,0 +1,211 @@
+require("json")
+
+module ReactEmailRails; end
+module ReactEmailRails::Generators; end
+
+class ReactEmailRails::Generators::InstallGenerator < Rails::Generators::Base
+  JAVASCRIPT_PACKAGES = [
+    "react-email-rails",
+    "@react-email/render",
+    "@react-email/components",
+    "react",
+    "react-dom",
+  ].freeze
+
+  PACKAGE_MANAGER_LOCKFILES = {
+    "pnpm-lock.yaml" => "pnpm",
+    "yarn.lock" => "yarn",
+    "bun.lock" => "bun",
+    "bun.lockb" => "bun",
+    "package-lock.json" => "npm",
+  }.freeze
+
+  SUPPORTED_PACKAGE_MANAGERS = ["bun", "npm", "pnpm", "yarn"].freeze
+  VITE_CONFIG_FILES = [
+    "vite.config.ts",
+    "vite.config.mts",
+    "vite.config.js",
+    "vite.config.mjs",
+    "vite.config.cts",
+    "vite.config.cjs",
+  ].freeze
+
+  VITE_IMPORT = 'import { reactEmailRails } from "react-email-rails"'
+
+  source_root(File.expand_path("templates", __dir__))
+
+  class_option(
+    :package_manager,
+    type: :string,
+    desc: "JavaScript package manager to use: npm, pnpm, yarn, or bun",
+  )
+  class_option(
+    :skip_package_install,
+    type: :boolean,
+    default: false,
+    desc: "Skip installing JavaScript dependencies",
+  )
+  class_option(
+    :skip_vite,
+    type: :boolean,
+    default: false,
+    desc: "Skip updating vite.config.*",
+  )
+  def copy_initializer
+    template("initializer.rb", "config/initializers/react_email_rails.rb")
+  end
+
+  def install_javascript_dependencies
+    return if options[:skip_package_install]
+
+    package = package_json
+    unless package
+      say_status(:skip, "JavaScript dependencies; package.json was not found", :yellow)
+      return
+    end
+
+    missing = missing_javascript_packages(package)
+    if missing.empty?
+      say_status(:identical, "JavaScript dependencies", :green)
+      return
+    end
+
+    manager = package_manager(package)
+    unless manager
+      say_status(
+        :skip,
+        "JavaScript dependencies; could not detect npm, pnpm, yarn, or bun",
+        :yellow,
+      )
+      return
+    end
+
+    run(javascript_install_command(manager, missing))
+  end
+
+  def configure_vite
+    return if options[:skip_vite]
+
+    if (config = vite_config_path)
+      update_vite_config(config)
+    else
+      template("vite.config.ts", "vite.config.ts")
+    end
+  end
+
+  def create_email_directory
+    empty_directory("app/javascript/emails")
+  end
+
+  private
+
+  def destination_path(path)
+    File.join(destination_root, path)
+  end
+
+  def package_json_path
+    destination_path("package.json")
+  end
+
+  def package_json
+    return unless File.exist?(package_json_path)
+
+    JSON.parse(File.read(package_json_path))
+  rescue JSON::ParserError => e
+    say_status(:skip, "JavaScript dependencies; package.json is invalid: #{e.message}", :yellow)
+    nil
+  end
+
+  def missing_javascript_packages(package)
+    dependencies = package.fetch("dependencies", {}).merge(package.fetch("devDependencies", {}))
+
+    JAVASCRIPT_PACKAGES.reject { |name| dependencies.key?(name) }
+  end
+
+  def package_manager(package)
+    manager = options[:package_manager].presence || package_manager_from_package_json(package) || package_manager_from_lockfile
+    return unless manager
+
+    manager = manager.to_s
+    raise(Thor::Error, "Unsupported package manager: #{manager}") if SUPPORTED_PACKAGE_MANAGERS.exclude?(manager)
+
+    manager
+  end
+
+  def package_manager_from_package_json(package)
+    package.fetch("packageManager", "").to_s.split("@").first.presence
+  end
+
+  def package_manager_from_lockfile
+    lockfile = PACKAGE_MANAGER_LOCKFILES.keys.find { |path| File.exist?(destination_path(path)) }
+    PACKAGE_MANAGER_LOCKFILES[lockfile]
+  end
+
+  def javascript_install_command(manager, packages)
+    case manager
+    when "npm"
+      "npm install #{packages.join(" ")}"
+    when "pnpm"
+      "pnpm add #{packages.join(" ")}"
+    when "yarn"
+      "yarn add #{packages.join(" ")}"
+    when "bun"
+      "bun add #{packages.join(" ")}"
+    end
+  end
+
+  def vite_config_path
+    VITE_CONFIG_FILES.find { |path| File.exist?(destination_path(path)) }
+  end
+
+  def update_vite_config(path)
+    full_path = destination_path(path)
+    source = File.read(full_path)
+
+    if configured_for_react_email?(source)
+      say_status(:identical, path, :green)
+      return
+    end
+
+    updated = insert_react_email_plugin(source)
+    unless updated
+      say_status(:skip, "#{path}; add reactEmailRails() to the Vite plugins array", :yellow)
+      return
+    end
+
+    File.write(full_path, ensure_react_email_import(updated))
+    say_status(:insert, path, :green)
+  end
+
+  def configured_for_react_email?(source)
+    source.match?(/reactEmailRails\s*\(/)
+  end
+
+  def insert_react_email_plugin(source)
+    return source if configured_for_react_email?(source)
+
+    if source.match?(/plugins:\s*\[\s*\]/)
+      source.sub(/plugins:\s*\[\s*\]/, "plugins: [reactEmailRails()]")
+    elsif source.match?(/plugins:\s*\[/)
+      source.sub(/plugins:\s*\[/) { |match| "#{match}reactEmailRails(), " }
+    elsif source.match?(/defineConfig\(\s*\{/)
+      source.sub(/defineConfig\(\s*\{/) { |match| "#{match}\n  plugins: [reactEmailRails()]," }
+    elsif source.match?(/export\s+default\s+\{/)
+      source.sub(/export\s+default\s+\{/) { |match| "#{match}\n  plugins: [reactEmailRails()]," }
+    end
+  end
+
+  def ensure_react_email_import(source)
+    return source if source.match?(/from\s+["']react-email-rails["']/)
+
+    lines = source.lines
+    last_import_index = (lines.length - 1).downto(0).find { |index| lines[index].match?(/\Aimport\b/) }
+
+    if last_import_index
+      lines.insert(last_import_index + 1, "#{VITE_IMPORT}\n")
+      lines.join
+    else
+      "#{VITE_IMPORT}\n\n#{source}"
+    end
+  end
+end

data/lib/generators/react_email_rails/templates/USAGE

@@ -0,0 +1,33 @@
+Description:
+    Generate an Action Mailer class backed by React Email components.
+
+Example:
+    bin/rails generate react_email_rails:email Account created invited
+
+    This creates:
+        app/mailers/account_mailer.rb
+        app/javascript/emails/account_mailer/created.tsx
+        app/javascript/emails/account_mailer/invited.tsx
+        test/mailers/account_mailer_test.rb
+        test/mailers/previews/account_mailer_preview.rb
+
+    The generator follows Rails' mailer generator shape:
+
+        NAME [method method]
+
+Options:
+    --emails-path=app/emails
+        Override the React Email component directory. By default this is
+        detected from reactEmailRails({ emails: ... }) in vite.config.* and
+        falls back to app/javascript/emails.
+
+    --extension=tsx|jsx|email.tsx
+        Override the generated component extension. By default this is detected
+        from the Vite plugin config, existing components, TypeScript signals,
+        and finally falls back to tsx.
+
+    --skip-test
+        Do not create a mailer test.
+
+    --skip-preview
+        Do not create a mailer preview.

data/lib/generators/react_email_rails/templates/email/application_mailer.rb.tt

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+end
+<% end -%>

data/lib/generators/react_email_rails/templates/email/component.tsx

@@ -0,0 +1,14 @@
+import { Body, Container, Heading, Html, Text } from "@react-email/components"
+
+export default function <%= @component_name %>() {
+  return (
+    <Html>
+      <Body>
+        <Container>
+          <Heading><%= class_name %>Mailer#<%= @action %></Heading>
+          <Text>Hi, find me in <%= @path %></Text>
+        </Container>
+      </Body>
+    </Html>
+  )
+}

data/lib/generators/react_email_rails/templates/email/mailer.rb.tt

@@ -0,0 +1,17 @@
+<% module_namespacing do -%>
+class <%= class_name %>Mailer < ApplicationMailer
+<% actions.each_with_index do |action, index| -%>
+<% if index != 0 -%>
+
+<% end -%>
+  # Subject can be set in your I18n file at config/locales/en.yml
+  # with the following lookup:
+  #
+  #   en.<%= mailer_file_path.tr("/", ".") %>.<%= action %>.subject
+  #
+  def <%= action %>
+    mail to: "to@example.org", react: true
+  end
+<% end -%>
+end
+<% end -%>

data/lib/generators/react_email_rails/templates/email/mailer_preview.rb.tt

@@ -0,0 +1,14 @@
+<% module_namespacing do -%>
+# Preview all emails at http://localhost:3000/rails/mailers/<%= mailer_file_path %>
+class <%= class_name %>MailerPreview < ActionMailer::Preview
+<% actions.each_with_index do |action, index| -%>
+<% if index != 0 -%>
+
+<% end -%>
+  # Preview this email at http://localhost:3000/rails/mailers/<%= mailer_file_path %>/<%= action %>
+  def <%= action %>
+    <%= class_name %>Mailer.<%= action %>
+  end
+<% end -%>
+end
+<% end -%>

data/lib/generators/react_email_rails/templates/email/mailer_test.rb.tt

@@ -0,0 +1,28 @@
+require "test_helper"
+
+<% module_namespacing do -%>
+class <%= class_name %>MailerTest < ActionMailer::TestCase
+<% actions.each_with_index do |action, index| -%>
+<% if index != 0 -%>
+
+<% end -%>
+  test "<%= action %>" do
+    rendered = ReactEmailRails::RenderedEmail.new(html: "<p>Hi</p>", text: "Hi")
+
+    ReactEmailRails.stub(:render, rendered) do
+      mail = <%= class_name %>Mailer.<%= action %>
+
+      assert_equal <%= action.to_s.humanize.inspect %>, mail.subject
+      assert_equal ["to@example.org"], mail.to
+      assert_equal ["from@example.com"], mail.from
+      assert_match "Hi", mail.body.encoded
+    end
+  end
+<% end -%>
+<% if actions.blank? -%>
+  # test "the truth" do
+  #   assert true
+  # end
+<% end -%>
+end
+<% end -%>

data/lib/generators/react_email_rails/templates/initializer.rb

@@ -0,0 +1,3 @@
+ReactEmailRails.configure do |config|
+  # See configuration options at: https://github.com/heysupertape/react-email-rails#configuration
+end

data/lib/generators/react_email_rails/templates/vite.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from "vite"
+import { reactEmailRails } from "react-email-rails"
+
+export default defineConfig({
+  plugins: [reactEmailRails()],
+})

data/lib/react-email-rails.rb

@@ -0,0 +1 @@
+require_relative("react_email_rails")

data/lib/react_email_rails/action_mailer.rb

@@ -0,0 +1,31 @@
+module ReactEmailRails::ActionMailer
+  extend(ActiveSupport::Concern)
+
+  prepended do
+    class_attribute(:react_email_use_instance_props, default: false)
+  end
+
+  class_methods do
+    def use_react_instance_props
+      self.react_email_use_instance_props = true
+    end
+  end
+
+  def mail(headers = {}, &block)
+    return super unless headers.is_a?(Hash) && headers.key?(:react)
+
+    headers = headers.dup
+    react = headers.delete(:react)
+    props = headers.delete(:props) if headers.key?(:props)
+
+    component, resolved_props = ReactEmailRails::PropsResolver.new(self).resolve(react, props)
+    render_options = ReactEmailRails.configuration.resolve_render_options(self)
+    rendered = ReactEmailRails.render(component:, props: resolved_props, render_options:)
+
+    super(headers) do |format|
+      format.html { rendered.html }
+      format.text { rendered.text } if rendered.text.present?
+      yield(format) if block
+    end
+  end
+end