teuton 2.1.8 → 2.1.9

data/lib/teuton/project/laboratory/builtin.rb

@@ -1,4 +1,5 @@
-
+#
+# EXPERIMENTAL class
 class Builtin
   attr_accessor :param
 

data/lib/teuton/project/laboratory/dsl.rb

@@ -11,7 +11,7 @@
 # * set
 class Laboratory
   def readme(_text)
-    # Usefull for "teuton reamde" action.
+    # Usefull for "teuton readme" command action.
   end
 
   def target(desc, args = {})
@@ -23,37 +23,35 @@ class Laboratory
   end
   alias goal target
 
-  def request(text)
-    @requests << text.to_s
-  end
+#  def request(text)
+#    @requests << text.to_s
+#  end
 
   def tempfile(_tempfile = nil)
     'tempfile'
   end
 
+  def run(command, args = {})
+    args[:exec] = command
+    host = :localhost
+    host = args[:on] if args[:on]
+    goto(host, args)
+  end
+
   def goto(host = :localhost, args = {})
     result.reset
+    args[:on] = host unless args[:on]
 
     if @hosts[host]
       @hosts[host] += 1
     else
       @hosts[host] = 1
     end
-    verboseln "      goto        #{host} and #{args}"
-  end
-
-  def run(command, args = {})
-    args[:exec] = command
-    goto(:localhost, args)
+    verboseln "      run         '#{args[:exec]}' on #{args[:on]}"
   end
 
   def expect(_cond, args = {})
-    #unless [ String, Array, Regexp].include? _cond.class
-    #  verboseln "[ERROR] expect #{_cond} (#{_cond.class})"
-    #  return
-    #end
     verboseln "      alter       #{result.alterations}" unless result.alterations.empty?
-    #verboseln "      expect      #{result.expected} (#{result.expected.class})"
     verboseln "      expect      #{_cond} (#{_cond.class})"
     verboseln ''
   end

data/lib/teuton/project/laboratory/laboratory.rb

@@ -43,6 +43,8 @@ alias play start
 class Laboratory
   attr_reader :result
 
+  ##
+  # Initialize instance
   def initialize(script_path, config_path)
     @path = {}
     @path[:script]   = script_path
@@ -52,6 +54,8 @@ class Laboratory
     reset
   end
 
+  ##
+  # Set attibutes to default values
   def reset
     @result = Result.new
     @targetid = 0
@@ -59,7 +63,7 @@ class Laboratory
     @gets = {}
     @sets = {}
     @hosts = {}
-    @requests = []
+    @requests = [] # REVISE this
     @verbose = Application.instance.verbose
   end
 end

data/lib/teuton/project/laboratory/show.rb

@@ -9,6 +9,8 @@ require_relative '../configfile_reader'
 # * show_stats
 # * show_config
 class Laboratory
+  ##
+  # Display DSL on screen
   def show_dsl
     @verbose = true
     process_content
@@ -16,6 +18,8 @@ class Laboratory
     show_config
   end
 
+  ##
+  # Display stats on screen
   def show_stats
     @stats[:hosts] = 0
     @hosts.each_pair { |_k, v| @stats[:hosts] += v }
@@ -45,6 +49,8 @@ class Laboratory
     verboseln my_screen_table.to_s + "\n"
   end
 
+  ##
+  # Display config on screen
   def show_config
     @verbose = false
     process_content
@@ -52,19 +58,19 @@ class Laboratory
     revise_config_content
   end
 
-  def show_requests
-    @verbose = false
-    process_content
-    @verbose = true
-    my_screen_table = Terminal::Table.new do |st|
-      st.add_row ['Lines', 'REQUEST description']
-      st.add_separator
-      @requests.each_with_index do |line, index|
-        st.add_row ['%03d' % index, line]
-      end
-    end
-    verboseln my_screen_table
-  end
+#  def show_requests
+#    @verbose = false
+#    process_content
+#    @verbose = true
+#    my_screen_table = Terminal::Table.new do |st|
+#      st.add_row ['Lines', 'REQUEST description']
+#      st.add_separator
+#      @requests.each_with_index do |line, index|
+#        st.add_row ['%03d' % index, line]
+#      end
+#    end
+#    verboseln my_screen_table
+#  end
 
   private
 
@@ -121,6 +127,8 @@ class Laboratory
     verboseln YAML.dump(output)
   end
 
+  ##
+  # Revive and check config content
   def revise_config_content
     @verbose = true
     my_screen_table = Terminal::Table.new do |st|

data/lib/teuton/project/name_file_finder.rb

@@ -116,6 +116,8 @@ module NameFileFinder
     verboseln Rainbow(trim(app.script_path)).blue.bright
     verbose Rainbow('[INFO] ConfigPath => ').blue
     verboseln Rainbow(trim(app.config_path)).blue.bright
+    verbose Rainbow('[INFO] Pwd        => ').blue
+    verboseln Rainbow(app.running_basedir).blue.bright
     verbose Rainbow('[INFO] TestName   => ').blue
     verboseln Rainbow(trim(app.test_name)).blue.bright
   end
@@ -125,8 +127,11 @@ module NameFileFinder
   # @param input (String)
   # @return String
   def self.trim(input)
+    return input unless input.to_s.start_with? Dir.pwd.to_s
+
     output = input.to_s
-    output = "...#{input[input.size - 50, input.size]}" if output.size > 65
+    offset = (Dir.pwd).length + 1
+    output = "#{input[offset, input.size]}"
     output.to_s
   end
 

data/lib/teuton/project/project.rb

@@ -33,16 +33,20 @@ module Project  ##
   # @param options (Array) Array of input options
   def self.play(projectpath, options)
     Application.instance.options.merge! options
-    process_input_case_option
+    process_input_options
     NameFileFinder.find_filenames_for(projectpath)
     NameFileFinder.puts_input_info_on_screen
     require_dsl_and_script('../case_manager/dsl') # Define DSL keywords
   end
 
   ##
-  # Convert input case options String to an Array of integers
-  def self.process_input_case_option
+  # Preprocess input options:
+  # * Convert input case options String to an Array of integers
+  # * Read color input option
+  def self.process_input_options
     options = Application.instance.options
+    options['color'] = true if options['color'].nil?
+    Rainbow.enabled = options['color']
     return if options['case'].nil?
 
     a = options['case'].split(',')

data/lib/teuton/project/readme/dsl.rb

@@ -59,7 +59,9 @@ class Readme
 
   def run(command, args = {})
     args[:exec] = command
-    goto(:localhost, args)
+    host = :localhost
+    host = args[:on] if args[:on]
+    goto(host, args)
   end
 
   def expect(_cond, _args = {})

data/lib/teuton/project/readme/readme.rb

@@ -31,6 +31,10 @@ class Readme
   attr_reader :result
   attr_reader :data
 
+  ##
+  # Initialize Readme instance
+  # @param script_path (String) Path to main rb file (start.rb)
+  # @param config_path (String) Path to main config file (config.yaml)
   def initialize(script_path, config_path)
     @path = {}
     @path[:script]   = script_path
@@ -76,30 +80,8 @@ class Readme
     show_tail
   end
 
-  def show_content
-    @data[:groups].each do |group|
-      next if group[:actions].empty?
-
-      puts "\n## #{group[:name]}\n\n"
-      group[:readme].each { |line| puts "#{line}\n" }
-      previous_host = nil
-      group[:actions].each_with_index do |item, index|
-        if item[:host].nil? && index.positive?
-          item[:host] = group[:actions][0][:host]
-        end
-        if previous_host.nil? || item[:host] != previous_host
-          previous_host = item[:host] || 'null'
-          puts format(Lang::get(:goto), previous_host.upcase)
-        end
-
-        weight = ''
-        weight = "(x#{item[:weight]}) " if item[:weight] != 1.0
-        puts "* #{weight}#{item[:target]}"
-        item[:readme].each { |line| puts "    * #{line}\n" }
-      end
-    end
-  end
-
+  ##
+  # Show README head
   def show_head
     app = Application.instance
     puts '```'
@@ -107,8 +89,8 @@ class Readme
     puts format(Lang::get(:date), Time.now)
     puts format(Lang::get(:version), Application::VERSION)
     puts '```'
-    puts "\n---\n"
-    puts "# README.md\n"
+    puts "\n"
+    puts "# #{app.test_name}\n"
 
     i = 1
     unless @required_hosts.empty?
@@ -135,6 +117,35 @@ class Readme
     end
   end
 
+  ##
+  # Show README content
+  def show_content
+    @data[:groups].each do |group|
+      next if group[:actions].empty?
+
+      puts "\n## #{group[:name].capitalize}\n\n"
+      group[:readme].each { |line| puts "#{line}\n" }
+      previous_host = nil
+      group[:actions].each_with_index do |item, index|
+        if item[:host].nil? && index.positive?
+          item[:host] = group[:actions][0][:host]
+        end
+        if previous_host.nil? || item[:host] != previous_host
+          previous_host = item[:host] || 'null'
+          puts format(Lang::get(:goto), previous_host.upcase)
+        end
+
+        weight = ''
+        weight = "(x#{item[:weight]}) " if item[:weight] != 1.0
+        last = (item[:target].end_with?('.') ? '' : '.')
+        puts "* #{weight}#{item[:target]}#{last}"
+        item[:readme].each { |line| puts "    * #{line}\n" }
+      end
+    end
+  end
+
+  ##
+  # Show README tail
   def show_tail
     return if @global_params.empty?
 

data/lib/teuton/project/skeleton.rb

@@ -11,6 +11,9 @@ require 'rainbow'
 # * create_dirs
 # * copyfile
 module Skeleton
+  ##
+  # Create teuton project skeleton
+  # @param project_dir (String)
   def self.create(project_dir)
     project_name = File.basename(project_dir)
     puts "\n[INFO] Creating #{Rainbow(project_name).bright} project skeleton"
@@ -19,12 +22,15 @@ module Skeleton
     create_main_dir_and_files(project_dir, source_basedir)
   end
 
+  ##
+  # Create main dir and files
+  # @param project_dir (String)
+  # @param source_basedir (String)
   def self.create_main_dir_and_files(project_dir, source_basedir)
     # Directory and files: Ruby script, Configfile, gitignore
     items = [
       { source: 'files/config.yaml', target: 'config.yaml' },
       { source: 'files/start.rb', target: 'start.rb' },
-    # { source: 'files/README.md', target: 'README.md' },
       { source: 'files/gitignore', target: '.gitignore' }
     ]
     items.each do |item|
@@ -34,6 +40,9 @@ module Skeleton
     end
   end
 
+  ##
+  # Create dir
+  # @param dirpath (String)
   def self.create_dir(dirpath)
     if Dir.exist? dirpath
       puts "* Exists dir!       => #{Rainbow(dirpath).yellow}"
@@ -47,17 +56,24 @@ module Skeleton
     end
   end
 
+  ##
+  # Create dirs
+  # @param args (Array)
   def self.create_dirs(*args)
     args.each { |arg| create_dir arg }
   end
 
-  def self.copyfile(target, dest)
+  ##
+  # Copy file
+  # @param source (String) Source file
+  # @param dest (String) Dest file
+  def self.copyfile(source, dest)
     if File.exist? dest
       puts "* Exists file!      => #{Rainbow(dest).yellow}"
     else
-      puts "* File not found!   => #{Rainbow(target).yellow}" unless File.exist? target
+      puts "* File not found!   => #{Rainbow(source).yellow}" unless File.exist? source
       begin
-        FileUtils.cp(target, dest)
+        FileUtils.cp(source, dest)
         puts "* Create file       => #{Rainbow(dest).green}"
       rescue StandardError
         puts "* Create file ERROR => #{Rainbow(dest).red}"

data/lib/teuton/report/close.rb

@@ -9,6 +9,8 @@ class Report
   # * good_weight,d
   # * fail_weight
   # * fail_counter
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def close
     app = Application.instance
     max = 0.0
@@ -16,16 +18,16 @@ class Report
     fail = 0.0
     fail_counter = 0
     @lines.each do |i|
-      if i.class.to_s == '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
+      next unless i.class.to_s == '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
@@ -33,9 +35,11 @@ class Report
     @tail[:fail_weight] = fail
     @tail[:fail_counter] = fail_counter
 
-    i = good.to_f / max.to_f
+    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
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 end

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

@@ -2,16 +2,17 @@
 
 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 'html_formatter'
 require_relative 'xml_formatter'
 
 # FormaterFactory module
@@ -23,7 +24,7 @@ module FormatterFactory
     when :csv
       f = CSVFormatter.new(report)
     when :html
- #     f = HTMLFormatter.new(report)
+      f = HTMLFormatter.new(report)
     when :json
       f = JSONFormatter.new(report)
     when :list
@@ -42,12 +43,14 @@ module FormatterFactory
       f = ResumeTXTFormatter.new(report, true)
     when :resume_json
       f = ResumeJSONFormatter.new(report)
+    when :resume_html
+      f = ResumeHTMLFormatter.new(report)
     when :resume_list
       f = ResumeListFormatter.new(report)
     when :resume_yaml
       f = ResumeYAMLFormatter.new(report)
     else
-      raise Rainbow("[ERROR] FormaterFactory #{format} unkown!").red.bright
+      raise "[ERROR] FormaterFactory #{format} unkown!"
     end
     f.init(filename)
     f
@@ -58,14 +61,15 @@ module FormatterFactory
              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',
-             txt: 'txt',
-             yaml: 'yaml' }
+             resume_yaml: 'yaml' }
     return format.to_s if data[format].nil?
 
     data[format]