Feature: Auto-generate a todo file
  Write a Reek configuration as a kind of todo list that will prevent Reek
  from reporting smells on the current code.
  This can then be worked on later on.
  The main goal here would be to ease the Reek adoption by allowing developers to:
    - introduce Reek right away (e.g. for CI)
    - exclude the "old" smells from getting reported
    - fix them step by step
    - get rid of the todo file

  Scenario: Generate a proper todo file that disables all found smells
    Given the smelly file 'smelly.rb'
    When I run reek smelly.rb
    Then the exit status indicates smells
    And it reports:
      """
      smelly.rb -- 2 warnings:
        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
      """
    When I run reek --todo smelly.rb
    Then it succeeds
    And it reports:
      """

      '.todo.reek' generated! You can now use this as a starting point for your configuration.
      """
    And a file named ".todo.reek" should exist
    And the file ".todo.reek" should contain:
      """
      ---
      UncommunicativeMethodName:
        exclude:
        - Smelly#x
      UncommunicativeVariableName:
        exclude:
        - Smelly#x
        """
    When I run reek -c .todo.reek smelly.rb
    Then it succeeds

  Scenario: Reacts appropiately when there are no smells
    Given the clean file 'clean.rb'
    When I run reek --todo clean.rb
    Then a file named ".todo.reek" should not exist
    And it reports:
      """

      '.todo.reek' not generated because there were no smells found!
      """

  Scenario: Mercilessly overwrite existing .todo.reek files
    Given the smelly file 'smelly.rb'
    And a file named ".todo.reek" with:
      """
      ---
      # smelly.rb reeks of UncommunicativeMethodName and UncommunicativeVariableName
      # so the configuration below will partially mask this
      UncommunicativeMethodName:
        enabled: false
      """
    When I run `reek -c .todo.reek smelly.rb`
    Then it reports:
      """
      smelly.rb -- 1 warning:
        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
      """
    When I run `reek --todo smelly.rb`
    Then it succeeds
    When I run `reek -c .todo.reek smelly.rb`
    Then it reports nothing

  Scenario: Ignore existing other configuration files that are passed explicitly
    Given the smelly file 'smelly.rb'
    And a file named "config.reek" with:
      """
      ---
      # smelly.rb reeks of UncommunicativeMethodName and UncommunicativeVariableName
      # so the configuration below will partially mask this
      UncommunicativeMethodName:
        enabled: false
      """
    When I run `reek -c config.reek smelly.rb`
    Then it reports:
      """
      smelly.rb -- 1 warning:
        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
      """
    When I run `reek -c config.reek --todo smelly.rb`
    Then it succeeds
    When I run `reek -c .todo.reek smelly.rb`
    Then it reports nothing