mail_engine 0.1.2 → 0.1.3

data/Gemfile

@@ -12,6 +12,7 @@ gem 'kaminari', :git => 'https://github.com/amatsuda/kaminari.git'
 gem "carrierwave", :git => "git://github.com/jnicklas/carrierwave.git"
 
 group :development do
+  gem "annotate"
   gem "bluecloth"
   gem "yard"
   gem "bundler"

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/app/controllers/mail_engine/application_controller.rb

@@ -1,5 +1,6 @@
 class MailEngine::ApplicationController < ApplicationController
-  prepend_view_path MailEngine::MailTemplate::Resolver.instance
+  # used when mail_template preview.
+  prepend_view_path MailEngine::MailTemplateResolver.instance
   layout 'mail_engine/mail_engine'
 
   # set the access check method.

data/app/controllers/mail_engine/dashboard_controller.rb

@@ -1,9 +1,7 @@
 class MailEngine::DashboardController < MailEngine::ApplicationController
   def index
     @pie_chart_columns = ["bounces", "unique_opens", "spamreports", "blocks", "unopened"]
-
-    @stats_data = MailEngine::Sendgrid::RestApi.stats(:days => 6)
-    @data_of_today = @stats_data.last
+    @data_of_today = MailEngine::Sendgrid::RestApi.stats
     @data_of_today.merge!("unopened" => (@data_of_today["delivered"].to_i - @data_of_today["unique_opens"].to_i))
   end
 end

data/app/controllers/mail_engine/mail_templates_controller.rb

@@ -132,6 +132,18 @@ class MailEngine::MailTemplatesController < MailEngine::ApplicationController
   def edit
   end
 
+  def import
+  end
+
+  def import_from_files
+    MailEngine::MailTemplate.import_from_files!(params[:import][:mailer_name])
+    flash[:notice] = "Import successfully!"
+  rescue => e
+    flash[:notice] = "Import failed due to: #{e.to_s}"
+  ensure
+    render :import
+  end
+
   # def send_test_mail
   #   @mail_template.send_test_mail_to!(params[:recipient])
   #   render :text => "alert('Test Mail sent to #{params[:recipient]}'); $('#recipient').val('');"

data/app/controllers/mail_engine/reports_controller.rb

@@ -21,9 +21,8 @@ class MailEngine::ReportsController < MailEngine::ApplicationController
     @stats_data = if params[:report] and params[:report][:from] and params[:report][:to]
                     MailEngine::Sendgrid::RestApi.stats(:start_date => params[:report][:from], :end_date => params[:report][:to])
                   else
-                    MailEngine::Sendgrid::RestApi.stats(:days => 6)
+                    MailEngine::Sendgrid::RestApi.stats(:days => 7)
                   end
-    @data_of_today = @stats_data.last
   end
 
   def chart

data/app/helpers/mail_engine/mail_engine_helper.rb

@@ -2,7 +2,7 @@ module MailEngine
   module MailEngineHelper
 
     def show_no_record collection, &block
-      if collection.all.blank?
+      if collection.is_a?(Array) ? collection.blank? : collection.all.blank?
         return raw("<div class='notice' style='margin-top:10px'>No Record</div>")
       else
         block.call

data/app/models/mail_engine/mail_log.rb

@@ -1,36 +1,51 @@
+# == Schema Information
+#
+# Table name: mail_logs
+#
+#  id                 :integer         not null, primary key
+#  mail_template_path :string(255)
+#  recipient          :string(255)
+#  sender             :string(255)
+#  subject            :string(255)
+#  mime_type          :string(255)
+#  raw_body           :text
+#  created_at         :datetime
+#  updated_at         :datetime
+#
+
 class MailEngine::MailLog < ActiveRecord::Base  
   validates_presence_of :mail_template_path
 
-  # Callback of Mail gem when delivering mails
-  def self.delivering_email mail
-    # pp email.body.raw_source
-    # pp email.to
-    # pp email.from
-    # pp email.subject
-    # pp email.mime_type
-
-    ##################
-    # pp mail.mime_type
-    # pp mail.content_type
-    # pp mail.from            #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-    # pp mail.to              #=> 'bob@test.lindsaar.net'
-    # pp mail.subject         #=> "This is the subject"
-    # pp mail.body.decoded    #=> 'This is the body of the email...
-    ###################
-
-    # pp mail.parts.map { |p| p.content_type }  #=> ['text/plain', 'application/pdf']
-    # pp mail.parts.map { |p| p.class }         #=> [Mail::Message, Mail::Message]
-    # pp mail.parts[0].content_type_parameters  #=> {'charset' => 'ISO-8859-1'}
-    # pp mail.parts[1].content_type_parameters  #=> {'name' => 'my.pdf'}
-
-    # mail_type = email.header["X-mail-type"].value
-    # record = create! :recipient => email.to.join(","), :mail_type => mail_type
-    # email.encoded # kick email to set content_transfer_encoding
-    # # The new body needs to be already encoded, as Mail expects the body to be encoded already (after calling #encoded)
-    # encoding = Mail::Encodings.get_encoding email.content_transfer_encoding
-    # new_body = encoding.encode email.body.to_s.sub("/t/id.gif", "/t/#{record.open_token}.gif")
-    # email.body(new_body)
-    #
-    # record.update_attributes! :body => email.body.to_s, :raw_text => email.encoded
-  end
-end
+  # # Callback of Mail gem when delivering mails
+  # def self.delivering_email mail
+  #   # pp email.body.raw_source
+  #   # pp email.to
+  #   # pp email.from
+  #   # pp email.subject
+  #   # pp email.mime_type
+  # 
+  #   ##################
+  #   # pp mail.mime_type
+  #   # pp mail.content_type
+  #   # pp mail.from            #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+  #   # pp mail.to              #=> 'bob@test.lindsaar.net'
+  #   # pp mail.subject         #=> "This is the subject"
+  #   # pp mail.body.decoded    #=> 'This is the body of the email...
+  #   ###################
+  # 
+  #   # pp mail.parts.map { |p| p.content_type }  #=> ['text/plain', 'application/pdf']
+  #   # pp mail.parts.map { |p| p.class }         #=> [Mail::Message, Mail::Message]
+  #   # pp mail.parts[0].content_type_parameters  #=> {'charset' => 'ISO-8859-1'}
+  #   # pp mail.parts[1].content_type_parameters  #=> {'name' => 'my.pdf'}
+  # 
+  #   # mail_type = email.header["X-mail-type"].value
+  #   # record = create! :recipient => email.to.join(","), :mail_type => mail_type
+  #   # email.encoded # kick email to set content_transfer_encoding
+  #   # # The new body needs to be already encoded, as Mail expects the body to be encoded already (after calling #encoded)
+  #   # encoding = Mail::Encodings.get_encoding email.content_transfer_encoding
+  #   # new_body = encoding.encode email.body.to_s.sub("/t/id.gif", "/t/#{record.open_token}.gif")
+  #   # email.body(new_body)
+  #   #
+  #   # record.update_attributes! :body => email.body.to_s, :raw_text => email.encoded
+  # end
+end

data/app/models/mail_engine/mail_schedule.rb

@@ -1,8 +1,43 @@
+# == Schema Information
+#
+# Table name: mail_schedules
+#
+#  id               :integer         not null, primary key
+#  name             :string(255)
+#  mail_template_id :integer
+#  user_group       :string(255)
+#  count            :integer         default(0)
+#  sent_count       :integer         default(0)
+#  period           :string(255)
+#  payload          :string(255)
+#  first_send_at    :datetime
+#  last_sent_at     :datetime
+#  created_at       :datetime
+#  updated_at       :datetime
+#
+
 class MailEngine::MailSchedule < ActiveRecord::Base
   validates_presence_of :name, :user_group, :mail_template_id, :period, :count, :first_send_at
+  validates_inclusion_of :period, :in => %w( once daily weekly monthly yearly), :message => "period should in 'daily', 'weekly' and 'monthly'"
   belongs_to :mail_template
   scope :available, where("sent_count < count OR count = 0")
 
+  PERIOD_TO_UNIT_TABLE = {
+    "daily" => "day",
+    "weekly" => "week",
+    "monthly" => "month",
+    "yearly" => "year"
+  }
+
+  def self.future_schedules
+    all_future_schedules = []
+    MailEngine::MailSchedule.available.all.each do |schedule|
+      next_schedules = [schedule].product(schedule.next_several_schedules)
+      all_future_schedules << next_schedules.flatten if next_schedules.present?
+    end
+    all_future_schedules.sort {|x,y| x[1] <=> y[1]}
+  end
+
   # list mail log with the same mail_template_path to current mail_template's path
   def logs(count = 10)
     MailEngine::MailLog.where(:mail_template_path => self.mail_template.actual_path).order("id desc").limit(count)
@@ -27,6 +62,26 @@ class MailEngine::MailSchedule < ActiveRecord::Base
     end
   end
 
+  def next_several_schedules(schedule_count = 5)
+    # check if send count reached the total count.
+    return [] if (sent_count >= count and count != 0)
+    # only send once.
+    if period == 'once'
+      if first_send_at > Time.now
+        return [first_send_at]
+      else
+        return []
+     end
+    end
+
+    # other period
+    rest_count = (count == 0 ? schedule_count : count - sent_count)
+    start_datetime = Time.parse("#{(last_sent_at||first_send_at).strftime("%D")} #{first_send_at.strftime("%T")}")
+    (1..rest_count).map do |i|
+      start_datetime + i.send(PERIOD_TO_UNIT_TABLE[period])
+    end
+  end
+
   # If execute sendmail twice very soon(within 14 minutes), it should not be able to send mail again.
   def ready_to_send?
     # check if send count reached the total count.
@@ -34,10 +89,15 @@ class MailEngine::MailSchedule < ActiveRecord::Base
     # only send once.
     return sent_count < 1 if period == 'once'
 
-    # why 15 minutes? for tolerance.
-    not_sent_mail_within_15_minutes = last_sent_at.nil? || ((Time.now.to_i - last_sent_at.to_i).abs >= 60*15)
-    ready_to_send = not_sent_mail_within_15_minutes and (Time.now.to_i - first_send_at.to_i).abs < 60*15
-    result_by_period = case period
+    ###  ready for first send?
+    # why 15 minutes?   because crontab will run each 15 minutes.
+    timespan_since_last_mail = (Time.now.to_i - last_sent_at.to_i).abs
+    timespan_to_first_send_at = (Time.now.to_i - first_send_at.to_i).abs
+    not_sent_mail_within_15_minutes = last_sent_at.nil? || (timespan_since_last_mail >= 60*15)
+    start_first_send_within_15_minutes = (timespan_to_first_send_at < 60*15)
+
+    # cycle start
+    cycle_start = case period
                        when 'daily'
                          1.days.ago.to_i <= last_sent_at.to_i
                        when 'weekly'
@@ -47,8 +107,7 @@ class MailEngine::MailSchedule < ActiveRecord::Base
                        else
                          false
                        end
-
-    ready_to_send or (not_sent_mail_within_15_minutes and result_by_period)
+    not_sent_mail_within_15_minutes and (cycle_start or start_first_send_within_15_minutes)
   end
 
   # used in Rake task, the main mail sending method.

data/app/models/mail_engine/mail_template.rb

@@ -1,3 +1,22 @@
+# == Schema Information
+#
+# Table name: mail_templates
+#
+#  id            :integer         not null, primary key
+#  name          :string(255)
+#  subject       :string(255)
+#  path          :string(255)
+#  format        :string(255)     default("html")
+#  locale        :string(255)
+#  handler       :string(255)     default("liquid")
+#  body          :text
+#  partial       :boolean         default(FALSE)
+#  for_marketing :boolean         default(FALSE)
+#  layout        :string(255)     default("none")
+#  zip_file      :string(255)
+#  created_at    :datetime
+#  updated_at    :datetime
+#
 class MailEngine::MailTemplate < ActiveRecord::Base
   attr_accessor :create_by_upload
 
@@ -37,7 +56,7 @@ class MailEngine::MailTemplate < ActiveRecord::Base
   before_save :delete_partials_if_new_partials_added
   after_save do
     # clear cached paths
-    MailEngine::MailTemplate::Resolver.instance.clear_cache
+    MailEngine::MailTemplateResolver.instance.clear_cache
 
     # update subject
     MailEngine::MailTemplate.update_all(["subject=?", self.subject], ["path = ? AND locale = ?", self.path, self.locale])
@@ -45,10 +64,56 @@ class MailEngine::MailTemplate < ActiveRecord::Base
 
   # class methods
   class << self
+    # get subject from other templates with same path
     def get_subject_from_bother_template(path, locale, for_marketing)
       return nil if path.blank?
       MailEngine::MailTemplate.where(:path => path, :locale => locale, :for_marketing => for_marketing, :partial => false).select("subject").first.try(:subject)
     end
+
+    # import all mail template from exist system.
+    # format like: views/user_mailer/index.en.html.erb
+    def import_from_files!(mailer_name)
+      mailer = mailer_name.classify.constantize
+      raise "not a mailer or doesn't provide mailer." unless mailer.ancestors.include?(ActionMailer::Base)
+
+      # prepare data
+      mailer_actions     = mailer.action_methods
+      file_view_paths    = mailer.view_paths.select {|path| path.is_a?(ActionView::FileSystemResolver)}
+      available_formats  = [:text, :html]
+      available_handlers = [:erb, :liquid, :rhtml]
+      available_locales  = I18n.available_locales
+
+      # collect all possible combinations
+      search_envs = file_view_paths.product(mailer_actions, available_formats, available_handlers, available_locales)
+
+      # [#<ActionView::FileSystemResolver>, "notify_to_user", :text, :erb, :zh]
+      search_envs.map { |resolver, action, format, handler, locale|
+        template_files = resolver.find_all "#{mailer.to_s.underscore}/#{action}", {}, false, {
+          :locale => Array.wrap(locale),
+          :formats => Array.wrap(format),
+          :handlers => Array.wrap(handler)
+        }
+
+        # file_path => app/views/user_mailer/notify.html.erb
+        template_files.map do |file_path|
+          template = MailEngine::MailTemplate.create(
+            :name    => "#{mailer.to_s.underscore}/#{action} - #{format}",
+            :subject => "#{mailer.to_s.underscore}/#{action} - #{format}",
+            :path    => "#{mailer.to_s.underscore}/#{action}",
+            :format  => format.to_s,
+            :locale  => locale.to_s,
+            :body    => File.read(file_path.identifier)
+          )
+        end
+      }.compact.flatten.uniq # search_envs
+    end
+
+    def all_system_mailers
+      mailer_path = File.join(Rails.root, "app", "mailers")
+      mailers_found_on_system = `find #{mailer_path} -name *.rb`.split("\n")
+      # remove mailer_path just show file names
+      mailers_found_on_system.map {|mailer| mailer.sub(/^#{mailer_path}\//, '')}
+    end
   end
 
   # detect if current partial template is used by other templates.
@@ -232,65 +297,4 @@ class MailEngine::MailTemplate < ActiveRecord::Base
   #     ).deliver
   #   end
   # end
-
-
-  ###############################
-  # path resolver, used for find template by provided path.
-  class Resolver < ActionView::Resolver
-    require "singleton"
-    include Singleton
-
-    def find_templates(name, prefix, partial, details)
-      template_path_and_name = prefix.include?("mail_engine/mail_dispatcher") ? normalize_path(name, nil) : normalize_path(name, prefix)
-
-      conditions = {
-        :path    => template_path_and_name,
-        :locale  => normalize_array(details[:locale]).first,
-        :format  => normalize_array(details[:formats]).first,
-        :handler => normalize_array(details[:handlers]),
-        :partial => partial || false
-      }
-
-      MailEngine::MailTemplate.where(conditions).map do |record|
-        initialize_template(record)
-      end
-    end
-
-    # Normalize name and prefix, so the tuple ["index", "users"] becomes
-    # "users/index" and the tuple ["template", nil] becomes "template".
-    def normalize_path(name, prefix)
-      prefix.present? ? "#{prefix}/#{name}" : name
-    end
-
-    # Normalize arrays by converting all symbols to strings.
-    def normalize_array(array)
-      array.map(&:to_s)
-    end
-
-    # Initialize an ActionView::Template object based on the record found.
-    def initialize_template(record)
-      source = record.body
-
-      identifier = "mail template - #{record.id} - #{record.path.inspect}"
-      handler = ActionView::Template.registered_template_handler(record.handler)
-
-      details = {
-        :format => Mime[record.format],
-        :updated_at => record.updated_at,
-        :virtual_path => virtual_path(record.path, record.partial)
-      }
-
-      ActionView::Template.new(source, identifier, handler, details)
-    end
-
-    # Make paths as "users/user" become "users/_user" for partials.
-    def virtual_path(path, partial)
-      return path unless partial
-      if index = path.rindex("/")
-        path.insert(index + 1, "_")
-      else
-        "_#{path}"
-      end
-    end
-  end # Resolver
-end
+end

data/app/models/mail_engine/mail_template_file.rb

@@ -1,3 +1,15 @@
+# == Schema Information
+#
+# Table name: mail_template_files
+#
+#  id               :integer         not null, primary key
+#  mail_template_id :integer
+#  file             :string(255)
+#  size             :integer
+#  created_at       :datetime
+#  updated_at       :datetime
+#
+
 class MailEngine::MailTemplateFile < ActiveRecord::Base
   mount_uploader :file, MailEngine::TemplateFileUploader
 

data/app/models/mail_engine/template_partial.rb

@@ -1,3 +1,13 @@
+# == Schema Information
+#
+# Table name: template_partials
+#
+#  id               :integer         not null, primary key
+#  placeholder_name :string(255)
+#  mail_template_id :integer
+#  partial_id       :integer
+#
+
 class MailEngine::TemplatePartial < ActiveRecord::Base
   validates_presence_of :partial_id, :placeholder_name
 

data/app/views/layouts/mail_engine/mail_engine.html.erb

@@ -80,6 +80,7 @@
           <li <%= "class='current-tab'" if controller_name == 'mail_templates' and params[:type] == 'system' %>><%= link_to "Sytem Mail Templates", mail_templates_path(:type => 'system') %></li>
           <li <%= "class='current-tab'" if controller_name == 'mail_templates' and params[:type] == 'marketing' %>><%= link_to "Marketing Mail Templates", mail_templates_path(:type => 'marketing') %></li>
           <li <%= "class='current-tab'" if controller_name == 'mail_templates' and params[:type] == 'partial' %>><%= link_to "Template Partials", mail_templates_path(:type => 'partial') %></li>
+          <li <%= "class='current-tab'" if controller_name == 'mail_templates' and action_name == 'import_from_files' %>><%= link_to "Import From System Templates", import_mail_templates_path %></li>
         </ul>
         <div class="clearer">&nbsp;</div>
       </div>

data/app/views/mail_engine/dashboard/index.html.erb

@@ -25,7 +25,7 @@
 </script>
 
 <div class="today-report left">
-  
+
   <h2>Report of Today</h2>
   <div class="clearer"></div>
 
@@ -73,9 +73,39 @@
     <tr>
       <th>Schedule Name</th><th width="120">Send Time</th>
     </tr>
+    <% MailEngine::MailSchedule.future_schedules.each do |schedule, scheduled_time| %>
     <tr>
-      <td>New Jobs Newsletter</td><td>2011-3-4 12:00</td>
+      <td><%= link_to schedule.name, mail_schedule_path(schedule) %></td><td><%= scheduled_time.to_s(:db) %></td>
+    </tr>
+    <% end %>
+  </table>
+</div>
+<div class="clearer"></div>
+
+<div class="today-report left">
+  <h2>Recently Sent Mails</h2>
+  <div class="clearer"></div>
+
+  <table class="data-table" style="width: 910px; margin-top: 30px; margin-right: 30px">
+    <tr>
+      <th>Subject</th>
+      <th>Sender</th>
+      <th>Recipient</th>
+      <th>mime_type</th>
+      <th>Sent at</th>
+      <th width="20"></th>
+    </tr>
+
+  <% MailEngine::MailLog.order("id desc").limit(10).each do |log| %>
+    <tr class="even">
+      <td><%= log.subject %></td>
+      <td><%= log.sender %></td>
+      <td><%= log.recipient %></td>
+      <td><%= log.mime_type %></td>
+      <td><%= log.created_at %></td>
+      <td><%= link_to image_tag('mail_engine/icons/show.png'), mail_log_path(log) %></td>
     </tr>
+  <% end %>
   </table>
 </div>
 <div class="clearer"></div>

data/app/views/mail_engine/mail_schedules/index.html.erb

@@ -4,26 +4,28 @@
 	  <%= show_no_record(@mail_schedules) do %>
 		<table class="data-table">
       <tr>
-        <th>Name</th>
-        <th>Template</th>
-        <th>User Group</th>
-        <th>Total Count</th>
-        <th>Sent Count</th>
-        <th>Period</th>
-        <th>Payload</th>
-        <th></th>
+        <th>Schedule Info</th>
+        <th width="230"></th>
       </tr>
 
     <% @mail_schedules.each do |mail_schedule| %>
       <tr class="even">
-        <td><%= mail_schedule.name %></td>
-        <td><%= mail_schedule.mail_template.name %></td>
-        <td><%= mail_schedule.user_group %></td>
-        <td><%= mail_schedule.count %></td>
-        <td><%= mail_schedule.sent_count %></td>
-        <td><%= mail_schedule.period %></td>
-        <td><%= raw mail_schedule.payload.gsub(",", "<br/>") %></td>
-        <td>
+        <td style="vertical-align:top">
+          <table class="data-table" style="margin-bottom: 0px">
+            <tr><th width="100">Name</th><td><%= mail_schedule.name %></td></tr>
+            <tr><th>Template</th><td><%= mail_schedule.mail_template.name %></td></tr>
+            <tr><th>User Group</th><td><%= mail_schedule.user_group %></td></tr>
+            <tr><th>Total Count</th><td><%= mail_schedule.count %></td></tr>
+            <tr><th>Sent Count</th><td><%= mail_schedule.sent_count %></td></tr>
+            <tr><th>Period</th><td><%= mail_schedule.period %></td></tr>
+            <tr><th>First Send At</th><td><%= mail_schedule.first_send_at %></td></tr>
+            <tr><th>Last Sent At</th><td><%= mail_schedule.last_sent_at %></td></tr>
+            <tr><th>Payload</th>
+              <td><%= raw mail_schedule.payload.gsub(",", "<br/>") %></td>
+            </tr>
+          </table>
+        </td>
+        <td style="vertical-align:top">
           <%= link_to image_tag('mail_engine/icons/show.png'), mail_schedule_path(mail_schedule) %>
           <%= link_to image_tag('mail_engine/icons/edit.gif'), edit_mail_schedule_path(mail_schedule) %>
           <%= link_to image_tag('mail_engine/icons/delete.png'), mail_schedule_path(mail_schedule), :confirm => 'Are you sure?', :method => :delete %>

data/app/views/mail_engine/mail_schedules/show.html.erb

@@ -29,6 +29,14 @@
         <td>Period</td>
         <td><%= @mail_schedule.period %></td>
       </tr>
+      <tr>
+        <td>First send at</td>
+        <td><%= @mail_schedule.first_send_at %></td>
+      </tr>
+      <tr>
+        <td>Last send at</td>
+        <td><%= @mail_schedule.last_sent_at %></td>
+      </tr>
       <tr>
         <td>Payload</td>
         <td><%= @mail_schedule.payload %></td>

data/app/views/mail_engine/mail_templates/import.html.erb

@@ -0,0 +1,41 @@
+<div class="post">
+  <div class="post-title">
+    <h2>
+      Import Mail Template From System Files
+    </h2>
+  </div>
+  <div class="post-body">
+    <%= form_for(:import, :url => import_from_files_mail_templates_path) do |f| %>
+      <!-- basic columns -->
+      <div class="field">
+        <%= f.label :mailer_name %><br />
+        <%= f.text_field :mailer_name, :class => "text" %>
+      </div>
+
+      <div class="actions">
+        <%= f.submit :class => "button" %>
+      </div>
+
+      <% if @mailers_found_on_system = MailEngine::MailTemplate.all_system_mailers %>
+      <div class="field quiet" style="margin-top: 20px">
+        <label>Mailers Found on current system under "app/mailers":</label>
+        <ul>
+          <% @mailers_found_on_system.each do |mailer| %>
+          <li><%= mailer %></li>
+          <% end %>
+        </ul>
+      </div>
+      <% end %>
+
+      <div class="field quiet" style="margin-top: 20px">
+        <label>Your mail template file name have to abide the convention like:</label>
+        <ul>
+          <li>xxx.html.erb</li>
+          <li>xxx.text.erb</li>
+          <li>xxx.html.liquid</li>
+          <li>xxx.text.liquid</li>
+        </ul>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/mail_engine/mail_templates/index.html.erb

@@ -4,35 +4,37 @@
     <%= show_no_record(@mail_templates) do %>
 		<table class="data-table">
       <tr>
-        <th>Name</th>
-        <th>Template Path</th>
-        <% if params[:type] != 'partial' %>
-          <th>Subject</th>
-          <th>Layout</th>
-          <th>Partials</th>
-        <% end %>
-        <th>Variations</th>
+        <th>Template Info</th>
+        <th>Variations
+          <a href="javascript:void()" class="show_all_variations_link">All</a>
+        </th>
       </tr>
 
     <% @mail_templates.each do |mail_template| %>
       <tr class="even">
-        <td><%= mail_template.name %></td>
-        <td><%= mail_template.path %></td>
-        <% if params[:type] != 'partial' %>
-          <td><%= mail_template.subject %></td>
-          <td><%= mail_template.layout %></td>
-          <td><%= mail_template.partials.map(&:name).join(" , ") %></td>
-        <% end %>
-        <td style="width: 200px;">
+        <td style="vertical-align:top">
+          <table class="data-table" style="margin-bottom: 0px">
+            <tr><th width="100">Name</th><td><%= mail_template.name %></td></tr>
+            <tr><th>Path</th><td><%= mail_template.path %></td></tr>
+          <% if params[:type] != 'partial' %>
+            <tr><th>Subject</th><td><%= mail_template.subject %></td></tr>
+            <tr><th>Layout</th><td><%= mail_template.layout %></td></tr>
+            <tr><th>Partials</th><td><%= mail_template.partials.map(&:name).join(" , ") %></td></tr>
+          <% end %>
+          </table>
+        </td>
+        <td style="width: 200px; vertical-align: top;">
+          <!-- variation list -->
           <table style="margin-bottom: 0px;">
             <% mail_template.variations(params[:type] == 'partial').group_by(&:locale).each do |locale, templates| %>
-              <tr>
+              <tr class="<%= "hideable" unless templates.detect {|t| t.persisted? } %>">
                 <td colspan="2" style="background-color: grey; font-weight: bold; color: white; padding: 2px 5px"><%= locale.humanize %></td>
               </tr>
+
               <% templates.each do |template| %>
                 <% if template.persisted? %>
                 <tr>
-                  <td><%= template.locale %>.<%= template.format %></td>
+                  <td><b><%= template.locale %>.<%= template.format %></b></td>
                   <td>
                     <%= link_to image_tag('mail_engine/icons/show.png', :alt => "Show"), mail_template_path(template) %>
                     <%= link_to image_tag('mail_engine/icons/edit.gif', :alt => "Edit"), edit_mail_template_path(template) %>
@@ -42,16 +44,16 @@
                 </tr>
                 <% else %>
                 <tr>
-                  <td class='quiet' colspan='2'>
+                  <td class='quiet hideable' colspan='2'>
                     <%= image_tag('mail_engine/icons/missing.png', :alt => "Missing", :class=>"left", :style => "margin-bottom: 0px") %>
                     Missing: <%= template.locale %>.<%= template.format %>
                   </td>
-                  <%#= link_to image_tag('mail_engine/icons/add.png', :alt => "Add"), new_mail_template_path(:type => params[:type]) %>
                 </tr>
                 <% end %>
               <% end %>
             <% end %>
           </table>
+
         </td>
       </tr>
     <% end %>
@@ -70,4 +72,15 @@
     </h5>
     <div class="clearer">&nbsp;</div>
 	</div>
-</div>
+</div>
+
+<script>
+  $(function(){
+    $(".hideable").hide();
+
+    $(".show_all_variations_link").click(function(){
+      $(".hideable").toggle();
+      $(this).html($(this).html() == 'All' ? "Available" : "All")
+    });
+  });
+</script>

data/config/routes.rb

@@ -20,6 +20,8 @@ module MailEngine
             # used before mail template been saved
             post :preview
 
+            get :import
+            post :import_from_files
             get :get_existed_subject
             get :new_by_upload
             post :create_by_upload

data/db/migrate/20110114030841_create_table_mail_template.rb

@@ -10,7 +10,7 @@ class CreateTableMailTemplate < ActiveRecord::Migration
       t.text :body
       t.boolean :partial, :default => false
       t.boolean :for_marketing, :default => false
-      t.string :layout
+      t.string :layout, :default => 'none'
       t.string :zip_file
 
       t.timestamps

data/lib/mail_engine/action_mailer_patch.rb

@@ -8,6 +8,17 @@ module ActionMailer
       headers[:subject] = current_template.subject if headers[:subject].blank? && current_template.present?
       headers[:message_id] = "#{controller_path}/#{action_name}"
 
+      unless block_given?
+        puts "\e[1;31;40m[Mail Engine Warning]\e[0m Please pass a block to 'mail' method as below style,
+        mail engine needs you to specify the format to send:
+          \e[1;34;40m
+          mail :to => 'xxx@xxx.com' do |format|
+            format.text
+            format.html
+          end
+          \e[0m"
+      end
+      
       # Add sendgrid header before sending mail.
       # Why here but not add to default_params of action_mailer? because the receiver email [:to] only can get here.
       if self.sendgrid_config

data/lib/mail_engine/engine.rb

@@ -18,7 +18,7 @@ module MailEngine
 
     initializer "mail_engine.register_database_template" do
       ActionMailer::Base.layout "layouts/mail_engine/mail_template_layouts/none"
-      ActionMailer::Base.send(:prepend_view_path, MailEngine::MailTemplate::Resolver.instance)
+      ActionMailer::Base.send(:prepend_view_path, MailEngine::MailTemplateResolver.instance)
     end
 
     initializer "mail_engine.add_acts_as_mail_receiver" do

data/lib/mail_engine/mail_template_resolver.rb

@@ -0,0 +1,63 @@
+module MailEngine
+
+  ###############################
+  # path resolver, used for find template by provided path.
+  class MailTemplateResolver < ActionView::Resolver
+    require "singleton"
+    include Singleton
+
+    def find_templates(name, prefix, partial, details)
+      template_path_and_name = prefix.include?("mail_engine/mail_dispatcher") ? normalize_path(name, nil) : normalize_path(name, prefix)
+
+      conditions = {
+        :path    => template_path_and_name,
+        :locale  => normalize_array(details[:locale]).first,
+        :format  => normalize_array(details[:formats]).first,
+        :handler => normalize_array(details[:handlers]),
+        :partial => partial || false
+      }
+
+      MailTemplate.where(conditions).map do |record|
+        initialize_template(record)
+      end
+    end
+
+    # Normalize name and prefix, so the tuple ["index", "users"] becomes
+    # "users/index" and the tuple ["template", nil] becomes "template".
+    def normalize_path(name, prefix)
+      prefix.present? ? "#{prefix}/#{name}" : name
+    end
+
+    # Normalize arrays by converting all symbols to strings.
+    def normalize_array(array)
+      array.map(&:to_s)
+    end
+
+    # Initialize an ActionView::Template object based on the record found.
+    def initialize_template(record)
+      source = record.body
+
+      identifier = "mail template - #{record.id} - #{record.path.inspect}"
+      handler = ActionView::Template.registered_template_handler(record.handler)
+
+      details = {
+        :format => Mime[record.format],
+        :updated_at => record.updated_at,
+        :virtual_path => virtual_path(record.path, record.partial)
+      }
+
+      ActionView::Template.new(source, identifier, handler, details)
+    end
+
+    # Make paths as "users/user" become "users/_user" for partials.
+    def virtual_path(path, partial)
+      return path unless partial
+      if index = path.rindex("/")
+        path.insert(index + 1, "_")
+      else
+        "_#{path}"
+      end
+    end
+  end # Resolver
+
+end

data/lib/mail_engine.rb

@@ -20,5 +20,6 @@ module MailEngine
   autoload :Mailer
   autoload :ActsAsMailReceiver
   autoload :Configuration
+  autoload :MailTemplateResolver
 end
 

data/mail_engine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mail_engine}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["michael he"]
-  s.date = %q{2011-03-05}
+  s.date = %q{2011-03-06}
   s.description = %q{Rails system mail management solution.}
   s.email = %q{hlxwell@gmail.com}
   s.extra_rdoc_files = [
@@ -132,6 +132,7 @@ Gem::Specification.new do |s|
     "app/views/mail_engine/mail_templates/_layout_selector.html.erb",
     "app/views/mail_engine/mail_templates/duplicate.html.erb",
     "app/views/mail_engine/mail_templates/edit.html.erb",
+    "app/views/mail_engine/mail_templates/import.html.erb",
     "app/views/mail_engine/mail_templates/index.html.erb",
     "app/views/mail_engine/mail_templates/new.html.erb",
     "app/views/mail_engine/mail_templates/new_by_upload.html.erb",
@@ -203,6 +204,7 @@ Gem::Specification.new do |s|
     "lib/mail_engine/html_document_assets_replacer.rb",
     "lib/mail_engine/liquid_view_patch/liquid_view.rb",
     "lib/mail_engine/mail_log_subscriber.rb",
+    "lib/mail_engine/mail_template_resolver.rb",
     "lib/mail_engine/sendgrid.rb",
     "lib/mail_engine/sendgrid/base.rb",
     "lib/mail_engine/sendgrid/rest_api.rb",
@@ -356,8 +358,11 @@ Gem::Specification.new do |s|
     "test/dummy/Rakefile",
     "test/dummy/app/controllers/application_controller.rb",
     "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/mailers/test/test_mailer.rb",
     "test/dummy/app/mailers/user_mailer.rb",
     "test/dummy/app/models/user.rb",
+    "test/dummy/app/views/user_mailer/notify.html.erb",
+    "test/dummy/app/views/user_mailer/notify.text.erb",
     "test/dummy/config.ru",
     "test/dummy/config/application.rb",
     "test/dummy/config/boot.rb",
@@ -551,6 +556,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/dummy/app/controllers/application_controller.rb",
     "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/mailers/test/test_mailer.rb",
     "test/dummy/app/mailers/user_mailer.rb",
     "test/dummy/app/models/user.rb",
     "test/dummy/config/application.rb",
@@ -604,6 +610,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<liquid>, [">= 0"])
       s.add_runtime_dependency(%q<kaminari>, [">= 0"])
       s.add_runtime_dependency(%q<carrierwave>, [">= 0"])
+      s.add_development_dependency(%q<annotate>, [">= 0"])
       s.add_development_dependency(%q<bluecloth>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
@@ -620,6 +627,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<liquid>, [">= 0"])
       s.add_dependency(%q<kaminari>, [">= 0"])
       s.add_dependency(%q<carrierwave>, [">= 0"])
+      s.add_dependency(%q<annotate>, [">= 0"])
       s.add_dependency(%q<bluecloth>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 0"])
@@ -637,6 +645,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<liquid>, [">= 0"])
     s.add_dependency(%q<kaminari>, [">= 0"])
     s.add_dependency(%q<carrierwave>, [">= 0"])
+    s.add_dependency(%q<annotate>, [">= 0"])
     s.add_dependency(%q<bluecloth>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 0"])

data/test/dummy/app/mailers/test/test_mailer.rb

@@ -0,0 +1,4 @@
+class Test::TestMailer < ActionMailer::Base
+  def nothing
+  end
+end

data/test/dummy/app/views/user_mailer/notify.html.erb

@@ -0,0 +1 @@
+html notify content

data/test/dummy/app/views/user_mailer/notify.text.erb

@@ -0,0 +1 @@
+text notify content here.

data/test/dummy/config/application.rb

@@ -28,7 +28,7 @@ module Dummy
 
     # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
     # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
+    config.time_zone = 'Beijing'
 
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]

data/test/dummy/db/migrate/20110114030841_create_table_mail_template.rb

@@ -10,7 +10,7 @@ class CreateTableMailTemplate < ActiveRecord::Migration
       t.text :body
       t.boolean :partial, :default => false
       t.boolean :for_marketing, :default => false
-      t.string :layout
+      t.string :layout, :default => 'none'
       t.string :zip_file
 
       t.timestamps

data/test/dummy/db/schema.rb

@@ -55,7 +55,7 @@ ActiveRecord::Schema.define(:version => 20110217062316) do
     t.text     "body"
     t.boolean  "partial",       :default => false
     t.boolean  "for_marketing", :default => false
-    t.string   "layout"
+    t.string   "layout",        :default => "none"
     t.string   "zip_file"
     t.datetime "created_at"
     t.datetime "updated_at"

data/test/unit/mail_engine/mail_schedule_test.rb

@@ -33,6 +33,10 @@ class MailEngine::MailScheduleTest < ActiveSupport::TestCase
         @schedule.send_test_mail_to!("hlxwell@gmail.com", 0)
       end
     end
+    
+    should "be able to get next_several_schedules" do
+      assert_equal [], @schedule.next_several_schedules
+    end
   end
 
   context "once sending only schedule" do

data/test/unit/mail_engine/mail_template_test.rb

@@ -15,7 +15,14 @@ class MailEngine::MailTemplateTest < ActiveSupport::TestCase
     end
   end
 
-  context "Template" do
+  context "Template class" do
+    setup do
+    end
+    should "be able to get_subject_from_bother_template"
+    should "be able to import templates from exist system"
+  end
+
+  context "A Template" do
     setup do
       @template = FactoryGirl.create(:system_mail_template_with_footer, :format => "html")
     end
@@ -102,7 +109,7 @@ class MailEngine::MailTemplateTest < ActiveSupport::TestCase
     # should "clone mail template files" do
     #   assert_equal @clone_template.mail_template_files.count, @zipmail_template.mail_template_files.count, "clone template has different files with original one."
     # end
-    # 
+    #
     # should "has the same files" do
     #   @clone_template.mail_template_files.each_with_index do |f, index|
     #     assert_equal File.basename(f.file.path), @zipmail_template.mail_template_files[index].try(:attributes).try(:[], "file")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mail_engine
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - michael he
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-05 00:00:00 +08:00
+date: 2011-03-06 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -158,7 +158,7 @@ dependencies:
         version: "0"
   requirement: *id010
   prerelease: false
-  name: bluecloth
+  name: annotate
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id011 !ruby/object:Gem::Requirement 
@@ -172,7 +172,7 @@ dependencies:
         version: "0"
   requirement: *id011
   prerelease: false
-  name: yard
+  name: bluecloth
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id012 !ruby/object:Gem::Requirement 
@@ -186,7 +186,7 @@ dependencies:
         version: "0"
   requirement: *id012
   prerelease: false
-  name: bundler
+  name: yard
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id013 !ruby/object:Gem::Requirement 
@@ -200,7 +200,7 @@ dependencies:
         version: "0"
   requirement: *id013
   prerelease: false
-  name: jeweler
+  name: bundler
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id014 !ruby/object:Gem::Requirement 
@@ -214,7 +214,7 @@ dependencies:
         version: "0"
   requirement: *id014
   prerelease: false
-  name: rcov
+  name: jeweler
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id015 !ruby/object:Gem::Requirement 
@@ -228,6 +228,20 @@ dependencies:
         version: "0"
   requirement: *id015
   prerelease: false
+  name: rcov
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id016 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id016
+  prerelease: false
   name: reek
   type: :development
 description: Rails system mail management solution.
@@ -355,6 +369,7 @@ files:
 - app/views/mail_engine/mail_templates/_layout_selector.html.erb
 - app/views/mail_engine/mail_templates/duplicate.html.erb
 - app/views/mail_engine/mail_templates/edit.html.erb
+- app/views/mail_engine/mail_templates/import.html.erb
 - app/views/mail_engine/mail_templates/index.html.erb
 - app/views/mail_engine/mail_templates/new.html.erb
 - app/views/mail_engine/mail_templates/new_by_upload.html.erb
@@ -426,6 +441,7 @@ files:
 - lib/mail_engine/html_document_assets_replacer.rb
 - lib/mail_engine/liquid_view_patch/liquid_view.rb
 - lib/mail_engine/mail_log_subscriber.rb
+- lib/mail_engine/mail_template_resolver.rb
 - lib/mail_engine/sendgrid.rb
 - lib/mail_engine/sendgrid/base.rb
 - lib/mail_engine/sendgrid/rest_api.rb
@@ -579,8 +595,11 @@ files:
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/test/test_mailer.rb
 - test/dummy/app/mailers/user_mailer.rb
 - test/dummy/app/models/user.rb
+- test/dummy/app/views/user_mailer/notify.html.erb
+- test/dummy/app/views/user_mailer/notify.text.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
@@ -802,6 +821,7 @@ summary: Mail Management Solution
 test_files: 
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/test/test_mailer.rb
 - test/dummy/app/mailers/user_mailer.rb
 - test/dummy/app/models/user.rb
 - test/dummy/config/application.rb