cuke_linter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 499570d540f5b32c4774f299e4733b932c32c2b14f3b52d47f4bec6e99854edd
-  data.tar.gz: 8e4361c1f2cd7c7f11f503dbc1ba9deaa073f89a220fbcf8cd1ef1cc63ff1265
+  metadata.gz: 5bc43845a692a99b982b4a41b56c877bc41231bf931e04defd9d70aad2193f04
+  data.tar.gz: 6b8e365c8eda00b38728d02fd88caad4b04fc601c94caeb03dc760bc374ebac9
 SHA512:
-  metadata.gz: 37d73b22eb4be9d13b98339b14605c6d5b99c4c3584bc03f8baada3f88035787d4427980b0308855277ceccd5aa846468cecb34e03ad6e5c20b936426dfc62ab
-  data.tar.gz: e678c2ee1ac758234b4fd461c4c46acc555e5752d886203189b155a451a294b74d40b971b5aa8415af3239fa402ead4f9352bc6188a245d9dede6b720e1d5a1c
+  metadata.gz: 650f8900dc73461011250fc3d487c0c14f85e7064c7bed6b65316fedaeac167dd368127ee900774058d6109e6a4ea397994eeeffa9b6295fec223ae5c5344cf4
+  data.tar.gz: 9ee27f5bc99953d7b830dd4ffcdec2fd47b6fe51f1b4f9fce2cdb1380495705325fa10be710afdf88268c1c4113a36803e8a71bcc5c1d1932749c0784f151bc2

data/CHANGELOG.md

@@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing yet...
 
+## [0.3.0] - 2019-04-07
+
+### Added
+ - Linter configuration: linters can now be configured (turned on/off, conditions changed, etc.) instead of having to always use the default settings
+
 ## [0.2.0] - 2019-03-19
 
 ### Added
@@ -23,6 +28,7 @@ Nothing yet...
 - Custom linters, formatters, and command line usability
 
 
-[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/enkessler/cuke_linter/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/enkessler/cuke_linter/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/enkessler/cuke_linter/compare/2bbd3f29f4eb45b6e9ea7d47c5bb47182bf4fde7...v0.1.0

data/Rakefile

@@ -1,8 +1,9 @@
 require 'rake'
 require 'racatt'
 require 'coveralls/rake/task'
-require 'colorize'
+require 'rainbow'
 
+Rainbow.enabled = true
 
 namespace 'racatt' do
   Racatt.create_tasks
@@ -19,20 +20,20 @@ namespace 'cuke_linter' do
 
   desc 'Check documentation with RDoc'
   task :check_documentation do
-    output = `rdoc lib`
+    output = `rdoc lib -C`
     puts output
 
     if output =~ /100.00% documented/
-      puts 'All code documented'.green
+      puts Rainbow('All code documented').green
     else
-      raise 'Parts of the gem are undocumented'.red
+      raise Rainbow('Parts of the gem are undocumented').red
     end
   end
 
   desc 'Run all of the tests'
   task :test_everything => [:clear_coverage] do
-    rspec_args    = '--pattern "testing/rspec/spec/**/*_spec.rb"'
-    cucumber_args = "testing/cucumber/features -r environments/cucumber_env.rb -f progress -t 'not @wip'"
+    rspec_args    = '--pattern "testing/rspec/spec/**/*_spec.rb" --force-color'
+    cucumber_args = "testing/cucumber/features -r environments/cucumber_env.rb -f progress -t 'not @wip' --color"
 
     Rake::Task['racatt:test_everything'].invoke(rspec_args, cucumber_args)
   end
@@ -42,6 +43,20 @@ namespace 'cuke_linter' do
 
   desc 'The task that CI will run. Do not run locally.'
   task :ci_build => ['cuke_linter:test_everything', 'coveralls:push']
+
+  desc 'Check that things look good before trying to release'
+  task :prerelease_check do
+    begin
+      Rake::Task['cuke_linter:test_everything'].invoke
+      Rake::Task['cuke_linter:check_documentation'].invoke
+    rescue => e
+      puts Rainbow("Something isn't right!").red
+      raise e
+    end
+
+    puts Rainbow('All is well. :)').green
+  end
+
 end
 
 

data/cuke_linter.gemspec

@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'simplecov', '< 1.0.0'
   spec.add_development_dependency 'coveralls', '< 1.0.0'
-  spec.add_development_dependency 'colorize', '< 1.0.0'
+  spec.add_development_dependency 'rainbow', '< 4.0.0'
 end

data/environments/cucumber_env.rb

@@ -7,6 +7,14 @@ 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)

data/environments/rspec_env.rb

@@ -4,8 +4,10 @@ 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'

data/lib/cuke_linter.rb

@@ -12,33 +12,56 @@ require 'cuke_linter/linters/test_with_too_many_steps_linter'
 
 module CukeLinter
 
-  @registered_linters = { 'FeatureWithoutScenariosLinter'     => FeatureWithoutScenariosLinter.new,
-                          'ExampleWithoutNameLinter'          => ExampleWithoutNameLinter.new,
-                          'OutlineWithSingleExampleRowLinter' => OutlineWithSingleExampleRowLinter.new,
-                          'TestWithTooManyStepsLinter'        => TestWithTooManyStepsLinter.new }
+  @original_linters = { 'FeatureWithoutScenariosLinter'     => FeatureWithoutScenariosLinter.new,
+                        'ExampleWithoutNameLinter'          => ExampleWithoutNameLinter.new,
+                        'OutlineWithSingleExampleRowLinter' => OutlineWithSingleExampleRowLinter.new,
+                        'TestWithTooManyStepsLinter'        => TestWithTooManyStepsLinter.new }
+
+  # Configures linters based on the given options
+  def self.load_configuration(config_file_path: nil, config: nil)
+    # TODO: define what happens if both a configuration file and a configuration are provided. Merge them or have direct config take precedence? Both?
+
+    unless config || config_file_path
+      config_file_path = "#{Dir.pwd}/.cuke_linter"
+      raise 'No configuration or configuration file given and no .cuke_linter file found' unless File.exist?(config_file_path)
+    end
+
+    config = config || YAML.load_file(config_file_path)
+
+    config.each_pair do |linter_name, options|
+      unregister_linter(linter_name) if options.key?('Enabled') && !options['Enabled']
+
+      registered_linters[linter_name].configure(options) if registered_linters[linter_name]
+    end
+  end
+
+  # Returns the registered linters to their default state
+  def self.reset_linters
+    @registered_linters = nil
+  end
 
   # Registers for linting use the given linter object, tracked by the given name
   def self.register_linter(linter:, name:)
-    @registered_linters[name] = linter
+    self.registered_linters[name] = linter
   end
 
   # Unregisters the linter object tracked by the given name so that it is not used for linting
   def self.unregister_linter(name)
-    @registered_linters.delete(name)
+    self.registered_linters.delete(name)
   end
 
   # Lists the names of the currently registered linting objects
   def self.registered_linters
-    @registered_linters
+    @registered_linters ||= Marshal.load(Marshal.dump(@original_linters))
   end
 
   # Unregisters all currently registered linting objects
   def self.clear_registered_linters
-    @registered_linters.clear
+    self.registered_linters.clear
   end
 
   # Lints the tree of model objects rooted at the given model using the given linting objects and formatting the results with the given formatters and their respective output locations
-  def self.lint(model_tree: CukeModeler::Directory.new(Dir.pwd), linters: @registered_linters.values, formatters: [[CukeLinter::PrettyFormatter.new]])
+  def self.lint(model_tree: CukeModeler::Directory.new(Dir.pwd), linters: self.registered_linters.values, formatters: [[CukeLinter::PrettyFormatter.new]])
     # puts "model tree: #{model_tree}"
     # puts "linters: #{linters}"
     # puts "formatters: #{formatters}"

data/lib/cuke_linter/linters/test_with_too_many_steps_linter.rb

@@ -9,14 +9,20 @@ module CukeLinter
       'TestWithTooManyStepsLinter'
     end
 
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @step_threshold = options['StepThreshold'] if options['StepThreshold']
+    end
+
     # Lints the given model and returns linting data about said model
     def lint(model)
       return [] unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)
 
-      step_count = model.steps.nil? ? 0 : model.steps.count
+      step_count     = model.steps.nil? ? 0 : model.steps.count
+      step_threshold = @step_threshold || 10
 
-      if step_count > 10
-        [{ problem: "Test has too many steps. #{step_count} steps found (max 10)", location: "#{model.get_ancestor(:feature_file).path}:#{model.source_line}" }]
+      if step_count > step_threshold
+        [{ problem: "Test has too many steps. #{step_count} steps found (max #{step_threshold})", location: "#{model.get_ancestor(:feature_file).path}:#{model.source_line}" }]
       else
         []
       end

data/lib/cuke_linter/version.rb

@@ -1,4 +1,4 @@
 module CukeLinter
   # The release version of this gem
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/testing/cucumber/features/configuration/configuring_linters.feature

@@ -0,0 +1,19 @@
+Feature: Configuration of linters
+
+  Instead of having to modify the linting object directly in a script at runtime, a configuration file can be used so that specific linters can be configured in a more convenient, static manner. Some configurable properties are available across all linters while some are linter specific.
+
+
+  Scenario: Disabling a linter
+    Given a linter registered as "AlwaysFindsAProblem"
+    And the following configuration file:
+      """
+      AlwaysFindsAProblem:
+        Enabled: false
+      """
+    And the following feature:
+      """
+      Feature: Something in which a problem could exist
+      """
+    When the configuration file is used
+    And the feature is linted
+    Then no error is reported

data/testing/cucumber/features/configuration/using_configurations.feature

@@ -0,0 +1,46 @@
+Feature: Using a configuration
+
+  Configuration can be done during a script or through a configuration file. This file can be explicitly provided or a default configuration file will be used.
+
+
+  Scenario: Providing a configuration directly
+    Given a linter registered as "SomeLinter"
+    When the following code is used:
+      """
+      CukeLinter.load_configuration(config: { 'SomeLinter' => { 'Enabled' => false } })
+      """
+    Then the linter "SomeLinter" is no longer registered
+
+  Scenario: Loading a configuration from a file
+    Given a linter registered as "SomeLinter"
+    And the following configuration file "my_config.file":
+      """
+      SomeLinter:
+        Enabled: false
+      """
+    When the following code is used:
+      """
+      CukeLinter.load_configuration(config_file_path: '<path_to>/my_config.file')
+      """
+    Then the linter "SomeLinter" is no longer registered
+
+  Scenario: Using the default configuration file
+    Given a directory "test_directory"
+    And the following configuration file "test_directory/.cuke_linter":
+      """
+      SomeLinter:
+        Enabled: false
+      """
+    And a linter registered as "SomeLinter"
+    When "test_directory" is the current directory
+    And the following code is used:
+      """
+      CukeLinter.load_configuration
+      """
+    Then the linter "SomeLinter" is no longer registered
+
+  @wip
+  Scenario: Configuring from the command line
+
+  @wip
+  Scenario: Using the default configuration file from the command line

data/testing/cucumber/features/linters/default_linters.feature

@@ -6,7 +6,7 @@ Feature: Default Linters
 
 
   Scenario: Using the default linters
-    Given no other linters have been registered
+    Given no other linters have been registered or unregistered
     Then the following linters are registered by default
       | ExampleWithoutNameLinter          |
       | FeatureWithoutScenariosLinter     |

data/testing/cucumber/features/linters/test_with_too_many_steps.feature

@@ -31,3 +31,26 @@ Feature: Test with too many steps linter
     Then an error is reported
       | linter                     | problem                                          | location         |
       | TestWithTooManyStepsLinter | Test has too many steps. 11 steps found (max 10) | <path_to_file>:3 |
+
+  Scenario: Configuration of step count threshold
+    Given a linter for tests with too many steps has been registered
+    And the following configuration file:
+      """
+      TestWithTooManyStepsLinter:
+        StepThreshold: 3
+      """
+    And the following feature:
+      """
+      Feature:
+
+        Scenario:
+          * step 1
+          * step 2
+          * step 3
+          * step one too many...
+      """
+    When the configuration file is loaded
+    And the feature is linted
+    Then an error is reported
+      | linter                     | problem                                        | location         |
+      | TestWithTooManyStepsLinter | Test has too many steps. 4 steps found (max 3) | <path_to_file>:3 |

data/testing/cucumber/step_definitions/action_steps.rb

@@ -8,10 +8,30 @@ When(/^it is formatted by the "([^"]*)" formatter$/) do |linter_name|
   @results = CukeLinter.const_get("#{linter_name.capitalize}Formatter").new.format(@linter_data)
 end
 
-When(/^it is linted$/) do
-  options = { model_tree: @model,
-              linters:    [@linter],
-              formatters: [[CukeLinter::FormatterFactory.generate_fake_formatter, "#{CukeLinter::FileHelper::create_directory}/junk_output_file.txt"]] }
+When(/^(?:the feature|it) is linted$/) do
+  options           = { model_tree: @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)
+
+  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

data/testing/cucumber/step_definitions/setup_steps.rb

@@ -25,8 +25,8 @@ Given(/^a linter for features without scenarios$/) do
   @linter = CukeLinter::FeatureWithoutScenariosLinter.new
 end
 
-Given(/^no other linters have been registered$/) do
-  # There is no way to 'reset' the linters, so just assume that no changes have been made
+Given(/^no other linters have been registered or unregistered$/) do
+  CukeLinter.reset_linters
 end
 
 Given(/^a linter for examples without names$/) do
@@ -40,3 +40,25 @@ end
 Given(/^a linter for tests with too many steps$/) do
   @linter = CukeLinter::TestWithTooManyStepsLinter.new
 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(/^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

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -17,3 +17,11 @@ 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(/^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

data/testing/file_helper.rb

@@ -22,6 +22,18 @@ module CukeLinter
         path
       end
 
+      def create_file(options = {})
+        options[:text]      ||= ''
+        options[:name]      ||= 'test_file'
+        options[:extension] ||= '.txt'
+        options[:directory] ||= create_directory
+
+        file_path = "#{options[:directory]}/#{options[:name]}#{options[:extension]}"
+        File.write(file_path, options[:text])
+
+        file_path
+      end
+
     end
 
   end

data/testing/linter_factory.rb

@@ -5,9 +5,10 @@ module CukeLinter
       linter = Object.new
 
       linter.define_singleton_method('lint') do |model|
-        location = model.respond_to?(:source_line) ? "#{model.get_ancestor(:feature_file).path}:#{model.source_line}" :
-                       model.path
-        [{ problem:  "#{name} problem",
+        location = model.respond_to?(:source_line) ? "#{model.get_ancestor(:feature_file).path}:#{model.source_line}" : model.path
+        problem  = @problem || "#{name} problem"
+
+        [{ problem:  problem,
            location: location }]
       end
 
@@ -15,6 +16,11 @@ module CukeLinter
         name
       end
 
+      linter.define_singleton_method('configure') do |options|
+        @problem = options['Problem'] if options['Problem']
+      end
+
+
       linter
     end
 

data/testing/rspec/spec/integration/cuke_linter_integration_spec.rb

@@ -115,4 +115,79 @@ RSpec.describe CukeLinter do
     expect(subject.registered_linters['TestWithTooManyStepsLinter']).to be_a(CukeLinter::TestWithTooManyStepsLinter)
   end
 
+  it 'returns to its default set of linters after being reset' do
+    original_names        = CukeLinter.registered_linters.keys
+    original_linter_types = CukeLinter.registered_linters.values.map(&:class)
+    new_linter            = CukeLinter::LinterFactory.generate_fake_linter
+
+    CukeLinter.register_linter(linter: new_linter, name: 'FakeLinter')
+    CukeLinter.reset_linters
+
+    expect(CukeLinter.registered_linters.keys).to eq(original_names)
+    expect(CukeLinter.registered_linters.values.map(&:class)).to eq(original_linter_types)
+  end
+
+  # To protect against someone modifying them
+  it 'does not reuse the old linting objects when resetting to the default linters' do
+    original_linter_ids = CukeLinter.registered_linters.values.map(&:object_id)
+
+    CukeLinter.reset_linters
+
+    expect(CukeLinter.registered_linters.values.map(&:object_id)).to_not match_array(original_linter_ids)
+  end
+
+
+  describe 'configuration' do
+
+    it 'unregisters disabled linters' do
+      config             = { 'FakeLinter1' => { 'Enabled' => false } }
+      configuration_file = CukeLinter::FileHelper.create_file(name: '.cuke_linter', extension: '', text: config.to_yaml)
+
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter1'), name: 'FakeLinter1')
+      expect(subject.registered_linters['FakeLinter1']).to_not be nil
+
+      subject.load_configuration(config_file_path: configuration_file)
+
+      expect(subject.registered_linters['FakeLinter1']).to be nil
+    end
+
+    it 'uses the default configuration file in the current directory if no configuration file is provided' do
+      config             = { 'FakeLinter1' => { 'Enabled' => false } }
+      configuration_file = CukeLinter::FileHelper.create_file(name: '.cuke_linter', extension: '', text: config.to_yaml)
+
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter1'), name: 'FakeLinter1')
+      expect(subject.registered_linters['FakeLinter1']).to_not be nil
+
+      Dir.chdir(File.dirname(configuration_file)) do
+        subject.load_configuration
+      end
+
+      expect(subject.registered_linters['FakeLinter1']).to be nil
+    end
+
+    it 'raises an exception if no default configuration file is found and no configuration or file is provided' do
+      some_empty_directory = CukeLinter::FileHelper.create_directory
+
+      Dir.chdir(File.dirname(some_empty_directory)) do
+        expect { subject.load_configuration }.to raise_error('No configuration or configuration file given and no .cuke_linter file found')
+      end
+    end
+
+    it 'configures every linter for which it has a configuration' do
+      config = { 'FakeLinter1' => { 'Problem' => 'My custom message for FakeLinter1' },
+                 'FakeLinter2' => { 'Problem' => 'My custom message for FakeLinter2' } }
+
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter1'), name: 'FakeLinter1')
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter2'), name: 'FakeLinter2')
+      linting_options.delete(:linters)
+
+      subject.load_configuration(config: config)
+      results = subject.lint(linting_options)
+
+      expect(results).to match_array([{ linter: 'FakeLinter1', location: 'path_to_file:1', problem: 'My custom message for FakeLinter1' },
+                                      { linter: 'FakeLinter2', location: 'path_to_file:1', problem: 'My custom message for FakeLinter2' }])
+    end
+
+  end
+
 end

data/testing/rspec/spec/unit/cuke_linter_unit_spec.rb

@@ -80,4 +80,22 @@ RSpec.describe CukeLinter do
     expect(CukeLinter.registered_linters).to eq({})
   end
 
+  it 'can reset to its default set of linters' do
+    expect(CukeLinter).to respond_to(:reset_linters)
+  end
+
+  describe 'configuration' do
+
+    it 'can load a configuration' do
+      expect(CukeLinter).to respond_to(:load_configuration)
+    end
+
+    it 'is configured optionally via a file or a directly provided configuration' do
+      expect(CukeLinter.method(:load_configuration).arity).to eq(-1)
+      expect(CukeLinter.method(:load_configuration).parameters).to match_array([[:key, :config_file_path],
+                                                                                [:key, :config]])
+    end
+
+  end
+
 end

data/testing/rspec/spec/unit/linters/configurable_linter_unit_specs.rb

@@ -0,0 +1,11 @@
+shared_examples_for 'a configurable linter at the unit level' do
+
+  it 'is configurable' do
+    expect(subject).to respond_to(:configure)
+  end
+
+  it 'is configured via a set of options' do
+    expect(subject.method(:configure).arity).to eq(1)
+  end
+
+end

data/testing/rspec/spec/unit/linters/test_with_too_many_steps_linter_unit_spec.rb

@@ -29,6 +29,7 @@ RSpec.describe CukeLinter::TestWithTooManyStepsLinter do
 
 
   it_should_behave_like 'a linter at the unit level'
+  it_should_behave_like 'a configurable linter at the unit level'
 
 
   it 'has a name' do
@@ -139,6 +140,78 @@ RSpec.describe CukeLinter::TestWithTooManyStepsLinter do
 
       end
 
+
+      describe 'configuration' do
+
+        context 'with no configuration' do
+
+          let(:default_step_threshhold) { 10 }
+
+          context 'because configuration never happened' do
+
+            let(:unconfigured_test_model) do
+              model       = CukeLinter::ModelFactory.send("generate_#{model_type}_model")
+              model.steps = []
+              (default_step_threshhold + 1).times { model.steps << :a_step }
+
+              model
+            end
+
+            it 'defaults to a step threshold of 10 steps' do
+              results = subject.lint(unconfigured_test_model)
+
+              expect(results.first[:problem]).to match(/^Test has too many steps. #{unconfigured_test_model.steps.count} steps found \(max 10\)/)
+            end
+
+          end
+
+          context 'because configuration did not set a step threshold' do
+            let(:configuration) { {} }
+            let(:configured_test_model) do
+              model       = CukeLinter::ModelFactory.send("generate_#{model_type}_model")
+              model.steps = []
+              (default_step_threshhold + 1).times { model.steps << :a_step }
+
+              subject.configure(configuration)
+
+              model
+            end
+
+            it 'defaults to a step threshold of 10 steps' do
+              results = subject.lint(configured_test_model)
+
+              expect(results.first[:problem]).to match(/^Test has too many steps. #{configured_test_model.steps.count} steps found \(max 10\)/)
+            end
+
+          end
+
+        end
+
+
+        context 'with configuration' do
+
+          let(:step_threshhold) { 3 }
+          let(:configuration) { { 'StepThreshold' => step_threshhold } }
+          let(:configured_test_model) do
+            model       = CukeLinter::ModelFactory.send("generate_#{model_type}_model")
+            model.steps = []
+            (step_threshhold + 1).times { model.steps << :a_step }
+
+            subject.configure(configuration)
+
+            model
+          end
+
+          it 'the step threshold used is the configured value' do
+            results = subject.lint(configured_test_model)
+
+            expect(results.first[:problem]).to match(/^Test has too many steps. #{configured_test_model.steps.count} steps found \(max #{step_threshhold}\)/)
+          end
+
+        end
+
+      end
+
     end
 
     context 'a non-test model' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_linter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2019-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -137,19 +137,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 4.0.0
 description: 
 email:
 - morrow748@gmail.com
@@ -182,6 +182,8 @@ files:
 - lib/cuke_linter/linters/test_with_too_many_steps_linter.rb
 - lib/cuke_linter/version.rb
 - testing/cucumber/features/command_line.feature
+- testing/cucumber/features/configuration/configuring_linters.feature
+- testing/cucumber/features/configuration/using_configurations.feature
 - testing/cucumber/features/formatters/pretty_formatter.feature
 - testing/cucumber/features/linters/default_linters.feature
 - testing/cucumber/features/linters/example_without_name.feature
@@ -206,6 +208,7 @@ files:
 - testing/rspec/spec/unit/cuke_linter_unit_spec.rb
 - testing/rspec/spec/unit/formatters/formatter_unit_specs.rb
 - testing/rspec/spec/unit/formatters/pretty_formatter_unit_spec.rb
+- testing/rspec/spec/unit/linters/configurable_linter_unit_specs.rb
 - testing/rspec/spec/unit/linters/example_without_name_linter_unit_spec.rb
 - testing/rspec/spec/unit/linters/feature_without_scenarios_linter_unit_spec.rb
 - testing/rspec/spec/unit/linters/linter_unit_specs.rb