docgenerator-creole 3.0.0

data/unittest/unittest_creole_placeholders.rb

@@ -0,0 +1,161 @@
+if $0 == __FILE__
+  $:.unshift("../lib")
+  $:.unshift('../../docgenerator/lib')
+end
+
+gem 'minitest-filecontent'
+require 'minitest/filecontent.rb'
+
+require 'docgenerator-creole.rb'
+require 'docgenerator/creole/plugins/rail.rb'
+require 'docgenerator/creole/plugins/struktex.rb'
+require 'docgenerator/creole/plugins/todonotes.rb'
+require 'docgenerator/creole/plugins/rubycode4creole.rb'
+
+#~ DOCGENERATOR_LOGGER.level = Log4r::DEBUG
+#~ DOCGENERATOR_DEFAULT_LOGGER.level = Log4r::WARN
+#~ Docgenerator.trace_on
+
+
+#Avoid warnings about missing logger in to_doc
+OPT = { :log => Docgenerator::DOCGENERATOR_DEFAULT_LOGGER }  unless defined? OPT
+
+require 'log4r'
+#Warn -> report missing important test
+#Info -> report missing test
+$log = Log4r::Logger.new('Unittest creole', Log4r::ERROR)
+#~ $log = Log4r::Logger.new('Unittest creole', Log4r::WARN)
+#~ $log = Log4r::Logger.new('Unittest creole', Log4r::INFO)
+$log.outputters = Log4r::StdoutOutputter.new('log_stdout')
+
+#Logger to catch unwanted messages
+$tmplog = Log4r::Logger.new('Creole', Log4r::FATAL)
+
+<<missingtests
+erweitern:
+*todonotes
+
+placeholder mit parameter (siehe creole_rail)
+
+Bug:
+http://... am Ende ohne folgenden Text wird falsch erkannt.
+--> test_creole_links_implicit_end()
+missingtests
+
+class Test_creole_placeholder_interface < MiniTest::Test
+  def test_creole_placeholders()
+    creole = Docgenerator::Creole::Creole.new(:content => <<creole
+==Titel 1==
+Text
+creole
+    )
+    assert_equal( Docgenerator::Creole::Placeholders::Collection, creole.placeholders)
+    assert_equal( Docgenerator::Creole::Placeholders::Dummy, Docgenerator::Creole::Placeholders::Collection[:undefined])
+    assert_equal( Docgenerator::Creole::Placeholders::Creole_html, Docgenerator::Creole::Placeholders::Collection['html'])
+    #~ assert_instance_of( Dummy_placeholder, Creole::Placeholders[:undefined])
+  end #test_creole_placeholders
+
+=begin 
+Define test for each placeholder.
+=end
+  Docgenerator::Creole::Placeholders::Collection.each{|key,placeholder_class|
+    code = <<-xx
+      def test_#{placeholder_class.to_s.gsub(/::/, '_')}()
+        do_interfacetest('#{key}', #{placeholder_class})
+      end
+      xx
+    class_eval(code)
+  }
+=begin rdoc
+Test, if the interface for a placeholder follows the main definition.
+
+=end
+  def do_interfacetest(key,placeholder_class)
+      assert_equal( placeholder_class, Docgenerator::Creole::Placeholders[key])
+      assert_equal( placeholder_class, Docgenerator::Creole::Placeholders::Collection[key])
+      assert_equal( placeholder_class, Docgenerator::Creole::Creole.new.placeholders[key])
+
+      creation_successful= false
+      #Check with no parameter
+      begin
+        placeholder = placeholder_class.new( Docgenerator::Creole::Creole.new ) 
+      rescue Docgenerator::Creole::Placeholder::ParameterError
+        #Docgenerator::Creole_placeholder::ParameterError is an accepted error
+        #Happens if this placeholder needs a parameter.
+      else
+        creation_successful= true
+        #Check inheritance.
+        assert_kind_of( Docgenerator::Creole::Placeholder, placeholder)
+      end
+      
+      parameter = case key
+        when "structogramm"; 'Title;120;45' #
+        else;          'dummy'
+      end
+        
+      #Check with 1 parameter
+      begin
+        placeholder = placeholder_class.new( Docgenerator::Creole::Creole.new, parameter )
+      rescue Docgenerator::Creole::Placeholder::ParameterError
+        #Docgenerator::Creole_placeholder::ParameterError is an accepted error
+        #Happens if this placeholder needs a specific parameter.
+      else
+        creation_successful= true
+        #Check inheritance.
+        assert_kind_of( Docgenerator::Creole::Placeholder, placeholder)
+      end
+
+      #Check 2 parameters: Actual no placeholder with 2 parameters exists
+      assert_raises(ArgumentError, "Interface error for class #{placeholder_class}"){ 
+        placeholder = placeholder_class.new( Docgenerator::Creole::Creole.new, 'a', 'b' )
+        #Check inheritance.
+        assert_kind_of( Docgenerator::Creole::Placeholder, placeholder)
+      }
+      
+      assert(creation_successful, "Placeholder %s can't be created" % key.inspect)
+      
+  end #do_interfacetest(key,placeholder_class)
+  
+end #class Test_creole_placeholder_interface
+
+class Test_creole_placeholders_html < MiniTest::Test
+  def test_creole_placeholders_html()
+    creole = Docgenerator::Creole::Creole.new(:content => <<creole
+before
+<<<html
+<em>this is only for HTML</em>
+>>>
+after
+creole
+    )
+    #Really like this? Or should there be no paragraph?
+    assert_equal_filecontent( "expected_creole/test_creole_placeholders_html.html", creole.to_doc(:html, OPT))
+    assert_equal_filecontent( "expected_creole/test_creole_placeholders_html.latex", creole.to_doc(:latex, OPT))
+    $log.warn('test_creole_placeholders_html: to_context')
+    #~ assert_equal_filecontent( "expected_creole/test_creole_placeholders_html.context", creole.to_doc(:context))
+    $log.warn('test_creole_placeholders_html: to wiki/creole')
+    #~ assert_equal_filecontent( "expected_creole/test_creole_placeholders_html.creole", creole.to_doc(:creole))
+    assert_equal_filecontent( "expected_creole/test_creole_placeholders_html.text", creole.to_doc(:text, OPT))
+  end #test_creole_placeholders_html
+end #class Test_creole_placeholders_html 
+class Test_creole_placeholders_latex < MiniTest::Test
+  def test_creole_placeholders_latex()
+    creole = Docgenerator::Creole::Creole.new(:content => <<creole
+before
+<<<latex
+\\textbf{this is only for latex}
+>>>
+after
+creole
+    )
+    #Really like this? Or should there be no paragraph?
+    assert_equal_filecontent( "expected_creole/test_creole_placeholders_latex.html", creole.to_doc(:html, OPT))
+    assert_equal_filecontent( "expected_creole/test_creole_placeholders_latex.latex", creole.to_doc(:latex, OPT))
+    $log.warn('test_creole_placeholders_latex: to_context')
+    #~ assert_equal_filecontent( "expected_creole/test_creole_placeholders_context.context", creole.to_doc(:context))
+    $log.warn('test_creole_placeholders_latex: to wiki/creole')
+    #~ assert_equal_filecontent( "expected_creole/test_creole_placeholders_latex.creole", creole.to_doc(:creole))
+    assert_equal_filecontent( "expected_creole/test_creole_placeholders_latex.text", creole.to_doc(:text, OPT))
+  end #test_creole_placeholders_latex
+end   #Test_creole_placeholders
+

data/unittest/unittest_creole_plugin_rail.rb

@@ -0,0 +1,148 @@
+gem 'minitest-filecontent'
+require 'minitest/filecontent.rb'
+
+
+if $0 == __FILE__
+  $:.unshift("../lib")
+  $:.unshift('../../docgenerator/lib')
+end
+require 'docgenerator-creole.rb'
+require 'docgenerator/creole/plugins/rail.rb'
+
+#~ $log        = Log4r::Logger.new( 'test rail', Log4r::WARN )
+#~ $log.outputters = Log4r::StdoutOutputter.new('test rail')
+#~ $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_rail < MiniTest::Test
+  #~ def test_rail()
+    #~ block = Rail_diagramm.new('block', <<-RAIL
+        #~ ( lbrace | 'begin' )
+        #~ ( ( '|' ( variable + ',' ) '|' ) | [Keine Blockvariablen] )
+        #~ comm
+        #~ ( rbrace | 'end' )
+      #~ RAIL
+      #~ )
+  #~ assert_equal_filecontent( "expected_rail/rail_.rail", text.to_doc(:tex))
+  #~ end
+#~ end #Test_rail
+
+class Test_creole_rail < MiniTest::Test
+  #~ def test_document_placeholder()
+    #~ doc = Docgenerator::Creole::Creole_document.new(
+      #~ :title => 'Rail-Diagramms in Creole'
+    #~ )
+    #~ assert_nothing_raised(){
+      #~ doc  << <<DATA
+#~ <<<rail|id
+#~ A
+#~ >>>
+#~ DATA
+    #~ }    
+  #~ end
+  def test_document_placeholder_missing_id()
+    doc = Docgenerator::Creole::Creole_document.new(
+      :title => 'Rail-Diagramms in Creole'
+    )
+    assert_raises( Docgenerator::Creole::Placeholder::ParameterError ){
+      doc  << <<DATA
+<<<rail
+A
+>>>
+DATA
+    }    
+  end
+  def test_document_placeholder_wrong_id()
+    doc = Docgenerator::Creole::Creole_document.new(
+      :title => 'Rail-Diagramms in Creole'
+    )
+    assert_raises( Docgenerator::Creole::Placeholder::ParameterError ){
+      doc  << <<DATA
+<<<rail|id-with-minus
+A
+>>>
+DATA
+    }    
+  end
+  
+  def test_document_placeholder_in_wiki()
+    doc = Docgenerator::Creole::Creole_document.new(
+      :title => 'Rail-Diagramms in Creole'
+    )
+    doc.doc.head << Docgenerator::Creole::Rail::Rail_diagramm::TEX_PACKAGE_RAIL
+    #~ doc.doc.head << element(:latexonly,{}, [
+      #~ Rail_diagramm::RAIL_ALIAS,
+      #~ '\railterm{lowcharacter,uppercharacter}',
+      #~ ])
+
+    doc  << <<DATA
+=Rail-Diagramms
+==Via Placeholder
+<<<rail|test
+      [1] (
+            ( '[' string ']' )
+           ? body[2--6] + '|'
+           )
+    | [2] body[3--6] '*' body[5--6]
+    | [2] body[3--6] '+' body[5--6]
+    | [3] ( body[4--5] + )
+    | [4] body[5] '?'
+    | [5] identifier ( '[' string ']' ) ?
+    | [5] quote string quote
+    | [5] dquote string dquote
+    | [5] '(' body[1--6] ')'
+    | [5] cr
+    | [6]
+    ;
+>>>
+DATA
+#~ doc.runtex = :pdflatex
+  assert_equal_filecontent( "expected_creole_rail/test_rail_creole_placeholder.tex", doc.doc.to_latex({
+                                              :template=> Docgenerator::DocumentTemplate[:article],
+                                              :filename => 'xx',
+                                              :log  => doc.doc.log
+                                            }))
+  end
+                                          
+                                          
+  def test_document_object()
+    $block = Docgenerator::Creole::Rail::Rail_diagramm.new('block', <<-RAIL
+        ( lbrace | 'begin' )
+        ( ( '|' ( variable + ',' ) '|' ) | [Keine Blockvariablen] )
+        comm
+        ( rbrace | 'end' )
+      RAIL
+      )
+    doc = Docgenerator::Creole::Creole_document.new(
+      :title => 'Rail-Diagramms in Creole'
+    )
+    doc.doc.head << Docgenerator::Creole::Rail::Rail_diagramm::TEX_PACKAGE_RAIL
+    #~ doc.doc.head << element(:latexonly,{}, [
+      #~ Rail_diagramm::RAIL_ALIAS,
+      #~ '\railterm{lowcharacter,uppercharacter}',
+      #~ ])
+
+    doc  << <<DATA
+=Rail-Diagramms
+==Via Ruby-object
+<<ruby_raw|$block.to_latex>>
+DATA
+#~ doc.runtex = :pdflatex
+    assert_equal_filecontent( "expected_creole_rail/test_rail_creole_object.tex", doc.doc.to_latex({
+                                              :template=> Docgenerator::DocumentTemplate[:article],
+                                              :filename => 'xx',                                              
+                                              :log  => doc.doc.log
+                                            }))
+  end
+end #Test_rail
+
+  #~ assert_equal_filecontent( "expected_rail/rail_.rail", text.to_doc(:tex))
+
+__END__

data/unittest/unittest_creole_plugin_rubycode4doc.rb

@@ -0,0 +1,123 @@
+#~ require '../test_docgenerator.rb'
+gem 'minitest-filecontent'
+require 'minitest/filecontent.rb'
+
+if $0 == __FILE__
+  $:.unshift("../lib")
+  $:.unshift("../../docgenerator/lib")
+end
+
+require 'docgenerator/packages/rubycode4doc'
+require 'docgenerator/creole'
+require 'docgenerator/creole/plugins/rubycode4creole'
+
+#~ 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_creole  < MiniTest::Test
+  #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__

data/unittest/unittest_creole_plugin_struktex.rb

@@ -0,0 +1,26 @@
+#
+#Tests for creole/plugins//struktex.rb
+#
+#Check after __END__ for missing tests.
+#
+
+if $0 == __FILE__
+  $:.unshift("../lib")
+  $:.unshift("../../docgenerator/lib")
+end
+
+gem 'minitest-filecontent'
+require 'minitest/filecontent.rb'
+
+require 'docgenerator/packages/struktex.rb'
+require 'docgenerator/creole'
+require 'docgenerator/creole/plugins/struktex.rb'
+
+class Test_struktex_creole < MiniTest::Test
+  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
+