adds initial word_cloud_module files

common/lib/xmodule/setup.py

@@ -52,6 +52,7 @@ setup(
             "graphical_slider_tool = xmodule.gst_module:GraphicalSliderToolDescriptor",
             "annotatable = xmodule.annotatable_module:AnnotatableDescriptor",
             "foldit = xmodule.foldit_module:FolditDescriptor",
+            "word_cloud = xmodule.word_cloud_module:WordCloudDescriptor",
             "hidden = xmodule.hidden_module:HiddenDescriptor",
             "raw = xmodule.raw_module:RawDescriptor",
         ],

common/lib/xmodule/xmodule/js/src/word_cloud/logme.js

+// Wrapper for RequireJS. It will make the standard requirejs(), require(), and
+// define() functions from Require JS available inside the anonymous function.
+(function (requirejs, require, define) {
+
+define('logme', [], function () {
+    var debugMode;
+
+    // debugMode can be one of the following:
+    //
+    //     true - All messages passed to logme will be written to the internal
+    //            browser console.
+    //     false - Suppress all output to the internal browser console.
+    //
+    // Obviously, if anywhere there is a direct console.log() call, we can't do
+    // anything about it. That's why use logme() - it will allow to turn off
+    // the output of debug information with a single change to a variable.
+    debugMode = true;
+
+    return logme;
+
+    /*
+     * function: logme
+     *
+     * A helper function that provides logging facilities. We don't want
+     * to call console.log() directly, because sometimes it is not supported
+     * by the browser. Also when everything is routed through this function.
+     * the logging output can be easily turned off.
+     *
+     * logme() supports multiple parameters. Each parameter will be passed to
+     * console.log() function separately.
+     *
+     */
+    function logme() {
+        var i;
+
+        if (
+            (typeof debugMode === 'undefined') ||
+            (debugMode !== true) ||
+            (typeof window.console === 'undefined')
+        ) {
+            return;
+        }
+
+        for (i = 0; i < arguments.length; i++) {
+            window.console.log(arguments[i]);
+        }
+    } // End-of: function logme
+});
+
+// End of wrapper for RequireJS. As you can see, we are passing
+// namespaced Require JS variables to an anonymous function. Within
+// it, you can use the standard requirejs(), require(), and define()
+// functions as if they were in the global namespace.
+}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define)

common/lib/xmodule/xmodule/js/src/word_cloud/word_cloud_main.js

+window.Poll = function (el) {
+    RequireJS.require(['PollMain'], function (PollMain) {
+        new PollMain(el);
+    });
+};

common/lib/xmodule/xmodule/word_cloud_module.py

+"""Word cloud is ungraded xblock used by students to
+generate and view word cloud..
+
+On the client side we show:
+If student does not yet anwered - five text inputs.
+If student have answered - words he entered and cloud.
+
+Stunent can change his answer.
+"""
+
+import cgi
+import json
+import logging
+from copy import deepcopy
+from collections import OrderedDict
+
+from lxml import etree
+from pkg_resources import resource_string
+
+from xmodule.x_module import XModule
+from xmodule.stringify import stringify_children
+from xmodule.mako_module import MakoModuleDescriptor
+from xmodule.xml_module import XmlDescriptor
+from xblock.core import Scope, String, Object, Boolean, List
+
+log = logging.getLogger(__name__)
+
+
+class WordCloudFields(object):
+    # Name of poll to use in links to this poll
+    display_name = String(help="Display name for this module", scope=Scope.settings)
+
+    submitted = Boolean(help="Whether this student has voted on the poll", scope=Scope.student_state, default=False)
+    student_words= List(help="Student answer", scope=Scope.student_state, default=[])
+    all_words = Object(help="All possible words from other students", scope=Scope.content)
+    top_words = Object(help="Top N words for word cloud", scope=Scope.content)
+    top_low_border = Int(help="Number to distinguish top from all words", scope=Scope.content)
+
+class WordCloudModule(WordCloudFields, XModule):
+    """WordCloud Module"""
+    js = {
+      'coffee': [resource_string(__name__, 'js/src/javascript_loader.coffee')],
+      'js': [resource_string(__name__, 'js/src/word_cloud/logme.js'),
+             resource_string(__name__, 'js/src/word_cloud/word_cloud.js'),
+             resource_string(__name__, 'js/src/word_cloud/word_cloud_main.js')]
+         }
+    css = {'scss': [resource_string(__name__, 'css/word_cloud/display.scss')]}
+    js_module_name = "Word_Cloud"
+
+    Number_of_top_words = 250
+
+    def handle_ajax(self, dispatch, get):
+        """Ajax handler.
+
+        Args:
+            dispatch: string request slug
+            get: dict request get parameters
+
+        Returns:
+            json string
+        """
+        if dispatch == 'submit':
+
+            # self.all_words[word] -= 1
+            # FIXME: fix this, when xblock will support mutable types.
+            # Now we use this hack.
+            # speed issues
+            temp_all_words = self.all_words
+            temp_top_words = self.top_words
+
+            if self.submitted:
+
+                for word in self.student_words:
+                    temp_all_words[word] -= 1
+
+                    if word in temp_top_words:
+                        temp_top_words -= 1
+
+            else:
+                self.submitted = True
+
+            self.student_words = get['student_words']
+
+            question_words = {}
+
+            for word in self.student_words:
+                temp_all_words[word] += 1
+
+                if word in temp_top_words:
+                    temp_top_words += 1
+                else:
+                    if temp_all_words[word] > top_low_border:
+                        question_words[word] = temp_all_words[word]
+
+
+            self.all_words = temp_all_words
+
+            self.top_words = self.update_top_words(question_words, temp_top_words)
+
+
+            return json.dumps({'student_words': self.student_words,
+                               'top_words': self.top_words,
+                               })
+        elif dispatch == 'get_state':
+            return json.dumps({'student_answers': self.student_answers,
+                               'top_words': self.top_words)
+                               })
+        else:  # return error message
+            return json.dumps({'error': 'Unknown Command!'})
+
+
+    def update_top_words(question_words, top_words):
+
+        for word, number in question_words:
+            for top_word, top_number in top_words[:]:
+                if top_number < number:
+                    del top_words[top_word]
+                    top_words[word] - number
+                    break
+
+        return top_words
+
+    def get_html(self):
+        """Renders parameters to template."""
+        params = {
+                  'element_id': self.location.html_id(),
+                  'element_class': self.location.category,
+                  'ajax_url': self.system.ajax_url,
+                  'configuration_json': json.dumps({}),
+                  }
+        self.content = self.system.render_template('word_cloud.html', params)
+        return self.content
+
+
+
+class WordCloudDescriptor(WordCloudFields, MakoModuleDescriptor, XmlDescriptor):
+    _tag_name = 'word_cloud'
+
+    module_class = WordCloudModule
+    template_dir_name = 'word_cloud'
+    stores_state = True
+
+    @classmethod
+    def definition_from_xml(cls, xml_object, system):
+        """Pull out the data into dictionary.
+
+        Args:
+            xml_object: xml from file.
+            system: `system` object.
+
+        Returns:
+            (definition, children) - tuple
+
+        """
+        definition = {}
+        children = []
+
+        return (definition, children)
+
+    def definition_to_xml(self, resource_fs):
+        """Return an xml element representing to this definition."""
+        poll_str = '<{tag_name}/>'.format(tag_name=self._tag_name)
+        xml_object = etree.fromstring(poll_str)
+        xml_object.set('display_name', self.display_name)
+
+        return xml_object

lms/templates/word_cloud.html

+<section
+    id="poll_${element_id}"
+    class="${element_class}"
+    data-ajax-url="${ajax_url}"
+>
+    <!-- Hidden field to read configuration JSON from. -->
+    <div class="${element_class}_div" id="${element_id}_json" style="display: none;">${configuration_json}</div>
+</section>