idlemailer 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad91007cd0d5f336f443b3107e150dc865e52cd7048642a388e9d3b476fd180c
-  data.tar.gz: 822bbb3f19ffb0878d568574672fca4a6ad531c9b73f51935ce1ecae9ff77a7d
+  metadata.gz: 288e28b5d6f7ac40873806faa8bf56b8e66143a96819be6025238bcbc5fbc239
+  data.tar.gz: 76389af5d9027c264ae2cd2ae0f014a184a3bff41204a001d0a9061ef83e223f
 SHA512:
-  metadata.gz: dc64bf86b25a4fc15d99d9d3a38b99c48a759816ed73e90182169236de159e003a2e44b473c09d079ad4f06eb0ba5fcf2b3c980c3cb7630585a3c7139c7a2f14
-  data.tar.gz: 2291ccedc03e3d310c59eda8e98d153560221ef22d71e47898942e7b9d3adef053c5a235a41f3a58eb26ef2b0fbcc01b4665f2df2887b111db3b2a807c2fd4b1
+  metadata.gz: 294f547d16812a33f260ac1dfd10602de80e62cda27c8bf6d4401745c2b8e75c74fd840103f2bb04552df1bc4da4da6878de8a4bd40ad213301171ba6649c8aa
+  data.tar.gz: f86dfb20178f2dbc43826b6ffb1e879009eed952be403be29f41873c2d19d7aa431e2e00b90ae6d1a8ebc58bd2d92a1637c054be7d4fe6f323fdb0443c47a480

data/README.md

@@ -1,12 +1,14 @@
 # IdleMailer
 
-A lightweight (~150 line) alternative to ActionMailer for Rubyists who are too cool for Rails. Powered by the [mail](http://www.rubydoc.info/gems/mail) gem. Great for API-only backends that need to send email.
+A lightweight (~200 line) alternative to ActionMailer for Rubyists who are too cool for Rails. Powered by the [mail](http://www.rubydoc.info/gems/mail) gem. Great for API-only backends that need to send email.
 
 ## Installation
 
 Add to your Gemfile.
 
-    gem 'idlemailer'
+```ruby
+gem 'idlemailer'
+```
 
 ## Use
 
@@ -27,12 +29,20 @@ class WidgetMailer
 end
 
 # Create widget.html.erb and/or widget.text.erb in your templates directory.
-# They'll have access to instance variables like @widget above.
+# They'll have access to instance variables like @widget above, as well as any methods you define.
 
 # Send your mail
 WidgetMailer.new(current_user, widget).deliver
 ```
 
+### HTML escaping
+
+All values will be automatically HTML-escaped. If you need to bypass escapeing, use the `raw` helper:
+
+```ruby
+<%= raw @something_with_safe_html %>
+```
+
 ### Inline templates
 
 If you prefer, you can embed your ERB templates right inside your Ruby class, instead of making separate template files. Slick amiright?

data/lib/idlemailer/html_safe_string.rb

@@ -0,0 +1,16 @@
+module IdleMailer
+  class HtmlSafeString < String
+    def <<(str)
+      safe_str = str.is_a?(HtmlSafeString) ? str : ERB::Util.html_escape(str.to_s)
+      super safe_str
+    end
+
+    def safe_concat(val)
+      self << HtmlSafeString.new(val)
+    end
+
+    def to_s
+      self
+    end
+  end
+end

data/lib/idlemailer/template_manager.rb

@@ -3,6 +3,7 @@ module IdleMailer
   module TemplateManager
     def self.extended(klass)
       klass.class_eval do
+        include Templates::Helpers
         class << self
           attr_reader :layouts, :templates
         end
@@ -12,19 +13,19 @@ module IdleMailer
     end
 
     def text(str)
-      templates['text'] = ERB.new str.chomp
+      templates['text'] = Templates.compile str.chomp
     end
 
     def html(str)
-      templates['html'] = ERB.new str.chomp
+      templates['html'] = Templates.compile str.chomp
     end
 
     def template(type)
-      templates[type] || ERB.new(template_path(template_name, type).read.chomp)
+      templates[type] || Templates.compile(template_path(template_name, type).read.chomp)
     end
 
     def layout(type)
-      layouts[type] || ERB.new(template_path(layout_name, type).read.chomp)
+      layouts[type] || Templates.compile(template_path(layout_name, type).read.chomp)
     end
 
     def layout=(new_name)

data/lib/idlemailer/templates.rb

@@ -0,0 +1,27 @@
+module IdleMailer
+  module Templates
+    def self.compile(src)
+      compiler = ERB::Compiler.new("<>")
+      compiler.pre_cmd = ["_erbout=+HtmlSafeString.new"]
+      compiler.put_cmd = "_erbout.safe_concat"
+      compiler.insert_cmd = "_erbout.<<"
+      compiler.post_cmd = ["_erbout"]
+      code, _enc = compiler.compile(src)
+      Template.new code.freeze
+    end
+
+    Template = Struct.new(:code) do
+      def result(bind)
+        _erbout = HtmlSafeString.new
+        eval code, bind
+      end
+    end
+
+    module Helpers
+      # Don't HTML-escape the given value
+      def raw(str)
+        HtmlSafeString.new(str)
+      end
+    end
+  end
+end

data/lib/idlemailer/version.rb

@@ -1,5 +1,5 @@
 # IdleMailer module
 module IdleMailer
   # Version number
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/lib/idlemailer.rb

@@ -7,6 +7,8 @@ require 'idlemailer/defaults'
 require 'idlemailer/message'
 require 'idlemailer/mailer'
 require 'idlemailer/template_manager'
+require 'idlemailer/templates'
+require 'idlemailer/html_safe_string'
 require 'idlemailer/version'
 
 module IdleMailer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idlemailer
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -36,9 +36,11 @@ files:
 - lib/idlemailer.rb
 - lib/idlemailer/config.rb
 - lib/idlemailer/defaults.rb
+- lib/idlemailer/html_safe_string.rb
 - lib/idlemailer/mailer.rb
 - lib/idlemailer/message.rb
 - lib/idlemailer/template_manager.rb
+- lib/idlemailer/templates.rb
 - lib/idlemailer/testing.rb
 - lib/idlemailer/version.rb
 homepage: https://github.com/jhollinger/idlemailer
@@ -59,8 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A lightweight alternative to ActionMailer