courrier 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b3c205c8fe157cc0eb5b6addc937bed0b256207da068262dddd2a903f474dd9
-  data.tar.gz: eac8a569f680a755f18f496f3a6118f3f5dccba38ffb8a417ff7c012974df1f6
+  metadata.gz: 8a3d93b4337d15e066ffa7ed4626dd254231ee744940de07b7b76be8714afbde
+  data.tar.gz: d7ef7a3ed1a8600581b6bdf13f63072c49ad138ad52384e1c358dbcd8f8a45b2
 SHA512:
-  metadata.gz: af1f9d97366be5d819114f5d3f0510d01ad2297eca90f0a23217832c1fc9202acf8c99c9b77e9baf4aa2cb87b85ad630797853c9e85b6fe27da78cda70cf5989
-  data.tar.gz: df77f8fdeeba27658032a99a1435e750b4f336b5a0ef9ec51681c0d6e4df1c744d9c04fd9b147428480abee79c5f0b786ad8c10e8eb91b8bdd6b85b446f5abf1
+  metadata.gz: 32d2fba728012eb703ca67044484a2f0caf0177ee0f341b6973566a50136f6531dfc37edfe7347511b4de67291af0364f6f03ad4c22247f5bbd72ca306e13455
+  data.tar.gz: 5a3ea2ea5fb0637f025a3577d6e1004a66478e0929b96752b0fdea302af95f6c88af3bed801265dc14f6645a8014adb781cd1cc04ee1809bedf76ca892f4c4f0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    courrier (0.8.1)
+    courrier (0.9.0)
       launchy (>= 3.1, < 4)
       nokogiri (>= 1.18, < 2)
 

data/README.md

@@ -16,8 +16,9 @@ end
 
 OrderEmail.deliver to: "recipient@railsdesigner.com"
 
-# Manage newsletter subscriptions
+# Manage newsletter subscribers
 Courrier::Subscriber.create "subscriber@example.com"
+Courrier::Subscriber.destroy "subscriber@example.com"
 ```
 
 <a href="https://railsdesigner.com/" target="_blank">
@@ -255,6 +256,39 @@ end
 ```
 
 
+### Template files
+
+Instead of defining `text` and `html` methods, you can create ERB template files:
+```ruby
+class OrderEmail < Courrier::Email
+  def subject = "Your order is ready!"
+  # text and html content will be loaded from template files
+end
+```
+
+Create template files alongside your email class:
+- `app/emails/order_email.text.erb`
+- `app/emails/order_email.html.erb`
+
+Templates have access to all context options and instance variables:
+```erb
+<!-- app/emails/order_email.html.erb -->
+<h1>Hello <%= name %>!</h1>
+<p>Your order #<%= order_id %> is ready for pickup.</p>
+```
+
+Method definitions take precedence over template files when both exist. You can mix approaches. For example, define text in a method and use a template for the html:
+```ruby
+class OrderEmail < Courrier::Email
+  def subject = "Your order is ready!"
+
+  def text = "Hello #{name}! Your order ##{order_id} is ready."
+
+  # html will be loaded from app/emails/order_email.html.erb
+end
+```
+
+
 ### Auto-generate text from HTML
 
 Automatically generate plain text versions from your HTML emails:

data/lib/courrier/email/provider.rb

@@ -40,8 +40,8 @@ module Courrier
       end
 
       def deliver
-        raise Courrier::ConfigurationError, "`provider` and `api_key` must be configured for production environment" if configuration_missing_in_production?
-        raise Courrier::ConfigurationError, "Unknown provider. Choose one of `#{comma_separated_providers}` or provide your own." if @provider.nil? || @provider.to_s.strip.empty?
+        raise Courrier::ConfigurationError, "Unknown provider. Choose one of `#{comma_separated_providers}` or provide your own." if provider_invalid?
+        raise Courrier::ConfigurationError, "API key must be configured for #{@provider} provider in production environment" if configuration_missing_in_production?
 
         provider_class.new(
           api_key: @api_key,
@@ -53,8 +53,12 @@ module Courrier
 
       private
 
+      def provider_invalid?
+        @provider.nil? || @provider.to_s.strip.empty?
+      end
+
       def configuration_missing_in_production?
-        production? && required_attributes_blank?
+        production? && api_key_required_providers? && api_key_blank?
       end
 
       def comma_separated_providers = PROVIDERS.keys.join(", ")
@@ -65,7 +69,13 @@ module Courrier
         Object.const_get(@provider)
       end
 
-      def required_attributes_blank? = @api_key.empty?
+      def api_key_required_providers?
+        !%w[logger inbox].include?(@provider.to_s)
+      end
+
+      def api_key_blank?
+        @api_key.nil? || @api_key.to_s.strip.empty?
+      end
 
       def production?
         defined?(Rails) && Rails.env.production?

data/lib/courrier/email.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "erb"
+
 require "courrier/email/address"
 require "courrier/jobs/email_delivery_job" if defined?(Rails)
 require "courrier/email/layouts"
@@ -133,7 +135,25 @@ module Courrier
       ENV["COURRIER_EMAIL_DISABLED"] == "true" || ENV["COURRIER_EMAIL_ENABLED"] == "false"
     end
 
-    def method_missing(name, *) = @context_options[name]
+    def method_missing(name, *)
+      if name == :text || name == :html
+        render_template(name.to_s)
+      else
+        @context_options[name]
+      end
+    end
+
+    def render_template(format)
+      template_path = template_file_path(format)
+
+      File.exist?(template_path) ? ERB.new(File.read(template_path)).result(binding) : nil
+    end
+
+    def template_file_path(format)
+      class_path = self.class.name.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+
+      File.join(Courrier.configuration&.email_path, "#{class_path}.#{format}.erb")
+    end
 
     def respond_to_missing?(name, include_private = false) = true
   end

data/lib/courrier/version.rb

@@ -1,3 +1,3 @@
 module Courrier
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

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

@@ -3,13 +3,13 @@ Courrier.configure do |config|
 
   # 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
+  #   provider: "", # default, `logger`, choose from: <%= Courrier::Email::Provider::PROVIDERS.keys.join(", ") %>
+  #   api_key: "" your transactional email provider's API key
   # }
 
   # Set your marketing email provider
   # config.subscriber = {
-    # provider = ""
+  #   provider: ""
   # }
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: courrier
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Rails Designer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-09 00:00:00.000000000 Z
+date: 2026-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy