rails_best_practices 0.2.0 → 0.3.0

data/lib/rails_best_practices/command.rb

@@ -1,7 +1,7 @@
 require 'optparse'
 
 def expand_dirs_to_files *dirs
-  extensions = ['rb']
+  extensions = ['rb', 'erb', 'builder']
 
   dirs.flatten.map { |p|
     if File.directory? p
@@ -9,13 +9,46 @@ def expand_dirs_to_files *dirs
     else
       p
     end
-  }.flatten.sort
+  }.flatten
+end
+
+# for law_of_demeter_check
+def model_first_sort files
+  files.sort { |a, b|
+    if a =~ /models\/.*rb/
+      -1
+    elsif b =~ /models\/.*rb/
+      1
+    else
+      a <=> b
+    end
+  }
+end
+
+# for always_add_db_index_check
+def add_duplicate_migrations files
+  migration_files = files.select { |file| file.index("db/migrate") }
+  (files << migration_files).flatten
+end
+
+def ignore_files files, pattern
+  files.reject { |file| file.index(pattern) }
 end
 
 options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: rails_best_practices [options]"
   
+  opts.on("-d", "--debug", "Debug mode") do
+    options['debug'] = true
+  end
+
+  ['vendor', 'spec', 'test', 'stories'].each do |pattern|
+    opts.on("--#{pattern}", "include #{pattern} files") do
+      options[pattern] = true
+    end
+  end
+
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
@@ -25,8 +58,20 @@ OptionParser.new do |opts|
 end
 
 runner = RailsBestPractices::Core::Runner.new
-expand_dirs_to_files(ARGV).each.each { |file| runner.check_file(file) }
+runner.set_debug if options['debug']
+
+files = expand_dirs_to_files(ARGV)
+files = model_first_sort(files)
+files = add_duplicate_migrations(files)
+['vendor', 'spec', 'test', 'stories'].each do |pattern|
+  files = ignore_files(files, "#{pattern}/") unless options[pattern]
+end
+files.each { |file| runner.check_file(file) }
+
 runner.errors.each {|error| puts error}
-puts "\nFound #{runner.errors.size} errors."
+if runner.errors.size > 0
+  puts "\ngo to http://wiki.github.com/flyerhzm/rails_best_practices to see how to solve these errors."
+  puts "\nFound #{runner.errors.size} errors."
+end
 
-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
@@ -17,10 +18,17 @@ module RailsBestPractices
         @checks = checks unless checks.empty?
         @checks ||= load_checks
         @checker ||= CheckingVisitor.new(@checks)
-        @parser = RubyParser.new
+        @debug = false
+      end
+      
+      def set_debug
+        @debug = true
       end
 
       def check(filename, content)
+        if filename =~ /.*erb/
+          content = ERB.new(content).src
+        end
         node = parse(filename, content)
         node.accept(@checker) if node
       end
@@ -42,10 +50,11 @@ module RailsBestPractices
       private
 
       def parse(filename, content)
+        puts filename if @debug
         begin
-          @parser.parse(content, filename)
+          RubyParser.new.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..." if @debug
           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,31 @@ 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 :defn == node_type
+      self[3][1]
+    elsif :defs == node_type
+      self[4][1]
     end
   end
 
   def to_ruby
-    Ruby2Ruby.new.process(self)
+    Ruby2Ruby.new.process(self) unless self.empty?
+  end
+  
+  def to_ruby_string
+    return nil if self.empty?
+    eval(Ruby2Ruby.new.process(self)).to_s
   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.3.0"
 
   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-10}
   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,8 +28,14 @@ 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_code_into_controller_check.rb",
+     "lib/rails_best_practices/checks/move_code_into_helper_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",
      "lib/rails_best_practices/checks/needless_deep_nesting_check.rb",
@@ -37,8 +43,11 @@ Gem::Specification.new do |s|
      "lib/rails_best_practices/checks/not_use_default_route_check.rb",
      "lib/rails_best_practices/checks/overuse_route_customizations_check.rb",
      "lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb",
+     "lib/rails_best_practices/checks/replace_instance_variable_with_local_variable_check.rb",
+     "lib/rails_best_practices/checks/use_filter_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,7 +59,13 @@ 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_code_into_controller_check_spec.rb",
+     "spec/rails_best_practices/checks/move_code_into_helper_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",
      "spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb",
@@ -58,8 +73,11 @@ Gem::Specification.new do |s|
      "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
      "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
      "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
+     "spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb",
+     "spec/rails_best_practices/checks/use_filter_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"
@@ -70,18 +88,27 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{check rails files according to ihower's presentation 'rails best practices'}
   s.test_files = [
-    "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/use_model_callback_check_spec.rb",
+    "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/use_model_association_check_spec.rb",
-     "spec/rails_best_practices/checks/move_model_logic_into_model_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/move_code_into_controller_check_spec.rb",
+     "spec/rails_best_practices/checks/move_code_into_helper_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",
      "spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb",
+     "spec/rails_best_practices/checks/nested_model_forms_check_spec.rb",
+     "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
      "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
+     "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
+     "spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb",
+     "spec/rails_best_practices/checks/use_filter_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_helper.rb"
   ]
 
@@ -90,15 +117,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ruby_parser>, [">= 0"])
-      s.add_runtime_dependency(%q<ruby2ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<ruby_parser>, [">= 2.0.4"])
+      s.add_runtime_dependency(%q<ruby2ruby>, [">= 1.2.4"])
     else
-      s.add_dependency(%q<ruby_parser>, [">= 0"])
-      s.add_dependency(%q<ruby2ruby>, [">= 0"])
+      s.add_dependency(%q<ruby_parser>, [">= 2.0.4"])
+      s.add_dependency(%q<ruby2ruby>, [">= 1.2.4"])
     end
   else
-    s.add_dependency(%q<ruby_parser>, [">= 0"])
-    s.add_dependency(%q<ruby2ruby>, [">= 0"])
+    s.add_dependency(%q<ruby_parser>, [">= 2.0.4"])
+    s.add_dependency(%q<ruby2ruby>, [">= 1.2.4"])
   end
 end
 

data/rails_best_practices.yml

@@ -10,3 +10,12 @@ MoveModelLogicIntoModelCheck: { called_count: 4 }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
+KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }
+UseObserverCheck: { }
+IsolateSeedDataCheck: { }
+AlwaysAddDbIndexCheck: { }
+UseFilterCheck: { }
+MoveCodeIntoControllerCheck: { }
+MoveCodeIntoHelperCheck: { }
+ReplaceInstanceVariableWithLocalVariableCheck: { }

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,42 @@ 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
+
+  it "should add model virtual attribute with two dimension params" do
+    content = <<-EOF
+    class UsersController < ApplicationController
+
+      def create
+        @user = User.new(params[:user])
+        @user.first_name = params[:user][:full_name].split(' ', 2).first
+        @user.last_name = params[:user][: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 no add model virtual attribute with two dimension params" do
+    content = <<-EOF
+    class UsersController < ApplicationController
+
+      def create
+        @user = User.new(params[:user])
+        @user.first_name = params[:user][:first_name]
+        @user.last_name = params[:user][:last_name]
+        @user.save
+      end
+    end
+    EOF
+    @runner.check('app/controllers/users_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end

data/spec/rails_best_practices/checks/always_add_db_index_check_spec.rb

@@ -0,0 +1,153 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::AlwaysAddDbIndexCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::AlwaysAddDbIndexCheck.new)
+  end
+
+  it "should always add db index" do
+    content = <<-EOF
+    class CreateComments < ActiveRecord::Migration
+      def self.up
+        create_table "comments", :force => true do |t|
+          t.string :content
+          t.integer :post_id
+          t.integer :user_id
+        end
+      end
+
+      def self.down
+        drop_table "comments"
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => post_id, comments => user_id)"
+  end
+
+  it "should always add db index with column has no id" do
+    content = <<-EOF
+    class CreateComments < ActiveRecord::Migration
+      def self.up
+        create_table "comments", :force => true do |t|
+          t.string :content
+          t.integer :position
+        end
+      end
+
+      def self.down
+        drop_table "comments"
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should always add db index with references" do
+    content = <<-EOF
+    class CreateComments < ActiveRecord::Migration
+      def self.up
+        create_table "comments", :force => true do |t|
+          t.string :content
+          t.references :post
+          t.references :user
+        end
+      end
+
+      def self.down
+        drop_table "comments"
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => post_id, comments => user_id)"
+  end
+
+  it "should always add db index with column" do
+    content = <<-EOF
+    class CreateComments < ActiveRecord::Migration
+      def self.up
+        create_table "comments", :force => true do |t|
+          t.string :content
+          t.column :post_id, :integer
+          t.column :user_id, :integer
+        end
+      end
+
+      def self.down
+        drop_table "comments"
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => post_id, comments => user_id)"
+  end
+
+  it "should not always add db index with add_index" do
+    content = <<-EOF
+    class CreateComments < ActiveRecord::Migration
+      def self.up
+        create_table "comments", :force => true do |t|
+          t.string :content
+          t.integer :post_id
+          t.integer :user_id
+        end
+
+        add_index :comments, :post_id
+        add_index :comments, :user_id
+      end
+
+      def self.down
+        drop_table "comments"
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not always add db index with add_index in another migration file" do
+    content = <<-EOF
+    class CreateComments < ActiveRecord::Migration
+      def self.up
+        create_table "comments", :force => true do |t|
+          t.string :content
+          t.integer :post_id
+          t.integer :user_id
+        end
+      end
+
+      def self.down
+        drop_table "comments"
+      end
+    end
+    EOF
+    add_index_content = <<-EOF
+    class AddIndexesToComments < ActiveRecord::Migration
+      def self.up
+        add_index :comments, :post_id
+        add_index :comments, :user_id
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    @runner.check('db/migrate/20090919130258_add_indexes_to_comments.rb', content)
+    @runner.check('db/migrate/20090918130258_create_comments.rb', content)
+    @runner.check('db/migrate/20090919130258_add_indexes_to_comments.rb', content)
+    errors = @runner.errors
+  end
+end

data/spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb

@@ -0,0 +1,79 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::IsolateSeedDataCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::IsolateSeedDataCheck.new)
+  end
+
+  it "should isolate seed data" do
+    content = <<-EOF
+    class CreateRoles < ActiveRecord::Migration
+      def self.up
+        create_table "roles", :force => true do |t|
+          t.string :name
+        end
+
+        ["admin", "author", "editor", "account"].each do |name|
+          Role.create!(:name => name)
+        end
+      end
+
+      def self.down
+        drop_table "roles"
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20090818130258_create_roles.rb', content)
+    @runner.check('db/migrate/20090818130258_create_roles.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:8 - isolate seed data"
+    errors.size.should == 1
+  end
+  
+  it "should isolate seed data with new and save" do
+    content = <<-EOF
+    class CreateRoles < ActiveRecord::Migration
+      def self.up
+        create_table "roles", :force => true do |t|
+          t.string :name
+        end
+  
+        ["admin", "author", "editor", "account"].each do |name|
+          role = Role.new(:name => name)
+          role.save!
+        end
+      end
+  
+      def self.down
+        drop_table "roles"
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20090818130258_create_roles.rb', content)
+    @runner.check('db/migrate/20090818130258_create_roles.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:9 - isolate seed data"
+  end
+  
+  it "should not isolate seed data without data insert" do
+    content = <<-EOF
+    class CreateRoles < ActiveRecord::Migration
+      def self.up
+        create_table "roles", :force => true do |t|
+          t.string :name
+        end
+      end
+  
+      def self.down
+        drop_table "roles"
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20090818130258_create_roles.rb', content)
+    @runner.check('db/migrate/20090818130258_create_roles.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end