email_template 0.6.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jenua Boiko
+
+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,120 @@
+# EmailTemplate
+
+Allows your users to edit e-mail templates.
+With Devise and Active Admin support (but you don't need them to start using email_template).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'email_template'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or just:
+
+```sh
+$ gem install email_template
+```
+
+## Usage
+
+Run installer:
+
+```sh
+$ rails g email_template:install
+```
+    
+In order to use Devise templates you need to install devise wrapper:
+    
+```sh
+$ rails g email_template:devise_install
+```
+        
+Then generate common devise templates for a specified scope: 
+   
+```sh
+$ rails g email_template:devise_templates <devise_scope>
+```
+    
+This generator produces email templates with the names:
+
+```ruby
+<devise_scope>_mailer:confirmation_instructions
+<devise_scope>_mailer:reset_password_instructions
+<devise_scope>_mailer:unlock_instructions
+```
+
+Run:
+
+```sh
+$ rake db:migrate
+```
+
+You can configure email_template at
+
+    config/initializers/email_template.rb
+
+Pull template to the base :
+
+```ruby
+MailTemplate.create(name: "activity_partner_mailer:join_confirmation_self",
+                    subject: "Join request confirmation",
+                    classes: ["activity_partner"],
+                    body:
+                        <<-TEXT
+                          Dear \#{activity_partner.full_name} ...
+                          ....
+                        TEXT
+)
+```
+
+In Mailer:
+
+```ruby
+class ActivityPartnerMailer < TemplateSendMailer
+  def join_confirmation_self(activity_partner)
+    #send_mail(template_name, mail_params = {}, template_params = {})
+    send_mail("#{self.class.name.tableize.singularize}:#{__method__}", {to: "user@example.com"}, {activity_partner_join: activity_partner})
+  end
+end
+```
+
+## Customization
+
+In case you need additional customization :
+
+In Mailer:
+
+```ruby   
+class CustomDeviseMailer < Devise::Mailer
+  include Devise::Mailers::Helpers
+  include EmailTemplate::Mailers::Helpers
+    
+  def confirmation_instructions(record, opts={})
+    @template = check_template("#{record.class.name.tableize.singularize}_mailer:#{__method__}")
+    devise_mail(record, :confirmation_instructions, opts.merge(subject: @template.subject))
+  end
+end    
+```
+
+In View:
+
+```ruby
+= raw(@template.as_html(:parent => @resource).gsub(/\#\{confirm_link\}/,
+link_to('Confirm my account', confirmation_url(@resource, confirmation_token: @resource.confirmation_token))))
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/email_template.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/email-template/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jenua Boiko"]
+  gem.email         = ["jeyboy1985@gmail.com"]
+  gem.description   = %Q{Allows your users to edit e-mail templates}
+  gem.summary       = %Q{Allows your users to edit e-mail templates. With Devise and Active Admin support (but you don't need them to start using email_template).}
+  gem.homepage      = "https://github.com/jeyboy/email_template"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "email_template"
+  gem.require_paths = ["lib"]
+  gem.version       = EmailTemplate::VERSION
+  gem.rubygems_version = %q{1.8.6}
+
+  gem.add_dependency("rails", ">= 3.0.0")
+end
+

data/lib/email-template/version.rb

@@ -0,0 +1,3 @@
+module EmailTemplate
+  VERSION = "0.6.0"
+end

data/lib/email_template.rb

@@ -0,0 +1,20 @@
+require "email_template/j_models"
+require "email_template/j_mailers"
+require "email_template/j_helpers"
+
+include JModels
+include JMailers
+include EmailTemplate::Mailers::Helpers
+
+module EmailTemplate
+  mattr_accessor :columns_black_list
+  self.columns_black_list = []
+  mattr_accessor :attributes_black_list
+  self.attributes_black_list = []
+  mattr_accessor :methods_header
+  self.methods_header = "et_"
+
+  def self.setup
+    yield self
+  end
+end

data/lib/email_template/j_helpers.rb

@@ -0,0 +1,35 @@
+module EmailTemplate
+  module Mailers
+    module Helpers
+
+    protected
+      def check_template(template_name)
+        throw "#{template_name} not set" if (@template = MailTemplate.where(name: template_name).first).blank?
+        @template
+      end
+
+      def mailing(template, mail_params = {}, template_params = {})
+        mail_params.reverse_merge!(subject: template.subject)
+
+        if mail_params.has_key?(:template_path) && mail_params.has_key?(:template_name)
+          mail mail_params
+        else
+          mail mail_params do |format|
+            format.text { render :text => template.as_text(template_params) }
+            format.html { render :text => template.as_html(template_params) }
+          end
+        end
+      end
+
+      def obj_class_name(obj)
+        obj.class.name.tableize.singularize
+      end
+
+
+      #def subject_for(key)
+      #  I18n.t(:"#{devise_mapping.name}_subject", :scope => [:devise, :mailer, key],
+      #    :default => [:subject, key.to_s.humanize])
+      #end
+    end
+  end
+end

data/lib/email_template/j_mailers.rb

@@ -0,0 +1,7 @@
+module JMailers
+  class TemplateSendMailer < ActionMailer::Base
+    def send_mail(template_name, mail_params = {}, template_params = {})
+      mailing(check_template(template_name), mail_params, template_params)
+    end
+  end
+end

data/lib/email_template/j_models.rb

@@ -0,0 +1,112 @@
+module JModels
+  class MailTemplate < ActiveRecord::Base
+    include EmailTemplate
+    include ActionView::Helpers::SanitizeHelper
+
+    self.table_name = 'email_templates'
+
+    attr_accessor :prepared
+
+    attr_accessible :name, :body, :subject, :classes
+    serialize :classes, Array
+
+    validates :name, :uniqueness => true
+
+    def prepare(attrs={})
+      @prepared ||= lambda{ |attrs|
+        attrs.stringify_keys!
+        body.gsub(/\#{.*?}/) do |match|
+          elem, action = match[2..-2].split('.')
+          if (action)
+            attrs[elem].try(action.to_sym) rescue match.to_s
+          else
+            attrs[elem] || match.to_s
+          end
+        end
+      }.call(attrs)
+    end
+
+    def as_html(attrs={})
+      prepare(attrs)
+    end
+
+    def as_text(attrs={})
+      strip_tags(prepare(attrs))
+      #sanitize(prepare(attrs), :tags => %w(a), :attributes => %w(href))
+    end
+
+    def prepare_fields
+      possible_attrs = []
+      self.classes.each do |resource_class|
+        current_class = resource_class.downcase.match(/\w*/mix).to_a.first
+        if (current_class[0] == '_')
+          possible_attrs << obj(current_class.from(1))
+        else
+          const_obj = current_class.camelize.constantize
+          [:find_attributes, :find_columns, :find_methods].each do |method|
+            possible_attrs += self.send(method, current_class, const_obj)
+          end
+        end
+      end
+      possible_attrs.uniq
+    end
+
+    protected
+    def finder(classname, items, val, current_pattern)
+      items.each_with_object([]) do |attr, ret|
+        (ret << obj(classname, attr.send(val))) if ((attr.send(val) =~ /#{current_pattern}/).nil? || current_pattern.nil?)
+      end
+    end
+
+    def find_attributes(classname, object)
+      if object.respond_to?(:attributes)
+        finder(classname, object.attributes, :first, attr_pattern(classname))
+      end || []
+    end
+
+    def find_columns(classname, object)
+      if object.respond_to?(:columns)
+        finder(classname, object.columns, :name, column_pattern(classname))
+      end || []
+    end
+
+    def find_methods(classname, object)
+      object.public_instance_methods.each_with_object([]) do |m_alias, ret|
+        (ret << obj(classname, m_alias.to_s.from(methods_header.length))) if m_alias.to_s.start_with?(methods_header)
+      end
+    end
+
+    def find_devise_methods(object)
+      res = []
+      res << obj("confirmation_token")    if object.respond_to? :confirmation_token
+      res << obj("reset_password_token")  if object.respond_to? :reset_password_token
+      res << obj("unlock_token")          if object.respond_to? :unlock_token
+      res
+    end
+
+    private
+    def regex_from_list(list)
+      list.blank? ? nil : "(" + list.join(")|(") + ")"
+    end
+
+    def regex_from_hash(hash, object)
+      regex_from_list(hash[object] || hash['*'] || [])
+    end
+
+    def pattern(elems, object)
+      elems.is_a?(Array) ? regex_from_list(elems) : regex_from_hash(elems, object)
+    end
+
+    def column_pattern(object)
+      pattern(columns_black_list, object)
+    end
+
+    def attr_pattern(object)
+      pattern(attributes_black_list, object)
+    end
+
+    def obj(clas, name = nil)
+      "\#{#{[clas, name].compact.join('.')}}"
+    end
+  end
+end

data/lib/email_template/linkable/devise.rb

@@ -0,0 +1,36 @@
+module Linkable
+  module DeviseMailer
+    class DeviseTemplateSendMailer < Devise::Mailer
+      require "email_template/linkable/devise_helper"
+      include Linkable::DeviseMailerHelper
+      include ActionView::Helpers::UrlHelper
+      include Devise::Mailers::Helpers
+
+      def send_mail(record, action, template_name, mail_params = {}, template_params = {})
+        initialize_from_record(record)
+        opts = template_params[:*] || {}
+
+        template_params.reverse_merge!(
+          :confirm_link => link_to(opts[:confirm_name] || 'Confirm my account',
+            "#{link_head(record)}/confirmation?confirmation_token=#{@resource.confirmation_token}")
+        ) if @resource.respond_to? :confirmation_token
+
+        template_params.reverse_merge!(
+          :edit_password_link => link_to(opts[:change_name] || 'Change my password',
+            "#{link_head(record)}/password/edit?reset_password_token=#{@resource.reset_password_token}")
+        ) if @resource.respond_to? :reset_password_token
+
+        template_params.reverse_merge!(
+          :unlock_link => link_to(opts[:unlock_name] || 'Unlock my account',
+            "#{link_head(record)}/unlock?unlock_token => #{@resource.unlock_token}")
+        ) if @resource.respond_to? :unlock_token
+
+        mailing(
+            check_template(template_name),
+            headers_for(action, mail_params).except(:subject, :template_path, :template_name),
+            template_params.except(:*)
+        )
+      end
+    end
+  end
+end

data/lib/email_template/linkable/devise_helper.rb

@@ -0,0 +1,12 @@
+module Linkable
+  module DeviseMailerHelper
+    def link_head(record)
+      "#{ActionMailer::Base.default_url_options[:host]}/#{record.class.name.tableize.singularize}"
+    end
+
+    def sending(record, action, template_name, email_opts = {}, template_opts = {})
+      send_mail(record, action, template_name, email_opts,
+                template_opts.merge(obj_class_name(record).to_sym => record))
+    end
+  end
+end

data/lib/generators/active_record/migration.rb

@@ -0,0 +1,16 @@
+class AddMailsTemplate < ActiveRecord::Migration
+  def self.up
+    create_table :email_templates do |t|
+      t.string :name
+      t.string :subject
+      t.text :body
+      t.text :classes
+
+      t.datetime :created_at
+    end
+  end
+
+  def self.down
+    drop_table :mail_templates
+  end
+end

data/lib/generators/email_template/devise_install_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/email_template/install_helpers'
+
+module EmailTemplate
+  module Generators
+    class DeviseInstallGenerator < Rails::Generators::Base
+      include EmailTemplate::Generators::OrmHelpers
+
+      source_root File.expand_path("../../", __FILE__)
+
+      desc "Copy devise mail template"
+      def copy_initializer
+        STDOUT << "devise mailer"
+        template "templates/devise/custom_devise_mailer.rb", "app/mailers/custom_devise_mailer.rb"
+      end
+    end
+  end
+end

data/lib/generators/email_template/devise_templates_generator.rb

@@ -0,0 +1,53 @@
+module EmailTemplate
+  module Generators
+    class DeviseTemplatesGenerator < Rails::Generators::NamedBase
+      attr_reader :bodies
+
+      desc "Create devise basic templates for input scope"
+      def initialize(args, *options)
+        super
+        @bodies = {}
+        @bodies['confirmation_instructions'] = <<-STR
+                              <p>Welcome \#{#{name}.email}!</p>
+                              <p>You can confirm your account email through the link below:</p>
+                              <p>\#{confirm_link}</p>
+                            STR
+        @bodies['reset_password_instructions'] = <<-STR
+                              <p>Hello \#{#{name}.email}!</p>
+                              <p>Someone has requested a link to change your password. You can do this through the link below.</p>
+                              <p>\#{edit_password_link}</p>
+                              <p>If you didn't request this, please ignore this email.</p>
+                              <p>Your password won't change until you access the link above and create a new one.</p>
+                            STR
+        @bodies['unlock_instructions'] = <<-STR
+                              <p>Hello \#{#{name}.email}!</p>
+                              <p>Your account has been locked due to an excessive amount of unsuccessful sign in attempts.</p>
+                              <p>Click the link below to unlock your account:<\p>
+                              <p>\#{unlock_link}</p>
+                            STR
+
+        generate_templates
+      end
+
+      def generate_templates
+        if defined?(MailTemplate)
+          ['confirmation_instructions', 'reset_password_instructions', 'unlock_instructions'].each do |method_name|
+            template_name = "#{name}_mailer:#{method_name}"
+
+            if MailTemplate.where(:name => template_name).empty?
+              STDOUT << template_name << "\n"
+              MailTemplate.create do |new_template|
+                new_template.name = template_name
+                new_template.classes = []
+                new_template.subject = method_name.humanize
+                new_template.body = bodies[method_name]
+              end
+            end
+          end
+        else
+          STDOUT << "base model \"MailTemplate\" missed"
+        end
+      end
+    end
+  end
+end

data/lib/generators/email_template/install_generator.rb

@@ -0,0 +1,34 @@
+require 'generators/email_template/install_helpers'
+
+module EmailTemplate
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include EmailTemplate::Generators::OrmHelpers
+
+      source_root File.expand_path("../../", __FILE__)
+
+      desc "Creates initializer and migration. If ActiveAdmin install - copy admin page for templates"
+      class_option :orm
+
+      def copy_initializer
+        unless migration_exists?("add_mails_template")
+          STDOUT << "migration"
+          template "active_record/migration.rb", "db/migrate/#{Time.now.utc.strftime("%Y%m%d%H%M%S").to_i}_add_mails_template.rb"
+        end
+
+        STDOUT << "config"
+        template "templates/email_templates.rb", "config/initializers/email_template.rb"
+
+        if Gem::Specification::find_all_by_name('activeadmin').any?
+          STDOUT << "admin"
+          template "templates/active_admin/emails.rb", "app/admin/email_templates.rb"
+        end
+
+        if Gem::Specification::find_all_by_name('devise').any?
+          STDOUT << "devise mailer"
+          template "templates/devise/custom_devise_mailer.rb", "app/mailers/custom_devise_mailer.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/email_template/install_helpers.rb

@@ -0,0 +1,21 @@
+module EmailTemplate
+  module Generators
+    module OrmHelpers
+      def self.orm
+        Rails::Generators.options[:rails][:orm]
+      end
+
+      def self.orm_has_migration?
+        [:active_record].include? orm
+      end
+
+      def migration_exists?(name)
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_#{name}.rb$/).first
+      end
+
+      def migration_path
+        @migration_path ||= File.join("db", "migrate")
+      end
+    end
+  end
+end

data/lib/generators/templates/active_admin/emails.rb

@@ -0,0 +1,37 @@
+ActiveAdmin.register MailTemplate, :as => "Mail Template" do
+  config.sort_order = "name_asc"
+  #config.batch_actions = false #uncomment this if you need batches
+
+  filter :subject, as: :select, collection: proc { MailTemplate.all.map(&:subject) }
+
+  actions :all, :except => [:destroy, :new]
+
+  index as: :grid do |email_template|
+    a email_template.name.humanize, href: admin_mail_template_path(email_template)
+  end
+
+  show do |email_template|
+    attributes_table do
+      row :subject
+      row :body do
+        raw email_template.body
+      end
+    end
+  end
+
+  sidebar :email_objects, :only => :edit do
+    raw([
+        "You may use next constants :",
+        "<br/><br/>",
+        ("<div>#{resource.prepare_fields.join("</div><div>")}</div>")
+        ].join)
+  end
+
+  form do |f|
+    f.inputs do
+      f.input :subject
+      f.input :body, :as => :rich  #, :as => :rich  # You may use this flag if you have installed gem 'rich'
+    end
+    f.actions
+  end
+end

data/lib/generators/templates/devise/custom_devise_mailer.rb

@@ -0,0 +1,19 @@
+require "email_template/linkable/devise"
+include Linkable::DeviseMailer
+
+class CustomDeviseMailer < DeviseTemplateSendMailer
+  def confirmation_instructions(record, opts={})
+    sending(record, :confirmation_instructions,
+            "#{obj_class_name(record)}_mailer:#{__method__}", opts, {})
+  end
+
+  def reset_password_instructions(record, opts={})
+    sending(record, :reset_password_instructions,
+            "#{obj_class_name(record)}_mailer:#{__method__}", opts, {})
+  end
+
+  def unlock_instructions(record, opts={})
+    sending(record, :unlock_instructions,
+            "#{obj_class_name(record)}_mailer:#{__method__}", opts, {})
+  end
+end

data/lib/generators/templates/email_templates.rb

@@ -0,0 +1,18 @@
+EmailTemplate.setup do |config|
+
+  #############Whitelists################
+
+  # Accepts args as Hash and as Array
+
+  # Ignore token list for columns
+  #config.columns_black_list = ["_at", "id"]
+  #config.columns_black_list = {'*' => ["_at", "id"], "some_object" => ["complete"]}
+
+  # Ignore token list for attributes
+  #config.attributes_black_list = []
+
+  #######################################
+
+  # Method header for object methods selecting. By default eql "et_"
+  #config.methods_header = "et_"
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'email_template'

data/spec/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+rspec --configure autotest

data/spec/helpers/mailer_helper_spec.rb

@@ -0,0 +1,5 @@
+require "spec/spec_helper"
+
+describe EmailTemplate::Mailers::Helpers do
+  pending "write it"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'email_template'
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: email_template
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
+platform: ruby
+authors:
+- Jenua Boiko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Allows your users to edit e-mail templates
+email:
+- jeyboy1985@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- email_template.gemspec
+- lib/email-template/version.rb
+- lib/email_template.rb
+- lib/email_template/j_helpers.rb
+- lib/email_template/j_mailers.rb
+- lib/email_template/j_models.rb
+- lib/email_template/linkable/devise.rb
+- lib/email_template/linkable/devise_helper.rb
+- lib/generators/active_record/migration.rb
+- lib/generators/email_template/devise_install_generator.rb
+- lib/generators/email_template/devise_templates_generator.rb
+- lib/generators/email_template/install_generator.rb
+- lib/generators/email_template/install_helpers.rb
+- lib/generators/templates/active_admin/emails.rb
+- lib/generators/templates/devise/custom_devise_mailer.rb
+- lib/generators/templates/email_templates.rb
+- rails/init.rb
+- spec/.rspec
+- spec/helpers/mailer_helper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jeyboy/email_template
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Allows your users to edit e-mail templates. With Devise and Active Admin
+  support (but you don't need them to start using email_template).
+test_files:
+- spec/.rspec
+- spec/helpers/mailer_helper_spec.rb
+- spec/spec_helper.rb