docgenerator 2.1.1 → 3.0.0

data/meta_test_and_doc/manpages/images.rb

@@ -0,0 +1,152 @@
+#encoding utf-8
+=begin rdoc
+Generated manpages for elements.
+
+This document does not contain the implementation or code documentation.
+
+This document is the source for a manpage for usage of Docgenerator elements.
+
+The following Element are documented in this document:
+
+* Docgenerator::Elements::Img
+=end
+
+#
+module Docgenerator
+  module Elements
+=begin rdoc
+=Docgenerator::Elements::Img
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  src                 :  X         X         X         -         -         -         -         -        
+  alt                 :  -         X         -         -         -         -         -         -        
+  id                  :  -         X         -         -         -         -         -         -        
+  class               :  -         X         -         -         -         -         -         -        
+  style               :  -         X         -         -         -         -         -         -        
+  title               :  -         X         -         -         -         -         -         -        
+  align               :  -         X         -         -         -         -         -         -        
+  width               :  -         -         -         X         -         -         -         -        
+  height              :  -         -         -         X         -         -         -         -        
+  border              :  -         X         -         -         -         -         -         -        
+  longdesc            :  -         X         -         -         -         -         -         -        
+  usemap              :  -         X         -         -         -         -         -         -        
+  name                :  -         X         -         -         -         -         -         -        
+  angle               :  -         -         -         X         -         -         -         -        
+  texoption           :  -         -         X         -         -         -         -         -        
+
+
+Docgenerator::Elements::Img allows no content.
+
+==Generate an object
+  test = Docgenerator::Elements::Img.new( {
+        :src                 => <<value>>, % required, values: [String]
+       #:alt                 => <<value>>, % optional, values: [String]
+       #:id                  => <<value>>, % optional
+       #:class               => <<value>>, % optional
+       #:style               => <<value>>, % optional, values: [Docgenerator::CSS, String]
+       #:title               => <<value>>, % optional
+       #:align               => <<value>>, % optional, values: ["left", "center", "right", "justify", "char"]
+       #:width               => <<value>>, % optional, values: [Integer, String]
+       #:height              => <<value>>, % optional, values: [Integer, String]
+       #:border              => <<value>>, % optional, values: [Integer]
+       #:longdesc            => <<value>>, % optional, values: [String]
+       #:usemap              => <<value>>, % optional, values: [String]
+       #:name                => <<value>>, % optional, values: [String]
+       #:angle               => <<value>>, % optional, values: [Integer]
+       #:texoption           => <<value>>, % optional, values: [String]
+      })
+
+Alternative generation
+  test = element(:img, {...Attributes...})
+  test = element(:includegraphics, {...Attributes...})
+
+
+==Outputs
+===Docgenerator::Elements::Img#to_latex
+  \includegraphics[,]{Value for src}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Img#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\includegraphics[,]{Value for src}<<END>>
+
+* Result after Docgenerator::Elements::Img#cr:
+
+    <<START>>\includegraphics[,]{Value for src}
+    <<END>>
+
+* Result after Docgenerator::Elements::Img#cR:
+
+    <<START>>\includegraphics[,]{Value for src}
+    <<END>>
+
+* Result after Docgenerator::Elements::Img#Cr:
+
+    <<START>>
+    \includegraphics[,]{Value for src}
+    <<END>>
+
+* Result after Docgenerator::Elements::Img#CR:
+
+    <<START>>
+    \includegraphics[,]{Value for src}
+    <<END>>
+
+===Docgenerator::Elements::Img#to_html
+  <img src = "Value for src" />
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Img#.to_html
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><img src = "Value for src" /><<END>>
+
+* Result after Docgenerator::Elements::Img#cr:
+
+    <<START>><img src = "Value for src" />
+    <<END>>
+
+* Result after Docgenerator::Elements::Img#cR:
+
+    <<START>><img src = "Value for src" />
+    <<END>>
+
+* Result after Docgenerator::Elements::Img#Cr:
+
+    <<START>>
+    <img src = "Value for src" />
+    <<END>>
+
+* Result after Docgenerator::Elements::Img#CR:
+
+    <<START>>
+    <img src = "Value for src" />
+    <<END>>
+
+===Docgenerator::Elements::Img#to_context
+  \includegraphics{}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Elements::Img#to_text
+  
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Elements::Img#to_wiki
+  
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Elements::Img#to_creole
+  
+
+
+* No output routine defined for creole - use a dummy
+=end
+    class Img << Docgenerator::Element
+    #This coding is empty - this is the manpage definition, not the implementation
+    end #class Img
+  end #module Elements
+end #module Docgenerator

data/unittest/expected/test_document_toc_article.latex

@@ -37,28 +37,28 @@
 
 
 \endgroup 
-\section{Abschnitt 1}\hypertarget{toc1}{}
+\section{Abschnitt 1}\hypertarget{toc1}{}\label{toc1}
 
 
 Text zu Abschnitt 1
 
-\subsection{Abschnitt 1.1}\hypertarget{toc2}{}
+\subsection{Abschnitt 1.1}\hypertarget{toc2}{}\label{toc2}
 
 
 Text zu Abschnitt 1.1
 
-\subsection{Abschnitt 1.2}\hypertarget{toc3}{}
-\section{Abschnitt 2}\hypertarget{toc4}{}
+\subsection{Abschnitt 1.2}\hypertarget{toc3}{}\label{toc3}
+\section{Abschnitt 2}\hypertarget{toc4}{}\label{toc4}
 
 
 Text zu Abschnitt 2
 
-\subsection{Abschnitt 2.1}\hypertarget{toc5}{}
+\subsection{Abschnitt 2.1}\hypertarget{toc5}{}\label{toc5}
 
 
 Text zu Abschnitt 2.1
 
-\section{Abschnitt 3}\hypertarget{sect3}{}
+\section{Abschnitt 3}\hypertarget{sect3}{}\label{sect3}
 
 \end{document}
 % ----------------------------------------------------------------

data/unittest/expected_struktex/test_struktex_krug.creole

@@ -1,15 +1,15 @@
 <<<structogramm|Krug;120;45
-    WHILE	Krug nicht zerbrochen
+    WHILE  Krug nicht zerbrochen
         Krug geht zum Brunnen
     ENDWHILE
     Qualitaetspruefung
-		-> Krug			Testgut
-		<- res_1			Pruefergebnis
-    IF	Krug zerbrochen
+    -> Krug      Testgut
+    <- res_1      Pruefergebnis
+    IF  Krug zerbrochen
     THEN
         Schade
     ELSE
-		Stabiler Krug
+    Stabiler Krug
     ENDIF
 
 >>>

data/unittest/expected_struktex/test_struktex_krug.wiki

@@ -1,15 +1,15 @@
 >>>structogramm{Krug;120;45}
-    WHILE	Krug nicht zerbrochen
+    WHILE  Krug nicht zerbrochen
         Krug geht zum Brunnen
     ENDWHILE
     Qualitaetspruefung
-		-> Krug			Testgut
-		<- res_1			Pruefergebnis
-    IF	Krug zerbrochen
+    -> Krug      Testgut
+    <- res_1      Pruefergebnis
+    IF  Krug zerbrochen
     THEN
         Schade
     ELSE
-		Stabiler Krug
+    Stabiler Krug
     ENDIF
 
 <<<    

data/unittest/expected_struktex/test_struktex_statement.creole

@@ -1,7 +1,7 @@
 <<<structogramm|Simple Statements;120;30
-			Statement
-			=>	Call procedure
-			<>	Return value
-			<=	Exit with return value
+      Statement
+      =>  Call procedure
+      <>  Return value
+      <=  Exit with return value
 
 >>>

data/unittest/expected_struktex/test_struktex_statement.wiki

@@ -1,7 +1,7 @@
 >>>structogramm{Simple Statements;120;30}
-			Statement
-			=>	Call procedure
-			<>	Return value
-			<=	Exit with return value
+      Statement
+      =>  Call procedure
+      <>  Return value
+      <=  Exit with return value
 
 <<<    

data/unittest/expected_templates/test_report_utf8.tex

@@ -0,0 +1,34 @@
+<<prefix>>
+\documentclass[ngerman]{scrreprt}
+\usepackage{babel}
+%Encoding-package depends on TeX-engine
+\usepackage{ifpdf,ifxetex,ifluatex}
+\ifxetex
+  \usepackage{fontspec}	%Without, umlauts are missing
+\fi
+\ifluatex
+  \usepackage[utf8]{luainputenc} %Or in first line: % !Mode:: "TeX:UTF-8".
+\else
+  \ifpdf\relax
+    \usepackage[utf8]{inputenc}
+  \fi
+\fi
+\usepackage{hyperref}
+% ----------------------------------------------------------------
+
+\title{Test of Template report\_utf8}
+\hypersetup{pdftitle={Test of Template report\_utf8}}
+
+% ----------------------------------------------------------------
+\begin{document}
+
+
+Some text
+
+
+
+Umlaute: öäü ÖÄÜ ß
+
+
+\end{document}
+% ----------------------------------------------------------------

data/unittest/expected_templates/test_standalone.tex

@@ -13,7 +13,8 @@
     \usepackage[utf8]{inputenc}
   \fi
 \fi
-%\usepackage{hyperref}
+\usepackage{luatex85} %%Needed since TeXLive 2016
+\usepackage{hyperref}
 % ----------------------------------------------------------------
 
 \title{Test of Template standalone}

data/unittest/unittest_docgenerator.rb

@@ -1,11 +1,6 @@
 # encoding: utf-8
-gem 'more_unit_test'
-gem 'test-unit'
-
-#~ $:.unshift('C:/usr/Script/more_unit_test/lib')
-require 'more_unit_test/assert_equal_filecontent.rb'
-require 'test/unit'
-
+gem 'minitest-filecontent'
+require 'minitest/filecontent.rb'
 
 if $0 == __FILE__
   $:.unshift("../lib")
@@ -52,7 +47,7 @@ $log_array.outputters = $log_array_outputter = ArrayOutputter.new('xx')
 
 
 
-class Test_elements < Test::Unit::TestCase
+class Test_elements < MiniTest::Test
   def setup()
     #Avoid warnings about missing logger in to_doc
     @opt = { :log => DOCGENERATOR_DEFAULT_LOGGER } #unless defined? @opt
@@ -89,17 +84,17 @@ class Test_elements < Test::Unit::TestCase
   def test_is_a()
 
     newline = element(:br)
-    assert_true( newline.is_a?(Element) )
-    assert_true( newline.is_a?(:br) )
-    assert_true( newline.is_a?(:newline) )
+    assert( newline.is_a?(Element) )
+    assert( newline.is_a?(:br) )
+    assert( newline.is_a?(:newline) )
     
-    assert_false( newline.is_a?(:zeilenumbruch) )
-    assert_false( newline.is_a?(Symbol) )
-    assert_false( newline.is_a?(Array) )
+    refute( newline.is_a?(:zeilenumbruch) )
+    refute( newline.is_a?(Symbol) )
+    refute( newline.is_a?(Array) )
 
     #Standard behaviour: TypeError: class or module required
-    assert_false( newline.to_html(@opt).is_a?(:newline) )
-    assert_false( '<br />'.is_a?(:newline) )
+    refute( newline.to_html(@opt).is_a?(:newline) )
+    refute( '<br />'.is_a?(:newline) )
 
   end
   
@@ -193,7 +188,7 @@ class Test_elements < Test::Unit::TestCase
   
 end #Test_elements 
 
-class Test_lists < Test::Unit::TestCase
+class Test_lists < MiniTest::Test
   def setup()
     #Avoid warnings about missing logger in to_doc
     @opt = { :log => DOCGENERATOR_DEFAULT_LOGGER } #unless defined? @opt
@@ -238,7 +233,7 @@ class Test_lists < Test::Unit::TestCase
   end
 end #Test_lists 
 
-class Test_footnotes < Test::Unit::TestCase
+class Test_footnotes < MiniTest::Test
   def setup()
     #Avoid warnings about missing logger in to_doc
     @opt = { :log => DOCGENERATOR_DEFAULT_LOGGER } #unless defined? @opt
@@ -294,7 +289,7 @@ class Test_footnotes < Test::Unit::TestCase
   end #test_footnote
 end #Test_footnotes
 
-class Test_tabular < Test::Unit::TestCase
+class Test_tabular < MiniTest::Test
   def setup()
     #Avoid warnings about missing logger in to_doc
     @opt = { :log => DOCGENERATOR_DEFAULT_LOGGER } #unless defined? @opt
@@ -366,10 +361,18 @@ class Test_tabular < Test::Unit::TestCase
     #~ assert_equal_filecontent( "expected/test_tabular_doc.wiki", text.to_doc(:wiki,@opt))
     #~ assert_equal_filecontent( "expected/test_tabular_doc.text", text.to_doc(:text, @opt))
   end
+  def test_tabular_cell
+    cell = element(:column,{},'content')
+    assert_equal('content', cell.to_latex)
+
+    #Test to avoid problems, when the cell starts with a [] (After a \\ it would interpreted as a skip
+    cell = element(:column,{},'[x] content')
+    assert_equal('\relax [x] content', cell.to_latex)
+  end
 end
 
 
-class Test_Verbatim < Test::Unit::TestCase
+class Test_Verbatim < MiniTest::Test
    def setup()
     #Avoid warnings about missing logger in to_doc
     @opt = { :log => DOCGENERATOR_DEFAULT_LOGGER } #unless defined? @opt
@@ -404,7 +407,7 @@ verb
   end
 end #Test_Verbatim 
   
-class Test_CSS < Test::Unit::TestCase
+class Test_CSS < MiniTest::Test
   def setup()
     #Avoid warnings about missing logger in to_doc
     @opt = { :log => DOCGENERATOR_DEFAULT_LOGGER } #unless defined? @opt
@@ -474,7 +477,7 @@ end
 #Remark:
 #- The <<prefix>> is replaced by Document.save.
 #- With <<prefix>> we get always differences (timestamp)
-class Test_document < Test::Unit::TestCase
+class Test_document < MiniTest::Test
   def setup()
     #Avoid warnings about missing logger in to_doc
     @opt = { :log => DOCGENERATOR_DEFAULT_LOGGER } #unless defined? @opt
@@ -490,7 +493,7 @@ class Test_document < Test::Unit::TestCase
     doc.body << element(:p,{}, 'This is some content' )
     #~ doc.save('test_document.html')
     assert_instance_of( Log4r::Logger, doc.log)
-    assert_not_same( DOCGENERATOR_LOGGER, doc.log)
+    refute_same( DOCGENERATOR_LOGGER, doc.log)
     
     $log.warn('test_document: to_context')
     $log.warn('test_document: to_creole')
@@ -529,7 +532,7 @@ class Test_document < Test::Unit::TestCase
     doc.body << element(:p,{}, 'This is some content' )
     #~ doc.save('test_document.html')
     assert_instance_of( Log4r::Logger, doc.log)
-    assert_not_same( DOCGENERATOR_LOGGER, doc.log)
+    refute_same( DOCGENERATOR_LOGGER, doc.log)
     {
       :html => :html,
       :article => :latex,
@@ -551,8 +554,8 @@ class Test_document < Test::Unit::TestCase
                                             }))
     }
   end
-end #Test_document < Test::Unit::TestCase
-class Test_document_toc < Test::Unit::TestCase
+end #Test_document < MiniTest::Test
+class Test_document_toc < MiniTest::Test
   def setup()
     #Avoid warnings about missing logger in to_doc
     @opt = { :log => DOCGENERATOR_DEFAULT_LOGGER } #unless defined? @opt
@@ -700,7 +703,7 @@ class Test_document_toc < Test::Unit::TestCase
   
 end
 
-class Test_usepackage < Test::Unit::TestCase
+class Test_usepackage < MiniTest::Test
   def setup()
     #Avoid warnings about missing logger in to_doc
     @opt = { :log => DOCGENERATOR_DEFAULT_LOGGER } #unless defined? @opt
@@ -713,8 +716,8 @@ class Test_usepackage < Test::Unit::TestCase
   end
   #Known packages 'require' new ruby packages.
   def test_usepackage_pdfpages()
-
-    DOCGENERATOR_LOGGER.level = Log4r::FATAL
+    loglevel = Docgenerator::DOCGENERATOR_LOGGER.level #remember loglevel
+    DOCGENERATOR_LOGGER.level = Log4r::FATAL  #temporary loglevel change
     old_required = $".dup #Get old require list
     usepackage_element = element(:usepackage,{},'pdfpages')
     #Now a new require should be done
@@ -725,11 +728,15 @@ class Test_usepackage < Test::Unit::TestCase
 
     assert_equal( '\usepackage{pdfpages}',  usepackage_element.to_latex(@opt))
     assert_equal( '',  usepackage_element.to_html(@opt))
+    
+    Docgenerator::DOCGENERATOR_LOGGER.level = loglevel #revert loglevel again
+    #Without the level reset, the default level amy not be tested
+    #(check it with ARGV << '--seed' << '4910')
 
   end  #test_usepackage_pdfpages()
 end
 
-#~ class Test_Element < Test::Unit::TestCase
+#~ class Test_Element < MiniTest::Test
   #~ def test_add_output()
 #~ cmd = <<'cmd'
 #~ def to_html(options = {})