reek 6.0.3 → 6.0.4

data/features/step_definitions/.rubocop.yml

@@ -1,5 +0,0 @@
-inherit_from: ../../.rubocop.yml
-
-# Allow common When <regexp> syntax
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false

data/features/step_definitions/reek_steps.rb

@@ -1,102 +0,0 @@
-When /^I run reek (.*)$/ do |args|
-  reek(args)
-end
-
-When 'I run the code climate reek runner' do
-  run_command_and_stop 'code_climate_reek'
-end
-
-When /^I pass "([^"]*)" to reek *(.*)$/ do |stdin, args|
-  reek_with_pipe(stdin, args)
-end
-
-When /^I pass a stdin to reek *(.*) with:$/ do |args, stdin|
-  reek_with_pipe(stdin, args)
-end
-
-Then /^it reports nothing$/ do
-  expect(last_command_started).to have_output_on_stdout('')
-end
-
-Then /^there is no output on stdout$/ do
-  expect(last_command_started).to have_output_on_stdout('')
-end
-
-Then /^stdout includes "(.*)"$/ do |text|
-  expect(last_command_started).to have_output_on_stdout(/#{Regexp.escape(text)}/)
-end
-
-Then /^it succeeds$/ do
-  success = Reek::CLI::Status::DEFAULT_SUCCESS_EXIT_CODE
-  expect(last_command_started).to have_exit_status(success)
-end
-
-Then /^the exit status indicates an error$/ do
-  error = Reek::CLI::Status::DEFAULT_ERROR_EXIT_CODE
-  expect(last_command_started).to have_exit_status(error)
-end
-
-Then /^the exit status indicates smells$/ do
-  smells = Reek::CLI::Status::DEFAULT_FAILURE_EXIT_CODE
-  expect(last_command_started).to have_exit_status(smells)
-end
-
-Then(/^the exit status is (\d+)$/) do |status|
-  expect(last_command_started).to have_exit_status(status.to_i)
-end
-
-Then /^it reports:$/ do |report|
-  expect(last_command_started).to have_output_on_stdout(report.gsub('\n', "\n"))
-end
-
-Then /^it reports this yaml:$/ do |expected_yaml|
-  expected_warnings = YAML.safe_load(expected_yaml.chomp)
-  actual_warnings = YAML.safe_load(last_command_started.stdout)
-  expect(actual_warnings).to eq expected_warnings
-end
-
-Then /^it reports this JSON:$/ do |expected_json|
-  expected_warnings = JSON.parse(expected_json.chomp)
-  actual_warnings = JSON.parse(last_command_started.stdout)
-  expect(actual_warnings).to eq expected_warnings
-end
-
-Then /^stderr reports:$/ do |report|
-  expect(last_command_started).to have_output_on_stderr(report.chomp)
-end
-
-Then /^it reports no errors$/ do
-  expect(last_command_started).to have_output_on_stderr('')
-end
-
-Then /^it reports an error$/ do
-  expect(last_command_started.stderr).to_not be_empty
-end
-
-Then /^it reports the error ['"](.*)['"]$/ do |string|
-  expect(last_command_started).to have_output_on_stderr(/#{Regexp.escape(string)}/)
-end
-
-Then /^it reports a parsing error$/ do
-  expect(last_command_started).to have_output_on_stderr(/Parser::SyntaxError/)
-end
-
-Then /^it should indicate the line numbers of those smells$/ do
-  expect(last_command_started).to have_output(/\[.*\]:/)
-end
-
-Then /^it reports the current version$/ do
-  expect(last_command_started).to have_output("reek #{Reek::Version::STRING}")
-end
-
-Then /^it reports this Code Climate output:$/ do |expected_output|
-  expected_issues = expected_output.split('NULL_BYTE_CHARACTER').map do |issue|
-    JSON.parse(issue)
-  end
-
-  actual_issues = last_command_started.stdout.split("\0").map do |issue|
-    JSON.parse(issue)
-  end
-
-  expect(actual_issues).to eq(expected_issues)
-end

data/features/step_definitions/sample_file_steps.rb

@@ -1,63 +0,0 @@
-require_relative '../../samples/paths'
-
-Given(/^the smelly file '(.+)'$/) do |filename|
-  write_file(filename, SAMPLES_DIR.join('smelly_source').join(filename).read)
-end
-
-Given(/^the smelly file "(.+)" in the directory "(.+)"$/) do |filename, directory|
-  FileUtils.mkdir_p directory
-  write_file Pathname(directory).join(filename).to_s,
-             SAMPLES_DIR.join('smelly_source').join(filename).read
-end
-
-Given(/^the clean file "(.*)"$/) do |filename|
-  write_file(filename, CLEAN_FILE.read)
-end
-
-Given(/^a directory called 'clean' containing two clean files$/) do
-  contents = CLEAN_FILE.read
-
-  write_file('clean/clean_one.rb', contents)
-  write_file('clean/clean_two.rb', contents)
-end
-
-Given(/^a directory called 'mixed_files' containing some clean and smelly files$/) do
-  write_file('mixed_files/clean.rb', CLEAN_FILE.read)
-  write_file('mixed_files/dirty.rb', SMELLY_FILE.read)
-end
-
-Given(/^a directory called 'smelly' containing two smelly files$/) do
-  contents = SMELLY_FILE.read
-
-  write_file('smelly/dirty_one.rb', contents)
-  write_file('smelly/dirty_two.rb', contents)
-end
-
-Given(/^the smelly file '(.+)' in a subdirectory$/) do |filename|
-  contents = SAMPLES_DIR.join('smelly_source').join(filename).read
-
-  write_file("subdir/#{filename}", contents)
-end
-
-Given(/^a configuration file '(.+)'$/) do |filename|
-  write_file(filename, CONFIGURATION_DIR.join(filename).read)
-end
-
-Given(/^our default configuration file$/) do
-  default_configuration = File.read Reek::DEFAULT_SMELL_CONFIGURATION
-  write_file('defaults.reek.yml', default_configuration)
-end
-
-When(/^I run "reek (.*?)" in a subdirectory$/) do |args|
-  cd 'subdir'
-
-  reek(args)
-end
-
-Then(/^it does not report private or protected methods$/) do
-  # Pseudo step for feature clarity.
-end
-
-Given('with a configuration file that is further up in the directory tree') do
-  # Pseudo step for feature clarity. We have an empty .reek.yml in our root directory already.
-end

data/features/support/env.rb

@@ -1,33 +0,0 @@
-require_relative '../../lib/reek'
-require_relative '../../lib/reek/cli/application'
-require 'aruba/cucumber'
-
-begin
-  require 'pry-byebug'
-rescue LoadError # rubocop:disable Lint/SuppressedException
-end
-
-#
-# Provides runner methods used in the cucumber steps.
-#
-class ReekWorld
-  def reek(args)
-    run_command_and_stop("reek --no-color --no-documentation #{args}", fail_on_error: false)
-  end
-
-  def reek_with_pipe(stdin, args)
-    run_command "reek --no-color --no-documentation #{args}"
-    type(stdin)
-    close_input
-  end
-end
-
-World do
-  ReekWorld.new
-end
-
-Before do
-  Aruba.configure do |config|
-    config.exit_timeout = 30
-  end
-end

data/features/todo_list.feature

@@ -1,108 +0,0 @@
-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
-  and then fix them step by step.
-
-  Scenario: Generate the default configuration 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'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-    When I run reek --todo smelly.rb
-    Then it succeeds
-    And it reports:
-      """
-
-      '.reek.yml' generated! You can now use this as a starting point.
-      """
-    And a file named ".reek.yml" should exist
-    And the file ".reek.yml" should contain:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          exclude:
-          - Smelly#x
-        UncommunicativeVariableName:
-          exclude:
-          - Smelly#x
-      """
-    When I run 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 ".reek.yml" should not exist
-    And it reports:
-      """
-
-      No smells found - nothing to do, exiting.
-      """
-
-  Scenario: Don't overwrite existing .reek.yml files
-    Given the smelly file 'smelly.rb'
-    And a file named ".reek.yml" with:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          enabled: false
-      """
-    When I run reek smelly.rb
-    Then it reports:
-      """
-      smelly.rb -- 1 warning:
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-    When I run reek --todo smelly.rb
-    Then it reports:
-      """
-
-      Existing '.reek.yml' detected - aborting.
-      """
-    When I run reek smelly.rb
-    Then it reports:
-      """
-      smelly.rb -- 1 warning:
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-
-  Scenario: Ignore existing other configuration files that are passed explicitly
-    Given the smelly file 'smelly.rb'
-    And a file named "config.reek" with:
-      """
-      ---
-      detectors:
-        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'
-      """
-    When I run reek -c config.reek --todo smelly.rb
-    Then it succeeds
-    And a file named ".reek.yml" should exist
-    And the file ".reek.yml" should contain:
-      """
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          exclude:
-          - Smelly#x
-        UncommunicativeVariableName:
-          exclude:
-          - Smelly#x
-      """
-    When I run reek smelly.rb
-    Then it reports nothing

data/samples/checkstyle.xml

@@ -1,7 +0,0 @@
-<?xml version='1.0'?>
-<checkstyle>
-  <file name='samples/smelly_source/smelly.rb'>
-    <error column='0' line='4' message='has the name &apos;x&apos;' severity='warning' source='UncommunicativeMethodName'/>
-    <error column='0' line='5' message='has the variable name &apos;y&apos;' severity='warning' source='UncommunicativeVariableName'/>
-  </file>
-</checkstyle>

data/samples/clean_source/clean.rb

@@ -1,6 +0,0 @@
-# Well documented Clean class.
-class Clean
-  def hello(argument)
-    say argument
-  end
-end

data/samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml

@@ -1,29 +0,0 @@
----
-detectors:
-  UnusedPrivateMethod:
-    exclude:
-      - "/exclude regexp/"
-  UncommunicativeMethodName:
-    reject:
-      - "reject name"
-    accept:
-      - "accept name"
-  UncommunicativeModuleName:
-    reject:
-      - "reject name 1"
-      - "reject name 2"
-    accept:
-      - "accept name 1"
-      - "accept name 2"
-  UncommunicativeParameterName:
-    reject:
-      - "reject name"
-      - "/reject regexp/"
-    accept:
-      - "accept name"
-      - "/accept regexp/"
-  UncommunicativeVariableName:
-    reject:
-      - "/^reject regexp$/"
-    accept:
-      - "/accept(.*)regexp/"

data/samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml

@@ -1,30 +0,0 @@
----
-directories:
-  "app/controllers":
-    UnusedPrivateMethod:
-      exclude:
-        - "/exclude regexp/"
-    UncommunicativeMethodName:
-      reject:
-        - "reject name"
-      accept:
-        - "accept name"
-    UncommunicativeModuleName:
-      reject:
-        - "reject name 1"
-        - "reject name 2"
-      accept:
-        - "accept name 1"
-        - "accept name 2"
-    UncommunicativeParameterName:
-      reject:
-        - "reject name"
-        - "/reject regexp/"
-      accept:
-        - "accept name"
-        - "/accept regexp/"
-    UncommunicativeVariableName:
-      reject:
-        - "/^reject regexp$/"
-      accept:
-        - "/accept(.*)regexp/"

data/samples/configuration/corrupt.reek

@@ -1 +0,0 @@
-Not a valid configuration file

data/samples/configuration/full_configuration.reek

@@ -1,13 +0,0 @@
----
-detectors:
-  IrresponsibleModule:
-    enabled: false
-
-directories:
-  "samples/three_clean_files/":
-    UtilityFunction:
-      enabled: false
-
-exclude_paths:
-  - "samples/two_smelly_files/"
-  - "samples/source_with_non_ruby_files/"

data/samples/configuration/full_mask.reek

@@ -1,6 +0,0 @@
----
-detectors:
-  UncommunicativeMethodName:
-    enabled: false
-  UncommunicativeVariableName:
-    enabled: false

data/samples/configuration/home/home.reek.yml

@@ -1,4 +0,0 @@
----
-UncommunicativeVariableName:
-  accept:
-  - md5

data/samples/configuration/partial_mask.reek

@@ -1,4 +0,0 @@
----
-detectors:
-  UncommunicativeMethodName:
-    enabled: false

data/samples/configuration/regular_configuration/.reek.yml

@@ -1,4 +0,0 @@
----
-UncommunicativeVariableName:
-  accept:
-  - md5