docgenerator 1.2.1 → 2.0.0

data/unittest/unittest_docgenerator_runtex.rb

@@ -6,27 +6,64 @@ if $0 == __FILE__
   $:.unshift("../lib")
 end
 require 'docgenerator'
+include Docgenerator
+
 require 'rake4latex'
 
-$log = Log4r::Logger.new('Unittest docgenerator', Log4r::ERROR )
+=begin rdoc
+Define a new outputter to catch data into an array
+=end
+class ArrayOutputter < Log4r::StdoutOutputter
+=begin rdoc
+Collect messages in array.
+=end
+  def write(message)
+    @messages ||= []  #create with first call
+    @messages  << message
+  end
+=begin rdoc
+Clear message array and return messages
+=end
+  def flush
+    @messages ||= []  #create with first call
+    messages = @messages.dup
+    @messages.clear
+    messages
+  end
+end #ArrayOutputter
 
 
 class Test_document_runtex < Test::Unit::TestCase
-  def test_document()
+  def clean_examples()
+    %w{test_runtex test_runtex_2}.each{|filename|
+      %w{tex pdf aux log out}.each{|ext|
+        File.delete(filename.ext(ext)) if File.exist?(filename.ext(ext))
+      }
+    }    
+  end #clean_examples()
+  def setup()    
+    clean_examples
+
+    @log = Log4r::Logger.new('Doc', Log4r::WARN )
+    @log.outputters = ArrayOutputter.new('log_xxx')
+
+  end
+  def teardown; clean_examples;   end
+  def test_runtex()
     doc = Document.new(
       :title => 'Testdokument',
       :keywords => 'Test',
       :description => 'This is a test for a Document, generated by docgenerator.rb',
       :author => 'docgenerator.rb',
-      :maketitle  => true
+      :maketitle  => true,
+      :log => @log
       )
     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)
     
-    filename = "test_runtex.tex"
-    #~ doc.runtex = true
+    filename = "#{__method__}.tex"
     
     assert_equal(false, File.exist?(filename))
     assert_equal(false, File.exist?(filename.ext('pdf')))
@@ -34,33 +71,29 @@ class Test_document_runtex < Test::Unit::TestCase
     assert_equal_filecontent( "expected/test_runtex.stdout", 
           catch_stdout(Proc.new{ doc.save(filename, :runtex => [:statistic]) } )
     )
+    assert_equal([" INFO Doc: Save changed	#{__method__}.tex\n"], @log.outputters.first.flush)
     
     assert_equal(true, File.exist?(filename))
     assert_equal(true, File.exist?(filename.ext('pdf')))
 
-    File.delete(filename)
-    File.delete(filename.ext('pdf'))
-    File.delete(filename.ext('aux'))
-    File.delete(filename.ext('log'))
-    File.delete(filename.ext('out'))
-
   end
 
   #test with doc.runtex = ...
-  def test_document_2()
+  def test_runtex_2()
     doc = Document.new(
       :title => 'Testdokument',
       :keywords => 'Test',
       :description => 'This is a test for a Document, generated by docgenerator.rb',
       :author => 'docgenerator.rb',
-      :maketitle  => true
+      :maketitle  => true,
+      :log => @log
       )
     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)
     
-    filename = "test_runtex_2.tex"
+    filename = "#{__method__}.tex"
     doc.runtex = [:statistic]
     
     assert_equal(false, File.exist?(filename))
@@ -69,15 +102,10 @@ class Test_document_runtex < Test::Unit::TestCase
     assert_equal_filecontent( "expected/test_runtex_2.stdout", 
           catch_stdout(Proc.new{ doc.save(filename) } )
     )
+    assert_equal([" INFO Doc: Save changed	#{__method__}.tex\n"], @log.outputters.first.flush)
     
     assert_equal(true, File.exist?(filename))
     assert_equal(true, File.exist?(filename.ext('pdf')))
 
-    File.delete(filename)
-    File.delete(filename.ext('pdf'))
-    File.delete(filename.ext('aux'))
-    File.delete(filename.ext('log'))
-    File.delete(filename.ext('out'))
-
   end
 end

data/unittest/unittest_packages_struktex.rb

@@ -0,0 +1,187 @@
+#
+#Tests for creole/plugins//struktex.rb
+#
+#Check after __END__ for missing tests.
+#
+
+if $0 == __FILE__
+  $:.unshift("../lib")
+end
+
+gem 'test-unit'
+require 'test/unit'
+require 'more_unit_test/assert_equal_filecontent.rb'
+
+require 'creole/creole2doc'
+require 'creole/plugins/struktex.rb'
+require 'wiki2doc/wiki2docgenerator'
+require 'wiki2doc/plugins/struktex.rb'
+
+
+#~ DOCGENERATOR_LOGGER.level = Log4r::DEBUG
+#Avoid warnings about missing logger in to_doc
+OPT = { :log => Docgenerator::DOCGENERATOR_DEFAULT_LOGGER }  unless defined? OPT
+
+#~ $log        = Log4r::Logger.new( 'test struktex', Log4r::WARN )
+#~ $log.outputters = Log4r::StdoutOutputter.new('test struktex')
+#~ $log.level = Log4r::INFO
+#~ $log.info("Remark: Known errors/problems and missing checks are logged.")
+#~ DOCGENERATOR_LOGGER.level = Log4r::DEBUG
+#~ DOCGENERATOR_LOGGER.level = Log4r::INFO
+#~ DOCGENERATOR_LOGGER.level = Log4r::WARN
+#~ DOCGENERATOR_LOGGER.level = Log4r::ERROR
+
+#~ include Log4r 
+
+class Test_struktex < Test::Unit::TestCase
+  
+  def test_struktex_krug()
+    struct = Docgenerator::Packages::Struktex::Structogramm.new('Krug', 120, 45, <<-cmd
+    WHILE	Krug nicht zerbrochen
+        Krug geht zum Brunnen
+    ENDWHILE
+    Qualitaetspruefung
+		-> Krug			Testgut
+		<- res_1			Pruefergebnis
+    IF	Krug zerbrochen
+    THEN
+        Schade
+    ELSE
+		Stabiler Krug
+    ENDIF
+      cmd
+    )
+    assert_equal_filecontent( "expected_struktex/#{__method__}.tex", struct.to_doc(:latex, OPT))
+    #~ $log.warn("No test krug.construct") if $log.warn?
+    assert_equal_filecontent( "expected_struktex/#{__method__}.wiki", struct.to_doc(:wiki, OPT))
+    #~ $log.warn("No test krug.construct") if $log.warn?
+    assert_equal_filecontent( "expected_struktex/#{__method__}.creole", struct.to_doc(:creole, OPT))
+  end  
+  
+  def test_struktex_statement()
+    struct = Docgenerator::Packages::Struktex::Structogramm.new('Simple Statements', 120, 30, <<-cmd
+			Statement
+			=>	Call procedure
+			<>	Return value
+			<=	Exit with return value
+      cmd
+    )
+    assert_equal_filecontent( "expected_struktex/#{__method__}.tex", struct.to_doc(:latex, OPT))
+    
+    #~ puts struct.to_latex[-10..-1].inspect
+    #~ puts struct.to_doc(:latex)[-10..-1].inspect
+    #~ assert_equal( struct.to_latex, struct.to_doc(:latex))
+    assert_equal_filecontent( "expected_struktex/#{__method__}.wiki", struct.to_doc(:wiki, OPT))
+    assert_equal_filecontent( "expected_struktex/#{__method__}.creole", struct.to_doc(:creole, OPT))
+  end
+end #Test_struktex
+
+
+class Test_struktex_creole < Test::Unit::TestCase
+  def test_struktex_collector()
+    assert_equal( Docgenerator::Creole::Creole_structogramm, Docgenerator::Creole::Placeholders['structogramm'])
+    assert_equal( Docgenerator::Creole::Creole_structogramm, Docgenerator::Creole::Placeholders::Collection['structogramm'])
+    #~ assert_kind_of( Placeholder, Creole::Placeholders['structogramm'])
+  end
+end #Test_struktex
+
+
+
+def newtest(name, withclass = false)
+  code = []
+  code << "class Test_struktex < Test::Unit::TestCase" if withclass
+  code << <<-code
+  def test_struktex_#{name}()
+    struct = ''
+    assert_equal_filecontent( "expected_struktex/struktex_#{name}.tex", struct.to_doc(:latex))
+    #~ $log.warn("No test #{name}.construct") if $log.warn?
+    assert_equal_filecontent( "expected_struktex/struktex_#{name}.wiki", struct.to_doc(:wiki))
+    #~ $log.warn("No test #{name}.construct") if $log.warn?
+    assert_equal_filecontent( "expected_struktex/struktex_#{name}.creole", struct.to_doc(:creole))
+  end
+  code
+  code << "end #Test_struktex" if withclass
+  puts code.join("\n")
+end
+
+#~ newtest( 'krug')
+
+__END__
+
+===Declarations===
+With declarations you can define interfaces of sub-routines.
+This declarations are part of the command
+>>>structogramm{Declarations/Interfaces;120;25}
+			Statement
+			->	field1	description
+			<-	field2	description
+			<->	field3	description
+<<<
+
+===IF-Statement===
+		IF Condition
+		THEN	size	text
+		ELSE		size	text
+		ENDIF
+>>>structogramm{Test f�r IF;120;40}
+			IF Bedingung?
+			THEN 6	Ja
+				IF Andere Frage?
+				THEN 
+					<= Ergebnis
+				ELSE
+					<= Anderes Ergebnis
+				ENDIF
+			ELSE	6	Nein
+				IF Andere Frage?
+				THEN 4
+					<= Ergebnis
+				ELSE	5
+					<= Anderes Ergebnis
+				ENDIF
+			ENDIF
+<<<
+
+===CASE-statements===
+The first number after CASE defines the degree of the case-line.
+
+The WHEN clause has an optional parameter:
+*c	centered
+*r right-aligned
+>>>structogramm{CASE Statements;120;40}
+			CASE	5	variable
+			WHEN	value1
+				Statement 1-1
+				Statement 1-2
+			WHEN[r]	value2
+				Statement 2-1
+				Statement 2-2
+			WHEN[c]	value3
+				Statement 3-1
+				Statement 3-2
+			WHEN	value4
+				Statement 4-1
+				Statement 4-2
+			ENDCASE
+<<<
+===While-statements===
+>>>structogramm{While Statements;120;15}
+			WHILE Condition
+				Statement
+			ENDWHILE
+<<<
+
+===Repeat-Until-statements===
+>>>structogramm{Repeat-Until Statements;120;15}
+			REPEAT 
+				Statement
+			UNTIL	Condition
+<<<
+
+===FOREVER-Loop-statements===
+>>>structogramm{FOREVER-Loop Statements;120;30}
+			FOREVER
+				Statement
+				<= Exit
+			ENDFOREVER
+<<<

data/unittest/unittest_rubycode4doc.rb

@@ -0,0 +1,275 @@
+#~ require '../test_docgenerator.rb'
+require 'test/unit'
+require 'more_unit_test/assert_equal_filecontent.rb'
+
+if $0 == __FILE__
+  $:.unshift("../lib")
+end
+
+require 'docgenerator/packages/rubycode4doc'
+require 'creole/plugins/rubycode4creole'
+require 'wiki2doc/plugins/rubycode4wiki'
+
+#~ DOCGENERATOR_LOGGER.level = Log4r::DEBUG
+#Avoid warnings about missing logger in to_doc
+OPT = { :log => Docgenerator::DOCGENERATOR_DEFAULT_LOGGER }  unless defined? OPT
+
+#
+#
+#
+class Test_rubycode4doc < Test::Unit::TestCase
+def test_codetest()
+  testcode_sourcecode = <<-CODE
+  a = 5
+  b = a * 5
+  puts b
+  puts b + 3
+  CODE
+
+  testcode_evaluated = <<-CODE
+  a = 5         # -> 5         
+  b = a * 5     # -> 25        
+  puts b        # => "25\\n"    
+  puts b + 3    # => "28\\n"    
+  CODE
+  testcode_output = <<-CODE
+
+
+25
+28
+  CODE
+
+  codetest = Docgenerator::Rubycode::CodeTest.new('codetest', testcode_sourcecode )
+  
+  assert_equal(testcode_sourcecode.chomp, codetest.sourcecode)
+  assert_equal(testcode_evaluated.chomp, codetest.code_evaluation)
+  assert_equal(testcode_output.chomp, codetest.output)
+  
+  #Extend the code
+  codetest << <<-TEST
+  3.times{|i| 
+    puts i
+  }
+  TEST
+  testcode_sourcecode << <<-CODE
+  3.times{|i| 
+    puts i
+  }
+  CODE
+  testcode_evaluated << <<-CODE
+  3.times{|i| 
+    puts i
+  } # -> 3         => "0\\n1\\n2\\n"
+  CODE
+  testcode_output << <<-CODE
+0
+1
+2
+  CODE
+
+  assert_equal(testcode_sourcecode.chomp, codetest.sourcecode)
+  #15 was defined in original settings
+  assert_equal(testcode_evaluated.chomp, codetest.code_evaluation(15))
+  assert_equal(testcode_output.chomp, codetest.output)
+  
+  assert_instance_of(Docgenerator::Tables::Tabular, codetest.code_in_tab)
+  assert_instance_of(Docgenerator::Listings::Lstlisting, codetest.code_evaluation_lstlisting)
+  
+end #test_codetest()
+end
+
+
+class Test_rubycode4doc_wiki < Test::Unit::TestCase
+  def test_wikitest()
+    
+  Docgenerator::Rubycode::CodeTest.new('codetest_wiki', <<-CODE
+  a = 5
+  b = a * 5
+  puts b
+  puts b + 3
+  CODE
+)
+    
+    wiki_1 = Docgenerator::Wikimedia::Rubywiki.new( :content => <<wiki
+===Originalcoding===
+{{rubycode|codetest_wiki}}
+wiki
+  )
+    wiki_2 = Docgenerator::Wikimedia::Rubywiki.new( :content => <<wiki
+===Executed Coding===
+{{rubycode_with_evaluation|codetest_wiki}}
+wiki
+  )
+    wiki_3 = Docgenerator::Wikimedia::Rubywiki.new( :content => <<wiki
+===Executed Coding in einer Tabelle===
+{{rubycode_in_tab|codetest_wiki}}
+wiki
+  )
+
+    assert_equal_filecontent( "expected_rubycode4doc/wiki_1.html", wiki_1.to_html(OPT) )
+    assert_equal_filecontent( "expected_rubycode4doc/wiki_2.html", wiki_2.to_html(OPT) )
+    assert_equal_filecontent( "expected_rubycode4doc/wiki_3.html", wiki_3.to_html(OPT) )
+  end #test_wikitest()
+
+
+  def test_wikitest_immediate()
+    #Code definieren (Kein output)
+    #Code wird unter dem Namen code_in_wiki abgelegt.
+    wiki = Docgenerator::Wikimedia::Rubywiki.new( :content => <<wiki
+>>>rubycode{code_in_wiki}
+1.upto(3){|i| puts i }
+<<<
+wiki
+  )
+    #Verwenden von code_in_wiki
+    wiki_1 = Docgenerator::Wikimedia::Rubywiki.new( :content => <<wiki
+===Originalcoding===
+{{rubycode|code_in_wiki}}
+wiki
+  )
+    wiki_2 = Docgenerator::Wikimedia::Rubywiki.new( :content => <<wiki
+===Executed Coding===
+{{rubycode_with_evaluation|code_in_wiki}}
+wiki
+  )
+    wiki_3 = Docgenerator::Wikimedia::Rubywiki.new( :content => <<wiki
+===Executed Coding in a tabular===
+{{rubycode_in_tab|code_in_wiki}}
+wiki
+  )
+
+  assert_equal('', wiki.to_html(OPT))
+  assert_equal_filecontent( "expected_rubycode4doc/wiki_immediate_1.html", wiki_1.to_html(OPT))
+  assert_equal_filecontent( "expected_rubycode4doc/wiki_immediate_2.html", wiki_2.to_html(OPT))
+  assert_equal_filecontent( "expected_rubycode4doc/wiki_immediate_3.html", wiki_3.to_html(OPT))
+  
+    wiki_full = Docgenerator::Wikimedia::Rubywiki.new( :content => <<wiki
+==Code definition==
+(Nothing to see)
+>>>rubycode{code_in_wiki_full}
+1.upto(3){|i| puts i * 2 }
+<<<
+
+==Code with evaluation==
+{{rubycode|code_in_wiki_full}}
+
+==Code with evaluation==
+{{rubycode_with_evaluation|code_in_wiki_full}}
+
+==Code with evaluation==
+{{rubycode_in_tab|code_in_wiki_full}}
+wiki
+  )
+  assert_equal_filecontent( "expected_rubycode4doc/wiki_immediate_full.html", wiki_full.to_html(OPT))
+  
+end #test_wikitest_immediate()
+
+end #class Test_rubycode4doc_wiki
+
+
+class Test_rubycode4doc_creole  < Test::Unit::TestCase
+  #This is integrated in Creole
+  def test_creole_inline_ruby()
+    wiki = Docgenerator::Creole::Creole.new()
+    wiki << <<wiki
+*1 + 1 = <<ruby|1+1>>
+*1 + 1 = <<ruby_raw|1+1>>
+wiki
+    assert_equal_filecontent( "expected_rubycode4doc/creole_inline_ruby.html", wiki.to_html(OPT))
+  end
+  #
+  #
+  def test_creole_rubycode()
+    wiki = Docgenerator::Creole::Creole.new()
+    wiki << <<wiki
+<<<rubycode
+1 + 1
+>>>
+wiki
+    assert_equal_filecontent( "expected_rubycode4doc/creole_rubycode.html", wiki.to_html(OPT))
+    assert_equal_filecontent( "expected_rubycode4doc/creole_rubycode.tex", wiki.to_latex(OPT))
+  end
+
+  def test_creole_rubycode_output()
+    wiki = Docgenerator::Creole::Creole.new()
+    wiki << <<wiki
+<<<rubycode_output
+1 + 1
+puts 1 + 2
+>>>
+wiki
+    assert_equal_filecontent( "expected_rubycode4doc/creole_output.html", wiki.to_html(OPT))
+    assert_equal_filecontent( "expected_rubycode4doc/creole_output.tex", wiki.to_latex(OPT))
+  end
+
+  def test_creole_rubycode_evaluated()
+    wiki = Docgenerator::Creole::Creole.new()
+    wiki << <<wiki
+<<<rubycode_evaluated
+1 + 1
+>>>
+wiki
+    assert_equal_filecontent( "expected_rubycode4doc/creole_rubycode_evaluated.html", wiki.to_html(OPT))
+    assert_equal_filecontent( "expected_rubycode4doc/creole_rubycode_evaluated.tex", wiki.to_latex(OPT))
+  end
+
+  def test_creole_rubycode_evaluated_listings()
+    wiki = Docgenerator::Creole::Creole.new()
+    wiki << <<wiki
+<<<rubycode_evaluated_listings
+1 + 1
+>>>
+wiki
+    assert_equal_filecontent( "expected_rubycode4doc/creole_rubycode_evaluated_listings.html", wiki.to_html(OPT))
+    assert_equal_filecontent( "expected_rubycode4doc/creole_rubycode_evaluated_listings.tex", wiki.to_latex(OPT))
+  end
+
+
+
+  def test_creole_rubycode_in_tab()
+    wiki = Docgenerator::Creole::Creole.new()
+    wiki << <<wiki
+<<<rubycode_in_tab
+1 + 1
+>>>
+wiki
+    assert_equal_filecontent( "expected_rubycode4doc/creole_in_tab.html", wiki.to_html(OPT))
+    assert_equal_filecontent( "expected_rubycode4doc/creole_in_tab.tex", wiki.to_latex(OPT))
+  end
+
+
+  #
+  def test_creole_rubycode_complete()
+    wiki = Docgenerator::Creole::Creole.new()
+    wiki << <<wiki
+rubycode
+<<<rubycode
+1 + 1
+>>>
+----
+rubycode_output
+<<<rubycode_output
+puts 1 + 1
+>>>
+----
+rubycode_evaluated
+<<<rubycode_evaluated
+1 + 1
+>>>
+----
+rubycode_in_tab
+<<<rubycode_in_tab
+1 + 1
+>>>
+----
+<<<rubycode_evaluated_listings
+1 + 1
+>>>
+wiki
+    assert_equal_filecontent( "expected_rubycode4doc/creole_complete.html", wiki.to_html(OPT))
+    assert_equal_filecontent( "expected_rubycode4doc/creole_complete.tex", wiki.to_latex(OPT))
+  end
+
+end #class Test_rubycode4doc_creole
+
+__END__