teuton 2.3.5 → 2.3.7

data/lib/teuton/report/formatter/array_formatter.rb

@@ -1,20 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'base_formatter'
+require_relative "base_formatter"
 
-##
-# ArrayFormatter class: format report data into an array
 class ArrayFormatter < BaseFormatter
-  ##
-  # Initialize class
-  # @param report (Report) Format report data into Array
   def initialize(report)
     super(report)
     @data = {}
   end
 
-  ##
-  # Execute format action
   def process
     build_data
     w @data.to_s # Write data into ouput file
@@ -34,49 +27,45 @@ class ArrayFormatter < BaseFormatter
     @data[:config] = head
   end
 
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   def build_history_data
     @data[:logs] = []
     groups = []
     title = nil
     targets = []
     @lines.each do |i|
-      if i.class.to_s == 'Hash'
-        value = 0.0
-        value = i[:weight] if i[:check]
-        if i[:groupname] != title
-          # Add currentgroup
-          groups << { title: title, targets: targets } unless title.nil?
-          # Create new group
-          title = i[:groupname]
-          targets = []
-        end
-
-        target = {}
-        # target[:target_id]   = format('%02d', i[:id])
-        target[:target_id]   = format('%<id>02d', id: i[:id])
-        target[:check]       = i[:check]
-        target[:score]       = value
-        target[:weight]      = i[:weight]
-        target[:description] = i[:description]
-        target[:command]     = i[:command]
-        target[:conn_type]   = i[:conn_type]
-        target[:duration]    = i[:duration]
-        target[:alterations] = i[:alterations]
-        target[:expected]    = i[:expected]
-        target[:result]      = i[:result]
-        targets << target
-      else
+      unless i.instance_of? Hash
         @data[:logs] << i.to_s # Add log line
+        next
+      end
+
+      value = 0.0
+      value = i[:weight] if i[:check]
+      if i[:groupname] != title
+        # Add currentgroup
+        groups << {title: title, targets: targets} unless title.nil?
+        # Create new group
+        title = i[:groupname]
+        targets = []
       end
+
+      target = {}
+      target[:target_id] = format("%<id>02d", id: i[:id])
+      target[:check] = i[:check]
+      target[:score] = value
+      target[:weight] = i[:weight]
+      target[:description] = i[:description]
+      target[:command] = i[:command]
+      target[:conn_type] = i[:conn_type]
+      target[:duration] = i[:duration]
+      target[:alterations] = i[:alterations]
+      target[:expected] = i[:expected]
+      target[:result] = i[:result]
+      targets << target
     end
 
-    groups << { title: title, targets: targets } unless title.nil?
+    groups << {title: title, targets: targets} unless title.nil?
     @data[:groups] = groups
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 
   def build_final_data
     tail = {}

data/lib/teuton/report/formatter/base_formatter.rb

@@ -1,28 +1,19 @@
 # frozen_string_literal: true
 
-# BaseFormatter class
 class BaseFormatter
-  ##
-  # Initialize class
-  # @param report (Report) Format report data
   def initialize(report)
     @head = report.head
     @lines = report.lines
     @tail = report.tail
   end
 
-  ##
-  # Execute format action
   def process
-    raise 'Empty method!'
+    raise "Empty method!"
   end
 
-  ##
-  # Creates new output file
-  # @param filename (String) Path to output file
   def init(filename)
     @filename = filename
-    @file = File.open(@filename, 'w')
+    @file = File.open(@filename, "w")
   end
 
   ##
@@ -32,8 +23,6 @@ class BaseFormatter
     @file.write text.to_s
   end
 
-  ##
-  # Close open output file
   def deinit
     @file.close
   end

data/lib/teuton/report/formatter/csv_formatter.rb

@@ -1,31 +1,25 @@
-
-require_relative 'base_formatter'
+require_relative "base_formatter"
 
 class CSVFormatter < BaseFormatter
-	def initialize(report)
-		super(report)
-	end
-
 	def process
-		d = ';'
-		@head.each { |key,value| w "HEAD#{d}#{key}#{d}#{value}\n" }
+		d = ";"
+		@head.each { |key, value| w "HEAD#{d}#{key}#{d}#{value}\n" }
 		@datagroups.each { |item| process_datagroup(item,d) }
-		@tail.each { |key,value| w "TAIL#{d}#{key}#{d}#{value}\n" }
+		@tail.each { |key, value| w "TAIL#{d}#{key}#{d}#{value}\n" }
 		deinit
 	end
 
-	def process_datagroup(pGroup, delimiter=';')
+	def process_datagroup(group, delimiter = ";")
 		d = delimiter
-		a = "DATAGROUP"+pGroup.order.to_s+d
-		pGroup.head.each { |key,value| w a+"HEAD"+d+key.to_s+d+value.to_s+"\n" }
-		pGroup.lines.each do |i|
-			if i.class.to_s=='Hash' then
-				w a + "LINES#{d}ACTION#{d}#{i[:id]}#{d}#{i[:weight]}#{d}" +
-				      "#{i[:description]}\n"
+		a = "DATAGROUP#{group.order}#{d}"
+		group.head.each { |key, value| w "#{a}HEAD#{d}#{key}#{d}#{value}\n" }
+		group.lines.each do |i|
+			if i.instance_of? Hash
+				w "#{a}LINES#{d}ACTION#{d}#{i[:id]}#{d}#{i[:weight]}#{d}#{i[:description]}\n"
 			else
-				w a + "LINES#{d}LOG#{d}#{i}\n"
+        w "#{a}LINES#{d}LOG#{d}#{i}\n"
 			end
 		end
-		pGroup.tail.each { |key,value| w a+"TAIL"+d+key.to_s+d+value.to_s+"\n" }
+		group.tail.each { |key, value| w "#{a}TAIL#{d}#{key}#{d}#{value}\n" }
 	end
 end

data/lib/teuton/report/formatter/formatter_factory.rb

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
-require 'rainbow'
-require_relative 'json_formatter'
-require_relative 'html_formatter'
-require_relative 'list_formatter'
-require_relative 'txt_formatter'
-require_relative 'yaml_formatter'
-require_relative 'resume_json_formatter'
-require_relative 'resume_html_formatter'
-require_relative 'resume_list_formatter'
-require_relative 'resume_yaml_formatter'
-require_relative 'resume_txt_formatter'
-require_relative 'moodle_csv_formatter'
-require_relative 'csv_formatter'
-require_relative 'xml_formatter'
+require "rainbow"
+require_relative "json_formatter"
+require_relative "html_formatter"
+require_relative "list_formatter"
+require_relative "txt_formatter"
+require_relative "yaml_formatter"
+require_relative "resume_json_formatter"
+require_relative "resume_html_formatter"
+require_relative "resume_list_formatter"
+require_relative "resume_yaml_formatter"
+require_relative "resume_txt_formatter"
+require_relative "moodle_csv_formatter"
+require_relative "csv_formatter"
+require_relative "xml_formatter"
 
 # FormaterFactory module
 module FormatterFactory
   def self.get(report, format, filename)
     case format
     when :colored_text
-      f = TXTFormatter.new(report,true)
+      f = TXTFormatter.new(report, true)
     when :csv
       f = CSVFormatter.new(report)
     when :html
@@ -30,7 +30,7 @@ module FormatterFactory
     when :list
       f = ListFormatter.new(report)
     when :txt
-      f = TXTFormatter.new(report,false)
+      f = TXTFormatter.new(report, false)
     when :xml
       f = XMLFormatter.new(report)
     when :yaml
@@ -57,19 +57,21 @@ module FormatterFactory
   end
 
   def self.ext(format)
-    data = { cvs: 'csv',
-             colored_text: 'txt',
-             json: 'json',
-             list: 'txt',
-             txt: 'txt',
-             yaml: 'yaml',
-             resume_colored_text: 'txt',
-             resume_csv: 'csv',
-             resume_json: 'json',
-             resume_html: 'html',
-             resume_list: 'txt',
-             resume_txt: 'txt',
-             resume_yaml: 'yaml' }
+    data = {
+      cvs: "csv",
+      colored_text: "txt",
+      json: "json",
+      list: "txt",
+      txt: "txt",
+      yaml: "yaml",
+      resume_colored_text: "txt",
+      resume_csv: "csv",
+      resume_json: "json",
+      resume_html: "html",
+      resume_list: "txt",
+      resume_txt: "txt",
+      resume_yaml: "yaml"
+    }
     return format.to_s if data[format].nil?
 
     data[format]

data/lib/teuton/report/formatter/html_formatter.rb

@@ -1,15 +1,10 @@
 # frozen_string_literal: true
 
-require 'erb'
-require_relative 'yaml_formatter'
-require_relative '../../application'
+require "erb"
+require_relative "yaml_formatter"
+require_relative "../../application"
 
-##
-# HTMLFormatter class receive a [Report] and generates HAML output.
 class HTMLFormatter < YAMLFormatter
-  ##
-  # Class constructor
-  # @param report [Report] Parent object that contains data to be exported.
   def initialize(report)
     super(report)
     @data = {}
@@ -17,25 +12,46 @@ class HTMLFormatter < YAMLFormatter
     @template = File.read(filepath)
   end
 
-  ##
-  # Process data from parent object and export it into YAML format.
   def process
     build_data
     build_page
     deinit
   end
 
-  ##
-  # Build html case page
   def build_page
-    config = @data[:config]
-    results = @data[:results]
-    logs = @data[:logs]
-    groups = @data[:groups]
-    groups = @data[:groups]
-    hall_of_fame = @data[:hall_of_fame]
-    version = Application::VERSION
-    renderer = ERB.new(@template)
-    w renderer.result(binding)
+    # config = @data[:config]
+    # results = @data[:results]
+    # logs = @data[:logs]
+    # groups = @data[:groups]
+    # hall_of_fame = @data[:hall_of_fame]
+    # version = Application::VERSION
+    render = ERB.new(@template)
+    w render.result(binding)
+  end
+
+  private
+
+  def config
+    @data[:config]
+  end
+
+  def results
+    @data[:results]
+  end
+
+  def logs
+    @data[:logs]
+  end
+
+  def groups
+    @data[:groups]
+  end
+
+  def hall_of_fame
+    @data[:hall_of_fame]
+  end
+
+  def version
+    Application::VERSION
   end
 end

data/lib/teuton/report/formatter/json_formatter.rb

@@ -1,15 +1,9 @@
 # frozen_string_literal: true
 
-require 'json/pure'
-require_relative 'array_formatter'
+require "json/pure"
+require_relative "array_formatter"
 
-# JSONFormatter class
 class JSONFormatter < ArrayFormatter
-  def initialize(report)
-    super(report)
-    @data = {}
-  end
-
   def process
     build_data
     w @data.to_json # Write data into ouput file

data/lib/teuton/report/formatter/list_formatter.rb

@@ -1,14 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'array_formatter'
+require_relative "array_formatter"
 
-# ListFormatter class
 class ListFormatter < ArrayFormatter
-  def initialize(report)
-    super(report)
-    @data = {}
-  end
-
   def process
     build_data
     process_config
@@ -23,7 +17,7 @@ class ListFormatter < ArrayFormatter
 
   def process_config
     w "CONFIGURATION\n"
-    @data[:config].sort.each { |key,value| w "  * #{key} : #{value}\n" }
+    @data[:config].sort.each { |key, value| w "  * #{key} : #{value}\n" }
     w "\n\n"
   end
 
@@ -43,8 +37,8 @@ class ListFormatter < ArrayFormatter
 
   def process_results
     w "\nRESULTS\n"
-    @data[:results].each do |key,value|
-      w "  * #{key.to_s} : #{value.to_s}\n"
+    @data[:results].each do |key, value|
+      w "  * #{key} : #{value}\n"
     end
   end
 
@@ -60,10 +54,10 @@ class ListFormatter < ArrayFormatter
   private
 
   def process_group(group)
-    tab = '  '
+    tab = "  "
     w "- #{group[:title]}\n"
     group[:targets].each do |i|
-      w tab*2 + "#{format("%02d", i[:target_id].to_i)}"
+      w "#{tab * 2}#{format("%02d", i[:target_id].to_i)}"
       w " (#{i[:score]}/#{i[:weight]}) "
       w "#{i[:description]}\n"
     end

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

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'resume_array_formatter'
+require_relative "resume_array_formatter"
 
-##
-# Format data to Moodle CSV
 class MoodleCSVFormatter < ResumeArrayFormatter
   ##
   # initialize instance
@@ -28,10 +26,9 @@ class MoodleCSVFormatter < ResumeArrayFormatter
     w "MoodleID, TeutonGrade, TeutonFeedback\n"
     @data[:cases].each do |line|
       moodle_id = line[:moodle_id]
-      moodle_id = line[:moodle_id].split(',') if moodle_id.class == String
+      moodle_id = line[:moodle_id].split(",") if moodle_id.instance_of? String
       moodle_id.each do |id|
-        w "#{id.strip},#{line[:grade]}," \
-          "#{line[:moodle_feedback]}\n" unless line[:skip]
+        w "#{id.strip},#{line[:grade]},#{line[:moodle_feedback]}\n" unless line[:skip]
       end
     end
   end

data/lib/teuton/report/formatter/resume_array_formatter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'base_formatter'
+require_relative "base_formatter"
 
 # ArrayFormatter class: format report data into an array
 class ResumeArrayFormatter < BaseFormatter

data/lib/teuton/report/formatter/resume_html_formatter.rb

@@ -1,39 +1,49 @@
 # frozen_string_literal: true
 
-require 'erb'
-require_relative 'resume_yaml_formatter'
-require_relative '../../application'
+require "erb"
+require_relative "resume_yaml_formatter"
+require_relative "../../application"
 
 ##
-# HTMLFormatter class receive a [Report] and generates HAML output.
+# HTMLFormatter class receive a [Report] and generates HTML output.
 class ResumeHTMLFormatter < ResumeYAMLFormatter
-  ##
-  # Class constructor
-  # @param report [Report] Parent object that contains data to be exported.
   def initialize(report)
     super(report)
     @data = {}
-    filepath = File.join(File.dirname(__FILE__), '..', '..', 'files', 'template', 'resume.html')
+    filepath = File.join(File.dirname(__FILE__), "..", "..", "files", "template", "resume.html")
     @template = File.read(filepath)
   end
 
-  ##
-  # Process data from parent object and export it into YAML format.
   def process
     build_data
     build_page
     deinit
   end
 
-  ##
-  # Build html case page
   def build_page
-    config = @data[:config]
-    cases = @data[:cases]
-    results = @data[:results]
-    hall_of_fame = @data[:hall_of_fame]
-    version = Application::VERSION
-    renderer = ERB.new(@template)
-    w renderer.result(binding)
+    render = ERB.new(@template)
+    w render.result(binding)
+  end
+
+  private
+
+  def config
+    @data[:config]
+  end
+
+  def cases
+    @data[:cases]
+  end
+
+  def results
+    @data[:results]
+  end
+
+  def hall_of_fame
+    @data[:hall_of_fame]
+  end
+
+  def version
+    Application::VERSION
   end
 end

data/lib/teuton/report/formatter/resume_json_formatter.rb

@@ -1,6 +1,5 @@
-
-require 'json/pure'
-require_relative 'resume_array_formatter'
+require "json/pure"
+require_relative "resume_array_formatter"
 
 # JSONFormatter class
 class ResumeJSONFormatter < ResumeArrayFormatter

data/lib/teuton/report/formatter/resume_list_formatter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'resume_array_formatter'
+require_relative "resume_array_formatter"
 
 # ResumeListFormatter class
 class ResumeListFormatter < ResumeArrayFormatter
@@ -23,7 +23,7 @@ class ResumeListFormatter < ResumeArrayFormatter
 
   def process_config
     w "CONFIGURATION\n"
-    @data[:config].each do |key,value|
+    @data[:config].each do |key, value|
       w "  * #{key}: #{trim(value)}\n"
     end
   end
@@ -31,7 +31,7 @@ class ResumeListFormatter < ResumeArrayFormatter
   def process_cases
     w "CASES\n"
     @data[:cases].each do |line|
-      w "  [#{line[:id]}] #{line[:members]}   :#{format('%3d', line[:grade])}\n"
+      w "  [#{line[:id]}] #{line[:members]}   :#{format("%3d", line[:grade])}\n"
     end
   end
 
@@ -46,7 +46,7 @@ class ResumeListFormatter < ResumeArrayFormatter
 
   def process_results
     w "\nRESULTS\n"
-    @data[:results].each do |key,value|
+    @data[:results].each do |key, value|
       w "  * #{key}: #{value}\n"
     end
   end

data/lib/teuton/report/formatter/resume_txt_formatter.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'terminal-table'
-require 'rainbow'
-require_relative 'resume_array_formatter'
+require "terminal-table"
+require "rainbow"
+require_relative "resume_array_formatter"
 
 # TXTFormatter class
 class ResumeTXTFormatter < ResumeArrayFormatter
@@ -30,7 +30,7 @@ class ResumeTXTFormatter < ResumeArrayFormatter
   private
 
   def process_config
-    w "#{Rainbow('CONFIGURATION').bg(:blue)}\n"
+    w "#{Rainbow("CONFIGURATION").bg(:blue)}\n"
     my_screen_table = Terminal::Table.new do |st|
       @data[:config].each do |key, value|
         st.add_row [key.to_s, trim(value)]
@@ -39,21 +39,21 @@ class ResumeTXTFormatter < ResumeArrayFormatter
     w "#{my_screen_table}\n\n"
   end
 
-  # rubocop:disable Metrics/MethodLength
   def process_cases
-    w "#{Rainbow('CASES').bg(:blue)}\n"
+    w "#{Rainbow("CASES").bg(:blue)}\n"
     my_screen_table = Terminal::Table.new do |st|
       st.add_row %w[CASE MEMBERS GRADE STATE]
       @data[:cases].each do |line|
-        st.add_row [line[:id],
-                    line[:members],
-                    format('  %<grade>3d', { grade: line[:grade] }),
-                    line[:letter]]
+        st.add_row [
+          line[:id],
+          line[:members],
+          format("  %<grade>3d", {grade: line[:grade]}),
+          line[:letter]
+        ]
       end
     end
     w "#{my_screen_table}\n\n"
   end
-  # rubocop:enable Metrics/MethodLength
 
   def process_conn_errors
     my_screen_table = Terminal::Table.new do |st|
@@ -66,11 +66,11 @@ class ResumeTXTFormatter < ResumeArrayFormatter
     end
     return unless my_screen_table.rows.size > 1
 
-    w "#{Rainbow('CONN ERRORS').bg(:red)}\n#{my_screen_table}\n"
+    w "#{Rainbow("CONN ERRORS").bg(:red)}\n#{my_screen_table}\n"
   end
 
   def process_results
-    w "\n#{Rainbow('RESULTS').bg(:blue)}\n"
+    w "\n#{Rainbow("RESULTS").bg(:blue)}\n"
     my_screen_table = Terminal::Table.new do |st|
       @data[:results].each do |key, value|
         st.add_row [key.to_s, value.to_s]
@@ -79,12 +79,10 @@ class ResumeTXTFormatter < ResumeArrayFormatter
     w "#{my_screen_table}\n"
   end
 
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   def process_hof
     return if @data[:hall_of_fame].size < 3
 
-    w "\n#{Rainbow('HALL OF FAME').bg(:blue)}\n"
+    w "\n#{Rainbow("HALL OF FAME").bg(:blue)}\n"
     my_screen_table = Terminal::Table.new do |st|
       @data[:hall_of_fame].each do |line|
         mycolor = :green
@@ -100,6 +98,4 @@ class ResumeTXTFormatter < ResumeArrayFormatter
     end
     w "#{my_screen_table}\n"
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 end

data/lib/teuton/report/formatter/resume_yaml_formatter.rb

@@ -1,19 +1,11 @@
+require_relative "resume_array_formatter"
 
-require_relative 'resume_array_formatter'
-
-##
-# ResumeHTMLFormatter class
 class ResumeYAMLFormatter < ResumeArrayFormatter
-  ##
-  # Initialize class
-  # @param report (Report)
   def initialize(report)
     super(report)
     @data = {}
   end
 
-  ##
-  # Process resume report
   def process
     build_data
     w @data.to_yaml # Write data into ouput file