posten 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5507003d22cfa28e7cb3865873dfa9a2a78e605c
-  data.tar.gz: cf35fd60c024ef13458b75a9acc1ec831c136c5a
+  metadata.gz: 5e09e2ebeb4aa81ad15f50d02cb2b734a2dd493c
+  data.tar.gz: 44b8f2ff496751fbdd11e76f7b3d67c9196cb602
 SHA512:
-  metadata.gz: df08b2bdddb0971061ed214f587d8868af81edc94b85238f5b04283ee238e3224c7afc0cd0b3a86a72523a9659747559e8b408750ca17db137844ea334db55da
-  data.tar.gz: 93063845d9e06717188efa7493e7f1c8cf682012c791305b9eb7c6cd04688bc8c2665639bc972b2f8415b7eeb6b7e1baa2a40bdd1286aa21c820c9c7224e8822
+  metadata.gz: 0b83ca4a6a9b10de1478323ea7c4ea38f4e81988753c625545fbd658fdfe513583f04adbe02d8c6b2efd9ba60a6d5dc8ac3692fb93872b7422bad9694c106c33
+  data.tar.gz: eb541fd35b96c673d259b02601ddd390a8fa4f9c9acb5ed72c1c1fbd6106b8e81643cb1adf89e03cd491e07d1458742dc20c268d11e1aace435601ad1897ee7c

data/README.md

@@ -68,7 +68,7 @@ You can use inheritance to create mailer classes:
 
 ```ruby
 class UserMailer < Posten
-  defaults from: "admin@posten.gem"
+  defaults from: "team@posten.gem"
 
   def welcome_mail(user)
     deliver(
@@ -85,6 +85,65 @@ mailer.welcome_mail(User.first)
 
 Defaults are inherited but can be changed through the `defaults` method.
 
+Templates
+---------
+
+You can render templates using the `render` method. It uses the template
+engine [Mote][mote].
+
+```ruby
+class UserMailer < Posten
+  defaults from: "team@posten.gem"
+
+  def welcome_email(user)
+    deliver(
+      to: user.email,
+      subject: "Welcome #{ user.name }!",
+      text: render("welcome.txt", user: user),
+      html: render("welcome.html", user: user)
+    )
+  end
+end
+```
+
+By default, it assumes that all mail templates are placed in a folder named
+`mails` and that they use the `.mote` extension:
+
+```
+# mails/welcome.txt.mote
+Welcome {{ user.name }}!
+
+# mails/welcome.html.mote
+<b>Welcome {{ user.name }}!</b>
+```
+
+Check [Mote's GitHub repository][mote] for more information.
+
+Helpers
+-------
+
+Included helper modules are available inside the template through the `app`
+variable.
+
+```ruby
+module TextHelper
+  def titleize(str)
+    return str.gsub(/\w+/) { |x| x.capitalize }
+  end
+end
+
+class UserMailer < Posten
+  include TextHelper
+
+  defaults from: "team@posten.gem"
+
+  # ...
+end
+
+# mails/welcome.txt.mote
+welcome {{ app.titleize(user.name) }}!
+```
+
 Testing
 -------
 
@@ -92,8 +151,11 @@ If you don't want to call the actual delivery method in your tests, you
 can use `posten/test`:
 
 ```ruby
+require "posten"
 require "posten/test"
 
+Posten.connect({ ... })
+
 posten = Posten.new
 posten.deliver(to: "alice@posten.gem", subject: "hei")
 
@@ -180,3 +242,4 @@ $ gem install posten
 ```
 
 [cutest]: https://github.com/djanowski/cutest
+[mote]: https://github.com/soveran/mote

data/lib/posten/version.rb

@@ -1,3 +1,3 @@
 class Posten
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/posten.rb

@@ -1,8 +1,10 @@
 require "malone"
+require "mote"
 require "seteable"
 require_relative "posten/version"
 
 class Posten
+  include Mote::Helpers
   include Seteable
 
   def self.connect(options)
@@ -32,6 +34,15 @@ class Posten
   def defaults
     return settings[:defaults]
   end
+
+  def render(template, params = {})
+    return mote(view_path(template), params.merge(app: self), TOPLEVEL_BINDING)
+  end
+
+  private def view_path(template)
+    return File.join(settings[:views], "#{ template }.mote")
+  end
 end
 
 Posten.settings[:defaults] = {}
+Posten.settings[:views] = File.expand_path("mails", Dir.pwd)

data/makefile

@@ -1,5 +1,5 @@
 default:
-	cutest ./test/*.rb
+	cutest -r ./test/helper.rb ./test/*.rb
 
 smtp:
 	mt 2525

data/posten.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
 
   s.add_dependency "malone", "~> 1.1.0"
+  s.add_dependency "mote", "~> 1.1.4"
   s.add_dependency "seteable", "1.0.0"
   s.add_development_dependency "bundler", "~> 1.10"
   s.add_development_dependency "cutest", "~> 1.2"

data/test/defaults.rb

@@ -0,0 +1,15 @@
+test "defaults" do
+  Posten.defaults(from: "bob@posten.gem")
+
+  class EveMailer < Posten
+    defaults to: "eve@posten.gem"
+  end
+
+  params = { from: "bob@posten.gem" }
+
+  assert_equal params, Posten.settings[:defaults]
+
+  params = params.merge(to: "eve@posten.gem")
+
+  assert_equal params, EveMailer.settings[:defaults]
+end

data/test/deliver.rb

@@ -0,0 +1,37 @@
+require "malone/test"
+
+setup do
+  Malone.deliveries.clear
+
+  Posten.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587")
+end
+
+test "deliver use defaults" do
+  defaults = { from: "bob@posten.gem", to: "eve@posten.gem" }
+
+  Posten.defaults(defaults)
+
+  params = {
+    subject: "subject",
+    text: "text",
+    html: "<html></html>"
+  }
+
+  Posten.new.deliver(params)
+
+  options = Malone.deliveries.last.to_h
+
+  assert_equal options, defaults.merge(params)
+
+  class Mailer < Posten
+    defaults to: "alice@posten.gem"
+  end
+
+  Mailer.new.deliver(params)
+
+  defaults = defaults.merge(to: "alice@posten.gem")
+
+  options = Malone.deliveries.last.to_h
+
+  assert_equal options, defaults.merge(params)
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require "bundler/setup"
+require "cutest"
+require_relative "../lib/posten"

data/test/mails/mail.mote

@@ -0,0 +1 @@
+{{ message }}

data/test/render.rb

@@ -0,0 +1,12 @@
+Posten.settings[:views] = File.expand_path("mails", __dir__)
+
+setup do
+  Posten.connect({})
+  Posten.new
+end
+
+test "render" do |posten|
+  content = posten.render("mail", message: "posten")
+
+  assert_equal "posten", content.strip
+end

data/test/sandbox.rb

@@ -0,0 +1,21 @@
+require_relative "../lib/posten/test"
+
+test "sandbox" do
+  Posten.connect({})
+
+  defaults = { from: "bob@posten.gem", to: "eve@posten.gem" }
+
+  Posten.defaults(defaults)
+
+  params = {
+    subject: "subject",
+    text: "text",
+    html: "<html></html>"
+  }
+
+  Posten.new.deliver(params)
+
+  mail = Posten.deliveries.first
+
+  assert_equal defaults.merge(params), mail.to_h
+end

data/test/settings.rb

@@ -0,0 +1,20 @@
+test "raise if not smtp settings" do
+  Posten.settings.delete(:smtp)
+
+  assert_raise do
+    Posten.new
+  end
+end
+
+test "settings" do
+  Posten.settings[:foo] = "foo"
+
+  Notifier = Class.new(Posten)
+
+  assert_equal "foo", Notifier.settings[:foo]
+
+  Notifier.settings[:foo] = "bar"
+
+  assert_equal "foo", Posten.settings[:foo]
+  assert_equal "bar", Notifier.settings[:foo]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: posten
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Francesco Rodríguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: malone
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: mote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
 - !ruby/object:Gem::Dependency
   name: seteable
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,13 @@ files:
 - lib/posten/version.rb
 - makefile
 - posten.gemspec
-- test/posten_test.rb
+- test/defaults.rb
+- test/deliver.rb
+- test/helper.rb
+- test/mails/mail.mote
+- test/render.rb
+- test/sandbox.rb
+- test/settings.rb
 homepage: https://github.com/harmoni/posten
 licenses:
 - MIT

data/test/posten_test.rb

@@ -1,98 +0,0 @@
-require "bundler/setup"
-require "cutest"
-require_relative "../lib/posten"
-
-require "malone/test"
-
-setup do
-  Malone.deliveries.clear
-
-  Posten.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587")
-end
-
-test "raise if not smtp settings" do
-  Posten.settings.delete(:smtp)
-
-  assert_raise do
-    Posten.new
-  end
-end
-
-test "settings" do
-  Posten.settings[:foo] = "foo"
-
-  Notifier = Class.new(Posten)
-
-  assert_equal "foo", Notifier.settings[:foo]
-
-  Notifier.settings[:foo] = "bar"
-
-  assert_equal "foo", Posten.settings[:foo]
-  assert_equal "bar", Notifier.settings[:foo]
-end
-
-test "defaults" do
-  Posten.defaults(from: "bob@posten.gem")
-
-  class EveMailer < Posten
-    defaults to: "eve@posten.gem"
-  end
-
-  params = { from: "bob@posten.gem" }
-
-  assert_equal params, Posten.settings[:defaults]
-
-  params = params.merge(to: "eve@posten.gem")
-
-  assert_equal params, EveMailer.settings[:defaults]
-end
-
-test "deliver use defaults" do
-  defaults = { from: "bob@posten.gem", to: "eve@posten.gem" }
-
-  Posten.defaults(defaults)
-
-  params = {
-    subject: "subject",
-    text: "text",
-    html: "<html></html>"
-  }
-
-  Posten.new.deliver(params)
-
-  options = Malone.deliveries.last.to_h
-
-  assert_equal options, defaults.merge(params)
-
-  class Mailer < Posten
-    defaults to: "alice@posten.gem"
-  end
-
-  Mailer.new.deliver(params)
-
-  defaults = defaults.merge(to: "alice@posten.gem")
-
-  options = Malone.deliveries.last.to_h
-
-  assert_equal options, defaults.merge(params)
-end
-
-test "testing" do
-  require_relative "../lib/posten/test"
-
-  defaults = { from: "bob@posten.gem", to: "eve@posten.gem" }
-
-  Posten.defaults(defaults)
-
-  params = {
-    subject: "subject",
-    text: "text",
-    html: "<html></html>"
-  }
-
-  Posten.new.deliver(params)
-
-  mail = Posten.deliveries.first
-
-  assert_equal defaults.merge(params), mail.to_h
-end