''' rmtoo Free and Open Source Requirements Management Tool LaTeX output class version 2. (c) 2010-2012 by flonatel GmbH & Co. KG For licensing details see COPYING ''' from rmtoo.lib.Requirement import Requirement from rmtoo.lib.Constraints import Constraints from rmtoo.lib.TestCases import TestCases from rmtoo.lib.RMTException import RMTException from rmtoo.lib.StdOutputParams import StdOutputParams from rmtoo.lib.ExecutorTopicContinuum import ExecutorTopicContinuum from rmtoo.lib.logging import tracer from rmtoo.lib.CreateMakeDependencies import CreateMakeDependencies class latex2(StdOutputParams, ExecutorTopicContinuum, CreateMakeDependencies): default_config = { "req_attributes": ["Id", "Priority", "Owner", "Invented on", "Invented by", "Status", "Class"] } level_names = [ "chapter", "section", "subsection", "subsubsection", "paragraph", "subparagraph" ] def __init__(self, oconfig): '''Create a graph output object.''' tracer.info("Called.") StdOutputParams.__init__(self, oconfig) CreateMakeDependencies.__init__(self) self.__ce3set = None self.__fd = None if not self._config.is_available('req_attributes'): self._config.set_value('req_attributes', ["Id", "Priority", "Owner", "Invented on", "Invented by", "Status", "Class"]) self.__level = -1 @staticmethod def __strescape(string): '''Escapes a string: hexifies it.''' result = "" for fchar in string: if ord(fchar) >= 32 and ord(fchar) < 127: result += fchar else: result += "%02x" % ord(fchar) return result def topic_set_pre(self, _topics_set): '''Prepare the output file.''' self.__fd = file(self._output_filename, "w") def __output_latex_one_constraint(self, cname, cnstrt): '''Output one constraint.''' cname = latex2.__strescape(cname) tracer.debug("Output constraint [%s]." % cname) self.__fd.write("%% CONSTRAINT '%s'\n" % cname) self.__fd.write("\%s{%s}\label{CONSTRAINT%s}\n" "\\textbf{Description:} %s\n" % (self.level_names[1], cnstrt.get_value("Name").get_content(), cname, cnstrt.get_value("Description").get_content())) if cnstrt.is_val_av_and_not_null("Rationale"): self.__fd.write("\n\\textbf{Rationale:} %s\n" % cnstrt.get_value("Rationale").get_content()) if cnstrt.is_val_av_and_not_null("Note"): self.__fd.write("\n\\textbf{Note:} %s\n" % cnstrt.get_value("Note").get_content()) tracer.debug("Finished.") def __output_latex_constraints(self, constraints): '''Write out all constraints for the topic set.''' if len(constraints) == 0: tracer.debug("No constraints to output.") return self.__fd.write("\\%s{Constraints}\n" % self.level_names[0]) for cname, cnstrt in sorted(constraints.iteritems()): self.__output_latex_one_constraint(cname, cnstrt) # TODO: Code duplication from constraints def __output_latex_one_testcase(self, cname, cnstrt): '''Output one testcase.''' cname = latex2.__strescape(cname) tracer.debug("Output testcase [%s]." % cname) self.__fd.write("%% TEST-CASE '%s'\n" % cname) self.__fd.write("\%s{%s}\label{TESTCASE%s}\n" "\\textbf{Description:} %s\n" % (self.level_names[1], cnstrt.get_value("Name").get_content(), cname, cnstrt.get_value("Description").get_content())) if cnstrt.is_val_av_and_not_null("Expected Result"): self.__fd.write("\n\\textbf{Expected Result:} %s\n" % cnstrt.get_value("Expected Result").get_content()) if cnstrt.is_val_av_and_not_null("Rationale"): self.__fd.write("\n\\textbf{Rationale:} %s\n" % cnstrt.get_value("Rationale").get_content()) if cnstrt.is_val_av_and_not_null("Note"): self.__fd.write("\n\\textbf{Note:} %s\n" % cnstrt.get_value("Note").get_content()) tracer.debug("Finished.") def __output_latex_testcases(self, testcases): '''Write out all testcases for the topic set.''' if len(testcases) == 0: tracer.debug("No testcases to output.") return self.__fd.write("\\%s{Test Cases}\n" % self.level_names[0]) for cname, cnstrt in sorted(testcases.iteritems()): self.__output_latex_one_testcase(cname, cnstrt) def topic_set_post(self, topic_set): '''Print out the constraints and clean up file.''' tracer.debug("Called; output constraints.") if topic_set == None: assert False constraints = Constraints.collect(topic_set) self.__output_latex_constraints(constraints) testcases = TestCases.collect(topic_set) self.__output_latex_testcases(testcases) tracer.debug("Clean up file.") self.__fd.close() tracer.debug("Finished.") def topic_pre(self, topic): '''Output one topic.''' self.__level += 1 self.__fd.write("%% Output topic '%s'\n" % topic.name) def topic_post(self, _topic): '''Cleanup things for topic.''' self.__level -= 1 def topic_name(self, name): '''Output the topic name.''' self.__fd.write("\\%s{%s}\n" % (self.level_names[self.__level], name)) def topic_text(self, text): '''Write out the given text.''' self.__fd.write("%s\n" % text) def requirement_set_pre(self, rset): '''Prepare the requirements set output.''' self.__ce3set = rset.get_ce3set() self.__testcases = rset.get_testcases() def requirement_set_sort(self, list_to_sort): '''Sort by id.''' return sorted(list_to_sort, key=lambda r: r.id) def requirement(self, req): '''Write out one requirement.''' self.__fd.write("%% REQ '%s'\n" % req.id) self.__fd.write("\%s{%s}\label{%s}\n\\textbf{Description:} %s\n" % (self.level_names[self.__level + 1], req.get_value("Name").get_content(), latex2.__strescape(req.id), req.get_value("Description").get_content())) if req.is_val_av_and_not_null("Rationale"): self.__fd.write("\n\\textbf{Rationale:} %s\n" % req.get_value("Rationale").get_content()) if req.is_val_av_and_not_null("Note"): self.__fd.write("\n\\textbf{Note:} %s\n" % req.get_value("Note").get_content()) # Only output the depends on when there are fields for output. if len(req.incoming) > 0: # Create links to the corresponding labels. self.__fd.write("\n\\textbf{Depends on:} ") self.__fd.write(", ".join(["\\ref{%s} \\nameref{%s}" % (latex2.__strescape(d.id), latex2.__strescape(d.id)) for d in sorted(req.incoming, key=lambda r: r.id)])) self.__fd.write("\n") if len(req.outgoing) > 0: # Create links to the corresponding dependency nodes. self.__fd.write("\n\\textbf{Solved by:} ") # No comma at the end. self.__fd.write(", ".join(["\\ref{%s} \\nameref{%s}" % (latex2.__strescape(d.id), latex2.__strescape(d.id)) for d in sorted(req.outgoing, key=lambda r: r.id)])) self.__fd.write("\n") if self.__ce3set != None: cnstrt = self.__ce3set.get(req.get_id()) if cnstrt != None and cnstrt.len() > 0: self.__fd.write("\n\\textbf{Constraints:} ") cstrs = [] for key, val in sorted(cnstrt.get_values().iteritems()): refid = latex2.__strescape(key) refctr = "\\ref{CONSTRAINT%s} \\nameref{CONSTRAINT%s}" \ % (refid, refid) description = val.description() if description != None: refctr += " [" + description + "] " cstrs.append(refctr) self.__fd.write(", ".join(cstrs)) self.__fd.write("\n") testcases = req.get_value_default("Test Cases") if testcases != None: self.__fd.write("\n\\textbf{Test Cases:} ") tcout = [] for testcase in testcases: refid = latex2.__strescape(testcase) refctr = "\\ref{TESTCASE%s} \\nameref{TESTCASE%s}" \ % (refid, refid) tcout.append(refctr) self.__fd.write(", ".join(tcout)) self.__fd.write("\n") status = req.get_value("Status").get_output_string() # HACK: Remove annoying parenthesis status=status.split('(')[0] clstr = req.get_value("Class").get_output_string() rtype = Requirement.get_type_as_str(req.get_value("Type")) self.__fd.write("\n\\textbf{Status:} %s" % status) # self.__fd.write("\n\\par\n{\small \\begin{center}" # "\\begin{tabular}{rlrlrl}\n") # # Put mostly three things in a line. # i = 0 # if 0: # for rattr in self._config.get_value("req_attributes"): # if rattr == "Id": # self.__fd.write("\\textbf{Id:} & %s " % req.id) # elif rattr == "Priority": # self.__fd.write("\\textbf{Priority:} & %4.2f " # % (req.get_value("Priority") * 10)) # elif rattr == "Owner": # self.__fd.write("\\textbf{Owner:} & %s" % # req.get_value("Owner")) # elif rattr == "Invented on": # self.__fd.write("\\textbf{Invented on:} & %s " # % req.get_value("Invented on").strftime("%Y-%m-%d")) # elif rattr == "Invented by": # self.__fd.write("\\textbf{Invented by:} & %s " # % req.get_value("Invented by")) # elif rattr == "Status": # self.__fd.write("\\textbf{Status:} & %s " % status) # elif rattr == "Class": # self.__fd.write("\\textbf{Class:} & %s " % clstr) # elif rattr == "Type": # self.__fd.write("\\textbf{Type:} & %s " % rtype) # else: # # This only happens when a wrong configuration is supllied. # raise RMTException(85, "Wrong latex2 output configuration " # "supplied: unknown tag [%s]" % rattr) # i += 1 # if i == 3: # i = 0 # self.__fd.write("\\\ \n") # else: # self.__fd.write(" & ") # while i < 2: # self.__fd.write("& & ") # i += 1 # self.__fd.write("\end{tabular}\end{center} }\n\n") def cmad_topic_continuum_pre(self, _): '''Write out the one and only dependency to all the requirements.''' tracer.debug("Called.") CreateMakeDependencies.write_reqs_dep(self._cmad_file, self._output_filename) self._cmad_file.write("REQS_LATEX2=%s\n" % self._output_filename)