Merge branch 'wip-MDL-60515-master' of git://github.com/abgreeve/moodle

mvaraujo · Nov 2, 2017 · 58280ae · 58280ae
2 parents c8e7777 + ab2095f
commit 58280ae
Show file tree

Hide file tree

Showing 11 changed files with 365 additions and 48 deletions.
diff --git a/group/classes/output/group_details.php b/group/classes/output/group_details.php
@@ -0,0 +1,93 @@
+<?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/>.
+
+/**
+ * Group details page.
+ *
+ * @package    core_group
+ * @copyright  2017 Adrian Greeve <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core_group\output;
+defined('MOODLE_INTERNAL') || die();
+
+use renderable;
+use renderer_base;
+use stdClass;
+use templatable;
+use context_course;
+use moodle_url;
+
+/**
+ * Group details page class.
+ *
+ * @package    core_group
+ * @copyright  2017 Adrian Greeve <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class group_details implements renderable, templatable {
+
+    /** @var stdClass $group An object with the group information. */
+    protected $group;
+
+    /**
+     * group_details constructor.
+     *
+     * @param  int $groupid Group ID to show details of.
+     */
+    public function __construct($groupid) {
+        $this->group = groups_get_group($groupid, '*', MUST_EXIST);
+    }
+
+    /**
+     * Export the data.
+     *
+     * @param renderer_base $output
+     * @return stdClass
+     */
+    public function export_for_template(renderer_base $output) {
+
+        if (!empty($this->group->description) || (!empty($this->group->picture) && empty($this->group->hidepicture))) {
+            $context = context_course::instance($this->group->courseid);
+            $description = file_rewrite_pluginfile_urls($this->group->description,
+                                                        'pluginfile.php',
+                                                        $context->id,
+                                                        'group',
+                                                        'description',
+                                                        $this->group->id);
+
+            $descriptionformat = $this->group->descriptionformat ?? FORMAT_MOODLE;
+            $options = [
+                'overflowdiv' => true,
+                'context'     => $context
+            ];
+
+            $data = new stdClass();
+            $data->name = format_string($this->group->name, true, ['context' => $context]);
+            $data->pictureurl = get_group_picture_url($this->group, $this->group->courseid, true);
+            $data->description = format_text($description, $descriptionformat, $options);
+
+            if (has_capability('moodle/course:managegroups', $context)) {
+                $url = new moodle_url('/group/group.php', ['id' => $this->group->id, 'courseid' => $this->group->courseid]);
+                $data->editurl = $url->out(false);
+            }
+
+            return $data;
+        } else {
+            return;
+        }
+    }
+}
diff --git a/group/classes/output/renderer.php b/group/classes/output/renderer.php
@@ -47,4 +47,15 @@ public function render_index_page(index_page $page) {
         $data = $page->export_for_template($this);
         return parent::render_from_template('core_group/index', $data);
     }
+
+    /**
+     * Defer to template.
+     *
+     * @param group_details $page Group details page object.
+     * @return string HTML to render the group details.
+     */
+    public function group_details(group_details $page) {
+        $data = $page->export_for_template($this);
+        return parent::render_from_template('core_group/group_details', $data);
+    }
 }
diff --git a/group/members.php b/group/members.php
@@ -102,36 +102,11 @@
 // Store the rows we want to display in the group info.
 $groupinforow = array();
 
-// Check if there is a picture to display.
-if (!empty($group->picture)) {
-    $picturecell = new html_table_cell();
-    $picturecell->attributes['class'] = 'left side picture';
-    $picturecell->text = print_group_picture($group, $course->id, true, true, false);
-    $groupinforow[] = $picturecell;
-}
-
 // Check if there is a description to display.
-$group->description = file_rewrite_pluginfile_urls($group->description, 'pluginfile.php', $context->id, 'group', 'description', $group->id);
 if (!empty($group->description)) {
-    if (!isset($group->descriptionformat)) {
-        $group->descriptionformat = FORMAT_MOODLE;
-    }
-
-    $options = new stdClass;
-    $options->overflowdiv = true;
-
-    $contentcell = new html_table_cell();
-    $contentcell->attributes['class'] = 'content';
-    $contentcell->text = format_text($group->description, $group->descriptionformat, $options);
-    $groupinforow[] = $contentcell;
-}
-
-// Check if we have something to show.
-if (!empty($groupinforow)) {
-    $groupinfotable = new html_table();
-    $groupinfotable->attributes['class'] = 'groupinfobox';
-    $groupinfotable->data[] = new html_table_row($groupinforow);
-    echo html_writer::table($groupinfotable);
+    $grouprenderer = $PAGE->get_renderer('core_group');
+    $groupdetailpage = new \core_group\output\group_details($groupid);
+    echo $grouprenderer->group_details($groupdetailpage);
 }
 
 /// Print the editing form

diff --git a/group/templates/group_details.mustache b/group/templates/group_details.mustache
@@ -0,0 +1,53 @@
+{{!
+    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/>.
+}}
+{{!
+    @template core_group/group_details
+
+    Template for the Groups page.
+
+    Classes required for JS:
+    * none
+
+    Data attributes required for JS:
+    * none
+
+    Context variables required for this template:
+    * name string Group Name
+    * pictureurl string Group image url
+    * description string Group description
+    * edit string edit link to edit the group
+
+    Example context (json):
+    {
+        "name": "Group Name",
+        "pictureurl": "https://raw.githubusercontent.com/moodle/moodle/master/pix/g/f1.png",
+        "description": "This is the description for Group Name",
+        "editurl": "http://www.moodle.org"
+    }
+}}
+{{#name}}
+<div class="groupinfobox container-fluid p-x-1 p-y-1">
+    {{#pictureurl}}
+    <div class="group-image"><img class="grouppicture" src="{{{pictureurl}}}" alt="{{{name}}}" title="{{{name}}}"/></div>
+    {{/pictureurl}}
+    {{#editurl}}
+    <div class="group-edit"><a href="{{editurl}}">{{#pix}}t/edit, core, {{#str}}editgroupprofile{{/str}}{{/pix}}</a></div>
+    {{/editurl}}
+    <h3 class="">{{{name}}}</h3>
+    <div class="group-description">{{{description}}}</div>
+</div>
+{{/name}}
diff --git a/group/tests/behat/group_description.feature b/group/tests/behat/group_description.feature
@@ -0,0 +1,104 @@
+@core @core_group
+Feature: The description of a group can be viewed by students and teachers
+  In order to view the description of a group
+  As a teacher
+  I need to create groups and add descriptions to them.
+
+  Background:
+    Given the following "courses" exist:
+      | fullname | shortname | format |
+      | Course 1 | C1 | topics |
+    And the following "users" exist:
+      | username | firstname | lastname | email |
+      | teacher1 | Teacher | 1 | teacher1@example.com |
+      | student1 | Student | 1 | student1@example.com |
+      | student2 | Student | 2 | student2@example.com |
+    And the following "course enrolments" exist:
+      | user | course | role |
+      | teacher1 | C1 | editingteacher |
+      | student1 | C1 | student |
+      | student2 | C1 | student |
+
+  @javascript
+  Scenario: A student can see the group description when visible groups are set. Teachers can see group details.
+    Given I log in as "teacher1"
+    And I am on "Course 1" course homepage
+    And I navigate to "Edit settings" in current page administration
+    And I set the following fields to these values:
+      | Group mode | Visible groups |
+    And I press "Save and display"
+    And I navigate to "Users > Groups" in current page administration
+    And I press "Create group"
+    And I set the following fields to these values:
+      | Group name | Group A |
+      | Group description | Description for Group A |
+    And I press "Save changes"
+    And I press "Create group"
+    And I set the following fields to these values:
+      | Group name | Group B |
+    And I press "Save changes"
+    And I add "Student 1 ([email protected])" user to "Group A" group members
+    And I add "Student 2 ([email protected])" user to "Group B" group members
+    And I am on "Course 1" course homepage
+    And I navigate to course participants
+    And I open the autocomplete suggestions list
+    And I click on "Group: Group A" item in the autocomplete list
+    And I should see "Description for Group A"
+    And ".groupinfobox" "css_element" should exist
+    And I should see "Description for Group A"
+    And I click on "Group: Group A" "autocomplete_selection"
+    And I open the autocomplete suggestions list
+    And I click on "Group: Group B" item in the autocomplete list
+    And ".groupinfobox" "css_element" should not exist
+    And I log out
+    When I log in as "student1"
+    And I am on "Course 1" course homepage
+    And I navigate to course participants
+    Then I should see "Description for Group A"
+    And I log out
+    And I log in as "student2"
+    And I am on "Course 1" course homepage
+    And I navigate to course participants
+    And ".groupinfobox" "css_element" should not exist
+
+  @javascript
+  Scenario: A student can not see the group description when separate groups are set. Teachers can see group details.
+    Given I log in as "teacher1"
+    And I am on "Course 1" course homepage
+    And I navigate to "Edit settings" in current page administration
+    And I set the following fields to these values:
+      | Group mode | Separate groups |
+    And I press "Save and display"
+    And I navigate to "Users > Groups" in current page administration
+    And I press "Create group"
+    And I set the following fields to these values:
+      | Group name | Group A |
+      | Group description | Description for Group A |
+    And I press "Save changes"
+    And I press "Create group"
+    And I set the following fields to these values:
+      | Group name | Group B |
+    And I press "Save changes"
+    And I add "Student 1 ([email protected])" user to "Group A" group members
+    And I add "Student 2 ([email protected])" user to "Group B" group members
+    And I am on "Course 1" course homepage
+    And I navigate to course participants
+    And I open the autocomplete suggestions list
+    And I click on "Group: Group A" item in the autocomplete list
+    And I should see "Description for Group A"
+    And ".groupinfobox" "css_element" should exist
+    And I click on "Group: Group A" "autocomplete_selection"
+    And I open the autocomplete suggestions list
+    And I click on "Group: Group B" item in the autocomplete list
+    And ".groupinfobox" "css_element" should not exist
+    And I log out
+    When I log in as "student1"
+    And I am on "Course 1" course homepage
+    And I navigate to course participants
+    Then I should not see "Description for Group A"
+    And ".groupinfobox" "css_element" should not exist
+    And I log out
+    And I log in as "student2"
+    And I am on "Course 1" course homepage
+    And I navigate to course participants
+    And ".groupinfobox" "css_element" should not exist
diff --git a/lib/behat/classes/partial_named_selector.php b/lib/behat/classes/partial_named_selector.php
@@ -109,6 +109,7 @@ public function __construct() {
         'text' => 'text',
         'xpath_element' => 'xpath_element',
         'form_row' => 'form_row',
+        'autocomplete_selection' => 'autocomplete_selection',
     );
 
     /**
@@ -178,6 +179,9 @@ public function __construct() {
 XPATH
         , 'message_area_action' => <<<XPATH
 .//div[@data-region='messaging-area']/descendant::*[@data-action = %locator%]
+XPATH
+        , 'autocomplete_selection' => <<<XPATH
+.//div[contains(concat(' ', normalize-space(@class), ' '), concat(' ', 'form-autocomplete-selection', ' '))]/span[@role='listitem'][contains(normalize-space(.), %locator%)]
 XPATH
     );