# Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved.

# This component and the accompanying materials are made available under the terms of the License 

# "Eclipse Public License v1.0" which accompanies this distribution, 

# and is available at the URL "http://www.eclipse.org/legal/epl-v10.html".

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

# System Documentation Tools

# Description:

#

import os.path

import sys

import unittest

import xml

import stat

from cStringIO import StringIO

from xml.etree import ElementTree as etree

__version__ = '0.1'

UNSAFE_CHARS = ("\n", "\t", ":", "?", ",", "=", ".", "\\", "/", "[", "]", "|", "<", ">", "+", ";", '"', "-")

class FileRenamer(object):

    """

    Given an xml file this class returns a MODE compatable filename

    >>> fr = FileRenamer(xmlparser=StubXmlParser())

    >>> fr.rename(r"c:\\temp\\xml\\class_c_active_scheduler.xml")

    'class_c_active_scheduler=GUID-BED8A733-2ED7-31AD-A911-C1F4707C67F=1=en=.reference'

    """

        self.parser = xmlparser

    def _escape(self, filename):

        for char in UNSAFE_CHARS:

            filename = filename.replace(char, "")            

        filename = filename.encode('unicode-escape', 'ignore')

        filename = filename.replace(" ", "-")

        return filename        

    def rename(self, xmlfile):

        """

        Return DITA MODE compliant filename.

        Format of resultant filenames is:

            title=identifier=version=language=resolution.extension    

        Examples:

            Test-Document=GUID-1234=1=en=.reference

        """

        id = self.parser.parse(xmlfile)

        filename = os.path.basename(xmlfile)

        filename, ext = os.path.splitext(filename)

        return newfilename + ext

    for filepath in scan(indir):

        newfilename = os.path.join(os.path.dirname(filepath), fr.rename(filepath))

if __name__ == '__main__':

######################################

# Test code

######################################

class TestFileRenamer(unittest.TestCase):

        newfile = fr.rename("hello.xml")

        self.assertTrue(newfile == "hello=GUID-BED8A733-2ED7-31AD-A911-C1F4707C67F=1=en=.reference")

        fr = FileRenamer(xmlparser=StubXmlParser())

        newfile = fr.rename("hello.ditamap")

        self.assertTrue(newfile == "hello=GUID-BED8A733-2ED7-31AD-A911-C1F4707C67F=1=en=.ditamap")

    def test_i_can_return_a_files_new_name_if_passed_an_absolute_path(self):

        fr = FileRenamer(xmlparser=StubXmlParser())

        newfile = fr.rename("c:\\temp\\xml\\hello.xml")

        self.assertTrue(newfile == "hello=GUID-BED8A733-2ED7-31AD-A911-C1F4707C67F=1=en=.reference")

    def test_i_can_remove_incompatable_characters_from_a_filename(self):

        fr = FileRenamer(xmlparser=StubXmlParser())

        newfile = fr.rename("hello:?,=..xml")