rails_best_practices 0.1.2 → 0.2.0

data/README.textile

@@ -15,7 +15,7 @@ sudo gem install rails_best_practices --source http://gemcutter.org
 
 h2. Usage
 
-at the root of rails
+at the root directory of rails app
 
 <pre><code>
 rails_best_practices .
@@ -23,6 +23,28 @@ rails_best_practices .
 
 *************************************************
 
+h2. Customize Configuration
+
+Copy <code>rails_best_practices.yml</code> in the root directory of rails_best_practices gem to <code>config</code> directory
+Now you can customize the configuration, the default configuration is as follows:
+
+<pre><code>
+MoveFinderToNamedScopeCheck: { }
+UseModelAssociationCheck: { }
+UseScopeAccessCheck: { }
+AddModelVirtualAttributeCheck: { }
+# UseModelCallbackCheck: { }
+ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
+MoveModelLogicIntoModelCheck: { called_count: 4 }
+# ManyToManyCollectionCheck: { }
+# NestedModelFormsCheck: { }
+OveruseRouteCustomizationsCheck: { customize_count: 3 }
+NeedlessDeepNestingCheck: { nested_count: 2 }
+NotUseDefaultRouteCheck: {  }
+</code></pre>
+
+*************************************************
+
 h2. Progress
 
 * Lesson 1. Move code from Controller to Model
@@ -39,8 +61,8 @@ h2. Progress
 
 * Lesson 2. RESTful Conventions
 ## [-Overuse route customizations-]
-## Needless deep nesting
-## Not use default route
+## [-Needless deep nesting-]
+## [-Not use default route-]
 
 * Lesson 3. Model
 ## Keep Finders on Their Own Model

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb

@@ -42,7 +42,7 @@ module RailsBestPractices
       def call_assignment(node)
         if node.message == :save
           variable = node.subject
-          add_error "add model virtual attribute" if params_dup?(@variables[variable].collect {|h| h[:arguments] })
+          add_error "add model virtual attribute (for #{node.subject.to_ruby})" if params_dup?(@variables[variable].collect {|h| h[:arguments] })
         end
       end
       
@@ -54,4 +54,4 @@ module RailsBestPractices
       end
     end
   end
-end
+end

data/lib/rails_best_practices/checks/move_model_logic_into_model_check.rb

@@ -29,8 +29,9 @@ module RailsBestPractices
             call_node(child)
           end
         end
-        if @variables.values.any? { |count| count > @called_count }
-          add_error "move model logic into model"
+        
+        @variables.each do |variable, count|
+          add_error "move model logic into model (#{variable.to_ruby} called_count > #{@called_count})" if count > @called_count
         end
         @variables = nil
       end
@@ -39,10 +40,10 @@ module RailsBestPractices
       
       def call_node(node)
         variable = node.subject
-        return if variable.nil?
+        return if variable.nil? or ![:lvar, :ivar].include? node.subject.node_type
         @variables[variable] ||= 0
         @variables[variable] += 1
       end
     end
   end
-end
+end

data/lib/rails_best_practices/checks/needless_deep_nesting_check.rb

@@ -0,0 +1,35 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check config/routes.rb to make sure not to use too deep nesting routes.
+    #
+    # Implementation: check nested route count, if more than nested_count, then it is needless deep nesting.
+    class NeedlessDeepNestingCheck < Check
+      
+      def interesting_nodes
+        [:call]
+      end
+
+      def interesting_files
+        /config\/routes.rb/
+      end
+
+      def initialize(options = {})
+        super()
+        @nested_count = options['nested_count'] || 2
+      end
+      
+      def evaluate_start(node)
+        if node.message == :resources
+          if node.subject == s(:call, nil, :map, s(:arglist))
+            @counter = 0
+          else
+            @counter += 1
+            add_error "needless deep nesting (nested_count > #{@nested_count})" if @counter >= @nested_count
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/not_use_default_route_check.rb

@@ -0,0 +1,26 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check config/routes to make sure not use default route that rails generated.
+    #
+    # Implementation: compare route sentence to see if it is equal to rails default route.
+    class NotUseDefaultRouteCheck < Check
+      
+      def interesting_nodes
+        [:call]
+      end
+      
+      def interesting_files
+        /config\/routes.rb/
+      end
+      
+      def evaluate_start(node)
+        if node == s(:call, s(:lvar, :map), :connect, s(:arglist, s(:str, ":controller/:action/:id"))) or
+           node == s(:call, s(:lvar, :map), :connect, s(:arglist, s(:str, ":controller/:action/:id.:format")))
+          add_error "not use default route"
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/overuse_route_customizations_check.rb

@@ -22,7 +22,7 @@ module RailsBestPractices
       
       def evaluate_start(node)
         if s(:lvar, :map) == node.subject and :resources == node.message
-          add_error "overuse route customizations" if member_and_collection_count(node) > @customize_count
+          add_error "overuse route customizations (customize_count > #{@customize_count})" if member_and_collection_count(node) > @customize_count
         end
       end
 

data/lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb

@@ -39,7 +39,7 @@ module RailsBestPractices
       
       def attribute_assignment(node)
         variable = node.subject
-        return if variable.nil?
+        return if variable.nil? or ![:lvar, :ivar].include? node.subject.node_type
         @variables[variable] ||= 0
         @variables[variable] += 1
       end
@@ -47,9 +47,9 @@ module RailsBestPractices
       def call_assignment(node)
         if node.message == :save
           variable = node.subject
-          add_error "replace complex creation with factory method" if @variables[variable] > @attrasgn_count
+          add_error "replace complex creation with factory method (#{variable.to_ruby} attribute_assignment_count > #{@attrasgn_count})" if @variables[variable] > @attrasgn_count
         end
       end
     end
   end
-end
+end

data/lib/rails_best_practices/checks/use_model_association_check.rb

@@ -39,9 +39,9 @@ module RailsBestPractices
       def call_assignment(node)
         if node.message == :save
           variable = node.subject[1]
-          add_error "use model association" if @variables[variable]
+          add_error "use model association (for #{node.subject.to_ruby})" if @variables[variable]
         end
       end
     end
   end
-end
+end

data/lib/rails_best_practices/checks.rb

@@ -7,4 +7,6 @@ require 'rails_best_practices/checks/replace_complex_creation_with_factory_metho
 require 'rails_best_practices/checks/move_model_logic_into_model_check'
 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/overuse_route_customizations_check'
+require 'rails_best_practices/checks/needless_deep_nesting_check'
+require 'rails_best_practices/checks/not_use_default_route_check'

data/lib/rails_best_practices/core/runner.rb

@@ -6,9 +6,14 @@ module RailsBestPractices
   module Core
     class Runner
       DEFAULT_CONFIG = File.join(File.dirname(__FILE__), "..", "..", "..", "rails_best_practices.yml")
+      CUSTOM_CONFIG = File.join('config', 'rails_best_practices.yml')
       
       def initialize(*checks)
-        @config = DEFAULT_CONFIG
+        if File.exists?(CUSTOM_CONFIG)
+          @config = CUSTOM_CONFIG
+        else
+          @config = DEFAULT_CONFIG
+        end
         @checks = checks unless checks.empty?
         @checks ||= load_checks
         @checker ||= CheckingVisitor.new(@checks)

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -47,56 +47,43 @@ class Sexp
   end
   
   def subject
-    case node_type
-    when :attrasgn, :call, :iasgn, :lasgn
+    if [:attrasgn, :call, :iasgn, :lasgn].include? node_type
       self[1]
-    else
     end
   end
   
   def message
-    case node_type
-    when :attrasgn, :call
+    if [:attrasgn, :call].include? node_type
       self[2]
-    else
     end
   end
   
   def arguments
-    case node_type
-    when :attrasgn, :call
+    if [:attrasgn, :call].include? node_type
       self[3]
-    else
     end
   end
   
   def call
-    case node_type
-    when :if, :arglist
+    if [:if, :arglist].include? node_type
       self[1]
-    else
     end
   end
   
   def true_node
-    case node_type
-    when :if
+    if :if == node_type
       self[2]
-    else
     end
   end
   
   def false_node
-    case node_type
-    when :if
+    if :if == node_type
       self[3]
-    else
     end
   end
   
   def method_body
-    case node_type
-    when :block
+    if :block == node_type
       self[1..-1]
     else
     end

data/rails_best_practices.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.1.2"
+  s.version = "0.2.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-05}
+  s.date = %q{2009-11-06}
   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}
@@ -32,7 +32,9 @@ Gem::Specification.new do |s|
      "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",
+     "lib/rails_best_practices/checks/needless_deep_nesting_check.rb",
      "lib/rails_best_practices/checks/nested_model_forms_check.rb",
+     "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/use_model_association_check.rb",
@@ -51,7 +53,9 @@ Gem::Specification.new do |s|
      "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",
+     "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/use_model_association_check_spec.rb",
@@ -67,6 +71,7 @@ Gem::Specification.new do |s|
   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/many_to_many_collection_check_spec.rb",
@@ -75,6 +80,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/nested_model_forms_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/spec_helper.rb"
   ]

data/rails_best_practices.yml

@@ -8,3 +8,5 @@ MoveModelLogicIntoModelCheck: { called_count: 4 }
 # ManyToManyCollectionCheck: { }
 # NestedModelFormsCheck: { }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
+NeedlessDeepNestingCheck: { nested_count: 2 }
+NotUseDefaultRouteCheck: {  }

data/spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb

@@ -20,7 +20,7 @@ describe RailsBestPractices::Checks::AddModelVirtualAttributeCheck do
     @runner.check('app/controller/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"
+    errors[0].to_s.should == "app/controller/users_controller.rb:3 - add model virtual attribute (for @user)"
   end
 
   it "should not add model virtual attribute with differen param" do
@@ -57,4 +57,4 @@ describe RailsBestPractices::Checks::AddModelVirtualAttributeCheck do
     errors = @runner.errors
     errors.should be_empty
   end
-end
+end

data/spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb

@@ -26,7 +26,7 @@ describe RailsBestPractices::Checks::MoveModelLogicIntoModelCheck do
     @runner.check('app/controller/posts_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - move model logic into model"
+    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - move model logic into model (@post called_count > 4)"
   end
 
   it "should not move model logic into model with simple model calling" do

data/spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::NeedlessDeepNestingCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::NeedlessDeepNestingCheck.new)
+  end
+  
+  it "should needless deep nesting" do
+    content = <<-EOF
+    map.resources :posts do |post|
+      post.resources :comments do |comment|
+        comment.resources :favorites
+      end
+    end
+    EOF
+    @runner.check('config/routes.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "config/routes.rb:3 - needless deep nesting (nested_count > 2)"
+  end
+
+  it "should no needless deep nesting" do
+    content = <<-EOF
+    map.resources :posts do |post|
+      post.resources :comments
+    end
+    
+    map.resources :comments do |comment|
+      comment.resources :favorites
+    end
+    EOF
+    @runner.check('config/routes.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/not_use_default_route_check_spec.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::NotUseDefaultRouteCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::NotUseDefaultRouteCheck.new)
+  end
+  
+  it "should not use default route" do
+    content = <<-EOF
+    ActionController::Routing::Routes.draw do |map|
+      map.resources :posts, :member => { :push => :post }
+      
+      map.connect ':controller/:action/:id'
+      map.connect ':controller/:action/:id.:format'
+    end
+    EOF
+    @runner.check('config/routes.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "config/routes.rb:4 - not use default route"
+    errors[1].to_s.should == "config/routes.rb:5 - not use default route"
+  end
+
+  it "should no not use default route" do
+    content = <<-EOF
+    ActionController::Routing::Routes.draw do |map|
+      map.resources :posts, :member => { :push => :post }
+    end
+    EOF
+    @runner.check('config/routes.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb

@@ -17,7 +17,7 @@ describe RailsBestPractices::Checks::OveruseRouteCustomizationsCheck do
     @runner.check('config/routes.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations"
+    errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
   end
   
   it "should overuse route customizations with collection" do
@@ -32,7 +32,7 @@ describe RailsBestPractices::Checks::OveruseRouteCustomizationsCheck do
     @runner.check('config/routes.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations"
+    errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
   end
   
   it "should not overuse route customizations without customization" do

data/spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb

@@ -28,7 +28,7 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
     @runner.check('app/controller/invoices_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controller/invoices_controller.rb:3 - replace complex creation with factory method"
+    errors[0].to_s.should == "app/controller/invoices_controller.rb:3 - replace complex creation with factory method (@invoice attribute_assignment_count > 2)"
   end
 
   it "should not replace complex creation with factory method with simple creation" do

data/spec/rails_best_practices/checks/use_model_association_check_spec.rb

@@ -19,7 +19,7 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
     @runner.check('app/controller/posts_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - use model association"
+    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - use model association (for @post)"
   end
 
   it "should not use model association without association assign" do
@@ -51,7 +51,7 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
     @runner.check('app/controller/posts_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - use model association"
+    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - use model association (for post)"
   end
 
   it "should not use model association" do
@@ -68,4 +68,4 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
     errors = @runner.errors
     errors.should be_empty
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-05 00:00:00 +08:00
+date: 2009-11-06 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,9 @@ files:
 - 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
+- lib/rails_best_practices/checks/needless_deep_nesting_check.rb
 - lib/rails_best_practices/checks/nested_model_forms_check.rb
+- 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/use_model_association_check.rb
@@ -74,7 +76,9 @@ files:
 - 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
+- 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/use_model_association_check_spec.rb
@@ -112,6 +116,7 @@ specification_version: 3
 summary: check rails files according to ihower's presentation 'rails best practices'
 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/many_to_many_collection_check_spec.rb
@@ -120,5 +125,6 @@ test_files:
 - 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_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/spec_helper.rb