rails_best_practices 0.2.4 → 0.2.5

data/README.textile

@@ -45,6 +45,7 @@ KeepFindersOnTheirOwnModelCheck: { }
 LawOfDemeterCheck: { }
 UseObserverCheck: { }
 IsolateSeedDataCheck: { }
+AlwaysAddDbIndexCheck: { }
 </code></pre>
 
 *************************************************
@@ -79,7 +80,7 @@ h2. Progress
 
 * Lesson 4. Migration
 ## [-Isolating Seed Data-]
-## Always add DB index
+## [-Always add DB index-]
 
 * Lesson 5. Controller
 ## Use before_filter

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/lib/rails_best_practices/checks.rb

@@ -14,3 +14,4 @@ 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/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, :class, :lasgn]
+      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn]
 
       def initialize
         @errors = []

data/lib/rails_best_practices/checks/law_of_demeter_check.rb

@@ -29,7 +29,7 @@ module RailsBestPractices
       private
 
       def remember_belongs_to(node)
-        node.class_body.grep_nodes(:message => :belongs_to).collect do |body_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

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/command.rb

@@ -9,7 +9,22 @@ 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
 
 options = {}
@@ -25,7 +40,7 @@ OptionParser.new do |opts|
 end
 
 runner = RailsBestPractices::Core::Runner.new
-expand_dirs_to_files(ARGV).each.each { |file| runner.check_file(file) }
+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."
 

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -53,7 +53,7 @@ class Sexp
   end
   
   def message
-    if [:attrasgn, :call].include? node_type
+    if [:attrasgn, :call, :defs].include? node_type
       self[2]
     end
   end
@@ -88,15 +88,13 @@ class Sexp
     end
   end
   
-  def method_body
+  def body
     if :block == node_type
       self[1..-1]
-    end
-  end
-
-  def class_body
-    if :class == node_type
+    elsif :class == node_type
       self[3]
+    elsif :defs == node_type
+      self[4]
     end
   end
 

data/rails_best_practices.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
@@ -28,6 +28,7 @@ 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",
@@ -54,6 +55,7 @@ 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",
@@ -94,6 +96,7 @@ Gem::Specification.new do |s|
      "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

@@ -14,3 +14,4 @@ KeepFindersOnTheirOwnModelCheck: { }
 LawOfDemeterCheck: { }
 UseObserverCheck: { }
 IsolateSeedDataCheck: { }
+AlwaysAddDbIndexCheck: { }

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Richard Huang
@@ -51,6 +51,7 @@ files:
 - 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
@@ -77,6 +78,7 @@ files:
 - 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
@@ -139,4 +141,5 @@ test_files:
 - 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