Class: RailsBestPractices::Reviews::UseMultipartAlternativeAsContentTypeOfEmailReview

Inherits:
Review
  • Object
show all
Defined in:
lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

Overview

Make sure to use multipart/alternative as content_type of email.

See the best practice details here rails-bestpractices.com/posts/41-use-multipart-alternative-as-content_type-of-email.

Implementation:

Review process:

check class node to remember the class name,
and check the method definition nodes to see if the corresponding mailer views exist or not.

Constant Summary

Constants inherited from Core::Check

Core::Check::CONTROLLER_FILES, Core::Check::HELPER_FILES, Core::Check::MAILER_FILES, Core::Check::MIGRATION_FILES, Core::Check::MODEL_FILES, Core::Check::NODE_TYPES, Core::Check::PARTIAL_VIEW_FILES, Core::Check::ROUTE_FILE, Core::Check::SCHEMA_FILE, Core::Check::VIEW_FILES

Instance Attribute Summary

Attributes inherited from Core::Check

#errors

Instance Method Summary collapse

Methods inherited from Review

#equal?, #model_associations, #model_attributes, #models, #remember_variable_use_count, #reset_variable_use_count, #variable, #variable_use_count

Methods inherited from Core::Check

#add_error, #initialize, #method_missing, #node_end, #node_start

Constructor Details

This class inherits a constructor from RailsBestPractices::Core::Check

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class RailsBestPractices::Core::Check

Instance Method Details

#interesting_files ⇒ Object 



25
26
27
 
# File 'lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb', line 25

def interesting_files
  MAILER_FILES
end

#interesting_nodes ⇒ Object 



21
22
23
 
# File 'lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb', line 21

def interesting_nodes
  [:class, :defn]
end

#start_class(node) ⇒ Object

check class node to remember the ActionMailer class name.



30
31
32
 
# File 'lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb', line 30

def start_class(node)
  @klazz_name = node.class_name
end

#start_defn(node) ⇒ Object

check defn node and find if the corresponding views exist or not?



35
36
37
38
39
40
41
 
# File 'lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb', line 35

def start_defn(node)
  name = node.method_name
  return unless deliver_method?(name)
  if rails2_canonical_mailer_views?(name) || rails3_canonical_mailer_views?(name)
    add_error("use multipart/alternative as content_type of email")
  end
end

#url ⇒ Object 



17
18
19
 
# File 'lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb', line 17

def url
  "http://rails-bestpractices.com/posts/41-use-multipart-alternative-as-content_type-of-email"
end