Changeset 4688

Timestamp:

06/08/08 10:05:27 (6 months ago)

Author:

deets

Message:

added version handling stuff, tests and docuementation

Files:

• projects/tgMochiKit/trunk/ChangeLog (added)
• projects/tgMochiKit/trunk/README.txt (modified) (2 diffs)
• projects/tgMochiKit/trunk/tgmochikit/base.py (modified) (4 diffs)
• projects/tgMochiKit/trunk/tgmochikit/__init__.py (modified) (1 diff)
• projects/tgMochiKit/trunk/tgmochikit/tests/test_tgmochikit.py (added)

projects/tgMochiKit/trunk/README.txt

@@ -121 +121 @@
-    This setting selects the version of the MochiKit library that the
-    ``turbogears.mochikit`` widget will use. tgMochiKit currently ships
-a snapshot
+several snapshots
-
-``tg_mochikit.packed -- False``
@@ -132 +132 @@
-    ``MochiKit.js`` file.
-
+``tg_mochikit.draganddrop -- False``
+    Selects whether the ``turbogears.mochikit`` widget should include the
+    ``DragAndDrop.js`` file.
+
+Version selection
+-----------------
+
+The selection of a proper version of MochiKit is a bit more elaborated due to 
+the fact that MockiKit hasn't had a proper 1.4 release for a few years now.
+
+tgMochiKit ships with various versions of MochKit.
+
+ - the stable 1.3.1 version, as used by the TurboGears 1.0.x series.
+ - various snapshots of the 1.4 version from the subversion.
+ - the ``trunk``, also a subversion snapshot, which reflects the
+   version inside trunk at the time of the tgMochiKit release you are using.
+
+You can get the shipped versions by doing :::
+
+  >>> import tgmochikit
+  >>> print tgmochikit.get_shipped_versions()
+
+
+Now when using tgMochiKit, the problem of which version to chose arises. 
+
+If you want 1.3.1, just configure that as version to chose.
+
+If you want a specific version that is shipped, configure that. This is the
+safe course of action for you application, because by this you ensure that
+even if you install newer versions of tgMochiKit (which might happen due
+to TurboGears upgrades), you will end up with code you verified that it works.
+
+If you feel confident that using the latest of MochiKit is ok for you, configure
+``tg_mochikit.version`` to be ``1.4``. This will always pick the newest from the 
+pack.
+
+The ``trunk``-version is something special. In the shipped tgMochiKit it will always
+be equal to the latest 1.4 version.
+
+However, if you want the latest from trunk, you can simply 
+
+ - check out tgMochiKit. This will fetch the latest from trunk into the distribution
+ - create your own tgMochiKit.egg, and use that for your application.
+
+The version actually used by tgMochiKit based on your configuration is by the way
+logged on the logger ``tgmochikit`` with level ``INFO`` with the text::
+
+  Version chosen: <version>
-
-Installation

projects/tgMochiKit/trunk/tgmochikit/base.py

@@ +1 @@
+import pkg_resources
+
+import os
-import glob
-os
+logging
-
-
+
-
-VERSION = '1.3.1'
@@ -13 +16 @@
-DRAGANDDROP = False
-
-
+config={}, 
-    """Initializes the MochiKit resources.
-
@@ -32 +35 @@
-        if draganddrop is not None:
-            DRAGANDDROP = draganddrop
-        import turbogears.config
-        INITIALIZED = True
-turbogears.
-turbogears.
-turbogears.
-turbogears.
+
+
+
+
-
-
-
-
+
+
+
+
+
+
+
+
+
-        path = os.path.join(js_dir, "unpacked", "*.js")
-        for name in glob.glob(path):
@@ -57 +65 @@
-                    res.append("unpacked/%s" % submodule)
-            PATHS = res
-
+ and not is_131
-            PATHS.append("unpacked/DragAndDrop.js")
-
-def get_paths():
-    return PATHS
+
+
+def get_shipped_versions():
+    js_base_dir = pkg_resources.resource_filename("tgmochikit",
+                                                  "static/javascript/")
+    return [os.path.basename(p) for p in glob.glob(os.path.join(js_base_dir, "*"))]
+    

projects/tgMochiKit/trunk/tgmochikit/__init__.py

@@ -1 @@
-
+, get_shipped_versions
-
-__all__ = [
-    "init",
-
+
+
-]