rails_best_practices 0.2.0 → 0.2.6

data/README.textile

@@ -41,6 +41,11 @@ MoveModelLogicIntoModelCheck: { called_count: 4 }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
+KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }
+UseObserverCheck: { }
+IsolateSeedDataCheck: { }
+AlwaysAddDbIndexCheck: { }
 </code></pre>
 
 *************************************************
@@ -65,17 +70,17 @@ h2. Progress
 ## [-Not use default route-]
 
 * Lesson 3. Model
-## Keep Finders on Their Own Model
-## Love named_scope
-## the Law of Demeter
+## [-Keep Finders on Their Own Model-]
+## [-Love named_scope-] # same as Move finder to named_scope
+## [-the Law of Demeter-]
 ## DRY: metaprogramming
 ## Extract into Module
 ## Extract to composed class
-## Use Observer
+## [-Use Observer-]
 
 * Lesson 4. Migration
-## Isolating Seed Data
-## Always add DB index
+## [-Isolating Seed Data-]
+## [-Always add DB index-]
 
 * Lesson 5. Controller
 ## Use before_filter

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.6

data/lib/rails_best_practices/checks/always_add_db_index_check.rb

@@ -0,0 +1,83 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    class AlwaysAddDbIndexCheck < Check
+
+      def interesting_nodes
+        [:defs]
+      end
+
+      def interesting_files
+        /db\/migrate\/.*rb/
+      end
+
+      def initialize
+        super
+        @files = []
+        @references = {}
+        @indexes = {}
+        @parse = false
+      end
+
+      def evaluate_start(node)
+        if @files.include? node.file
+          @parse = true if :up == node.message
+        else
+          @files << node.file
+        end
+
+        if @parse and :up == node.message
+          @references.each do |table_name, column_names|
+            differences = column_names - (@indexes[table_name] || [])
+            hint = differences.collect {|column_name| "#{table_name} => #{column_name}"}.join(', ')
+            add_error "always add db index (#{hint})" unless differences.empty?
+          end
+        else
+          remember_references(node.body)
+          remember_indexes(node.body)
+        end
+      end
+
+      private
+
+      def remember_references(node)
+        create_table_node = node.grep_nodes({:node_type => :call, :message => :create_table}).first
+        if create_table_node
+          table_name = eval(create_table_node.arguments[1].to_ruby).to_s
+          node.grep_nodes({:node_type => :call, :message => :integer}).each do |integer_node|
+            column_name = eval(integer_node.arguments[1].to_ruby).to_s
+            if column_name =~ /_id$/
+              @references[table_name] ||= []
+              @references[table_name] << column_name
+            end
+          end
+          node.grep_nodes({:node_type => :call, :message => :references}).each do |references_node|
+            column_name = eval(references_node.arguments[1].to_ruby).to_s + "_id"
+            @references[table_name] ||= []
+            @references[table_name] << column_name
+          end
+          node.grep_nodes({:node_type => :call, :message => :column}).each do |column_node|
+            if 'integer' == eval(column_node.arguments[2].to_ruby).to_s
+              column_name = eval(column_node.arguments[1].to_ruby).to_s
+              if column_name =~ /_id$/
+                @references[table_name] ||= []
+                @references[table_name] << column_name
+              end
+            end
+          end
+        end
+      end
+
+      def remember_indexes(node)
+        add_index_nodes = node.grep_nodes({:node_type => :call, :message => :add_index})
+        add_index_nodes.each do |add_index_node|
+          table_name = eval(add_index_node.arguments[1].to_ruby).to_s
+          column_name = eval(add_index_node.arguments[2].to_ruby).to_s
+          @indexes[table_name] ||= []
+          @indexes[table_name] << column_name
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/check.rb

@@ -3,7 +3,7 @@ require 'rails_best_practices/core/error'
 module RailsBestPractices
   module Checks
     class Check
-      NODE_TYPES = [:call, :defn, :if, :unless]
+      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn]
 
       def initialize
         @errors = []

data/lib/rails_best_practices/checks/isolate_seed_data_check.rb

@@ -0,0 +1,46 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a migration file to make sure not to insert data in migration, move them to seed file.
+    #
+    # Implementation: check if there are :create, :create!, and :new with :save or :save! exist, the migration file needs isolate seed data.
+    class IsolateSeedDataCheck < Check
+
+      def interesting_nodes
+        [:call, :lasgn]
+      end
+
+      def interesting_files
+        /db\/migrate\/.*rb/
+      end
+
+      def initialize
+        super
+        @new_variables = []
+      end
+
+      def evaluate_start(node)
+        if [:create, :create!].include? node.message
+          add_error("isolate seed data")
+        elsif :lasgn == node.node_type
+          remember_new_variable(node)
+        elsif [:save, :save!].include? node.message
+          add_error("isolate seed data") if new_record?(node)
+        end
+      end
+
+      private
+
+      def remember_new_variable(node)
+        unless node.grep_nodes({:node_type => :call, :message => :new}).empty?
+          @new_variables << node.subject.to_s
+        end
+      end
+
+      def new_record?(node)
+        @new_variables.include? node.subject.to_ruby
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb

@@ -0,0 +1,29 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a model to make sure finders are on their own model.
+    #
+    # Implementation: check if :find is called by other model.
+    class KeepFindersOnTheirOwnModelCheck < Check
+      
+      def interesting_nodes
+        [:call]
+      end
+
+      def interesting_files
+        /models\/.*rb/
+      end
+
+      def evaluate_start(node)
+        add_error "keep finders on their own model" if others_finder?(node)
+      end
+
+      private
+
+      def others_finder?(node)
+        node.message == :find and node.subject.node_type == :call
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/law_of_demeter_check.rb

@@ -0,0 +1,47 @@
+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
+        [:call, :class]
+      end
+
+      def initialize
+        super
+        @associations = {}
+      end
+
+      def evaluate_start(node)
+        if node.node_type == :class
+          remember_belongs_to(node)
+        elsif [:lvar, :ivar].include?(node.subject.node_type) and node.subject != s(:lvar, :_erbout)
+          add_error "law of demeter" if need_delegate?(node)
+        end
+      end
+
+      private
+
+      def remember_belongs_to(node)
+        node.body.grep_nodes(:message => :belongs_to).collect do |body_node|
+          class_name = node.subject.to_s.underscore
+          @associations[class_name] ||= []
+          @associations[class_name] << eval(body_node.arguments[1].to_ruby).to_s
+        end
+      end
+
+      def need_delegate?(node)
+        @associations.each do |class_name, associations|
+          return true if node.subject.to_ruby =~ /#{class_name}$/ and associations.include? node.message.to_s
+        end
+        false
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/use_observer_check.rb

@@ -0,0 +1,49 @@
+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)
+        node.arguments[1..-1].each do |argument|
+          @callbacks << eval(argument.to_ruby).to_s
+        end
+      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/use_scope_access_check.rb

@@ -26,7 +26,7 @@ module RailsBestPractices
         
         condition_node.message == :== and 
         (current_user?(condition_node.arguments.call) or current_user?(condition_node.subject)) and 
-        (node.false_node.method_body.any? {|n| n.message == :redirect_to} or node.true_node.method_body.any? {|n| n.message == :redirect_to})
+        (node.false_node.body.any? {|n| n.message == :redirect_to} or node.true_node.method_body.any? {|n| n.message == :redirect_to})
       end
       
       def current_user?(call_node)
@@ -35,4 +35,4 @@ module RailsBestPractices
       
     end
   end
-end
+end

data/lib/rails_best_practices/checks.rb

@@ -9,4 +9,9 @@ require 'rails_best_practices/checks/many_to_many_collection_check'
 require 'rails_best_practices/checks/nested_model_forms_check'
 require 'rails_best_practices/checks/overuse_route_customizations_check'
 require 'rails_best_practices/checks/needless_deep_nesting_check'
-require 'rails_best_practices/checks/not_use_default_route_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'
+require 'rails_best_practices/checks/isolate_seed_data_check'
+require 'rails_best_practices/checks/always_add_db_index_check'

data/lib/rails_best_practices/command.rb

@@ -1,7 +1,8 @@
 require 'optparse'
 
 def expand_dirs_to_files *dirs
-  extensions = ['rb']
+  # extensions = ['rb', 'erb', 'builder']
+  extensions = ['rb', 'builder']
 
   dirs.flatten.map { |p|
     if File.directory? p
@@ -9,7 +10,26 @@ def expand_dirs_to_files *dirs
     else
       p
     end
-  }.flatten.sort
+  }.flatten.sort { |a, b|
+    # for law_of_demeter_check
+    if a =~ /models\/.*rb/
+      -1
+    elsif b =~ /models\/.*rb/
+      1
+    else
+      a <=> b
+    end
+  }
+end
+
+# for always_add_db_index_check
+def add_duplicate_migration_files files
+  migration_files = files.select { |file| file.index("db/migrate") }
+  (files << migration_files).flatten
+end
+
+def ignore_vendor_directories files
+  files.reject { |file| file.index("vendor/") }
 end
 
 options = {}
@@ -25,8 +45,8 @@ OptionParser.new do |opts|
 end
 
 runner = RailsBestPractices::Core::Runner.new
-expand_dirs_to_files(ARGV).each.each { |file| runner.check_file(file) }
+ignore_vendor_directories(add_duplicate_migration_files(expand_dirs_to_files(ARGV))).each { |file| runner.check_file(file) }
 runner.errors.each {|error| puts error}
 puts "\nFound #{runner.errors.size} errors."
 
-exit runner.errors.size
+exit runner.errors.size

data/lib/rails_best_practices/core/core_ext.rb

@@ -4,8 +4,19 @@ module Enumerable
   end
 end
 
+class String
+  # copy from rails
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end
+
 class NilClass
   def method_missing(method_sym, *arguments, &block)
     return nil
   end
-end
+end

data/lib/rails_best_practices/core/runner.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'ruby_parser'
+require 'erb'
 require 'yaml'
 
 module RailsBestPractices
@@ -21,6 +22,9 @@ module RailsBestPractices
       end
 
       def check(filename, content)
+        if filename =~ /.*erb/
+          content = ERB.new(content).src
+        end
         node = parse(filename, content)
         node.accept(@checker) if node
       end
@@ -45,7 +49,7 @@ module RailsBestPractices
         begin
           @parser.parse(content, filename)
         rescue Exception => e
-          puts "#{filename} looks like it's not a valid Ruby file.  Skipping..." if ENV["ROODI_DEBUG"]
+          puts "#{filename} looks like it's not a valid Ruby file.  Skipping..."
           nil
         end
       end

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -47,13 +47,13 @@ class Sexp
   end
   
   def subject
-    if [:attrasgn, :call, :iasgn, :lasgn].include? node_type
+    if [:attrasgn, :call, :iasgn, :lasgn, :class].include? node_type
       self[1]
     end
   end
   
   def message
-    if [:attrasgn, :call].include? node_type
+    if [:attrasgn, :call, :defs].include? node_type
       self[2]
     end
   end
@@ -81,15 +81,24 @@ class Sexp
       self[3]
     end
   end
+
+  def message_name
+    if :defn == node_type
+      self[1]
+    end
+  end
   
-  def method_body
+  def body
     if :block == node_type
       self[1..-1]
-    else
+    elsif :class == node_type
+      self[3]
+    elsif :defs == node_type
+      self[4]
     end
   end
 
   def to_ruby
-    Ruby2Ruby.new.process(self)
+    Ruby2Ruby.new.process(self) unless self.empty?
   end
 end

data/rails_best_practices.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.2.0"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2009-11-06}
+  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}
@@ -28,7 +28,11 @@ Gem::Specification.new do |s|
      "lib/rails_best_practices.rb",
      "lib/rails_best_practices/checks.rb",
      "lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb",
+     "lib/rails_best_practices/checks/always_add_db_index_check.rb",
      "lib/rails_best_practices/checks/check.rb",
+     "lib/rails_best_practices/checks/isolate_seed_data_check.rb",
+     "lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb",
+     "lib/rails_best_practices/checks/law_of_demeter_check.rb",
      "lib/rails_best_practices/checks/many_to_many_collection_check.rb",
      "lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb",
      "lib/rails_best_practices/checks/move_model_logic_into_model_check.rb",
@@ -39,6 +43,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",
@@ -50,6 +55,10 @@ Gem::Specification.new do |s|
      "rails_best_practices.gemspec",
      "rails_best_practices.yml",
      "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
+     "spec/rails_best_practices/checks/always_add_db_index_check_spec.rb",
+     "spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb",
+     "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
+     "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
      "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
      "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
      "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
@@ -60,6 +69,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"
@@ -73,15 +83,20 @@ Gem::Specification.new do |s|
     "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
      "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
      "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
+     "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",
+     "spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb",
      "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
      "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
+     "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",
+     "spec/rails_best_practices/checks/always_add_db_index_check_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/rails_best_practices.yml

@@ -10,3 +10,8 @@ MoveModelLogicIntoModelCheck: { called_count: 4 }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
+KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }
+UseObserverCheck: { }
+IsolateSeedDataCheck: { }
+AlwaysAddDbIndexCheck: { }

data/spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb

@@ -17,10 +17,28 @@ describe RailsBestPractices::Checks::AddModelVirtualAttributeCheck do
       end
     end
     EOF
-    @runner.check('app/controller/users_controller.rb', content)
+    @runner.check('app/controllers/users_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controller/users_controller.rb:3 - add model virtual attribute (for @user)"
+    errors[0].to_s.should == "app/controllers/users_controller.rb:3 - add model virtual attribute (for @user)"
+  end
+  
+  it "should add model virtual attribute with local assignment" do
+    content = <<-EOF
+    class UsersController < ApplicationController
+      
+      def create
+        user = User.new(params[:user])
+        user.first_name = params[:full_name].split(' ', 2).first
+        user.last_name = params[:full_name].split(' ', 2).last
+        user.save
+      end
+    end
+    EOF
+    @runner.check('app/controllers/users_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controllers/users_controller.rb:3 - add model virtual attribute (for user)"
   end
 
   it "should not add model virtual attribute with differen param" do
@@ -35,7 +53,7 @@ describe RailsBestPractices::Checks::AddModelVirtualAttributeCheck do
       end
     end
     EOF
-    @runner.check('app/controller/users_controller.rb', content)
+    @runner.check('app/controllers/users_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end
@@ -53,7 +71,7 @@ describe RailsBestPractices::Checks::AddModelVirtualAttributeCheck do
       end
     end
     EOF
-    @runner.check('app/controller/users_controller.rb', content)
+    @runner.check('app/controllers/users_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end