rails_best_practices 0.2.0 → 0.2.1

data/README.textile

@@ -41,6 +41,7 @@ MoveModelLogicIntoModelCheck: { called_count: 4 }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
+KeepFindersOnTheirOwnModelCheck: { }
 </code></pre>
 
 *************************************************
@@ -65,7 +66,7 @@ h2. Progress
 ## [-Not use default route-]
 
 * Lesson 3. Model
-## Keep Finders on Their Own Model
+## [-Keep Finders on Their Own Model-]
 ## Love named_scope
 ## the Law of Demeter
 ## DRY: metaprogramming

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/rails_best_practices/checks.rb

@@ -9,4 +9,5 @@ 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'

data/lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb

@@ -0,0 +1,26 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    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/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.1"
 
   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-07}
   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}
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "lib/rails_best_practices/checks.rb",
      "lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb",
      "lib/rails_best_practices/checks/check.rb",
+     "lib/rails_best_practices/checks/keep_finders_on_their_own_model_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",
@@ -50,6 +51,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/keep_finders_on_their_own_model_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",
@@ -73,6 +75,7 @@ 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/many_to_many_collection_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_association_check_spec.rb",

data/rails_best_practices.yml

@@ -10,3 +10,4 @@ MoveModelLogicIntoModelCheck: { called_count: 4 }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
+KeepFindersOnTheirOwnModelCheck: { }

data/spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb

@@ -17,10 +17,10 @@ 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 not add model virtual attribute with differen param" do
@@ -35,7 +35,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 +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

data/spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb

@@ -0,0 +1,71 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::KeepFindersOnTheirOwnModelCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::KeepFindersOnTheirOwnModelCheck.new)
+  end
+
+  it "should keep finders on thier own model" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+      has_many :comments
+
+      def find_valid_comments
+        self.comment.find(:all, :conditions => { :is_spam => false }, 
+                                :limit => 10)
+      end
+    end
+    EOF
+    @runner.check('app/models/post.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/models/post.rb:5 - keep finders on their own model"
+  end
+
+  it "should not keep finders on thier own model with self finder" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+      has_many :comments
+
+      def find_valid_comments
+        self.find(:all, :conditions => { :is_spam => false }, 
+                                :limit => 10)
+      end
+    end
+    EOF
+    @runner.check('app/models/post.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not keep finders on thier own model with own finder" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+      has_many :comments
+
+      def find_valid_comments
+        Post.find(:all, :conditions => { :is_spam => false }, 
+                                :limit => 10)
+      end
+    end
+    EOF
+    @runner.check('app/models/post.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not keep finders on thier own model without finder" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+      has_many :comments
+
+      def find_valid_comments
+        self.comments.destroy_all
+      end
+    end
+    EOF
+    @runner.check('app/models/post.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb

@@ -20,11 +20,11 @@ describe RailsBestPractices::Checks::MoveFinderToNamedScopeCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.size.should == 2
-    errors[0].to_s.should == "app/controller/posts_controller.rb:4 - move finder to named_scope"
-    errors[1].to_s.should == "app/controller/posts_controller.rb:8 - move finder to named_scope"
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:4 - move finder to named_scope"
+    errors[1].to_s.should == "app/controllers/posts_controller.rb:8 - move finder to named_scope"
   end
   
   it "should not move simple finder" do
@@ -41,7 +41,7 @@ describe RailsBestPractices::Checks::MoveFinderToNamedScopeCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     @runner.errors.should be_empty
   end
   
@@ -55,7 +55,7 @@ describe RailsBestPractices::Checks::MoveFinderToNamedScopeCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     @runner.errors.should be_empty
   end
   
@@ -79,4 +79,4 @@ describe RailsBestPractices::Checks::MoveFinderToNamedScopeCheck do
     @runner.errors.should be_empty
     
   end
-end
+end

data/spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb

@@ -23,10 +23,10 @@ describe RailsBestPractices::Checks::MoveModelLogicIntoModelCheck do
       redirect_to post_url(@post)
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/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 (@post called_count > 4)"
+    errors[0].to_s.should == "app/controllers/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
@@ -42,8 +42,8 @@ describe RailsBestPractices::Checks::MoveModelLogicIntoModelCheck do
       redirect_to post_url(@post)
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end
-end
+end

data/spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb

@@ -25,10 +25,10 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
       end
     end
     EOF
-    @runner.check('app/controller/invoices_controller.rb', content)
+    @runner.check('app/controllers/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 (@invoice attribute_assignment_count > 2)"
+    errors[0].to_s.should == "app/controllers/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
@@ -43,7 +43,7 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
       end
     end
     EOF
-    @runner.check('app/controller/invoices_controller.rb', content)
+    @runner.check('app/controllers/invoices_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end
@@ -69,8 +69,8 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
     end
     EOF
     @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck.new('attribute_assignment_count' => 5))
-    @runner.check('app/controller/invoices_controller.rb', content)
+    @runner.check('app/controllers/invoices_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end
-end
+end

data/spec/rails_best_practices/checks/use_model_association_check_spec.rb

@@ -16,10 +16,10 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/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 (for @post)"
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - use model association (for @post)"
   end
 
   it "should not use model association without association assign" do
@@ -32,7 +32,7 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end
@@ -48,10 +48,10 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/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 (for post)"
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - use model association (for post)"
   end
 
   it "should not use model association" do
@@ -64,7 +64,7 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end

data/spec/rails_best_practices/checks/use_scope_access_check_spec.rb

@@ -20,10 +20,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:7 - use scope access"
     end
 
     it "shoud use scope access by comparing with id" do
@@ -40,10 +40,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:7 - use scope access"
     end
 
     it "shoud use scope access with current_user ==" do
@@ -60,10 +60,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:7 - use scope access"
     end
 
     it "shoud use scope access by current_user.id ==" do
@@ -80,10 +80,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:7 - use scope access"
     end
   end
 
@@ -102,10 +102,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:6 - use scope access"
     end
 
     it "shoud use scope access by comparing with id" do
@@ -122,10 +122,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:6 - use scope access"
     end
 
     it "shoud use scope access with current_user ==" do
@@ -142,10 +142,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:6 - use scope access"
     end
 
     it "shoud use scope access by current_user.id ==" do
@@ -162,10 +162,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:6 - use scope access"
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-06 00:00:00 +08:00
+date: 2009-11-07 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,7 @@ files:
 - lib/rails_best_practices/checks.rb
 - lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb
 - lib/rails_best_practices/checks/check.rb
+- lib/rails_best_practices/checks/keep_finders_on_their_own_model_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
@@ -73,6 +74,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/keep_finders_on_their_own_model_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
@@ -118,6 +120,7 @@ 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/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/many_to_many_collection_check_spec.rb
 - spec/rails_best_practices/checks/use_model_association_check_spec.rb