rails_best_practices 1.0.1 → 1.1.0

data/lib/rails_best_practices/prepares/mailer_prepare.rb

@@ -5,9 +5,10 @@ module RailsBestPractices
   module Prepares
     # Remember the mailer names.
     class MailerPrepare < Core::Check
+      include Core::Check::Classable
 
       def interesting_nodes
-        [:class]
+        [:class, :module]
       end
 
       def interesting_files
@@ -24,7 +25,7 @@ module RailsBestPractices
       # then remember its class name.
       def start_class(node)
         if "ActionMailer::Base" == node.base_class.to_s
-          @mailers << node.class_name.to_s
+          @mailers << class_name(node)
         end
       end
     end

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -3,12 +3,14 @@ require 'rails_best_practices/core/check'
 
 module RailsBestPractices
   module Prepares
-    # Remember the model associations.
+    # Remember models and model associations.
     class ModelPrepare < Core::Check
+      include Core::Check::Classable
+
       ASSOCIATION_METHODS = %w(belongs_to has_one has_many has_and_belongs_to_many)
 
       def interesting_nodes
-        [:class, :command]
+        [:class, :command, :module]
       end
 
       def interesting_files
@@ -22,19 +24,19 @@ module RailsBestPractices
 
       # check class node to remember the last class name.
       def start_class(node)
-        @last_klazz= node.class_name.to_s
-        @models << @last_klazz
+        @class_name= class_name(node)
+        @models << @class_name
       end
 
       # check command node to remember all assoications.
       #
       # the remembered association names (@associations) are like
       #     {
-      #       :Project=>{
-      #         "categories" => {:has_and_belongs_to_many => "Category"},
-      #         "project_manager" => {:has_one => "ProjectManager"},
-      #         "portfolio" => {:belongs_to => "Portfolio"},
-      #         "milestones => {:has_many" => "Milestone"}
+      #       "Project" => {
+      #         "categories" => {"has_and_belongs_to_many" => "Category"},
+      #         "project_manager" => {"has_one" => "ProjectManager"},
+      #         "portfolio" => {"belongs_to" => "Portfolio"},
+      #         "milestones => {"has_many" => "Milestone"}
       #       }
       #     }
       def start_command(node)
@@ -50,7 +52,7 @@ module RailsBestPractices
           association_class = arguments_node.hash_value("class_name").to_s
         end
         association_class ||= association_name.classify
-        @model_associations.add_association(@last_klazz, association_name, association_meta, association_class)
+        @model_associations.add_association(@class_name, association_name, association_meta, association_class)
       end
     end
   end

data/lib/rails_best_practices/reviews.rb

@@ -25,3 +25,4 @@ require 'rails_best_practices/reviews/use_multipart_alternative_as_content_type_
 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'
+require 'rails_best_practices/reviews/restrict_auto_generated_routes_review'

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -33,7 +33,7 @@ module RailsBestPractices
       end
 
       def interesting_files
-        ROUTE_FILE
+        ROUTE_FILES
       end
 
       def initialize(options = {})

data/lib/rails_best_practices/reviews/not_use_default_route_review.rb

@@ -28,7 +28,7 @@ module RailsBestPractices
       end
 
       def interesting_files
-        ROUTE_FILE
+        ROUTE_FILES
       end
 
       # check all command call nodes, compare with rails2 default route

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -40,7 +40,7 @@ module RailsBestPractices
       end
 
       def interesting_files
-        ROUTE_FILE
+        ROUTE_FILES
       end
 
       def initialize(options = {})

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/review'
+
+module RailsBestPractices
+  module Reviews
+    # Review a route file to make sure all auto-generated routes have corresponding actions in controller.
+    #
+    # See the best practice details here http://rails-bestpractices.com/posts/86-restrict-auto-generated-routes
+    #
+    # Implementation:
+    #
+    # Review process:
+    #   check all resources and resource method calls,
+    #   compare the generated routes and corresponding actions in controller,
+    #   if there is a route generated, but there is not action in that controller,
+    #   then you should restrict your routes.
+    class RestrictAutoGeneratedRoutesReview < Review
+      RESOURCE_METHODS = ["show", "new", "create", "edit", "update", "destroy"]
+      RESOURCES_METHODS = RESOURCE_METHODS + ["index"]
+
+      def url
+        "http://rails-bestpractices.com/posts/86-restrict-auto-generated-routes"
+      end
+
+      def interesting_nodes
+        [:command, :command_call, :method_add_block]
+      end
+
+      def interesting_files
+        ROUTE_FILES
+      end
+
+      def initialize
+        super
+        @namespaces = []
+      end
+
+      # check if the generated routes have the corresponding actions in controller for rails3 routes.
+      def start_command(node)
+        if "resources" == node.message.to_s
+          check_resources(node)
+        elsif "resource" == node.message.to_s
+          check_resource(node)
+        end
+      end
+
+      # remember the namespace.
+      def start_method_add_block(node)
+        if "namespace" == node.message.to_s
+          @namespaces << node.arguments.all[0].to_s
+        end
+      end
+
+      # end of namespace call.
+      def end_method_add_block(node)
+        if "namespace" == node.message.to_s
+          @namespaces.pop
+        end
+      end
+
+      # check if the generated routes have the corresponding actions in controller for rails2 routes.
+      alias_method :start_command_call, :start_command
+
+      private
+        # check resources call, if the routes generated by resources does not exist in the controller.
+        def check_resources(node)
+          controller_name = controller_name(node)
+          return unless Prepares.controllers.include? controller_name
+          resources_methods = resources_methods(node)
+          unless resources_methods.all? { |meth| Prepares.controller_methods.has_method?(controller_name, meth) }
+            only_methods = (resources_methods & Prepares.controller_methods.get_methods(controller_name)).map { |meth| ":#{meth}" }.join(", ")
+            add_error "restrict auto-generated routes (:only => [#{only_methods}])"
+          end
+        end
+
+        # check resource call, if the routes generated by resources does not exist in the controller.
+        def check_resource(node)
+          controller_name = controller_name(node)
+          return unless Prepares.controllers.include? controller_name
+          resource_methods = resource_methods(node)
+          unless resource_methods.all? { |meth| Prepares.controller_methods.has_method?(controller_name, meth) }
+            only_methods = (resource_methods & Prepares.controller_methods.get_methods(controller_name)).map { |meth| ":#{meth}" }.join(", ")
+            add_error "restrict auto-generated routes (:only => [#{only_methods}])"
+          end
+        end
+
+        # get the controller name.
+        def controller_name(node)
+          if node.arguments.all.size > 1
+            options = node.arguments.all[1]
+            if options.hash_keys.include?("controller")
+              name = options.hash_value("controller").to_s
+            else
+              name = node.arguments.all[0].to_s.tableize
+            end
+          else
+            name = node.arguments.all[0].to_s.tableize
+          end
+          namespaced_class_name(name)
+        end
+
+        # get the class name with namespace.
+        def namespaced_class_name(name)
+          class_name = "#{name.split("/").map(&:camelize).join("::")}Controller"
+          if @namespaces.empty?
+            class_name
+          else
+            @namespaces.map { |namespace| "#{namespace.camelize}::" }.join("") + class_name
+          end
+        end
+
+        # get the route actions that should be generated by resources call.
+        def resources_methods(node)
+          resources_methods = RESOURCES_METHODS
+
+          if node.arguments.all.size > 1
+            options = node.arguments.all[1]
+            if options.hash_keys.include?("only")
+              Array(options.hash_value("only").to_object)
+            elsif options.hash_keys.include?("except")
+              resources_methods - Array(options.hash_value("except").to_object)
+            else
+              resources_methods
+            end
+          else
+            resources_methods
+          end
+        end
+
+        # get the route actions that should be generated by resource call.
+        def resource_methods(node)
+          resource_methods = RESOURCE_METHODS
+
+          if node.arguments.all.size > 1
+            options = node.arguments.all[1]
+            if options.hash_keys.include?("only")
+              Array(options.hash_value("only").to_object)
+            elsif options.hash_keys.include?("except")
+              resource_methods - Array(options.hash_value("except").to_object)
+            else
+              resource_methods
+            end
+          else
+            resource_methods
+          end
+        end
+    end
+  end
+end

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.gemspec

@@ -13,17 +13,17 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
 
-  s.add_dependency("ruby_parser")
-  s.add_dependency("ruby-progressbar")
+  s.add_dependency("sexp_processor")
+  s.add_dependency("progressbar")
   s.add_dependency("colored")
   s.add_dependency("erubis")
-  s.add_dependency("haml")
   s.add_dependency("i18n")
   s.add_dependency("activesupport")
 
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec")
   s.add_development_dependency("watchr")
+  s.add_development_dependency("haml")
   s.add_development_dependency("bundler")
 
   s.files         = `git ls-files`.split("\n")

data/rails_best_practices.yml

@@ -26,3 +26,4 @@ SimplifyRenderInViewsCheck: { }
 SimplifyRenderInControllersCheck: { }
 RemoveEmptyHelpersCheck: { }
 RemoveTabCheck: { }
+RestrictAutoGeneratedRoutesCheck: { }

data/spec/rails_best_practices/core/controllers_spec.rb

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

data/spec/rails_best_practices/core/methods_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Core::Methods do
+  let(:methods) { RailsBestPractices::Core::Methods.new }
+
+  before :each do
+    methods.add_method("Post", "create")
+    methods.add_method("Post", "destroy")
+    methods.add_method("Comment", "create")
+  end
+
+  it "should get_methods" do
+    methods.get_methods("Post").to_a.should == ["create", "destroy"]
+    methods.get_methods("Comment").to_a.should == ["create"]
+  end
+
+  it "should has_method?" do
+    methods.should be_has_method("Post", "create")
+    methods.should be_has_method("Post", "destroy")
+    methods.should_not be_has_method("Comment", "destroy")
+  end
+end

data/spec/rails_best_practices/core_ext/sexp_spec.rb

@@ -128,6 +128,13 @@ describe Sexp do
     end
   end
 
+  describe "module_name" do
+    it "should get module name of module node" do
+      node = parse_content("module Admin; end").grep_node(:sexp_type => :module)
+      node.module_name.to_s.should == "Admin"
+    end
+  end
+
   describe "class_name" do
     it "should get class name of class node" do
       node = parse_content("class User; end").grep_node(:sexp_type => :class)
@@ -213,6 +220,11 @@ describe Sexp do
       node = parse_content("User.find(:all)").grep_node(:sexp_type => :method_add_arg)
       node.arguments.sexp_type.should == :args_add_block
     end
+
+    it "should get the arguments of method_add_block" do
+      node = parse_content("Post.save(false) do; end").grep_node(:sexp_type => :method_add_block)
+      node.arguments.sexp_type.should == :args_add_block
+    end
   end
 
   describe "argument" do
@@ -369,13 +381,28 @@ describe Sexp do
       node = parse_content("['first_name', 'last_name']").grep_node(:sexp_type => :array)
       node.array_size.should == 2
     end
+
+    it "should get 0" do
+      node = parse_content("[]").grep_node(:sexp_type => :array)
+      node.array_size.should == 0
+    end
   end
 
   describe "to_object" do
-    it "should to_object" do
+    it "should to array" do
       node = parse_content("['first_name', 'last_name']").grep_node(:sexp_type => :array)
       node.to_object.should == ["first_name", "last_name"]
     end
+
+    it "should to empty array" do
+      node = parse_content("[]").grep_node(:sexp_type => :array)
+      node.to_object.should == []
+    end
+
+    it "should to string" do
+      node = parse_content("'richard'").grep_node(:sexp_type => :string_literal)
+      node.to_object.should == "richard"
+    end
   end
 
   describe "to_s" do

data/spec/rails_best_practices/prepares/controller_prepare_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Prepares::ControllerPrepare do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:prepares => RailsBestPractices::Prepares::ControllerPrepare.new) }
+
+  before :each do
+    runner.whiny = true
+  end
+
+  it "should parse controller methods" do
+    content =<<-EOF
+    class PostsController < ApplicationController
+      def index
+      end
+
+      def show
+      end
+    end
+    EOF
+    runner.prepare('app/controllers/posts_controller.rb', content)
+    methods = RailsBestPractices::Prepares.controller_methods
+    methods.get_methods("PostsController").should == ["index", "show"]
+  end
+
+  it "should parse controller methods with module ::" do
+    content =<<-EOF
+    class Admin::Blog::PostsController < ApplicationController
+      def index
+      end
+
+      def show
+      end
+    end
+    EOF
+    runner.prepare('app/controllers/admin/posts_controller.rb', content)
+    methods = RailsBestPractices::Prepares.controller_methods
+    methods.get_methods("Admin::Blog::PostsController").should == ["index", "show"]
+  end
+
+  it "should parse controller methods with module" do
+    content =<<-EOF
+    module Admin
+      module Blog
+        class PostsController < ApplicationController
+          def index
+          end
+
+          def show
+          end
+        end
+      end
+    end
+    EOF
+    runner.prepare('app/controllers/admin/posts_controller.rb', content)
+    methods = RailsBestPractices::Prepares.controller_methods
+    methods.get_methods("Admin::Blog::PostsController").should == ["index", "show"]
+  end
+
+  describe "inherited_resources" do
+    it "extend inherited_resources" do
+      content =<<-EOF
+      class PostsController < InheritedResources::Base
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      methods = RailsBestPractices::Prepares.controller_methods
+      methods.get_methods("PostsController").should == ["index", "show", "new", "create", "edit", "update", "destroy"]
+    end
+
+    it "extend inherited_resources with actions" do
+      content =<<-EOF
+      class PostsController < InheritedResources::Base
+        actions :index, :show
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      methods = RailsBestPractices::Prepares.controller_methods
+      methods.get_methods("PostsController").should == ["index", "show"]
+    end
+
+    it "DSL inherit_resources" do
+      content =<<-EOF
+      class PostsController
+        inherit_resources
+      end
+      EOF
+      runner.prepare('app/controllers/posts_controller.rb', content)
+      methods = RailsBestPractices::Prepares.controller_methods
+      methods.get_methods("PostsController").should == ["index", "show", "new", "create", "edit", "update", "destroy"]
+    end
+  end
+end