email_templator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 833f300e05c8f85170c52c44b08374e95cbaf8ed
+  data.tar.gz: 0498995a7808a044da9656b337f95cb25b041f31
+SHA512:
+  metadata.gz: 70c9f08231f09140b7772327c70f11b7ca1c0d96a670a7dd217ed598f053fdeaabde93accd2d2727c2c1dceef4889aa2c828aaf4995ced0c2416e13f68a620dd
+  data.tar.gz: ff2097a92343ac9d222745280f45fe6bc7230dd28008983161861415c2f283eb718cbb84cb4249d6c3c9d49a89f60f73d32788f3c9238670fc948bfb11c66ce5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+notifications:
+  email:
+    on_success: always
+    on_failure: always

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in email_templator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bucky Box Limited
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# EmailTemplator
+
+Sanitize and parse an user-generated email template for sending.
+
+## Usage
+
+```ruby
+# 1. Define an email template class which can be personalized for a given resource (e.g. a customer)
+class CustomerEmailTemplate < EmailTemplator
+
+  # white-list mapping of keywords to be replaced
+  KEYWORDS = {
+    first_name:            :first_name,
+    account_balance:       :account_balance_with_currency,
+    email_address:         :email,
+  }
+
+end
+
+# 2. Create the template
+template = CustomerEmailTemplate.new "Hi {first_name}", <<-BODY
+Hey {first_name}!
+
+Here's your email: {email_address}
+BODY
+
+template.valid? #=> true
+
+# 3. Create a personalized email from the template
+customer = OpenStruct.new(first_name: "Joe", email: "joe@example.net") # typically a model
+personalized_email = template.personalize(customer)
+personalized_email.subject #=> "Hi Joe"
+personalized_email.body #=> "Hey Joe!\n\nHere's your email: joe@example.net\n"
+
+# 4. Send emails!
+```
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = "-w"
+end
+
+task :default => :spec

data/email_templator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_templator"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Cédric Félizard"]
+  spec.email         = ["cedric@felizard.fr"]
+  spec.summary       = %q{Sanitize and parse an user-generated email template for sending.}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end

data/lib/email_templator.rb

@@ -0,0 +1,90 @@
+# An email template which can be personalized for a given resource
+class EmailTemplator
+
+  # white-list of special keywords to be replaced
+  KEYWORDS = {}
+
+  # 2-array with left and right keyword delimiters
+  DELIMITERS = %w({ })
+
+  ATTRIBUTES = [:subject, :body]
+
+  attr_reader(*ATTRIBUTES)
+  attr_reader :errors
+
+  def initialize(subject, body)
+    @subject, @body = subject, body
+
+    @errors = []
+  end
+
+  def valid?
+    ATTRIBUTES.each do |attribute|
+      value = public_send(attribute)
+      if value.nil? || value.empty?
+        @errors << "#{attribute.to_s.capitalize} can't be blank"
+      end
+    end
+
+    unless unknown_keywords.empty?
+      @errors << "Unknown keywords found: #{unknown_keywords.join(', ')}"
+    end
+
+    @errors.empty?
+  end
+
+  def personalize resource
+    raise ArgumentError, @errors unless valid?
+
+    resource = pre_personalize_hook resource
+
+    replace_map = self.class::KEYWORDS.inject({}) do |hash, (keyword,method)|
+      replace = resource.public_send(method)
+      hash.merge!(keyword => replace.to_s)
+    end.freeze
+
+    personalized = {}
+
+    ATTRIBUTES.each do |attribute|
+      attribute_value = public_send(attribute).dup
+
+      replace_map.each do |key, value|
+        attribute_value.gsub!(self.class.keyword_with_delimiters(key), value)
+      end
+
+      personalized[attribute] = attribute_value
+    end
+
+    self.class.new(personalized[:subject], personalized[:body]).freeze
+  end
+
+  def pre_personalize_hook resource
+    resource
+  end
+
+  def unknown_keywords
+    regexp = /#{Regexp.escape(self.class::DELIMITERS.first)}(.*?)#{Regexp.escape(self.class::DELIMITERS.last)}/
+
+    present_keywords = ATTRIBUTES.map do |attribute|
+      public_send(attribute).to_s.scan(regexp).map(&:first)
+    end.flatten
+
+    present_keywords - self.class.keywords
+  end
+
+  def self.keywords_with_delimiters
+    keywords.map do |keyword|
+      keyword_with_delimiters keyword
+    end
+  end
+
+private
+
+  def self.keyword_with_delimiters keyword
+    "#{self::DELIMITERS.first}#{keyword}#{self::DELIMITERS.last}"
+  end
+
+  def self.keywords
+    self::KEYWORDS.keys.map(&:to_s).sort
+  end
+end

data/spec/email_templator_spec.rb

@@ -0,0 +1,84 @@
+require "simplecov"
+SimpleCov.start
+SimpleCov.minimum_coverage 100
+
+require "email_templator"
+
+class EmailTemplatorTest < EmailTemplator
+  KEYWORDS = {
+    first_name: :name,
+    email: :email,
+  }
+end
+
+class EmailTemplatorTestWithCustomDelimiters < EmailTemplatorTest
+  DELIMITERS = %w(# #)
+end
+
+describe EmailTemplatorTest do
+  subject { EmailTemplatorTest }
+
+  describe "#valid?" do
+    it "validates presence of required attributes" do
+      template = subject.new "", ""
+
+      template.should_not be_valid
+      template.errors.join.should include "Subject", "Body", "blank"
+    end
+
+    it "validates absence of unknown attributes" do
+      template = subject.new "Hey", "{nope}"
+
+      template.should_not be_valid
+      expect(template.errors).to eq ["Unknown keywords found: nope"]
+    end
+  end
+
+  describe "#unknown_keywords" do
+    it "returns unknown keywords" do
+      template = subject.new "Hey {you}", <<-BODY
+        Hi {first_name},
+
+        Your are {age} years old!
+      BODY
+
+      template.unknown_keywords.should eq %w(you age)
+    end
+  end
+
+  describe "#personalize" do
+    it "replaces keywords" do
+      customer = double(:customer,
+        name: "Joe",
+        email: "joe@example.net",
+      )
+
+      template = subject.new "Hi {first_name}", <<-BODY
+        Hey {first_name}!
+
+        Here's your email: {email}
+      BODY
+
+      personalized_email = template.personalize(customer)
+      personalized_email.subject.should eq "Hi Joe"
+      personalized_email.body.should eq <<-BODY
+        Hey Joe!
+
+        Here's your email: joe@example.net
+      BODY
+    end
+  end
+
+  describe ".keywords_with_delimiters" do
+    it "returns a list of keywords for use in views" do
+      expect(subject.keywords_with_delimiters).to eq %w({email} {first_name})
+    end
+  end
+end
+
+describe EmailTemplatorTestWithCustomDelimiters do
+  subject { EmailTemplatorTestWithCustomDelimiters }
+
+  specify { expect(subject.keywords_with_delimiters).to eq %w(#email# #first_name#) }
+end
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: email_templator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cédric Félizard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sanitize and parse an user-generated email template for sending.
+email:
+- cedric@felizard.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- email_templator.gemspec
+- lib/email_templator.rb
+- spec/email_templator_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sanitize and parse an user-generated email template for sending.
+test_files:
+- spec/email_templator_spec.rb