From 36affe7c738e94c6085f50b5fae8dfb9ae9b81fd Mon Sep 17 00:00:00 2001 From: Thierry Parmentelat Date: Thu, 20 Dec 2012 16:07:58 +0100 Subject: [PATCH] cleanup rendered html with new field names --- engine/composite.py | 7 ++-- engine/plugin.py | 49 +++++++++++++-------------- engine/templates/plugin.html | 16 +++++---- engine/views.py | 1 - plugins/simplelist.py | 1 - plugins/templates/verticallayout.html | 2 +- 6 files changed, 39 insertions(+), 37 deletions(-) diff --git a/engine/composite.py b/engine/composite.py index fd72db5b..69953f70 100644 --- a/engine/composite.py +++ b/engine/composite.py @@ -12,11 +12,14 @@ class Composite (Plugin): def template_env (self, request): # this is designed so as to support a template like # {% for son in sons %} {{ son.rendered }} ... + ranks=range(len(self.sons)) return { 'sons': [ { 'rendered': son.render(request), 'title': son.title, - 'uuid': son.uuid} - for son in self.sons ]} + 'uuid': son.uuid, + 'classname': son.classname, + 'rank': rank} + for (son,rank) in zip(self.sons,ranks) ]} # xxx need a way to select an active son, like e.g. # Composite (active='some string') diff --git a/engine/plugin.py b/engine/plugin.py index 2645810f..b69d098f 100644 --- a/engine/plugin.py +++ b/engine/plugin.py @@ -8,10 +8,11 @@ from django.template.loader import render_to_string from engine.prelude import Prelude -# set to +#################### +# set DEBUG to # . False : silent -# [ 'SliceList', 'TabbedView' ] : to debug these classes -# True : to debug all slices +# . [ 'SliceList', 'TabbedView' ] : to debug these classes +# . True : to debug all plugin DEBUG= [ 'SliceList' ] @@ -53,10 +54,12 @@ class Plugin: self.name=name self.add_to_settings ( ['title','name'] ) self.uuid=Plugin.newuuid() + self.classname=self._classname() + self.add_to_settings ( [ 'uuid', 'classname' ] ) self.visible=visible self.hidable=hidable self.hidden_by_default=hidden_by_default - self.add_to_settings( ['uuid','visible','hidable','hidden_by_default'] ) + self.add_to_settings( ['visible','hidable','hidden_by_default'] ) # we store as a dictionary the arguments passed to constructor # e.g. SimpleList (list=[1,2,3]) => _settings = { 'list':[1,2,3] } # our own settings are not made part of _settings but could be.. @@ -73,7 +76,7 @@ class Plugin: for setting_name in setting_name_s: self._settings[setting_name]=getattr(self,setting_name) - def classname (self): + def _classname (self): try: return self.__class__.__name__ except: return 'Plugin' @@ -90,13 +93,12 @@ class Plugin: def need_debug (self): if not DEBUG: return False if DEBUG is True: return True - else: return self.classname() in DEBUG + else: return self.classname in DEBUG # returns the html code for that plugin # in essence, wraps the results of self.render_content () def render (self, request): uuid = self.uuid - classname = self.classname() # initialize prelude placeholder self._init_request (request) @@ -105,15 +107,11 @@ class Plugin: # expose _settings in json format to js settings_json = json.dumps (self._settings, separators=(',',':')) - result = render_to_string ('plugin.html', - {'uuid':uuid, - 'classname':classname, - 'visible':self.is_visible(), - 'hidable':self.is_hidable(), - 'hidden':self.is_hidden_by_default(), - 'plugin_content' : plugin_content, - 'settings_json' : settings_json, - }) + env= {'plugin_content' : plugin_content, + 'settings_json' : settings_json, + } + env.update(self._settings) + result = render_to_string ('plugin.html',env) # handle requirements() if defined on this class try: @@ -136,17 +134,18 @@ class Plugin: template = self.template_file() env=self.template_env(request) if not isinstance (env,dict): - raise Exception, "%s.template_env returns wrong type"%self.classname() + raise Exception, "%s.template_env returns wrong type"%self.classname # expose this class's settings to the template # xxx we might need to check that this does not overwrite env.. env.update(self._settings) result=render_to_string (template, env) if self.need_debug(): - print "%s.render_content: BEG --------------------"%self.classname() + print "%s.render_content: BEG --------------------"%self.classname print "template=%s"%template - print "env=%s"%env.keys() - # print result - print "%s.render_content: END --------------------"%self.classname() + print "env.keys=%s"%env.keys() + print "env=%s"%env + print result + print "%s.render_content: END --------------------"%self.classname return result #################### requirements/prelude management @@ -178,7 +177,7 @@ class Plugin: def handle_requirements (self, request, d): for (k,v) in d.iteritems(): if self.need_debug(): - print "%s: handling requirement %s"%(self.classname(),v) + print "%s: handling requirement %s"%(self.classname,v) method_name='add_'+k method=Plugin.__dict__[method_name] method(self,request,v) @@ -187,15 +186,15 @@ class Plugin: # your plugin is expected to implement either # (*) def render_content(self, request) -> html fragment # -- or -- - # (*) def template_file(self) -> filename + # (*) def template_file (self) -> filename # relative to STATIC # (*) def template_env (self, request) -> dict # this is the variable->value association used to render the template # in which case the html template will be used # if you see this string somewhere your template_file() code is not kicking in - def template_file (self): return "undefined_template" - def template_env (self, request): return {} + def template_file (self): return "undefined_template" + def template_env (self, request): return {} # # tell the framework about requirements (for the document
) # # the notion of 'Media' in django provides for medium-dependant diff --git a/engine/templates/plugin.html b/engine/templates/plugin.html index 20398015..650551af 100644 --- a/engine/templates/plugin.html +++ b/engine/templates/plugin.html @@ -1,12 +1,13 @@ +{##} {% if visible %} -
+ {% endif %} +{##} {# Plugin initialization (if the plugin has the right structure) - from plugin.php #} {# note: that's the spirit but using {% insert %} is not reliable enough #} {# so for now this doesn't make it back to the browser #} {% insert prelude_js %} if (typeof jQuery('#{{ uuid }}').$title != 'undefined') { - jQuery('#{{ uuid }}').$title({ {{ settings_json }} plugin_uuid: '{{ uuid }}' }); - //jQuery('#{{ uuid }}').$title('show'); + jQuery('#plugin-{{ uuid }}').$title({ {{ settings_json }} plugin_uuid: '{{ uuid }}' }); + //jQuery('#plugin-{{ uuid }}').$title('show'); }; {% endinsert %} diff --git a/engine/views.py b/engine/views.py index f2c157f5..59a2e46a 100644 --- a/engine/views.py +++ b/engine/views.py @@ -57,7 +57,6 @@ def test_plugin_view (request): # request.plugin_prelude holds a summary of the requirements() for all plugins # define {js,css}_{files,chunks} prelude_env = request.plugin_prelude.template_env() - print 'prelude_env',prelude_env template_env.update(prelude_env) return render_to_response ('view-plugin.html',template_env, diff --git a/plugins/simplelist.py b/plugins/simplelist.py index f119d76b..d49118dc 100644 --- a/plugins/simplelist.py +++ b/plugins/simplelist.py @@ -22,7 +22,6 @@ class SimpleList (Plugin) : if self.with_datatables: reqs['js_files'].append ("datatables/js/dataTables.js") reqs['js_files'].append ("js/with-datatables.js") - print self.classname(),reqs return reqs # for tests # 'js_chunks' : "/* a javascript chunk */", diff --git a/plugins/templates/verticallayout.html b/plugins/templates/verticallayout.html index 4b77c94d..052dc490 100644 --- a/plugins/templates/verticallayout.html +++ b/plugins/templates/verticallayout.html @@ -1,7 +1,7 @@
{% for son in sons %}

{{ son.title }}

-
+
{{ son.rendered }}
{% endfor %} -- 2.43.0