Contents

# frozen_string_literal: true

require 'active_support/configurable'

# Adding plugin
module Danger
  def self.configuration
    @configuration ||= Configuration.new
  end

  def self.configure
    yield configuration
  end

  # Adding opportunity to maintain exceptions list for plugin.
  class Configuration
    include ::ActiveSupport::Configurable

    config_accessor(:spec_postfix_exceptions) do
      ['spec/shared_examples/', 'spec/factories/', 'spec/support/', 'spec/rails_helper.rb', 'spec/spec_helper.rb']
    end
  end

  # Lints the test files. Will fail if any has no '_spec' postfix.
  # Generates a `string` with warning.
  #
  # @param   [String] files
  #          A globbed string which should return the files that you want to lint, defaults to nil.
  #          if nil, modified and added files from the diff will be used.
  # @return  [void]
  #
  class DangerSpecPostfix < Plugin
    def lint
      changed_files.select { |f| f.match?(%r{^spec/.*rb$}) }
                   .reject { |f| f.end_with?('_spec.rb') }
                   .reject { |f| Danger.configuration.spec_postfix_exceptions.any? { |e| f.start_with?(e) } }
                   .each   { |f| warn(warning_generator(f)) }
    end

    private

    def changed_files
      (git.modified_files + git.added_files)
    end

    def warning_generator(file)
      "Tests should have `_spec` postfix: #{file}"
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
danger-spec_postfix-0.0.2	lib/spec_postfix/plugin.rb