florath/rmtoo

'''
 rmtoo
   Free and Open Source Requirements Management Tool

  Txt Record Entry Class
   This class hold additionally the original raw representation of
   each record entry.

 (c) 2011-2011,2017 by flonatel GmbH & Co. KG

 For licensing details see COPYING
'''
from rmtoo.lib.Encoding import Encoding
from rmtoo.lib.storagebackend.txtfile.TxtParser import TxtParser
from rmtoo.lib.storagebackend.RecordEntry import RecordEntry
from rmtoo.lib.StringHelper import join_ate


class TxtRecordEntry(RecordEntry):
    """Holds the raw entry.

    This is needed if a file must be written: it should be as similar
    as possible.
    """
    def __init__(self, se):
        '''There must be three entries:
           1) initial line with tag
           2) possible empty list of continue lines (starting with space)
           3) possible empty list of comment and / or empty lines.
        '''
        assert len(se) == 3
        Encoding.check_unicode(se[0])
        self.tag_raw = se[0]
        Encoding.check_unicode_list(se[1])
        self.content_raw = se[1]
        Encoding.check_unicode_list(se[2])
        self.comment_raw = se[2]
        # Parse the rest
        tag = self.tag_raw[0:-1]
        value = "".join(se[1])
        comment = TxtParser.extract_comment(se[2])
        RecordEntry.__init__(self, tag, value, comment)

    def to_string(self):
        """Return the entry as a string"""
        add_content = TxtParser.add_newlines(self.content_raw)
        add_comment = TxtParser.add_newlines(self.comment_raw)
        return self.tag_raw + add_content + add_comment

    def __str__(self):
        return self.to_string()

    @staticmethod
    def format_entry(line):
        '''For 'Normal' RecordEntries there is the need to convert them
        into Txt ones.
        '''
        # This is a minimalistic implementation - which works.
        # Maybe add text wrapping needs to be added?
        comment = ""
        if line.get_comment() is not None:
            comment = "# " + line.get_comment()

        return line.get_tag() + ": " + line.get_content() + "\n" + comment

    def write_fd(self, out_file):
        '''Write record entry to filesystem.'''
        if self.content_raw is not None:
            out_file.write(self.tag_raw)
            out_file.write(join_ate(u"\n", self.content_raw))
        else:
            out_file.write(self.get_tag())
            out_file.write(": ")
            out_file.write(self.get_content())
            out_file.write("\n")

        if self.comment_raw is not None:
            out_file.write(join_ate(u"\n", self.comment_raw))
        else:
            out_file.write("# ")
            out_file.write(self.get_comment())
            out_file.write("\n")

    def set_content(self, content):
        '''There is the need to clean up the raw stored content.'''
        RecordEntry.set_content(self, content)
        self.content_raw = None

    def set_comment(self, comment):
        ''' Set the comment.'''
        RecordEntry.set_comment(self, comment)
        self.comment_raw = None

    def get_content_with_nl(self):
        """Return the raw content"""
        return self.content_raw