RubyGems - rails_courrier - Versions diffs - 0.5.0 - Mend

rails_courrier 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

checksums.yaml +7 -0
data/Gemfile +15 -0
data/Gemfile.lock +214 -0
data/README.md +123 -0
data/Rakefile +9 -0
data/app/controllers/courrier/previews/cleanups_controller.rb +13 -0
data/app/controllers/courrier/previews_controller.rb +23 -0
data/app/views/courrier/previews/index.html.erb +167 -0
data/bin/release +34 -0
data/bin/setup +8 -0
data/config/routes.rb +8 -0
data/lib/courrier/configuration/inbox.rb +21 -0
data/lib/courrier/email/delivery_job.rb +11 -0
data/lib/courrier/email/providers/inbox/default.html.erb +127 -0
data/lib/courrier/email/providers/inbox.rb +83 -0
data/lib/courrier/engine.rb +7 -0
data/lib/courrier/railtie.rb +49 -0
data/lib/courrier/tasks/courrier.rake +13 -0
data/lib/generators/courrier/email_generator.rb +42 -0
data/lib/generators/courrier/install_generator.rb +11 -0
data/lib/generators/courrier/templates/email/password_reset.rb.tt +29 -0
data/lib/generators/courrier/templates/email/welcome.rb.tt +43 -0
data/lib/generators/courrier/templates/email.rb.tt +19 -0
data/lib/generators/courrier/templates/initializer.rb.tt +44 -0
data/lib/rails_courrier/version.rb +3 -0
data/lib/rails_courrier.rb +23 -0
data/rails_courrier.gemspec +29 -0
metadata +159 -0

data/lib/courrier/email/providers/inbox/default.html.erb ADDED Viewed

@@ -0,0 +1,127 @@
+<!--
+{
+  "to": "<%= email %>",
+  "subject": "<%= @options.subject %>"
+}
+-->
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title><%= @options.subject %></title>
+    <style>
+      *, *::before, *::after { box-sizing: border-box; }
+      * { margin: 0; padding: 0; }
+      body { margin: 0; padding: 0; 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); }
+      pre { margin: 0; white-space: pre-wrap; }
+      .email {
+        width: 100%;
+        max-width: 65rem;
+        margin-left: auto; margin-right: auto;
+        background-color: #fff;
+        box-shadow: 0 20px 25px -5px rgb(0 0 0 / .1), 0 8px 10px -6px rgb(0 0 0 / 0.1);
+        border-bottom-right-radius: 1rem; border-bottom-left-radius: 1rem;
+      }
+      .email__header { display: flex; align-items: center; padding: .75rem; -moz-column-gap: .75rem; column-gap: .75rem; }
+      .email__avatar {
+        flex-shrink: 0;
+        padding: .25rem;
+        width: 2rem; height: 2rem;
+        background-color: rgb(203 213 225);
+        color: rgb(51 65 85);
+        border-radius: 9999px;
+      }
+      .email__recipient { flex-grow: 1; font-size: .875rem; line-height: 1.25rem; }
+      .email__recipient-name { font-weight: 600; color: rgb(51 65 85); }
+      .email__metadata { display: flex; align-items: center; justify-content: space-between; }
+      .email__recipient-email { color: rgb(100 116 139); }
+      .email__datetime { font-size: .75rem; line-height: 1rem; color: rgb(148 163 184); }
+      .email__subject {
+        margin-left: 3.5rem;
+        font-size: 1.25rem; line-height: 1.75rem;
+        font-weight: 700;
+        letter-spacing: -.025em;
+        color: rgb(30 41 59)
+      }
+      .email__preview { margin-top: .75rem; margin-left: 3.5rem; padding-bottom: 1rem; }
+      .preview-toggle { display: none; }
+      .preview-toggle-label {
+        display: inline-block;
+        padding: .25rem .875rem;
+        font-size: .75rem; line-height: 1rem;
+        font-weight: 600;
+        color: rgb(30 41 59);
+        background-color: rgb(255 255 255);
+        border: 1px solid rgb(226 232 240);
+        border-radius: .375rem;
+        box-shadow: 0 1px 3px 0 rgb(0 0 0 / 0.1), 0 1px 2px -1px rgb(0 0 0 / 0.1);
+        cursor: pointer;
+        &:hover { border-color: rgb(203 213 225); }
+        &:active { transform: scale(.98); }
+      }
+      .preview-toggle[disabled] + .preview-toggle-label { opacity: 0.5; cursor: not-allowed; }
+      .email__preview-html, .email__preview-text { margin-top: 1.5rem;}
+      .email__preview-html { display: none; }
+      .preview-toggle:checked ~ .email__preview-text { display: none; }
+      .preview-toggle:checked ~ .email__preview-html { display: block; }
+    </style>
+  </head>
+  <body>
+    <article class="email">
+      <header class="email__header">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="email__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__recipient">
+          <% if name %>
+            <p class="email__recipient-name">
+              <%= name %>
+            </p>
+          <% end %>
+          <div class="email__metadata">
+            <p class="email__recipient-email">
+              <%= email %>
+            </p>
+            <time class="email__datetime" datetime="#{Time.now.strftime("%Y-%m-%d %H:%M:%S %z")}">
+              <%= Time.now.strftime("%Y-%m-%d %H:%M:%S %z") %>
+            </time>
+          </div>
+        </div>
+      </header>
+      <p class="email__subject">
+        <%= @options.subject %>
+      </p>
+      <div class="email__preview">
+        <input type="checkbox" id="preview-toggle" class="preview-toggle" <%= html ? "" : "disabled" %>>
+        <label for="preview-toggle" class="preview-toggle-label">Toggle HTML/Text</label>
+        <div class="email__preview-text">
+          <pre><%= text || "(no text content)" %></pre>
+        </div>
+        <div class="email__preview-html">
+          <%= html || "<p>(no HTML content)</p>" %>
+        </div>
+      </div>
+    </article>
+  </body>
+</html>

data/lib/courrier/email/providers/inbox.rb ADDED Viewed

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+require "tmpdir"
+require "fileutils"
+require "launchy"
+module Courrier
+  class Email
+    module Providers
+      class Inbox < Base
+        def deliver
+          FileUtils.mkdir_p(config.destination)
+          file_path = File.join(config.destination, "#{Time.now.to_i}.html")
+          File.write(file_path, ERB.new(File.read(config.template_path)).result(binding))
+          Launchy.open(file_path) if config.auto_open
+          "📮 Email saved to #{file_path} and #{email_destination}"
+        end
+        def name = extract(@options.to)[:name]
+        def email = extract(@options.to)[:email]
+        def text = prepare(@options.text)
+        def html = prepare(@options.html)
+        private
+        def extract(to)
+          if to.to_s =~ /(.*?)\s*<(.+?)>/
+            {name: $1.strip, email: $2.strip}
+          else
+            {name: nil, email: to.to_s.strip}
+          end
+        end
+        def prepare(content)
+          content.to_s.gsub(URL_PARSER.make_regexp(%w[http https])) do |url|
+            %(<a href="#{url}">#{url}</a>)
+          end
+        end
+        def config = @config ||= Courrier.configuration.inbox
+        def email_destination
+          return "opened in your default browser" if config.auto_open
+          path = begin
+            Rails.application.routes.url_helpers.courrier_path
+          rescue
+            "/courrier/ (Note: Add `mount Courrier::Engine => \"/courrier\"` to your routes.rb to enable routing)"
+          end
+          "available at #{path}"
+        end
+        URL_PARSER = (
+          defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER
+        )
+        class Email < Data.define(:path, :filename, :metadata)
+          Metadata = Data.define(:to, :subject)
+          def self.from_file(path)
+            content = File.read(path)
+            json = content[/<!--\s*(.*?)\s*-->/m, 1]
+            metadata = JSON.parse(json, symbolize_names: true)
+            new(
+              path: path,
+              filename: File.basename(path),
+              metadata: Metadata.new(**metadata)
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/courrier/engine.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module Courrier
+  class Engine < ::Rails::Engine
+    isolate_namespace Courrier
+  end
+end

data/lib/courrier/railtie.rb ADDED Viewed

@@ -0,0 +1,49 @@
+module Courrier
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      Courrier::Email.default_url_options = Courrier.configuration.default_url_options
+      if Courrier.configuration.email_path == File.join("courrier", "emails")
+        Courrier.configuration.email_path = Rails.root.join("app", "emails").to_s
+      end
+    end
+    ActiveSupport.on_load(:action_view) do
+      include Courrier::Email::Address
+    end
+    ActiveSupport.on_load(:action_controller) do
+      include Courrier::Email::Address
+    end
+    ActiveSupport.on_load(:active_job) do
+      include Courrier::Email::Address
+    end
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), "tasks", "courrier.rake")
+    end
+    module ClassMethods
+      def deliver_later(**options)
+        job = Courrier::Email::DeliveryJob
+        job = job.set(**queue_options) if queue_options.any?
+        job.perform_later(name, **options)
+      end
+    end
+    module InheritedHook
+      def inherited(subclass)
+        super
+        if Rails.respond_to?(:application) && Rails.application
+          subclass.include Rails.application.routes.url_helpers
+        end
+      end
+    end
+    Courrier::Email.extend ClassMethods
+    Courrier::Email.singleton_class.prepend InheritedHook
+  end
+end

data/lib/courrier/tasks/courrier.rake ADDED Viewed

@@ -0,0 +1,13 @@
+namespace :tmp do
+  task :courrier do
+    rm_rf Dir["#{Courrier.configuration.inbox.destination}/[^.]*"], verbose: false
+  end
+  task clear: :courrier
+end
+namespace :courrier do
+  desc "Clear email files from `#{Courrier.configuration.inbox.destination}`"
+  task clear: "tmp:courrier"
+end

data/lib/generators/courrier/email_generator.rb ADDED Viewed

@@ -0,0 +1,42 @@
+module Courrier
+  class EmailGenerator < Rails::Generators::NamedBase
+    AVAILABLE_TEMPLATES = %w[welcome password_reset]
+    desc "Create a new Courrier Email class"
+    source_root File.expand_path("templates", __dir__)
+    check_class_collision suffix: "Email"
+    class_option :skip_suffix, type: :boolean, default: false
+    class_option :template, type: :string, desc: "Template type (#{AVAILABLE_TEMPLATES.join(", ")})"
+    def copy_mailer_file
+      template template_file, destination_path
+    end
+    private
+    def file_name = super.delete_suffix("_email")
+    def parent_class = defined?(ApplicationEmail) ? ApplicationEmail : Courrier::Email
+    def template_file
+      if options[:template] && template_exists?("email/#{options[:template]}.rb.tt")
+        "email/#{options[:template]}.rb.tt"
+      else
+        "email.rb.tt"
+      end
+    end
+    def destination_path
+      File.join(Courrier.configuration.email_path, class_path, "#{file_name}#{"_email" unless options[:skip_suffix]}.rb")
+    end
+    def template_exists?(path)
+      find_in_source_paths(path)
+    rescue
+      nil
+    end
+  end
+end

data/lib/generators/courrier/install_generator.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module Courrier
+  class InstallGenerator < Rails::Generators::Base
+    desc "Creates the initializer for Courrier"
+    source_root File.expand_path("templates", __dir__)
+    def copy_initializer_file
+      template "initializer.rb", "config/initializers/courrier.rb"
+    end
+  end
+end

data/lib/generators/courrier/templates/email/password_reset.rb.tt ADDED Viewed

@@ -0,0 +1,29 @@
+# Usage:
+#
+# PasswordResetEmail.deliver to: user.email, reset_url: edit_password_url(user.password_reset_token)
+#
+class <%= class_name %><%= options[:skip_suffix] ? "" : "Email" %> < <%= parent_class %>
+  def subject = "Reset your password"
+  def text
+    <<~TEXT
+      You can reset your password within the next 15 minutes on this password reset page:
+      #{reset_url}
+      If you didn't request a password reset, please ignore this email.
+    TEXT
+  end
+  def html
+    <<~HTML
+      <p>
+        You can reset your password within the next 15 minutes on
+        <a href="#{reset_url}">this password reset page</a>.
+      </p>
+      <p>
+        If you didn't request a password reset, please ignore this email.
+      </p>
+    HTML
+  end
+end

data/lib/generators/courrier/templates/email/welcome.rb.tt ADDED Viewed

@@ -0,0 +1,43 @@
+# Usage:
+#
+# WelcomeEmail.deliver to: user.email, name: "John", login_url: "https://example.com/login"
+#
+class <%= class_name %><%= options[:skip_suffix] ? "" : "Email" %> < <%= parent_class %>
+  def subject = "Welcome to My First App, #{name}!"
+  def text
+    <<~TEXT
+      Welcome, #{name}!
+      We're excited to have you on board. Here's how to get started:
+      1. Log in to your account: #{login_url}
+      2. Complete your profile
+      3. Explore our features
+      If you have any questions, our help center is available to assist you.
+      Thanks for joining us!
+    TEXT
+  end
+  def html
+    <<~HTML
+      <p>Welcome, #{name}!</p>
+      <p>We're excited to have you on board. Here's how to get started:</p>
+      <ol>
+        <li><a href="#{login_url}">Log in to your account</a></li>
+        <li>Complete your profile</li>
+        <li>Explore our features</li>
+      </ol>
+      <p>If you have any questions, our help center is available to assist you.</p>
+      <p>
+        Thanks for joining us!
+      </p>
+    HTML
+  end
+end

data/lib/generators/courrier/templates/email.rb.tt ADDED Viewed

@@ -0,0 +1,19 @@
+class <%= class_name %><%= options[:skip_suffix] ? "" : "Email" %> < <%= parent_class %>
+  def subject = ""
+  def text
+    <<~TEXT
+    TEXT
+  end
+  def html
+    <<~HTML
+    HTML
+  end
+  # def markdown
+  #   # Requires: redcarpet, kramdown or commonmarker gem
+  #   <<~MARKDOWN
+  #   MARKDOWN
+  # end
+end

data/lib/generators/courrier/templates/initializer.rb.tt ADDED Viewed

@@ -0,0 +1,44 @@
+Courrier.configure do |config|
+  include Courrier::Email::Address
+  # Set your email delivery provider
+  # config.email = {
+  #   provider: "", # default, `logger`, choose from: <%= Courrier::Email::Provider::PROVIDERS.keys.join(", ") %>
+  #   api_key: "" your transactional email provider's API key
+  # }
+  # Configure provider-specific settings
+  # config.providers.loops.transactional_id = ""
+  # config.providers.mailgun.domain = ""
+  # Set default sender details
+  config.from = email_with_name("support@example.com", "Example Support") # => `Example Support <support@example.com>`
+  # config.reply_to = ""
+  # config.cc = ""
+  # config.bcc = ""
+  # Set host for Rails URL helpers, e.g. `{host: "https://railsdesigner.com/"}`
+  # config.default_url_options = {}
+  # Generate text version from HTML content
+  # Default: `false`
+  # config.auto_generate_text = false
+  # Location for generated Courrier Emails
+  # Default: `app/emails`
+  # config.email_path = ""
+  # Select logger for the `logger` provider
+  # Default: `::Logger.new($stdout)` - Ruby's built-in Logger
+  # config.logger = ""
+  # Set your marketing email provider
+  # config.subscriber = {
+  #   provider: ""
+  # }
+end

data/lib/rails_courrier/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module RailsCourrier
+  VERSION = "0.5.0"
+end

data/lib/rails_courrier.rb ADDED Viewed

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require "active_support"
+require "active_job"
+require "action_view"
+require "action_pack"
+require "action_dispatch"
+require "rails/railtie"
+require "rails/engine"
+require "launchy"
+require "courrier"
+require "courrier/engine"
+require "courrier/railtie"
+require "courrier/email/delivery_job"
+require "courrier/email/providers/inbox"
+require "courrier/configuration/inbox"
+Courrier::Email::Provider::PROVIDERS[:inbox] = Courrier::Email::Providers::Inbox
+module RailsCourrier
+end

data/rails_courrier.gemspec ADDED Viewed

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require_relative "lib/rails_courrier/version"
+Gem::Specification.new do |spec|
+  spec.name = "rails_courrier"
+  spec.version = RailsCourrier::VERSION
+  spec.authors = ["Rails Designer"]
+  spec.email = ["devs@railsdesigner.com"]
+  spec.summary = "Rails integration for Courrier email delivery"
+  spec.description = "Rails engine, generators, ActiveJob support, inbox previews and rake tasks for Courrier."
+  spec.homepage = "https://railsdesigner.com/open-source/rails_courrier/"
+  spec.license = "MIT"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Rails-Designer/rails_courrier/"
+  spec.files = Dir["{bin,app,config,lib}/**/*", "Rakefile", "README.md", "rails_courrier.gemspec", "Gemfile", "Gemfile.lock"]
+  spec.required_ruby_version = ">= 4.0.0"
+  spec.add_dependency "courrier", "~> 0.11.0"
+  spec.add_dependency "launchy", ">= 3.1", "< 4"
+  spec.add_dependency "railties", ">= 7.0"
+  spec.add_dependency "actionpack", ">= 7.0"
+  spec.add_dependency "activejob", ">= 7.0"
+  spec.add_dependency "actionview", ">= 7.0"
+end