Changeset 1706

Timestamp:

07/23/08 12:46:51 (20 months ago)

Author:

JensDiemer

Message:

Add a set_preferences method. Update unittest and doc.

Location:

trunk/pylucid

Files:

• doc/plugin_api.py (modified) (1 diff)
• PyLucid/models/Plugin.py (modified) (2 diffs)
• PyLucid/system/BasePlugin.py (modified) (2 diffs)
• tests/preferences.py (modified) (1 diff)
• tests/unittest_plugin/unittest_plugin.py (modified) (1 diff)

trunk/pylucid/doc/plugin_api.py

@@ -162 +162 @@
         my_entry_value = preferences["entry_key"]
 
+    def change_preference_entry(self):
+        """
+        A plugin can change a preference entry with self.set_preferences()
+        """
+        new_preference_dict = self.set_preferences("key", "new_value")
+
+        self.page_msg("Changed value:", new_preference_dict["key"])
 
     #__________________________________________________________________________

trunk/pylucid/PyLucid/models/Plugin.py

@@ -76 +76 @@
     Adds caching to plugin preference queries.
     """
-    def get_preferences(self, plugin_name, id=None):
-        """
-        returns the preference data dict, use the cache
-        """
+    def get_pref_obj(self, plugin_name, id=None):
         # Get the name of the plugin, if __file__ used
         plugin_name = os.path.splitext(os.path.basename(plugin_name))[0]
@@ -102 +99 @@
             ) % (id, pref.plugin, plugin)
 
+        return pref
+
+    def get_preferences(self, plugin_name, id=None):
+        """
+        returns the preference data dict, use the cache
+        """
+        pref = self.get_pref_obj(plugin_name, id)
         data_dict = pref.get_data()
-
+        return data_dict
+
+    def set_preferences(self, plugin_name, key, value, user, id=None):
+        """
+        set a new value to one preferences entry
+        """
+        pref_obj = self.get_pref_obj(plugin_name, id)
+        data_dict = pref_obj.get_data()
+        data_dict[key] = value
+        pref_obj.set_data(data_dict, user)
+        pref_obj.save()
         return data_dict
 

trunk/pylucid/PyLucid/system/BasePlugin.py

@@ -61 +61 @@
         self.current_page = self.context["PAGE"]
 
-    def get_preferences(self, id = None):
+    def get_preferences(self, id=None):
         """
         returns the preferences from the database as a dict
@@ -67 +67 @@
         preference = Plugin.objects.get_preferences(self.plugin_name, id)
         return preference
+
+    def set_preferences(self, key, value, id=None):
+        """
+        set a new value to one preferences entry
+        """
+        user = self.request.user
+        data_dict = Plugin.objects.set_preferences(
+            self.plugin_name, key, value, user, id
+        )
+        return data_dict
 
     def build_menu(self):

trunk/pylucid/tests/preferences.py

@@ -182 +182 @@
         pref_obj3 = self.test_plugin.get_preference(id = id)
         self.assertEqual(pref_obj3.get_data(), TEST_DICT2)
+
+
+    def test_plugin_manager(self):
+        """
+        Test Plugin.objects.set_preferences
+        """
+        pref_obj1 = self.test_plugin.set_default_preference(
+            comment = "default pref",
+            data = {"a":1, "b":2},
+            user = None,
+        )
+        self.assertEqual(pref_obj1.get_data(), {"a":1, "b":2})
+
+        # Test set_preferences
+        data_dict = Plugin.objects.set_preferences(
+            self.test_plugin.plugin_name, "b", 3, user=None
+        )
+        self.assertEqual(data_dict, {"a":1, "b":3})
+
+        # Check Plugin.objects.get_preferences
+        preference = Plugin.objects.get_preferences(
+            self.test_plugin.plugin_name, id=None
+        )
+        self.assertEqual(preference, {"a":1, "b":3})
 
 

trunk/pylucid/tests/unittest_plugin/unittest_plugin.py

@@ -158 +158 @@
         )
 
+        # Change a preference entry
+        new_preference_dict = self.set_preferences('print_index', True)
+        assert(new_preference_dict['print_index'], True)
+
+        # Get the preference from the database again and check
+        preferences = self.get_preferences()
+        assert(preferences['print_index'], True)
+
         self.response.write("test preferences END")