idlemailer 1.0.0 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 347bc7e19b8427031ed9246730a710ca7ad8893f
-  data.tar.gz: 4e44c6a7525787ab0576655f863fa31b5d1359ff
+  metadata.gz: 026e7c3207e3a4d68ad8788514da4df57fb38c7c
+  data.tar.gz: 1ba8967dd1cea7dbb1615083c542dc75371220c5
 SHA512:
-  metadata.gz: 707144b2594688f8b838dc2eb3aa35f553c2f9bc188a0be8f6f812ccc7e801005a1068691ca8cf54d699564037e4a5fe0bb0f8e4c491425915dedc3e2ae8ef28
-  data.tar.gz: a349486802b1245cf60dd885b85dfbbb74ea266ee077a0ff0f1b366d864fb2004fd7718ecac63d674ce2bf667d8c2f64dced20935c78aae4f9371fd8a1f931e2
+  metadata.gz: 33eabc8cf62e1a2854b56d330150b2e7f5525ea04640e03455eecc256140af4dfa999f30b714e171875db1a2fc2bc7c350da0869445b455389e4e118817356d6
+  data.tar.gz: '0294ef2f3f64dce15c02c787f0b1fb0234ca7c902c85a1f5162d4236c2ccf59f1dca1bdce1c96f7b2900c610d04bc4f9d33e2513221c066f33ddf164bdf1b15e'

data/README.md

@@ -1,6 +1,6 @@
 # IdleMailer
 
-A lightweight (~100 line) alternative to ActionMailer for hipsters who use Ruby but not Rails. Powered by [mail](http://www.rubydoc.info/gems/mail). Great for API-only backends that need to send email.
+A lightweight (~150 line) alternative to ActionMailer for hipsters who use Ruby but not Rails. Powered by [mail](http://www.rubydoc.info/gems/mail). Great for API-only backends that need to send email.
 
 ## Installation
 
@@ -31,6 +31,34 @@ mailer = WidgetMailer.new(current_user, widget)
 mailer.deliver
 ```
 
+### Inline templates
+
+Instead of creating template files, you can embed your ERB templates right inside your Ruby class.
+
+```ruby
+class WidgetMailer
+  include IdleMailer::Mailer
+
+  def initialize(user, widget)
+    mail.to = user.email
+    mail.subject = "Widget #{widget.sku}"
+    @widget = widget
+  end
+
+  text %(
+A new widget called <%= @widget %> was just created!
+
+Thanks!
+  )
+
+  html %(
+<p>A new widget called <%= @widget %> was just created!</p>
+
+<p>Thanks!</p>
+  )
+end
+```
+
 ## Configure
 
 These are the default options. Salt to taste.
@@ -40,6 +68,9 @@ IdleMailer.config do |config|
   # Directory containing the mailer templates
   config.templates = Pathname.new(Dir.getwd).join('templates')
 
+  # Pre-cache all templates and layouts (instead of re-loading them on each delivery)
+  config.cache_templates = true
+
   # Name of the layout template. Here, the file(s) would be named
   # mailer_layout.html.erb and/or mailer_layout.text.erb.
   config.layout = 'mailer_layout'

data/lib/idlemailer/config.rb

@@ -7,7 +7,7 @@ module IdleMailer
   #   default_from Default "from" address if it's left blank
   #   logger a Logger object for logging email
   #   log_body if true, the entire message body will be logged (instead of just the headers) (default false)
-  Config = Struct.new(:templates, :layout, :delivery_method, :delivery_options, :default_from, :logger, :log_body)
+  Config = Struct.new(:templates, :layout, :cache_templates, :delivery_method, :delivery_options, :default_from, :logger, :log_body)
   @config = Config.new
 
   # Takes a block and hands it an IdleMailer::Config object

data/lib/idlemailer/defaults.rb

@@ -1,6 +1,7 @@
 IdleMailer.config do |config|
   config.templates = Pathname.new(Dir.getwd).join('templates')
   config.layout = 'mailer_layout'
+  config.cache_templates = true
   config.delivery_method = :smtp
   config.delivery_options = {
     user_name: ENV['MAIL_USER'],

data/lib/idlemailer/mailer.rb

@@ -18,6 +18,10 @@ module IdleMailer
   #  mailer.deliver
   #
   module Mailer
+    def self.included(klass)
+      klass.extend TemplateManager
+    end
+
     # Deliver mail
     def deliver
       mailer = IdleMailer::Message.new(mail, self)

data/lib/idlemailer/message.rb

@@ -13,17 +13,19 @@ module IdleMailer
 
     # Deliver mail
     def deliver!
-      if has_template? 'html'
+      if mailer.class.has_template? 'html'
         html_body = layout('html') { body('html') }
         mail.html_part do
           content_type 'text/html; charset=UTF-8'
           body html_body
         end
       end
-      if has_template? 'text'
+
+      if mailer.class.has_template? 'text'
         text_body = layout('text') { body('text') }
         mail.text_part { body text_body }
       end
+
       config = IdleMailer.config
       mail.from config.default_from if mail.from.nil?
       mail.delivery_method config.delivery_method, config.delivery_options
@@ -35,35 +37,15 @@ module IdleMailer
     private
 
     def body(type)
-      render template_path(template_name, type)
+      render mailer.class.template(type)
     end
 
     def layout(type)
-      has_layout?(type) ? render(template_path(IdleMailer.config.layout, type)) { yield } : yield
-    end
-
-    def render(path)
-      mailer.render(ERB.new(File.read(path))) { yield }
-    end
-
-    def has_template?(type)
-      File.exists? template_path(template_name, type)
-    end
-
-    def has_layout?(type)
-      File.exists? template_path(IdleMailer.config.layout, type)
-    end
-
-    def template_name
-      @name ||= mailer.class.name.
-        gsub(/::/, File::SEPARATOR).
-        sub(/Mailer$/, '').
-        gsub(/([a-z])([A-Z])/, "\\1_\\2").
-        downcase
+      mailer.class.has_layout?(type) ? render(mailer.class.layout(type)) { yield } : yield
     end
 
-    def template_path(name, type)
-      IdleMailer.config.templates.join("#{name}.#{type}.erb")
+    def render(template)
+      mailer.render(template) { yield }
     end
   end
 end

data/lib/idlemailer/template_manager.rb

@@ -0,0 +1,56 @@
+module IdleMailer
+  module TemplateManager
+    def self.extended(klass)
+      klass.class_eval do
+        class << self
+          attr_reader :layouts, :templates
+        end
+        @layouts, @templates = {}, {}
+      end
+      klass.cache_templates! if IdleMailer.config.cache_templates
+    end
+
+    def text(str)
+      templates['text'] = ERB.new str
+    end
+
+    def html(str)
+      templates['html'] = ERB.new str
+    end
+
+    def template(type)
+      templates[type] || ERB.new(template_path(template_name, type).read)
+    end
+
+    def layout(type)
+      layouts[type] || ERB.new(template_path(IdleMailer.config.layout, type).read)
+    end
+
+    def has_template?(type)
+      templates.has_key?(type) || template_path(template_name, type).exist?
+    end
+
+    def has_layout?(type)
+      layouts.has_key?(type) || template_path(IdleMailer.config.layout, type).exist?
+    end
+
+    def template_name
+      @name ||= self.name.
+        gsub(/::/, File::SEPARATOR).
+        sub(/Mailer$/, '').
+        gsub(/([a-z])([A-Z])/, "\\1_\\2").
+        downcase
+    end
+
+    def template_path(name, type)
+      IdleMailer.config.templates.join("#{name}.#{type}.erb")
+    end
+
+    def cache_templates!
+      layouts['text'] = layout 'text' if has_layout? 'text'
+      layouts['html'] = layout 'html' if has_layout? 'html'
+      templates['text'] = template 'text' if has_template? 'text'
+      templates['html'] = template 'html' if has_template? 'html'
+    end
+  end
+end

data/lib/idlemailer/version.rb

@@ -1,5 +1,5 @@
 # IdleMailer module
 module IdleMailer
   # Version number
-  VERSION = '1.0.0'
+  VERSION = '2.0.0.rc1'
 end

data/lib/idlemailer.rb

@@ -5,4 +5,5 @@ require 'idlemailer/config'
 require 'idlemailer/defaults'
 require 'idlemailer/message'
 require 'idlemailer/mailer'
+require 'idlemailer/template_manager'
 require 'idlemailer/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idlemailer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -38,6 +38,7 @@ files:
 - lib/idlemailer/defaults.rb
 - lib/idlemailer/mailer.rb
 - lib/idlemailer/message.rb
+- lib/idlemailer/template_manager.rb
 - lib/idlemailer/version.rb
 homepage: https://github.com/jhollinger/idlemailer
 licenses: []
@@ -53,14 +54,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A lightweight alternative to ActionMailer
 test_files: []
-has_rdoc: