rails_best_practices 1.5.0 → 1.5.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.5.0)
+    rails_best_practices (1.5.1)
       activesupport
       colored
       erubis

data/lib/rails_best_practices/core/check.rb

@@ -172,6 +172,11 @@ module RailsBestPractices
           @klass.extend_class_name
         end
 
+        # get the current module name.
+        def current_module_name
+          modules.join("::")
+        end
+
         # modules.
         def modules
           @moduels ||= []
@@ -215,11 +220,16 @@ module RailsBestPractices
               mark_used(node)
             end
 
+            # skip start_command callback for these nodes
+            def skip_command_callback_nodes
+              []
+            end
+
             # remember the message of command node.
             # remember the argument of alias_method and alias_method_chain as well.
             add_callback "start_command" do |node|
               case node.message.to_s
-              when "named_scope", "scope"
+              when *skip_command_callback_nodes
                 # nothing
               when "alias_method"
                 mark_used(node.arguments.all[1])

data/lib/rails_best_practices/core/methods.rb

@@ -75,7 +75,28 @@ module RailsBestPractices
         end
       end
 
-      # remomber the method name, the method is probably be used for the class' public method.
+      # Mark the method as public.
+      #
+      # @param [String] class name
+      # @param [String] method name
+      def mark_publicize(class_name, method_name)
+        method = get_method(class_name, method_name)
+        method.publicize if method
+      end
+
+      # Mark parent classs' method as public.
+      #
+      # @param [String] class name
+      # @param [String] method name
+      def mark_parent_class_methods_publicize(class_name, method_name)
+        klass = Prepares.klasses.find { |klass| klass.to_s == class_name }
+        if klass && klass.extend_class_name
+          mark_parent_class_methods_publicize(klass.extend_class_name, method_name)
+          mark_publicize(class_name, method_name)
+        end
+      end
+
+      # Remomber the method name, the method is probably be used for the class' public method.
       #
       # @param [String] method name
       def possible_public_used(method_name)
@@ -133,10 +154,15 @@ module RailsBestPractices
         @used = false
       end
 
-      # Mark this method as used.
+      # Mark the method as used.
       def mark_used
         @used = true
       end
+
+      # Mark the method as public
+      def publicize
+        @access_control = "public"
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -11,7 +11,7 @@ module RailsBestPractices
       include InheritedResourcesable
 
       interesting_nodes :class, :command, :method_add_arg
-      interesting_files CONTROLLER_FILES, VIEW_FILES
+      interesting_files CONTROLLER_FILES, VIEW_FILES, HELPER_FILES
 
       INHERITED_RESOURCES_METHODS = %w(resource collection begin_of_association_chain build_resource)
 
@@ -31,6 +31,12 @@ module RailsBestPractices
         end
       end
 
+      # skip render and around_filter nodes for start_command callbacks.
+      def skip_command_callback_nodes
+        %w(render_cell render around_filter)
+      end
+
+      # mark corresponding action as used for cells' render and render_call.
       def start_command(node)
         case node.message.to_s
         when "render_cell"
@@ -42,6 +48,18 @@ module RailsBestPractices
             action_name = first_argument.hash_value("state").to_s
             call_method(action_name, current_class_name)
           end
+        when "around_filter"
+          node.arguments.all.each { |argument| mark_used(argument) }
+        when "helper_method"
+          node.arguments.all.each { |argument| mark_publicize(argument.to_s) }
+        when "delegate"
+          last_argument = node.arguments.all.last
+          if :bare_assoc_hash == last_argument.sexp_type && "controller" == last_argument.hash_value("to").to_s
+            controller_name = current_module_name.sub("Helper", "Controller")
+            node.arguments.all[0..-2].each { |method| mark_publicize(method.to_s, controller_name) }
+          end
+        else
+          # nothing
         end
       end
 
@@ -72,6 +90,11 @@ module RailsBestPractices
         def internal_except_methods
           %w(rescue_action).map { |method_name| "*\##{method_name}" }
         end
+
+        def mark_publicize(method_name, class_name=current_class_name)
+          @controller_methods.mark_publicize(class_name, method_name)
+          @controller_methods.mark_parent_class_methods_publicize(class_name, method_name)
+        end
     end
   end
 end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -17,6 +17,7 @@ module RailsBestPractices
       include Callable
       include Exceptable
 
+      interesting_nodes :command
       interesting_files ALL_FILES
 
       def initialize(options={})
@@ -24,6 +25,21 @@ module RailsBestPractices
         @model_methods = Prepares.model_methods
       end
 
+      # skip scope and validate nodes for start_command callbacks.
+      def skip_command_callback_nodes
+        %w(named_scope scope validate validate_on_create validate_on_update)
+      end
+
+      # mark validate methods as used.
+      def start_command(node)
+        case node.message.to_s
+        when "validate", "validate_on_create", "validate_on_update"
+          node.arguments.all.each { |argument| mark_used(argument) }
+        else
+          # nothing
+        end
+      end
+
       # get all unused methods at the end of review process.
       def on_complete
         @model_methods.get_all_unused_methods.each do |method|
@@ -39,7 +55,7 @@ module RailsBestPractices
         end
 
         def internal_except_methods
-          %w(initialize validate to_xml to_json assign_attributes after_find after_initialize).map { |method_name| "*\##{method_name}" }
+          %w(initialize validate validate_each to_xml to_json assign_attributes after_find after_initialize).map { |method_name| "*\##{method_name}" }
         end
     end
   end

data/lib/rails_best_practices/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/spec/rails_best_practices/reviews/remove_unused_methods_in_controllers_review_spec.rb

@@ -53,6 +53,31 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
       runner.should have(0).errors
     end
 
+    it "should not remove unused methods for around_filter" do
+      content =<<-EOF
+      RailsBestPracticesCom::Application.routes.draw do
+        resources :posts
+      end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      content =<<-EOF
+      class PostsController < ActiveRecord::Base
+        around_filter :set_timestamp
+        protected
+          def set_timestamp
+            Time.zone = "Pacific Time (US & Canada)"
+            yield
+          ensure
+            Time.zone = "UTC"
+          end
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      runner.review('app/controllers/posts_controller.rb', content)
+      runner.on_complete
+      runner.should have(0).errors
+    end
+
     it "should not remove inherited_resources methods" do
       content =<<-EOF
       RailsBestPracticesCom::Application.routes.draw do
@@ -130,6 +155,108 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInControllersReview do
     end
   end
 
+  context "helper_method" do
+    it "should remove unused methods if helper method is not called" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+        helper_method :helper_post
+        protected
+          def helper_post; end
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      runner.review('app/controllers/posts_controller.rb', content)
+      runner.on_complete
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:4 - remove unused methods (PostsController#helper_post)"
+    end
+
+    it "should not remove unused methods if call helper method in views" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+        helper_method :helper_post
+        protected
+          def helper_post; end
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      runner.review('app/controllers/posts_controller.rb', content)
+      content = <<-EOF
+      <%= helper_post %>
+      EOF
+      runner.review('app/views/posts/show.html.erb', content)
+      runner.on_complete
+      runner.should have(0).errors
+    end
+
+    it "should not remove unused methods if call helper method in helpers" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+        helper_method :helper_post
+        protected
+          def helper_post; end
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      runner.review('app/controllers/posts_controller.rb', content)
+      content = <<-EOF
+      module PostsHelper
+        def new_post
+          helper_post
+        end
+      end
+      EOF
+      runner.review('app/helpers/posts_helper.rb', content)
+      runner.on_complete
+      runner.should have(0).errors
+    end
+  end
+
+  context "delegate :to => :controller" do
+    it "should remove unused methods if delegate method is not called" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+        protected
+          def helper_post(type); end
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      runner.review('app/controllers/posts_controller.rb', content)
+      content = <<-EOF
+      module PostsHelper
+        delegate :helper_post, :to => :controller
+      end
+      EOF
+      runner.review('app/helpers/posts_helper.rb', content)
+      runner.on_complete
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - remove unused methods (PostsController#helper_post)"
+    end
+
+    it "should remove unused methods if delegate method is called" do
+      content = <<-EOF
+      class PostsController < ApplicationController
+        protected
+          def helper_post(type); end
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      runner.review('app/controllers/posts_controller.rb', content)
+      content = <<-EOF
+      module PostsHelper
+        delegate :helper_post, :to => :controller
+      end
+      EOF
+      runner.review('app/helpers/posts_helper.rb', content)
+      content = <<-EOF
+      <%= helper_post("new") %>
+      EOF
+      runner.review('app/views/posts/show.html.erb', content)
+      runner.on_complete
+      runner.should have(0).errors
+    end
+  end
+
   context "cells" do
     it "should remove unused methods" do
       content =<<-EOF

data/spec/rails_best_practices/reviews/remove_unused_methods_in_models_review_spec.rb

@@ -550,4 +550,57 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       runner.should have(0).errors
     end
   end
+
+  context "callbacks" do
+    it "should not remove unused method" do
+      content =<<-EOF
+      class Post < ActiveRecord::Base
+        before_save :init_columns
+        after_destroy :remove_dependencies
+
+        protected
+          def init_columns; end
+          def remove_dependencies; end
+      end
+      EOF
+      runner.prepare("app/models/post.rb", content)
+      runner.review("app/models/post.rb", content)
+      runner.on_complete
+      runner.should have(0).errors
+    end
+  end
+
+  context "validates" do
+    it "should not remove unused method" do
+      content =<<-EOF
+      class Post < ActiveRecord::Base
+        validate :valid_birth_date
+
+        protected
+          def valid_birth_date; end
+      end
+      EOF
+      runner.prepare("app/models/post.rb", content)
+      runner.review("app/models/post.rb", content)
+      runner.on_complete
+      runner.should have(0).errors
+    end
+
+    it "should not remove unused method for validate_on_create and validate_on_update" do
+      content =<<-EOF
+      class Post < ActiveRecord::Base
+        validate_on_create :valid_email
+        validate_on_update :valid_birth_date
+
+        protected
+          def valid_email; end
+          def valid_birth_date; end
+      end
+      EOF
+      runner.prepare("app/models/post.rb", content)
+      runner.review("app/models/post.rb", content)
+      runner.on_complete
+      runner.should have(0).errors
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-26 00:00:00.000000000Z
+date: 2011-11-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
-  requirement: &70247886541600 !ruby/object:Gem::Requirement
+  requirement: &70264679380100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70247886541600
+  version_requirements: *70264679380100
 - !ruby/object:Gem::Dependency
   name: progressbar
-  requirement: &70247886540700 !ruby/object:Gem::Requirement
+  requirement: &70264679364420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70247886540700
+  version_requirements: *70264679364420
 - !ruby/object:Gem::Dependency
   name: colored
-  requirement: &70247886540000 !ruby/object:Gem::Requirement
+  requirement: &70264679363200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70247886540000
+  version_requirements: *70264679363200
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &70247886539360 !ruby/object:Gem::Requirement
+  requirement: &70264679361180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70247886539360
+  version_requirements: *70264679361180
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70247886538640 !ruby/object:Gem::Requirement
+  requirement: &70264679359900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70247886538640
+  version_requirements: *70264679359900
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70247886537980 !ruby/object:Gem::Requirement
+  requirement: &70264679358160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70247886537980
+  version_requirements: *70264679358160
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70247886537200 !ruby/object:Gem::Requirement
+  requirement: &70264679356880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247886537200
+  version_requirements: *70264679356880
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70247886536480 !ruby/object:Gem::Requirement
+  requirement: &70264679355940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247886536480
+  version_requirements: *70264679355940
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70247886535760 !ruby/object:Gem::Requirement
+  requirement: &70264679354960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247886535760
+  version_requirements: *70264679354960
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70247886534860 !ruby/object:Gem::Requirement
+  requirement: &70264679353820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247886534860
+  version_requirements: *70264679353820
 - !ruby/object:Gem::Dependency
   name: spork
-  requirement: &70247886533880 !ruby/object:Gem::Requirement
+  requirement: &70264679351020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -131,10 +131,10 @@ dependencies:
         version: 0.9.0.rc9
   type: :development
   prerelease: false
-  version_requirements: *70247886533880
+  version_requirements: *70264679351020
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70247886532280 !ruby/object:Gem::Requirement
+  requirement: &70264679348780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247886532280
+  version_requirements: *70264679348780
 - !ruby/object:Gem::Dependency
   name: guard-spork
-  requirement: &70247886531300 !ruby/object:Gem::Requirement
+  requirement: &70264679326140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247886531300
+  version_requirements: *70264679326140
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70247886530520 !ruby/object:Gem::Requirement
+  requirement: &70264679325060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247886530520
+  version_requirements: *70264679325060
 description: a code metric tool for rails codes, written in Ruby.
 email:
 - flyerhzm@gmail.com
@@ -324,7 +324,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3104358296029422528
+      hash: -1541278919148785467
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: