rails_courrier 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c27079a012b10a2af5545069b4fd95df7fee48f90ca676d556f6fbe0e5c14c0
+  data.tar.gz: 7624375dfacce56335d8cd31a4a896be095fdd23bc1d66e7238470221661cad5
+SHA512:
+  metadata.gz: 79f5e0e925e3d9513422e749b390a5e4e57f2d423f062657aae3b1fd4ac13214725fa5ae7fb098885a928db77b9c6297b9493d65f88d3283e13e6ff0273ac006
+  data.tar.gz: 706a198bc22cf183ba6cd02581c622c0d3b790c17bd5e8c6f7a8b7d60809d38bf22a22920feab28e4fe46045660436a1ec050b144063ffc1db648556c3b58544

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "standard", "~> 1.49"
+end
+
+group :development, :test do
+  gem "rake", "~> 13.2", ">= 13.2.1"
+  gem "minitest", "~> 5.25", ">= 5.25.5"
+  gem "debug", "~> 1.9", ">= 1.9.2"
+end

data/Gemfile.lock

@@ -0,0 +1,214 @@
+PATH
+  remote: .
+  specs:
+    rails_courrier (0.5.0)
+      actionpack (>= 7.0)
+      actionview (>= 7.0)
+      activejob (>= 7.0)
+      courrier (~> 0.11.0)
+      launchy (>= 3.1, < 4)
+      railties (>= 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (8.1.3)
+      actionview (= 8.1.3)
+      activesupport (= 8.1.3)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.1.3)
+      activesupport (= 8.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.1.3)
+      activesupport (= 8.1.3)
+      globalid (>= 0.3.6)
+    activesupport (8.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (4.1.2)
+    builder (3.3.0)
+    childprocess (5.1.0)
+      logger (~> 1.5)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
+    courrier (0.11.0)
+      logger (>= 1.5, < 3)
+      nokogiri (>= 1.18, < 2)
+    crass (1.0.6)
+    date (3.5.1)
+    debug (1.11.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.3)
+    erb (6.0.4)
+    erubi (1.13.1)
+    globalid (1.3.0)
+      activesupport (>= 6.1)
+    i18n (1.14.8)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.19.8)
+    language_server-protocol (3.17.0.5)
+    launchy (3.1.1)
+      addressable (~> 2.8)
+      childprocess (~> 5.0)
+      logger (~> 1.6)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    loofah (2.25.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.27.0)
+    nokogiri (1.19.3-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.19.3-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.19.3-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.19.3-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.19.3-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.19.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.19.3-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.19.3-x86_64-linux-musl)
+      racc (~> 1.4)
+    parallel (1.28.0)
+    parser (3.3.11.1)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    psych (5.4.0)
+      date
+      stringio
+    public_suffix (7.0.5)
+    racc (1.8.1)
+    rack (3.2.6)
+    rack-session (2.1.2)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.3.1)
+      rack (>= 3)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.7.0)
+      loofah (~> 2.25)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.1.3)
+      actionpack (= 8.1.3)
+      activesupport (= 8.1.3)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.4.2)
+    rdoc (7.2.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    regexp_parser (2.12.0)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rubocop (1.84.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    standard (1.54.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.84.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.9.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.26.0)
+    stringio (3.2.0)
+    thor (1.5.0)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    useragent (0.16.11)
+    zeitwerk (2.8.2)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  debug (~> 1.9, >= 1.9.2)
+  minitest (~> 5.25, >= 5.25.5)
+  rails_courrier!
+  rake (~> 13.2, >= 13.2.1)
+  standard (~> 1.49)
+
+BUNDLED WITH
+   2.6.8

data/README.md

@@ -0,0 +1,123 @@
+# Rails Courrier
+
+Rails-specific features for [Courrier](https://github.com/Rails-Designer/courrier), the API-powered email delivery gem for Ruby.
+
+![Preview of the Rails Courrier inbox with a list of images on the left and preview of an email on the right](https://raw.githubusercontent.com/Rails-Designer/rails_courrier/HEAD/.github/rails_courrier_inbox.jpg)
+
+
+## Installation
+
+Add to your Gemfile:
+```bash
+bundle add rails_courrier
+```
+
+<a href="https://railsdesigner.com/" target="_blank">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Rails-Designer/courrier/HEAD/.github/logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/Rails-Designer/courrier/HEAD/.github/logo-light.svg">
+    <img alt="Rails Designer logo" src="https://raw.githubusercontent.com/Rails-Designer/courrier/HEAD/.github/logo-light.svg" width="240" style="max-width: 100%;">
+  </picture>
+</a>
+
+**Sponsored By [Rails Designer](https://railsdesigner.com/)**
+
+
+## Setup
+
+Generate the initializer:
+```bash
+bin/rails generate courrier:install
+```
+
+This creates `config/initializers/courrier.rb`.
+
+Generate an email:
+```bash
+bin/rails generate courrier:email Order
+```
+
+This creates `app/emails/order_email.rb`.
+
+Mount the engine for inbox previews:
+```ruby
+# config/routes.rb
+mount Courrier::Engine => "/courrier"
+```
+
+
+## Usage
+
+### Send emails
+
+```ruby
+OrderEmail.deliver to: "recipient@example.com"
+```
+
+
+### Deliver later via ActiveJob
+
+```ruby
+OrderEmail.deliver_later to: "recipient@example.com"
+```
+
+Configure queue options in the email class:
+```ruby
+class OrderEmail < Courrier::Email
+  enqueue queue: "emails", wait: 5.minutes
+
+  def subject = "Your order is ready!"
+  # …
+end
+```
+
+
+### Inbox provider
+
+Preview emails in your browser:
+```ruby
+# config/initializers/courrier.rb
+Courrier.configure do |config|
+  config.email = { provider: "inbox" }
+end
+```
+
+Enable auto-open:
+
+```ruby
+config.email = { provider: "inbox" }
+config.inbox.auto_open = true
+```
+
+Clear inbox files:
+
+```bash
+bin/rails courrier:clear
+```
+
+
+### URL helpers
+
+Rails Courrier automatically includes Rails URL helpers in your email classes:
+```ruby
+class OrderEmail < Courrier::Email
+  def text
+    "View your order: #{order_url(token: "abc123")}"
+  end
+end
+```
+
+
+## Documentation
+
+See the [Courrier README](https://github.com/Rails-Designer/courrier) for full configuration, providers, layouts, templates and more.
+
+
+## Contributing
+
+This project uses [Standard](https://github.com/testdouble/standard) for formatting Ruby code. Please make sure to run `rake` before submitting pull requests.
+
+
+## License
+
+Courrier is released under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+require "standard/rake"
+
+Minitest::TestTask.create
+
+task default: %i[test standard]

data/app/controllers/courrier/previews/cleanups_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Courrier
+  module Previews
+    class CleanupsController < ActionController::Base
+      def create
+        system("bin/rails courrier:clear")
+
+        redirect_to root_path
+      end
+    end
+  end
+end

data/app/controllers/courrier/previews_controller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Courrier
+  class PreviewsController < ActionController::Base
+    def index
+      @emails = emails.map { Courrier::Email::Providers::Inbox::Email.from_file(it) }
+    end
+
+    def show
+      file_path = File.join(Courrier.configuration.inbox.destination, params[:id])
+      content = File.read(file_path)
+
+      render html: content.html_safe, layout: false
+    end
+
+    private
+
+    def emails
+      @emails ||= Dir.glob("#{Courrier.configuration.inbox.destination}/*.html")
+        .sort_by { -File.basename(it, ".html").to_i }
+    end
+  end
+end

data/app/views/courrier/previews/index.html.erb

@@ -0,0 +1,167 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Courrier Inbox</title>
+
+    <style>
+      *, *::before, *::after { box-sizing: border-box; }
+      * { margin: 0; padding: 0; }
+      body { margin: 0; padding: 0; font-size: 16px; line-height: 1.5; font-family: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; background-color: rgb(241 245 249); }
+
+      .sidebar {
+        display: flex;
+        flex-direction: column;
+        position: sticky;
+        top: 0;
+        padding: .5rem;
+        width: min(350px, 33.3333%); height: 100dvh;
+        border-right: 1px solid rgb(226 232 240);
+      }
+
+      .sidebar__options {
+        position: sticky;
+        bottom: 0;
+        padding: .5rem;
+        background-color: rgb(241 245 249);
+      }
+
+      .sidebar__btn-clear {
+        border: none;
+        display: flex;
+        align-items: center;
+        justify-content: center;
+        column-gap: .25rem;
+        width: 100%;
+        padding: .5rem;
+        font-size: .875rem; line-height: 1.25rem;
+        font-weight: 500;
+        color: rgb(71 85 105);
+        background-color: rgb(226 232 240);
+        border-radius: .5rem;
+        cursor: default;
+
+        &:hover { background-color: rgb(203 213 225); }
+        &:active { transform: scale(.98); }
+
+        [data-slot="icon"] { width: .875rem; height: .875rem; }
+      }
+
+      .email-previews {
+        display: flex;
+        flex-direction: column;
+        flex: 1;
+        row-gap: .5rem;
+        overflow-y: auto;
+        width: 100%;
+      }
+
+      .email-preview {
+        display: flex;
+        flex-direction: row;
+        column-gap: .5rem;
+        width: 100%;
+        padding: .5rem .75rem;
+        text-decoration: none;
+        border-radius: .5rem;
+
+        &:hover { background-color: rgb(226 232 240 / .75); }
+      }
+
+      .email-preview--empty {
+        display: none;
+        text-align: center;
+
+        &:only-child { display: block; }
+      }
+
+      .email-preview__avatar {
+        flex-shrink: 0;
+        padding: .25rem;
+        width: 1.5rem; height: 1.5rem;
+        background-color: rgb(203 213 225);
+        color: rgb(51, 65, 85);
+        border-radius: 9999px;
+      }
+
+      .email-preview__content {
+        font-size: .875rem;
+        line-height: 1.25rem;
+      }
+
+      .email-preview__recipient {
+        font-size: 1rem; line-height: 1.5rem;
+        font-weight: 600;
+        letter-spacing: -.025em;
+        color: rgb(51 65 85);
+      }
+
+      .email-preview__subject {
+        margin-top: .125rem;
+        overflow: hidden; display: -webkit-box; -webkit-box-orient: vertical; -webkit-line-clamp: 1;
+        color: rgb(100 116 139);
+      }
+    </style>
+  </head>
+
+  <body>
+    <div style="display: flex; column-gap: 1rem;">
+      <aside class="sidebar">
+        <ul class="email-previews">
+          <li class="email-preview--empty">
+            <p class="email-preview__subject">
+              No emails yet…
+            </p>
+          </li>
+
+          <% @emails.each do |email| %>
+            <li>
+              <%= link_to courrier.preview_path(email.filename), data: {remote: true}, class: "email-preview" do %>
+                <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="email-preview__avatar">
+                  <path fill-rule="evenodd" d="M7.5 6a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM3.751 20.105a8.25 8.25 0 0 1 16.498 0 .75.75 0 0 1-.437.695A18.683 18.683 0 0 1 12 22.5c-2.786 0-5.433-.608-7.812-1.7a.75.75 0 0 1-.437-.695Z" clip-rule="evenodd"/>
+                </svg>
+
+                <div class="email-preview__content">
+                  <small class="email-preview__recipient">
+                    <%= email.metadata.to %>
+                  </small>
+
+                  <p class="email-preview__subject">
+                    <%= email.metadata.subject || "No subject" %>
+                  </p>
+                </div>
+              <% end %>
+            </li>
+          <% end %>
+        </ul>
+
+        <div class="sidebar__options">
+          <%= button_to courrier.cleanup_path, class: "sidebar__btn-clear" do %>
+            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon">
+              <path fill-rule="evenodd" d="M16.5 4.478v.227a48.816 48.816 0 0 1 3.878.512.75.75 0 1 1-.256 1.478l-.209-.035-1.005 13.07a3 3 0 0 1-2.991 2.77H8.084a3 3 0 0 1-2.991-2.77L4.087 6.66l-.209.035a.75.75 0 0 1-.256-1.478A48.567 48.567 0 0 1 7.5 4.705v-.227c0-1.564 1.213-2.9 2.816-2.951a52.662 52.662 0 0 1 3.369 0c1.603.051 2.815 1.387 2.815 2.951Zm-6.136-1.452a51.196 51.196 0 0 1 3.273 0C14.39 3.05 15 3.684 15 4.478v.113a49.488 49.488 0 0 0-6 0v-.113c0-.794.609-1.428 1.364-1.452Zm-.355 5.945a.75.75 0 1 0-1.5.058l.347 9a.75.75 0 1 0 1.499-.058l-.346-9Zm5.48.058a.75.75 0 1 0-1.498-.058l-.347 9a.75.75 0 0 0 1.5.058l.345-9Z" clip-rule="evenodd"/>
+            </svg>
+
+            Clear inbox
+          <% end %>
+        </div>
+      </aside>
+
+      <article style="flex: 1;" id="email-preview">
+      </article>
+    </div>
+
+    <script>
+      document.querySelectorAll("a[data-remote]").forEach(link => {
+        link.addEventListener("click", (event) => {
+          event.preventDefault();
+
+          fetch(link.href)
+            .then(response => response.text())
+            .then(html => {
+              document.getElementById("email-preview").innerHTML = html;
+            });
+        });
+      });
+    </script>
+  </body>
+</html>

data/bin/release

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+VERSION=$1
+
+if [ -z "$VERSION" ]; then
+  echo "Error: Version number or bump type is required."
+  echo "Usage: $0 <major|minor|patch|version-number>"
+
+  exit 1
+fi
+
+if [[ "$VERSION" =~ ^(major|minor|patch)$ ]]; then
+  CURRENT=$(grep -o '"[^"]*"' ./lib/rails_courrier/version.rb | tr -d '"')
+  IFS='.' read -r MAJOR MINOR PATCH <<< "$CURRENT"
+
+  case $VERSION in
+    major) VERSION="$((MAJOR + 1)).0.0" ;;
+    minor) VERSION="$MAJOR.$((MINOR + 1)).0" ;;
+    patch) VERSION="$MAJOR.$MINOR.$((PATCH + 1))" ;;
+  esac
+fi
+
+printf "module RailsCourrier\n  VERSION = \"$VERSION\"\nend\n" > ./lib/rails_courrier/version.rb
+
+bundle
+
+git add Gemfile.lock lib/rails_courrier/version.rb
+git commit -m "Bump version for $VERSION"
+git push
+git tag v$VERSION
+git push --tags
+
+bundle exec rake build
+gem push "pkg/rails_courrier-$VERSION.gem"

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Courrier::Engine.routes.draw do
+  resources :previews, only: %w[show], constraints: {id: /.*\.html/}
+  resource :cleanup, only: %w[create], module: "previews"
+
+  root "previews#index"
+end

data/lib/courrier/configuration/inbox.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Configuration
+    class Inbox
+      attr_accessor :destination, :auto_open, :template_path
+
+      def initialize
+        @destination = default_destination
+        @auto_open = false
+        @template_path = File.expand_path("../email/providers/inbox/default.html.erb", __dir__)
+      end
+
+      private
+
+      def default_destination
+        Rails.root.join("tmp", "courrier", "emails").to_s
+      end
+    end
+  end
+end

data/lib/courrier/email/delivery_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    class DeliveryJob < ActiveJob::Base
+      def perform(email_class_name, **options)
+        Object.const_get(email_class_name).new(**options).deliver_now
+      end
+    end
+  end
+end