Almirah 0.2.4 → 0.2.5

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/search/specifications_db.rb

@@ -1,83 +1,79 @@
+# frozen_string_literal: true
+
 require 'json'
+
 # Prepare JSON database file for further indexing by other tools
 class SpecificationsDb
+  attr_accessor :specifications, :data
 
-    attr_accessor :specifications
-    attr_accessor :data
+  def initialize(spec_list)
+    @specifications = spec_list
+    @data = []
+    create_data
+  end
 
-    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
+  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)
-        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
+  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)
-        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
+  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)
+  def save(path)
+    json = JSON.generate(@data)
 
-        file = File.open( path + "/specifications_db.json", "w" )
-        file.puts json
-        file.close
-    end
-end
+    file = File.open("#{path}/specifications_db.json", 'w')
+    file.puts json
+    file.close
+  end
+end

data/lib/almirah.rb

@@ -1,28 +1,38 @@
-require "thor"
-require_relative "almirah/project"
-require_relative "almirah/project_configuration"
+require 'thor'
+require_relative 'almirah/project'
+require_relative 'almirah/project_configuration'
+require_relative 'almirah/project_template'
 
 class CLI < Thor
-  option :results
-  desc "please <project_folder>", "say <project_folder>"
-    def please(project_folder)
-      a = Almirah.new project_folder
-      if options[:results]
-        a.results( options[:results] )
-      else
-        a.default()
-      end
-    end
+  option :run
+  desc 'please <project_folder>', 'Processes the folder'
+  long_desc <<-LONGDESC
+    Creates HTML representation of markdown files stored in <project_folder>
+
+    Use --run option to specify excat test run ID for processing if required.
 
-  desc "transform <project_folder>", "say <project_folder>"
-  def transform(project_folder)
+    For example: almirah please my_project --run 003
+
+  LONGDESC
+  def please(project_folder)
     a = Almirah.new project_folder
-    a.transform "docx"
+    if options[:run]
+      a.run(options[:run])
+    else
+      a.default
+    end
+  end
+
+  desc 'Creates project from template', ''
+  long_desc <<-LONGDESC
+    Creates default project structure in the <project_name> folder
+  LONGDESC
+  def create(project_name)
+    Almirah.create_new_project_structure project_name
   end
 end
 
 class Almirah
-
   attr_accessor :project
 
   def initialize(project_folder)
@@ -30,20 +40,19 @@ class Almirah
     @project = Project.new config
   end
 
-  def getGemRoot()
+  def getGemRoot
     File.expand_path './..', File.dirname(__FILE__)
   end
 
-  def results( test_run )
+  def run(test_run)
     @project.specifications_and_results test_run
   end
 
-  def transform( file_extension )
-    @project.transform file_extension
+  def self.create_new_project_structure(project_name)
+    ProjectTemplate.new project_name
   end
 
-  def default()
+  def default
     @project.specifications_and_protocols
   end
-
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: Almirah
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-29 00:00:00.000000000 Z
-dependencies: []
+date: 2024-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 description: The software part of the Almirah framework
 email: oleksandr.ivanov.development@gmail.com
 executables:
@@ -27,6 +47,7 @@ files:
 - lib/almirah/doc_items/controlled_table_row.rb
 - lib/almirah/doc_items/doc_footer.rb
 - lib/almirah/doc_items/doc_item.rb
+- lib/almirah/doc_items/frontmatter.rb
 - lib/almirah/doc_items/heading.rb
 - lib/almirah/doc_items/image.rb
 - lib/almirah/doc_items/markdown_list.rb
@@ -47,6 +68,7 @@ files:
 - lib/almirah/navigation_pane.rb
 - lib/almirah/project.rb
 - lib/almirah/project_configuration.rb
+- lib/almirah/project_template.rb
 - lib/almirah/search/specifications_db.rb
 - lib/almirah/templates/css/main.css
 - lib/almirah/templates/css/search.css
@@ -65,14 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Almirah