Contents

# frozen_string_literal: true

module RailsBestPractices
  module Reviews
    # Review a controller file to make sure there are no complex finder.
    #
    # See the best practice details here https://rails-bestpractices.com/posts/2010/07/14/move-finder-to-named_scope/
    #
    # Implementation:
    #
    # Review process:
    #   check all method method_add_arg nodes in controller files.
    #   if there is any call node with message find, all, first or last,
    #   and it has a hash argument,
    #   then it is a complex finder, and should be moved to model's named scope.
    class MoveFinderToNamedScopeReview < Review
      interesting_nodes :method_add_arg
      interesting_files CONTROLLER_FILES
      url 'https://rails-bestpractices.com/posts/2010/07/14/move-finder-to-named_scope/'

      FINDERS = %w[find all first last].freeze

      # check method_add_ag node if its message is one of find, all, first or last,
      # and it has a hash argument,
      # then the call node is the finder that should be moved to model's named_scope.
      add_callback :start_method_add_arg do |node|
        add_error 'move finder to named_scope' if finder?(node)
      end

      private

        # check if the method_add_arg node is a finder.
        #
        # if the receiver of method_add_arg node is a constant,
        # and the message of call method_add_arg is one of find, all, first or last,
        # and any of its arguments is a hash,
        # then it is a finder.
      def finder?(node)
        FINDERS.include?(node[1].message.to_s) &&
          node[1].sexp_type == :call &&
          node.arguments.grep_nodes_count(sexp_type: :bare_assoc_hash) > 0
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
rails_best_practices-1.20.0	lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb
rails_best_practices-1.19.5	lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb
rails_best_practices-1.19.4	lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb