Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Rake
      # This cop detects method definition in a task or namespace,
      # because it is defined to the top level.
      # It is confusing because the scope looks in the task or namespace,
      # but actually it is defined to the top level.
      #
      # @example
      #   # bad
      #   task :foo do
      #     def helper_method
      #       do_something
      #     end
      #   end
      #
      #   # bad
      #   namespace :foo do
      #     def helper_method
      #       do_something
      #     end
      #   end
      #
      #   # good - It is also defined to the top level,
      #   #        but it looks expected behavior.
      #   def helper_method
      #   end
      #   task :foo do
      #   end
      #
      class MethodDefinitionInTask < Cop
        MSG = 'Do not define a method in rake task, because it will be defined to the top level.'

        def on_def(node)
          return if Helper::ClassDefinition.in_class_definition?(node)
          return unless Helper::TaskDefinition.in_task_or_namespace?(node)

          add_offense(node)
        end

        alias on_defs on_def
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
rubocop-rake-0.5.1	lib/rubocop/cop/rake/method_definition_in_task.rb
rubocop-rake-0.5.0	lib/rubocop/cop/rake/method_definition_in_task.rb
rubocop-rake-0.4.0	lib/rubocop/cop/rake/method_definition_in_task.rb
rubocop-rake-0.3.1	lib/rubocop/cop/rake/method_definition_in_task.rb
rubocop-rake-0.3.0	lib/rubocop/cop/rake/method_definition_in_task.rb