Almirah 0.2.4 → 0.2.6

data/lib/almirah.rb

@@ -1,49 +1,93 @@
-require "thor"
-require_relative "almirah/project"
-require_relative "almirah/project_configuration"
-
-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
-
-  desc "transform <project_folder>", "say <project_folder>"
-  def transform(project_folder)
-    a = Almirah.new project_folder
-    a.transform "docx"
-  end
-end
-
-class Almirah
-
-  attr_accessor :project
-
-  def initialize(project_folder)
-    config = ProjectConfiguration.new project_folder
-    @project = Project.new config
-  end
-
-  def getGemRoot()
-    File.expand_path './..', File.dirname(__FILE__)
-  end
-
-  def results( test_run )
-    @project.specifications_and_results test_run
-  end
-
-  def transform( file_extension )
-    @project.transform file_extension
-  end
-
-  def default()
-    @project.specifications_and_protocols
-  end
-
-end
+require 'thor'
+require_relative 'almirah/project'
+require_relative 'almirah/project_configuration'
+require_relative 'almirah/project_template'
+require_relative 'almirah/project_utility'
+
+class CLI < Thor
+  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 exact test run ID for processing if required.
+
+    For example: almirah please my_project --run 003
+
+  LONGDESC
+  def please(project_folder)
+    a = Almirah.new project_folder
+    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
+
+  option :run
+  desc 'combine <project_folder>', 'Combines all the test protocols'
+  long_desc <<-LONGDESC
+    Combines all the test protocols from the <project_folder>/tests/protocols folder
+
+    Use --run option to specify exact test run ID from <project_folder>/tests/runs folder.
+
+    For example: almirah combine my_project --run 003
+
+    Result is stored as <project_folder>/build/combined.md
+  LONGDESC
+  def combine(project_folder)
+    Almirah.create_project_utility project_folder
+    if options[:run]
+      Almirah.combine_run(options[:run])
+    else
+      Almirah.combine_protocols
+    end
+  end
+end
+
+class Almirah
+  attr_accessor :project
+  attr_accessor :project_utility
+
+  def initialize(project_folder)
+    config = ProjectConfiguration.new project_folder
+    @project = Project.new config
+  end
+
+  def getGemRoot
+    File.expand_path './..', File.dirname(__FILE__)
+  end
+
+  def run(test_run)
+    @project.specifications_and_results test_run
+  end
+
+  def self.create_new_project_structure(project_name)
+    ProjectTemplate.new project_name
+  end
+
+  def self.create_project_utility(project_folder)
+    config = ProjectConfiguration.new project_folder
+    @project_utility = ProjectUtility.new config
+  end
+
+  def self.combine_protocols
+    @project_utility.combine_protocols
+  end
+
+  def self.combine_run(test_run)
+    @project_utility.combine_run test_run
+  end
+
+  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.6
 platform: ruby
 authors:
 - Oleksandr Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-29 00:00:00.000000000 Z
-dependencies: []
+date: 2024-08-17 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,8 @@ files:
 - lib/almirah/navigation_pane.rb
 - lib/almirah/project.rb
 - lib/almirah/project_configuration.rb
+- lib/almirah/project_template.rb
+- lib/almirah/project_utility.rb
 - lib/almirah/search/specifications_db.rb
 - lib/almirah/templates/css/main.css
 - lib/almirah/templates/css/search.css
@@ -65,14 +88,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.17
 signing_key:
 specification_version: 4
 summary: Almirah