rails_best_practices 1.5.3 → 1.6.0

data/spec/rails_best_practices/prepares/helper_prepare_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Prepares::HelperPrepare do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:parepare => RailsBestPractices::Prepares::HelperPrepare.new) }
+
+  context "methods" do
+    it "should parse helper methods" do
+      content =<<-EOF
+      module PostsHelper
+        def used; end
+        def unused; end
+      end
+      EOF
+      runner.prepare('app/helpers/posts_helper.rb', content)
+      methods = RailsBestPractices::Prepares.helper_methods
+      methods.get_methods("PostsHelper").map(&:method_name).should == ["used", "unused"]
+    end
+
+    it "should parse helpers" do
+      content =<<-EOF
+      module PostsHelper
+      end
+      EOF
+      runner.prepare('app/helpers/posts_helper.rb', content)
+      content =<<-EOF
+      module Admin::UsersHelper
+      end
+      EOF
+      runner.prepare('app/helpers/users_helper.rb', content)
+      content =<<-EOF
+      module Admin
+        module BaseHelper
+        end
+      end
+      EOF
+      runner.prepare("app/helpers/base_helper.rb", content)
+      helpers = RailsBestPractices::Prepares.helpers
+      helpers.map(&:to_s).should == ["PostsHelper", "Admin::UsersHelper", "Admin", "Admin::BaseHelper"]
+    end
+  end
+end

data/spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb

@@ -16,7 +16,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(2).errors
     runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (comments => [post_id])"
     runner.errors[1].to_s.should == "db/schema.rb:2 - always add db index (comments => [user_id])"
@@ -33,7 +33,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(1).errors
     runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])"
   end
@@ -49,7 +49,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(1).errors
     runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])"
   end
@@ -67,7 +67,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(1).errors
     runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (taggings => [taggable_id, taggable_type])"
   end
@@ -85,7 +85,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(1).errors
     runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (taggings => [tag_id])"
   end
@@ -102,7 +102,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(1).errors
     runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (websites => [user_id])"
   end
@@ -117,7 +117,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(0).errors
   end
 
@@ -135,7 +135,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(0).errors
   end
 
@@ -148,7 +148,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(0).errors
   end
 
@@ -165,7 +165,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(0).errors
   end
 
@@ -182,7 +182,7 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     end
     EOF
     runner.review('db/schema.rb', content)
-    runner.on_complete
+    runner.after_review
     runner.should have(0).errors
   end
 end

data/spec/rails_best_practices/reviews/remove_unused_methods_in_controllers_review_spec.rb

@@ -25,7 +25,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       EOF
       runner.prepare('app/controllers/posts_controller.rb', content)
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(2).errors
       runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:4 - remove unused methods (PostsController#load_post)"
       runner.errors[1].to_s.should == "app/controllers/posts_controller.rb:6 - remove unused methods (PostsController#load_user)"
@@ -49,7 +49,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       EOF
       runner.prepare('app/controllers/posts_controller.rb', content)
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -74,7 +74,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       EOF
       runner.prepare('app/controllers/posts_controller.rb', content)
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -96,7 +96,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       EOF
       runner.prepare('app/controllers/posts_controller.rb', content)
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end
@@ -117,7 +117,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       EOF
       runner.prepare('app/controllers/posts_controller.rb', content)
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
       runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - remove unused methods (PostsController#list)"
     end
@@ -138,7 +138,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       EOF
       runner.prepare('app/controllers/internal_controller.rb', content)
       runner.review('app/controllers/internal_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -150,7 +150,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       EOF
       runner.prepare('app/controllers/exceptable_controller.rb', content)
       runner.review('app/controllers/exceptable_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end
@@ -166,7 +166,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       EOF
       runner.prepare('app/controllers/posts_controller.rb', content)
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
       runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:4 - remove unused methods (PostsController#helper_post)"
     end
@@ -185,7 +185,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       <%= helper_post %>
       EOF
       runner.review('app/views/posts/show.html.erb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -207,7 +207,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       end
       EOF
       runner.review('app/helpers/posts_helper.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end
@@ -228,7 +228,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       end
       EOF
       runner.review('app/helpers/posts_helper.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
       runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - remove unused methods (PostsController#helper_post)"
     end
@@ -252,7 +252,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       <%= helper_post("new") %>
       EOF
       runner.review('app/views/posts/show.html.erb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end
@@ -266,7 +266,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       EOF
       runner.prepare('app/cells/posts_cell.rb', content)
       runner.review('app/cells/posts_cell.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
       runner.errors[0].to_s.should == "app/cells/posts_cell.rb:2 - remove unused methods (PostsCell#list)"
     end
@@ -285,7 +285,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       <%= render_cell(:posts, :display) %>
       EOF
       runner.review('app/views/posts/index.html.erb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -307,7 +307,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       <%= render_cell :posts, :list %>
       EOF
       runner.review('app/views/posts/index.html.erb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end

data/spec/rails_best_practices/reviews/remove_unused_methods_in_helpers_review_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::RemoveUnusedMethodsInHelpersReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(
+    :prepares => [RailsBestPractices::Prepares::ControllerPrepare.new, RailsBestPractices::Prepares::HelperPrepare.new],
+    :reviews => RailsBestPractices::Reviews::RemoveUnusedMethodsInHelpersReview.new(:except_methods => [])
+  ) }
+
+  it "should remove unused methods" do
+    content =<<-EOF
+    module PostsHelper
+      def unused; end
+    end
+    EOF
+    runner.prepare('app/helpers/posts_helper.rb', content)
+    runner.review('app/helpers/posts_helper.rb', content)
+    runner.after_review
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:2 - remove unused methods (PostsHelper#unused)"
+  end
+
+  it "should not remove unused methods if called on views" do
+    content =<<-EOF
+    module PostsHelper
+      def used?(post); end
+    end
+    EOF
+    runner.prepare('app/helpers/posts_helper.rb', content)
+    runner.review('app/helpers/posts_helper.rb', content)
+    content =<<-EOF
+    <% if used?(@post) %>
+    <% end %>
+    EOF
+    runner.review('app/views/posts/show.html.erb', content)
+    runner.after_review
+    runner.should have(0).errors
+  end
+
+  it "should not remove unused methods if called on helpers" do
+    content =<<-EOF
+    module PostsHelper
+      def used?(post)
+        test?(post)
+      end
+
+      def test?(post); end
+    end
+    EOF
+    runner.prepare('app/helpers/posts_helper.rb', content)
+    runner.review('app/helpers/posts_helper.rb', content)
+    content =<<-EOF
+    <% if used?(@post) %>
+    <% end %>
+    EOF
+    runner.review('app/views/posts/show.html.erb', content)
+    runner.after_review
+    runner.should have(0).errors
+  end
+
+  it "should not remove unused methods if called on controllers" do
+    helper_content =<<-EOF
+    module PostsHelper
+      def used?(post); end
+    end
+    EOF
+    controller_content =<<-EOF
+    class PostsController < InheritedResources::Base
+      include PostsHelper
+
+      def show
+        @post = Post.find(params[:id])
+        used?(@post)
+      end
+    end
+    EOF
+    runner.prepare('app/helpers/posts_helper.rb', helper_content)
+    runner.prepare('app/controllers/posts_controller.rb', controller_content)
+    runner.after_prepare
+    runner.review('app/helpers/posts_helper.rb', helper_content)
+    runner.review('app/controllers/posts_controller.rb', controller_content)
+    runner.after_review
+    runner.should have(0).errors
+  end
+end

data/spec/rails_best_practices/reviews/remove_unused_methods_in_models_review_spec.rb

@@ -25,7 +25,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
       runner.errors[0].to_s.should == "app/models/post.rb:4 - remove unused methods (Post#find_by_sql)"
     end
@@ -38,7 +38,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare('app/models/post.rb', content)
       runner.review('app/models/post.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -62,7 +62,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -76,7 +76,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare('app/models/post.rb', content)
       runner.review('app/models/post.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -100,7 +100,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -124,7 +124,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -150,7 +150,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -164,7 +164,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare('app/models/post.rb', content)
       runner.review('app/models/post.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -178,7 +178,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare('app/models/post.rb', content)
       runner.review('app/models/post.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -191,7 +191,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare('app/models/post.rb', content)
       runner.review('app/models/post.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end
@@ -204,7 +204,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.prepare('app/models/post.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
       runner.errors[0].to_s.should == "app/models/post.rb:2 - remove unused methods (Post#fetch)"
     end
@@ -224,7 +224,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -236,7 +236,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare('app/models/post.rb', content)
       runner.review('app/models/post.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -256,7 +256,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -276,7 +276,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -297,7 +297,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
     end
 
@@ -318,7 +318,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
     end
   end
@@ -341,7 +341,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
       runner.errors[0].to_s.should == "app/models/post.rb:3 - remove unused methods (Post#test)"
     end
@@ -372,7 +372,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review('app/controllers/posts_controller.rb', content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end
@@ -394,7 +394,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review("app/controllers/posts_controller.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -406,7 +406,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare("app/models/post.rb", content)
       runner.review("app/models/post.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
       runner.errors[0].to_s.should == "app/models/post.rb:2 - remove unused methods (Post#active)"
     end
@@ -429,7 +429,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review("app/controllers/posts_controller.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -441,7 +441,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare("app/models/post.rb", content)
       runner.review("app/models/post.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(1).errors
       runner.errors[0].to_s.should == "app/models/post.rb:2 - remove unused methods (Post#active)"
     end
@@ -465,7 +465,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review("app/controllers/posts_controller.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -486,7 +486,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review("app/controllers/posts_controller.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -507,7 +507,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review("app/controllers/posts_controller.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -528,7 +528,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       end
       EOF
       runner.review("app/controllers/posts_controller.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end
@@ -546,7 +546,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare("app/models/post.rb", content)
       runner.review("app/models/post.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end
@@ -565,7 +565,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare("app/models/post.rb", content)
       runner.review("app/models/post.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end
@@ -582,7 +582,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare("app/models/post.rb", content)
       runner.review("app/models/post.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
 
@@ -599,7 +599,7 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       EOF
       runner.prepare("app/models/post.rb", content)
       runner.review("app/models/post.rb", content)
-      runner.on_complete
+      runner.after_review
       runner.should have(0).errors
     end
   end