MDL-56335 behat: prefixed_tablenode_transformations final deprecation
[moodle.git] / lib / tests / behat / behat_transformations.php
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/>.
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  */
28 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
30 require_once(__DIR__ . '/../../behat/behat_base.php');
32 use Behat\Gherkin\Node\TableNode;
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  */
45 class behat_transformations extends behat_base {
47     /**
48      * @deprecated since Moodle 3.2
49      */
50     public function prefixed_tablenode_transformations() {
51         throw new coding_exception('prefixed_tablenode_transformations() can not be used anymore. ' .
52             'Please use tablenode_transformations() instead.');
53     }
55     /**
56      * Removes escaped argument delimiters.
57      *
58      * We use double quotes as arguments delimiters and
59      * to add the " as part of an argument we escape it
60      * with a backslash, this method removes this backslash.
61      *
62      * @Transform /^((.*)"(.*))$/
63      * @param string $string
64      * @return string The string with the arguments fixed.
65      */
66     public function arg_replace_slashes($string) {
67         if (!is_scalar($string)) {
68             return $string;
69         }
70         return str_replace('\"', '"', $string);
71     }
73     /**
74      * Replaces $NASTYSTRING vars for a nasty string.
75      *
76      * @Transform /^((.*)\$NASTYSTRING(\d)(.*))$/
77      * @param string $argument The whole argument value.
78      * @return string
79      */
80     public function arg_replace_nasty_strings($argument) {
81         if (!is_scalar($argument)) {
82             return $argument;
83         }
84         return $this->replace_nasty_strings($argument);
85     }
87     /**
88      * Convert string time to timestamp.
89      * Use ::time::STRING_TIME_TO_CONVERT::DATE_FORMAT::
90      *
91      * @Transform /^##(.*)##$/
92      * @param string $time
93      * @return int timestamp.
94      */
95     public function arg_time_to_string($time) {
96         return $this->get_transformed_timestamp($time);
97     }
99     /**
100      * Transformations for TableNode arguments.
101      *
102      * Transformations applicable to TableNode arguments should also
103      * be applied, adding them in a different method for Behat API restrictions.
104      *
105      * @Transform table:*
106      * @param TableNode $tablenode
107      * @return TableNode The transformed table
108      */
109     public function tablenode_transformations(TableNode $tablenode) {
110         // Walk through all values including the optional headers.
111         $rows = $tablenode->getRows();
112         foreach ($rows as $rowkey => $row) {
113             foreach ($row as $colkey => $value) {
115                 // Transforms vars into nasty strings.
116                 if (preg_match('/\$NASTYSTRING(\d)/', $rows[$rowkey][$colkey])) {
117                     $rows[$rowkey][$colkey] = $this->replace_nasty_strings($rows[$rowkey][$colkey]);
118                 }
120                 // Transform time.
121                 if (preg_match('/^##(.*)##$/', $rows[$rowkey][$colkey], $match)) {
122                     if (isset($match[1])) {
123                         $rows[$rowkey][$colkey] = $this->get_transformed_timestamp($match[1]);
124                     }
125                 }
126             }
127         }
129         // Return the transformed TableNode.
130         unset($tablenode);
131         $tablenode = new TableNode($rows);
133         return $tablenode;
134     }
136     /**
137      * Replaces $NASTYSTRING vars for a nasty string.
138      *
139      * Method reused by TableNode tranformation.
140      *
141      * @param string $string
142      * @return string
143      */
144     public function replace_nasty_strings($string) {
145         return preg_replace_callback(
146             '/\$NASTYSTRING(\d)/',
147             function ($matches) {
148                 return nasty_strings::get($matches[0]);
149             },
150             $string
151         );
152     }
154     /**
155      * Return timestamp for the time passed.
156      *
157      * @param string $time time to convert
158      * @return string
159      */
160     protected function get_transformed_timestamp($time) {
161         $timepassed = explode('##', $time);
163         // If not a valid time string, then just return what was passed.
164         if ((($timestamp = strtotime($timepassed[0])) === false)) {
165             return $time;
166         }
168         $count = count($timepassed);
169         if ($count === 2) {
170             // If timestamp with spcified format, then retrun date.
171             return date($timepassed[1], $timestamp);
172         } else if ($count === 1) {
173             return $timestamp;
174         } else {
175             // If not a valid time string, then just return what was passed.
176             return $time;
177         }
178     }