Almirah 0.2.4 → 0.2.6

data/lib/almirah/project_configuration.rb

@@ -1,42 +1,42 @@
-require 'yaml'
-
-class ProjectConfiguration
-
-    attr_accessor :project_root_directory
-    attr_accessor :parameters
-
-    def initialize(path)
-        @project_root_directory = path
-        @parameters = {}
-        load_project_file()
-    end
-
-    def load_project_file
-        begin
-            @parameters = YAML.load_file(@project_root_directory + '/project.yml') 
-        rescue Psych::SyntaxError => e
-            puts "YAML syntax error: #{e.message}"
-          rescue Errno::ENOENT
-            puts "Project file not found: project.yml"
-        end
-    end
-
-    def get_design_inputs
-        if (@parameters.key? 'specifications') and (@parameters['specifications'].key? 'input')
-            return @parameters['specifications']['input']
-        end
-        return []
-    end
-
-    def is_spec_db_shall_be_created
-        if (@parameters.key? 'output')
-            @parameters['output'].each do |p|
-               if p == 'specifications_db'
-                return true
-               end
-            end
-        end
-        return false
-    end
-
+require 'yaml'
+
+class ProjectConfiguration
+
+    attr_accessor :project_root_directory
+    attr_accessor :parameters
+
+    def initialize(path)
+        @project_root_directory = path
+        @parameters = {}
+        load_project_file()
+    end
+
+    def load_project_file
+        begin
+            @parameters = YAML.load_file(@project_root_directory + '/project.yml') 
+        rescue Psych::SyntaxError => e
+            puts "YAML syntax error: #{e.message}"
+          rescue Errno::ENOENT
+            puts "Project file not found: project.yml"
+        end
+    end
+
+    def get_design_inputs
+        if (@parameters.key? 'specifications') and (@parameters['specifications'].key? 'input')
+            return @parameters['specifications']['input']
+        end
+        return []
+    end
+
+    def is_spec_db_shall_be_created
+        if (@parameters.key? 'output')
+            @parameters['output'].each do |p|
+               if p == 'specifications_db'
+                return true
+               end
+            end
+        end
+        return false
+    end
+
 end

data/lib/almirah/project_template.rb

@@ -0,0 +1,298 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+class ProjectTemplate # rubocop:disable Style/Documentation
+  attr_accessor :project_root
+
+  def initialize(project_name)
+    path = File.join(Dir.pwd, project_name)
+    Kernel.abort 'Suggested project folder already exists' if Dir.exist? path
+    FileUtils.mkdir_p path
+    @project_root = path
+    create_requirements
+    create_architecture
+    create_tests
+    create_test_runs
+  end
+
+  def create_requirements
+    path = File.join(@project_root, 'specifications/req')
+    FileUtils.mkdir_p path
+
+    file_content = <<~EOS
+      ---
+      title: Requirements Specification
+      author: put your name here
+      ---
+
+      # Overview
+
+      This is an example of software requirements specification.
+
+      # Requirements
+
+      This is a regular paragraph in the document.
+
+      [REQ-001] This is a first requirement (controlled paragraph with ID equal to "REQ-001").
+
+      [REQ-002] This is a second requirement.
+
+      # Document Histrory
+
+      | Revision | Description of changes | Date |
+      |---|---|---|
+      | A | Initial version | #{Time.now.strftime('%Y-%d-%m')} |
+
+    EOS
+
+    path = File.join(path, 'req.md')
+    file = File.open(path, 'w')
+    file.puts file_content
+    file.close
+  end
+
+  def create_architecture
+    path = File.join(@project_root, 'specifications/arch')
+    FileUtils.mkdir_p path
+
+    file_content = <<~EOS
+      ---
+      title: Architecture Specification
+      author: put your name here
+      ---
+
+      # Overview
+
+      This is an example of software architecture document.
+
+      # System Overview
+
+      This is a regular paragraph in the document.
+
+      [ARCH-004] This is an architecture item that is related to requirement "REQ-001". >[REQ-001]
+
+      [ARCH-002] This is a regular architecture item.
+
+      # System Decomposition
+
+      [ARCH-005] This is an architecture irem that is related to requirement "REQ-002". >[REQ-002]
+
+      # Document Histrory
+
+      | Revision | Description of changes | Date |
+      |---|---|---|
+      | A | Initial version | #{Time.now.strftime('%Y-%d-%m')} |
+
+    EOS
+
+    path = File.join(path, 'arch.md')
+    file = File.open(path, 'w')
+    file.puts file_content
+    file.close
+  end
+
+  def create_tests
+    create_test_001
+    create_test_002
+    create_test_003
+  end
+
+  def create_test_001
+    path = File.join(@project_root, 'tests/protocols/tp-001')
+    FileUtils.mkdir_p path
+
+    file_content = <<~EOS
+      # Test Case TP-001
+
+      This is an example of test case for software requirement "REQ-001".
+
+      # Test Summary
+
+      | Param | Value |
+      |---|---|
+      | Software Version |  |
+      | Tester Name | |
+      | Date |  |
+
+      # Test Procedure
+
+      | Test Step # | Test Step Description | Result | Req. Id |
+      |---|---|---|---|
+      | 1 | Some preparation step |  |  |
+      | 2 | Some verification step for requirement "REQ-001" | | >[REQ-001] |
+
+    EOS
+
+    path = File.join(path, 'tp-001.md')
+    file = File.open(path, 'w')
+    file.puts file_content
+    file.close
+  end
+
+  def create_test_002
+    path = File.join(@project_root, 'tests/protocols/tp-002')
+    FileUtils.mkdir_p path
+
+    file_content = <<~EOS
+      # Test Case TP-002
+
+      This is an example of test case for software requirement "REQ-002".
+
+      # Test Summary
+
+      | Param | Value |
+      |---|---|
+      | Software Version |  |
+      | Tester Name | |
+      | Date |  |
+
+      # Test Procedure
+
+      | Test Step # | Test Step Description | Result | Req. Id |
+      |---|---|---|---|
+      | 1 | Some preparation step |  |  |
+      | 2 | Some verification step for requirement "REQ-002" | | >[REQ-002] |
+
+    EOS
+
+    path = File.join(path, 'tp-002.md')
+    file = File.open(path, 'w')
+    file.puts file_content
+    file.close
+  end
+
+  def create_test_003
+    path = File.join(@project_root, 'tests/protocols/tq-001')
+    FileUtils.mkdir_p path
+
+    file_content = <<~EOS
+      # Test Case TQ-001
+
+      This is an example of test case for software architecture item "ARCH-002".
+
+      # Test Summary
+
+      | Param | Value |
+      |---|---|
+      | Software Version |  |
+      | Tester Name | |
+      | Date |  |
+
+      # Test Procedure
+
+      | Test Step # | Test Step Description | Result | Req. Id |
+      |---|---|---|---|
+      | 1 | Some preparation step |  |  |
+      | 2 | Some verification step for architecture item "ARCH-002" | | >[ARCH-002] |
+
+    EOS
+
+    path = File.join(path, 'tq-001.md')
+    file = File.open(path, 'w')
+    file.puts file_content
+    file.close
+  end
+
+  def create_test_runs
+    run_test_001
+    run_test_002
+    run_test_003
+  end
+
+  def run_test_001
+    path = File.join(@project_root, 'tests/runs/001/tp-001')
+    FileUtils.mkdir_p path
+
+    file_content = <<~EOS
+      # Test Case TP-001
+
+      This is an example of test case for software requirement "REQ-001".
+
+      # Test Summary
+
+      | Param | Value |
+      |---|---|
+      | Software Version |  |
+      | Tester Name | |
+      | Date |  |
+
+      # Test Procedure
+
+      | Test Step # | Test Step Description | Result | Req. Id |
+      |---|---|---|---|
+      | 1 | Some preparation step | n/a |  |
+      | 2 | Some verification step for requirement "REQ-001" | pass | >[REQ-001] |
+
+    EOS
+
+    path = File.join(path, 'tp-001.md')
+    file = File.open(path, 'w')
+    file.puts file_content
+    file.close
+  end
+
+  def run_test_002
+    path = File.join(@project_root, 'tests/runs/001/tp-002')
+    FileUtils.mkdir_p path
+
+    file_content = <<~EOS
+      # Test Case TP-002
+
+      This is an example of test case for software requirement "REQ-002".
+
+      # Test Summary
+
+      | Param | Value |
+      |---|---|
+      | Software Version |  |
+      | Tester Name | |
+      | Date |  |
+
+      # Test Procedure
+
+      | Test Step # | Test Step Description | Result | Req. Id |
+      |---|---|---|---|
+      | 1 | Some preparation step | n/a |  |
+      | 2 | Some verification step for requirement "REQ-002" | fail | >[REQ-002] |
+
+    EOS
+
+    path = File.join(path, 'tp-002.md')
+    file = File.open(path, 'w')
+    file.puts file_content
+    file.close
+  end
+
+  def run_test_003
+    path = File.join(@project_root, 'tests/runs/010/tq-002')
+    FileUtils.mkdir_p path
+
+    file_content = <<~EOS
+      # Test Case TQ-001
+
+      This is an example of test case for software architecture item "ARCH-002".
+
+      # Test Summary
+
+      | Param | Value |
+      |---|---|
+      | Software Version |  |
+      | Tester Name | |
+      | Date |  |
+
+      # Test Procedure
+
+      | Test Step # | Test Step Description | Result | Req. Id |
+      |---|---|---|---|
+      | 1 | Some preparation step | n/a |  |
+      | 2 | Some verification step for architecture item "ARCH-002" | pass | >[ARCH-002] |
+
+    EOS
+
+    path = File.join(path, 'tq-001.md')
+    file = File.open(path, 'w')
+    file.puts file_content
+    file.close
+  end
+end

data/lib/almirah/project_utility.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+class ProjectUtility # rubocop:disable Style/Documentation
+  attr_accessor :configuration
+
+  def initialize(configuration)
+    @configuration = configuration
+  end
+
+  def combine_protocols
+    combine nil
+  end
+
+  def combine_run(run_id)
+    combine run_id
+  end
+
+  private
+
+  def combine(run_id) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    path = @configuration.project_root_directory
+    dst_folder = "#{@configuration.project_root_directory}/build"
+    FileUtils.mkdir_p(dst_folder)
+
+    dst_file = "#{dst_folder}/combined.md"
+    File.delete(dst_file) if File.exist?(dst_file)
+    dst_f = File.open(dst_file, 'a')
+
+    src_path = if run_id
+                 unless Dir.exist? "#{path}/tests/runs/#{run_id}"
+                   puts "\e[1m\e[31m Run #{run_id} folder does not exists"
+                 end
+                 "#{path}/tests/runs/#{run_id}/**/*.md"
+               else
+                 "#{path}/tests/protocols/**/*.md"
+               end
+
+    Dir.glob(src_path).sort.each do |f|
+      puts "\e[35m #{f}"
+      file = File.open(f)
+      file_data = file.readlines
+      file.close
+
+      dst_f.puts file_data
+      dst_f.puts # empty line
+    end
+
+    dst_f.close
+  end
+end

data/lib/almirah/search/specifications_db.rb

@@ -1,83 +1,79 @@
-require 'json'
-# Prepare JSON database file for further indexing by other tools
-class SpecificationsDb
-
-    attr_accessor :specifications
-    attr_accessor :data
-
-    def initialize(spec_list)
-        @specifications = spec_list
-        @data = []
-        create_data
-    end
-
-    def create_data
-        @specifications.each do |sp|
-            sp.items.each do |i|
-                if (i.instance_of? Paragraph) or (i.instance_of? ControlledParagraph)
-                    e = {"document" => i.parent_doc.title, \
-                        "doc_color" => i.parent_doc.color, \
-                        "text" => i.text, \
-                        "heading_url" => i.parent_heading.get_url(), \
-                        "heading_text" => i.parent_heading.get_section_info()
-                    }
-                    @data.append e                    
-                elsif i.instance_of? MarkdownList
-                    e = add_markdown_list_item_to_db( @data, i, i)
-                elsif i.instance_of? MarkdownTable
-                    add_markdown_table_item_to_db( @data, i, i)    
-                end
-            end
-        end
-    end
-
-    def add_markdown_list_item_to_db(data, item_for_reference, item_to_process)
-        e = nil
-        item_to_process.rows.each do |r|
-            if r.is_a?(MarkdownList)
-                f_text = r.text
-                e = {   "document" => item_for_reference.parent_doc.title, \
-                        "doc_color" => item_for_reference.parent_doc.color, \
-                        "text" => f_text, \
-                        "heading_url" => item_for_reference.parent_heading.get_url(), \
-                        "heading_text" => item_for_reference.parent_heading.get_section_info()
-                    }
-                data << e
-                add_markdown_list_item_to_db(data, item_for_reference, r)
-            else
-                f_text = r
-                e = {   "document" => item_for_reference.parent_doc.title, \
-                        "doc_color" => item_for_reference.parent_doc.color, \
-                        "text" => f_text, \
-                        "heading_url" => item_for_reference.parent_heading.get_url(), \
-                        "heading_text" => item_for_reference.parent_heading.get_section_info()
-                    }
-                data << e
-            end
-        end
-        return e
-    end
-
-    def add_markdown_table_item_to_db(data, item_for_reference, item_to_process)
-        e = nil
-        table_text = ""
-        item_to_process.rows.each do |row|
-            table_text += "| " + row.join(" | ") + " |"
-        end
-        e = {   "document" => item_for_reference.parent_doc.title, \
-                "doc_color" => item_for_reference.parent_doc.color, \
-                "text" => table_text, \
-                "heading_url" => item_for_reference.parent_heading.get_url(), \
-                "heading_text" => item_for_reference.parent_heading.get_section_info()
-            }
-        data << e
-    end
-
-    def save(path)
-        json = JSON.generate(@data)
-
-        file = File.open( path + "/specifications_db.json", "w" )
-        file.puts json
-        file.close
-    end
-end
+# frozen_string_literal: true
+
+require 'json'
+
+# Prepare JSON database file for further indexing by other tools
+class SpecificationsDb
+  attr_accessor :specifications, :data
+
+  def initialize(spec_list)
+    @specifications = spec_list
+    @data = []
+    create_data
+  end
+
+  def create_data # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    @specifications.each do |sp|
+      sp.items.each do |i|
+        if (i.instance_of? Paragraph) or (i.instance_of? ControlledParagraph)
+          e = { 'document' => i.parent_doc.title, \
+                'doc_color' => i.parent_doc.color, \
+                'text' => i.text, \
+                'heading_url' => i.parent_heading.get_url, \
+                'heading_text' => i.parent_heading.get_section_info }
+          @data.append e
+        elsif i.instance_of? MarkdownList
+          add_markdown_list_item_to_db(@data, i, i)
+        elsif i.instance_of? MarkdownTable
+          add_markdown_table_item_to_db(@data, i, i)
+        end
+      end
+    end
+  end
+
+  def add_markdown_list_item_to_db(data, item_for_reference, item_to_process) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    e = nil
+    item_to_process.rows.each do |r|
+      if r.is_a?(MarkdownList)
+        f_text = r.text
+        e = {   'document' => item_for_reference.parent_doc.title, \
+                'doc_color' => item_for_reference.parent_doc.color, \
+                'text' => f_text, \
+                'heading_url' => item_for_reference.parent_heading.get_url, \
+                'heading_text' => item_for_reference.parent_heading.get_section_info }
+        data << e
+        add_markdown_list_item_to_db(data, item_for_reference, r)
+      else
+        f_text = r
+        e = {   'document' => item_for_reference.parent_doc.title, \
+                'doc_color' => item_for_reference.parent_doc.color, \
+                'text' => f_text, \
+                'heading_url' => item_for_reference.parent_heading.get_url, \
+                'heading_text' => item_for_reference.parent_heading.get_section_info }
+        data << e
+      end
+    end
+    e
+  end
+
+  def add_markdown_table_item_to_db(data, item_for_reference, item_to_process)
+    table_text = ''
+    item_to_process.rows.each do |row|
+      table_text += "| #{row.join(' | ')} |"
+    end
+    e = {   'document' => item_for_reference.parent_doc.title, \
+            'doc_color' => item_for_reference.parent_doc.color, \
+            'text' => table_text, \
+            'heading_url' => item_for_reference.parent_heading.get_url, \
+            'heading_text' => item_for_reference.parent_heading.get_section_info }
+    data << e
+  end
+
+  def save(path)
+    json = JSON.generate(@data)
+
+    file = File.open("#{path}/specifications_db.json", 'w')
+    file.puts json
+    file.close
+  end
+end