# 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