# frozen_string_literal: true module RuboCop module Cop module Rails # This cop checks for Rake tasks without the `:environment` task # dependency. The `:environment` task loads application code for other # Rake tasks. Without it, tasks cannot make use of application code like # models. # # You can ignore the offense if the task satisfies at least one of the # following conditions: # # * The task does not need application code. # * The task invokes the `:environment` task. # # @example # # bad # task :foo do # do_something # end # # # good # task foo: :environment do # do_something # end # class RakeEnvironment < Base extend AutoCorrector MSG = 'Include `:environment` task as a dependency for all Rake tasks.' def_node_matcher :task_definition?, <<~PATTERN (block $(send nil? :task ...) ...) PATTERN def on_block(node) task_definition?(node) do |task_method| return if task_name(task_method) == :default return if with_dependencies?(task_method) add_offense(task_method) do |corrector| task_name = task_method.arguments[0] task_dependency = correct_task_dependency(task_name) corrector.replace(task_name.loc.expression, task_dependency) end end end private def correct_task_dependency(task_name) if task_name.sym_type? "#{task_name.source.delete(':|\'|"')}: :environment" else "#{task_name.source} => :environment" end end def task_name(node) first_arg = node.arguments[0] case first_arg&.type when :sym, :str first_arg.value.to_sym when :hash return nil if first_arg.children.size != 1 pair = first_arg.children.first key = pair.children.first case key.type when :sym, :str key.value.to_sym end end end def with_dependencies?(node) first_arg = node.arguments[0] return false unless first_arg if first_arg.hash_type? with_hash_style_dependencies?(first_arg) else task_args = node.arguments[1] return false unless task_args return false unless task_args.hash_type? with_hash_style_dependencies?(task_args) end end def with_hash_style_dependencies?(hash_node) deps = hash_node.pairs.first&.value return false unless deps case deps.type when :array !deps.values.empty? else true end end end end end end