cuke_linter 0.13.0 → 1.0.0

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/environments/common_env.rb

@@ -1,12 +0,0 @@
-require 'require_all'
-
-require 'cuke_linter'
-require 'open3'
-
-
-require_relative '../testing/model_factory'
-require_relative '../testing/linter_factory'
-require_relative '../testing/formatter_factory'
-require_relative '../testing/file_helper'
-
-PROJECT_ROOT = "#{__dir__}/.."

data/environments/cucumber_env.rb

@@ -1,22 +0,0 @@
-require 'simplecov'
-SimpleCov.command_name('cucumber_tests')
-
-require_relative 'common_env'
-require 'cucumber'
-
-require_all 'testing/cucumber/step_definitions'
-
-
-Before do
-  CukeLinter.clear_registered_linters
-end
-
-Before do
-  @root_test_directory = CukeLinter::FileHelper.create_directory
-end
-
-at_exit do
-  CukeLinter::FileHelper.created_directories.each do |dir_path|
-    FileUtils.remove_entry(dir_path, true)
-  end
-end

data/environments/rspec_env.rb

@@ -1,50 +0,0 @@
-require 'simplecov'
-SimpleCov.command_name('rspec_tests')
-
-require_relative 'common_env'
-require 'rspec'
-require 'rubygems/mock_gem_ui'
-require 'yaml'
-
-require_relative '../testing/rspec/spec/unit/formatters/formatter_unit_specs'
-require_relative '../testing/rspec/spec/unit/linters/configurable_linter_unit_specs'
-require_relative '../testing/rspec/spec/unit/linters/linter_unit_specs'
-require_relative '../testing/rspec/spec/integration/formatters/formatter_integration_specs'
-require_relative '../testing/rspec/spec/integration/linters/linter_integration_specs'
-
-# Convenient constants, just in case what kinds of elements are taggable ever changes
-TAGGABLE_ELEMENTS               = ['feature', 'scenario', 'outline', 'example']
-ELEMENTS_WITH_TAGGABLE_CHILDREN = ['feature', 'outline']
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-
-  config.before(:suite) do
-    # Using a global variable instead of an instance variable because instance variables are not compatible with :suite hooks
-    $default_linters = Marshal.load(Marshal.dump(CukeLinter.registered_linters))
-  end
-
-  # Restore the original linters after any test that modifies them so that other tests can rely on them being only the default ones
-  config.after(:example, :linter_registration) do
-    CukeLinter.clear_registered_linters
-
-    $default_linters.each_pair do |name, linter|
-      CukeLinter.register_linter(name: name, linter: linter)
-    end
-  end
-
-  config.after(:suite) do
-    CukeLinter::FileHelper.created_directories.each do |dir_path|
-      FileUtils.remove_entry(dir_path, true)
-    end
-  end
-
-end

data/testing/cucumber/step_definitions/action_steps.rb

@@ -1,84 +0,0 @@
-When(/^the following command is executed:$/) do |command|
-  command = "bundle exec ruby #{@executable_directory || "#{PROJECT_ROOT}/exe"}/#{command}"
-  command.gsub!('<path_to>', @root_test_directory)
-
-  @results = @output = `#{command}`
-end
-
-When(/^it is formatted by the "([^"]*)" formatter$/) do |linter_name|
-  @results = CukeLinter.const_get("#{linter_name.capitalize}Formatter").new.format(@linter_data)
-end
-
-When(/^(?:the feature|the model|it) is linted$/) do
-  options           = { model_trees: [@model],
-                        formatters:  [[CukeLinter::FormatterFactory.generate_fake_formatter, "#{CukeLinter::FileHelper::create_directory}/junk_output_file.txt"]] }
-  options[:linters] = [@linter] if @linter
-
-  @results = CukeLinter.lint(options)
-end
-
-When(/^the configuration file is (?:used|loaded)$/) do
-  CukeLinter.load_configuration(config_file_path: @configuration_file_path)
-end
-
-And(/^the following code is used:$/) do |code|
-  code.sub!('<path_to>', @root_test_directory)
-  code.sub!('<code_to_generate_a_new_linter_instance>', 'CukeLinter::LinterFactory.generate_fake_linter')
-
-  if @working_directory
-    Dir.chdir(@working_directory) do
-      eval(code)
-    end
-  else
-    eval(code)
-  end
-end
-
-When(/^"([^"]*)" is the current directory$/) do |directory|
-  @working_directory = "#{@root_test_directory}/#{directory}"
-end
-
-When(/^the executable finds no linting problems$/) do
-  # Linting an empty directory doesn't (currently) find and problems
-  command = "bundle exec ruby #{PROJECT_ROOT}/exe/cuke_linter"
-
-  std_out, std_err, status = [nil, nil, nil]
-
-  Dir.chdir(@root_test_directory) do
-    std_out, std_err, status = Open3.capture3(command)
-  end
-
-  @results = { std_out: std_out, std_err: std_err, status: status }
-end
-
-When(/^the executable finds linting problems$/) do
-  # This should be a problematic feature file
-  CukeLinter::FileHelper.create_file(directory: @root_test_directory,
-                                     name:      'pretty_empty',
-                                     extension: '.feature',
-                                     text:      'Feature: ')
-
-
-  command = "bundle exec ruby #{PROJECT_ROOT}/exe/cuke_linter"
-
-  std_out, std_err, status = [nil, nil, nil]
-
-  Dir.chdir(@root_test_directory) do
-    std_out, std_err, status = Open3.capture3(command)
-  end
-
-  @results = { std_out: std_out, std_err: std_err, status: status }
-end
-
-When(/^the executable has a problem$/) do
-  # Missing a required argument for a flag should be a problem
-  command = "bundle exec ruby #{PROJECT_ROOT}/exe/cuke_linter -r"
-
-  std_out, std_err, status = [nil, nil, nil]
-
-  Dir.chdir(@root_test_directory) do
-    std_out, std_err, status = Open3.capture3(command)
-  end
-
-  @results = { std_out: std_out, std_err: std_err, status: status }
-end

data/testing/cucumber/step_definitions/setup_steps.rb

@@ -1,258 +0,0 @@
-Given(/^the cuke_linter executable is available$/) do
-  @executable_directory = "#{PROJECT_ROOT}/exe"
-end
-
-Given(/^the following linter data:$/) do |linter_data|
-  @linter_data = [].tap do |data|
-    linter_data.hashes.each do |data_point|
-      data << { linter:   data_point['linter name'],
-                problem:  data_point['problem'],
-                location: data_point['location'] }
-    end
-  end
-end
-
-Given(/^the following feature:$/) do |text|
-  @model = CukeModeler::Feature.new(text)
-
-  fake_file_model      = CukeModeler::FeatureFile.new
-  fake_file_model.path = 'path_to_file'
-
-  @model.parent_model = fake_file_model
-end
-
-Given(/^a linter for features without scenarios$/) do
-  @linter = CukeLinter::FeatureWithoutScenariosLinter.new
-end
-
-Given(/^a linter for features with invalid file names$/) do
-  @linter = CukeLinter::FeatureFileWithInvalidNameLinter.new
-end
-
-And(/^a linter for features with mismatched file names$/) do
-  @linter = CukeLinter::FeatureFileWithMismatchedNameLinter.new
-end
-
-Given(/^no other linters have been registered or unregistered$/) do
-  CukeLinter.reset_linters
-end
-
-Given(/^a linter for examples without names$/) do
-  @linter = CukeLinter::ExampleWithoutNameLinter.new
-end
-
-Given(/^a linter for outlines with only one example row$/) do
-  @linter = CukeLinter::OutlineWithSingleExampleRowLinter.new
-end
-
-Given("a linter for tests with bad names") do
-  @linter = CukeLinter::TestWithBadNameLinter.new
-end
-
-Given(/^a linter for tests with too many steps$/) do
-  @linter = CukeLinter::TestWithTooManyStepsLinter.new
-end
-
-Given(/^a linter for steps the end with a period$/) do
-  @linter = CukeLinter::StepWithEndPeriodLinter.new
-end
-
-Given(/^a linter for backgrounds applied to only one test$/) do
-  @linter = CukeLinter::SingleTestBackgroundLinter.new
-end
-
-Given(/^a linter for backgrounds that do more than setup$/) do
-  @linter = CukeLinter::BackgroundDoesMoreThanSetupLinter.new
-end
-
-Given("a linter for test steps with too many characters") do
-  @linter = CukeLinter::StepWithTooManyCharactersLinter.new
-end
-
-Given(/^a linter for tests with no action step$/) do
-  @linter = CukeLinter::TestWithNoActionStepLinter.new
-end
-
-Given(/^a linter for tests with no verification step$/) do
-  @linter = CukeLinter::TestWithNoVerificationStepLinter.new
-end
-
-Given(/^a linter for features without a name$/) do
-  @linter = CukeLinter::FeatureWithoutNameLinter.new
-end
-
-Given(/^a linter for elements with too many tags$/) do
-  @linter = CukeLinter::ElementWithTooManyTagsLinter.new
-end
-
-Given(/^a linter for features with too many different tags$/) do
-  @linter = CukeLinter::FeatureWithTooManyDifferentTagsLinter.new
-end
-
-Given(/^a linter for elements with too many tags has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::ElementWithTooManyTagsLinter.new, name: 'ElementWithTooManyTagsLinter')
-end
-
-Given(/^a linter for elements with duplicate tags has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::ElementWithDuplicateTagsLinter.new, name: 'ElementWithDuplicateTagsLinter')
-end
-
-Given(/^a linter for tests with too many steps has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::TestWithTooManyStepsLinter.new, name: 'TestWithTooManyStepsLinter')
-end
-
-Given(/^a linter for backgrounds that do more than setup has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::BackgroundDoesMoreThanSetupLinter.new, name: 'BackgroundDoesMoreThanSetupLinter')
-end
-
-Given(/^a linter for tests with an action step as the final step has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::TestWithActionStepAsFinalStepLinter.new, name: 'TestWithActionStepAsFinalStepLinter')
-end
-
-Given(/^a linter for tests with no action step has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::TestWithNoActionStepLinter.new, name: 'TestWithNoActionStepLinter')
-end
-
-Given(/^a linter for tests with no verification step has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::TestWithNoVerificationStepLinter.new, name: 'TestWithNoVerificationStepLinter')
-end
-
-Given(/^a linter for tests with a setup step after an action step has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::TestWithSetupStepAfterActionStepLinter.new, name: 'TestWithSetupStepAfterActionStepLinter')
-end
-
-Given(/^a linter for tests with a setup step after a verification step has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::TestWithSetupStepAfterVerificationStepLinter.new, name: 'TestWithSetupStepAfterVerificationStepLinter')
-end
-
-Given(/^a linter for tests with a setup step as the final step has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::TestWithSetupStepAsFinalStepLinter.new, name: 'TestWithSetupStepAsFinalStepLinter')
-end
-
-Given("a linter for features without a description") do
-  @linter = CukeLinter::FeatureWithoutDescriptionLinter.new
-end
-
-Given(/^a linter for tests with no name$/) do
-  @linter = CukeLinter::TestWithNoNameLinter.new
-end
-
-Given(/^a linter for tests that should use a background$/) do
-  @linter = CukeLinter::TestShouldUseBackgroundLinter.new
-end
-
-Given(/^a linter for tests with a setup step after an action step$/) do
-  @linter = CukeLinter::TestWithSetupStepAfterActionStepLinter.new
-end
-
-Given(/^a linter for tests with a setup step after a verification step$/) do
-  @linter = CukeLinter::TestWithSetupStepAfterVerificationStepLinter.new
-end
-
-Given(/^a linter for tests with a setup step as the final step$/) do
-  @linter = CukeLinter::TestWithSetupStepAsFinalStepLinter.new
-end
-
-Given(/^a linter for tests with an action step as the final step$/) do
-  @linter = CukeLinter::TestWithActionStepAsFinalStepLinter.new
-end
-
-Given(/^a linter for elements with duplicate tags$/) do
-  @linter = CukeLinter::ElementWithDuplicateTagsLinter.new
-end
-
-Given(/^a linter for elements with common tags$/) do
-  @linter = CukeLinter::ElementWithCommonTagsLinter.new
-end
-
-Given(/^a linter for test steps with too many characters has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::StepWithTooManyCharactersLinter.new, name: 'StepWithTooManyCharactersLinter')
-end
-
-Given(/^a linter for features with too many different tags has been registered$/) do
-  CukeLinter.register_linter(linter: CukeLinter::FeatureWithTooManyDifferentTagsLinter.new, name: 'FeatureWithTooManyDifferentTagsLinter')
-end
-
-Given(/^the following configuration file(?: "([^"]*)")?:$/) do |file_name, text|
-  file_name ||= '.cuke_linter'
-
-  @configuration_file_path = CukeLinter::FileHelper.create_file(directory: @root_test_directory, name: file_name, extension: '', text: text)
-end
-
-Given(/^a linter "([^"]*)"$/) do |linter_class|
-  @linter = CukeLinter.const_get(linter_class).new
-end
-
-Given(/^a linter registered as "([^"]*)"$/) do |linter_name|
-  CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: linter_name), name: linter_name)
-end
-
-Given(/^a directory "([^"]*)"$/) do |directory_name|
-  @test_directory = CukeLinter::FileHelper.create_directory(directory: @root_test_directory, name: directory_name)
-end
-
-Given(/^no linters are currently registered$/) do
-  CukeLinter.clear_registered_linters
-end
-
-Given(/^the following custom linter object:$/) do |code|
-  code.sub!('<path_to>', @root_test_directory)
-  code.sub!('<code_to_generate_a_new_linter_instance>', 'CukeLinter::LinterFactory.generate_fake_linter')
-
-  if @working_directory
-    Dir.chdir(@working_directory) do
-      eval(code)
-    end
-  else
-    eval(code)
-  end
-end
-
-And(/^a model to lint$/) do
-  # Any old model should be fine
-  @model = CukeModeler::Feature.new
-
-  fake_file_model      = CukeModeler::FeatureFile.new
-  fake_file_model.path = 'path_to_file'
-
-  @model.parent_model = fake_file_model
-end
-
-Given(/^the following custom linter class:$/) do |code|
-  eval(code)
-end
-
-Given(/^the following(?: feature)? file "([^"]*)":$/) do |file_path, text|
-  path, extension = file_path.split('.')
-
-  @created_files ||= []
-  @created_files << CukeLinter::FileHelper.create_file(directory: @root_test_directory, name: path, extension: ".#{extension}", text: text)
-end
-
-Given(/^the default linters are being used$/) do
-  CukeLinter.reset_linters
-end
-
-And(/^a feature file model based on the following text:$/) do |text|
-  file_path = CukeLinter::FileHelper.create_file(directory: @root_test_directory, extension: '.feature', text: text)
-
-  @created_files ||= []
-  @created_files << file_path
-
-  @model = CukeModeler::FeatureFile.new(file_path)
-end
-
-Given(/^a feature file model named "([^"]*)"$/) do |file_path|
-  @model = CukeModeler::FeatureFile.new
-
-  @model.path = file_path
-end
-
-Given(/^a feature file model based on the file "([^"]*)" with the following text:$/) do |file_name, text|
-  file_path = CukeLinter::FileHelper.create_file(directory: @root_test_directory, extension: '.feature', text: text, name: file_name)
-
-  @created_files ||= []
-  @created_files << file_path
-
-  @model = CukeModeler::FeatureFile.new(file_path)
-end

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -1,94 +0,0 @@
-Then(/^a linting report will be made for all features$/) do
-  expect(@output).to match(/\d+ issues found/)
-end
-
-Then(/^the resulting output is the following:$/) do |text|
-  text.gsub!('<path_to>', @root_test_directory)
-
-  expect(@results.strip).to eq(text)
-end
-
-Then(/^the resulting output will include the following:$/) do |text|
-  text.gsub!('<path_to>', @root_test_directory)
-
-  expect(@results.chomp).to include(text)
-end
-
-Then(/^an error is reported:$/) do |table|
-  if @model.is_a?(CukeModeler::FeatureFile)
-    model_path        = @model.path
-    model_source_line = ''
-  else
-    model_path        = @model.get_ancestor(:feature_file).path
-    model_source_line = @model.source_line.to_s
-  end
-
-  table.hashes.each do |error_record|
-    expect(@results).to include({ linter:   error_record['linter'],
-                                  problem:  error_record['problem'],
-                                  location: error_record['location'].sub('<path_to_file>', model_path).sub('<model_line_number>', model_source_line) })
-  end
-end
-
-Then(/^the following problems are( not)? reported:$/) do |exclude, table|
-  assertion_method = exclude ? :to_not : :to
-
-  if @model.is_a?(CukeModeler::FeatureFile)
-    feature_file_model = @model
-    source_line        = ''
-  else
-    feature_file_model = @model.get_ancestor(:feature_file)
-    source_line        = @model.source_line.to_s
-  end
-
-  table.hashes.each do |error_record|
-    expect(@results).send(assertion_method, include({ linter:   error_record['linter'],
-                                                      problem:  error_record['problem'],
-                                                      location: error_record['location'].sub('<path_to_file>', feature_file_model.path).sub('<model_line_number>', source_line) }))
-  end
-end
-
-Then(/^the following linters are registered(?: by default)?$/) do |linter_names|
-  expect(CukeLinter.registered_linters.keys).to match_array(linter_names.raw.flatten)
-end
-
-Then(/^an error is reported$/) do
-  expect(@results).to_not be_empty
-end
-
-Then(/^no error is reported$/) do
-  expect(@results).to be_empty
-end
-
-Then(/^the linter "([^"]*)" is no longer registered$/) do |linter_name|
-  expect(CukeLinter.registered_linters).to_not have_key(linter_name)
-end
-
-Then(/^the following help is displayed:$/) do |text|
-  expect(@output.chomp).to eq(text)
-end
-
-Then(/^the version of the tool is displayed:$/) do |text|
-  major_number, minor_number, patch_number = CukeLinter::VERSION.split('.')
-  text.sub!('<major>', major_number)
-  text.sub!('<minor>', minor_number)
-  text.sub!('<patch>', patch_number)
-
-  expect(@output.chomp).to eq(text)
-end
-
-Then(/^the linting report will be output to "([^"]*)"$/) do |file_path|
-  file_path.gsub!('<path_to>', @root_test_directory)
-
-  expect(File.read(file_path)).to match(/\d+ issues found/)
-end
-
-And(/^the file "([^"]*)" contains:$/) do |file_path, text|
-  file_path.gsub!('<path_to>', @root_test_directory)
-
-  expect(File.read(file_path)).to eq(text)
-end
-
-Then(/^the exit code is "([^"]*)"$/) do |exit_code|
-  expect(@results[:status].exitstatus).to eq(exit_code.to_i)
-end