root/trunk/pylucid_project/tests/unittest_plugin/unittest_plugin.py

# -*- coding: utf-8 -*-

"""
    PyLucid Plugin API example
    ~~~~~~~~~~~~~~~~~~~~~~~~~~

    Pseudocode!

    Last commit info:
    ~~~~~~~~~~~~~~~~~
    $LastChangedDate$
    $Rev$
    $Author$

    :copyleft: 2008 by the PyLucid team, see AUTHORS for more details.
    :license: GNU GPL v3, see LICENSE.txt for more details.
"""

from pprint import pformat

from PyLucid.system.BasePlugin import PyLucidBasePlugin

from django.conf import settings
from django.db import models
from django.contrib.auth.models import User


#_____________________________________________________________________________
# Test Plugin models


class TestArtist(models.Model):
    name = models.CharField(max_length=100)

    class Meta:
        app_label = 'PyLucidPlugins'

class TestAlbum(models.Model):
    artist = models.ForeignKey(TestArtist)
    name = models.CharField(max_length=100)
    num_stars = models.IntegerField()

    createtime = models.DateTimeField(auto_now_add=True)
    lastupdatetime = models.DateTimeField(auto_now=True)

    createby = models.ForeignKey(User, related_name="test_createby",
        null=True, blank=True
    )
    class Meta:
        app_label = 'PyLucidPlugins'

    def __unicode__(self):
        return u"TestAlbum '%s', ID %s, createby: %s" % (
            self.name, self.id, self.createby
        )

PLUGIN_MODELS = (TestArtist, TestAlbum)

#_____________________________________________________________________________
# Plugin


class unittest_plugin(PyLucidBasePlugin):
    def lucidTag(self, *args, **kwargs):
        """
        Test if arguments in lucidTag would be parsed right in
        PyLucid.template_addons.lucidTag
        """
        self.response.write("<pre>\n")
        self.response.write("args:\n")
        self.response.write("%s\n" % pformat(args))
        self.response.write("pformarted kwargs:\n")
        self.response.write("%s\n" % pformat(kwargs))
        self.response.write("</pre>")

    def hello_world(self):
        """
        Test if arguments in a lucidTag
        """
        self.response.write("Hello world!")

    def test_restricted_method(self):
        """
        TODO: Must be update if ticket:199 is implemented!
        ticket: "change plugin_manager_data (must_login and must_admin)"
        """
        self.response.write("<pre>This is restricted!</pre>")

    def test_attributes(self, attr_name):
        self.response.write(getattr(self, attr_name))

    def test_page_msg(self):
        # Normal ouput in blue color
        self.page_msg("page_msg test:")

        # A black colored messages:
        self.page_msg.black("I am black")

        # A error in red color
        self.page_msg.red("RedError!")

        # Successfull messages should be geen:
        self.page_msg.green("and green")

    def plugin_models(self):
        """
        Plays with the two local plugin models.
        """
        self.response.write("<pre>\n")
        self.response.write("Test the plugin models\n")
        self.response.write("Create TestArtist\n")
        artist = TestArtist(name="A test Artist\n")
        artist.save()
        self.response.write("entry with ID '%s' created\n" % artist.id)
        self.response.write("Create TestAlbum\n")
        album = TestAlbum(
            artist = artist,
            name = "A test Album",
            num_stars = 10,
            createby = self.request.user
        )
        album.save()
        self.response.write("entry with ID '%s' created:\n" % album.id)
        self.response.write(u"%s\n" % album)
        self.response.write("</pre>")

    def all_models(self):
        """
        Display all existing models
        """
        self.response.write("<pre>\n")
        self.response.write("All Albums:\n")
        albums = TestAlbum.objects.all()
        for album in albums:
            self.response.write(u"%s: %s\n" % (album.id, album))

        self.response.write("</pre>")



    #__________________________________________________________________________
    # PREFERENCES
    #
    def test_preferences(self):
        """
        Test the preferences API.

        more info about plugin preferences:
            http://www.pylucid.org/_goto/153/preferences/

        TODO: Add more tests here. Test to change the preferences.
        """
        # Get the preferences from the database:
        preferences = self.get_preferences()

        self.response.write("<pre>\n")
        self.response.write(repr(preferences))
        self.response.write("</pre>")

        assert(preferences,
            {
                'index': u'Index', 'print_index': False,
                'print_last_page': True, 'index_url': u'/'
            }
        )

        # 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")


#    """
#    We inherit from the base plugin.
#    """
#    def global_objects(self):
#        """
#        A list of all global plugin objects how inherit from the base plugin.
#        """
#        # The plugin name as a String:
#        self.plugin_name
#
#        # Interface to the internal pages (only for special needs)
#        # PyLucid.system.internal_page.InternalPage()
#        self.internal_page
#
#        # The global context
#        self.context
#
#        # A response object (only for special needs)
#        self.response
#
#        # The django request object
#        # see http://www.djangoproject.com/documentation/request_response/
#        self.request
#
#        # Interface to the PyLucid page message system
#        self.page_msg
#
#        # object to build URLs:
#        # comes from PyLucid.system.URLs
#        self.URLs
#
#        # database instance of the cms page object:
#        self.current_page
#
#    #__________________________________________________________________________
#    # URLs
#    #
#    # How to build urls
#    #
#    def building_urls(self):
#        """
#        You should never building urls "by hand". You should use URLs!
#        In the most case you need only methodLink() and commandLink().
#
#        In special cases you can some other methods. Please look into the
#        source code PyLucid.system.URLs
#        """
#        # mostly you will create a link to a other method of the current plugin
#        # Use methodLink() for this:
#        link = self.URLs.methodLink("method_name")
#
#        # In special cases you would like to insert a link to a other plugin.
#        # Use commandLink() for this:
#        link = self.URLs.commandLink("page_admin", "edit_page")
#
#        # The URLs object is a dictionary like object. You can display the
#        # content of it into the page_msg with:
#        self.URLs.debug()
#
#
#    #__________________________________________________________________________
#    # OUTPUT
#    #
#    # How a Plugin can create a response
#    #
#    def render_a_internal_page(self):
#        """
#        Normal way to create output into the content area with a existing
#        internal page.
#
#        See also: http://pylucid.org/_goto/142/internal-pages/
#        """
#        # Example:
#        context = {
#            # Building a template context for the internal page
#            "key": value,
#            "Foo": Bar,
#        }
#        # Render the template with the context and write the result into the
#        # response object:
#        self._render_template("InternalPageName", context)
#
#    def page_msg(self):
#        """
#        With the global self.page_msg object a plugin can easy send short
#        messages to the user.
#        You can call page_msg several times and everywhere.
#        All messages would be inserted in the generated page.
#
#        Note:
#            The page message object is good for debugging. List and Dictioaries
#            would be formatted with pprint.
#
#        More info in PyLucid.system.page_msg
#        """
#        # Examples:
#
#        # Normal ouput in blue color
#        self.page_msg("The shorted way...")
#
#        # A error in red color
#        self.page_msg.red("Error!")
#
#        # A black colored messages:
#        self.page_msg.black("I am black")
#
#        # Successfull messages should be geen:
#        self.page_msg.geen("Update XY successfull")
#
#    def return_a_response(self):
#        """
#        A Plugin method can return a django HttpResponse object directy back.
#        e.g. send files to the client or a Redirect
#        """
#        # send the XML file to the client
#        from django.http import HttpResponse
#        response = HttpResponse()
#        response['Content-Type'] = 'application/xml; charset=utf-8'
#        response.write(FooBar)
#        return response
#
#    def change_page_title(self):
#        """
#        If a plugin creates his own response page, it should be change the
#        current displayed page title, so it makes more sense for the user.
#        """
#        self.context["PAGE"].title = "The Plugin Title"

#
#
#    #__________________________________________________________________________
#    # ENVIRONMENT
#    #
#    # Some needfull information
#    #
#    def on_request_object(self):
#        """
#        Some needfull objects from the request object.
#        """
#        # Is debug on? If you will display information only if debug is on, you
#        # should not use settings.DEBUG directly!
#        # Use request.debug, because it is true if settings.DEBUG if true *or*
#        # if the client IP is in settings.INTERNAL_IPS
#        # This is append to the request object in
#        # PyLucid.system.utils.setup_debug
#        if self.request.debug:
#            self.page_msg("Debug is on.")