RubyGems - teuton - Versions diffs - 2.3.11 → 2.4.0 - Mend

teuton 2.3.11 → 2.4.0

Files changed (61) hide show

checksums.yaml +4 -4
data/README.md +44 -13
data/docs/CHANGELOG.md +0 -13
data/docs/changelog/todo.md +18 -0
data/docs/changelog/v2.4.md +6 -2
data/docs/dsl/execution/export.md +9 -15
data/docs/dsl/execution/show.md +22 -7
data/docs/ideas/{ideas.md → todo.md} +8 -16
data/docs/learn/01-target.md +14 -43
data/docs/learn/02-config.md +20 -37
data/docs/learn/03-remote_hosts.md +20 -1
data/docs/learn/04-new_test.md +4 -4
data/docs/learn/05-use.md +3 -4
data/docs/learn/06-debug.md +6 -9
data/docs/learn/07-log.md +14 -14
data/docs/learn/08-readme.md +4 -4
data/docs/learn/13-include.md +13 -6
data/docs/learn/14-alias.md +14 -8
data/docs/learn/README.md +7 -7
data/lib/teuton/case_manager/case/case.rb +1 -5
data/lib/teuton/case_manager/case/dsl/expect.rb +2 -4
data/lib/teuton/case_manager/case/dsl/log.rb +1 -2
data/lib/teuton/case_manager/case/dsl/send.rb +4 -2
data/lib/teuton/case_manager/case/play.rb +1 -2
data/lib/teuton/case_manager/case/runner.rb +6 -7
data/lib/teuton/case_manager/case_manager.rb +15 -11
data/lib/teuton/case_manager/check_cases.rb +5 -7
data/lib/teuton/case_manager/dsl.rb +1 -1
data/lib/teuton/case_manager/export_manager.rb +13 -15
data/lib/teuton/case_manager/hall_of_fame.rb +20 -16
data/lib/teuton/case_manager/main.rb +1 -2
data/lib/teuton/case_manager/report.rb +3 -3
data/lib/teuton/report/formatter/base_formatter.rb +6 -7
data/lib/teuton/report/formatter/{array_formatter.rb → default/array.rb} +44 -9
data/lib/teuton/report/formatter/default/colored_text.rb +7 -0
data/lib/teuton/report/formatter/default/html.rb +24 -0
data/lib/teuton/report/formatter/default/json.rb +15 -0
data/lib/teuton/report/formatter/{txt_formatter.rb → default/txt.rb} +4 -3
data/lib/teuton/report/formatter/{xml_formatter.rb → default/xml.rb} +10 -4
data/lib/teuton/report/formatter/default/yaml.rb +15 -0
data/lib/teuton/report/formatter/formatter.rb +54 -0
data/lib/teuton/report/formatter/moodle_csv_formatter.rb +4 -10
data/lib/teuton/report/formatter/{resume_array_formatter.rb → resume/array.rb} +4 -7
data/lib/teuton/report/formatter/resume/colored_text.rb +7 -0
data/lib/teuton/report/formatter/{resume_html_formatter.rb → resume/html.rb} +7 -9
data/lib/teuton/report/formatter/{resume_json_formatter.rb → resume/json.rb} +4 -4
data/lib/teuton/report/formatter/{resume_txt_formatter.rb → resume/txt.rb} +4 -6
data/lib/teuton/report/formatter/{resume_yaml_formatter.rb → resume/yaml.rb} +4 -3
data/lib/teuton/report/report.rb +60 -43
data/lib/teuton/report/show.rb +38 -24
data/lib/teuton/version.rb +1 -1
metadata +32 -33
data/lib/teuton/case_manager/show.rb +0 -24
data/lib/teuton/report/close.rb +0 -38
data/lib/teuton/report/formatter/csv_formatter.rb +0 -25
data/lib/teuton/report/formatter/formatter_factory.rb +0 -79
data/lib/teuton/report/formatter/html_formatter.rb +0 -57
data/lib/teuton/report/formatter/json_formatter.rb +0 -12
data/lib/teuton/report/formatter/list_formatter.rb +0 -65
data/lib/teuton/report/formatter/resume_list_formatter.rb +0 -62
data/lib/teuton/report/formatter/yaml_formatter.rb +0 -15

data/lib/teuton/report/formatter/default/html.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require "erb"
+require_relative "yaml"
+class HTMLFormatter < YAMLFormatter
+  def initialize(report)
+    super(report)
+    @ext = "html"
+    @data = {}
+    basedir = File.join(File.dirname(__FILE__), "..", "..", "..")
+    filepath = File.join(basedir, "files", "template", "case.html")
+    @template = File.read(filepath)
+  end
+  def process(options = {})
+    build_data(options)
+    build_page
+    deinit
+  end
+  def build_page
+    render = ERB.new(@template)
+    w render.result(binding)
+  end
+end

data/lib/teuton/report/formatter/default/json.rb ADDED Viewed

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

data/lib/teuton/report/formatter/{txt_formatter.rb → default/txt.rb} RENAMED Viewed

@@ -1,19 +1,20 @@
 require "terminal-table"
 require "rainbow"
-require_relative "array_formatter"
+require_relative "array"
 class TXTFormatter < ArrayFormatter
   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_logs
     process_groups

data/lib/teuton/report/formatter/{xml_formatter.rb → default/xml.rb} RENAMED Viewed

@@ -1,9 +1,15 @@
-require_relative "base_formatter"
+require_relative "../base_formatter"
+require_relative "../../../version"
 class XMLFormatter < BaseFormatter
-  def process
+  def initialize(report)
+    super(report)
+    @ext = "xml"
+  end
+  def process(options = {})
     tab = "  "
-    w "<teuton version='0.2'>\n"
+    w "<teuton version='#{Teuton::VERSION}'>\n"
     w "#{tab}<head>\n"
     @head.each { |key, value| w "#{tab * 2}<#{key}>#{value}</#{key}>\n" }
     w "#{tab}</head>\n"
@@ -22,7 +28,7 @@ class XMLFormatter < BaseFormatter
       w "#{tab * 3}<check>#{i[:check]}</check>\n"
       w "#{tab * 3}<weigth>#{i[:weight]}</weigth>\n"
       w "#{tab * 2}</line>\n"
-		end
+    end
     w "#{tab}</lines>\n"
     w "#{tab}<tail>\n"
     @tail.each { |key, value| w "#{tab * 2}<#{key}>#{value}</#{key}>\n" }

data/lib/teuton/report/formatter/default/yaml.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require "yaml"
+require_relative "array"
+class YAMLFormatter < ArrayFormatter
+  def initialize(report)
+    super(report)
+    @ext = "yaml"
+  end
+  def process(options = {})
+    build_data(options)
+    w @data.to_yaml # Write data into ouput file
+    deinit
+  end
+end

data/lib/teuton/report/formatter/formatter.rb ADDED Viewed

@@ -0,0 +1,54 @@
+require "rainbow"
+require_relative "default/colored_text"
+require_relative "default/html"
+require_relative "default/json"
+require_relative "default/txt"
+require_relative "default/xml"
+require_relative "default/yaml"
+require_relative "resume/colored_text"
+require_relative "resume/html"
+require_relative "resume/json"
+require_relative "resume/txt"
+require_relative "resume/yaml"
+require_relative "moodle_csv_formatter"
+module Formatter
+  def self.call(report, options, filename)
+    klass = get(options[:format])
+    if klass.nil?
+      puts Rainbow("[ERROR] Unkown format: #{options[:format]}").red
+      puts Rainbow("        export format: FORMAT").red
+      exit 1
+    end
+    formatter = klass.new(report)
+    formatter.init(filename)
+    formatter.process(options)
+  end
+  def self.get(format)
+    list = {
+      colored_text: ColoredTextFormatter,
+      html: HTMLFormatter,
+      json: JSONFormatter,
+      txt: TXTFormatter,
+      xml: XMLFormatter,
+      yaml: YAMLFormatter,
+      moodle_csv: MoodleCSVFormatter,
+      resume_html: ResumeHTMLFormatter,
+      resume_json: ResumeJSONFormatter,
+      resume_txt: ResumeTXTFormatter,
+      resume_xml: ResumeTXTFormatter, # TODO
+      resume_yaml: ResumeYAMLFormatter
+    }
+    list[format]
+  end
+  def self.hide_feedback(report)
+    report2 = report.clone
+    report2.groups.each do |group|
+      group.each do |item|
+        puts item.to_s
+      end
+    end
+  end
+end

data/lib/teuton/report/formatter/moodle_csv_formatter.rb CHANGED Viewed

@@ -1,20 +1,14 @@
-# frozen_string_literal: true
-require_relative "resume_array_formatter"
+require_relative "resume/array"
 class MoodleCSVFormatter < ResumeArrayFormatter
-  ##
-  # initialize instance
-  # @param report (Report)
   def initialize(report)
     super(report)
+    @ext = "csv"
     @data = {}
   end
-  ##
-  # Process internal data and generates data with format
-  def process
-    build_data
+  def process(options = {})
+    build_data(options)
     process_cases
     deinit
   end

data/lib/teuton/report/formatter/{resume_array_formatter.rb → resume/array.rb} RENAMED Viewed

@@ -1,21 +1,18 @@
-# frozen_string_literal: true
+require_relative "../base_formatter"
-require_relative "base_formatter"
-# ArrayFormatter class: format report data into an array
 class ResumeArrayFormatter < BaseFormatter
   def initialize(report)
     super(report)
     @data = {}
   end
-  def process
-    build_data
+  def process(options = {})
+    build_data(options)
     w @data.to_s # Write data into ouput file
     deinit
   end
-  def build_data
+  def build_data(options)
     build_initial_data
     build_cases_data
     build_final_data

data/lib/teuton/report/formatter/resume/colored_text.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require_relative "txt"
+class ResumeColoredTextFormatter < ResumeTXTFormatter
+  def initialize(report)
+    super(report, true)
+  end
+end

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

@@ -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} RENAMED Viewed

@@ -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} RENAMED Viewed

@@ -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} RENAMED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

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