wortsammler 0.0.9 → 1.0.0

data/lib/wortsammler.rb

@@ -4,22 +4,22 @@ require "wortsammler/class.proolib"
 
 ##
 # This represents the high level API of Wortsammler
- 
+
 module Wortsammler
 
 
-  # 
+  #
   # execute Wortsammler after parsing the command line
-  # 
-  # @param  options [Hash] The parsed commandline arguments. 
-  # 
+  #
+  # @param  options [Hash] The parsed commandline arguments.
+  #
   #         The key of each entry is the argument name as a symbol
-  # 
+  #
   #         The value of each entry is the value of the argument
   #
   #         No default handling is performed, since defaulting of arguments has been done
   #         on the commandline processor.
-  # 
+  #
   # @return [Nil] No Return
   def self.execute(options)
 
@@ -31,14 +31,20 @@ module Wortsammler
     # print version info
     #
     if options[:version] then
-      puts "#{Wortsammler::PROGNAME} #{Wortsammler::VERSION}"
+      puts "this is #{Wortsammler::PROGNAME} version #{Wortsammler::VERSION}\n"
 
       pandoc=`pandoc -v`.split("\n")[0] rescue pandoc="error running pandoc"
       xetex=`xelatex -v`.split("\n")[0] rescue pandoc="error running xelatex"
 
-      puts "found #{pandoc}"
-      puts "found #{xetex}"
+      $log.info "found #{pandoc}"
+      $log.info "found #{xetex}"
 
+      $log.debug("debug mode turned on")
+
+      l= "-----------------"
+      $log.info l
+      options.each {|k,v| $log.info "#{k}: #{v}"}
+      $log.info l
     end
 
     ##
@@ -75,7 +81,7 @@ module Wortsammler
       if File.file?(inputpath)  #(RS_Mdc)
         input_files=[inputpath]
       elsif File.exists?(inputpath)
-        input_files=Dir["#{inputpath}/**/*.md", "#{inputpath}/**/*.markdown"]
+        input_files=Dir["#{inputpath}/**/*.md", "#{inputpath}/**/*.markdown", "#{inputpath}/**/*.plantuml"]
       end
     end
 
@@ -226,14 +232,14 @@ module Wortsammler
     cleaner = PandocBeautifier.new($log)
     plantumljar=File.dirname(__FILE__)+"/../resources/plantuml.jar"
 
-    paths.each{|f| 
+    paths.each{|f|
       cmd = "java -jar \"#{plantumljar}\" -v \"#{f}\" 2>&1"
       r=`#{cmd}`
       no_of_images = r.split($/).grep(/Number of image/).first.split(":")[1]
 
       $log.info("#{no_of_images} uml diagram(s) in #{File.basename(f)}")
       $log.info(r) unless $?.success?
-     }
+    }
     nil
   end
 
@@ -420,6 +426,16 @@ module Wortsammler
       end
     end
 
+    unless options[:outputfolder] then
+      outputfolder="."
+      inputpath=options[:inputpath]
+      unless inputpath.nil? then
+        outputfolder = inputpath                    if File.directory?(inputpath)
+        outputfolder = File.dirname(inputpath)    if File.file?(inputpath)
+      end
+      options[:outputfolder] = outputfolder
+    end
+
     if options[:inputpath] and options[:process] then
       unless options[:outputfolder] then
         $log.error "no output folder specified for input path"
@@ -432,4 +448,4 @@ module Wortsammler
 
 
 
-end # module
+end # module

data/resources/default.wortsammler.latex

@@ -256,6 +256,10 @@ $if(linenumbers)$
 \setlength\linenumbersep{1mm}
 \modulolinenumbers[5]
 $endif$
+
+\usepackage{makeidx}
+\makeindex
+
 %
 %\renewcommand{Befehl der Gliederungsebene z.B. \chapter}{\@startsection{Name z.B. chapter}{Ebene z.B. 0}{Einrückung z.B. 0pt}{Abstand zum vorigen Text z.B. 3.5ex plus 1ex minus 0pt\relax}{Abstand zum nachfolgenden Text z.B. 2.5ex plus 0.5ex minus 0pt\relax}{Schrift z.B. \normalfont\Large\bfseries}}
 %

data/spec/test_mkindex.md

@@ -0,0 +1,22 @@
+# Das ist ein Test zur Indexerstellung
+
+Dies ist ein Typoblindtext\index{Typoblindtext}. An ihm kann man sehen, ob alle Buchstaben da sind und wie sie aussehen. Manchmal benutzt man Worte wie Hamburgefonts, Rafgenduks oder Handgloves, um Schriften zu testen. 
+
+Manchmal Sätze\index{Sätze}, die alle Buchstaben des Alphabets enthalten - man nennt diese Sätze »Pangrams«. Sehr bekannt ist dieser: The quick brown fox jumps over the lazy old dog. Oft werden in Typoblindtexte auch fremdsprachige Satzteile eingebaut (AVAIL® and Wefox™ are testing aussi la Kerning), um die Wirkung in anderen Sprachen zu testen. In Lateinisch sieht zum Beispiel fast jede Schrift gut aus. Quod erat demonstrandum. Seit 1975 fehlen in den meisten Testtexten die Zahlen, weswegen nach TypoGb. 204 § ab dem Jahr 2034 Zahlen in 86 der Texte zur Pflicht werden. Nichteinhaltung wird mit bis zu 245 € oder 368 $ bestraft. Genauso wichtig in sind mittlerweile auch Âçcèñtë, die in neueren Schriften aber fast immer enthalten sind. Ein wichtiges aber schwierig zu integrierendes Feld sind OpenType-Funktionalitäten. Je nach Software und Voreinstellungen können eingebaute Kapitälchen, Kerning oder Ligaturen (sehr pfiffig) nicht richtig dargestellt werden.Dies ist ein Typoblindtext. An ihm kann man sehen, ob alle Buchstaben da sind und wie sie aussehen. Manchmal benutzt man Worte wie Hamburgefonts, Rafgenduks
+
+\index{Über}\index{Uder}\index{Ufer}\index{Äpfelchen}
+\clearpage
+
+Dies ist ein Typoblindtext\index{Typoblindtext}. An ihm kann man sehen, ob alle Buchstaben da sind und wie sie aussehen. Manchmal benutzt man Worte wie Hamburgefonts, Rafgenduks oder Handgloves, um Schriften zu testen. Manchmal Sätze, die alle Buchstaben des Alphabets enthalten - man nennt diese Sätze »Pangrams«. Sehr bekannt ist dieser: The quick brown fox jumps over the lazy old dog. Oft werden in Typoblindtexte auch fremdsprachige Satzteile eingebaut (AVAIL® and Wefox™ are testing aussi la Kerning), um die Wirkung in anderen Sprachen zu testen. In Lateinisch sieht zum Beispiel fast jede Schrift gut aus. Quod erat demonstrandum. Seit 1975 fehlen in den meisten Testtexten die Zahlen, weswegen nach TypoGb. 204 § ab dem Jahr 2034 Zahlen in 86 der Texte zur Pflicht werden. Nichteinhaltung wird mit bis zu 245 € oder 368 $ bestraft. Genauso wichtig in sind mittlerweile auch Âçcèñtë, die in neueren Schriften aber fast immer enthalten sind. Ein wichtiges aber schwierig zu integrierendes Feld sind OpenType-Funktionalitäten. Je nach Software und Voreinstellungen können eingebaute Kapitälchen, Kerning oder Ligaturen (sehr pfiffig) nicht richtig dargestellt werden.Dies ist ein Typoblindtext. An ihm kann man sehen, ob alle Buchstaben da sind und wie sie aussehen. Manchmal benutzt man Worte wie Hamburgefonts, Rafgenduks
+
+
+\clearpage
+
+hier kommt der Index
+
+\printindex
+
+ende des Index
+
+
+

data/spec/wortsammler_spec.rb

@@ -11,12 +11,29 @@ testoutput     = "#{specdir}/../testoutput"
 
 describe "Wortsammler generic issues" do
 
-  it "provides a help" do
+  it "provides a help", :exp => false do
     result = `#{wortsammler} -h`
     result.should include("Usage: Wortsammler [options]")
     $?.success?.should==true
   end
 
+  it "runs silent", :exp => false do
+    result = `#{wortsammler}`
+    result.empty?.should==true
+  end
+
+  it "reports version numbers", :exp => false do 
+    result = `#{wortsammler} -v`
+    result.should include "wortsammler"
+    result.should include "pandoc"
+    result.should include "XeTeX"
+  end
+
+  it "turns on vervbose mode", :exp => false do 
+    result = `#{wortsammler} -v`
+    result.should include "DEBUG"
+  end
+
   it "can create a new project folder", :exp => false do
     FileUtils.rm_rf(testprojectdir)
     system "#{wortsammler} -n #{testprojectdir}"
@@ -33,7 +50,7 @@ describe "Wortsammler generic issues" do
   end
 
   it "controls the pandoc options by document class" do
-    pending "implmenet test to control pandoc options by document class"
+    pending "implement test to control pandoc options by document class"
   end
 end
 
@@ -43,11 +60,7 @@ describe "Wortsammler options validator" do
     $?.success?.should==false
   end
 
-  it "rejeccts inputs without outputs" do
-    system "#{wortsammler} -pi ." do
-      $?.success?.should==false
-    end
-  end
+
 end
 
 describe "Wortsammler beautifier features" do
@@ -130,6 +143,7 @@ describe "Wortsammler conversion" do
     Dir["#{tempdir}/*"].map{|f|File.basename(f)}.should== ["single.docx",
                                                            "single.html",
                                                            "single.latex",
+                                                           "single.log",
                                                            "single.md",
                                                            "single.pdf"
                                                            ]
@@ -144,7 +158,8 @@ describe "Wortsammler conversion" do
     $?.success?.should==true
 
 
-    Dir["#{tempdir}/*"].map{|f|File.basename(f)}.should== ["single.md",
+    Dir["#{tempdir}/*"].map{|f|File.basename(f)}.should== ["single.log",
+                                                           "single.md",
                                                            "single.pdf"
                                                            ]
   end
@@ -176,6 +191,7 @@ describe "Wortsammler conversion" do
     Dir["#{tempdir}/chapternesting*"].map{|f|File.basename(f)}.sort.should== ["chapternesting.md",
                                                                               "chapternesting.pdf",
                                                                               "chapternesting.latex",
+                                                                              "chapternesting.log",
                                                                               "chapternesting.md.bak"
                                                                               ].sort
   end
@@ -209,6 +225,7 @@ describe "Wortsammler conversion" do
     Dir["#{tempdir}/listnesting*"].map{|f|File.basename(f)}.sort.should== ["listnesting.md",
                                                                            "listnesting.pdf",
                                                                            "listnesting.latex",
+                                                                           "listnesting.log",
                                                                            "listnesting.md.bak"
                                                                            ].sort
   end
@@ -259,7 +276,7 @@ describe "Wortsammler conversion" do
 
   it "extracts plantuml from a single file", :exp => false do
     outfile="#{testoutput}/authentification.png"
-    FileUtils.rm(outfile)
+    FileUtils.rm(outfile) if File.exists?(outfile)
     system "#{wortsammler} -ui \"#{specdir}/TC_EXP_002.md\""
     $?.success?.should==true
     File.exist?(outfile).should==true
@@ -267,7 +284,7 @@ describe "Wortsammler conversion" do
 
   it "extracts plantuml from a folder", :exp => false do
     outfile="#{testoutput}/authentification.png"
-    FileUtils.rm(outfile)
+    FileUtils.rm(outfile) if File.exists?(outfile)
     system "#{wortsammler} -ui \"#{specdir}\""
     $?.success?.should==true
     File.exist?(outfile).should==true
@@ -403,4 +420,19 @@ describe "Wortsammler syntax extensions", :exp => false do
     ref.should==result
   end
 
+  it "generates an index", exp: false do 
+    system "wortsammler -pi \"#{specdir}/test_mkindex.md\" -f pdf:latex"
+    system "pdftotext \"#{specdir}/test_mkindex.pdf\""
+    ref    = File.open("#{specdir}/test_mkindex_reference.txt").read
+    result = File.open("#{specdir}/test_mkindex.txt").read
+    ref.should==result
+  end
+
+  it "reports TeX messages", exp: false do 
+    system "wortsammler -pi \"#{specdir}/test_mkindex.md\" -f pdf:latex >> \"#{specdir}/test_mkindex.lst\""
+    system "pdftotext \"#{specdir}/test_mkindex.pdf\""
+    result = File.open("#{specdir}/test_mkindex.lst").read
+    result.include?("[WARN]").should==true
+  end
+
 end