docgenerator 2.0.0 → 2.1.0

data/build_test_and_doc.rb

@@ -1,505 +0,0 @@
-#encoding: utf-8
-=begin
-Generates new versions for test.
-
-Generates:
-*unittest_docgenerator_characters.rb based on 
-* test for each element
-=end
-
-#~ Dir['lib/**/wiki*/*'].each{|file| puts "require '#{file}'".sub(/lib\//,'') }
-#~ exit
-
-require 'date'
-$:.unshift('lib')
-require 'docgenerator'
-Docgenerator::DOCGENERATOR_LOGGER.level = Log4r::WARN
-#~ require 'docgenerator/compatibility_v1'
-require 'docgenerator/packages/attachfile.rb'
-require 'docgenerator/packages/caption.rb'
-require 'docgenerator/packages/hyperref.rb'
-require 'docgenerator/packages/listings.rb'
-require 'docgenerator/packages/pdfpages.rb'
-require 'docgenerator/packages/rubycode4doc.rb'
-require 'docgenerator/packages/scrlettr2.rb'
-require 'docgenerator/packages/scrpage2.rb'
-require 'docgenerator/packages/struktex.rb'
-require 'docgenerator/packages/todonotes.rb'
-require 'docgenerator/packages/url.rb'
-
-require 'creole/creole2doc.rb'
-require 'creole/plugins/rail.rb'
-require 'creole/plugins/rubycode4creole.rb'
-require 'creole/plugins/struktex.rb'
-require 'creole/plugins/todonotes.rb'
-
-require 'wiki2doc/wiki2docgenerator.rb'
-require 'wiki2doc/plugins/rubycode4wiki.rb'
-require 'wiki2doc/plugins/struktex.rb'
-
-
-=begin rdoc
-List all known elements
-=end
-def puts_elements
-  ObjectSpace.each_object(Class).map{|o| 
-      o.name || ''
-    }.sort.each{|o|
-      puts o if o =~ /^Docgenerator/ 
-      #~ puts o if o.is_a?(Docgenerator::Element)
-  }
-end
-
-
-
-=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
-
-TESTHEAD = <<testhead
-#encoding: utf-8
-
-=begin rdoc
-Test generated by #{__FILE__} #{Date.today}
-=end
-
-gem 'test-unit'
-require 'test/unit'
-
-if $0 == __FILE__
-  $:.unshift("../lib")
-end
-require 'docgenerator'
-#~ DOCGENERATOR_LOGGER.level = Log4r::DEBUG
-
-=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
-
-testhead
-
-def mk_character_test(filename = "unittest/unittest_docgenerator_characters_#{Date.today}.xx")
-  File.open(filename, 'w:utf-8'){|f_test|
-    puts "Create #{f_test.path}"
-    f_test << TESTHEAD
-    f_test << <<code
-include Docgenerator
-class Test_characters < Test::Unit::TestCase
-  def self.startup()
-    #DEBUG would contain messages
-    @@log = Log4r::Logger.new('Test_characters', Log4r::INFO)
-    @@log.outputters = @@logoutputter = ArrayOutputter.new('xx')
-  end #self.startup()
-
-code
-
-  #Some Coding to prepare the unit tests
-  els = nil
-  lclass = nil
-  File.open('../lib/docgenerator/characters.rb', 'r:utf-8').each_line{|line|#
-    case line
-      when /\A\s*#/ #skip
-      when /class\s*(\w+)\s/
-        lclass = $1
-        els = [ $1.downcase.to_sym ]
-      when /add_id\s*(\w+)/
-        els << $1
-      when /add_(html|latex|wiki|creole|text)_output\s*'(.+?)'/
-        target = $1
-        result  = $2.sub(/'/, "''")
-        f_test << "\n  def test_character_#{lclass}_#{target}()\n"
-        els.each{|el|
-        if result.sub!(/\#\{@content\}/, '1')
-          f_test << "    assert_equal( '#{result}', element(#{el.inspect}, {}, 1).to_#{target}( :log => @@log))\n"
-        else
-          f_test << "    assert_equal( '#{result}', element(#{el.inspect}).to_#{target}( :log => @@log))\n"
-        end
-          f_test << "    assert_equal( [], @@logoutputter.flush)\n"
-        }
-        f_test << "  end #test_character_#{lclass}_#{target}\n"
-    end
-  }
-
-    f_test << <<code
-end #class Test_characters
-code
-  }
-end #mk_character_test()
-
-class Docgenerator::Element
-  def self.each()
-    @@ids.values.uniq.each{|cl| yield cl }
-  end
-end
-
-def mk_element_test(pattern)
-  
-  testcode= []
-  Docgenerator::Element.each{|cl|
-    next unless cl.name =~ pattern
-    #exclude dummy element.
-    next if %w{Docgenerator::Sectioning::DummySectioning}.include?(cl.name.to_s)
-    p cl.name
-    
-    testclass = "Test_element_#{cl.name.downcase.gsub(/::/, '_')}"
-    @@log = Log4r::Logger.new(cl.element_ids.first.to_s, Log4r::DEBUG)
-    @@log.outputters = @@logoutputter = ArrayOutputter.new('xx')
-    @@el = cl.new(:log => @@log )
-    testcode << <<code
-=begin rdoc
-Test #{cl.name}.
-=end
-class #{testclass} < Test::Unit::TestCase
-  def self.startup()
-    @@log = Log4r::Logger.new('#{cl.element_ids.first.to_s}', Log4r::DEBUG)
-    @@log.outputters = @@logoutputter = ArrayOutputter.new('xx')
-    @@el = #{cl.name}.new(:log => @@log)
-
-    #fill attributes
-code
-      @@el.attr.each{|k,a|
-        if a.required?  
-          #this may give an error, if the attribute has wrong type/layout...
-          @@el[k] << "Attr_#{k}"
-          testcode  << "    @@el[#{k.inspect}] << 'Attr_#{k}'"
-        else  #only as template
-          testcode  << "    \#@@el[#{k.inspect}] << 'Attr_#{k}'"
-        end
-      }
-      
-      if @@el.content?
-        @@el << 'content'
-        testcode<< "    #fill content"
-        testcode<< "    @@el << 'content'"
-      else
-        testcode<< "    #element allows no content"
-      end
-      
-      testcode<< "    #Store log messages"
-      testcode<< "    @@messages = @@logoutputter.flush"
-    #test log-content
-    @@messages = @@log.outputters.first.flush
-    testname = "test_element_#{cl.name.downcase.gsub(/::/, '_')}_log"
-    
-    testcode<< <<code
-    end #self.startup()
-=begin rdoc
-Check messages from logger.
-This may include warnings for wrong content format...
-
-The following messages are expected:
-#{@@messages.to_yaml}
-=end
-  def #{testname}
-    assert_equal(
-      #{@@messages.inspect},
-      @@messages
-    )
-  end ##{testname}
-code
-    %w{latex html context text wiki creole}.each{|target|
-        testname = "test_element_#{cl.name.downcase.gsub(/::/, '_')}_#{target}"
-        result = @@el.send("to_#{target}".to_sym, :log => @@log)
-        
-        testcode<< <<code
-=begin
-Test #{cl.name}#to_#{target}.
-=end
-  def #{testname}()
-    assert_equal(
-code
-        #Problem:
-        if result.count("\n") < 2 #einzeilig
-          #\u (\url...) wird als Unicode-eingabe interpretiert. Desahlb muss \ maskiert werden.
-          testcode<< "      #{result.inspect.gsub(/\\/, '\\\\')}," 
-        else  #mehrzeilig
-=begin
-Problem: %{inhalt} macht Probleme bei Strings mit { und }
-<<<xx fügt leerzeichen ein, komma für nächste Parameter geht auch nicht.
-=end
-          testcode<< "      %Q{#{result.gsub(/\\/, '\\\\\\\\')}},"  #mehrzeilig
-          #~ testcode<< "#~ <<result" 
-          #~ testcode<< @@el.send("to_#{target}".to_sym).gsub(/\\/, '\\\\\\\\').gsub(/^/, '#~ ')
-          #~ testcode<< "#~ result"
-        end
-        testcode<< "      @@el.to_#{target}( :log => @@log).encode('utf-8')"
-        testcode<< "    )"
-        messages = @@logoutputter.flush
-        testcode<< <<code
-=begin
-Check messages from #{cl.name}#to_#{target}. Expected:
-#{messages.to_yaml}
-=end
-    assert_equal(
-      #{messages.inspect},
-      @@logoutputter.flush
-    )
-code
-        testcode<< "  end ##{testname}"
-    }
-      testcode<< "end ##{testclass}"
-    
-  }
-
-  File.open("unittest/x_unittest_docgenerator_elements_#{Date.today}.rb", 'w:utf-8'){|f_test|
-    puts "Create #{f_test.path}"
-    f_test << TESTHEAD
-    f_test << testcode.join("\n")
-  }
-
-  #~ puts testcode.join("\n")
-end #mk_element_test
-
-=begin rdoc
-Prepare a documentation, based on execution and meta-analyse.
-=end
-def mk_element_doc(pattern, filename = "manpage_element.rb")
-  
-  rd_code= [<<xx
-=begin rdoc
-Generated manpages for elements.
-=end
-
-module Doc
-
-module Docgenerator
-  module Characters; end
-  module Creole; end
-  module Elements; end
-  module Environments; end
-  module Letter; end
-  module Listings; end
-  module Lists; end
-  module Sectioning; end
-  module Tables; end
-  module Wikimedia; end
-end
-
-module Struktex; end
-
-xx
-  ]
-  log = Log4r::Logger.new('log', Log4r::WARN) #avoid message
-  log.outputters = logoutputter = ArrayOutputter.new('xx')
-  
-  Docgenerator::Element.each{|cl|
-    next unless cl.name =~ pattern
-    
-    #exclude dummy element.
-    next if %w{Docgenerator::Sectioning::DummySectioning}.include?(cl.name.to_s)
-    p cl.name
-
-    el = cl.new(:log => log )
-    rd_code << <<code
-=begin rdoc
-=#{cl.name}
-See also ::#{cl.name}
-
-code
-    if ! el.attr.empty?
-      tab = element(:tabular, columns: 10).Cr
-      tab << row = element(:row ).cr
-      row << element(:th, {}, 'Name')
-      row << element(:th, {}, 'required?')
-      row << element(:th, {}, 'HTML')
-      row << element(:th, {}, 'LaTeX')
-      row << element(:th, {}, '~keyval')
-      row << element(:th, {}, 'ConTeXt')
-      row << element(:th, {}, 'Text')
-      row << element(:th, {}, 'Wiki')
-      row << element(:th, {}, 'Creole')
-      row << element(:th, {}, 'Values')
-
-        el.attr.each{|k,a|
-  ##fixme element(:radic) statt 'X'?
-          tab << row = element(:row).cr
-          row << element(:col, {}, k.inspect)
-          row << element(:col, {}, a.required? ? 'X' : '-' )
-          row << element(:col, {}, a.html? ? 'X' : '-' )
-          row << element(:col, {}, a.latex? ? 'X' : '-' )
-          row << element(:col, {}, a.texkeyval? ? 'X' : '-' )
-          row << element(:col, {}, a.context? ? 'X' : '-' )
-          row << element(:col, {}, a.text? ? 'X' : '-' )
-          row << element(:col, {}, a.wiki? ? 'X' : '-' )
-          row << element(:col, {}, a.creole? ? 'X' : '-' )
-          #~ rd_code  << "===Attribute #{k.inspect}"
-          if a.required?  
-            #this may give an error, if the attribute has wrong type/layout...
-            el[k] << "Value for #{k}"
-            #~ rd_code  << "* required"
-          #~ else
-            #~ rd_code  << "* optional"
-          end
-          #~ rd_code  << "* used for:"
-          #~ rd_code  << "  * HTML" if a.html?()
-          #~ rd_code  << "  * LaTeX" if a.latex?()
-          #~ rd_code  << "  * LaTeX as key-val parameter" if a.texkeyval?()
-          #~ rd_code  << "  * ConTeXt" if a.context?()
-          #~ rd_code  << "  * text" if a.text?()
-          #~ rd_code  << "  * wiki (wikimedia)" if a.wiki?()
-          #~ rd_code  << "  * wiki (creole)" if a.creole?()
-
-          row << col = element(:col)
-          if a.allowed_values
-            col << ul = element(:ul)
-            #~ rd_code  << "* Allowed values:"
-            a.allowed_values.each{|x|
-              ul << element(:li,{}, x.inspect)
-              #~ rd_code  << "  * #{x.inspect}"
-            } 
-          end
-        }
-      
-        rd_code<< "==Attributes"
-        rd_code<< tab.to_html(:log=> log)
-      end
-      
-      #~ rd_code<< "==Content"
-      if el.content?
-        el << 'content'
-        rd_code<< "The element can contain content"
-      else
-        rd_code<< "The element allows no content"
-      end
-      
-      rd_code<< "\n==Generate an object"
-      cmd = "  test = #{el.class}.new( "
-      el.attr.each{|k,a|
-        cmd << "\n      #{k.inspect} => #{a.content.inspect}," unless a.content.empty?
-      }
-      cmd.sub!(/,\Z/, "\n") #delete last , from attributes if available.
-      cmd << "  )"
-      cmd << "\n  test << #{el.content.inspect}" if el.content?
-      
-      cmd << "\n\nAlternative generation\n"
-      el.element_ids.each{|id|
-        cmd << "  test = element(#{id.inspect}#{ ' , { ...Attributes... }' unless el.attr.empty?})\n"
-      }
-      rd_code << cmd
-    
-    
-      rd_code<< "\n==Outputs"
-      
-      %w{latex html context text wiki creole}.each{|target|
-
-        el2 = el.dup  #later check with cr, cR... would modify the result
-        
-        logoutputter.flush  #clear messages
-        result = el.send("to_#{target}".to_sym, :log => log)
-        rd_code<< <<code
-===test.to_#{target}
-#{result.gsub(/^/, "  ")}
-code
-      logoutputter.flush.each{|message|
-        case message
-          when /(Missing output routine for .*)\(/
-            rd_code << "* #{$1}"
-          when /No related document for tableofcontents/
-          when %r{ERROR log: :li/wiki: Unknown list type nil}
-          else
-            p "Uncatched message: #{message}"
-        end
-      }#logoutputter.flush
-
-      cr_first = true
-      #try different cr-commands
-      [ :cr, :cR, :Cr, :CR ].each{| cr |
-        el2.send(cr)
-        result2 = el2.send("to_#{target}".to_sym, :log => log)
-        
-        if result != result2
-          if cr_first #first difference -> print start information
-            rd_code << <<code
-====:cr, :cR, :Cr, :CR 
-With Element#cr, Element#cR, Element#Cr, Element#CR you may influence 
-the code layout.
-[[START]]/[[END]] are not part of the output, but needed to illustrate the 
-line breaks.
-
-Default:
-#{"[[START]]#{result}[[END]]".gsub(/^/, "  ")}
-code
-            cr_first = false
-          end #cr_first
-          rd_code << <<code
-Result after Element##{cr}:
-#{"[[START]]#{result2}[[END]]".gsub(/^/, "  ")}
-code
-        end
-      } #different cr-commands
-    } #targets
-    rd_code << <<code
-=end
-  class #{cl.name}
-  end ##{cl.name}
-code
-  } #Element.each 
-
-  rd_code << "end"
-  
-  puts rd_code.join("\n").encoding
-  puts rd_code.join("\n").valid_encoding?
-  
-  File.open(filename, 'w:cp1252'){|f_test|
-    puts "Create #{f_test.path}"
-    f_test << rd_code.join("\n")
-  }
-
-end #mk_element_doc(pattern)
-
-#~ mk_character_test( )
-#~ mk_character_test( "unittest_docgenerator_characters.rb" )
-
-#~ mk_element_test(/./i)
-#~ mk_element_test(/\A(?:.(?<!Characters))*\Z/i) #ohne characters
-#~ mk_element_test(/include/i)
-#~ mk_element_test(/img/i)
-#~ mk_element_test(/Section/i)
-
-#~ mk_element_doc(/img/i, 'manpage_extract.rb')
-mk_element_doc(/sectioning/i, 'manpage_extract.rb')
-#~ mk_element_doc(/elements/i, 'manpage_extract.rb')
-#~ mk_element_doc(/tables/i, 'manpage_extract.rb')
-#~ mk_element_doc(/envi/i, 'manpage_extract.rb')
-#~ mk_element_doc(/list/i, 'manpage_extract.rb')
-#~ mk_element_doc(/style|foot/i, 'manpage_extract.rb')
-#~ mk_element_doc(/\A(?:.(?<!Characters))*\Z/i) #ohne characters
-#~ mk_element_doc(/./i)
-
-#~ puts_elements