From b709866ba93d98c32127ff4deae5b783e271e5b3 Mon Sep 17 00:00:00 2001
From: Thierry Parmentelat <thierry.parmentelat@inria.fr>
Date: Mon, 18 Mar 2013 14:13:06 +0100
Subject: [PATCH] split engine/ into manifold/ (backend oriented) and unfold/
 (the UI)

---
 Makefile                                         |  2 +-
 README                                           |  7 +++++--
 auth/manifoldbackend.py                          |  2 +-
 {engine => manifold}/__init__.py                 |  0
 {engine => manifold}/manifoldapi.py              |  0
 {engine => manifold}/manifoldproxy.py            |  4 ++--
 {engine => manifold}/manifoldquery.py            |  0
 myslice/settings.py                              | 10 +++++++---
 myslice/urls.py                                  |  2 +-
 plugins/lists/simplelist.py                      |  2 +-
 plugins/lists/staticlist.py                      |  2 +-
 plugins/querycode/querycode.py                   |  2 +-
 plugins/quickfilter/quickfilter.py               |  2 +-
 plugins/raw/raw.py                               |  2 +-
 plugins/tabs/tabs.py                             |  2 +-
 plugins/verticallayout/verticallayout.py         |  2 +-
 trash/dashboard.py                               |  4 ++--
 trash/pluginview.py                              |  2 +-
 trash/sampleviews.py                             |  2 +-
 unfold/__init__.py                               |  0
 {engine => unfold}/composite.py                  |  2 +-
 {engine => unfold}/css/plugin.css                |  0
 {engine => unfold}/js/manifold-async.js          |  0
 {engine => unfold}/js/manifold-pubsub.js         |  0
 {engine => unfold}/js/manifold-query.js          |  0
 {engine => unfold}/js/onavail.js                 |  0
 {engine => unfold}/js/plugin-init.js             |  0
 {engine => unfold}/js/plugin.js                  |  0
 {engine => unfold}/models.py                     |  0
 {engine => unfold}/page.py                       |  4 ++--
 {engine => unfold}/plugin.py                     |  4 ++--
 {engine => unfold}/prelude.py                    |  0
 {engine => unfold}/templates/header-prelude.html |  0
 {engine => unfold}/templates/plugin-setenv.js    |  0
 {engine => unfold}/templates/plugin.html         |  0
 {engine => unfold}/tests.py                      |  0
 36 files changed, 33 insertions(+), 26 deletions(-)
 rename {engine => manifold}/__init__.py (100%)
 rename {engine => manifold}/manifoldapi.py (100%)
 rename {engine => manifold}/manifoldproxy.py (95%)
 rename {engine => manifold}/manifoldquery.py (100%)
 create mode 100644 unfold/__init__.py
 rename {engine => unfold}/composite.py (96%)
 rename {engine => unfold}/css/plugin.css (100%)
 rename {engine => unfold}/js/manifold-async.js (100%)
 rename {engine => unfold}/js/manifold-pubsub.js (100%)
 rename {engine => unfold}/js/manifold-query.js (100%)
 rename {engine => unfold}/js/onavail.js (100%)
 rename {engine => unfold}/js/plugin-init.js (100%)
 rename {engine => unfold}/js/plugin.js (100%)
 rename {engine => unfold}/models.py (100%)
 rename {engine => unfold}/page.py (98%)
 rename {engine => unfold}/plugin.py (99%)
 rename {engine => unfold}/prelude.py (100%)
 rename {engine => unfold}/templates/header-prelude.html (100%)
 rename {engine => unfold}/templates/plugin-setenv.js (100%)
 rename {engine => unfold}/templates/plugin.html (100%)
 rename {engine => unfold}/tests.py (100%)

diff --git a/Makefile b/Makefile
index a819950b..85b5d09a 100644
--- a/Makefile
+++ b/Makefile
@@ -42,7 +42,7 @@ thirdparty-css:
 thirdparty-img:
 	@find $(THIRD-PARTY-RESOURCES) -name '*.png'
 
-# we might have any of these as templates - e.g. ./engine/templates/plugin-setenv.js
+# we might have any of these as templates - e.g. ./unfold/templates/plugin-setenv.js
 # so if there's a /templates/ in the path ignore the file
 local-js: force
 	@find . -type f -name '*.js' | egrep -v '/all-(static|templates)/|/third-party/|/templates/'
diff --git a/README b/README
index 95a197ae..724fa20b 100644
--- a/README
+++ b/README
@@ -103,8 +103,11 @@ I've tried to keep track of the version I picked and to have an easy upgrade pat
   . settings.py
   . urls.py
 
-* engine:
-  the code for building / rendering plugins / queries
+* manifold:
+  the code for dealing with queries, sending them to the backend, and offering the /manifold/api/ proxy URL
+
+* unfold:
+  the code for building / rendering plugins 
 
 * plugins:
   the actual code for plugins
diff --git a/auth/manifoldbackend.py b/auth/manifoldbackend.py
index dbaf863c..96697b3f 100644
--- a/auth/manifoldbackend.py
+++ b/auth/manifoldbackend.py
@@ -2,7 +2,7 @@ import time
 
 from django.contrib.auth.models import User
 
-from engine.manifoldapi import ManifoldAPI
+from manifold.manifoldapi import ManifoldAPI
 
 # Name my backend 'ManifoldBackend'
 class ManifoldBackend:
diff --git a/engine/__init__.py b/manifold/__init__.py
similarity index 100%
rename from engine/__init__.py
rename to manifold/__init__.py
diff --git a/engine/manifoldapi.py b/manifold/manifoldapi.py
similarity index 100%
rename from engine/manifoldapi.py
rename to manifold/manifoldapi.py
diff --git a/engine/manifoldproxy.py b/manifold/manifoldproxy.py
similarity index 95%
rename from engine/manifoldproxy.py
rename to manifold/manifoldproxy.py
index f75d430c..3b3ba0fb 100644
--- a/engine/manifoldproxy.py
+++ b/manifold/manifoldproxy.py
@@ -3,8 +3,8 @@ import json
 #from django.core import serializers
 from django.http import HttpResponse, HttpResponseForbidden
 
-from engine.manifoldquery import ManifoldQuery
-from engine.manifoldapi import ManifoldAPI
+from manifold.manifoldquery import ManifoldQuery
+from manifold.manifoldapi import ManifoldAPI
 
 # add artificial delay in s
 debug_spin=0
diff --git a/engine/manifoldquery.py b/manifold/manifoldquery.py
similarity index 100%
rename from engine/manifoldquery.py
rename to manifold/manifoldquery.py
diff --git a/myslice/settings.py b/myslice/settings.py
index a4a32214..0deec523 100644
--- a/myslice/settings.py
+++ b/myslice/settings.py
@@ -142,12 +142,16 @@ INSTALLED_APPS = (
     'django.contrib.sites',
     'django.contrib.messages',
     'django.contrib.staticfiles',
+    # handling the {% insert %} and {% container %} tags
     # see details in devel/django-insert-above-1.0-4
     'insert_above',
+    # our django project
     'myslice',
-    'auth',
-    'engine',
+    # the core of the UI
+    'auth', 'manifold', 'unfold',
+    # plugins
     'plugins',
+    # views - more or less stable 
     'views',
     'trash',
     # Uncomment the next line to enable the admin:
@@ -190,7 +194,7 @@ AUTHENTICATION_BACKENDS = ( 'auth.backend.MyCustomBackend', 'auth.manifoldbacken
 ### the view to redirect malformed (i.e. with a wrong CSRF) incoming requests
 # without this setting django will return a 403 forbidden error, which is fine
 # if you need to see the error message then use this setting
-CSRF_FAILURE_VIEW = 'engine.manifoldproxy.csrf_failure'
+CSRF_FAILURE_VIEW = 'manifold.manifoldproxy.csrf_failure'
 
 #################### for insert_above
 #IA_JS_FORMAT = "<script type='text/javascript' src='{URL}' />"
diff --git a/myslice/urls.py b/myslice/urls.py
index b5389a1e..c3fababc 100644
--- a/myslice/urls.py
+++ b/myslice/urls.py
@@ -38,7 +38,7 @@ urlpatterns = patterns(
     #
     # the manifold proxy
     #
-    (r'^manifold/api/(?P<format>\w+)/?$', 'engine.manifoldproxy.api'),
+    (r'^manifold/api/(?P<format>\w+)/?$', 'manifold.manifoldproxy.api'),
     #
     # various trash views
     #
diff --git a/plugins/lists/simplelist.py b/plugins/lists/simplelist.py
index 663dd05e..5681bb72 100644
--- a/plugins/lists/simplelist.py
+++ b/plugins/lists/simplelist.py
@@ -1,4 +1,4 @@
-from engine.plugin import Plugin
+from unfold.plugin import Plugin
 
 class SimpleList (Plugin) :
 
diff --git a/plugins/lists/staticlist.py b/plugins/lists/staticlist.py
index 134917a8..4655578a 100644
--- a/plugins/lists/staticlist.py
+++ b/plugins/lists/staticlist.py
@@ -1,4 +1,4 @@
-from engine.plugin import Plugin
+from unfold.plugin import Plugin
 
 class StaticList (Plugin) :
 
diff --git a/plugins/querycode/querycode.py b/plugins/querycode/querycode.py
index 6766444f..5211d637 100644
--- a/plugins/querycode/querycode.py
+++ b/plugins/querycode/querycode.py
@@ -1,4 +1,4 @@
-from engine.plugin import Plugin
+from unfold.plugin import Plugin
 
 class QueryCode (Plugin):
 
diff --git a/plugins/quickfilter/quickfilter.py b/plugins/quickfilter/quickfilter.py
index a49a0e50..cd6ff6ed 100644
--- a/plugins/quickfilter/quickfilter.py
+++ b/plugins/quickfilter/quickfilter.py
@@ -1,4 +1,4 @@
-from engine.plugin import Plugin
+from unfold.plugin import Plugin
 
 class QuickFilter (Plugin) :
 
diff --git a/plugins/raw/raw.py b/plugins/raw/raw.py
index 6da0c908..01f59e9f 100644
--- a/plugins/raw/raw.py
+++ b/plugins/raw/raw.py
@@ -1,4 +1,4 @@
-from engine.plugin import Plugin
+from unfold.plugin import Plugin
 
 # usage Raw (html="some html text")
 
diff --git a/plugins/tabs/tabs.py b/plugins/tabs/tabs.py
index d487eec6..211af422 100644
--- a/plugins/tabs/tabs.py
+++ b/plugins/tabs/tabs.py
@@ -1,4 +1,4 @@
-from engine.composite import Composite
+from unfold.composite import Composite
 
 class Tabs (Composite):
     
diff --git a/plugins/verticallayout/verticallayout.py b/plugins/verticallayout/verticallayout.py
index 9ac6f49c..fe6ff458 100644
--- a/plugins/verticallayout/verticallayout.py
+++ b/plugins/verticallayout/verticallayout.py
@@ -1,6 +1,6 @@
 from django.template.loader import render_to_string
 
-from engine.composite import Composite
+from unfold.composite import Composite
 
 class VerticalLayout (Composite) :
     
diff --git a/trash/dashboard.py b/trash/dashboard.py
index d081ea2c..3f92b9dc 100644
--- a/trash/dashboard.py
+++ b/trash/dashboard.py
@@ -7,8 +7,8 @@ from django.shortcuts import render_to_response
 
 from django.contrib.auth.decorators import login_required
 
-from engine.page import Page
-from engine.manifoldquery import ManifoldQuery
+from unfold.page import Page
+from manifold.manifoldquery import ManifoldQuery
 
 from plugins.verticallayout.verticallayout import VerticalLayout
 from plugins.lists.slicelist import SliceList
diff --git a/trash/pluginview.py b/trash/pluginview.py
index 9c9c6a70..da31dfaa 100644
--- a/trash/pluginview.py
+++ b/trash/pluginview.py
@@ -7,7 +7,7 @@ from django.shortcuts import render_to_response
 
 from django.contrib.auth.decorators import login_required
 
-from engine.page import Page
+from unfold.page import Page
 
 from plugins.verticallayout.verticallayout import VerticalLayout
 from plugins.tabs.tabs import Tabs
diff --git a/trash/sampleviews.py b/trash/sampleviews.py
index 7147dbb2..8fbcb01c 100644
--- a/trash/sampleviews.py
+++ b/trash/sampleviews.py
@@ -4,7 +4,7 @@ from django.template import RequestContext
 from django.shortcuts import render_to_response
 from django.contrib.auth.decorators import login_required
 
-from engine.prelude import Prelude
+from unfold.prelude import Prelude
 
 from myslice.viewutils import topmenu_items, the_user
 # tmp
diff --git a/unfold/__init__.py b/unfold/__init__.py
new file mode 100644
index 00000000..e69de29b
diff --git a/engine/composite.py b/unfold/composite.py
similarity index 96%
rename from engine/composite.py
rename to unfold/composite.py
index 49ea0b57..409b1bc8 100644
--- a/engine/composite.py
+++ b/unfold/composite.py
@@ -1,4 +1,4 @@
-from engine.plugin import Plugin
+from unfold.plugin import Plugin
 
 class Composite (Plugin):
 
diff --git a/engine/css/plugin.css b/unfold/css/plugin.css
similarity index 100%
rename from engine/css/plugin.css
rename to unfold/css/plugin.css
diff --git a/engine/js/manifold-async.js b/unfold/js/manifold-async.js
similarity index 100%
rename from engine/js/manifold-async.js
rename to unfold/js/manifold-async.js
diff --git a/engine/js/manifold-pubsub.js b/unfold/js/manifold-pubsub.js
similarity index 100%
rename from engine/js/manifold-pubsub.js
rename to unfold/js/manifold-pubsub.js
diff --git a/engine/js/manifold-query.js b/unfold/js/manifold-query.js
similarity index 100%
rename from engine/js/manifold-query.js
rename to unfold/js/manifold-query.js
diff --git a/engine/js/onavail.js b/unfold/js/onavail.js
similarity index 100%
rename from engine/js/onavail.js
rename to unfold/js/onavail.js
diff --git a/engine/js/plugin-init.js b/unfold/js/plugin-init.js
similarity index 100%
rename from engine/js/plugin-init.js
rename to unfold/js/plugin-init.js
diff --git a/engine/js/plugin.js b/unfold/js/plugin.js
similarity index 100%
rename from engine/js/plugin.js
rename to unfold/js/plugin.js
diff --git a/engine/models.py b/unfold/models.py
similarity index 100%
rename from engine/models.py
rename to unfold/models.py
diff --git a/engine/page.py b/unfold/page.py
similarity index 98%
rename from engine/page.py
rename to unfold/page.py
index 57e52268..5d37acff 100644
--- a/engine/page.py
+++ b/unfold/page.py
@@ -4,8 +4,8 @@
 
 import json
 
-from engine.prelude import Prelude
-from engine.manifoldapi import ManifoldAPI
+from unfold.prelude import Prelude
+from manifold.manifoldapi import ManifoldAPI
 from myslice.config import Config
 
 # decorator to deflect calls on this Page to its prelude
diff --git a/engine/plugin.py b/unfold/plugin.py
similarity index 99%
rename from engine/plugin.py
rename to unfold/plugin.py
index 8f817a5b..1b710520 100644
--- a/engine/plugin.py
+++ b/unfold/plugin.py
@@ -6,8 +6,8 @@ import json
 
 from django.template.loader import render_to_string
 
-from engine.page import Page
-from engine.prelude import Prelude
+from unfold.page import Page
+from unfold.prelude import Prelude
 
 #################### 
 # set DEBUG to
diff --git a/engine/prelude.py b/unfold/prelude.py
similarity index 100%
rename from engine/prelude.py
rename to unfold/prelude.py
diff --git a/engine/templates/header-prelude.html b/unfold/templates/header-prelude.html
similarity index 100%
rename from engine/templates/header-prelude.html
rename to unfold/templates/header-prelude.html
diff --git a/engine/templates/plugin-setenv.js b/unfold/templates/plugin-setenv.js
similarity index 100%
rename from engine/templates/plugin-setenv.js
rename to unfold/templates/plugin-setenv.js
diff --git a/engine/templates/plugin.html b/unfold/templates/plugin.html
similarity index 100%
rename from engine/templates/plugin.html
rename to unfold/templates/plugin.html
diff --git a/engine/tests.py b/unfold/tests.py
similarity index 100%
rename from engine/tests.py
rename to unfold/tests.py
-- 
2.43.0