rails_best_practices 0.2.2 → 0.2.3

data/README.textile

@@ -43,6 +43,7 @@ NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
 KeepFindersOnTheirOwnModelCheck: { }
 LawOfDemeterCheck: { }
+UseObserverCheck: { }
 </code></pre>
 
 *************************************************
@@ -73,7 +74,7 @@ h2. Progress
 ## DRY: metaprogramming
 ## Extract into Module
 ## Extract to composed class
-## Use Observer
+## [-Use Observer-]
 
 * Lesson 4. Migration
 ## Isolating Seed Data

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/lib/rails_best_practices/checks/law_of_demeter_check.rb

@@ -2,6 +2,11 @@ require 'rails_best_practices/checks/check'
 
 module RailsBestPractices
   module Checks
+    # Check to make sure not avoid the law of demeter.
+    # 
+    # Implementation: 
+    # 1. check all models to record belongs_to associations
+    # 2. check if calling belongs_to association's method or attribute
     class LawOfDemeterCheck < Check
       
       def interesting_nodes

data/lib/rails_best_practices/checks/use_observer_check.rb

@@ -0,0 +1,47 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a model file to make sure mail deliver method is in observer not callback.
+    #
+    # Implementation: 
+    # Record :after_create callback
+    # Check method define, if it is a callback and call deliver_xxx message in method body, then it should use observer.
+    class UseObserverCheck < Check
+
+      def interesting_nodes
+        [:defn, :call]
+      end
+
+      def interesting_files
+        /models\/.*rb/
+      end
+
+      def initialize
+        super
+        @callbacks = []
+      end
+
+      def evaluate_start(node)
+        if :after_create == node.message
+          remember_callbacks(node)
+        elsif :defn == node.node_type and @callbacks.include?(node.message_name.to_s)
+          add_error "use observer" if use_observer?(node)
+        end
+      end
+
+      private
+
+      def remember_callbacks(node)
+        @callbacks << eval(node.arguments.to_ruby).to_s
+      end
+
+      def use_observer?(node)
+        node.recursive_children do |child|
+          return true if :call == child.node_type and :const == child.subject.node_type and child.message.to_s =~ /^deliver_/
+        end
+        false
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks.rb

@@ -12,3 +12,4 @@ require 'rails_best_practices/checks/needless_deep_nesting_check'
 require 'rails_best_practices/checks/not_use_default_route_check'
 require 'rails_best_practices/checks/keep_finders_on_their_own_model_check'
 require 'rails_best_practices/checks/law_of_demeter_check'
+require 'rails_best_practices/checks/use_observer_check'

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -81,6 +81,12 @@ class Sexp
       self[3]
     end
   end
+
+  def message_name
+    if :defn == node_type
+      self[1]
+    end
+  end
   
   def method_body
     if :block == node_type

data/rails_best_practices.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2009-11-07}
+  s.date = %q{2009-11-08}
   s.default_executable = %q{rails_best_practices}
   s.description = %q{check rails files according to ihower's presentation 'rails best practices'}
   s.email = %q{flyerhzm@gmail.com}
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
      "lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb",
      "lib/rails_best_practices/checks/use_model_association_check.rb",
      "lib/rails_best_practices/checks/use_model_callback_check.rb",
+     "lib/rails_best_practices/checks/use_observer_check.rb",
      "lib/rails_best_practices/checks/use_scope_access_check.rb",
      "lib/rails_best_practices/command.rb",
      "lib/rails_best_practices/core.rb",
@@ -64,6 +65,7 @@ Gem::Specification.new do |s|
      "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",
+     "spec/rails_best_practices/checks/use_observer_check_spec.rb",
      "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -85,6 +87,7 @@ Gem::Specification.new do |s|
      "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
      "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
      "spec/rails_best_practices/checks/nested_model_forms_check_spec.rb",
+     "spec/rails_best_practices/checks/use_observer_check_spec.rb",
      "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
      "spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb",
      "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",

data/rails_best_practices.yml

@@ -12,3 +12,4 @@ NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
 KeepFindersOnTheirOwnModelCheck: { }
 LawOfDemeterCheck: { }
+UseObserverCheck: { }

data/spec/rails_best_practices/checks/use_observer_check_spec.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::UseObserverCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseObserverCheck.new)
+  end
+
+  it "should use observer" do
+    content =<<-EOF
+    class Project < ActiveRecord::Base
+      after_create :send_create_notification
+
+      private
+
+      def send_create_notification
+        self.members.each do |member|
+          ProjectMailer.deliver_notification(self, member)
+        end
+      end
+    end
+    EOF
+    @runner.check('app/models/project.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/models/project.rb:6 - use observer"
+  end
+
+  it "should not use observer without callback" do
+    content =<<-EOF
+    class Project < ActiveRecord::Base
+      private
+
+      def send_create_notification
+        self.members.each do |member|
+          ProjectMailer.deliver_notification(self, member)
+        end
+      end
+    end
+    EOF
+    @runner.check('app/models/project.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 +08:00
+date: 2009-11-08 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,6 +64,7 @@ files:
 - lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb
 - lib/rails_best_practices/checks/use_model_association_check.rb
 - lib/rails_best_practices/checks/use_model_callback_check.rb
+- lib/rails_best_practices/checks/use_observer_check.rb
 - lib/rails_best_practices/checks/use_scope_access_check.rb
 - lib/rails_best_practices/command.rb
 - lib/rails_best_practices/core.rb
@@ -87,6 +88,7 @@ files:
 - spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
 - spec/rails_best_practices/checks/use_model_association_check_spec.rb
 - spec/rails_best_practices/checks/use_model_callback_check_spec.rb
+- spec/rails_best_practices/checks/use_observer_check_spec.rb
 - spec/rails_best_practices/checks/use_scope_access_check_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -130,6 +132,7 @@ test_files:
 - spec/rails_best_practices/checks/law_of_demeter_check_spec.rb
 - spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
 - spec/rails_best_practices/checks/nested_model_forms_check_spec.rb
+- spec/rails_best_practices/checks/use_observer_check_spec.rb
 - spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb
 - spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb
 - spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb