teuton 2.3.11 → 2.4.1

data/lib/teuton/report/formatter/{resume_html_formatter.rb → resume/html.rb}

@@ -1,21 +1,19 @@
-# frozen_string_literal: true
-
 require "erb"
-require_relative "resume_yaml_formatter"
-require_relative "../../application"
+require_relative "yaml"
+require_relative "../../../application"
 
-##
-# HTMLFormatter class receive a [Report] and generates HTML output.
 class ResumeHTMLFormatter < ResumeYAMLFormatter
   def initialize(report)
     super(report)
+    @ext = "html"
     @data = {}
-    filepath = File.join(File.dirname(__FILE__), "..", "..", "files", "template", "resume.html")
+    basedir = File.join(File.dirname(__FILE__), "..", "..", "..")
+    filepath = File.join(basedir, "files", "template", "resume.html")
     @template = File.read(filepath)
   end
 
-  def process
-    build_data
+  def process(options = {})
+    build_data(options)
     build_page
     deinit
   end

data/lib/teuton/report/formatter/{resume_json_formatter.rb → resume/json.rb}

@@ -1,15 +1,15 @@
 require "json/pure"
-require_relative "resume_array_formatter"
+require_relative "array"
 
-# JSONFormatter class
 class ResumeJSONFormatter < ResumeArrayFormatter
   def initialize(report)
     super(report)
+    @ext = "json"
     @data = {}
   end
 
-  def process
-    build_data
+  def process(options = {})
+    build_data(options)
     w @data.to_json # Write data into ouput file
     deinit
   end

data/lib/teuton/report/formatter/{resume_txt_formatter.rb → resume/txt.rb}

@@ -1,22 +1,20 @@
-# frozen_string_literal: true
-
 require "terminal-table"
 require "rainbow"
-require_relative "resume_array_formatter"
+require_relative "array"
 
-# TXTFormatter class
 class ResumeTXTFormatter < ResumeArrayFormatter
   def initialize(report, color = false)
     @color = color
     super(report)
+    @ext = "txt"
     @data = {}
   end
 
-  def process
+  def process(options = {})
     rainbow_state = Rainbow.enabled
     Rainbow.enabled = @color
 
-    build_data
+    build_data(options)
     process_config
     process_cases
     process_conn_errors

data/lib/teuton/report/formatter/{resume_yaml_formatter.rb → resume/yaml.rb}

@@ -1,13 +1,14 @@
-require_relative "resume_array_formatter"
+require_relative "array"
 
 class ResumeYAMLFormatter < ResumeArrayFormatter
   def initialize(report)
     super(report)
+    @ext = "yaml"
     @data = {}
   end
 
-  def process
-    build_data
+  def process(options = {})
+    build_data(options)
     w @data.to_yaml # Write data into ouput file
     deinit
   end

data/lib/teuton/report/report.rb

@@ -1,34 +1,14 @@
-# frozen_string_literal: true
-
-require "terminal-table"
 require_relative "../application"
-require_relative "formatter/formatter_factory"
-require_relative "show"
-require_relative "close"
+require_relative "formatter/formatter"
 
-##
-# This class maintain the results of every case, in a structured way.
-# * report/show.rb
-# * report/close.rb
 class Report
-  # @!attribute id
-  #   @return [Integer] It is the [Case] number. Zero indicates Resume Report.
   attr_accessor :id, :filename, :output_dir
-  # @!attribute head
-  #   @return [Hash] Report head information.
   attr_accessor :head
-  # @!attribute lines
-  #   @return [Array] Report body information.
   attr_accessor :lines
-  # @!attribute tail
-  #   @return [Hash] Report tail information.
   attr_accessor :tail
-  # @!attribute format
-  #   @return [Symbol] Indicate export format.
-  attr_reader :format
+  attr_accessor :format
   attr_reader :history
-  ##
-  # Class constructor
+
   def initialize(id = "00")
     @id = id
     @filename = "case-#{@id}"
@@ -42,30 +22,67 @@ class Report
     @history = ""
   end
 
-  ##
-  # Export [Case] data to specified format.
-  # @param format [Symbol] Select export format. Default value is :txt.
-  def export(format = :txt)
-    @format = format
-    filepath = File.join(@output_dir, @filename + "." \
-             + FormatterFactory.ext(@format))
+  def clone
+    report = Report.new
+    attrs = %i[id filename output_dir head lines tail format]
+    attrs.each do |attr|
+      attr_set = "#{attr}=".to_sym
+      report.send(attr_set, send(attr).clone)
+    end
 
-    formatter = FormatterFactory.get(self, @format, filepath)
-    formatter.process
+    report
   end
 
-  ##
-  # Export resumed data from all Cases, to specified format.
-  # @param format [Symbol] Select export format. Default value is :txt.
-  def export_resume(format = :txt)
+  def export(options)
+    filepath = File.join(@output_dir, @filename)
+    Formatter.call(self, options, filepath)
+  end
+
+  def export_resume(options)
+    format = options[:format]
     @format = "resume_#{format}".to_sym
-    filepath = File.join(@output_dir, @filename + "." \
-             + FormatterFactory.ext(@format))
-    formatter = FormatterFactory.get(self, @format, filepath)
-    formatter.process
+    options[:format] = @format
+    filepath = File.join(@output_dir, @filename)
+    Formatter.call(self, options, filepath)
+
+    filepath = File.join(@output_dir, "moodle")
+    Formatter.call(self, {format: :moodle_csv}, filepath)
+  end
+
+  ##
+  # Calculate final values:
+  # * grade
+  # * max_weight
+  # * good_weight,d
+  # * fail_weight
+  # * fail_counter
+  def close
+    app = Application.instance
+    max = 0.0
+    good = 0.0
+    fail = 0.0
+    fail_counter = 0
+    @lines.each do |i|
+      next unless i.instance_of? Hash
+
+      max += i[:weight] if i[:weight].positive?
+      if i[:check]
+        good += i[:weight]
+        @history += app.letter[:good]
+      else
+        fail += i[:weight]
+        fail_counter += 1
+        @history += app.letter[:bad]
+      end
+    end
+    @tail[:max_weight] = max
+    @tail[:good_weight] = good
+    @tail[:fail_weight] = fail
+    @tail[:fail_counter] = fail_counter
 
-    filepath = File.join(@output_dir, "moodle.csv")
-    formatter = FormatterFactory.get(self, :moodle_csv, filepath)
-    formatter.process
+    i = good.to_f / max
+    i = 0 if i.nan?
+    @tail[:grade] = (100.0 * i).round
+    @tail[:grade] = 0 if @tail[:unique_fault].positive?
   end
 end

data/lib/teuton/report/show.rb

@@ -1,48 +1,62 @@
-# frozen_string_literal: true
+require "rainbow"
+require_relative "../application"
 
-# Show methods for Report class.
-class Report
-  ##
-  # Display [Report] information on screen
-  def show
-    show_initial_configurations
-    if @filename.to_s.include? "resume"
+class ShowReport
+  def initialize(report)
+    @report = report
+  end
+
+  def call(verbose)
+    return if Application.instance.quiet?
+
+    show_initial_configurations if verbose > 2
+    if filename.to_s.include? "resume"
       show_resume
     else
       show_targets_history
     end
-    show_final_values
-    show_hall_of_fame
+    show_final_values if verbose > 1
+    show_hall_of_fame if verbose > 0
   end
 
   private
 
-  ##
-  # Display initial configurations
+  def filename
+    @report.filename
+  end
+
+  def head
+    @report.head
+  end
+
+  def lines
+    @report.lines
+  end
+
+  def tail
+    @report.tail
+  end
+
   def show_initial_configurations
     puts Rainbow("INITIAL CONFIGURATIONS").bright
     my_screen_table = Terminal::Table.new do |st|
-      @head.each do |key, value|
+      head.each do |key, value|
         st.add_row [key.to_s, trim(value)]
       end
     end
     puts "#{my_screen_table}\n\n"
   end
 
-  ##
-  # Display resume
   def show_resume
     show_case_list
     show_conn_status
   end
 
-  ##
-  # Display case list
   def show_case_list
     puts Rainbow("CASE RESULTS").bright
     my_screen_table = Terminal::Table.new do |st|
       st.add_row %w[CASE MEMBERS GRADE STATE]
-      @lines.each do |line|
+      lines.each do |line|
         st.add_row [line[:id], line[:members], line[:grade], line[:letter]]
       end
     end
@@ -51,13 +65,13 @@ class Report
 
   def show_conn_status
     errors = 0
-    @lines.each { |line| errors += line[:conn_status].size }
+    lines.each { |line| errors += line[:conn_status].size }
     return if errors.zero?
 
     puts Rainbow("CONN ERRORS").bright
     my_screen_table = Terminal::Table.new do |st|
       st.add_row %w[CASE MEMBERS HOST ERROR]
-      @lines.each do |line|
+      lines.each do |line|
         line[:conn_status].each_pair do |host, error|
           st.add_row [line[:id], line[:members], host, Rainbow(error).red.bright]
         end
@@ -69,10 +83,10 @@ class Report
   def show_targets_history
     tab = "  "
     puts Rainbow("CASE RESULTS").bright
-    if @lines.size == 1
-      puts @lines[0]
+    if lines.size == 1
+      puts lines[0]
     else
-      @lines.each do |i|
+      lines.each do |i|
         if i.class.to_s == "Hash"
           value = 0.0
           value = i[:weight] if i[:check]
@@ -91,7 +105,7 @@ class Report
   def show_final_values
     puts Rainbow("FINAL VALUES").bright
     my_screen_table = Terminal::Table.new do |st|
-      @tail.each do |key, value|
+      tail.each do |key, value|
         st.add_row [key.to_s, value.to_s]
       end
     end

data/lib/teuton/version.rb

@@ -1,5 +1,5 @@
 module Teuton
-  VERSION = "2.3.11"
+  VERSION = "2.4.1"
   APPNAME = "teuton"
   GEMNAME = "teuton"
   DOCKERNAME = "dvarrui/#{GEMNAME}"

data/lib/teuton.rb

@@ -38,7 +38,8 @@ module Teuton
       require_relative app.script_path
     rescue SyntaxError => e
       puts e.to_s
-      puts Rainbow.new("==> [FAIL] SyntaxError into file #{app.script_path}").red
+      puts Rainbow.new("[FAIL ] Reading file #{app.script_path}").red
+      puts Rainbow.new("[ERROR] Syntax Error!").red
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.3.11
+  version: 2.4.1
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2023-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,70 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: net-telnet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
 description: |2
     Intrastructure test, useful for:
     (1) Sysadmin teachers to evaluate students remote machines.
@@ -139,6 +139,7 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 - docs/CHANGELOG.md
+- docs/changelog/todo.md
 - docs/changelog/v2.0.md
 - docs/changelog/v2.1.md
 - docs/changelog/v2.2.md
@@ -165,12 +166,13 @@ extra_rdoc_files:
 - docs/es/guess_os.md
 - docs/ideas/Challenge-Server-Project.md
 - docs/ideas/contributions.md
-- docs/ideas/ideas.md
 - docs/ideas/servidor-de-retos.md
+- docs/ideas/todo.md
 - docs/install/README.md
 - docs/install/manual.md
 - docs/install/modes_of_use.md
-- docs/install/scripts.md
+- docs/install/s-node.md
+- docs/install/t-node.md
 - docs/install/vagrant_docker.md
 - docs/learn/01-target.md
 - docs/learn/02-config.md
@@ -187,6 +189,7 @@ extra_rdoc_files:
 - docs/learn/13-include.md
 - docs/learn/14-alias.md
 - docs/learn/16-exit_codes.md
+- docs/learn/17-hide-feedback.md
 - docs/learn/README.md
 - docs/learn/videos.md
 - docs/videos.md
@@ -195,6 +198,7 @@ files:
 - README.md
 - bin/teuton
 - docs/CHANGELOG.md
+- docs/changelog/todo.md
 - docs/changelog/v2.0.md
 - docs/changelog/v2.1.md
 - docs/changelog/v2.2.md
@@ -221,12 +225,13 @@ files:
 - docs/es/guess_os.md
 - docs/ideas/Challenge-Server-Project.md
 - docs/ideas/contributions.md
-- docs/ideas/ideas.md
 - docs/ideas/servidor-de-retos.md
+- docs/ideas/todo.md
 - docs/install/README.md
 - docs/install/manual.md
 - docs/install/modes_of_use.md
-- docs/install/scripts.md
+- docs/install/s-node.md
+- docs/install/t-node.md
 - docs/install/vagrant_docker.md
 - docs/learn/01-target.md
 - docs/learn/02-config.md
@@ -243,6 +248,7 @@ files:
 - docs/learn/13-include.md
 - docs/learn/14-alias.md
 - docs/learn/16-exit_codes.md
+- docs/learn/17-hide-feedback.md
 - docs/learn/README.md
 - docs/learn/videos.md
 - docs/videos.md
@@ -280,7 +286,6 @@ files:
 - lib/teuton/case_manager/hall_of_fame.rb
 - lib/teuton/case_manager/main.rb
 - lib/teuton/case_manager/report.rb
-- lib/teuton/case_manager/show.rb
 - lib/teuton/case_manager/utils.rb
 - lib/teuton/check/builtin.rb
 - lib/teuton/check/dsl.rb
@@ -295,24 +300,22 @@ files:
 - lib/teuton/readme/dsl.rb
 - lib/teuton/readme/lang.rb
 - lib/teuton/readme/readme.rb
-- lib/teuton/report/close.rb
-- lib/teuton/report/formatter/array_formatter.rb
 - lib/teuton/report/formatter/base_formatter.rb
-- lib/teuton/report/formatter/csv_formatter.rb
-- lib/teuton/report/formatter/formatter_factory.rb
-- lib/teuton/report/formatter/html_formatter.rb
-- lib/teuton/report/formatter/json_formatter.rb
-- lib/teuton/report/formatter/list_formatter.rb
+- lib/teuton/report/formatter/default/array.rb
+- lib/teuton/report/formatter/default/colored_text.rb
+- lib/teuton/report/formatter/default/html.rb
+- lib/teuton/report/formatter/default/json.rb
+- lib/teuton/report/formatter/default/txt.rb
+- lib/teuton/report/formatter/default/xml.rb
+- lib/teuton/report/formatter/default/yaml.rb
+- lib/teuton/report/formatter/formatter.rb
 - lib/teuton/report/formatter/moodle_csv_formatter.rb
-- lib/teuton/report/formatter/resume_array_formatter.rb
-- lib/teuton/report/formatter/resume_html_formatter.rb
-- lib/teuton/report/formatter/resume_json_formatter.rb
-- lib/teuton/report/formatter/resume_list_formatter.rb
-- lib/teuton/report/formatter/resume_txt_formatter.rb
-- lib/teuton/report/formatter/resume_yaml_formatter.rb
-- lib/teuton/report/formatter/txt_formatter.rb
-- lib/teuton/report/formatter/xml_formatter.rb
-- lib/teuton/report/formatter/yaml_formatter.rb
+- lib/teuton/report/formatter/resume/array.rb
+- lib/teuton/report/formatter/resume/colored_text.rb
+- lib/teuton/report/formatter/resume/html.rb
+- lib/teuton/report/formatter/resume/json.rb
+- lib/teuton/report/formatter/resume/txt.rb
+- lib/teuton/report/formatter/resume/yaml.rb
 - lib/teuton/report/report.rb
 - lib/teuton/report/show.rb
 - lib/teuton/skeleton.rb

data/docs/install/scripts.md

@@ -1,96 +0,0 @@
-[<< back](README.md)
-
-# Using scripts to install Teuton
-
-1. T-Node installation
-    * GNU/Linux
-    * MACOSX
-    * Windows
-2. S-Node installation
-    * GNU/Linux
-    * MACOSX
-    * Windows
-3. Tested OS list
-
----
-# 1. T-NODE installation
-
-* **T-node**: Host where Teuton software is installed. Monitor S-NODE hosts.
-
-## 1.1 T-NODE: GNU/Linux installation
-
-Run this command as `root` user:
-
-```bash
-wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/devel/install/linux/linux_t-node_install.sh | bash
-```
-
-## 1.2 T-NODE: Windows installation
-
-Requirements:
-* Windows 7+ / Windows Server 2003+
-* PowerShell v2+
-
-Run this command on **PowerShell (PS)** as `Administrator` user:
-
-```powershell
-Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/devel/install/windows/windows_t-node_install.ps1'))
-```
-
-## 1.3 T-NODE: Mac OS X installation
-
-Run this command as admin user (member of `admin` group):
-
-```bash
-curl -sL https://raw.githubusercontent.com/teuton-software/teuton/devel/install/mac/macosx_t-node_install.sh | bash
-```
-
----
-# 2. S-NODE installation
-
-* **S-node**: Host where SSH server is installed. This hosts are monitotized by T-NODE host.
-
-## 2.1 S-NODE: GNU/Linux installation
-
-Run this command as `root` user:
-
-```bash
-wget -qO- https://raw.githubusercontent.com/teuton-software/teuton/devel/install/linux/linux_s-node_install.sh | bash
-```
-
-## 2.2 S-NODE: Windows installation
-
-Requirements:
-* Windows 7+ / Windows Server 2003+
-* PowerShell v2+
-
-Run this command on **PowerShell (PS)** as `Administrator` user:
-
-```powershell
-Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/teuton-software/teuton/devel/install/windows/windows_s-node_install.ps1'))
-```
-
-## 2.3 S-NODE: Mac OS X installation
-
-Run this command as `root` user:
-
-```bash
-curl -sL https://raw.githubusercontent.com/teuton-software/teuton/devel/install/mac/macosx_s-node_install.sh | bash
-```
-
----
-# 3. Tested OS list
-
-| Type      | O.S.      | Version        | Arch   | T-node | S-node |
-| --------- | --------- | -------------- | ------ | ------ | ------ |
-| GNU/Linux | CentOS    | 7              | x86-64 |        |        |
-|           | Debian    | 9.7.0          | x86-64 | Ok     |        |
-|           | Fedora    | Workstation 29 | x84-64 | Ok     |        |
-|           | LinuxMint | 18.3           | x86-64 | Ok     |        |
-|           | openSUSE  | Leap 15        | x86-64 | Ok     | Ok     |
-|           | Ubuntu    | 18.04          | x86-64 | Ok     | Ok     |
-| Microsoft | Windows   | 7 Enterprise   | x86    | Ok     |        |
-|           | Windows   | 10 Pro         | x86-64 | Ok     | Ok     |
-|           | Windows   | Server 2012 R2 | x86-64 |        |        |
-| Apple     | Mac OS X  | Capitán (10.11.6) | x86-64 | Ok  | Ok     |
-|           | Mac OS X  | Sierra (10.12)    | x86-64 | Ok  |        |