email_template 0.6.2 → 0.6.3

data/README.md

@@ -64,7 +64,7 @@ You can configure email_template at
 Pull template to the base :
 
 ```ruby
-MailTemplate.create(name: "activity_partner_mailer:join_confirmation_self",
+MailTemplate.create(name: "template unique name",
                     subject: "Join request confirmation",
                     classes: ["activity_partner"],
                     body:
@@ -81,34 +81,54 @@ In Mailer:
 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})
+    send_mail("template unique name", {to: "user@example.com"}, {activity_partner_: activity_partner})
   end
 end
 ```
 
+## Configuration
+    If you need adding some model method to token list need create in model alias with prefix,
+    which you set in config(by default is 'et_').
+    
+    For example if you need add method 'full_name' for 'activity_partner' to token list you need do next:
+
+```ruby
+class ActivityPartner < ActiveRecord::Base
+    def full_name
+        [self.first_name, self.last_name].join(' ')
+    end
+
+    alias et_full_name full_name
+end
+```
+    
+
 ## Customization
 
 In case you need additional customization :
 
 In Mailer:
+    Simply add 'template_path' and 'template_name'
 
 ```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))
+class MyMailer < TemplateSendMailer
+
+  def result(tree)
+    send_mail('MyMailer:result', 
+    {
+        to: my_email,
+        template_path: 'mailers',
+        template_name: 'mail'
+    }, {tree: tree})
   end
-end    
+end
 ```
 
 In View:
+    In view you will have compiled template in @data variable
 
 ```ruby
-= raw(@template.as_html(:parent => @resource).gsub(/\#\{confirm_link\}/,
-link_to('Confirm my account', confirmation_url(@resource, confirmation_token: @resource.confirmation_token))))
+= @data.html_safe
 ```
 
 ## Contributing

data/lib/email-template/version.rb

@@ -1,3 +1,3 @@
 module EmailTemplate
-  VERSION = "0.6.2"
+  VERSION = '0.6.3'
 end

data/lib/email_template.rb

@@ -1,6 +1,6 @@
-require "email_template/j_models"
-require "email_template/j_mailers"
-require "email_template/j_helpers"
+require 'email_template/j_models'
+require 'email_template/j_mailers'
+require 'email_template/j_helpers'
 
 include EmailTemplate::JModels
 include EmailTemplate::JMailers
@@ -12,7 +12,7 @@ module EmailTemplate
   mattr_accessor :attributes_black_list
   self.attributes_black_list = []
   mattr_accessor :methods_header
-  self.methods_header = "et_"
+  self.methods_header = 'et_'
 
   def self.setup
     yield self

data/lib/email_template/j_helpers.rb

@@ -12,6 +12,7 @@ module EmailTemplate
         mail_params.reverse_merge!(subject: template.subject)
 
         if mail_params.has_key?(:template_path) && mail_params.has_key?(:template_name)
+          @data = template.as_html(template_params)
           mail mail_params
         else
           mail mail_params do |format|

data/lib/email_template/j_models.rb

@@ -79,9 +79,9 @@ module EmailTemplate
 
       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 << 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
 

data/lib/email_template/linkable/devise.rb

@@ -2,7 +2,7 @@ module EmailTemplate
   module Linkable
     module DeviseMailer
       class DeviseTemplateSendMailer < Devise::Mailer
-        require "email_template/linkable/devise_helper"
+        require 'email_template/linkable/devise_helper'
         include EmailTemplate::Linkable::DeviseMailerHelper
         include ActionView::Helpers::UrlHelper
         include Devise::Mailers::Helpers

data/lib/generators/email_template/devise_install_generator.rb

@@ -7,10 +7,10 @@ module EmailTemplate
 
       source_root File.expand_path("../../", __FILE__)
 
-      desc "Copy devise mail template"
+      desc 'Copy devise mail template'
       def copy_initializer
-        STDOUT << "devise mailer"
-        template "templates/devise/custom_devise_mailer.rb", "app/mailers/custom_devise_mailer.rb"
+        STDOUT << 'devise mailer'
+        template 'templates/devise/custom_devise_mailer.rb', 'app/mailers/custom_devise_mailer.rb'
       end
     end
   end

data/lib/generators/email_template/devise_templates_generator.rb

@@ -3,7 +3,7 @@ module EmailTemplate
     class DeviseTemplatesGenerator < Rails::Generators::NamedBase
       attr_reader :bodies
 
-      desc "Create devise basic templates for input scope"
+      desc 'Create devise basic templates for input scope'
       def initialize(args, *options)
         super
         @bodies = {}

data/lib/generators/email_template/install_generator.rb

@@ -7,26 +7,26 @@ module EmailTemplate
 
       source_root File.expand_path("../../", __FILE__)
 
-      desc "Creates initializer and migration. If ActiveAdmin install - copy admin page for templates"
+      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"
+        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"
+        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"
+          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"
+          STDOUT << 'devise mailer'
+          template 'templates/devise/custom_devise_mailer.rb', 'app/mailers/custom_devise_mailer.rb'
         end
       end
     end

data/lib/generators/email_template/install_helpers.rb

@@ -14,7 +14,7 @@ module EmailTemplate
       end
 
       def migration_path
-        @migration_path ||= File.join("db", "migrate")
+        @migration_path ||= File.join('db', 'migrate')
       end
     end
   end

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

@@ -1,6 +1,6 @@
-ActiveAdmin.register MailTemplate, :as => "Mail Template" do
-  config.sort_order = "name_asc"
-  #config.batch_actions = false #uncomment this if you need batches
+ActiveAdmin.register MailTemplate, :as => 'Mail Template' do
+  config.sort_order = 'name_asc'
+  config.batch_actions = false #comment this if you need batches
 
   filter :subject, as: :select, collection: proc { MailTemplate.all.map(&:subject) }
 
@@ -20,17 +20,16 @@ ActiveAdmin.register MailTemplate, :as => "Mail Template" do
   end
 
   sidebar :email_objects, :only => :edit do
-    raw([
-        "You may use next constants :",
-        "<br/><br/>",
-        ("<div>#{resource.prepare_fields.join("</div><div>")}</div>")
-        ].join)
+    table_for([]) do
+      tr { td 'You may use next constants : ' }
+      resource.prepare_fields.each { |item| tr { td item} }
+    end
   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'
+      f.input :body  #, :as => :rich  # You may use this flag if you have installed gem 'rich'
     end
     f.actions
   end

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

@@ -1,4 +1,4 @@
-require "email_template/linkable/devise"
+require 'email_template/linkable/devise'
 include EmailTemplate::Linkable::DeviseMailer
 
 class CustomDeviseMailer < DeviseTemplateSendMailer

data/lib/generators/templates/email_templates.rb

@@ -3,6 +3,7 @@ EmailTemplate.setup do |config|
   #############Whitelists################
 
   # Accepts args as Hash and as Array
+  #if column name or attribute contains one of listened pieces - it will be ignore in output list
 
   # Ignore token list for columns
   #config.columns_black_list = ["_at", "id"]
@@ -13,6 +14,6 @@ EmailTemplate.setup do |config|
 
   #######################################
 
-  # Method header for object methods selecting. By default eql "et_"
+  # Method header for object methods which will be output in usable tokens list. By default eql "et_"
   #config.methods_header = "et_"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: email_template
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -73,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -656039679
+      hash: -128805631
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -656039679
+      hash: -128805631
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24