teuton 3.2.1 → 3.4.0

data/lib/teuton/case/result/ext_compare.rb

@@ -32,8 +32,8 @@ class Result
     case external.class.to_s
     when "Fixnum"
       internal = @content[0].to_i
-      puts "[WARN] Fixnum class is deprecated!"
-      puts "       Upgrade your Ruby version."
+      Logger.warn "Fixnum class is deprecated!"
+      Logger.warn "- Upgrade your Ruby version."
     when "Float"
       internal = @content[0].to_f
     when "Integer"
@@ -55,8 +55,8 @@ class Result
     case input.class.to_s
     when "Fixnum"
       value = @content[0].to_i
-      puts "[WARN] Fixnum class is deprecated!"
-      puts "       Upgrade your Ruby version."
+      Logger.warn "Fixnum class is deprecated!"
+      Logger.warn "Upgrade your Ruby version."
     when "Float"
       value = @content[0].to_f
     when "Integer"
@@ -75,8 +75,8 @@ class Result
     case input.class.to_s
     when "Fixnum"
       value = @content[0].to_i
-      puts "[WARN] Fixnum class is deprecated!"
-      puts "       Upgrade your Ruby version."
+      Logger.warn "Fixnum class is deprecated!"
+      Logger.warn "Upgrade your Ruby version."
     when "Float"
       value = @content[0].to_f
     when "Integer"
@@ -96,8 +96,8 @@ class Result
     case input.class.to_s
     when "Fixnum"
       value = @content[0].to_i
-      puts "[WARN] Fixnum class is deprecated!"
-      puts "       Upgrade your Ruby version."
+      Logger.warn "Fixnum class is deprecated!"
+      Logger.warn "Upgrade your Ruby version."
     when "Float"
       value = @content[0].to_f
     when "Integer"
@@ -116,8 +116,8 @@ class Result
     case input.class.to_s
     when "Fixnum"
       value = @content[0].to_i
-      puts "[WARN] Fixnum class is deprecated!"
-      puts "       Upgrade your Ruby version."
+      Logger.warn "Fixnum class is deprecated!"
+      Logger.warn "Upgrade your Ruby version."
     when "Float"
       value = @content[0].to_f
     when "Integer"

data/lib/teuton/case_manager/dsl.rb

@@ -16,14 +16,18 @@ alias defmacro define_macro
 def group(name, &block)
   Project.value[:groups] << { name: name, block: block }
 end
-alias task group
+
+def task(...)
+  Logger.warn("Keyword deprecated: Replace 'task' by 'group'.")
+  group(...)
+end
 
 def play(&block)
   CaseManager.new.play(&block)
 end
 
 def start(...)
-  Logger.warn "[DEPRECATED] Replace 'start do' by `play do'"
+  Logger.warn "Keywaord deprecaed: Replace 'start do' by `play do'"
   play(...)
 end
 

data/lib/teuton/case_manager/ext/report.rb

@@ -57,10 +57,6 @@ module ReportExtension
     end
   end
 
-  ##
-  # Trim string text when is too long
-  # @param input (String)
-  # @return String
   def trim(input)
     return input unless input.to_s.start_with? Dir.pwd.to_s
     return input if input == Dir.pwd.to_s

data/lib/teuton/case_manager/show_resume_report.rb

@@ -32,13 +32,12 @@ class ShowResumeReport
   private
 
   def show_initial_configurations
-    puts Rainbow("INITIAL CONFIGURATIONS").bright
-    my_screen_table = Terminal::Table.new do |st|
-      @report.head.each do |key, value|
-        st.add_row [key.to_s, trim(value)]
-      end
+    Logger.puts Rainbow(" INITIAL CONFIGURATIONS").bright
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      @report.head.each { |key, value| t.add_row [key.to_s, trim(value)] }
     end
-    puts "#{my_screen_table}\n\n"
+    Logger.puts "#{table}\n\n"
   end
 
   def show_resume
@@ -47,14 +46,15 @@ class ShowResumeReport
   end
 
   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]
+    Logger.puts Rainbow(" \u{2630} CASE RESULTS").bright
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      t.add_row %w[CASE MEMBERS GRADE STATE]
       @report.lines.each do |line|
-        st.add_row [line[:id], line[:members], line[:grade], line[:letter]]
+        t.add_row [line[:id], line[:members], line[:grade], line[:letter]]
       end
     end
-    puts "#{my_screen_table}\n\n"
+    Logger.puts "#{table}\n\n"
   end
 
   def show_conn_status
@@ -62,21 +62,22 @@ class ShowResumeReport
     @report.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]
+    Logger.puts Rainbow(" \u{1f5f2} CONN ERRORS").bright
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      t.add_row %w[CASE MEMBERS HOST ERROR]
       @report.lines.each do |line|
         line[:conn_status].each_pair do |host, error|
-          st.add_row [line[:id], line[:members], host, Rainbow(error).red.bright]
+          t.add_row [line[:id], line[:members], host, Rainbow(error).blue.bright]
         end
       end
     end
-    puts "#{my_screen_table}\n\n"
+    Logger.puts "#{table}\n\n"
   end
 
   def show_targets_history
     tab = "  "
-    puts Rainbow("CASE RESULTS").bright
+    Logger.puts Rainbow(" CASE RESULTS").bright
     if @report.lines.size == 1
       puts lines[0]
     else
@@ -93,30 +94,28 @@ class ShowResumeReport
         end
       end
     end
-    puts "\n\n"
+    Logger.puts "\n\n"
   end
 
   def show_final_values
-    puts Rainbow("FINAL VALUES").bright
-    my_screen_table = Terminal::Table.new do |st|
-      @report.tail.each do |key, value|
-        st.add_row [key.to_s, value.to_s]
-      end
+    Logger.puts Rainbow(" FINAL VALUES").bright
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      @report.tail.each { |key, value| t.add_row [key.to_s, value.to_s] }
     end
-    puts "#{my_screen_table}\n\n"
+    Logger.puts "#{table}\n\n"
   end
 
   def show_hall_of_fame
     hall_of_fame = Project.value[:hall_of_fame]
     return if hall_of_fame.size < MIN_HALL_OF_FAME
 
-    puts Rainbow("HALL OF FAME").bright
-    my_screen_table = Terminal::Table.new do |st|
-      hall_of_fame.each do |line|
-        st.add_row [line[0], line[1]]
-      end
+    Logger.puts Rainbow(" HALL OF FAME").bright
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      hall_of_fame.each { |line| t.add_row [line[0], line[1]] }
     end
-    puts "#{my_screen_table}\n\n"
+    Logger.puts "#{table}\n\n"
   end
 
   def trim(input)

data/lib/teuton/check/checker.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "../case/action/manager"
 require_relative "../case/dsl/macro"
 require_relative "../case/result/result"
 require_relative "../utils/project"
@@ -14,6 +15,7 @@ class Checker
   attr_reader :result
 
   def initialize(script_path, config_path)
+    @action_manager = Case::ActionManager.new
     @path = {}
     @path[:script] = script_path
     @path[:dirname] = File.dirname(script_path)
@@ -28,6 +30,7 @@ class Checker
     @stats = {
       groups: 0,
       targets: 0,
+      events: 0,
       logs: 0,
       readmes: 0,
       uniques: 0,
@@ -69,22 +72,30 @@ class Checker
     groups = Project.value[:groups]
     option = Project.value[:options]
 
-    Logger.info ""
+    Logger.puts ""
     if Project.value[:uses].size.positive?
-      Logger.info Terminal::Table.new { |st| st.add_row ["USE: external libraries"] }
-      Project.value[:uses].each_with_index { Logger.info "      #{_2 + 1}. #{_1}" }
+      table = Terminal::Table.new do |t|
+        t.style = {border: :unicode}
+        t.add_row ["USE: external libraries"]
+      end
+      Logger.puts table
+      Project.value[:uses].each_with_index { Logger.puts "      #{_2 + 1}. #{_1}" }
+      Logger.puts ""
     end
     groups.each do |t|
       @stats[:groups] += 1
       unless option[:panel]
         msg = "GROUP: #{t[:name]}"
-        my_screen_table = Terminal::Table.new { |st| st.add_row [msg] }
-        Logger.info my_screen_table
+        table = Terminal::Table.new do |t|
+          t.style = {border: :unicode}
+          t.add_row [msg]
+        end
+        Logger.puts table
       end
       instance_eval(&t[:block])
     end
-    if @target_begin
-      Logger.warn "WARN  Last 'target' requires 'expect'\n"
-    end
+    return unless @target_begin
+
+    Logger.warn "Last 'target' requires 'expect'\n"
   end
 end

data/lib/teuton/check/dsl/all.rb

@@ -1,37 +1,31 @@
 require_relative "builtin"
 require_relative "expect"
+require_relative "event"
 require_relative "getset"
 require_relative "run"
+require_relative "target"
 
 module CheckDSL
   def log(text = "", type = :info)
     @stats[:logs] += 1
     prefix = (type == :info) ? "" : "#{type.to_s.upcase}: "
-    Logger.info "      log         #{prefix}" + text.to_s
+    Logger.puts "      log         #{prefix}" + text.to_s
   end
 
-  def readme(text)
+  def doc(text)
     @stats[:readmes] += 1
-    Logger.info "      readme      #{text}"
+    Logger.puts "      doc         #{text}"
   end
 
-  def target(desc, args = {})
-    if @target_begin
-      Logger.warn "WARN  Previous 'target' requires 'expect'"
-    end
-    @target_begin = true
-    @stats[:targets] += 1
-    @targetid += 1
-    weight = args[:weight] ? args[:weight].to_f : 1.0
-    Logger.info format("(%03<targetid>d) target      %<desc>s", targetid: @targetid, desc: desc)
-    Logger.info "      weight      #{weight}"
+  def readme(...)
+    Logger.warn("Keyword deprecated: Replace 'readme' by 'doc'.")
+    doc(...)
   end
-  alias_method :goal, :target
 
   def unique(key, _value)
     @stats[:uniques] += 1
 
-    Logger.info "      unique      value for <#{key}>"
-    Logger.info ""
+    Logger.puts "   \u{26bf}  unique      value for <#{key}>"
+    Logger.puts ""
   end
 end

data/lib/teuton/check/dsl/event.rb

@@ -0,0 +1,10 @@
+module CheckDSL
+  def event(**args)
+    if @action_manager.check_event(args)
+      @stats[:events] += 1
+      Logger.puts "   \u{1f5f2}  event       on: #{args[:on]}, when: #{args[:when]}"
+    else
+      Logger.puts "    \u{2718} event       on: #{args[:on]}, when: #{args[:when]} (UNKOWN!)"
+    end
+  end
+end

data/lib/teuton/check/dsl/expect.rb

@@ -2,60 +2,42 @@ require_relative "expect_sequence"
 
 module CheckDSL
   def expect(cond)
-    unless @target_begin
-      Logger.warn "WARN  'expect' with no previous 'target'"
-    end
-    Logger.info "      alter       #{result.alterations}" unless result.alterations.empty?
-    Logger.info "      expect      #{cond} (#{cond.class})"
-    Logger.info ""
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
+    Logger.puts "      alter       #{result.alterations}" unless result.alterations.empty?
+    Logger.puts "      expect      #{cond} (#{cond.class})"
     @target_begin = false
   end
 
   def expect_exit(cond)
-    unless @target_begin
-      Logger.warn "WARN  'expect' with no previous 'target'"
-    end
-    Logger.info "      expect_exit #{cond} (#{cond.class})"
-    Logger.info ""
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
+    Logger.puts "      expect_exit #{cond} (#{cond.class})"
     @target_begin = false
   end
 
   def expect_fail
-    unless @target_begin
-      Logger.warn "WARN  'expect' with no previous 'target'"
-    end
-    Logger.info "      expect_fail"
-    Logger.info ""
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
+    Logger.puts "      expect_fail"
     @target_begin = false
   end
 
   def expect_first(cond)
-    unless @target_begin
-      Logger.warn "WARN  'expect' with no previous 'target'"
-    end
-    Logger.info "      alter        #{result.alterations}" unless result.alterations.empty?
-    Logger.info "      expect_first #{cond} (#{cond.class})"
-    Logger.info ""
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
+    Logger.puts "      alter        #{result.alterations}" unless result.alterations.empty?
+    Logger.puts "      expect_first #{cond} (#{cond.class})"
     @target_begin = false
   end
 
   def expect_last(cond)
-    unless @target_begin
-      Logger.warn "WARN  'expect' with no previous 'target'"
-    end
-    Logger.info "      alter        #{result.alterations}" unless result.alterations.empty?
-    Logger.info "      expect_last #{cond} (#{cond.class})"
-    Logger.info ""
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
+    Logger.puts "      alter        #{result.alterations}" unless result.alterations.empty?
+    Logger.puts "      expect_last #{cond} (#{cond.class})"
     @target_begin = false
   end
 
   def expect_none(cond = nil, args = {})
-    unless @target_begin
-      Logger.warn "WARN  'expect' with no previous 'target'"
-    end
-    Logger.info "      alter       #{result.alterations}" unless result.alterations.empty?
-    Logger.info "      expect_none #{cond} (#{cond.class})"
-    Logger.info ""
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
+    Logger.puts "      alter       #{result.alterations}" unless result.alterations.empty?
+    Logger.puts "      expect_none #{cond} (#{cond.class})"
     @target_begin = false
   end
 
@@ -68,23 +50,17 @@ module CheckDSL
   end
 
   def expect_one(cond)
-    unless @target_begin
-      Logger.warn "WARN  'expect' with no previous 'target'"
-    end
-    Logger.info "      alter       #{result.alterations}" unless result.alterations.empty?
-    Logger.info "      expect_one  #{cond} (#{cond.class})"
-    Logger.info ""
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
+    Logger.puts "      alter       #{result.alterations}" unless result.alterations.empty?
+    Logger.puts "      expect_one  #{cond} (#{cond.class})"
     @target_begin = false
   end
 
   def expect_sequence(&block)
-    unless @target_begin
-      Logger.warn "WARN  'expect' with no previous 'target'"
-    end
+    Logger.warn "    \u{1f6c8} 'expect' with no previous 'target'" unless @target_begin
     seq = CheckDSL::ExpectSequence.new
     seq.is_valid?(&block)
-    Logger.info "      expect_sequence #{seq.expected}"
-    Logger.info ""
+    Logger.puts "      expect_sequence #{seq.expected}"
     @target_begin = false
   end
 end

data/lib/teuton/check/dsl/getset.rb

@@ -14,10 +14,10 @@ module CheckDSL
     value = ":" + value.to_s if value.instance_of? Symbol
 
     @stats[:sets] << "#{key}=#{value}"
-    Logger.info "      set(#{key},#{value})"
+    Logger.puts "      set(#{key},#{value})"
   end
 
   def unset(key)
-    Logger.info "      unset(#{key})"
+    Logger.puts "      unset(#{key})"
   end
 end

data/lib/teuton/check/dsl/run.rb

@@ -17,7 +17,7 @@ module CheckDSL
   def goto(host = :localhost, args = {})
     result.reset
     @stats[:hosts][host] = @stats[:hosts][host] ? (@stats[:hosts][host] + 1) : 1
-    Logger.info "      run         '#{args[:exec]}' on #{host}"
+    Logger.puts "      run         '#{args[:exec]}' on #{host}"
   end
 
   def upload(filename, args = {})
@@ -30,6 +30,6 @@ module CheckDSL
       "and #{values.join(",")}"
     end
     @stats[:uploads] << filename
-    Logger.info "      upload      '#{filename}' to #{host} #{custom}"
+    Logger.puts "      upload      '#{filename}' to #{host} #{custom}"
   end
 end

data/lib/teuton/check/dsl/target.rb

@@ -0,0 +1,17 @@
+module CheckDSL
+  def target(desc, args = {})
+    Logger.warn "Previous 'target' requires 'expect'" if @target_begin
+    @target_begin = true
+    @stats[:targets] += 1
+    @targetid += 1
+    weight = args[:weight] ? args[:weight].to_f : 1.0
+    Logger.puts ""
+    Logger.puts format("(%03<targetid>d) target      %<desc>s", targetid: @targetid, desc: desc)
+    Logger.puts "      weight      #{weight}"
+  end
+
+  def goal(...)
+    Logger.warn("Keyword deprecated: Replace 'goal' by 'target'.")
+    target(...)
+  end
+end

data/lib/teuton/check/show.rb

@@ -15,14 +15,14 @@ class ShowCheck
     output = {"global" => nil, "cases" => [{}]}
     script_vars = find_script_vars
     script_vars.each { |i| output["cases"][0][i.to_s] = "TOCHANGE" }
-    Logger.info YAML.dump(output)
+    Logger.puts YAML.dump(output)
   end
 
   def revise_config_content
     unless File.exist?(@path[:config])
-      Logger.warn "[WARN] Configfile not found"
-      Logger.debug "       #{@path[:config]}"
-      Logger.warn "[INFO] Recomended content:"
+      Logger.warn "Configfile not found"
+      Logger.debug "- File: #{@path[:config]}"
+      Logger.info "Recomended content:"
       suggest_config_content
       return
     end
@@ -52,50 +52,44 @@ class ShowCheck
   end
 
   def show_stats
-    my_screen_table = Terminal::Table.new do |st|
-      st.add_row ["DSL Stats", "Count"]
-      st.add_separator
+    table = Terminal::Table.new do |t|
+      t.style = {border: :unicode}
+      t.add_row ["DSL Stats", "Count"]
+      t.add_separator
 
-      if Project.value[:uses].size.positive?
-        st.add_row ["Uses", Project.value[:uses].size]
-      end
+      t.add_row ["Uses", Project.value[:uses].size] if Project.value[:uses].size.positive?
       if Project.value[:macros].size.positive?
-        st.add_row ["Macros", Project.value[:macros].size]
-        Project.value[:macros].each_key { |value| st.add_row ["", value] }
-      end
-      st.add_row ["Groups", @stats[:groups]]
-      st.add_row ["Targets", @stats[:targets]]
-      runs = @stats[:hosts].values.inject(0) { |acc, item| acc + item }
-      st.add_row ["Runs", runs]
-      @stats[:hosts].each_pair { |k, v| st.add_row [" * #{k}", v] }
-      if @stats[:uniques].positive?
-        st.add_row ["Uniques", @stats[:uniques]]
-      end
-      if @stats[:logs].positive?
-        st.add_row ["Logs", @stats[:logs]]
-      end
-      if @stats[:readmes].positive?
-        st.add_row ["Readmes", @stats[:readmes]]
+        t.add_row ["Macros", Project.value[:macros].size]
+        Project.value[:macros].each_key { |value| t.add_row ["", value] }
       end
+      t.add_row ["Groups", @stats[:groups]]
+      t.add_row ["Targets", @stats[:targets]]
+      t.add_row ["Events", @stats[:events]]
+      runs = @stats[:hosts].values.sum
+      t.add_row ["Runs", runs]
+      @stats[:hosts].each_pair { |k, v| t.add_row ["- #{k}", v] }
+      t.add_row ["Uniques", @stats[:uniques]] if @stats[:uniques].positive?
+      t.add_row ["Logs", @stats[:logs]] if @stats[:logs].positive?
+      t.add_row ["Docs", @stats[:readmes]] if @stats[:readmes].positive?
 
       if @stats[:gets].size.positive?
-        total = @stats[:gets].values.inject(0) { |acc, value| acc + value }
-        st.add_row ["Gets", total]
+        total = @stats[:gets].values.sum
+        t.add_row ["Gets", total]
         list = @stats[:gets].sort_by { |_k, v| v }
-        list.reverse_each { |item| st.add_row [" * #{item[0]}", item[1].to_s] }
+        list.reverse_each { |item| t.add_row [" - #{item[0]}", item[1].to_s] }
       end
 
       if @stats[:sets].size.positive?
-        st.add_row ["Sets", @stats[:sets].size]
-        @stats[:sets].each { |value| st.add_row ["", value] }
+        t.add_row ["Sets", @stats[:sets].size]
+        @stats[:sets].each { |value| t.add_row ["", value] }
       end
       if @stats[:uploads].size.positive?
-        st.add_row ["Uploads", @stats[:uploads].size]
+        t.add_row ["Uploads", @stats[:uploads].size]
         uploads = @stats[:uploads].select { _1 }
-        uploads.each { |value| st.add_row ["", value] }
+        uploads.each { |value| t.add_row ["", value] }
       end
     end
-    Logger.info my_screen_table.to_s + "\n"
+    Logger.puts "\n#{table}\n"
   end
 
   private
@@ -106,16 +100,16 @@ class ShowCheck
       next if k == :localhost
 
       if k.instance_of? Symbol
-        script_vars << (k.to_s + "_ip").to_sym
-        script_vars << (k.to_s + "_username").to_sym
-        script_vars << (k.to_s + "_password").to_sym
+        script_vars << :"#{k}_ip"
+        script_vars << :"#{k}_username"
+        script_vars << :"#{k}_password"
       else
-        script_vars << k.to_s + "_ip"
-        script_vars << k.to_s + "_username"
-        script_vars << k.to_s + "_password"
+        script_vars << "#{k}_ip"
+        script_vars << "#{k}_username"
+        script_vars << "#{k}_password"
       end
     end
-    @stats[:gets].keys.each { |value| script_vars << value }
+    @stats[:gets].each_key { |value| script_vars << value }
     script_vars
   end
 end

data/lib/teuton/cli/app.rb

@@ -40,7 +40,7 @@ module Teuton
       end
 
       map ["co", "-co", "--config"] => "config"
-      desc "config [OPTIONS] DIRECTORY", "Suggest configuration."
+      desc "config DIRECTORY", "Suggest configuration."
       long_desc <<~LONGDESC
         config DIRECTORY, "Suggest the content of the configuration file based on the test"
       LONGDESC
@@ -50,22 +50,30 @@ module Teuton
         Teuton.check(projectpath, opt)
       end
 
-      map ["--readme"] => "readme"
+      map ["--doc"] => "doc"
       option :lang, type: :string
-      desc "readme DIRECTORY", "Show README extracted from test contents"
+      desc "doc DIRECTORY", "Display practice exercise statement"
       long_desc <<-LONGDESC
 
-      (1) teuton readme foo
-      , Create README.md from foo/start.rb.
+      (1) teuton doc foo
+      , Display exercise statement from foo/start.rb.
 
-      (2) teuton readme foo/demo.rb
-      , Create README.md from foo/demo.rb.
+      (2) teuton doc foo/demo.rb
+      , Display exercise statement from foo/demo.rb.
       LONGDESC
 
-      def readme(projectpath)
+      def doc(projectpath)
         Teuton.readme(projectpath, options)
       end
 
+      map ["--readme"] => "readme"
+      desc "readme DIRECTORY", "DEPRECATED! Use 'teuton doc'"
+
+      def readme(projectpath)
+        Logger.info "Use: teuton doc"
+        Logger.warn "'teuton readme' has been DEPRECATED!"
+      end
+
       map ["--run", "run"] => "play"
       option :export, type: :string
       option :cname, type: :string