rails_best_practices 1.5.3 → 1.6.0

data/lib/rails_best_practices/core/error.rb

@@ -16,6 +16,14 @@ module RailsBestPractices
         @url = url
       end
 
+      def short_filename
+        File.expand_path(filename)[File.expand_path(Core::Runner.base_path).size..-1].sub(/^\//, '')
+      end
+
+      def first_line_number
+        line_number.split(',').first
+      end
+
       def to_s
         "#{@filename}:#{@line_number} - #{@message}"
       end

data/lib/rails_best_practices/core/helpers.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    # Helper moduels.
+    class Helpers < Modules
+    end
+  end
+end

data/lib/rails_best_practices/core/modules.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    # Module container
+    class Modules < Array
+      # add module decendant.
+      #
+      # @param [String] module name
+      # @param [String] decendant name
+      def add_module_decendant(module_name, decendant)
+        mod = find { |mod| mod.to_s == module_name }
+        mod.add_decendant(decendant) if mod
+      end
+    end
+
+    # Module info include module name and module spaces.
+    class Mod
+      attr_reader :decendants
+
+      def initialize(module_name, modules)
+        @module_name = module_name
+        @modules = modules
+        @decendants = []
+      end
+
+      def add_decendant(decendant)
+        @decendants << decendant
+      end
+
+      def to_s
+        if @modules.empty?
+          @module_name
+        else
+          @modules.map { |modu| "#{modu}::" }.join("") + @module_name
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/core/runner.rb

@@ -115,10 +115,21 @@ module RailsBestPractices
         (@reviews + @lexicals).collect {|check| check.errors}.flatten
       end
 
+      def after_lexical; end
+
+      # provide a handler after all files reviewed.
+      def after_prepare
+        filename = "rails_best_practices.after_prepare"
+        content = "class RailsBestPractices::AfterPrepare; end"
+        node = parse_ruby(filename, content)
+        node.file = filename
+        node.prepare(@checker)
+      end
+
       # provide a handler after all files reviewed.
-      def on_complete
-        filename = "rails_best_practices.complete"
-        content = "class RailsBestPractices::Complete; end"
+      def after_review
+        filename = "rails_best_practices.after_review"
+        content = "class RailsBestPractices::AfterReview; end"
         node = parse_ruby(filename, content)
         node.file = filename
         node.review(@checker)

data/lib/rails_best_practices/prepares.rb

@@ -4,6 +4,7 @@ require 'rails_best_practices/prepares/mailer_prepare'
 require 'rails_best_practices/prepares/schema_prepare'
 require 'rails_best_practices/prepares/controller_prepare'
 require 'rails_best_practices/prepares/route_prepare'
+require 'rails_best_practices/prepares/helper_prepare'
 
 module RailsBestPractices
   module Prepares
@@ -40,6 +41,14 @@ module RailsBestPractices
         @controller_methods ||= Core::Methods.new
       end
 
+      def helpers
+        @helpers ||= Core::Helpers.new
+      end
+
+      def helper_methods
+        @helper_methods ||= Core::Methods.new
+      end
+
       def routes
         @routes ||= Core::Routes.new
       end

data/lib/rails_best_practices/prepares/controller_prepare.rb

@@ -5,9 +5,10 @@ module RailsBestPractices
   module Prepares
     # Remember controllers and controller methods
     class ControllerPrepare < Core::Check
-      include Core::Check::Klassable
+      include Core::Check::Classable
       include Core::Check::InheritedResourcesable
       include Core::Check::Accessable
+      include Core::Check::Afterable
 
       interesting_nodes :class, :var_ref, :command, :def
       interesting_files CONTROLLER_FILES
@@ -17,6 +18,7 @@ module RailsBestPractices
       def initialize
         @controllers = Prepares.controllers
         @methods = Prepares.controller_methods
+        @helpers = Prepares.helpers
         @inherited_resources = false
       end
 
@@ -47,11 +49,13 @@ module RailsBestPractices
 
       # restrict actions for inherited_resources
       def start_command(node)
-        if @inherited_resources && "actions" ==  node.message.to_s
+        if "include" == node.message.to_s
+          @helpers.add_module_decendant(node.arguments.all.first.to_s, current_class_name)
+        elsif @inherited_resources && "actions" ==  node.message.to_s
           if "all" == node.arguments.all.first.to_s
             @actions = DEFAULT_ACTIONS
             option_argument = node.arguments.all[1]
-            if :bare_assoc_hash == option_argument.sexp_type && option_argument.hash_value("except")
+            if option_argument && :bare_assoc_hash == option_argument.sexp_type && option_argument.hash_value("except")
               @actions -= option_argument.hash_value("except").to_object
             end
           else
@@ -76,6 +80,14 @@ module RailsBestPractices
         method_name = node.method_name.to_s
         @methods.add_method(current_class_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
       end
+
+      # ask Reviews::RemoveUnusedMoethodsInHelperReview to check the controllers who include helpers.
+      def after_prepare
+        decendants = @helpers.map(&:decendants).flatten
+        if decendants.present?
+          Reviews::RemoveUnusedMethodsInHelpersReview.interesting_files *decendants.map { |decendant| %r|#{decendant.underscore}| }
+        end
+      end
     end
   end
 end

data/lib/rails_best_practices/prepares/helper_prepare.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require 'rails_best_practices/core/check'
+
+module RailsBestPractices
+  module Prepares
+    # Remember helper methods.
+    class HelperPrepare < Core::Check
+      include Core::Check::Moduleable
+      include Core::Check::Accessable
+
+      interesting_nodes :def, :command
+      interesting_files HELPER_FILES, CONTROLLER_FILES
+
+      def initialize
+        @helpers = Prepares.helpers
+        @methods = Prepares.helper_methods
+      end
+
+      # check module node to remember the module name.
+      def start_module(node)
+        @helpers << Core::Mod.new(current_module_name, [])
+      end
+
+      # check def node to remember all methods.
+      #
+      # the remembered methods (@methods) are like
+      #     {
+      #       "PostsHelper" => {
+      #         "create_time" => {"file" => "app/helpers/posts_helper.rb", "line" => 10, "unused" => false},
+      #         "update_time" => {"file" => "app/helpers/posts_helper.rb", "line" => 10, "unused" => false}
+      #       }
+      #     }
+      def start_def(node)
+        if node.file =~ HELPER_FILES
+          method_name = node.method_name.to_s
+          @methods.add_method(current_module_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/prepares/mailer_prepare.rb

@@ -5,7 +5,7 @@ module RailsBestPractices
   module Prepares
     # Remember the mailer names.
     class MailerPrepare < Core::Check
-      include Core::Check::Klassable
+      include Core::Check::Classable
 
       interesting_nodes :class
       interesting_files MAILER_FILES, MODEL_FILES

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -5,7 +5,7 @@ module RailsBestPractices
   module Prepares
     # Remember models and model associations.
     class ModelPrepare < Core::Check
-      include Core::Check::Klassable
+      include Core::Check::Classable
       include Core::Check::Accessable
 
       interesting_nodes :class, :def, :command, :var_ref, :alias

data/lib/rails_best_practices/reviews.rb

@@ -28,3 +28,4 @@ require 'rails_best_practices/reviews/remove_empty_helpers_review'
 require 'rails_best_practices/reviews/restrict_auto_generated_routes_review'
 require 'rails_best_practices/reviews/remove_unused_methods_in_models_review'
 require 'rails_best_practices/reviews/remove_unused_methods_in_controllers_review'
+require 'rails_best_practices/reviews/remove_unused_methods_in_helpers_review'

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -24,7 +24,7 @@ module RailsBestPractices
     #   if there are any foreign keys not existed in index columns,
     #   then the foreign keys should add db index.
     class AlwaysAddDbIndexReview < Review
-      include Completeable
+      include Afterable
 
       interesting_nodes :command, :command_call
       interesting_files SCHEMA_FILE
@@ -73,7 +73,7 @@ module RailsBestPractices
       # compare foreign keys and index columns,
       # if there are any foreign keys not existed in index columns,
       # then we should add db index for that foreign keys.
-      def on_complete
+      def after_review
         remove_only_type_foreign_keys
         @foreign_keys.each do |table, foreign_key|
           table_node = @table_nodes[table]

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -3,9 +3,19 @@ require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
   module Reviews
+    # Find out unused methods in controllers.
+    #
+    # Implementation:
+    #
+    # Review process:
+    #   remember all method calls in controllers,
+    #   if they are not defined in routes,
+    #   and they are not called in controllers,
+    #   then they are the unused methods in controllers.
     class RemoveUnusedMethodsInControllersReview < Review
-      include Klassable
-      include Completeable
+      include Classable
+      include Moduleable
+      include Afterable
       include Callable
       include Exceptable
       include InheritedResourcesable
@@ -66,7 +76,7 @@ module RailsBestPractices
       alias :start_method_add_arg :start_command
 
       # get all unused methods at the end of review process.
-      def on_complete
+      def after_review
         @routes.each do |route|
           if "*" == route.action_name
             action_names = @controller_methods.get_methods(route.controller_name_with_namespaces).map(&:method_name)

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/review'
+
+module RailsBestPractices
+  module Reviews
+    # Find out unused methods in helpers.
+    #
+    # Implementation:
+    #
+    # Review process:
+    #   remember all method calls in helpers.
+    #   if they are not called in views or helpers,
+    #   then they are unused methods in helpers.
+    class RemoveUnusedMethodsInHelpersReview < Review
+      include Moduleable
+      include Afterable
+      include Callable
+      include Exceptable
+
+      interesting_files HELPER_FILES, VIEW_FILES
+
+      def initialize(options={})
+        super
+        @helper_methods = Prepares.helper_methods
+        self.class.interesting_files Prepares.helpers.map(&:decendants)
+      end
+
+      # get all unused methods at the end of review process
+      def after_review
+        @helper_methods.get_all_unused_methods.each do |method|
+          if !excepted?(method)
+            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line
+          end
+        end
+      end
+
+      protected
+        def methods
+          @helper_methods
+        end
+
+        def internal_except_methods
+          []
+        end
+    end
+  end
+end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -12,8 +12,8 @@ module RailsBestPractices
     #   at end, check if all defined methods are called,
     #   if not, non called methods are unused.
     class RemoveUnusedMethodsInModelsReview < Review
-      include Klassable
-      include Completeable
+      include Classable
+      include Afterable
       include Callable
       include Exceptable
 
@@ -41,7 +41,7 @@ module RailsBestPractices
       end
 
       # get all unused methods at the end of review process.
-      def on_complete
+      def after_review
         @model_methods.get_all_unused_methods.each do |method|
           if !excepted?(method) && method.method_name !~ /=$/
             add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.yml

@@ -29,3 +29,4 @@ RemoveTabCheck: { }
 RestrictAutoGeneratedRoutesCheck: { }
 RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
 RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
+RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }

data/spec/rails_best_practices/analyzer_spec.rb

@@ -11,9 +11,9 @@ describe RailsBestPractices::Analyzer do
   end
 
   describe "file_sort" do
-    it "should get models first, then mailers" do
-      files = ["app/controllers/users_controller.rb", "app/mailers/user_mailer.rb", "app/models/user.rb", "app/views/users/index.html.haml", "lib/user.rb"]
-      subject.file_sort(files).should == ["app/models/user.rb", "app/mailers/user_mailer.rb", "app/controllers/users_controller.rb", "app/views/users/index.html.haml", "lib/user.rb"]
+    it "should get models first, mailers, helpers and then others" do
+      files = ["app/controllers/users_controller.rb", "app/mailers/user_mailer.rb", "app/helpers/users_helper.rb", "app/models/user.rb", "app/views/users/index.html.haml", "lib/user.rb"]
+      subject.file_sort(files).should == ["app/models/user.rb", "app/mailers/user_mailer.rb", "app/helpers/users_helper.rb", "app/controllers/users_controller.rb", "app/views/users/index.html.haml", "lib/user.rb"]
     end
   end
 

data/spec/rails_best_practices/core/error_spec.rb

@@ -2,6 +2,15 @@ require 'spec_helper'
 
 describe RailsBestPractices::Core::Error do
   it "should return error with filename, line number and message" do
-    RailsBestPractices::Core::Error.new("app/models/user.rb", 100, "not good", "BogusReview").to_s.should == "app/models/user.rb:100 - not good"
+    RailsBestPractices::Core::Error.new("app/models/user.rb", "100", "not good", "BogusReview").to_s.should == "app/models/user.rb:100 - not good"
+  end
+
+  it "should return short filename" do
+    RailsBestPractices::Core::Runner.base_path = "../rails-bestpractices.com"
+    RailsBestPractices::Core::Error.new("../rails-bestpractices.com/app/models/user.rb", "100", "not good", "BogusReview").short_filename.should == "app/models/user.rb"
+  end
+
+  it "should return first line number" do
+    RailsBestPractices::Core::Error.new("app/models/user.rb", "50,70,100", "not good", "BogusReview").first_line_number.should == "50"
   end
 end

data/spec/rails_best_practices/core/helpers_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Core::Helpers do
+  it { should be_a_kind_of RailsBestPractices::Core::Modules }
+end

data/spec/rails_best_practices/core/modules_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Core::Modules do
+  it { should be_a_kind_of Array }
+
+  context "Modules" do
+    before do
+      @mod = RailsBestPractices::Core::Mod.new("PostsHelper", [])
+    end
+    subject { RailsBestPractices::Core::Modules.new.tap { |modules| modules << @mod } }
+    it "should add decendant to the corresponding module" do
+      @mod.should_receive(:add_decendant).with("PostsController")
+      subject.add_module_decendant("PostsHelper", "PostsController")
+    end
+  end
+
+  context "Mod" do
+    subject {
+      RailsBestPractices::Core::Mod.new("UsersHelper", ["Admin"]).tap do |mod|
+        mod.add_decendant("Admin::UsersController")
+      end
+    }
+    its(:to_s) { should == "Admin::UsersHelper" }
+    its(:decendants) { should == ["Admin::UsersController"] }
+  end
+end

data/spec/rails_best_practices/prepares/controller_prepare_spec.rb

@@ -1,7 +1,9 @@
 require 'spec_helper'
 
 describe RailsBestPractices::Prepares::ControllerPrepare do
-  let(:runner) { RailsBestPractices::Core::Runner.new(:prepares => RailsBestPractices::Prepares::ControllerPrepare.new) }
+  let(:runner) { RailsBestPractices::Core::Runner.new(
+    :prepares => [RailsBestPractices::Prepares::ControllerPrepare.new, RailsBestPractices::Prepares::HelperPrepare.new]
+  ) }
 
   before :each do
     runner.whiny = true
@@ -100,6 +102,17 @@ describe RailsBestPractices::Prepares::ControllerPrepare do
         methods.get_methods("PostsController").map(&:method_name).should == ["index", "new", "create", "edit", "update", "destroy"]
       end
 
+      it "extend inherited_resources with all actions with no arguments" do
+        content =<<-EOF
+        class PostsController < InheritedResources::Base
+          actions :all
+        end
+        EOF
+        runner.prepare('app/controllers/posts_controller.rb', content)
+        methods = RailsBestPractices::Prepares.controller_methods
+        methods.get_methods("PostsController").map(&:method_name).should == ["index", "show", "new", "create", "edit", "update", "destroy"]
+      end
+
       it "DSL inherit_resources" do
         content =<<-EOF
         class PostsController
@@ -112,4 +125,22 @@ describe RailsBestPractices::Prepares::ControllerPrepare do
       end
     end
   end
+
+  context "helpers" do
+    it "should add helper decendant" do
+      content =<<-EOF
+      module PostsHelper
+      end
+      EOF
+      runner.prepare('app/helpers/posts_helper.rb', content)
+      content =<<-EOF
+      class PostsController
+        include PostsHelper
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      helpers = RailsBestPractices::Prepares.helpers
+      helpers.first.decendants.should == ["PostsController"]
+    end
+  end
 end