class Cucumber::Configuration

The base class for configuring settings for a Cucumber run.

Public Class Methods

default() click to toggle source
# File lib/cucumber/configuration.rb, line 17
def self.default
  new
end
new(user_options = {}) click to toggle source
# File lib/cucumber/configuration.rb, line 36
def initialize(user_options = {})
  @options = default_options.merge(Hash(user_options))
end

Public Instance Methods

all_files_to_load() click to toggle source
# File lib/cucumber/configuration.rb, line 188
def all_files_to_load
  files = require_dirs.map do |path|
    path = path.tr('\\', '/') # In case we're on windows. Globs don't work with backslashes.
    path = path.gsub(/\/$/, '') # Strip trailing slash. # rubocop:disable Style/RegexpLiteral
    File.directory?(path) ? Dir["#{path}/**/*"] : path
  end.flatten.uniq
  remove_excluded_files_from(files)
  files.select! { |f| File.file?(f) }
  files.reject! { |f| File.extname(f) == '.feature' }
  files.reject! { |f| f =~ /^http/ }
  files.sort
end
autoload_code_paths() click to toggle source
# File lib/cucumber/configuration.rb, line 128
def autoload_code_paths
  @options[:autoload_code_paths]
end
custom_profiles() click to toggle source
# File lib/cucumber/configuration.rb, line 116
def custom_profiles
  profiles - [@options[:default_profile]]
end
dry_run?() click to toggle source
# File lib/cucumber/configuration.rb, line 60
def dry_run?
  @options[:dry_run]
end
duration?() click to toggle source
# File lib/cucumber/configuration.rb, line 100
def duration?
  @options[:duration]
end
error_stream() click to toggle source
# File lib/cucumber/configuration.rb, line 48
def error_stream
  @options[:error_stream]
end
event_bus() click to toggle source
# File lib/cucumber/configuration.rb, line 247
def event_bus
  @options[:event_bus]
end
expand?() click to toggle source
# File lib/cucumber/configuration.rb, line 92
def expand?
  @options[:expand]
end
fail_fast?() click to toggle source
# File lib/cucumber/configuration.rb, line 72
def fail_fast?
  @options[:fail_fast]
end
feature_dirs() click to toggle source
# File lib/cucumber/configuration.rb, line 136
def feature_dirs
  dirs = paths.map { |f| File.directory?(f) ? f : File.dirname(f) }.uniq
  dirs.delete('.') unless paths.include?('.')
  with_default_features_path(dirs)
end
feature_files() click to toggle source
# File lib/cucumber/configuration.rb, line 158
def feature_files
  potential_feature_files = with_default_features_path(paths).map do |path|
    path = path.tr('\\', '/') # In case we're on windows. Globs don't work with backslashes.
    path = path.chomp('/')

    # TODO: Move to using feature loading strategies stored in
    # options[:feature_loaders]
    if File.directory?(path)
      Dir["#{path}/**/*.feature"].sort
    elsif Cli::RerunFile.can_read?(path)
      Cli::RerunFile.new(path).features
    else
      path
    end
  end.flatten.uniq
  remove_excluded_files_from(potential_feature_files)
  potential_feature_files
end
filters() click to toggle source
# File lib/cucumber/configuration.rb, line 154
def filters
  @options[:filters]
end
formats() click to toggle source
# File lib/cucumber/configuration.rb, line 124
def formats
  @options[:formats]
end
formatter_class(format) click to toggle source
# File lib/cucumber/configuration.rb, line 216
def formatter_class(format)
  if (builtin = Cli::Options::BUILTIN_FORMATS[format])
    constantize(builtin[0])
  else
    constantize(format)
  end
end
formatter_factories() { |factory, formatter_options, path_or_io| ... } click to toggle source
# File lib/cucumber/configuration.rb, line 205
def formatter_factories
  formats.map do |format, formatter_options, path_or_io|
    factory = formatter_class(format)
    yield factory,
          formatter_options,
          path_or_io
  rescue Exception => e # rubocop:disable Lint/RescueException
    raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
  end
end
guess?() click to toggle source
# File lib/cucumber/configuration.rb, line 80
def guess?
  @options[:guess]
end
id_generator() click to toggle source
# File lib/cucumber/configuration.rb, line 251
def id_generator
  @id_generator ||= Cucumber::Messages::IdGenerator::UUID.new
end
name_regexps() click to toggle source
# File lib/cucumber/configuration.rb, line 150
def name_regexps
  @options[:name_regexps]
end
notify(message, *args) click to toggle source

@private

# File lib/cucumber/configuration.rb, line 32
def notify(message, *args)
  event_bus.send(message, *args)
end
out_stream() click to toggle source
# File lib/cucumber/configuration.rb, line 44
def out_stream
  @options[:out_stream]
end
paths() click to toggle source
# File lib/cucumber/configuration.rb, line 120
def paths
  @options[:paths]
end
profiles() click to toggle source
# File lib/cucumber/configuration.rb, line 112
def profiles
  @options[:profiles] || []
end
publish_enabled?() click to toggle source
# File lib/cucumber/configuration.rb, line 64
def publish_enabled?
  @options[:publish_enabled]
end
publish_quiet?() click to toggle source
# File lib/cucumber/configuration.rb, line 68
def publish_quiet?
  @options[:publish_quiet]
end
randomize?() click to toggle source
# File lib/cucumber/configuration.rb, line 52
def randomize?
  @options[:order] == 'random'
end
register_snippet_generator(generator) click to toggle source
# File lib/cucumber/configuration.rb, line 242
def register_snippet_generator(generator)
  snippet_generators << generator
  self
end
retry_attempts() click to toggle source
# File lib/cucumber/configuration.rb, line 76
def retry_attempts
  @options[:retry]
end
seed() click to toggle source
# File lib/cucumber/configuration.rb, line 56
def seed
  @options[:seed]
end
skip_profile_information?() click to toggle source
# File lib/cucumber/configuration.rb, line 108
def skip_profile_information?
  @options[:skip_profile_information]
end
snippet_generators() click to toggle source

An array of procs that can generate snippets for undefined steps. These procs may be called if a formatter wants to display snippets to the user.

Each proc should take the following arguments:

- keyword
- step text
- multiline argument
- snippet type
# File lib/cucumber/configuration.rb, line 238
def snippet_generators
  @options[:snippet_generators] ||= []
end
snippet_type() click to toggle source
# File lib/cucumber/configuration.rb, line 132
def snippet_type
  @options[:snippet_type]
end
snippets?() click to toggle source
# File lib/cucumber/configuration.rb, line 104
def snippets?
  @options[:snippets]
end
source?() click to toggle source
# File lib/cucumber/configuration.rb, line 96
def source?
  @options[:source]
end
step_defs_to_load() click to toggle source
# File lib/cucumber/configuration.rb, line 201
def step_defs_to_load
  all_files_to_load.reject { |f| f =~ %r{/support/} }
end
strict() click to toggle source
# File lib/cucumber/configuration.rb, line 84
def strict
  @options[:strict]
end
support_to_load() click to toggle source
# File lib/cucumber/configuration.rb, line 177
def support_to_load
  support_files = all_files_to_load.select { |f| f =~ %r{/support/} }

  # env_files are separated from other_files so we can ensure env files
  # load first.
  #
  env_files = support_files.select { |f| f =~ %r{/support/env\..*} }
  other_files = support_files - env_files
  env_files.reverse + other_files.reverse
end
tag_expressions() click to toggle source
# File lib/cucumber/configuration.rb, line 146
def tag_expressions
  @options[:tag_expressions]
end
tag_limits() click to toggle source
# File lib/cucumber/configuration.rb, line 142
def tag_limits
  @options[:tag_limits]
end
to_hash() click to toggle source
# File lib/cucumber/configuration.rb, line 224
def to_hash
  @options
end
wip?() click to toggle source
# File lib/cucumber/configuration.rb, line 88
def wip?
  @options[:wip]
end
with_options(new_options) click to toggle source
# File lib/cucumber/configuration.rb, line 40
def with_options(new_options)
  self.class.new(@options.merge(new_options))
end

Private Instance Methods

default_features_paths() click to toggle source
# File lib/cucumber/configuration.rb, line 279
def default_features_paths
  ['features']
end
default_options() click to toggle source
# File lib/cucumber/configuration.rb, line 257
def default_options
  {
    autoload_code_paths: ['features/support', 'features/step_definitions'],
    filters: [],
    strict: Cucumber::Core::Test::Result::StrictConfiguration.new,
    require: [],
    dry_run: false,
    publish_quiet: false,
    fail_fast: false,
    formats: [],
    excludes: [],
    tag_expressions: [],
    name_regexps: [],
    env_vars: {},
    diff_enabled: true,
    snippets: true,
    source: true,
    duration: true,
    event_bus: Cucumber::Events.make_event_bus
  }
end
remove_excluded_files_from(files) click to toggle source
# File lib/cucumber/configuration.rb, line 288
def remove_excluded_files_from(files)
  files.reject! { |path| @options[:excludes].detect { |pattern| path =~ pattern } }
end
require_dirs() click to toggle source
# File lib/cucumber/configuration.rb, line 292
def require_dirs
  if @options[:require].empty?
    default_features_paths + Dir['vendor/{gems,plugins}/*/cucumber']
  else
    @options[:require]
  end
end
with_default_features_path(paths) click to toggle source
# File lib/cucumber/configuration.rb, line 283
def with_default_features_path(paths)
  return default_features_paths if paths.empty?
  paths
end