Class: Cucumber::Cli::Configuration

Inherits:
Object
  • Object
show all
Includes:
Cucumber::Constantize
Defined in:
lib/cucumber/cli/configuration.rb

Defined Under Namespace

Classes: LogFormatter

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Cucumber::Constantize

#constantize, #underscore

Constructor Details

#initialize(out_stream = STDOUT, error_stream = STDERR) ⇒ Configuration

Returns a new instance of Configuration.



17
18
19
20
21
 
# File 'lib/cucumber/cli/configuration.rb', line 17

def initialize(out_stream = STDOUT, error_stream = STDERR)
  @out_stream   = out_stream
  @error_stream = error_stream
  @options = Options.new(@out_stream, @error_stream, :default_profile => 'default')
end

Instance Attribute Details

#out_stream ⇒ Object (readonly)

Returns the value of attribute out_stream.



15
16
17
 
# File 'lib/cucumber/cli/configuration.rb', line 15

def out_stream
  @out_stream
end

Instance Method Details

#all_files_to_load ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/cucumber/cli/configuration.rb', line 79

def all_files_to_load
  requires = @options[:require].empty? ? require_dirs : @options[:require]
  files = requires.map do |path|
    path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
    path = path.gsub(/\/$/, '') # Strip trailing slash.
    File.directory?(path) ? Dir["#{path}/**/*"] : path
  end.flatten.uniq
  remove_excluded_files_from(files)
  files.reject! {|f| !File.file?(f)}
  files.reject! {|f| File.extname(f) == '.feature' }
  files.reject! {|f| f =~ /^http/}
  files.sort
end

#build_tree_walker(step_mother) ⇒ Object 



67
68
69
 
# File 'lib/cucumber/cli/configuration.rb', line 67

def build_tree_walker(step_mother)
  Ast::TreeWalker.new(step_mother, formatters(step_mother), self)
end

#drb? ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/cucumber/cli/configuration.rb', line 51

def drb?
  @options[:drb]
end

#drb_port ⇒ Object 



55
56
57
 
# File 'lib/cucumber/cli/configuration.rb', line 55

def drb_port
  @options[:drb_port].to_i if @options[:drb_port]
end

#dry_run? ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/cucumber/cli/configuration.rb', line 59

def dry_run?
  @options[:dry_run]
end

#expand? ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/cucumber/cli/configuration.rb', line 63

def expand?
  @options[:expand]
end

#feature_dirs ⇒ Object 



121
122
123
 
# File 'lib/cucumber/cli/configuration.rb', line 121

def feature_dirs
  paths.map { |f| File.directory?(f) ? f : File.dirname(f) }.uniq
end

#feature_files ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/cucumber/cli/configuration.rb', line 104

def feature_files
  potential_feature_files = paths.map do |path|
    path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
    path = path.chomp('/')
    if File.directory?(path)
      Dir["#{path}/**/*.feature"]
    elsif path[0..0] == '@' and # @listfile.txt
        File.file?(path[1..-1]) # listfile.txt is a file
      IO.read(path[1..-1]).split
    else
      path
    end
  end.flatten.uniq
  remove_excluded_files_from(potential_feature_files)
  potential_feature_files
end

#filters ⇒ Object 



137
138
139
 
# File 'lib/cucumber/cli/configuration.rb', line 137

def filters
  @options.filters
end

#formats ⇒ Object 



141
142
143
 
# File 'lib/cucumber/cli/configuration.rb', line 141

def formats
  @options[:formats]
end

#formatter_class(format) ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/cucumber/cli/configuration.rb', line 71

def formatter_class(format)
  if(builtin = Options::BUILTIN_FORMATS[format])
    constantize(builtin[0])
  else
    constantize(format)
  end
end

#guess? ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/cucumber/cli/configuration.rb', line 47

def guess?
  @options[:guess]
end

#log ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/cucumber/cli/configuration.rb', line 125

def log
  logger = Logger.new(@out_stream)
  logger.formatter = LogFormatter.new
  logger.level = Logger::INFO
  logger.level = Logger::DEBUG if self.verbose?
  logger
end

#options ⇒ Object 



145
146
147
148
 
# File 'lib/cucumber/cli/configuration.rb', line 145

def options
  warn("Deprecated: Configuration#options will be removed from the next release of Cucumber. Please use the configuration object directly instead.")
  @options
end

#parse!(args) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/cucumber/cli/configuration.rb', line 23

def parse!(args)
  @args = args
  @options.parse!(args)
  arrange_formats
  raise("You can't use both --strict and --wip") if strict? && wip?

  @options[:tag_expression] = Gherkin::TagExpression.new(@options[:tag_expressions])
  return @args.replace(@options.expanded_args_without_drb) if drb?

  set_environment_variables
end

#paths ⇒ Object 



150
151
152
 
# File 'lib/cucumber/cli/configuration.rb', line 150

def paths
  @options[:paths].empty? ? ['features'] : @options[:paths]
end

#step_defs_to_load ⇒ Object 



93
94
95
 
# File 'lib/cucumber/cli/configuration.rb', line 93

def step_defs_to_load
  all_files_to_load.reject {|f| f =~ %r{/support/} }
end

#strict? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/cucumber/cli/configuration.rb', line 39

def strict?
  @options[:strict]
end

#support_to_load ⇒ Object 



97
98
99
100
101
102
 
# File 'lib/cucumber/cli/configuration.rb', line 97

def support_to_load
  support_files = all_files_to_load.select {|f| f =~ %r{/support/} }
  env_files = support_files.select {|f| f =~ %r{/support/env\..*} }
  other_files = support_files - env_files
  @options[:dry_run] ? other_files : env_files + other_files
end

#tag_expression ⇒ Object 



133
134
135
 
# File 'lib/cucumber/cli/configuration.rb', line 133

def tag_expression
  Gherkin::TagExpression.new(@options[:tag_expressions])
end

#verbose? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/cucumber/cli/configuration.rb', line 35

def verbose?
  @options[:verbose]
end

#wip? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/cucumber/cli/configuration.rb', line 43

def wip?
  @options[:wip]
end