dim-toolkit 2.1.1 → 2.2.0

data/lib/dim/exporter/rst.rb

@@ -1,142 +1,142 @@
-require 'json'
-
-module Dim
-  class Rst < ExporterInterface
-    EXPORTER['rst'] = self
-
-    def initialize(loader)
-      super(loader)
-      @hasIndex = true
-    end
-
-    def document(f, name)
-      raw_html_name = ':raw-html:`' + name + '`'
-      f.puts raw_html_name
-      f.puts '=' * raw_html_name.length
-      @lastHeadingLevel = 0
-      @moduleName = name
-    end
-
-    def metadata(f, meta)
-      f.puts ''
-      f.puts html(meta.strip.escape_html, with_space: false)
-    end
-
-    def level2char(level)
-      { 0 => '=',
-        1 => '-',
-        2 => '+',
-        3 => '~',
-        4 => '^',
-        5 => '"' }.fetch(level, '"')
-    end
-
-    def html(elem, with_space: true)
-      return if elem.empty?
-
-      with_space ? " :raw-html:`#{elem}`" : ":raw-html:`#{elem}`"
-    end
-
-    def handle_empty_value(value)
-      return '' if value.empty?
-
-      ' ' + (value.is_a?(Array) ? value.join(', ') : value)
-    end
-
-    def createMultiLanguageElement(r, name)
-      lang_elems = r.data.keys.select { |k| k.start_with?("#{name}_") && !r.data[k].empty? }.sort
-      if lang_elems.empty?
-        return r.data[name].empty? ? '' : r.data[name]
-      end
-
-      str = (r.data[name].empty? ? '-' : r.data[name])
-      lang_elems.each do |l|
-        str << "<br><br><b>#{l.split('_').map(&:capitalize).join(' ')}: </b>"
-        str << r.data[l]
-      end
-      str
-    end
-
-    def requirement(f, r)
-      r.data.each { |k, v| r.data[k] = v.strip.escape_html }
-
-      if r.data['type'].start_with?('heading')
-        (@lastHeadingLevel + 1...r.depth).each do |l|
-          str = '<Skipped Heading Level>'
-          f.puts ''
-          f.puts str
-          f.puts level2char(l) * str.length
-        end
-        f.puts ''
-        str = ':raw-html:`' + r.data['text'] + '`'
-        f.puts str
-        f.puts level2char(r.depth) * str.length
-        @lastHeadingLevel = r.depth
-        return
-      end
-
-      r.data['tester'].gsub!('<br>', ' ')
-      r.data['developer'].gsub!('<br>', ' ')
-      text = createMultiLanguageElement(r, 'text')
-      comment = createMultiLanguageElement(r, 'comment')
-      refs = r.data['refs'].cleanUniqArray.select do |ref|
-        !@loader.requirements.has_key?(ref) || !@loader.requirements[ref].type.start_with?('heading')
-      end
-      tags = r.data['tags'].cleanUniqString
-      sources = r.data['sources'].cleanUniqString
-
-      f.puts ''
-      f.puts ".. #{r.data['type']}:: #{r.id}"
-      f.puts "    :category: #{r.category}"
-      f.puts "    :status: #{r.data['status']}"
-      f.puts "    :review_status: #{r.data['review_status']}"
-      f.puts "    :asil: #{r.data['asil']}"
-      f.puts "    :cal: #{r.data['cal']}"
-      f.puts "    :tags:#{handle_empty_value(tags)}"
-      f.puts "    :comment:#{html(comment)}"
-      f.puts "    :miscellaneous:#{html(r.data['miscellaneous'])}"
-      f.puts "    :refs:#{handle_empty_value(refs)}"
-      @loader.custom_attributes.each_key do |custom_attribute|
-        f.puts "    :#{custom_attribute}:#{handle_empty_value(r.data[custom_attribute])}"
-      end
-      if r.data['type'] == 'requirement'
-        vc = createMultiLanguageElement(r, 'verification_criteria')
-
-        f.puts "    :sources:#{handle_empty_value(sources)}"
-        f.puts "    :feature:#{html(r.data['feature'])}"
-        f.puts "    :change_request:#{html(r.data['change_request'])}"
-        f.puts "    :developer:#{handle_empty_value(r.data['developer'])}"
-        f.puts "    :tester:#{handle_empty_value(r.data['tester'])}"
-        f.puts "    :verification_methods:#{handle_empty_value(r.data['verification_methods'])}"
-        f.puts "    :verification_criteria:#{html(vc)}"
-      end
-
-      f.puts "\n   #{html(text)}" unless text.empty?
-    end
-
-    def footer(f)
-      files = @loader.module_data[@moduleName][:files].values.flatten
-      return if files.empty?
-
-      f.puts ''
-      f.puts '.. enclosed::'
-      f.puts ''
-      files.each do |file|
-        f.puts "    #{file}"
-      end
-    end
-
-    def index(f, category, origin, modules)
-      caption = category.capitalize + ' (' + origin + ')'
-      f.puts caption
-      f.puts '=' * caption.length
-      f.puts ''
-      f.puts '.. toctree::'
-      f.puts '  :maxdepth: 1'
-      f.puts ''
-      modules.sort.each do |m|
-        f.puts "  #{m.sanitize}/Requirements"
-      end
-    end
-  end
-end
+require 'json'
+
+module Dim
+  class Rst < ExporterInterface
+    EXPORTER['rst'] = self
+
+    def initialize(loader)
+      super(loader)
+      @hasIndex = true
+    end
+
+    def document(f, name)
+      raw_html_name = ':raw-html:`' + name + '`'
+      f.puts raw_html_name
+      f.puts '=' * raw_html_name.length
+      @lastHeadingLevel = 0
+      @moduleName = name
+    end
+
+    def metadata(f, meta)
+      f.puts ''
+      f.puts html(meta.strip.escape_html, with_space: false)
+    end
+
+    def level2char(level)
+      { 0 => '=',
+        1 => '-',
+        2 => '+',
+        3 => '~',
+        4 => '^',
+        5 => '"' }.fetch(level, '"')
+    end
+
+    def html(elem, with_space: true)
+      return if elem.empty?
+
+      with_space ? " :raw-html:`#{elem}`" : ":raw-html:`#{elem}`"
+    end
+
+    def handle_empty_value(value)
+      return '' if value.empty?
+
+      ' ' + (value.is_a?(Array) ? value.join(', ') : value)
+    end
+
+    def createMultiLanguageElement(r, name)
+      lang_elems = r.data.keys.select { |k| k.start_with?("#{name}_") && !r.data[k].empty? }.sort
+      if lang_elems.empty?
+        return r.data[name].empty? ? '' : r.data[name]
+      end
+
+      str = (r.data[name].empty? ? '-' : r.data[name])
+      lang_elems.each do |l|
+        str << "<br><br><b>#{l.split('_').map(&:capitalize).join(' ')}: </b>"
+        str << r.data[l]
+      end
+      str
+    end
+
+    def requirement(f, r)
+      r.data.each { |k, v| r.data[k] = v.strip.escape_html }
+
+      if r.data['type'].start_with?('heading')
+        (@lastHeadingLevel + 1...r.depth).each do |l|
+          str = '<Skipped Heading Level>'
+          f.puts ''
+          f.puts str
+          f.puts level2char(l) * str.length
+        end
+        f.puts ''
+        str = ':raw-html:`' + r.data['text'] + '`'
+        f.puts str
+        f.puts level2char(r.depth) * str.length
+        @lastHeadingLevel = r.depth
+        return
+      end
+
+      r.data['tester'].gsub!('<br>', ' ')
+      r.data['developer'].gsub!('<br>', ' ')
+      text = createMultiLanguageElement(r, 'text')
+      comment = createMultiLanguageElement(r, 'comment')
+      refs = r.data['refs'].cleanUniqArray.select do |ref|
+        !@loader.requirements.has_key?(ref) || !@loader.requirements[ref].type.start_with?('heading')
+      end
+      tags = r.data['tags'].cleanUniqString
+      sources = r.data['sources'].cleanUniqString
+
+      f.puts ''
+      f.puts ".. #{r.data['type']}:: #{r.id}"
+      f.puts "    :category: #{r.category}"
+      f.puts "    :status: #{r.data['status']}"
+      f.puts "    :review_status: #{r.data['review_status']}"
+      f.puts "    :asil: #{r.data['asil']}"
+      f.puts "    :cal: #{r.data['cal']}"
+      f.puts "    :tags:#{handle_empty_value(tags)}"
+      f.puts "    :comment:#{html(comment)}"
+      f.puts "    :miscellaneous:#{html(r.data['miscellaneous'])}"
+      f.puts "    :refs:#{handle_empty_value(refs)}"
+      @loader.custom_attributes.each_key do |custom_attribute|
+        f.puts "    :#{custom_attribute}:#{handle_empty_value(r.data[custom_attribute])}"
+      end
+      if r.data['type'] == 'requirement'
+        vc = createMultiLanguageElement(r, 'verification_criteria')
+
+        f.puts "    :sources:#{handle_empty_value(sources)}"
+        f.puts "    :feature:#{html(r.data['feature'])}"
+        f.puts "    :change_request:#{html(r.data['change_request'])}"
+        f.puts "    :developer:#{handle_empty_value(r.data['developer'])}"
+        f.puts "    :tester:#{handle_empty_value(r.data['tester'])}"
+        f.puts "    :verification_methods:#{handle_empty_value(r.data['verification_methods'])}"
+        f.puts "    :verification_criteria:#{html(vc)}"
+      end
+
+      f.puts "\n   #{html(text)}" unless text.empty?
+    end
+
+    def footer(f)
+      files = @loader.module_data[@moduleName][:files].values.flatten
+      return if files.empty?
+
+      f.puts ''
+      f.puts '.. enclosed::'
+      f.puts ''
+      files.each do |file|
+        f.puts "    #{file}"
+      end
+    end
+
+    def index(f, category, origin, modules)
+      caption = category.capitalize + ' (' + origin + ')'
+      f.puts caption
+      f.puts '=' * caption.length
+      f.puts ''
+      f.puts '.. toctree::'
+      f.puts '  :maxdepth: 1'
+      f.puts ''
+      modules.sort.each do |m|
+        f.puts "  #{m.sanitize}/Requirements"
+      end
+    end
+  end
+end

data/lib/dim/ext/psych.rb

@@ -1,63 +1,63 @@
-require_relative '../exit_helper'
-
-module Dim
-  module Refinements
-    refine Psych::Nodes::Document do
-      def line_numbers
-        hash = {}
-        children[0].children.each do |node|
-          if node.is_a?(Psych::Nodes::Scalar)
-            hash[node.value] = node.start_line + 1
-          end
-        end
-        hash
-      end
-    end
-  end
-end
-
-module Psych
-  module Visitors
-    class ToRuby
-      alias revive_hash_org revive_hash
-
-      def patched_revive_hash(hash, o)
-        test_hash = {}
-        o.children.each_slice(2) do |k, _v|
-          key = accept(k)
-          if test_hash.has_key?(key)
-            line = "line #{k.start_line + 1}: "
-            Dim::ExitHelper.exit(code: 1, msg: "#{line}found \"#{key}\" twice which must be unique.")
-          end
-          test_hash[key] = k
-        end
-        revive_hash_org hash, o
-      end
-
-      def self.add_patch
-        alias revive_hash patched_revive_hash
-      end
-
-      def self.revert_patch
-        alias revive_hash revive_hash_org
-      end
-    end
-  end
-
-  module Nodes
-    class Scalar
-      alias initialize_org initialize
-      def quoted_initialize(value, anchor = nil, tag = nil, plain = true, _quoted = false, style = ANY)
-        initialize_org(value, anchor, tag, plain, true, style)
-      end
-
-      def self.add_patch
-        alias initialize quoted_initialize
-      end
-
-      def self.revert_patch
-        alias initialize initialize_org
-      end
-    end
-  end
-end
+require_relative '../exit_helper'
+
+module Dim
+  module Refinements
+    refine Psych::Nodes::Document do
+      def line_numbers
+        hash = {}
+        children[0].children.each do |node|
+          if node.is_a?(Psych::Nodes::Scalar)
+            hash[node.value] = node.start_line + 1
+          end
+        end
+        hash
+      end
+    end
+  end
+end
+
+module Psych
+  module Visitors
+    class ToRuby
+      alias revive_hash_org revive_hash
+
+      def patched_revive_hash(hash, o)
+        test_hash = {}
+        o.children.each_slice(2) do |k, _v|
+          key = accept(k)
+          if test_hash.has_key?(key)
+            line = "line #{k.start_line + 1}: "
+            Dim::ExitHelper.exit(code: 1, msg: "#{line}found \"#{key}\" twice which must be unique.")
+          end
+          test_hash[key] = k
+        end
+        revive_hash_org hash, o
+      end
+
+      def self.add_patch
+        alias revive_hash patched_revive_hash
+      end
+
+      def self.revert_patch
+        alias revive_hash revive_hash_org
+      end
+    end
+  end
+
+  module Nodes
+    class Scalar
+      alias initialize_org initialize
+      def quoted_initialize(value, anchor = nil, tag = nil, plain = true, _quoted = false, style = ANY)
+        initialize_org(value, anchor, tag, plain, true, style)
+      end
+
+      def self.add_patch
+        alias initialize quoted_initialize
+      end
+
+      def self.revert_patch
+        alias initialize initialize_org
+      end
+    end
+  end
+end

data/lib/dim/ext/string.rb

@@ -1,85 +1,85 @@
-class String
-  def cleanString
-    cleanArray.join(', ')
-  end
-
-  def cleanUniqString
-    cleanUniqArray.join(', ')
-  end
-
-  def cleanUniqArray
-    cleanArray.uniq
-  end
-
-  def cleanArray
-    cleanSplit.select { |s| !s.empty? }
-  end
-
-  def cleanSplit
-    split(/(?<!\\),/).map(&:strip)
-  end
-
-  def addEnum(e)
-    replace((cleanArray << e).uniq.join(', '))
-  end
-
-  def removeEnum(e)
-    arr = cleanArray
-    arr.delete(e)
-    replace(arr.join(', '))
-  end
-
-  def escapeHtmlOutside
-    gsub(/&(?!(amp|lt|gt|quot|apos|emsp);)/, '&amp;')
-      .gsub('<',  '&lt;')
-      .gsub('>',  '&gt;')
-      .gsub('"', '&quot;')
-      .gsub("'",  '&apos;')
-      .gsub("\t", '&emsp;')
-      .gsub("\n", '<br>')
-      .gsub('`', '&#96;')
-      .gsub(/(?<= ) /, '&nbsp')
-  end
-
-  def escape_html_inside
-    gsub('`', '&#96;')
-      .gsub("\t", '&emsp;')
-      .gsub("\n", ' ')
-  end
-
-  def get_next_escape_token(pos)
-    ind = index(%r{<\s*(\/?)\s*html\s*>}, pos)
-    return [:none, length - pos, -1] if ind.nil?
-
-    type = Regexp.last_match(1).empty? ? :start : :end
-    [type, ind - pos, ind + Regexp.last_match(0).length]
-  end
-
-  def escape_html
-    str = ''
-    search_pos = 0
-    nested = 0
-    while true
-      next_token, token_pos, after_token_pos = get_next_escape_token(search_pos)
-      if nested == 0
-        str << self[search_pos, token_pos].escapeHtmlOutside
-        nested = 1 if next_token == :start
-      else
-        str << self[search_pos, token_pos].escape_html_inside
-        nested += (next_token == :start ? +1 : -1)
-      end
-      break if next_token == :none
-
-      search_pos = after_token_pos
-    end
-    str.strip
-  end
-
-  def sanitize
-    gsub(/[^a-zA-Z0-9.\-_]/, '_')
-  end
-
-  def universal_newline
-    encode(encoding, universal_newline: true)
-  end
-end
+class String
+  def cleanString
+    cleanArray.join(', ')
+  end
+
+  def cleanUniqString
+    cleanUniqArray.join(', ')
+  end
+
+  def cleanUniqArray
+    cleanArray.uniq
+  end
+
+  def cleanArray
+    cleanSplit.select { |s| !s.empty? }
+  end
+
+  def cleanSplit
+    split(/(?<!\\),/).map(&:strip)
+  end
+
+  def addEnum(e)
+    replace((cleanArray << e).uniq.join(', '))
+  end
+
+  def removeEnum(e)
+    arr = cleanArray
+    arr.delete(e)
+    replace(arr.join(', '))
+  end
+
+  def escapeHtmlOutside
+    gsub(/&(?!(amp|lt|gt|quot|apos|emsp);)/, '&amp;')
+      .gsub('<',  '&lt;')
+      .gsub('>',  '&gt;')
+      .gsub('"', '&quot;')
+      .gsub("'",  '&apos;')
+      .gsub("\t", '&emsp;')
+      .gsub("\n", '<br>')
+      .gsub('`', '&#96;')
+      .gsub(/(?<= ) /, '&nbsp')
+  end
+
+  def escape_html_inside
+    gsub('`', '&#96;')
+      .gsub("\t", '&emsp;')
+      .gsub("\n", ' ')
+  end
+
+  def get_next_escape_token(pos)
+    ind = index(%r{<\s*(\/?)\s*html\s*>}, pos)
+    return [:none, length - pos, -1] if ind.nil?
+
+    type = Regexp.last_match(1).empty? ? :start : :end
+    [type, ind - pos, ind + Regexp.last_match(0).length]
+  end
+
+  def escape_html
+    str = ''
+    search_pos = 0
+    nested = 0
+    while true
+      next_token, token_pos, after_token_pos = get_next_escape_token(search_pos)
+      if nested == 0
+        str << self[search_pos, token_pos].escapeHtmlOutside
+        nested = 1 if next_token == :start
+      else
+        str << self[search_pos, token_pos].escape_html_inside
+        nested += (next_token == :start ? +1 : -1)
+      end
+      break if next_token == :none
+
+      search_pos = after_token_pos
+    end
+    str.strip
+  end
+
+  def sanitize
+    gsub(/[^a-zA-Z0-9.\-_]/, '_')
+  end
+
+  def universal_newline
+    encode(encoding, universal_newline: true)
+  end
+end

data/lib/dim/globals.rb

@@ -1,12 +1,12 @@
-OPTIONS ||= {}
-SUBCOMMANDS ||= {}
-EXPORTER ||= {}
-CATEGORY_ORDER = {
-  'input' => 1,
-  'system' => 2,
-  'software' => 3,
-  'architecture' => 4,
-  'module' => 5,
-}.freeze
-ALLOWED_CATEGORIES = CATEGORY_ORDER.keys.each_with_object({}) { |k, obj| obj[k.to_sym] = k }.freeze
-SRS_NAME_REGEX = /[^a-zA-Z0-9-]+/.freeze
+OPTIONS ||= {}
+SUBCOMMANDS ||= {}
+EXPORTER ||= {}
+CATEGORY_ORDER = {
+  'input' => 1,
+  'system' => 2,
+  'software' => 3,
+  'architecture' => 4,
+  'module' => 5,
+}.freeze
+ALLOWED_CATEGORIES = CATEGORY_ORDER.keys.each_with_object({}) { |k, obj| obj[k.to_sym] = k }.freeze
+SRS_NAME_REGEX = /[^a-zA-Z0-9-]+/.freeze