wortsammler 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+testproject

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wortsammler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bernhard Weichel
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# Wortsammler
+
+Wortsammler (colloquial German for *word collector*) is an environment
+to maintain doucmentation in markdown and publish it in various formats
+for different audiences. It originated in some project specific hacks
+wrapping around [pandoc][]. But now I refactored it since I use it in
+more than two projects now and think it might be beneficial for others
+as well.
+
+Typical application of Wortsammler is user manuals, project documents,
+user manuals.
+
+Particular features of wortsammler are
+
+-   various output formats
+-   support of requirement management
+-   generate documents for different audiences based on single sources
+-   support for snippets
+-   include parts from other PDF files (only for pdf output yet)
+
+Basically Wortsammler comprises of
+
+-   a directory structure for source document sources
+-   a manifest file to control the publication process
+    -   involved input files
+    -   expected output formats
+    -   expected editions
+    -   Requirements tracing (upstream / downstream)
+
+-   a command line tool to produce the doucments (`wortsammler`)
+
+Wortsammler is built on top of other open source tools, in particular:
+
+-   pandoc
+-   LaTeX
+-   ruby and a bunch of gems
+
+I did not invent new markdown syntax to implement the features mentioned
+aforehead. In other words, any wortsammler flavored markdown file should
+reasonably be processed in standalone pandoc. I implemented particular
+patterns which are boiled down to either vanilla pandoc markdown or to
+LaTeX / HTML.
+
+The features are based on three appraoches:
+
+1.  particular pattern in existing markdown
+2.  embedded HTML/LaTeX
+3.  specific syntax in strikethrouh sections (e.g. ~~ED simple~~)
+
+## Installation
+
+    $ gem install wortsammler
+
+In order to use Wortsammler, you need to install the prerequisites:
+
+-   ruby 1.9.3 of course
+-   pandoc 1.9.4.2 or above
+
+    I plan to upgrade to 1.11.1 asap
+
+-   tex, in particular xelatex 3.1415926-2.4-0.9998
+
+## getting started
+
+### display the options
+
+    Wortsammler -h
+
+### process markdown files
+
+    Wortsammler -pi readme.md -o.  
+       -- generates readme.pdf
+
+    Wortsammler -pi readme.md -f pdf:docx:html -o. 
+        -- generates readme.pdf, readme.html, readme.docx
+
+    Wortsammler -bi readme.md
+        -- beautifies readme.md (normalizes the markdown)
+
+    Wortsammler -bi .
+        -- recursively beautifies all markdown files in the current folder    
+
+### initialize a project
+
+    Wortsammler init <folder>
+
+This command generates the proposed directory structure, a first
+document manifest and a rake file to do the processing.
+
+The rakefile is in `<folder>/30_Sources/ZSUPP_Tools`
+
+### generate document
+
+    rake -T           -- show all rake tasks
+    rake sample       -- format the sample document
+
+## known issues
+
+-   as usual documentation is not complete
+-   requirement collection only works via manifest
+-   some features (in particular referencing) should use pandoc 1.11
+    features
+-   HTML and DOCX styling does not work
+-   It extends `String`
+-   Specific syntax in strikethrough is still processed as one line
+    which is not very robust
+-   as of now the "framework" is hard to use in other applications
+
+## future plans
+
+-   provide a sublime text package
+-   improve documentation (it is flying around in German and needs to be
+    consolidated)
+-   support epub
+
+## contributing
+
+1.  play with it
+2.  give feedback to <bernhard.weichel@googlemail.com> and/or create
+    issues
+3.  Fork it
+4.  Create your feature branch (`git checkout -b my-new-feature`)
+5.  Commit your changes (`git commit -am 'Add some feature'`)
+6.  Push to the branch (`git push origin my-new-feature`)
+7.  Create new Pull Request
+
+## thanks to
+
+-   John Mc Farlane for [pandoc][]
+
+  [pandoc]: http://johnmacfarlane.net/pandoc/

data/Rakefile

@@ -0,0 +1,34 @@
+require "bundler/gem_tasks"
+require 'rake/clean'
+require 'rspec/core/rake_task'
+#require 'ruby-debug'
+ 
+CLEAN << "testproject"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rspec_opts = ['-d -fd -fd --out ./testresults/wortsammler_testresults.log -fh --out ./testresults/wortsammler_testresults.html']
+  # Put spec opts in a file named .rspec in root
+end
+ 
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+desc "create documentation"
+task :doc do
+	sh "bin/wortsammler -bi README.md"
+	sh "bin/wortsammler -pi README.md -o ."
+	sh "yard doc"
+end
+
+desc "run tests"
+task :test => [:clean, :spec]
+
+task :default do
+	rake -T
+end	

data/bin/wortsammler

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# 
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require "wortsammler/exe.wortsammler.rb"

data/lib/wortsammler/class.Traceable.md.rb

@@ -0,0 +1,104 @@
+#
+# this mixin represents the TeX specific methods of Traceable
+#
+#require 'ruby-debug' if not RUBY_PLATFORM=="i386-mingw32"
+require 'treetop'
+require File.dirname(__FILE__) + "/class.treetophelper"
+require File.dirname(__FILE__) + "/class.Traceable"
+require File.dirname(__FILE__) + "/class.Traceable.md"
+
+Treetop.load File.dirname(__FILE__) + "/mdTraceParser.treetop"
+
+
+class TraceableSet
+    
+
+
+    # this generates a synopsis of traces in markdown Format
+    # @param [Symbol] selectedCategory the the category of the Traceables
+    #                 which shall be reported.
+    def reqtraceSynopsis(selectedCategory)
+        all_traces(selectedCategory).
+            sort_by{|x| trace_order_index(x.id) }.
+            map{|t|
+                 tidm=t.id.gsub("_","-")
+    
+                 lContributes=t.contributes_to.
+    #                  map{|c| cm=c.gsub("_","-"); "[\[#{c}\]](#RT-#{cm})"}
+                       map{|c| cm=c.gsub("_","-"); "<a href=\"#RT-#{cm}\">\[#{c}\]</a>"}
+                       
+                   luptraces = [uptrace_ids[t.id]].flatten.compact.map{|x| self[x]}
+                   
+                   luptraces=luptraces.
+                       sort_by{|x| trace_order_index(x.id)}.            
+                       map{|u|
+                       um = u.id.gsub("_","-")
+                       "    - <a href=\"#RT-#{um}\">[#{u.id}]</a> #{u.header_orig}"
+                       }      
+    
+                 ["- ->[#{t.id}] <!-- --> <a id=\"RT-#{tidm}\"/>**#{t.header_orig}**" +
+    #                     "  (#{t.contributes_to.join(', ')})", "",
+                          "  (#{lContributes.join(', ')})", "",
+                          luptraces
+                ].flatten.join("\n")
+            }.join("\n\n")
+    end
+
+
+    # this generates the downstream_tracefile
+    def to_downstream_tracefile(selectedCategory)
+         all_traces(selectedCategory).
+            sort_by{|x| trace_order_index(x.id) }.
+            map{|t|
+                 "\n\n[#{t.id}] **#{t.header_orig}** { }()"
+               }.join("\n\n")
+    end
+
+# this generates the todo - list
+
+# TODO: add this method
+
+# this method processes all traces in a particular file
+# @param [String] mdFile name of the Markdown file which shall
+#                 be scanned.
+    def self.processTracesInMdFile(mdFile)
+        
+        parser=TraceInMarkdownParser.new
+        parser.consume_all_input = true
+        
+        raw_md_code_file=File.open(mdFile)
+        raw_md_code = raw_md_code_file.readlines.join
+        raw_md_code_file.close
+#       print mdFile
+        result = parser.parse(raw_md_code)
+#       print " ... parsed\n" todo: use logger here
+        
+        result_set = TraceableSet.new
+
+        if result
+            result.descendant.select{|x| x.getLabel==="trace"}.each{|c|
+                id       = c.traceId.payload.text_value
+                uptraces = c.uptraces.payload.text_value
+                header   = c.traceHead.payload.text_value
+                bodytext = c.traceBody.payload.text_value
+                uptraces = c.uptraces.payload.text_value
+                # Populate the Traceable entry
+                theTrace = Traceable.new
+                theTrace.info           = mdFile
+                theTrace.id             = id
+                theTrace.header_orig    = header
+                theTrace.body_orig      = bodytext
+                theTrace.trace_orig     = c.text_value
+                theTrace.contributes_to = uptraces.gsub!(/\s*/, "").split(",")
+                theTrace.category       = :SPECIFICATION_ITEM
+                result_set.add(theTrace)
+            }
+#            puts " .... finished"
+            else
+            puts ["","-----------", texFile, parser.failure_reason].join("\n")
+        end
+        result_set
+    end
+
+    
+end