Module: Cucumber::Glue::ProtoWorld

Defined in:
lib/cucumber/glue/proto_world.rb

Overview

Defines the basic API methods available in all Cucumber step definitions.

You can, and probably should, extend this API with your own methods that make sense in your domain. For more on that, see Dsl#World

Constant Summary collapse

AnsiEscapes = 
Cucumber::Gherkin::Formatter::AnsiEscapes

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.for(runtime, language) ⇒ Object

Dynamically generate the API module, closuring the dependencies



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
199
200
201
202
203
204
205
 
# File 'lib/cucumber/glue/proto_world.rb', line 129

def self.for(runtime, language)
  Module.new do
    def self.extended(object)
      # wrap the dynamically generated module so that we can document the methods
      # for yardoc, which doesn't like define_method.
      object.extend(ProtoWorld)
    end

    # TODO: pass these in when building the module, instead of mutating them later
    # Extend the World with user-defined modules
    def add_modules!(world_modules, namespaced_world_modules)
      add_world_modules!(world_modules) if world_modules.any?
      add_namespaced_modules!(namespaced_world_modules) if namespaced_world_modules.any?
    end

    define_method(:step) do |name, raw_multiline_arg = nil|
      location = Core::Test::Location.of_caller
      runtime.invoke_dynamic_step(name, MultilineArgument.from(raw_multiline_arg, location))
    end

    define_method(:steps) do |steps_text|
      location = Core::Test::Location.of_caller
      runtime.invoke_dynamic_steps(steps_text, language, location)
    end

    define_method(:ask) do |question, timeout_seconds = 60|
      runtime.ask(question, timeout_seconds)
    end

    define_method(:attach) do |file, media_type, filename|
      runtime.attach(file, media_type, filename)
    end

    # Prints the list of modules that are included in the World
    def inspect
      modules = [self.class]
      (class << self; self; end).instance_eval do
        modules += included_modules
      end
      modules << stringify_namespaced_modules
      format('#<%<modules>s:0x%<object_id>x>', modules: modules.join('+'), object_id: object_id)
    end

    private

    def add_world_modules!(modules)
      modules.each do |world_module|
        extend(world_module)
      end
    end

    def add_namespaced_modules!(modules)
      @__namespaced_modules = modules
      modules.each do |namespace, world_modules|
        world_modules.each do |world_module|
          variable_name = "@__#{namespace}_world"
          inner_world = instance_variable_get(variable_name) || Object.new

          instance_variable_set(
            variable_name,
            inner_world.extend(world_module)
          )

          self.class.send(:define_method, namespace) do
            instance_variable_get(variable_name)
          end
        end
      end
    end

    def stringify_namespaced_modules
      return '' if @__namespaced_modules.nil?

      @__namespaced_modules.map { |k, v| "#{v.join(',')} (as #{k})" }.join('+')
    end
  end
end

Instance Method Details

#ask(question, timeout_seconds = 60) ⇒ Object

Pause the tests and ask the operator for input



77
78
79
 
# File 'lib/cucumber/glue/proto_world.rb', line 77

def ask(question, timeout_seconds = 60)
  super
end

#attach(file, media_type = nil, filename = nil) ⇒ Object

Attach a file to the output

Parameters:

  • file (string|io) —

    the file to attach. It can be a string containing the file content itself, the file path, or an IO ready to be read.

  • media_type (string) (defaults to: nil) —

    the media type. If file is a valid path, media_type can be omitted, it will then be inferred from the file name.

  • filename (string) (defaults to: nil) —

    the name of the file you wish to specify. This is only needed in situations where you want to rename a PDF download e.t.c. - In most situations you should not need to pass a filename



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/cucumber/glue/proto_world.rb', line 93

def attach(file, media_type = nil, filename = nil)
  return super unless File.file?(file)

  content = File.read(file, mode: 'rb')
  media_type = MiniMime.lookup_by_filename(file)&.content_type if media_type.nil?

  super(content, media_type.to_s, filename)
rescue StandardError
  super
end

#inspect ⇒ Object

Prints the list of modules that are included in the World



119
120
121
 
# File 'lib/cucumber/glue/proto_world.rb', line 119

def inspect
  super
end

#log(*messages) ⇒ Object 



81
82
83
 
# File 'lib/cucumber/glue/proto_world.rb', line 81

def log(*messages)
  messages.each { |message| attach(message.to_s.dup, 'text/x.cucumber.log+plain') }
end

#pending(message = 'TODO') ⇒ Object

Mark the matched step as pending.



105
106
107
108
109
110
111
 
# File 'lib/cucumber/glue/proto_world.rb', line 105

def pending(message = 'TODO')
  raise Pending, message unless block_given?

  yield
rescue Exception
  raise Pending, message
end

#skip_this_scenario(message = 'Scenario skipped') ⇒ Object

Skips this step and the remaining steps in the scenario

Raises:

  • (Core::Test::Result::Skipped) 


114
115
116
 
# File 'lib/cucumber/glue/proto_world.rb', line 114

def skip_this_scenario(message = 'Scenario skipped')
  raise Core::Test::Result::Skipped, message
end

#step(name, raw_multiline_arg = nil) ⇒ Object

Run a single Gherkin step

Examples:

Call another step

step "I am logged in"

Call a step with quotes in the name

step %{the user "Dave" is logged in}

Passing a table

step "the following users exist:", table(%{
  | name  | email           |
  | Matt  | [email protected]   |
  | Aslak | [email protected] |
})

Passing a multiline string

step "the email should contain:", "Dear sir,\nYou've won a prize!\n"

Parameters:

  • name (String) —

    The name of the step

  • raw_multiline_arg (String, Cucumber::Test::DocString, Cucumber::Ast::Table) (defaults to: nil) 


30
31
32
 
# File 'lib/cucumber/glue/proto_world.rb', line 30

def step(name, raw_multiline_arg = nil)
  super
end

#steps(steps_text) ⇒ Object

Run a snippet of Gherkin

Examples:

steps %{
  Given the user "Susan" exists
  And I am logged in as "Susan"
}

Parameters:

  • steps_text (String) —

    The Gherkin snippet to run



41
42
43
 
# File 'lib/cucumber/glue/proto_world.rb', line 41

def steps(steps_text)
  super
end

#table(text_or_table) ⇒ Object

Parse Gherkin into a Ast::Table object.

Useful in conjunction with the #step method. Returns a Cucumber::MultilineArgument::DataTable for text_or_table, which can either be a String:

table(%{
  | account | description | amount |
  | INT-100 | Taxi        | 114    |
  | CUC-101 | Peeler      | 22     |
})

or a 2D Array:

table([
  %w{ account description amount },
  %w{ INT-100 Taxi        114    },
  %w{ CUC-101 Peeler      22     }
])

Examples:

Create a table

users = table(%{
  | name  | email           |
  | Matt  | [email protected]   |
  | Aslak | [email protected] |
})

Parameters:

  • text_or_table (String) —

    The Gherkin string that represents the table



72
73
74
 
# File 'lib/cucumber/glue/proto_world.rb', line 72

def table(text_or_table)
  MultilineArgument::DataTable.from(text_or_table)
end

#to_s ⇒ Object

see #inspect



124
125
126
 
# File 'lib/cucumber/glue/proto_world.rb', line 124

def to_s
  inspect
end