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::ALL_FILES, Core::Check::CONTROLLER_FILES, Core::Check::DEPLOY_FILES, Core::Check::HELPER_FILES, Core::Check::MAILER_FILES, Core::Check::MIGRATION_FILES, Core::Check::MODEL_FILES, Core::Check::PARTIAL_VIEW_FILES, Core::Check::ROUTE_FILES, Core::Check::SCHEMA_FILE, Core::Check::VIEW_FILES

Instance Method Summary collapse

Methods inherited from Review

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

Methods inherited from Core::Check

add_callback, #add_error, #after_prepare, #after_review, callbacks, #errors, #increment_total_files_checked!, #initialize, interesting_files, #interesting_files, #interesting_nodes, interesting_nodes, #method_missing, #node_end, #node_start, #parse_file?, #result, #total_files_checked

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

#start_class(node) ⇒ Object

check class node to remember the ActionMailer class name.



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

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

#start_def(node) ⇒ Object

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



30
31
32
33
34
35
36
 
# File 'lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb', line 30

def start_def(node)
  name = node.method_name.to_s
  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 



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

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