cuke_linter 1.3.0 → 1.4.0

data/exe/cuke_linter

@@ -1,112 +1,112 @@
-#!/usr/bin/env ruby
-
-require 'cuke_linter'
-require 'optparse'
-
-params              = {}
-params[:paths]      = []
-params[:formatters] = []
-params[:outs]       = []
-params[:requires]   = []
-
-# rubocop:disable Metrics/BlockLength
-parser = OptionParser.new do |options|
-
-  options.set_summary_width(30)
-
-  options.on('-p', '--path PATH', String,
-             'The file path that should be linted. Can be a file or directory.',
-             'This option can be specified multiple times in order to lint',
-             'multiple, unconnected locations.') do |path|
-    params[:paths] << path
-  end
-
-  options.on('-f', '--formatter FORMATTER', String,
-             'The formatter used for generating linting output. This option',
-             'can be specified multiple times in order to use more than one',
-             'formatter. Formatters must be specified using their fully',
-             'qualified class name (e.g CukeLinter::PrettyFormatter). Uses',
-             'the default formatter if none are specified.') do |format|
-    params[:formatters] << format
-  end
-
-  options.on('-o', '--out OUT', String,
-             'The file path to which linting results are output. Can be specified',
-             'multiple times. Specified files are matched to formatters in the',
-             'same order that the formatters are specified. Any formatter without',
-             'a corresponding file path will output to STDOUT instead.') do |out|
-    params[:outs] << out
-  end
-
-  options.on('-r', '--require FILEPATH', String,
-             'A file that will be required before further processing. Likely',
-             'needed when using custom linters or formatters in order to ensure',
-             'that the specified classes have been read into memory. This option',
-             'can be specified multiple times in order to load more than one file.') do |file_path|
-    params[:requires] << file_path
-  end
-
-  options.on('-c', '--config FILEPATH', String,
-             'The configuration file that will be used. Will use the default',
-             'configuration file (if present) if this option is not specified.') do |file_path|
-
-    if params[:config]
-      puts 'Cannot specify more than one configuration file!'
-      exit(2)
-    end
-
-    params[:config] = file_path
-  end
-
-  options.on('-h', '--help', 'Display the help that you are reading now.') do
-    puts options.help
-    exit
-  end
-
-  options.on('-v', '--version', 'Display the version of the gem being used.') do
-    puts CukeLinter::VERSION
-    exit
-  end
-
-end
-# rubocop:enable Metrics/BlockLength
-
-begin
-  parser.parse!
-rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
-  puts e.message
-  puts parser.help
-
-  exit(2)
-end
-
-
-require_files = params[:requires]
-
-require_files.each do |file|
-  require file
-end
-
-file_paths   = params[:paths]
-formatters   = params[:formatters].map { |formatter| Kernel.const_get(formatter).new }
-output_paths = params[:outs]
-
-bundled_formatters = [].tap do |formatter_output_pairs|
-  [formatters.count, output_paths.count].max.times do |count|
-    formatter_output_pairs << [formatters[count] || CukeLinter::PrettyFormatter.new, output_paths[count]]
-  end
-end
-
-options              = {}
-options[:formatters] = bundled_formatters unless bundled_formatters.empty?
-options[:file_paths] = file_paths
-
-if params[:config]
-  CukeLinter.load_configuration(config_file_path: params[:config])
-elsif File.exist?("#{Dir.pwd}/.cuke_linter")
-  CukeLinter.load_configuration
-end
-
-results = CukeLinter.lint(**options)
-
-exit(1) unless results.empty?
+#!/usr/bin/env ruby
+
+require 'cuke_linter'
+require 'optparse'
+
+params              = {}
+params[:paths]      = []
+params[:formatters] = []
+params[:outs]       = []
+params[:requires]   = []
+
+# rubocop:disable Metrics/BlockLength
+parser = OptionParser.new do |options|
+
+  options.set_summary_width(30)
+
+  options.on('-p', '--path PATH', String,
+             'The file path that should be linted. Can be a file or directory.',
+             'This option can be specified multiple times in order to lint',
+             'multiple, unconnected locations.') do |path|
+    params[:paths] << path
+  end
+
+  options.on('-f', '--formatter FORMATTER', String,
+             'The formatter used for generating linting output. This option',
+             'can be specified multiple times in order to use more than one',
+             'formatter. Formatters must be specified using their fully',
+             'qualified class name (e.g CukeLinter::PrettyFormatter). Uses',
+             'the default formatter if none are specified.') do |format|
+    params[:formatters] << format
+  end
+
+  options.on('-o', '--out OUT', String,
+             'The file path to which linting results are output. Can be specified',
+             'multiple times. Specified files are matched to formatters in the',
+             'same order that the formatters are specified. Any formatter without',
+             'a corresponding file path will output to STDOUT instead.') do |out|
+    params[:outs] << out
+  end
+
+  options.on('-r', '--require FILEPATH', String,
+             'A file that will be required before further processing. Likely',
+             'needed when using custom linters or formatters in order to ensure',
+             'that the specified classes have been read into memory. This option',
+             'can be specified multiple times in order to load more than one file.') do |file_path|
+    params[:requires] << file_path
+  end
+
+  options.on('-c', '--config FILEPATH', String,
+             'The configuration file that will be used. Will use the default',
+             'configuration file (if present) if this option is not specified.') do |file_path|
+
+    if params[:config]
+      puts 'Cannot specify more than one configuration file!'
+      exit(2)
+    end
+
+    params[:config] = file_path
+  end
+
+  options.on('-h', '--help', 'Display the help that you are reading now.') do
+    puts options.help
+    exit
+  end
+
+  options.on('-v', '--version', 'Display the version of the gem being used.') do
+    puts CukeLinter::VERSION
+    exit
+  end
+
+end
+# rubocop:enable Metrics/BlockLength
+
+begin
+  parser.parse!
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+  puts e.message
+  puts parser.help
+
+  exit(2)
+end
+
+
+require_files = params[:requires]
+
+require_files.each do |file|
+  require file
+end
+
+file_paths   = params[:paths]
+formatters   = params[:formatters].map { |formatter| Kernel.const_get(formatter).new }
+output_paths = params[:outs]
+
+bundled_formatters = [].tap do |formatter_output_pairs|
+  [formatters.count, output_paths.count].max.times do |count|
+    formatter_output_pairs << [formatters[count] || CukeLinter::PrettyFormatter.new, output_paths[count]]
+  end
+end
+
+options              = {}
+options[:formatters] = bundled_formatters unless bundled_formatters.empty?
+options[:file_paths] = file_paths
+
+if params[:config]
+  CukeLinter.load_configuration(config_file_path: params[:config])
+elsif File.exist?("#{Dir.pwd}/.cuke_linter")
+  CukeLinter.load_configuration
+end
+
+results = CukeLinter.lint(**options)
+
+exit(1) unless results.empty?

data/lib/cuke_linter/configuration.rb

@@ -1,45 +1,45 @@
-module CukeLinter
-
-  # Mix-in module containing methods related to configuring linters
-  module Configuration
-
-    # Configures linters based on the given options
-    def 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"
-        message          = 'No configuration or configuration file given and no .cuke_linter file found'
-        raise message unless File.exist?(config_file_path)
-      end
-
-      config ||= YAML.load_file(config_file_path)
-      configure_linters(config, registered_linters)
-    end
-
-
-    private
-
-
-    def configure_linters(configuration, linters)
-      common_config = configuration['AllLinters'] || {}
-      to_delete     = []
-
-      linters.each_pair do |name, linter|
-        linter_config = configuration[name] || {}
-        final_config  = common_config.merge(linter_config)
-
-        disabled = (final_config.key?('Enabled') && !final_config['Enabled'])
-
-        # Just save it for afterwards because modifying a collection while iterating through it is not a good idea
-        to_delete << name if disabled
-
-        linter.configure(final_config) if linter.respond_to?(:configure)
-      end
-
-      to_delete.each { |linter_name| unregister_linter(linter_name) }
-    end
-
-  end
-end
+module CukeLinter
+
+  # Mix-in module containing methods related to configuring linters
+  module Configuration
+
+    # Configures linters based on the given options
+    def 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"
+        message          = 'No configuration or configuration file given and no .cuke_linter file found'
+        raise message unless File.exist?(config_file_path)
+      end
+
+      config ||= YAML.load_file(config_file_path)
+      configure_linters(config, registered_linters)
+    end
+
+
+    private
+
+
+    def configure_linters(configuration, linters) # rubocop:disable Metrics/CyclomaticComplexity -- Maybe I'll revisit this later
+      common_config = configuration['AllLinters'] || {}
+      to_delete     = []
+
+      linters.each_pair do |name, linter|
+        linter_config = configuration[name] || {}
+        final_config  = common_config.merge(linter_config)
+
+        disabled = final_config.key?('Enabled') && !final_config['Enabled']
+
+        # Just save it for afterwards because modifying a collection while iterating through it is not a good idea
+        to_delete << name if disabled
+
+        linter.configure(final_config) if linter.respond_to?(:configure)
+      end
+
+      to_delete.each { |linter_name| unregister_linter(linter_name) }
+    end
+
+  end
+end

data/lib/cuke_linter/default_linters.rb

@@ -1,32 +1,32 @@
-module CukeLinter # rubocop:disable Style/Documentation
-
-  # Long names inherently result in long lines
-  # rubocop:disable Metrics/LineLength
-  @original_linters = { 'BackgroundDoesMoreThanSetupLinter'            => BackgroundDoesMoreThanSetupLinter.new,
-                        'ElementWithCommonTagsLinter'                  => ElementWithCommonTagsLinter.new,
-                        'ElementWithDuplicateTagsLinter'               => ElementWithDuplicateTagsLinter.new,
-                        'ElementWithTooManyTagsLinter'                 => ElementWithTooManyTagsLinter.new,
-                        'ExampleWithoutNameLinter'                     => ExampleWithoutNameLinter.new,
-                        'FeatureFileWithInvalidNameLinter'             => FeatureFileWithInvalidNameLinter.new,
-                        'FeatureFileWithMismatchedNameLinter'          => FeatureFileWithMismatchedNameLinter.new,
-                        'FeatureWithTooManyDifferentTagsLinter'        => FeatureWithTooManyDifferentTagsLinter.new,
-                        'FeatureWithoutDescriptionLinter'              => FeatureWithoutDescriptionLinter.new,
-                        'FeatureWithoutNameLinter'                     => FeatureWithoutNameLinter.new,
-                        'FeatureWithoutScenariosLinter'                => FeatureWithoutScenariosLinter.new,
-                        'OutlineWithSingleExampleRowLinter'            => OutlineWithSingleExampleRowLinter.new,
-                        'SingleTestBackgroundLinter'                   => SingleTestBackgroundLinter.new,
-                        'StepWithEndPeriodLinter'                      => StepWithEndPeriodLinter.new,
-                        'StepWithTooManyCharactersLinter'              => StepWithTooManyCharactersLinter.new,
-                        'TestShouldUseBackgroundLinter'                => TestShouldUseBackgroundLinter.new,
-                        'TestWithActionStepAsFinalStepLinter'          => TestWithActionStepAsFinalStepLinter.new,
-                        'TestWithBadNameLinter'                        => TestWithBadNameLinter.new,
-                        'TestWithNoActionStepLinter'                   => TestWithNoActionStepLinter.new,
-                        'TestWithNoNameLinter'                         => TestWithNoNameLinter.new,
-                        'TestWithNoVerificationStepLinter'             => TestWithNoVerificationStepLinter.new,
-                        'TestWithSetupStepAfterActionStepLinter'       => TestWithSetupStepAfterActionStepLinter.new,
-                        'TestWithSetupStepAfterVerificationStepLinter' => TestWithSetupStepAfterVerificationStepLinter.new,
-                        'TestWithSetupStepAsFinalStepLinter'           => TestWithSetupStepAsFinalStepLinter.new,
-                        'TestWithTooManyStepsLinter'                   => TestWithTooManyStepsLinter.new }
-  # rubocop:enable Metrics/LineLength
-
-end
+module CukeLinter # rubocop:disable Style/Documentation
+
+  # Long names inherently result in long lines
+  # rubocop:disable Layout/LineLength
+  @original_linters = { 'BackgroundDoesMoreThanSetupLinter'            => BackgroundDoesMoreThanSetupLinter.new,
+                        'ElementWithCommonTagsLinter'                  => ElementWithCommonTagsLinter.new,
+                        'ElementWithDuplicateTagsLinter'               => ElementWithDuplicateTagsLinter.new,
+                        'ElementWithTooManyTagsLinter'                 => ElementWithTooManyTagsLinter.new,
+                        'ExampleWithoutNameLinter'                     => ExampleWithoutNameLinter.new,
+                        'FeatureFileWithInvalidNameLinter'             => FeatureFileWithInvalidNameLinter.new,
+                        'FeatureFileWithMismatchedNameLinter'          => FeatureFileWithMismatchedNameLinter.new,
+                        'FeatureWithTooManyDifferentTagsLinter'        => FeatureWithTooManyDifferentTagsLinter.new,
+                        'FeatureWithoutDescriptionLinter'              => FeatureWithoutDescriptionLinter.new,
+                        'FeatureWithoutNameLinter'                     => FeatureWithoutNameLinter.new,
+                        'FeatureWithoutScenariosLinter'                => FeatureWithoutScenariosLinter.new,
+                        'OutlineWithSingleExampleRowLinter'            => OutlineWithSingleExampleRowLinter.new,
+                        'SingleTestBackgroundLinter'                   => SingleTestBackgroundLinter.new,
+                        'StepWithEndPeriodLinter'                      => StepWithEndPeriodLinter.new,
+                        'StepWithTooManyCharactersLinter'              => StepWithTooManyCharactersLinter.new,
+                        'TestShouldUseBackgroundLinter'                => TestShouldUseBackgroundLinter.new,
+                        'TestWithActionStepAsFinalStepLinter'          => TestWithActionStepAsFinalStepLinter.new,
+                        'TestWithBadNameLinter'                        => TestWithBadNameLinter.new,
+                        'TestWithNoActionStepLinter'                   => TestWithNoActionStepLinter.new,
+                        'TestWithNoNameLinter'                         => TestWithNoNameLinter.new,
+                        'TestWithNoVerificationStepLinter'             => TestWithNoVerificationStepLinter.new,
+                        'TestWithSetupStepAfterActionStepLinter'       => TestWithSetupStepAfterActionStepLinter.new,
+                        'TestWithSetupStepAfterVerificationStepLinter' => TestWithSetupStepAfterVerificationStepLinter.new,
+                        'TestWithSetupStepAsFinalStepLinter'           => TestWithSetupStepAsFinalStepLinter.new,
+                        'TestWithTooManyStepsLinter'                   => TestWithTooManyStepsLinter.new }
+  # rubocop:enable Layout/LineLength
+
+end

data/lib/cuke_linter/formatters/pretty_formatter.rb

@@ -1,84 +1,84 @@
-module CukeLinter
-
-  # Formats linting data into organized, user readable text
-  class PrettyFormatter
-
-    # Formats the given linting data
-    def format(data)
-      format_data(categorize_problems(data), data.count)
-    end
-
-
-    private
-
-
-    def categorize_problems(data)
-      {}.tap do |categorized_problems|
-        data.each do |lint_item|
-          categorized_problems[lint_item[:linter]]                      ||= {}
-          categorized_problems[lint_item[:linter]][lint_item[:problem]] ||= []
-          categorized_problems[lint_item[:linter]][lint_item[:problem]] << lint_item[:location]
-        end
-      end
-    end
-
-    def format_data(problem_data, problem_count)
-      ''.tap do |formatted_data|
-        problem_data.each_pair do |linter, problems|
-          formatted_data << "#{linter}\n"
-
-          problems.each_pair do |problem, locations|
-            formatted_data << "  #{problem}\n"
-
-            sort_locations(locations).each do |location|
-              formatted_data << "    #{location}\n"
-            end
-          end
-        end
-
-        formatted_data << "\n" unless problem_count.zero?
-        formatted_data << "#{problem_count} issues found"
-      end
-    end
-
-    def sort_locations(locations)
-      locations.sort do |a, b|
-        file_name_1   = a.match(/(.*?)(?::\d+)?$/)[1]
-        line_number_1 = a =~ /:\d+$/ ? a.match(/:(\d+)$/)[1].to_i : 0
-        file_name_2   = b.match(/(.*?)(?::\d+)?$/)[1]
-        line_number_2 = b =~ /:\d+$/ ? b.match(/:(\d+)$/)[1].to_i : 0
-
-        compare_locations(file_name_1, file_name_2, line_number_1, line_number_2)
-      end
-    end
-
-    def compare_locations(file_name_1, file_name_2, line_number_1, line_number_2)
-      if earlier_file(file_name_1, file_name_2) ||
-         same_file_earlier_line(file_name_1, file_name_2, line_number_1, line_number_2)
-        -1
-      elsif later_file(file_name_1, file_name_2) ||
-            same_file_later_line(file_name_1, file_name_2, line_number_1, line_number_2)
-        1
-      else
-        0
-      end
-    end
-
-    def earlier_file(file_name_1, file_name_2)
-      (file_name_1 < file_name_2)
-    end
-
-    def same_file_earlier_line(file_name_1, file_name_2, line_number_1, line_number_2)
-      (file_name_1 == file_name_2) && (line_number_1 < line_number_2)
-    end
-
-    def later_file(file_name_1, file_name_2)
-      (file_name_1 > file_name_2)
-    end
-
-    def same_file_later_line(file_name_1, file_name_2, line_number_1, line_number_2)
-      (file_name_1 == file_name_2) && (line_number_1 > line_number_2)
-    end
-
-  end
-end
+module CukeLinter
+
+  # Formats linting data into organized, user readable text
+  class PrettyFormatter
+
+    # Formats the given linting data
+    def format(data)
+      format_data(categorize_problems(data), data.count)
+    end
+
+
+    private
+
+
+    def categorize_problems(data)
+      {}.tap do |categorized_problems|
+        data.each do |lint_item|
+          categorized_problems[lint_item[:linter]]                      ||= {}
+          categorized_problems[lint_item[:linter]][lint_item[:problem]] ||= []
+          categorized_problems[lint_item[:linter]][lint_item[:problem]] << lint_item[:location]
+        end
+      end
+    end
+
+    def format_data(problem_data, problem_count)
+      ''.tap do |formatted_data|
+        problem_data.each_pair do |linter, problems|
+          formatted_data << "#{linter}\n"
+
+          problems.each_pair do |problem, locations|
+            formatted_data << "  #{problem}\n"
+
+            sort_locations(locations).each do |location|
+              formatted_data << "    #{location}\n"
+            end
+          end
+        end
+
+        formatted_data << "\n" unless problem_count.zero?
+        formatted_data << "#{problem_count} issues found"
+      end
+    end
+
+    def sort_locations(locations)
+      locations.sort do |a, b|
+        file_name_1   = a.match(/(.*?)(?::\d+)?$/)[1]
+        line_number_1 = a =~ /:\d+$/ ? a.match(/:(\d+)$/)[1].to_i : 0
+        file_name_2   = b.match(/(.*?)(?::\d+)?$/)[1]
+        line_number_2 = b =~ /:\d+$/ ? b.match(/:(\d+)$/)[1].to_i : 0
+
+        compare_locations(file_name_1, file_name_2, line_number_1, line_number_2)
+      end
+    end
+
+    def compare_locations(file_name_1, file_name_2, line_number_1, line_number_2)
+      if earlier_file(file_name_1, file_name_2) ||
+         same_file_earlier_line(file_name_1, file_name_2, line_number_1, line_number_2)
+        -1
+      elsif later_file(file_name_1, file_name_2) ||
+            same_file_later_line(file_name_1, file_name_2, line_number_1, line_number_2)
+        1
+      else
+        0
+      end
+    end
+
+    def earlier_file(file_name_1, file_name_2)
+      (file_name_1 < file_name_2)
+    end
+
+    def same_file_earlier_line(file_name_1, file_name_2, line_number_1, line_number_2)
+      (file_name_1 == file_name_2) && (line_number_1 < line_number_2)
+    end
+
+    def later_file(file_name_1, file_name_2)
+      (file_name_1 > file_name_2)
+    end
+
+    def same_file_later_line(file_name_1, file_name_2, line_number_1, line_number_2)
+      (file_name_1 == file_name_2) && (line_number_1 > line_number_2)
+    end
+
+  end
+end

data/lib/cuke_linter/gherkin.rb

@@ -1,10 +1,10 @@
-module CukeLinter
-
-  # The default keyword that is considered a 'Given' keyword
-  DEFAULT_GIVEN_KEYWORD = 'Given'.freeze
-  # The default keyword that is considered a 'When' keyword
-  DEFAULT_WHEN_KEYWORD = 'When'.freeze
-  # The default keyword that is considered a 'Then' keyword
-  DEFAULT_THEN_KEYWORD = 'Then'.freeze
-
-end
+module CukeLinter
+
+  # The default keyword that is considered a 'Given' keyword
+  DEFAULT_GIVEN_KEYWORD = 'Given'.freeze
+  # The default keyword that is considered a 'When' keyword
+  DEFAULT_WHEN_KEYWORD = 'When'.freeze
+  # The default keyword that is considered a 'Then' keyword
+  DEFAULT_THEN_KEYWORD = 'Then'.freeze
+
+end

data/lib/cuke_linter/linter_registration.rb

@@ -1,32 +1,32 @@
-module CukeLinter
-
-  # Mix-in module containing methods related to registering linters
-  module LinterRegistration
-
-    # Returns the registered linters to their default state
-    def reset_linters
-      @registered_linters = nil
-    end
-
-    # Registers for linting use the given linter object, tracked by the given name
-    def register_linter(linter:, name:)
-      registered_linters[name] = linter
-    end
-
-    # Unregisters the linter object tracked by the given name so that it is not used for linting
-    def unregister_linter(name)
-      registered_linters.delete(name)
-    end
-
-    # Lists the names of the currently registered linting objects
-    def registered_linters
-      @registered_linters ||= Marshal.load(Marshal.dump(@original_linters))
-    end
-
-    # Unregisters all currently registered linting objects
-    def clear_registered_linters
-      registered_linters.clear
-    end
-
-  end
-end
+module CukeLinter
+
+  # Mix-in module containing methods related to registering linters
+  module LinterRegistration
+
+    # Returns the registered linters to their default state
+    def reset_linters
+      @registered_linters = nil
+    end
+
+    # Registers for linting use the given linter object, tracked by the given name
+    def register_linter(linter:, name:)
+      registered_linters[name] = linter
+    end
+
+    # Unregisters the linter object tracked by the given name so that it is not used for linting
+    def unregister_linter(name)
+      registered_linters.delete(name)
+    end
+
+    # Lists the names of the currently registered linting objects
+    def registered_linters
+      @registered_linters ||= Marshal.load(Marshal.dump(@original_linters))
+    end
+
+    # Unregisters all currently registered linting objects
+    def clear_registered_linters
+      registered_linters.clear
+    end
+
+  end
+end