rails_best_practices 0.8.2 → 0.9.0

data/README.md

@@ -110,6 +110,7 @@ Now you can customize this configuration file, the default configuration is as f
     UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
     SimplifyRenderInViewsCheck: {}
     SimplifyRenderInControllersCheck: {}
+    RemoveEmptyHelpersCheck: {}
 
 You can remove or comment one review to disable it, and you can change the options.
 
@@ -151,6 +152,11 @@ Migration
 Controller
 
 1. Use before_filter
+2. Simplify render in controllers
+
+Helper
+
+1. Remove empty helpers
 
 View
 

data/lib/rails_best_practices/core/check.rb

@@ -4,9 +4,9 @@ module RailsBestPractices
     # A Check class that takes charge of checking the sexp.
     class Check
       # only nodes whose node_type is in NODE_TYPE will be reviewed.
-      NODE_TYPES = [:call, :defn, :defs, :if, :class, :lasgn, :iasgn, :ivar, :lvar, :block, :iter, :const]
+      NODE_TYPES = [:call, :defn, :defs, :if, :class, :module, :lasgn, :iasgn, :ivar, :lvar, :block, :iter, :const]
 
-      CONTROLLER_FILES = /_controller\.rb$/
+      CONTROLLER_FILES = /controllers\/.*\.rb$/
       MIGRATION_FILES = /db\/migrate\/.*\.rb$/
       MODEL_FILES = /models\/.*\.rb$/
       MAILER_FILES = /models\/.*mailer\.rb$|mailers\/.*mailer\.rb/
@@ -14,6 +14,7 @@ module RailsBestPractices
       PARTIAL_VIEW_FILES = /views\/.*\/_.*\.(erb|haml)$/
       ROUTE_FILE = /config\/routes\.rb/
       SCHEMA_FILE = /db\/schema\.rb/
+      HELPER_FILES = /helpers.*\.rb$/
 
       attr_reader :errors
 

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -388,6 +388,8 @@ class Sexp
       self[3]
     elsif :class == node_type
       self[3][1]
+    elsif :module == node_type
+      self[2][1]
     elsif :defn == node_type
       self[3][1]
     end

data/lib/rails_best_practices/reviews.rb

@@ -24,3 +24,4 @@ require 'rails_best_practices/reviews/use_query_attribute_review'
 require 'rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review'
 require 'rails_best_practices/reviews/simplify_render_in_views_review'
 require 'rails_best_practices/reviews/simplify_render_in_controllers_review'
+require 'rails_best_practices/reviews/remove_empty_helpers_review'

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/review'
+
+module RailsBestPractices
+  module Reviews
+    # Review a helper file to make sure it is not an empty moduel.
+    #
+    # See the best practice details here http://rails-bestpractices.com/posts/72-remove-empty-helpers.
+    #
+    # Implementation:
+    #
+    # Review process:
+    #   check all helper files, if the body of module is nil, then the helper file should be removed.
+    class RemoveEmptyHelpersReview < Review
+      def url
+        "http://rails-bestpractices.com/posts/72-remove-empty-helpers"
+      end
+
+      def interesting_files
+        HELPER_FILES
+      end
+
+      def interesting_nodes
+        [:module]
+      end
+
+      # check the body of module node, if it is nil, then it should be removed.
+      def start_module(module_node)
+        add_error "remove empty helpers" if module_node.body.is_a?(Core::Nil)
+      end
+    end
+  end
+end

data/lib/rails_best_practices/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "0.8.2"
+  VERSION = "0.9.0"
 end
 

data/rails_best_practices.yml

@@ -24,3 +24,4 @@ RemoveTrailingWhitespaceCheck: { }
 UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
 SimplifyRenderInViewsCheck: {}
 SimplifyRenderInControllersCheck: {}
+RemoveEmptyHelpersCheck: {}

data/spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::RemoveEmptyHelpersReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::RemoveEmptyHelpersReview.new) }
+
+  it "should remove empty helpers" do
+    content =<<-EOF
+    module PostsHelper
+    end
+    EOF
+    runner.review('app/helpers/posts_helper.rb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:1 - remove empty helpers"
+  end
+
+  it "should not remove empty helpers" do
+    content =<<-EOF
+    module PostsHelper
+      def post_link(post)
+        post_path(post)
+      end
+    end
+    EOF
+    runner.review('app/helpers/posts_helper.rb', content)
+    runner.should have(0).errors
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-25 00:00:00 +08:00
+date: 2011-05-15 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -193,6 +193,7 @@ files:
 - lib/rails_best_practices/reviews/needless_deep_nesting_review.rb
 - lib/rails_best_practices/reviews/not_use_default_route_review.rb
 - lib/rails_best_practices/reviews/overuse_route_customizations_review.rb
+- lib/rails_best_practices/reviews/remove_empty_helpers_review.rb
 - lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb
 - lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb
 - lib/rails_best_practices/reviews/review.rb
@@ -236,6 +237,7 @@ files:
 - spec/rails_best_practices/reviews/needless_deep_nesting_review_spec.rb
 - spec/rails_best_practices/reviews/not_use_default_route_review_spec.rb
 - spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb
+- spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb
 - spec/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review_spec.rb
 - spec/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review_spec.rb
 - spec/rails_best_practices/reviews/review_spec.rb
@@ -278,7 +280,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -784982188954262945
+      hash: 251922047825024421
       segments: 
       - 0
       version: "0"
@@ -323,6 +325,7 @@ test_files:
 - spec/rails_best_practices/reviews/needless_deep_nesting_review_spec.rb
 - spec/rails_best_practices/reviews/not_use_default_route_review_spec.rb
 - spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb
+- spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb
 - spec/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review_spec.rb
 - spec/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review_spec.rb
 - spec/rails_best_practices/reviews/review_spec.rb