Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * Behat tool renderer

 *

 * @package    tool_behat

 * @copyright  2012 David Monllaó

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir . '/behat/classes/behat_generator_base.php');

/**

 * Renderer for behat tool web features

 *

 * @package    tool_behat

 * @copyright  2012 David Monllaó

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class tool_behat_renderer extends plugin_renderer_base {

    /**

     * Renders the list of available steps according to the submitted filters.

     *

     * @param mixed $stepsdefinitions Available steps array.

     * @param moodleform $form

     * @return string HTML code

     */

    public function render_stepsdefinitions($stepsdefinitions, $form) {

        global $CFG;

        require_once($CFG->libdir . '/behat/classes/behat_selectors.php');

        $html = $this->output->header();

        $html .= $this->output->heading(get_string('pluginname', 'tool_behat'));

        $html .= $form->render();

        if (empty($stepsdefinitions)) {

            $stepsdefinitions = get_string('nostepsdefinitions', 'tool_behat');

        } else {

            $stepsdefinitions = implode('', $stepsdefinitions);

            // Replace text selector type arguments with a user-friendly select.

            $stepsdefinitions = preg_replace_callback('/(TEXT_SELECTOR\d?_STRING)/',

                function ($matches) {

                    return html_writer::select(behat_selectors::get_allowed_text_selectors(), uniqid());

                },

                $stepsdefinitions

            );

            // Replace selector type arguments with a user-friendly select.

            $stepsdefinitions = preg_replace_callback('/(SELECTOR\d?_STRING)/',

                function ($matches) {

                    return html_writer::select(behat_selectors::get_allowed_selectors(), uniqid());

                },

                $stepsdefinitions

            );

            // Replace simple OR options.

            $regex = '#\(\?P<[^>]+>([^\)|]+\|[^\)]+)\)#';

            $stepsdefinitions = preg_replace_callback($regex,

                function($matches){

                    return html_writer::select(explode('|', $matches[1]), uniqid());

                },

                $stepsdefinitions

            );

            $stepsdefinitions = preg_replace_callback('/(FIELD_VALUE_STRING)/',

                function ($matches) {

                    global $CFG;

                    // Creating a link to a popup with the help.

                    $url = new moodle_url(

                        '/help.php',

                        array(

                            'component' => 'tool_behat',

                            'identifier' => 'fieldvalueargument',

                            'lang' => current_language()

                        )

                    );

                    // Note: this title is displayed only if JS is disabled,

                    // otherwise the link will have the new ajax tooltip.

                    $title = get_string('fieldvalueargument', 'tool_behat');

                    $title = get_string('helpprefix2', '', trim($title, ". \t"));

                    $attributes = array('href' => $url, 'title' => $title,

                        'aria-haspopup' => 'true', 'target' => '_blank');

                    $output = html_writer::tag('a', 'FIELD_VALUE_STRING', $attributes);

                    return html_writer::tag('span', $output, array('class' => 'helptooltip'));

                },

                $stepsdefinitions

            );

            $elementstrings = [];

            $count = 1;

            $stepsdefinitions = preg_replace_callback('/(the following ")ELEMENT\d?_STRING(" exist:)/',

                function($matches) use (&$elementstrings, &$count) {

                    // Replace element type arguments with a user-friendly select.

                    if (empty($elementstrings)) {

                        $behatgenerators = new behat_data_generators();

                        $componententities = $behatgenerators->get_all_entities();

                        ksort($componententities);

                        $elementstrings = [];

                        foreach ($componententities as $component => $entities) {

                            asort($entities);

                            foreach ($entities as $entity) {

                                $string = ($component === 'core') ? $entity : $component . ' > ' . $entity;

                                $elementstrings[$string] = $string;

                            }

                        }

                    }

                    $select = html_writer::select($elementstrings, 'entities' . $count, '', ['' => 'choosedots'],

                            ['class' => 'entities']);

                    $count++;

                    return $matches[1] . $select . $matches[2];

                },

                $stepsdefinitions

            );

        }

        // Steps definitions.

        $html .= html_writer::tag('div', $stepsdefinitions, array('class' => 'steps-definitions'));

        $html .= $this->output->footer();

        return $html;

    }

    /**

     * Renders an error message adding the generic info about the tool purpose and setup.

     *

     * @param string $msg The error message

     * @return string HTML

     */

    public function render_error($msg) {

        $html = $this->output->header();

        $html .= $this->output->heading(get_string('pluginname', 'tool_behat'));

        $html .= $this->generic_info();

        $a = new stdClass();

        $a->errormsg = $msg;

        $a->behatcommand = behat_command::get_behat_command();

        $a->behatinit = 'php admin' . DIRECTORY_SEPARATOR . 'tool' . DIRECTORY_SEPARATOR .

            'behat' . DIRECTORY_SEPARATOR . 'cli' . DIRECTORY_SEPARATOR . 'init.php';

        $msg = get_string('wrongbehatsetup', 'tool_behat', $a);

        // Error box including generic error string + specific error msg.

        $html .= $this->output->box_start('box errorbox alert alert-danger');

        $html .= html_writer::tag('div', $msg);

        $html .= $this->output->box_end();

        $html .= $this->output->footer();

        return $html;

    }

    /**

     * Generic info about the tool.

     *

     * @return string

     */

    public function generic_info() {

        // Info.

        $installurl = behat_command::DOCS_URL;

        $installlink = html_writer::tag('a', $installurl, array('href' => $installurl, 'target' => '_blank'));

        $writetestsurl = 'https://moodledev.io/general/development/tools/behat/writing';

        $writetestslink = html_writer::tag('a', $writetestsurl, array('href' => $writetestsurl, 'target' => '_blank'));

        $writestepsurl = 'https://moodledev.io/general/development/tools/behat/writing#' .

            'writing-new-acceptance-test-step-definitions';

        $writestepslink = html_writer::tag('a', $writestepsurl, array('href' => $writestepsurl, 'target' => '_blank'));

        $infos = array(

            get_string('installinfo', 'tool_behat', $installlink),

            get_string('newtestsinfo', 'tool_behat', $writetestslink),

            get_string('newstepsinfo', 'tool_behat', $writestepslink)

        );

        // List of steps.

        $html = $this->output->box_start();

        $html .= html_writer::tag('div', get_string('aim', 'tool_behat'));

        $html .= html_writer::start_tag('div');

        $html .= html_writer::start_tag('ul');

        $html .= html_writer::start_tag('li');

        $html .= implode(html_writer::end_tag('li') . html_writer::start_tag('li'), $infos);

        $html .= html_writer::end_tag('li');

        $html .= html_writer::end_tag('ul');

        $html .= html_writer::end_tag('div');

        $html .= $this->output->box_end();

        return $html;

    }

}