weekly release 2.6dev
[moodle.git] / lib / tests / behat / behat_transformations.php
CommitLineData
b08b0a28
DM
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * Behat arguments transformations.
19 *
20 * This methods are used by Behat CLI command.
21 *
22 * @package core
23 * @category test
24 * @copyright 2012 David MonllaĆ³
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 */
27
28// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
29
30require_once(__DIR__ . '/../../behat/behat_base.php');
31
32use Behat\Gherkin\Node\TableNode;
33
34/**
35 * Transformations to apply to steps arguments.
36 *
37 * This methods are applied to the steps arguments that matches
38 * the regular expressions specified in the @Transform tag.
39 *
40 * @package core
41 * @category test
42 * @copyright 2013 David MonllaĆ³
43 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44 */
45class behat_transformations extends behat_base {
46
47 /**
48 * Removes escaped argument delimiters.
49 *
50 * We use double quotes as arguments delimiters and
51 * to add the " as part of an argument we escape it
52 * with a backslash, this method removes this backslash.
53 *
54 * @Transform /^((.*)"(.*))$/
55 * @param string $string
56 * @return string The string with the arguments fixed.
57 */
58 public function arg_replace_slashes($string) {
e88d47b4 59 return str_replace('\"', '"', $string);
b08b0a28
DM
60 }
61
62 /**
63 * Replaces $NASTYSTRING vars for a nasty string.
64 *
65 * @Transform /^((.*)\$NASTYSTRING(\d)(.*))$/
66 * @param string $argument The whole argument value.
67 * @return string
68 */
69 public function arg_replace_nasty_strings($argument) {
70 return $this->replace_nasty_strings($argument);
71 }
72
73 /**
74 * Transformations for TableNode arguments.
75 *
e88d47b4
DM
76 * Transformations applicable to TableNode arguments should also
77 * be applied, adding them in a different method for Behat API restrictions.
b08b0a28
DM
78 *
79 * @Transform /^table:(.*)/
46ac40cd 80 * @param TableNode $tablenode
b08b0a28
DM
81 * @return TableNode The transformed table
82 */
83 public function tablenode_transformations(TableNode $tablenode) {
84
85 // Walk through all values including the optional headers.
86 $rows = $tablenode->getRows();
87 foreach ($rows as $rowkey => $row) {
88 foreach ($row as $colkey => $value) {
89
b08b0a28
DM
90 // Transforms vars into nasty strings.
91 if (preg_match('/\$NASTYSTRING(\d)/', $rows[$rowkey][$colkey])) {
92 $rows[$rowkey][$colkey] = $this->replace_nasty_strings($rows[$rowkey][$colkey]);
93 }
94 }
95 }
96
97 // Return the transformed TableNode.
98 $tablenode->setRows($rows);
99 return $tablenode;
100 }
101
b08b0a28
DM
102 /**
103 * Replaces $NASTYSTRING vars for a nasty string.
104 *
105 * Method reused by TableNode tranformation.
106 *
107 * @param string $string
108 * @return string
109 */
110 public function replace_nasty_strings($string) {
111 return preg_replace_callback(
112 '/\$NASTYSTRING(\d)/',
113 function ($matches) {
114 return nasty_strings::get($matches[0]);
115 },
116 $string
117 );
118 }
119
120}