Class: Cucumber::Cli::Configuration

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

Constant Summary collapse

BUILTIN_FORMATS =
{
  'html'      => 'Cucumber::Formatter::Html',
  'pretty'    => 'Cucumber::Formatter::Pretty',
  'profile'   => 'Cucumber::Formatter::Profile',
  'progress'  => 'Cucumber::Formatter::Progress',
  'rerun'     => 'Cucumber::Formatter::Rerun',
  'usage'     => 'Cucumber::Formatter::Usage',
  'junit'     => 'Cucumber::Formatter::Junit',
  'tag_cloud' => 'Cucumber::Formatter::TagCloud',
  'steps'     => 'Cucumber::Formatter::Steps'
}
DRB_FLAG =
'--drb'
PROFILE_SHORT_FLAG =
'-p'
PROFILE_LONG_FLAG =
'--profile'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Configuration.



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

def initialize(out_stream = STDOUT, error_stream = STDERR)
  @out_stream   = out_stream
  @error_stream = error_stream

  @paths          = []
  @options        = default_options
end

Instance Attribute Details

#optionsObject (readonly)

Returns the value of attribute options.



22
23
24
# File 'lib/cucumber/cli/configuration.rb', line 22

def options
  @options
end

#pathsObject (readonly)

Returns the value of attribute paths.



21
22
23
# File 'lib/cucumber/cli/configuration.rb', line 21

def paths
  @paths
end

Instance Method Details

#build_formatter_broadcaster(step_mother) ⇒ Object



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/cucumber/cli/configuration.rb', line 235

def build_formatter_broadcaster(step_mother)
  return Formatter::Pretty.new(step_mother, nil, @options) if @options[:autoformat]
  formatters = @options[:formats].map do |format_and_out|
    format = format_and_out[0]
    out    = format_and_out[1]
    if String === out # file name
      unless File.directory?(out)
        out = File.open(out, Cucumber.file_mode('w'))
        at_exit do
          out.flush
          out.close
        end
      end
    end

    begin
      formatter_class = formatter_class(format)
      formatter_class.new(step_mother, out, @options)
    rescue Exception => e
      e.message << "\nError creating formatter: #{format}"
      raise e
    end
  end

  broadcaster = Broadcaster.new(formatters)
  broadcaster.options = @options
  return broadcaster
end

#diff_enabled?Boolean

Returns:

  • (Boolean)


216
217
218
# File 'lib/cucumber/cli/configuration.rb', line 216

def diff_enabled?
  @options[:diff_enabled]
end

#drb?Boolean

Returns:

  • (Boolean)


220
221
222
# File 'lib/cucumber/cli/configuration.rb', line 220

def drb?
  @drb
end

#feature_filesObject



287
288
289
290
291
292
293
294
295
# File 'lib/cucumber/cli/configuration.rb', line 287

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('/')
    File.directory?(path) ? Dir["#{path}/**/*.feature"] : path
  end.flatten.uniq
  remove_excluded_files_from(potential_feature_files)
  potential_feature_files
end

#files_to_requireObject



272
273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/cucumber/cli/configuration.rb', line 272

def files_to_require
  requires = @options[:require] || feature_dirs
  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}/**/*.rb"] : path
  end.flatten.uniq
  sorted_files = files.sort { |a,b| (b =~ %r{/support/} || -1) <=>  (a =~ %r{/support/} || -1) }.reject{|f| f =~ /^http/}
  env_files = sorted_files.select {|f| f =~ %r{/support/env.rb} }
  files = env_files + sorted_files.reject {|f| f =~ %r{/support/env.rb} }
  remove_excluded_files_from(files)
  files.reject! {|f| f =~ %r{/support/env.rb} } if @options[:dry_run]
  files
end

#formatter_class(format) ⇒ Object



264
265
266
267
268
269
270
# File 'lib/cucumber/cli/configuration.rb', line 264

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

#guess?Boolean

Returns:

  • (Boolean)


212
213
214
# File 'lib/cucumber/cli/configuration.rb', line 212

def guess?
  @options[:guess]
end

#parse!(args) ⇒ Object



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# File 'lib/cucumber/cli/configuration.rb', line 32

def parse!(args)
  args.concat(%w{--profile default}) if args.empty?
  @args = args
  expand_profiles_into_args
  return if parse_drb

  @args.each do |arg|
    if arg =~ /^(\w+)=(.*)$/
      ENV[$1] = $2
      @args.delete(arg)
    end
  end

  @args.extend(::OptionParser::Arguable)

  @args.options do |opts|
    opts.banner = ["Usage: cucumber [options] [ [FILE|DIR|URL][:LINE[:LINE]*] ]+", "",
      "Examples:",
      "cucumber examples/i18n/en/features",
      "cucumber --language it examples/i18n/it/features/somma.feature:6:98:113",
      "cucumber -s -i http://rubyurl.com/eeCl", "", "",
    ].join("\n")
    opts.on("-r LIBRARY|DIR", "--require LIBRARY|DIR",
      "Require files before executing the features. If this",
      "option is not specified, all *.rb files that are",
      "siblings or below the features will be loaded auto-",
      "matically. Automatic loading is disabled when this",
      "option is specified, and all loading becomes explicit.",
      "Files under directories named \"support\" are always",
      "loaded first.",
      "This option can be specified multiple times.") do |v|
      @options[:require] ||= []
      @options[:require] << v
    end
    opts.on("-l LANG", "--language LANG",
      "Specify language for features (Default: #{@options[:lang]})",
      %{Run with "--language help" to see all languages},
      %{Run with "--language LANG help" to list keywords for LANG}) do |v|
      if v == 'help'
        list_languages_and_exit
      elsif args==['help']
        list_keywords_and_exit(v)
      else
        @options[:lang] = v
      end
    end
    opts.on("-f FORMAT", "--format FORMAT",
      "How to format features (Default: pretty)",
      "Available formats: #{BUILTIN_FORMATS.keys.sort.join(", ")}",
      "FORMAT can also be the fully qualified class name of",
      "your own custom formatter. If the class isn't loaded,",
      "Cucumber will attempt to require a file with a relative",
      "file name that is the underscore name of the class name.",
      "Example: --format Foo::BarZap -> Cucumber will look for",
      "foo/bar_zap.rb. You can place the file with this relative",
      "path underneath your features/support directory or anywhere",
      "on Ruby's LOAD_PATH, for example in a Ruby gem.") do |v|
      @options[:formats] << [v, @out_stream]
      @active_format = v
    end
    opts.on("-o", "--out [FILE|DIR]",
      "Write output to a file/directory instead of STDOUT. This option",
      "applies to the previously specified --format, or the",
      "default format if no format is specified. Check the specific",
      "formatter's docs to see whether to pass a file or a dir.") do |v|
      @options[:formats] << ['pretty', nil] if @options[:formats].empty?
      @options[:formats][-1][1] = v
    end
    opts.on("-t TAGS", "--tags TAGS",
      "Only execute the features or scenarios with the specified tags.",
      "TAGS must be comma-separated without spaces. Prefix tags with ~ to",
      "exclude features or scenarios having that tag. Tags can be specified",
      "with or without the @ prefix.") do |v|
      include_tags, exclude_tags = *parse_tags(v)
      @options[:include_tags] += include_tags
      @options[:exclude_tags] += exclude_tags
    end
    opts.on("-n NAME", "--name NAME",
      "Only execute the feature elements which match part of the given name.",
      "If this option is given more than once, it will match against all the",
      "given names.") do |v|
      @options[:name_regexps] << /#{v}/
    end
    opts.on("-e", "--exclude PATTERN", "Don't run feature files or require ruby files matching PATTERN") do |v|
      @options[:excludes] << Regexp.new(v)
    end
    opts.on(PROFILE_SHORT_FLAG, "#{PROFILE_LONG_FLAG} PROFILE", "Pull commandline arguments from cucumber.yml.") do |v|
      # Processing of this is done previsouly so that the DRb flag can be detected within profiles.
    end
    opts.on("-c", "--[no-]color",
      "Whether or not to use ANSI color in the output. Cucumber decides",
      "based on your platform and the output destination if not specified.") do |v|
      Term::ANSIColor.coloring = v
    end
    opts.on("-d", "--dry-run", "Invokes formatters without executing the steps.",
      "This also omits the loading of your support/env.rb file if it exists.",
      "Implies --quiet.") do
      @options[:dry_run] = true
      @quiet = true
    end
    opts.on("-a", "--autoformat DIRECTORY",
      "Reformats (pretty prints) feature files and write them to DIRECTORY.",
      "Be careful if you choose to overwrite the originals.",
      "Implies --dry-run --formatter pretty.") do |directory|
      @options[:autoformat] = directory
      Term::ANSIColor.coloring = false
      @options[:dry_run] = true
      @quiet = true
    end
    opts.on("-m", "--no-multiline",
      "Don't print multiline strings and tables under steps.") do
      @options[:no_multiline] = true
    end
    opts.on("-s", "--no-source",
      "Don't print the file and line of the step definition with the steps.") do
      @options[:source] = false
    end
    opts.on("-i", "--no-snippets", "Don't print snippets for pending steps.") do
      @options[:snippets] = false
    end
    opts.on("-q", "--quiet", "Alias for --no-snippets --no-source.") do
      @quiet = true
    end
    opts.on("-b", "--backtrace", "Show full backtrace for all errors.") do
      Exception.cucumber_full_backtrace = true
    end
    opts.on("-S", "--strict", "Fail if there are any undefined steps.") do
      @options[:strict] = true
    end
    opts.on("-w", "--wip", "Fail if there are any passing scenarios.") do
      @options[:wip] = true
    end
    opts.on("-v", "--verbose", "Show the files and features loaded.") do
      @options[:verbose] = true
    end
    opts.on("-g", "--guess", "Guess best match for Ambiguous steps.") do
      @options[:guess] = true
    end
    opts.on("-x", "--expand", "Expand Scenario Outline Tables in output.") do
      @options[:expand] = true
    end
    opts.on("--no-diff", "Disable diff output on failing expectations.") do
      @options[:diff_enabled] = false
    end
    opts.on(DRB_FLAG, "Run features against a DRb server. (i.e. with the spork gem)") do
      # Processing of this is done previsouly in order to short circuit args from being lost.
    end
    opts.on_tail("--version", "Show version.") do
      @out_stream.puts VERSION::STRING
      Kernel.exit
    end
    opts.on_tail("-h", "--help", "You're looking at it.") do
      @out_stream.puts opts.help
      Kernel.exit
    end
  end.parse!

  arrange_formats

  @options[:snippets] = true if !@quiet && @options[:snippets].nil?
  @options[:source]   = true if !@quiet && @options[:source].nil?

  raise("You can't use both --strict and --wip") if @options[:strict] && @options[:wip]

  # Whatever is left after option parsing is the FILE arguments
  @paths += @args
end

#parse_tags(tag_string) ⇒ Object



224
225
226
227
228
229
230
231
232
233
# File 'lib/cucumber/cli/configuration.rb', line 224

def parse_tags(tag_string)
  tag_names = tag_string.split(",")
  excludes, includes = tag_names.partition{|tag| tag =~ /^~/}
  excludes = excludes.map{|tag| tag[1..-1]}

  # Strip @
  includes = includes.map{|tag| Ast::Tags.strip_prefix(tag)}
  excludes = excludes.map{|tag| Ast::Tags.strip_prefix(tag)}
  [includes, excludes]
end

#strict?Boolean

Returns:

  • (Boolean)


204
205
206
# File 'lib/cucumber/cli/configuration.rb', line 204

def strict?
  @options[:strict]
end

#verbose?Boolean

Returns:

  • (Boolean)


200
201
202
# File 'lib/cucumber/cli/configuration.rb', line 200

def verbose?
  @options[:verbose]
end

#wip?Boolean

Returns:

  • (Boolean)


208
209
210
# File 'lib/cucumber/cli/configuration.rb', line 208

def wip?
  @options[:wip]
end