wortsammler 2.0.0.dev1 → 2.0.2.pre.dev3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cab8f2e597793900ded556ee7c7d1cdee0299af57613dbc7c0129425b0635a63
-  data.tar.gz: da644dd2b9d4c4a4fee3650651fe7ece82ca882f63ab2734ac94571dbd981a20
+  metadata.gz: 2428bb7e9beed06c7d1988f3ad4292b5fb1d5c1fbf9bbfef16abae9eb11664cc
+  data.tar.gz: df9990288e9841109da60f4ed3b081dd0aa3d40c018d06b6285bdfa8969fca51
 SHA512:
-  metadata.gz: 48d9db98c275d8376ffe9d17d1b1ab97652c15f0cc1a308e7333240f448ed6bcb43b06d8ed151dba57ec8874f86d8bbf9688ade4d69dc437add7564ad6eeaf98
-  data.tar.gz: 59738730ff8bba6669a32da61451a1ce02b10aba4a3c67b4a2363cc130be58655ee67a7aa6acaec8bc7b26eca33bee1df188a25425f2f14bfbeb2e9df3bbbf98
+  metadata.gz: e6c5abe51379ae71360a618542004def4b58217c58558b4818928e74a7ce1cfbe2eed984e834de72c04ff6234b16f2862588461d00c5889079bdada5c18d7930
+  data.tar.gz: ac7224f1f41ca6f045727b4342353b5e255b670743e91fa140ebc49f352776c80c3e96183aaeae15764a5538d92001c64c6dc748662399a2f87e1d526dfdb25e

data/.gitignore

@@ -63,3 +63,4 @@ crashlytics.properties
 crashlytics-build.properties
 fabric.properties
 
+*.log

data/.gitpod.Dockerfile

@@ -0,0 +1,32 @@
+FROM alpine:latest
+                
+
+RUN apk update &&\
+    apk add texlive-xetex texmf-dist-latexextra less
+
+# from https://github.com/cybercode/alpine-ruby/blob/master/Dockerfile
+# guess ist is to install native extensions
+
+RUN echo "http://dl-cdn.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories \
+      && apk update \
+      && apk add --update-cache postgresql-client nodejs \
+        libffi-dev readline sqlite build-base postgresql-dev \
+        libc-dev linux-headers libxml2-dev libxslt-dev readline-dev gcc libc-dev \
+      && rm -rf /var/cache/apk/*
+
+RUN apk update && apk upgrade && apk --update add \
+    ruby ruby ruby-dev ruby-irb ruby-rake ruby-io-console ruby-bigdecimal ruby-json ruby-bundler ruby-rspec \
+    libstdc++ tzdata bash ca-certificates \
+    &&  echo 'gem: --no-document' > /etc/gemrc\
+# from https://hub.docker.com/r/ciandt/docker-alpine-pandoc/dockerfile^\
+# install pandoc
+RUN \
+    apk add ca-certificates wget \
+    && wget -O /tmp/pandoc.tar.gz https://github.com/jgm/pandoc/releases/download/2.5/pandoc-2.5-linux.tar.gz \
+    && tar xvzf /tmp/pandoc.tar.gz --strip-components 1 -C /usr/local/ \
+    && ln /usr/local/bin/pandoc /usr/local/bin/pandoc_2.5 \
+    && update-ca-certificates \
+    && apk del wget ca-certificates\
+    && rm /tmp/pandoc.tar.gz
+
+ RUN apk update && apk add ghostscript   

data/.gitpod.yml

@@ -0,0 +1 @@
+{ image: { file: .gitpod.Dockerfile } }

data/README.md

@@ -1,3 +1,5 @@
+[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/bwl21/wortsammler) 
+
 # Wortsammler
 
 > **plaease note**

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

@@ -13,6 +13,10 @@ Treetop.load File.dirname(__FILE__) + "/mdTraceParser.treetop"
 class TraceableSet
 
 
+  def mk_hyperlink(id)
+    idm = id.gsub("_","-")
+    "[\[#{id}\]](#RT-#{idm})"
+  end
 
   # this generates a synopsis of traces in markdown Format
   # @param [Symbol] selectedCategory the the category of the Traceables
@@ -23,20 +27,18 @@ class TraceableSet
     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>"}
+      lContributes = t.contributes_to.
+          map { |c| mk_hyperlink(c) }
 
       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}"
+        "    - #{mk_hyperlink(u.id)} #{u.header_orig}"
       }
 
-      ["- ->[#{t.id}] <!-- --> <a id=\"RT-#{tidm}\"/>**#{t.header_orig}**" +
+      ["- #{mk_hyperlink(t.id)} <!-- --> <a id=\"RT-#{tidm}\"/>**#{t.header_orig}**" +
        #                     "  (#{t.contributes_to.join(', ')})", "",
        "  (#{lContributes.join(', ')})", "",
        luptraces
@@ -50,7 +52,7 @@ class TraceableSet
     all_traces(selectedCategory).
       sort_by{|x| trace_order_index(x.id) }.
     map{|t|
-      "\n\n[#{t.id}] **#{t.header_orig}** { }()"
+      "\n\n\\[#{t.id}\\] **#{t.header_orig}** { }()"
     }.join("\n\n")
   end
 

data/lib/wortsammler/class.Traceable.rb

@@ -23,16 +23,16 @@ class TraceableSet
   # @return [type] [description]
   def initialize()
     # the traces
-    @traces={}
+    @traces = {}
 
     # the list of supporters
     # supporters for foo 0 @@supported_by["foo"]
-    @supported_by={}
+    @supported_by = {}
 
 
     # define the sort order policy
     # it is the same for all slots
-    @sortOrder=[]
+    @sortOrder = []
 
   end
 
@@ -63,7 +63,7 @@ class TraceableSet
   # @param  category  [Symbol] Restrict the comparison to a particlar category
   #
   # @return [Array] the ids of the added traces (list of trace_id which are not in @referece_set)
-  def added_trace_ids(reference_set, category=nil)
+  def added_trace_ids(reference_set, category = nil)
     self.all_trace_ids(category) - reference_set.all_trace_ids(category)
   end
 
@@ -74,9 +74,9 @@ class TraceableSet
   # @param  category [Symbol] Restrict the operation to traceables of this category.
   #
   # @return [Array] List of trace_id which changed not in reference_set
-  def changed_trace_ids(reference_set, category=nil)
-    candidates=self.all_trace_ids(category) & reference_set.all_trace_ids(category)
-    candidates.map{|candidate|
+  def changed_trace_ids(reference_set, category = nil)
+    candidates = self.all_trace_ids(category) & reference_set.all_trace_ids(category)
+    candidates.map { |candidate|
       self[candidate].get_diff(reference_set[candidate])
     }.compact
   end
@@ -87,9 +87,9 @@ class TraceableSet
   # @param  category [Symbol] Restrict the operation to traceables of this category.
   #
   # @return [Array] List of trace_id which unchanged
-  def unchanged_trace_ids(reference_set, category=nil)
-    candidates=self.all_trace_ids(category) & reference_set.all_trace_ids(category)
-    candidates.select{|candidate|
+  def unchanged_trace_ids(reference_set, category = nil)
+    candidates = self.all_trace_ids(category) & reference_set.all_trace_ids(category)
+    candidates.select { |candidate|
       self[candidate].get_diff(reference_set[candidate]).nil?
     }.compact
   end
@@ -101,7 +101,7 @@ class TraceableSet
   # @param  category [Symbol] Restrict the operation to traceables of this category.
   #
   # @return [Array] List of trace_id which are deleted (not in current set)
-  def deleted_trace_ids(reference_set, category=nil)
+  def deleted_trace_ids(reference_set, category = nil)
     reference_set.all_trace_ids(category) - self.all_trace_ids(category)
   end
 
@@ -109,31 +109,31 @@ class TraceableSet
   # export the trace as graphml for yed
   # @return - the requirements tree in graphml
   def to_graphml
-    f = File.open("#{File.dirname(__FILE__)}/../../resources/requirementsSynopsis.graphml")
+    f   = File.open("#{File.dirname(__FILE__)}/../../resources/requirementsSynopsis.graphml")
     doc = Nokogiri::XML(f)
     f.close
 
-    graph=doc.xpath("//xmlns:graph").first
+    graph = doc.xpath("//xmlns:graph").first
 
     # generate all nodes
-    self.all_traces(nil).each{|theTrace|
-      n_node = Nokogiri::XML::Node.new "node", doc
-      n_node["id"] = theTrace.id
-      n_data = Nokogiri::XML::Node.new "data", doc
-      n_data["key"]= "d6"
-      n_ShapeNode = Nokogiri::XML::Node.new "y:ShapeNode", doc
-      n_NodeLabel = Nokogiri::XML::Node.new "y:NodeLabel", doc
+    self.all_traces(nil).each { |theTrace|
+      n_node              = Nokogiri::XML::Node.new "node", doc
+      n_node["id"]        = theTrace.id
+      n_data              = Nokogiri::XML::Node.new "data", doc
+      n_data["key"]       = "d6"
+      n_ShapeNode         = Nokogiri::XML::Node.new "y:ShapeNode", doc
+      n_NodeLabel         = Nokogiri::XML::Node.new "y:NodeLabel", doc
       n_NodeLabel.content = "[#{theTrace.id}] #{theTrace.header_orig}"
       n_ShapeNode << n_NodeLabel
       n_data << n_ShapeNode
       n_node << n_data
       graph << n_node
 
-      theTrace.contributes_to.each{|up|
-        n_edge=Nokogiri::XML::Node.new "edge", doc
-        n_edge["source" ] = theTrace.id
-        n_edge["target" ] = up
-        n_edge["id"     ] = "#{up}_#{theTrace.id}"
+      theTrace.contributes_to.each { |up|
+        n_edge           = Nokogiri::XML::Node.new "edge", doc
+        n_edge["source"] = theTrace.id
+        n_edge["target"] = up
+        n_edge["id"]     = "#{up}_#{theTrace.id}"
         graph << n_edge
       }
     }
@@ -146,7 +146,7 @@ class TraceableSet
   # @return [Array of String] an array of the registered Traceables
   #                              of the selectedCategory
   def all_trace_ids(selected_category = nil)
-    @traces.keys.select{|x|
+    @traces.keys.select { |x|
       y = @traces[x].first
       selected_category.nil? or y.category == selected_category
     }.sort
@@ -161,7 +161,7 @@ class TraceableSet
   #
   # @return [Array of Traceable] The array of traceables
   def all_traces(selected_category = nil)
-    all_trace_ids(selected_category).map{|t| @traces[t].first}
+    all_trace_ids(selected_category).map { |t| @traces[t].first }
   end
 
 
@@ -187,43 +187,43 @@ class TraceableSet
   # this lists duplicate traces
   # @return [Array of String] the list of the id of duplicate Traces
   def duplicate_ids()
-    @traces.select{|id, traceables| traceables.length > 1}.map{|id, traceable| id}.sort
+    @traces.select { |id, traceables| traceables.length > 1 }.map { |id, traceable| id }.sort
   end
 
   # this lists duplicate traces
   # @return [Array of Traceable] the list duplicate Traces.
   def duplicate_traces()
-    @traces.select{|id, traceables| traceables.length > 1}.map{|id, traceable| traceable}.sort
+    @traces.select { |id, traceables| traceables.length > 1 }.map { |id, traceable| traceable }.sort
   end
 
 
   # this serializes a particular slot for caching
   # @param file [String] name of the cachefile
   def dump_to_marshal(file)
-    File.open(file, "wb"){|f|
+    File.open(file, "wb") { |f|
       Marshal.dump(self, f)
     }
   end
 
   # this loads cached information into a particular slot
   # @param file [String] name of the cachefile
-  def  self.load_from_marshal(file)
-    a=nil
-    File.open(file, "rb"){|f| a=Marshal.load(f)}
+  def self.load_from_marshal(file)
+    a = nil
+    File.open(file, "rb") { |f| a = Marshal.load(f) }
     a
   end
 
   # this merges a TraceableSet
   # @return [Treaceable] the current traceable set
   def merge(set)
-    set.all_traces_as_arrays.values.flatten.each{|t| self.add(t)}
+    set.all_traces_as_arrays.values.flatten.each { |t| self.add(t) }
   end
 
   # this retunrs traces marked as supported but not being defined
   # @return [Array of String] the list of the id of undefined Traces
   #         traces which are marked as uptraces but do not exist.
   def undefined_ids
-    @supported_by.keys.select{|t| not @traces.has_key?(t)}.sort
+    @supported_by.keys.select { |t| not @traces.has_key?(t) }.sort
   end
 
   #
@@ -243,7 +243,7 @@ class TraceableSet
   # it is placed according to the sequence
   # in the array. Otherwise it is sorted at the end
   def sort_order= (sort_order)
-    @sort_order=sort_order
+    @sort_order = sort_order
   end
 
   # this determines the sort order index of a trace
@@ -252,11 +252,11 @@ class TraceableSet
   #                 the sort order index shall be coumputed.
   # @return [String] the sort key of the given id.
   def trace_order_index(trace_id)
-    global=@sort_order.index{|x| trace_id.start_with? x} ||
-      (@sort_order.length+1)
+    global = @sort_order.index { |x| trace_id.start_with? x } ||
+        (@sort_order.length + 1)
 
     # add the {index} of the trace to
-    orderId = [global.to_s.rjust(5,"0"),trace_id].join("_")
+    orderId = [global.to_s.rjust(5, "0"), trace_id].join("_")
     orderId
   end
 
@@ -272,11 +272,10 @@ class TraceableSet
   #
   # @return [type] [description]
   def to_compareEntries
-    all_traces.sort.map{|t| "\n\n[#{t.id}]\n#{t.as_oneline}" }.join("\n")
+    all_traces.sort.map { |t| "\n\n[#{t.id}]\n#{t.as_oneline}" }.join("\n")
   end
 
 
-
   #############################
 
   private
@@ -286,7 +285,7 @@ class TraceableSet
   # @param [Nokogiri::XML::Document] doc - the document
   # @return [Nokogiri::XML::Document] the beautified document
   def xp(doc)
-    xsl =<<-XSL
+    xsl = <<-XSL
     <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
     <xsl:output method="xml" encoding="UTF-8" indent="yes"/>
     <xsl:strip-space elements="*"/>
@@ -307,16 +306,19 @@ class TraceableSet
 end
 
 
+class Traceable
 
+  def clear_trace_id(id)
+    id.gsub("\\_", "_")
+  end
 
-class Traceable
   include Comparable
 
 
   # String: The trace-Id
-  attr_accessor :id
+  attr_reader :id
   # string: the alternative Id, used e.g. for the constraint number
-  attr_accessor :alternative_id
+  attr_reader :alternative_id
   # String: The header in plain text
   attr_accessor :header_plain
   # String: The header in original format
@@ -326,7 +328,7 @@ class Traceable
   # String: he body in original format
   attr_accessor :body_orig
   # Array of Strings: The uplink as an array of Trace-ids
-  attr_accessor :contributes_to
+  attr_reader :contributes_to
   # String: the Traceable in its original format
   attr_accessor :trace_orig
   # String: origin of the entry
@@ -338,18 +340,30 @@ class Traceable
 
 
   def initialize()
-    @id = ""
+    @id             = ""
     @alternative_id = ""
-    @header_orig = ""
-    @body_plain = ""
-    @body_orig = ""
+    @header_orig    = ""
+    @body_plain     = ""
+    @body_orig      = ""
     @contributes_to = []
-    @trace_orig = ""
-    @category = ""
-    @info = ""
+    @trace_orig     = ""
+    @category       = ""
+    @info           = ""
+  end
+
+  def id=(id)
+    @id = clear_trace_id(id)
+  end
+
+  def alternative_id=()
+    @alternative_id = clear_trace_id(id)
+  end
+
+  def contributes_to=(list)
+    @contributes_to = list.map { |id| id = clear_trace_id(id) }
   end
 
-  # define the comparison to makeit really comaprable
+  # define the comparison to makeit really comparable
   # @param [Traceable] other the other traceable for comparison.
   def <=> (other)
     @id <=> other.id
@@ -366,19 +380,19 @@ class Traceable
     if newval == oldval
       result = nil
     else
-      diff_as_html= "<pre>#{other.trace_orig}</pre><hr/><pre>#{self.trace_orig}</pre>"#Diffy::Diff.new(other.trace_orig, self.trace_orig).to_s(:text)
-      rawDiff = Diffy::Diff.new(self.trace_orig, other.trace_orig)
-      diff_as_html=rawDiff.to_s(:html)
+      diff_as_html = "<pre>#{other.trace_orig}</pre><hr/><pre>#{self.trace_orig}</pre>" #Diffy::Diff.new(other.trace_orig, self.trace_orig).to_s(:text)
+      rawDiff      = Diffy::Diff.new(self.trace_orig, other.trace_orig)
+      diff_as_html = rawDiff.to_s(:html)
 
-      result = [self.id, similarity, diff_as_html]
-      diff_as_html=nil
+      result       = [self.id, similarity, diff_as_html]
+      diff_as_html = nil
     end
     result
   end
 
 
   def get_comparison_string
-    "#{header_orig};#{body_orig};#{contributes_to.sort}".gsub(/\s+/," ")
+    "#{header_orig};#{body_orig};#{contributes_to.sort}".gsub(/\s+/, " ")
   end
 
   def as_oneline

data/lib/wortsammler/class.proolib.rb

@@ -42,15 +42,15 @@ 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+"(.+)"~~/x
+INCLUDE_MD_PATTERN = /(\s*)~~MD\s+\\?"(.+)\\?"~~/x
 
 SNIPPET_PATTERN = /(\s*)~~SN \s+ (\w+)~~/x
 
 EMBEDDED_IMAGE_PATTERN = /~~EMBED\s+ "(.+)" \s+ (r|l|i|o) \s+ (.+) \s+ (.+)~~/x
 
-EXPECTED_RESULT_PATTERN = /(^\s*)~~~~\s*\{.expectedResult\s+label=\"([A-Za-z]+_[A-Za-z]+_[0-9]+)\"}\s([^~]*)~~~~/x
+EXPECTED_RESULT_PATTERN = /(^\s*)[~`]{3,}\s*\{.expectedResult\s+label=\"([A-Za-z]+\\?_[A-Za-z]+\\?_[0-9]+)\"}\s([^~`]+)[~`]{3,}/x
 
-PLANTUML_PATTERN = /[~`]{3,}\s+{\.plantuml}\s+@startuml\s+([^\n]+)(\s+title\s+([^\n]+))?[^~`]+[~`]{3,}/x
+PLANTUML_PATTERN = /[~`]{3,}\s+{\.plantuml}\s+@startuml\s+([^\n]+)(\s+title\s+([^\n]+))?[^~`]+ v/x
 
 #
 # This mixin convertes a file path to the os Path representation
@@ -161,19 +161,22 @@ class ReferenceTweaker
   # @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, :encoding => 'bom|utf-8').read
+      infile = $2.gsub("\\_", "_")
+      if File.exist?(infile) then
+        replacetext_raw = File.open(infile, :encoding => 'bom|utf-8').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}")
+          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}")
+        else
+          replacetext = replacetext_raw
         end
       else
-        replacetext=""
+        replacetext = ""
         @log.warn("File not found: #{$2}")
       end
-      result=replace_md_inlay(replacetext)
+      result = replace_md_inlay(replacetext)
       result
     }
     text
@@ -450,8 +453,8 @@ class PandocBeautifier
   def initialize(logger = nil)
 
     @markdown_output_switches = %w{
-     -backtick_code_blocks
-     +fenced_code_blocks
+     +backtick_code_blocks
+     -fenced_code_blocks
      +compact_definition_lists
      +space_in_atx_header
      +yaml_metadata_block
@@ -459,6 +462,7 @@ class PandocBeautifier
 
     @markdown_input_switches = %w{
      +smart
+     +backtick_code_blocks
      +fenced_code_blocks
      +compact_definition_lists
      -space_in_atx_header
@@ -531,15 +535,6 @@ class PandocBeautifier
 
     # tweak the quoting
     if $?.success? then
-      # do this twice since the replacement
-      # does not work on e.g. 2\_3\_4\_5.
-      #
-      newdoc.gsub!(/(\w)\\_(\w)/, '\1_\2')
-      newdoc.gsub!(/(\w)\\_(\w)/, '\1_\2')
-
-      # fix more quoting
-      newdoc.gsub!('-\\>[', '->[')
-
       # (RS_Mdc)
       # TODO: fix Table width toggles sometimes
       if (not olddoc == newdoc) then ##only touch the file if it is really changed
@@ -687,7 +682,7 @@ class PandocBeautifier
 
     #now combine the input files
     @log.debug("combining the input files #{inputname} et al")
-    cmd="#{PANDOC_EXE} --standalone -o #{output} --ascii #{inputs}" # note that inputs is already quoted
+    cmd="#{PANDOC_EXE} -f markdown#{@markdown_input_switches} --standalone -t markdown#{@markdown_output_switches} -o #{output} --ascii #{inputs}" # note that inputs is already quoted
     system(cmd)
     if $?.success? then
       PandocBeautifier.new().beautify(output)
@@ -959,7 +954,7 @@ class PandocBeautifier
     begin
       vars_string=vars.map.map { |key, value| "-V #{key}=#{value.esc}" }.join(" ")
     rescue
-      require 'pry'; binding.pry
+     #todo require 'pry'; binding.pry
     end
 
     @log.info("rendering  #{outname} as [#{format.join(', ')}]")
@@ -1057,7 +1052,6 @@ class PandocBeautifier
 
         cmd="#{PANDOC_EXE} -f markdown#{@markdown_input_switches} #{tempfileHtml.esc} --toc --standalone --self-contained --ascii --number-sections  #{vars_string}" +
             " -t plain+smart -o  #{outfileText.esc}"
-        puts cmd
         `#{cmd}`
       end