wortsammler 0.0.6 → 0.0.7

data/README.md

@@ -136,6 +136,13 @@ The rakefile is in `<folder>/30_Sources/ZSUPP_Tools`
 
 Please use Ruby 1.9.3
 
+-   mac:
+    -   installation requirex xcode with the commanline tools
+    -   use Ruby Version Manager [https://rvm.io][]
+    -   rvm install ruby_1.9.3
+    -   might take pretty long depending on wha you have on your mac.
+    -   after ruby is installed `gem install wortsammler`
+
 -   windows
     -   download von [http://rubyinstaller.org/downloads/][]
     -   development kit installieren
@@ -144,12 +151,9 @@ Please use Ruby 1.9.3
         Das braucht man nur, wenn man den Windows-Debugger verwenden
         muss. In den scripten ist rquire ruby-debug aukommentiert.
 
--   mac: OSX 10.8 bereits installiert
-
 ### pandoc
 
--   Download [ttp://code.google.com/p/pandoc/downloads/list][]
--   Installation <http://rubyinstaller.org/downloads/>
+-   Download [http://code.google.com/p/pandoc/downloads/list][]
 -   Homepage <http://johnmacfarlane.net/pandoc/>
 
 ### TeX
@@ -168,5 +172,4 @@ Please use Ruby 1.9.3
   [pandoc]: http://johnmacfarlane.net/pandoc/
   [http://rubyinstaller.org/downloads/]: http://rubyforge.org/frs/%20download.php/76277/rubyinstaller-1.8.7-p370.exe
   [DevKit-tdm-32-4.5.2-20111229-1559-sfx.exe]: https://github.com/downloads/oneclick/rubyinstaller/DevKit-tdm-32-4.5.2-20111229-1559-sfx.exe
-  [ttp://code.google.com/p/pandoc/downloads/list]: http://code.google.com/p/pandoc/downloads/list
   [usbtex]: http://www.exomatik.net/U-Latex/USBTeXEnglish

data/changelog.md

@@ -1,7 +1,15 @@
+# 0.0.7 (17.07.2013)
+
+-   Added support to include plantuml diagrams where the diagram source
+    is embedded in the md file
+-   Added support to include Markdown files.This provides another (maybe
+    even more common) approach to collect a document from multiple
+    files.
+
 # 0.0.6 (07.07.2013)
 
 -   Added initial support for Testreports
-	<https://github.com/bwl21/wortsammler/issues/17>
+    <https://github.com/bwl21/wortsammler/issues/17>
 
 # 0.0.5
 

data/lib/wortsammler.rb

@@ -106,6 +106,34 @@ module Wortsammler
       end
     end
 
+    #
+    # plantuml markdown files
+    #
+    #
+
+    if options[:plantuml]
+
+
+      # process path
+
+      if input_files then
+        Wortsammler.plantuml(input_files)
+      end
+
+      # process manifest
+
+      if config then
+        Wortsammler.plantuml(config.input)
+      end
+
+      unless input_files or config
+        $log.error "no input specified. Please use -m or -i to specify input"
+        exit false
+      end
+    end
+
+
+
     ##
     # process collect in markdown files
     #
@@ -187,6 +215,29 @@ module Wortsammler
     nil
   end
 
+
+  #
+  # plantuml a list of Documents
+  # @param  paths [Array of String] Array of filenames which shall be converted.
+  #
+  # @return [Nil] no return
+  def self.plantuml(paths)
+
+    cleaner = PandocBeautifier.new($log)
+    plantumljar=File.dirname(__FILE__)+"/../resources/plantuml.jar"
+
+    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
+
+
   #
   # process the documents according to the maanifest
   #
@@ -305,7 +356,7 @@ module Wortsammler
     # check duplicates
     duplicates=all_traceable_set.duplicate_traces
     if duplicates.count > 0
-      $logger.warn "duplicated trace ids found:"
+      $log.warn "duplicated trace ids found:"
       duplicates.each{|d| d.each{|t| $log.warn "#{t.id} in #{t.info}"}}
     end
 
@@ -363,8 +414,8 @@ module Wortsammler
   # @return [Boolean] true if successful. otherwise exits the program
   def self.verify_options(options)
     if options[:inputpath] or options[:manifest] then
-      unless options[:process] or options[:beautify] or options[:collect] then
-        $log.error "no procesing option (p, b, c) specified"
+      unless options[:process] or options[:beautify] or options[:collect] or options[:plantuml] then
+        $log.error "no procesing option (p, b, c, u) specified"
         exit false
       end
     end

data/lib/wortsammler/class.proolib.rb

@@ -37,7 +37,7 @@ TRACE_REF_PATTERN     = /->\[(\w+_\w+_\w+)\]/
 #                                                                                    pageclearance
 INCLUDE_PDF_PATTERN   = /^\s+~~PDF\s+"(.+)" \s+ "(.+)" \s* (\d*) \s* (\d+-\d+)? \s* (clearpage|cleardoublepage)?~~/x
 
-INCLUDE_MD_PATTERN    = /^\s+~~MD\s+"(.+)" \s+ "(.+)" \s* (\d*) \s* (\d+-\d+)? \s* (clearpage|cleardoublepage)?~~/x
+INCLUDE_MD_PATTERN    = /(\s*)~~MD\s+"(.+)"~~/x
 
 SNIPPET_PATTERN       = /(\s*)~~SN \s+ (\w+)~~/x
 
@@ -45,6 +45,8 @@ EMBEDDED_IMAGE_PATTERN   = /~~EMBED\s+ "(.+)" \s+ (r|l|i|o) \s+ (.+) \s+ (.+)~~/
 
 EXPECTED_RESULT_PATTERN = /(^\s*)~~~~\s*\{.expectedResult\s+label=\"([A-Za-z]+_[A-Za-z]+_[0-9]+)\"}\s([^~]*)~~~~/x
 
+PLANTUML_PATTERN = /[~]{4,}\s+{\.plantuml}\s+@startuml\s+([^\n]+)(\s+title\s+([^\n]+))?[^~]+[~]{4,}/x
+
 #
 # This mixin convertes a file path to the os Path representation
 # todo maybe replace this by a builtin ruby stuff such as "pathname"
@@ -111,22 +113,22 @@ class ReferenceTweaker
 
 
       j="00"
-      result << result_items.map{|i| 
+      result << result_items.map{|i|
         j = j.next
         "\\CheckBox[name=#{label}_#{j}]{} #{i}"
-       }
+      }
       result << "\\vspace{1em}"
       result << "\\ChoiceMenu[combo, name=#{label}_98]{Test execution:}{ok, fail, pending}"
       result << "\\vspace{1em}"
       result << ["\\TextField[ name=#{label}_99 , width=40em, height=2cm, multiline=true, bordercolor={1 1 1}] {}"]
       result << ["\\end{Form}"]
 
-        unless $1.nil? then
-          leading_whitespace=$1.split("\n",100)
-          leading_lines=leading_whitespace[0..-1].join("\n")
-          leading_spaces=leading_whitespace.last || ""
-          replacetext=leading_lines+replacetext_raw.gsub("\n", "\n#{leading_spaces}")
-        end
+      unless $1.nil? then
+        leading_whitespace=$1.split("\n",100)
+        leading_lines=leading_whitespace[0..-1].join("\n")
+        leading_spaces=leading_whitespace.last || ""
+        replacetext=leading_lines+replacetext_raw.gsub("\n", "\n#{leading_spaces}")
+      end
 
       result=result.compact.flatten.map{|i|"#{indent}#{i}"}
       result.join("\n#{indent}\n")
@@ -144,6 +146,36 @@ class ReferenceTweaker
       trace.gsub("_", "\\_")
     end
 
+
+
+    #
+    # This replaces markdown inlays
+    # it is a subroutine which is called
+    # recursively
+    # todo: handle indentation
+    #
+    # @param  text [String] text in which the markdown inlays shall be processed
+    # @return [String] The resulting text
+    def replace_md_inlay(text)
+      text.gsub!(INCLUDE_MD_PATTERN){|m|
+        if File.exist?($2) then
+          replacetext_raw=File.open($2).read
+          unless $1.nil? then
+            leading_whitespace=$1.split("\n",100)
+            leading_lines=leading_whitespace[0..-1].join("\n")
+            leading_spaces=leading_whitespace.last || ""
+            replacetext=leading_lines+replacetext_raw.gsub("\n", "\n#{leading_spaces}")
+          end
+        else
+          replacetext=""
+          @log.warn("File not found: #{$2}")
+        end
+        result=replace_md_inlay(replacetext)
+        result
+      }
+      text
+    end
+
   public
 
     # constructor
@@ -205,6 +237,11 @@ class ReferenceTweaker
         }
       end
 
+      # include Markdown files
+      #
+      #
+      text = replace_md_inlay(text)
+
 
       # embed images
       #
@@ -255,6 +292,17 @@ class ReferenceTweaker
         # it is already leave it as it is
       end
 
+      # substitute plantuml
+      #
+      # note this is substituted in any case
+      #
+      #if @target == "pdf" then
+      text.gsub!(PLANTUML_PATTERN){|m| ""}
+
+      #else
+      # it is already leave it as it is
+      #end
+
       File.open(outfile, "w"){|f| f.puts(text)}
     end
 end
@@ -817,6 +865,10 @@ class PandocBeautifier
 
     @log.info("rendering  #{outname} as [#{format.join(', ')}]")
 
+    supported_formats=["pdf", "latex", "frontmatter", "docx", "html", "txt", "rtf", "slide"]
+    wrong_format=format - supported_formats
+    wrong_format.each{|f|@log.error("format not supported: #{f}")}
+
     begin
 
 
@@ -898,8 +950,8 @@ class PandocBeautifier
           "  --ascii -t dzslides --slide-level 2 -o  #{outfileSlide.esc}"
         `#{cmd}`
       end
-    rescue
-      @log.error "failed to perform #{cmd}"
+    rescue Exception => e
+      @log.error "failed to perform #{cmd}, #{e.message}"
       #TODO make a try catch block kere
     end
     nil

data/lib/wortsammler/exe.wortsammler.rb

@@ -94,6 +94,11 @@ optparse = OptionParser.new do|opts|
   end
 
 
+  options[:plantuml] = false
+  opts.on( '-u', '--plantuml', 'plantuml documents by manifest' ) do
+    options[:plantuml] = true
+  end
+
   options[:beautify] = false
   opts.on( "-b", '--beautify', 'bautify markdownfiles' ) do
     options[:beautify] = true

data/lib/wortsammler/version.rb

@@ -1,4 +1,4 @@
 module Wortsammler
   PROGNAME="wortsammler"
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/TC_EXP_002.md

@@ -0,0 +1,12 @@
+# demoing plantuml support
+
+~~~~ {.plantuml}
+    @startuml ../testoutput/authentification.png
+
+    Alice -> Bob: Authentication Request
+    Bob --> Alice: Authentication Response
+    @enduml 
+~~~~
+
+![Authentification](../testoutput/authentification.png)
+

data/spec/TC_EXP_003_1.md

@@ -0,0 +1,7 @@
+## this is TC_EXP_003_1
+
+we now include TC_EXP_003_2 from TC_EXP_003_1
+
+~~MD "TC_EXP_003_2.md"~~
+
+end of TC_EXP_003_1

data/spec/TC_EXP_003_2.md

@@ -0,0 +1,7 @@
+## this is md TC_EXP_003_2
+
+	- hugo
+
+	- hugo2
+
+end of TC_EXP_003_2

data/spec/tc_exp_003_reference.txt

@@ -0,0 +1,54 @@
+-   this is headline
+    -   this is TC\_EXP\_003\_1
+    -   this is md TC\_EXP\_003\_2
+    -   this is md TC\_EXP\_003\_2
+
+
+this is headline
+================
+
+
+    now verbatim by indent inclucde TC_EXP_003_1.md
+
+        ## this is TC_EXP_003_1
+        
+        we now include TC_EXP_003_2 from TC_EXP_003_1
+        
+        ## this is md TC_EXP_003_2
+        
+            - hugo
+        
+            - hugo2
+        
+        end of TC_EXP_003_2
+        
+        end of TC_EXP_003_1
+
+now full format inclucde TC_EXP_003_1.md
+
+this is TC_EXP_003_1
+--------------------
+
+we now include TC_EXP_003_2 from TC_EXP_003_1
+
+this is md TC_EXP_003_2
+-----------------------
+
+    - hugo
+
+    - hugo2
+
+end of TC_EXP_003_2
+
+end of TC_EXP_003_1
+
+now full format inclucde TC_EXP_003_2.md
+
+this is md TC_EXP_003_2
+-----------------------
+
+    - hugo
+
+    - hugo2
+
+end of TC_EXP_003_2

data/spec/wortsammler_spec.rb

@@ -5,7 +5,8 @@ require 'pry'
 wortsammlerbin = "'#{File.expand_path("bin")}'"
 wortsammler    = "'#{File.expand_path(File.join("bin", "wortsammler"))}'"
 testprojectdir = "testproject/30_Sources"
-specdir   =File.dirname(__FILE__)
+specdir        = File.dirname(__FILE__)
+testoutput     = "#{specdir}/../testoutput"
 
 
 describe "Wortsammler generic issues" do
@@ -243,12 +244,37 @@ describe "Wortsammler conversion" do
     $?.success?.should==false
   end
 
-  it "extracts the traceables according to a manifest" do
+  it "extracts the traceables according to a manifest", :exp=> false do 
     manifest="testproject/30_Sources/ZSUPP_Manifests/sample_the-sample-document.yaml"
     system "#{wortsammler} -cm #{manifest}"
     $?.success?.should==true
   end
 
+
+  it "extracts plantuml according to a manifest", :exp => false do
+    manifest="testproject/30_Sources/ZSUPP_Manifests/sample_the-sample-document.yaml"
+    system "#{wortsammler} -um #{manifest}"
+    $?.success?.should==true
+  end
+
+  it "extracts plantuml from a single file", :exp => false do
+    outfile="#{testoutput}/authentification.png"
+    FileUtils.rm(outfile)
+    system "#{wortsammler} -ui \"#{specdir}/TC_EXP_002.md\""
+    $?.success?.should==true
+    File.exist?(outfile).should==true
+  end
+
+  it "extracts plantuml from a folder", :exp => false do
+    outfile="#{testoutput}/authentification.png"
+    FileUtils.rm(outfile)
+    system "#{wortsammler} -ui \"#{specdir}\""
+    $?.success?.should==true
+    File.exist?(outfile).should==true
+  end
+
+   
+
   it "processes snippets" do
     pending "Test not yet implemented"
   end
@@ -281,6 +307,7 @@ describe "Wortsammler conversion" do
       #system cmd
     }
   end
+
 end
 
 
@@ -317,15 +344,63 @@ describe "Wortsammler syntax extensions", :exp => false do
     $?.success?.should==true
   end
 
-  it "TC_EXP_001 expands expected results from testcases", exp: true do
+  it "TC_EXP_001 expands expected results from testcases", exp: false do
 
     proc=ReferenceTweaker.new("pdf")
     outfile="#{specdir}/../testoutput/TC_EXP_001.output.md"
     File.unlink(outfile) if File.exists?(outfile)
-    proc.prepareFile("#{specdir}/TC_EXP_001.md", "#{specdir}/../testoutput/TC_EXP_001.output.md")
+    proc.prepareFile("#{specdir}/TC_EXP_001.md", outfile)
 
     a=File.open(outfile, "r").readlines.join
     a.should include("TC_DES_003_01")
   end
 
+  it "TC_EXP_002 removes plantuml sources", exp: false do
+
+    proc=ReferenceTweaker.new("pdf")
+    outfile="#{specdir}/../testoutput/TC_EXP_002.output.md"
+    File.unlink(outfile) if File.exists?(outfile)
+    proc.prepareFile("#{specdir}/TC_EXP_002.md", outfile)
+
+    a=File.open(outfile, "r").readlines.join
+    a.include?(".plantuml").should==false
+  end
+
+  it "TC_EXP_003 handles Markdown inlays", exp: false do
+    tempdir   ="#{specdir}/../testoutput"
+    mdinlayfile ="TC_EXP_003_1.md"
+    mdinlayfile_1 ="TC_EXP_003_2.md"
+    mdfile="tc_exp_003"
+
+    FileUtils.cd(tempdir){|c|
+      FileUtils.cp("#{specdir}/#{mdinlayfile}", ".")
+      FileUtils.cp("#{specdir}/#{mdinlayfile_1}", ".")
+
+
+      mdtext=["#this is headline",
+              "",
+              "~~~~",
+              "","now verbatim by indent inclucde #{mdinlayfile}", "",
+              "    ~~MD \"#{mdinlayfile}\"~~",
+              "~~~~",
+              "",
+              "","now full format inclucde #{mdinlayfile}", "",              
+              "~~MD \"#{mdinlayfile}\"~~",
+              "",
+              "","now full format inclucde #{mdinlayfile_1}", "",
+              "~~MD \"#{mdinlayfile_1}\"~~",
+              ].flatten.join("\n")
+
+      File.open("#{mdfile}.md", "w"){|f| f.puts mdtext}
+
+      system "#{wortsammler} -pi '#{mdfile}.md' -o '.' -f txt"
+      FileUtils.rm mdinlayfile
+      FileUtils.rm mdinlayfile_1
+    }
+
+    ref    = File.open("#{specdir}/tc_exp_003_reference.txt").read
+    result = File.open("#{tempdir}/#{mdfile}.txt").read
+    ref.should==result
+  end
+
 end

data/testresults/wortsammler_testresults.html

@@ -284,13 +284,192 @@ a {
 <div class="results">
 <div id="div_group_1" class="example_group passed">
   <dl style="margin-left: 0px;">
-  <dt id="example_group_1" class="passed">Wortsammler syntax extensions</dt>
+  <dt id="example_group_1" class="passed">PandocBeautifier</dt>
+    <script type="text/javascript">moveProgressBar('1.5');</script>
+    <dd class="example passed"><span class="passed_spec_name">checks the availability of the right pandoc version</span><span class='duration'>0.03202s</span></dd>
+  </dl>
+</div>
+<div id="div_group_2" class="example_group passed">
+  <dl style="margin-left: 0px;">
+  <dt id="example_group_2" class="passed">pdf utilities:</dt>
+    <script type="text/javascript">moveProgressBar('3.0');</script>
+    <dd class="example passed"><span class="passed_spec_name">adjusts the bounding box of a pdf file</span><span class='duration'>18.83432s</span></dd>
+    <script type="text/javascript">moveProgressBar('4.5');</script>
+    <dd class="example passed"><span class="passed_spec_name">converts an excel sheet to pdf</span><span class='duration'>3.58990s</span></dd>
+    <script type="text/javascript">moveProgressBar('6.0');</script>
+    <dd class="example passed"><span class="passed_spec_name">converts a powerpoint to pdf</span><span class='duration'>1.64767s</span></dd>
+    <script type="text/javascript">moveProgressBar('7.5');</script>
+    <dd class="example passed"><span class="passed_spec_name">converts an excelsheet to cropped pdf</span><span class='duration'>3.71127s</span></dd>
+    <script type="text/javascript">moveProgressBar('9.0');</script>
+    <dd class="example passed"><span class="passed_spec_name">converts a powerpoint to cropped pdf</span><span class='duration'>20.07144s</span></dd>
+  </dl>
+</div>
+<div id="div_group_3" class="example_group passed">
+  <dl style="margin-left: 0px;">
+  <dt id="example_group_3" class="passed">TraceableSet</dt>
+    <script type="text/javascript">moveProgressBar('10.6');</script>
+    <dd class="example passed"><span class="passed_spec_name">should return a blank instance</span><span class='duration'>0.00019s</span></dd>
+    <script type="text/javascript">moveProgressBar('12.1');</script>
+    <dd class="example passed"><span class="passed_spec_name">allows to add Traceables</span><span class='duration'>0.00018s</span></dd>
+    <script type="text/javascript">moveProgressBar('13.6');</script>
+    <dd class="example passed"><span class="passed_spec_name">delivers the first of the duplicates</span><span class='duration'>0.00012s</span></dd>
+    <script type="text/javascript">moveProgressBar('15.1');</script>
+    <dd class="example passed"><span class="passed_spec_name">advertises duplicates</span><span class='duration'>0.00022s</span></dd>
+    <script type="text/javascript">moveProgressBar('16.6');</script>
+    <dd class="example passed"><span class="passed_spec_name">adertises undefined traceables</span><span class='duration'>0.00019s</span></dd>
+    <script type="text/javascript">moveProgressBar('18.1');</script>
+    <dd class="example passed"><span class="passed_spec_name">advertises all traceables</span><span class='duration'>0.00010s</span></dd>
+    <script type="text/javascript">moveProgressBar('19.6');</script>
+    <dd class="example passed"><span class="passed_spec_name">advertises a hash of supporting traces</span><span class='duration'>0.00011s</span></dd>
+    <script type="text/javascript">moveProgressBar('21.2');</script>
+    <dd class="example passed"><span class="passed_spec_name">advertises traceable ids of a particular category</span><span class='duration'>0.00012s</span></dd>
+    <script type="text/javascript">moveProgressBar('22.7');</script>
+    <dd class="example passed"><span class="passed_spec_name">advertises ttraceables of a particular category</span><span class='duration'>0.00010s</span></dd>
+    <script type="text/javascript">moveProgressBar('24.2');</script>
+    <dd class="example passed"><span class="passed_spec_name">merges traceables</span><span class='duration'>0.00027s</span></dd>
+    <script type="text/javascript">moveProgressBar('25.7');</script>
+    <dd class="example passed"><span class="passed_spec_name">exposes deleted Traceables</span><span class='duration'>0.00019s</span></dd>
+    <script type="text/javascript">moveProgressBar('27.2');</script>
+    <dd class="example passed"><span class="passed_spec_name">exposes added Traceables</span><span class='duration'>0.00021s</span></dd>
+    <script type="text/javascript">moveProgressBar('28.7');</script>
+    <dd class="example passed"><span class="passed_spec_name">exposes deleted Traceables of category</span><span class='duration'>0.00016s</span></dd>
+    <script type="text/javascript">moveProgressBar('30.3');</script>
+    <dd class="example passed"><span class="passed_spec_name">exposes added Traceables of category</span><span class='duration'>0.00012s</span></dd>
+    <script type="text/javascript">moveProgressBar('31.8');</script>
+    <dd class="example passed"><span class="passed_spec_name">exploses changed traceids as array of [Traceid, levensthein, diff_as_html]</span><span class='duration'>0.01376s</span></dd>
+    <script type="text/javascript">moveProgressBar('33.3');</script>
+    <dd class="example passed"><span class="passed_spec_name">exposes unchanged Traceables</span><span class='duration'>0.00513s</span></dd>
+    <script type="text/javascript">moveProgressBar('34.8');</script>
+    <dd class="example passed"><span class="passed_spec_name">can be marshalled to a file</span><span class='duration'>0.00214s</span></dd>
+    <script type="text/javascript">moveProgressBar('36.3');</script>
+    <dd class="example passed"><span class="passed_spec_name">can be dumped to a graphml file</span><span class='duration'>0.04104s</span></dd>
+  </dl>
+</div>
+<div id="div_group_4" class="example_group passed">
+  <dl style="margin-left: 0px;">
+  <dt id="example_group_4" class="passed">Traceable</dt>
+    <script type="text/javascript">moveProgressBar('37.8');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;id&quot;</span><span class='duration'>0.00026s</span></dd>
+    <script type="text/javascript">moveProgressBar('39.3');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;origin&quot;</span><span class='duration'>0.00020s</span></dd>
+    <script type="text/javascript">moveProgressBar('40.9');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;alternative_id&quot;</span><span class='duration'>0.00019s</span></dd>
+    <script type="text/javascript">moveProgressBar('42.4');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;header_plain&quot;</span><span class='duration'>0.00019s</span></dd>
+    <script type="text/javascript">moveProgressBar('43.9');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;\\textt{header_origin}&quot;</span><span class='duration'>0.00017s</span></dd>
+    <script type="text/javascript">moveProgressBar('45.4');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;body_plain&quot;</span><span class='duration'>0.00019s</span></dd>
+    <script type="text/javascript">moveProgressBar('46.9');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == [&quot;contributes_to&quot;]</span><span class='duration'>0.00015s</span></dd>
+    <script type="text/javascript">moveProgressBar('48.4');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;trace_orig&quot;</span><span class='duration'>0.00014s</span></dd>
+    <script type="text/javascript">moveProgressBar('50.0');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;origin&quot;</span><span class='duration'>0.00015s</span></dd>
+    <script type="text/javascript">moveProgressBar('51.5');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;category&quot;</span><span class='duration'>0.00012s</span></dd>
+    <script type="text/javascript">moveProgressBar('53.0');</script>
+    <dd class="example passed"><span class="passed_spec_name">should == &quot;info&quot;</span><span class='duration'>0.00014s</span></dd>
+  </dl>
+</div>
+<div id="div_group_5" class="example_group passed">
+  <dl style="margin-left: 0px;">
+  <dt id="example_group_5" class="passed">Wortsammler generic issues</dt>
+    <script type="text/javascript">moveProgressBar('54.5');</script>
+    <dd class="example passed"><span class="passed_spec_name">provides a help</span><span class='duration'>0.44483s</span></dd>
+    <script type="text/javascript">moveProgressBar('56.0');</script>
+    <dd class="example passed"><span class="passed_spec_name">can create a new project folder</span><span class='duration'>0.58100s</span></dd>
+    <script type="text/javascript">moveProgressBar('57.5');</script>
+    <dd class="example passed"><span class="passed_spec_name">does not initialize into an existing project folder</span><span class='duration'>0.45372s</span></dd>
+    <script type="text/javascript">makeYellow('rspec-header');</script>
+    <script type="text/javascript">makeYellow('div_group_5');</script>
+    <script type="text/javascript">makeYellow('example_group_5');</script>
+    <script type="text/javascript">moveProgressBar('59.0');</script>
+    <dd class="example not_implemented"><span class="not_implemented_spec_name">controls the pandoc options by document class (PENDING: implmenet test to control pandoc options by document class)</span></dd>
+  </dl>
+</div>
+<div id="div_group_6" class="example_group passed">
+  <dl style="margin-left: 0px;">
+  <dt id="example_group_6" class="passed">Wortsammler options validator</dt>
+    <script type="text/javascript">moveProgressBar('60.6');</script>
+    <dd class="example passed"><span class="passed_spec_name">rejects no processing</span><span class='duration'>0.40117s</span></dd>
+    <script type="text/javascript">moveProgressBar('62.1');</script>
+    <dd class="example passed"><span class="passed_spec_name">rejeccts inputs without outputs</span><span class='duration'>0.40486s</span></dd>
+  </dl>
+</div>
+<div id="div_group_7" class="example_group passed">
+  <dl style="margin-left: 0px;">
+  <dt id="example_group_7" class="passed">Wortsammler beautifier features</dt>
+    <script type="text/javascript">moveProgressBar('63.6');</script>
+    <dd class="example passed"><span class="passed_spec_name">beautifies all markdown files in a folder</span><span class='duration'>0.78738s</span></dd>
+    <script type="text/javascript">moveProgressBar('65.1');</script>
+    <dd class="example passed"><span class="passed_spec_name">beautifies a single file</span><span class='duration'>0.48401s</span></dd>
+    <script type="text/javascript">moveProgressBar('66.6');</script>
+    <dd class="example passed"><span class="passed_spec_name">recognizes if the specified manifest file is a directory</span><span class='duration'>0.44379s</span></dd>
+    <script type="text/javascript">moveProgressBar('68.1');</script>
+    <dd class="example passed"><span class="passed_spec_name">beautifies input files in a manifest</span><span class='duration'>0.49646s</span></dd>
+    <script type="text/javascript">moveProgressBar('69.6');</script>
+    <dd class="example passed"><span class="passed_spec_name">claims missing input</span><span class='duration'>0.43923s</span></dd>
+    <script type="text/javascript">moveProgressBar('71.2');</script>
+    <dd class="example passed"><span class="passed_spec_name">claims undefined document path</span><span class='duration'>0.43421s</span></dd>
+  </dl>
+</div>
+<div id="div_group_8" class="example_group passed">
+  <dl style="margin-left: 0px;">
+  <dt id="example_group_8" class="passed">Wortsammler conversion</dt>
+    <script type="text/javascript">moveProgressBar('72.7');</script>
+    <dd class="example passed"><span class="passed_spec_name">converts a single file to output format</span><span class='duration'>5.26633s</span></dd>
+    <script type="text/javascript">moveProgressBar('74.2');</script>
+    <dd class="example passed"><span class="passed_spec_name">converts a single file to default output format</span><span class='duration'>4.36495s</span></dd>
+    <script type="text/javascript">moveProgressBar('75.7');</script>
+    <dd class="example passed"><span class="passed_spec_name">handles chapters up to 6 levels</span><span class='duration'>7.67111s</span></dd>
+    <script type="text/javascript">moveProgressBar('77.2');</script>
+    <dd class="example passed"><span class="passed_spec_name">handles lists up to 9 levels</span><span class='duration'>4.52206s</span></dd>
+    <script type="text/javascript">moveProgressBar('78.7');</script>
+    <dd class="example passed"><span class="passed_spec_name">converts all files within a folder to output format</span><span class='duration'>0.54862s</span></dd>
+    <script type="text/javascript">moveProgressBar('80.3');</script>
+    <dd class="example passed"><span class="passed_spec_name">processes a manifest</span><span class='duration'>14.06971s</span></dd>
+    <script type="text/javascript">moveProgressBar('81.8');</script>
+    <dd class="example passed"><span class="passed_spec_name">investigates the existence of a manifest</span><span class='duration'>0.40736s</span></dd>
+    <script type="text/javascript">moveProgressBar('83.3');</script>
+    <dd class="example passed"><span class="passed_spec_name">extracts the traceables according to a manifest</span><span class='duration'>0.57014s</span></dd>
+    <script type="text/javascript">moveProgressBar('84.8');</script>
+    <dd class="example passed"><span class="passed_spec_name">extracts plantuml according to a manifest</span><span class='duration'>0.90640s</span></dd>
+    <script type="text/javascript">moveProgressBar('86.3');</script>
+    <dd class="example passed"><span class="passed_spec_name">extracts plantuml from a single file</span><span class='duration'>2.46489s</span></dd>
+    <script type="text/javascript">moveProgressBar('87.8');</script>
+    <dd class="example passed"><span class="passed_spec_name">extracts plantuml from a folder</span><span class='duration'>2.85117s</span></dd>
+    <script type="text/javascript">makeYellow('rspec-header');</script>
+    <script type="text/javascript">makeYellow('div_group_8');</script>
+    <script type="text/javascript">makeYellow('example_group_8');</script>
+    <script type="text/javascript">moveProgressBar('89.3');</script>
+    <dd class="example not_implemented"><span class="not_implemented_spec_name">processes snippets (PENDING: Test not yet implemented)</span></dd>
+    <script type="text/javascript">makeYellow('rspec-header');</script>
+    <script type="text/javascript">makeYellow('div_group_8');</script>
+    <script type="text/javascript">makeYellow('example_group_8');</script>
+    <script type="text/javascript">moveProgressBar('90.9');</script>
+    <dd class="example not_implemented"><span class="not_implemented_spec_name">handles undefined snippets (PENDING: Test not yet implemented)</span></dd>
+    <script type="text/javascript">moveProgressBar('92.4');</script>
+    <dd class="example passed"><span class="passed_spec_name">runs the rake file in the sample document</span><span class='duration'>14.54937s</span></dd>
+    <script type="text/javascript">moveProgressBar('93.9');</script>
+    <dd class="example passed"><span class="passed_spec_name">compiles all documents</span><span class='duration'>0.00024s</span></dd>
+  </dl>
+</div>
+<div id="div_group_9" class="example_group passed">
+  <dl style="margin-left: 0px;">
+  <dt id="example_group_9" class="passed">Wortsammler syntax extensions</dt>
+    <script type="text/javascript">moveProgressBar('95.4');</script>
+    <dd class="example passed"><span class="passed_spec_name">[RS_Comp_012] supports embedded images</span><span class='duration'>9.85614s</span></dd>
+    <script type="text/javascript">moveProgressBar('96.9');</script>
+    <dd class="example passed"><span class="passed_spec_name">TC_EXP_001 expands expected results from testcases</span><span class='duration'>0.02295s</span></dd>
+    <script type="text/javascript">moveProgressBar('98.4');</script>
+    <dd class="example passed"><span class="passed_spec_name">TC_EXP_002 removes plantuml sources</span><span class='duration'>0.00079s</span></dd>
     <script type="text/javascript">moveProgressBar('100.0');</script>
-    <dd class="example passed"><span class="passed_spec_name">TC_EXP_001 expands expected results from testcases</span><span class='duration'>0.00204s</span></dd>
+    <dd class="example passed"><span class="passed_spec_name">TC_EXP_003 handles Markdown inlays</span><span class='duration'>0.59397s</span></dd>
   </dl>
 </div>
-<script type="text/javascript">document.getElementById('duration').innerHTML = "Finished in <strong>0.00272 seconds</strong>";</script>
-<script type="text/javascript">document.getElementById('totals').innerHTML = "1 example, 0 failures";</script>
+<script type="text/javascript">document.getElementById('duration').innerHTML = "Finished in <strong>122.02649 seconds</strong>";</script>
+<script type="text/javascript">document.getElementById('totals').innerHTML = "66 examples, 0 failures, 3 pending";</script>
 </div>
 </div>
 </body>

data/testresults/wortsammler_testresults.log

@@ -1,7 +1,99 @@
-Run options: include {:exp=>true}
+Run options: exclude {:exp=>true}
+
+PandocBeautifier
+  checks the availability of the right pandoc version
+
+pdf utilities:
+  adjusts the bounding box of a pdf file
+  converts an excel sheet to pdf
+  converts a powerpoint to pdf
+  converts an excelsheet to cropped pdf
+  converts a powerpoint to cropped pdf
+
+TraceableSet
+  should return a blank instance
+  allows to add Traceables
+  delivers the first of the duplicates
+  advertises duplicates
+  adertises undefined traceables
+  advertises all traceables
+  advertises a hash of supporting traces
+  advertises traceable ids of a particular category
+  advertises ttraceables of a particular category
+  merges traceables
+  exposes deleted Traceables
+  exposes added Traceables
+  exposes deleted Traceables of category
+  exposes added Traceables of category
+  exploses changed traceids as array of [Traceid, levensthein, diff_as_html]
+  exposes unchanged Traceables
+  can be marshalled to a file
+  can be dumped to a graphml file
+
+Traceable
+  should == "id"
+  should == "origin"
+  should == "alternative_id"
+  should == "header_plain"
+  should == "\\textt{header_origin}"
+  should == "body_plain"
+  should == ["contributes_to"]
+  should == "trace_orig"
+  should == "origin"
+  should == "category"
+  should == "info"
+
+Wortsammler generic issues
+  provides a help
+  can create a new project folder
+  does not initialize into an existing project folder
+  controls the pandoc options by document class (PENDING: implmenet test to control pandoc options by document class)
+
+Wortsammler options validator
+  rejects no processing
+  rejeccts inputs without outputs
+
+Wortsammler beautifier features
+  beautifies all markdown files in a folder
+  beautifies a single file
+  recognizes if the specified manifest file is a directory
+  beautifies input files in a manifest
+  claims missing input
+  claims undefined document path
+
+Wortsammler conversion
+  converts a single file to output format
+  converts a single file to default output format
+  handles chapters up to 6 levels
+  handles lists up to 9 levels
+  converts all files within a folder to output format
+  processes a manifest
+  investigates the existence of a manifest
+  extracts the traceables according to a manifest
+  extracts plantuml according to a manifest
+  extracts plantuml from a single file
+  extracts plantuml from a folder
+  processes snippets (PENDING: Test not yet implemented)
+  handles undefined snippets (PENDING: Test not yet implemented)
+  runs the rake file in the sample document
+  compiles all documents
 
 Wortsammler syntax extensions
+  [RS_Comp_012] supports embedded images
   TC_EXP_001 expands expected results from testcases
+  TC_EXP_002 removes plantuml sources
+  TC_EXP_003 handles Markdown inlays
+
+Pending:
+  Wortsammler generic issues controls the pandoc options by document class
+    # implmenet test to control pandoc options by document class
+    # ./spec/wortsammler_spec.rb:35
+  Wortsammler conversion processes snippets
+    # Test not yet implemented
+    # ./spec/wortsammler_spec.rb:278
+  Wortsammler conversion handles undefined snippets
+    # Test not yet implemented
+    # ./spec/wortsammler_spec.rb:282
 
-Finished in 0.00272 seconds
-1 example, 0 failures
+Finished in 2 minutes 2.03 seconds
+66 examples, 0 failures, 3 pending

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wortsammler
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2013-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -255,14 +255,19 @@ files:
 - resources/default.wortsammler.latex
 - resources/logo.jpg
 - resources/main.md
+- resources/plantuml.jar
 - resources/rakefile.rb
 - resources/requirementsSynopsis.graphml
 - resources/sample_the-sample-document.yaml
 - resources/snippets.xlsx
 - spec/TC_EXP_001.md
+- spec/TC_EXP_002.md
+- spec/TC_EXP_003_1.md
+- spec/TC_EXP_003_2.md
 - spec/class.proolib_spec.rb
 - spec/floating-image.pdf
 - spec/pdf_utils_spec.rb
+- spec/tc_exp_003_reference.txt
 - spec/test.graphml
 - spec/traceable_spec.rb
 - spec/wortsammler_spec.rb
@@ -295,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3852503069998783980
+      hash: -3303182560829427324
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -304,9 +309,13 @@ specification_version: 3
 summary: an environment to manage documentation
 test_files:
 - spec/TC_EXP_001.md
+- spec/TC_EXP_002.md
+- spec/TC_EXP_003_1.md
+- spec/TC_EXP_003_2.md
 - spec/class.proolib_spec.rb
 - spec/floating-image.pdf
 - spec/pdf_utils_spec.rb
+- spec/tc_exp_003_reference.txt
 - spec/test.graphml
 - spec/traceable_spec.rb
 - spec/wortsammler_spec.rb