dim-toolkit 2.1.1 → 2.2.0

data/lib/dim/consistency.rb

@@ -1,187 +1,157 @@
-require_relative 'globals'
-require_relative 'exit_helper'
-
-module Dim
-  class Consistency
-    def initialize(loader)
-      @loader = loader
-    end
-
-    def cyclic_check(ref, previous_ref, checked_ids = {}, list = [])
-      return if checked_ids[ref.id]
-
-      # Circular dependency can occur only on same category level
-      return if previous_ref && (ref.category_level != previous_ref.category_level)
-
-      if list.include?(ref.id)
-        Dim::ExitHelper.exit(
-          code: 1,
-          filename: ref.filename,
-          msg: "\"#{ref.id}\" is cyclically referenced: #{list.join(' -> ')} -> #{ref.id}"
-        )
-      end
-
-      list << ref.id
-
-      ref.existingRefs.each do |ref_id|
-        cyclic_check(@loader.requirements[ref_id], ref, checked_ids, list)
-      end
-
-      list.pop
-
-      # Any value other than nil and false will work, as this is being used to check
-      # boolean condition on line#11
-      checked_ids[ref.id] = 1 if list.empty?
-    end
-    private :cyclic_check
-
-    def insert_default_values(req)
-      req.all_attributes.each do |key, config|
-        next if req.data.key?(key)
-
-        req.data[key] = config[:default]
-      end
-    end
-
-    def insert_property_file_definitions(ref)
-      @loader.property_table.fetch(ref.document, {}).each do |attr, value|
-        ref.data[attr] = value if ref.data[attr].nil?
-
-        if attr == 'test_setups' && (ref.data['verification_methods'].nil? || ref.data['verification_methods'] == '')
-          ref.data['verification_methods'] = value
-        end
-      end
-    end
-
-    def merge_test_setups_and_verification_methods(ref)
-      return if ref.data.key?('verification_methods') && !ref.data['verification_methods'].nil?
-
-      ref.data['verification_methods'] = ref.data['test_setups'].clone
-    end
-
-    def calculate_test_setups(ref)
-      return unless ref.data['test_setups'].nil?
-
-      tags = ref.data['tags'].cleanArray
-
-      ref.data['test_setups'] = if ref.data['type'] != 'requirement' || tags.include?('process')
-                                  'none'
-                                elsif ref.category == 'input' || ref.category == 'unspecified'
-                                  'none'
-                                elsif ref.category == 'module'
-                                  'off_target'
-                                elsif tags.include?('tool')
-                                  'off_target'
-                                else
-                                  'on_target'
-                                end
-    end
-
-    def calculate_verification_methods(ref)
-      return unless ref.data['verification_methods'].nil?
-
-      tags = ref.data['tags'].cleanArray
-
-      ref.data['verification_methods'] = if ref.data['type'] != 'requirement' || tags.include?('process')
-                                           'none'
-                                         elsif ref.category == 'input' || ref.category == 'unspecified'
-                                           'none'
-                                         elsif ref.category == 'module'
-                                           'off_target'
-                                         elsif tags.include?('tool')
-                                           'off_target'
-                                         else
-                                           'on_target'
-                                         end
-    end
-
-    def calculate_review_status(ref)
-      return unless ref.data['review_status'].nil?
-
-      ref.data['review_status'] = if ref.category == 'input' || ref.category == 'unspecified'
-                                    'not_reviewed'
-                                  else
-                                    'accepted'
-                                  end
-    end
-
-    def clean_comma_separated(ref)
-      %w[tags developer tester refs test_setups verification_methods].each do |var|
-        ref.data[var] = ref.data[var].cleanString
-      end
-    end
-
-    def calculate_developer_tester(ref)
-      %w[developer tester].each do |t|
-        next unless ref.data[t].nil?
-
-        ref.data[t] = if ref.data['type'] != 'requirement'
-                        ''
-                      elsif ref.data['tags'].cleanArray.include?('process') && t == 'tester'
-                        ''
-                      elsif ref.category == 'input' || ref.category == 'unspecified'
-                        ''
-                      else
-                        ref.origin
-                      end
-      end
-    end
-
-    def calculate_status(ref)
-      return unless ref.data['status'].nil?
-
-      ref.data['status'] = %w[requirement information].include?(ref.data['type']) ? 'draft' : 'valid'
-    end
-
-    def check(allow_missing:)
-      requirements_by_module = {}
-      @loader.module_data.keys.each { |um| requirements_by_module[um] = [] }
-      @loader.requirements.each { |_id, r| requirements_by_module[r.document] << r }
-
-      @loader.requirements.each do |_id, r|
-        insert_property_file_definitions(r)
-        insert_default_values(r)
-        merge_test_setups_and_verification_methods(r)
-        calculate_test_setups(r)
-        calculate_verification_methods(r)
-        calculate_review_status(r)
-        calculate_developer_tester(r)
-        calculate_status(r)
-      end
-
-      @loader.requirements.each do |_id, r|
-        clean_comma_separated(r)
-      end
-
-      @loader.requirements.each do |id, r|
-        r.data['refs'].cleanArray.each do |ref|
-          if !@loader.requirements.has_key?(ref)
-            unless allow_missing
-              Dim::ExitHelper.exit(
-                code: 1,
-                filename: r.filename,
-                msg: "\"#{id}\" refers to non-existing \"#{ref}\""
-              )
-            end
-          else
-            # Generate upstream and downstream refs based on category level
-            if @loader.requirements[id].category_level <= @loader.requirements[ref].category_level
-              @loader.requirements[id].downstreamRefs |= [ref]
-              @loader.requirements[ref].upstreamRefs |= [id]
-            else
-              @loader.requirements[id].upstreamRefs |= [ref]
-              @loader.requirements[ref].downstreamRefs |= [id]
-            end
-            @loader.requirements[ref].backwardRefs << id
-            r.existingRefs << ref
-          end
-        end
-      end
-
-      @checked_ids = {}
-      @loader.requirements.each do |_id, r|
-        cyclic_check(r, nil, @checked_ids)
-      end
-    end
-  end
-end
+require_relative 'globals'
+require_relative 'exit_helper'
+
+module Dim
+  class Consistency
+    def initialize(loader)
+      @loader = loader
+    end
+
+    def cyclic_check(ref, previous_ref, checked_ids = {}, list = [])
+      return if checked_ids[ref.id]
+
+      # Circular dependency can occur only on same category level
+      return if previous_ref && (ref.category_level != previous_ref.category_level)
+
+      if list.include?(ref.id)
+        Dim::ExitHelper.exit(
+          code: 1,
+          filename: ref.filename,
+          msg: "\"#{ref.id}\" is cyclically referenced: #{list.join(' -> ')} -> #{ref.id}"
+        )
+      end
+
+      list << ref.id
+
+      ref.existingRefs.each do |ref_id|
+        cyclic_check(@loader.requirements[ref_id], ref, checked_ids, list)
+      end
+
+      list.pop
+
+      # Any value other than nil and false will work, as this is being used to check
+      # boolean condition on line#11
+      checked_ids[ref.id] = 1 if list.empty?
+    end
+    private :cyclic_check
+
+    def insert_default_values(req)
+      req.all_attributes.each do |key, config|
+        next if req.data.key?(key)
+
+        req.data[key] = config[:default]
+      end
+    end
+
+    def insert_property_file_definitions(ref)
+      @loader.property_table.fetch(ref.document, {}).each do |attr, value|
+        ref.data[attr] = value if ref.data[attr].nil?
+      end
+    end
+
+    def calculate_verification_methods(ref)
+      return unless ref.data['verification_methods'].nil?
+
+      tags = ref.data['tags'].cleanArray
+
+      ref.data['verification_methods'] = if ref.data['type'] != 'requirement' || tags.include?('process')
+                                           'none'
+                                         elsif ref.category == 'input' || ref.category == 'unspecified'
+                                           'none'
+                                         elsif ref.category == 'module'
+                                           'off_target'
+                                         elsif tags.include?('tool')
+                                           'off_target'
+                                         else
+                                           'on_target'
+                                         end
+    end
+
+    def calculate_review_status(ref)
+      return unless ref.data['review_status'].nil?
+
+      ref.data['review_status'] = if ref.category == 'input' || ref.category == 'unspecified'
+                                    'not_reviewed'
+                                  else
+                                    'accepted'
+                                  end
+    end
+
+    def clean_comma_separated(ref)
+      %w[tags developer tester refs verification_methods].each do |var|
+        ref.data[var] = ref.data[var].cleanString
+      end
+    end
+
+    def calculate_developer_tester(ref)
+      %w[developer tester].each do |t|
+        next unless ref.data[t].nil?
+
+        ref.data[t] = if ref.data['type'] != 'requirement'
+                        ''
+                      elsif ref.data['tags'].cleanArray.include?('process') && t == 'tester'
+                        ''
+                      elsif ref.category == 'input' || ref.category == 'unspecified'
+                        ''
+                      else
+                        ref.origin
+                      end
+      end
+    end
+
+    def calculate_status(ref)
+      return unless ref.data['status'].nil?
+
+      ref.data['status'] = %w[requirement information].include?(ref.data['type']) ? 'draft' : 'valid'
+    end
+
+    def check(allow_missing:)
+      requirements_by_module = {}
+      @loader.module_data.keys.each { |um| requirements_by_module[um] = [] }
+      @loader.requirements.each { |_id, r| requirements_by_module[r.document] << r }
+
+      @loader.requirements.each do |_id, r|
+        insert_property_file_definitions(r)
+        insert_default_values(r)
+        calculate_verification_methods(r)
+        calculate_review_status(r)
+        calculate_developer_tester(r)
+        calculate_status(r)
+      end
+
+      @loader.requirements.each do |_id, r|
+        clean_comma_separated(r)
+      end
+
+      @loader.requirements.each do |id, r|
+        r.data['refs'].cleanArray.each do |ref|
+          if !@loader.requirements.has_key?(ref)
+            unless allow_missing
+              Dim::ExitHelper.exit(
+                code: 1,
+                filename: r.filename,
+                msg: "\"#{id}\" refers to non-existing \"#{ref}\""
+              )
+            end
+          else
+            # Generate upstream and downstream refs based on category level
+            if @loader.requirements[id].category_level <= @loader.requirements[ref].category_level
+              @loader.requirements[id].downstreamRefs |= [ref]
+              @loader.requirements[ref].upstreamRefs |= [id]
+            else
+              @loader.requirements[id].upstreamRefs |= [ref]
+              @loader.requirements[ref].downstreamRefs |= [id]
+            end
+            @loader.requirements[ref].backwardRefs << id
+            r.existingRefs << ref
+          end
+        end
+      end
+
+      @checked_ids = {}
+      @loader.requirements.each do |_id, r|
+        cyclic_check(r, nil, @checked_ids)
+      end
+    end
+  end
+end

data/lib/dim/dimmain.rb

@@ -1,28 +1,28 @@
-$stdout.sync = true
-
-require 'yaml'
-
-require_relative 'globals'
-require_relative 'exit_helper'
-require_relative 'ext/string'
-require_relative 'loader'
-require_relative 'ver'
-require_relative 'requirement'
-require_relative 'commands/stats'
-require_relative 'commands/check'
-require_relative 'commands/export'
-require_relative 'commands/format'
-require_relative 'options'
-
-module Dim
-  def self.main(args = ARGV)
-    Dim::Options.parse(args)
-    loader = Dim::Loader.new
-    loader.load(file: OPTIONS[:input],
-                attributes_file: OPTIONS[:attributes],
-                allow_missing: OPTIONS[:allow_missing],
-                no_check_enclosed: OPTIONS[:no_check_enclosed] || false,
-                silent: OPTIONS[:silent] || false)
-    SUBCOMMANDS[OPTIONS[:subcommand]].new(loader).execute(silent: OPTIONS[:silent] || false)
-  end
-end
+$stdout.sync = true
+
+require 'yaml'
+
+require_relative 'globals'
+require_relative 'exit_helper'
+require_relative 'ext/string'
+require_relative 'loader'
+require_relative 'ver'
+require_relative 'requirement'
+require_relative 'commands/stats'
+require_relative 'commands/check'
+require_relative 'commands/export'
+require_relative 'commands/format'
+require_relative 'options'
+
+module Dim
+  def self.main(args = ARGV)
+    Dim::Options.parse(args)
+    loader = Dim::Loader.new
+    loader.load(file: OPTIONS[:input],
+                attributes_file: OPTIONS[:attributes],
+                allow_missing: OPTIONS[:allow_missing],
+                no_check_enclosed: OPTIONS[:no_check_enclosed] || false,
+                silent: OPTIONS[:silent] || false)
+    SUBCOMMANDS[OPTIONS[:subcommand]].new(loader).execute(silent: OPTIONS[:silent] || false)
+  end
+end

data/lib/dim/encoding.rb

@@ -1,4 +1,4 @@
-# This overwrites the configuration of local machines,
-# Dim shall read, process and write only UTF_8.
-Encoding.default_external = Encoding::UTF_8
-Encoding.default_internal = Encoding::UTF_8
+# This overwrites the configuration of local machines,
+# Dim shall read, process and write only UTF_8.
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8

data/lib/dim/exit_helper.rb

@@ -1,23 +1,23 @@
-module Dim
-  class ExitHelper
-    @exit_code = 0
-
-    class << self
-      def exit_code
-        @exit_code
-      end
-
-      def reset_exit_code
-        @exit_code = 0
-      end
-
-      def exit(msg:, code: 0, filename: nil)
-        @exit_code = code
-        inf = filename ? "in #{filename}: " : ''
-        pre = code.positive? ? 'Error: ' : ''
-        warn("#{pre}#{inf}#{msg}")
-        Kernel.exit(code)
-      end
-    end
-  end
-end
+module Dim
+  class ExitHelper
+    @exit_code = 0
+
+    class << self
+      def exit_code
+        @exit_code
+      end
+
+      def reset_exit_code
+        @exit_code = 0
+      end
+
+      def exit(msg:, code: 0, filename: nil)
+        @exit_code = code
+        inf = filename ? "in #{filename}: " : ''
+        pre = code.positive? ? 'Error: ' : ''
+        warn("#{pre}#{inf}#{msg}")
+        Kernel.exit(code)
+      end
+    end
+  end
+end

data/lib/dim/exporter/csv.rb

@@ -1,25 +1,24 @@
-require_relative '../globals'
-require_relative '../requirement'
-
-module Dim
-  class Csv < ExporterInterface
-    EXPORTER['csv'] = self
-
-    def header(content)
-      @keys = @loader.all_attributes.keys
-      @keys.delete('test_setups')
-      content.puts 'Sep=,'
-      content.puts "id,document_name,originator,#{@keys.join(',')}"
-    end
-
-    def requirement(content, req)
-      vals = [req.id, req.document, req.origin]
-      @keys.each { |k| vals << req.data[k] }
-      # These values will never be nil.
-      # ID cannot be nil in Dim file, so as origin (default is "") and
-      # document cannot be missing in Dim files.
-      # Which leaves with data and YAML file cannot define nil value.
-      content.puts(vals.map { |a| "\"#{a.gsub('"', '""')}\"" }.join(','))
-    end
-  end
-end
+require_relative '../globals'
+require_relative '../requirement'
+
+module Dim
+  class Csv < ExporterInterface
+    EXPORTER['csv'] = self
+
+    def header(content)
+      @keys = @loader.all_attributes.keys
+      content.puts 'Sep=,'
+      content.puts "id,document_name,originator,#{@keys.join(',')}"
+    end
+
+    def requirement(content, req)
+      vals = [req.id, req.document, req.origin]
+      @keys.each { |k| vals << req.data[k] }
+      # These values will never be nil.
+      # ID cannot be nil in Dim file, so as origin (default is "") and
+      # document cannot be missing in Dim files.
+      # Which leaves with data and YAML file cannot define nil value.
+      content.puts(vals.map { |a| "\"#{a.gsub('"', '""')}\"" }.join(','))
+    end
+  end
+end

data/lib/dim/exporter/exporterInterface.rb

@@ -1,37 +1,37 @@
-module Dim
-  # This is how the interface is used by the Dim::Export:
-  #
-  # initialize()
-  #
-  # for every module:
-  #   header()
-  #   document()
-  #   metadata()
-  #   for every requirement in module:
-  #     requirement()
-  #   footer()
-  #
-  # if hasIndex:
-  #   for every originator/category combination:
-  #     index()
-  class ExporterInterface
-    attr_reader :hasIndex
-
-    def initialize(loader)
-      @hasIndex = false
-      @loader = loader
-    end
-
-    def header(f); end
-
-    def document(f, name); end
-
-    def metadata(f, metadata); end
-
-    def requirement(f, r); end
-
-    def footer(f); end
-
-    def index(f, category, origin, modules); end
-  end
-end
+module Dim
+  # This is how the interface is used by the Dim::Export:
+  #
+  # initialize()
+  #
+  # for every document:
+  #   header()
+  #   document()
+  #   metadata()
+  #   for every requirement in document:
+  #     requirement()
+  #   footer()
+  #
+  # if hasIndex:
+  #   for every originator/category combination:
+  #     index()
+  class ExporterInterface
+    attr_reader :hasIndex
+
+    def initialize(loader)
+      @hasIndex = false
+      @loader = loader
+    end
+
+    def header(f); end
+
+    def document(f, name); end
+
+    def metadata(f, metadata); end
+
+    def requirement(f, r); end
+
+    def footer(f); end
+
+    def index(f, category, origin, modules); end
+  end
+end

data/lib/dim/exporter/json.rb

@@ -1,32 +1,30 @@
-require 'json'
-
-require_relative '../globals'
-require_relative '../requirement'
-
-module Dim
-  class Json < ExporterInterface
-    EXPORTER['json'] = self
-
-    def header(_f)
-      @content = []
-    end
-
-    def requirement(_f, r)
-      vals = { 'id' => r.id, 'document_name' => r.document, 'originator' => r.origin }
-
-      @loader.all_attributes.keys.each do |k|
-        next if k == 'test_setups'
-
-        v = r.data[k]
-        v = v.cleanUniqArray.join(',') if k == 'refs'
-        vals[k] = v.strip
-      end
-
-      @content << vals
-    end
-
-    def footer(f)
-      f.puts(JSON.pretty_generate(@content))
-    end
-  end
-end
+require 'json'
+
+require_relative '../globals'
+require_relative '../requirement'
+
+module Dim
+  class Json < ExporterInterface
+    EXPORTER['json'] = self
+
+    def header(_f)
+      @content = []
+    end
+
+    def requirement(_f, r)
+      vals = { 'id' => r.id, 'document_name' => r.document, 'originator' => r.origin }
+
+      @loader.all_attributes.keys.each do |k|
+        v = r.data[k]
+        v = v.cleanUniqArray.join(',') if k == 'refs'
+        vals[k] = v.strip
+      end
+
+      @content << vals
+    end
+
+    def footer(f)
+      f.puts(JSON.pretty_generate(@content))
+    end
+  end
+end