teuton 2.6.0 → 2.7.0

data/lib/teuton/check/dsl.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-##
-# Include Teuton DSL keywords into Laboratory class
 class Laboratory
+  # Include Teuton DSL keywords into Laboratory class
   def readme(_text)
     # Usefull for "teuton readme" command action.
   end

data/lib/teuton/check/laboratory.rb

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
-require_relative "../application"
-require_relative "../result/result"
+require_relative "../utils/project"
+require_relative "../utils/result/result"
 require_relative "show"
 require_relative "dsl"
 require_relative "builtin"
 
 def use(filename)
   filename += ".rb"
-  app = Application.instance
-  rbfiles = File.join(app.project_path, "**", filename)
+  rbfiles = File.join(Project.value[:project_path], "**", filename)
   files = Dir.glob(rbfiles)
   use = []
   files.sort.each { |f| use << f if f.include?(filename) }
   require_relative use[0]
+  Project.value[:uses] << use[0]
 end
 
 def group(name, &block)
-  Application.instance.groups << {name: name, block: block}
+  Project.value[:groups] << {name: name, block: block}
 end
 alias task group
 
 def define_macro(name, *args, &block)
-  Application.instance.macros[name] = {args: args, block: block}
+  Project.value[:macros][name] = {args: args, block: block}
 end
 alias def_macro define_macro
 alias defmacro define_macro
@@ -54,6 +54,6 @@ class Laboratory
     @sets = {}
     @hosts = {}
     @requests = [] # REVISE this
-    @verbose = Application.instance.verbose
+    @verbose = Project.value[:verbose]
   end
 end

data/lib/teuton/check/show.rb

@@ -1,13 +1,9 @@
 require "terminal-table"
 require "rainbow"
 
-require_relative "../application"
+require_relative "../utils/project"
 require_relative "../utils/configfile_reader"
 
-# Laboratory
-# * show_dsl
-# * show_stats
-# * show_config
 class Laboratory
   def show
     @verbose = true
@@ -34,9 +30,9 @@ class Laboratory
   end
 
   def process_content
-    groups = Application.instance.groups
-    option = Application.instance.options
-
+    groups = Project.value[:groups]
+    option = Project.value[:options]
+    @stats[:uses] = Project.value[:uses].size
     verboseln ""
     groups.each do |t|
       @stats[:groups] += 1
@@ -124,6 +120,7 @@ class Laboratory
     my_screen_table = Terminal::Table.new do |st|
       st.add_row ["DSL Stats", "Count"]
       st.add_separator
+      st.add_row ["Uses", @stats[:uses]]
       st.add_row ["Groups", @stats[:groups]]
       st.add_row ["Targets", @stats[:targets]]
       st.add_row ["Runs", @stats[:hosts]]

data/lib/teuton/cli.rb

@@ -37,6 +37,16 @@ class CLI < Thor
     Teuton.check(projectpath, options)
   end
 
+  map ["co", "-co", "--config"] => "config"
+  desc "config DIRECTORY", "Suggest configuration"
+  long_desc <<~LONGDESC
+    config [OPTIONS] DIRECTORY", "Suggest configuration"
+  LONGDESC
+  def config(projectpath)
+    opt = {"onlyconfig" => true}
+    Teuton.check(projectpath, opt)
+  end
+
   map ["--readme"] => "readme"
   option :lang, type: :string
   desc "readme DIRECTORY", "Show README extracted from test contents"

data/lib/teuton/readme/dsl.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
 # Readme
-# * target
-# * goto
-# * run
-# * expect
-# * unique
-# * log
+#   readme, target, goto, run
+#   expect,
+#   gett, set, unique, log
 class Readme
   def readme(text)
     if @action[:target].nil?
@@ -92,7 +89,8 @@ class Readme
     m = method.to_s
     if m[0] == "_"
       instance_eval("get(:#{m[1, m.size - 1]})", __FILE__, __LINE__)
-    elsif not Application.instance.macros[m].nil?
+    # elsif not Application.instance.macros[m].nil?
+    elsif not Project.value[:macros][m].nil?
       puts "macro exec: #{m}"
       code = ""
       args[0].keys.each { |key| code += "set(:#{key}, '#{args[0][key]}')\n" }

data/lib/teuton/readme/lang.rb

@@ -1,4 +1,4 @@
-require_relative "../application"
+require_relative "../utils/project"
 
 module Lang
   def self.get(key)
@@ -23,7 +23,8 @@ module Lang
       global: "\nParámetros globales que pueden ser modificados:\n",
       created: "\nParámetros creados durante la ejecución del reto:\n"
     }
-    locale = Application.instance.options["lang"].downcase
+    # locale = Application.instance.options["lang"].downcase
+    locale = Project.value[:options]["lang"].downcase
     lang[locale][key]
   end
 end

data/lib/teuton/readme/readme.rb

@@ -1,27 +1,27 @@
-require_relative "../application"
+require_relative "../utils/project"
 require_relative "../utils/configfile_reader"
-require_relative "../result/result"
+require_relative "../utils/result/result"
 require_relative "../version"
 require_relative "dsl"
 require_relative "lang"
 
 def use(filename)
   filename += ".rb"
-  app = Application.instance
-  rbfiles = File.join(app.project_path, "**", filename)
+  rbfiles = File.join(Project.value[:project_path], "**", filename)
   files = Dir.glob(rbfiles)
   use = []
   files.sort.each { |f| use << f if f.include?(filename) }
   require_relative use[0]
+  Project.value[:uses] << use[0]
 end
 
 def define_macro(name, *args, &block)
   puts "macro: #{name}"
-  Application.instance.macros[name] = {args: args, block: block}
+  Project.value[:macros][name] = {args: args, block: block}
 end
 
 def group(name, &block)
-  Application.instance.groups << {name: name, block: block}
+  Project.value[:groups] << {name: name, block: block}
 end
 alias task group
 
@@ -31,16 +31,14 @@ end
 # alias_method "play", "start" # REVISE THIS
 alias play start
 
-# Creates README.md file from RB script file
 class Readme
+  # Creates README.md file from RB script file
   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)
+    # script_path Path to main rb file (start.rb)
+    # config_path Path to main config file (config.yaml)
     @path = {}
     @path[:script] = script_path
     @path[:dirname] = File.dirname(script_path)
@@ -59,9 +57,9 @@ class Readme
   private
 
   def reset
-    app = Application.instance
-    @config = ConfigFileReader.read(app.config_path)
-    @verbose = app.verbose
+    # app = Application.instance
+    @config = ConfigFileReader.read(Project.value[:config_path])
+    @verbose = Project.value[:verbose]
     @result = Result.new
     @data = {}
     @data[:macros] = []
@@ -76,7 +74,7 @@ class Readme
   end
 
   def process_content
-    Application.instance.groups.each do |g|
+    Project.value[:groups].each do |g|
       @current = {name: g[:name], readme: [], actions: []}
       @data[:groups] << @current
       reset_action
@@ -89,14 +87,13 @@ class Readme
   end
 
   def show_head
-    app = Application.instance
     puts "```"
-    puts format(Lang.get(:testname), app.test_name)
+    puts format(Lang.get(:testname), Project.value[:test_name])
     puts format(Lang.get(:date), Time.now)
     puts format(Lang.get(:version), Teuton::VERSION)
     puts "```"
     puts "\n"
-    puts "# #{app.test_name}\n"
+    puts "# #{Project.value[:test_name]}\n"
 
     i = 1
     unless @required_hosts.empty?

data/lib/teuton/report/formatter/default/array.rb

@@ -1,5 +1,5 @@
 require_relative "../base_formatter"
-require_relative "../../../application"
+require_relative "../../../utils/project"
 
 class ArrayFormatter < BaseFormatter
   def initialize(report)
@@ -60,12 +60,14 @@ class ArrayFormatter < BaseFormatter
       target[:duration] = i[:duration]
 
       target[:command] = i[:command]
+      target[:output] = i[:output]
       target[:alterations] = i[:alterations]
       target[:expected] = i[:expected]
       target[:result] = i[:result]
 
       if options[:feedback] == false
         target[:command] = "*" * i[:command].size
+        target[:output] = "*" * i[:output].size
         target[:alterations] = "*" * i[:alterations].size
         target[:expected] = "*" * i[:expected].size
         target[:result] = "*" * i[:result].size
@@ -85,12 +87,11 @@ class ArrayFormatter < BaseFormatter
   end
 
   def build_hof_data
-    app = Application.instance
     @data[:hall_of_fame] = {}
-    return if app.options[:case_number] < 3
+    return if Project.value[:options][:case_number] < 3
 
     fame = {}
-    app.hall_of_fame.each { |line| fame[line[0]] = line[1] }
+    Project.value[:hall_of_fame].each { |line| fame[line[0]] = line[1] }
     @data[:hall_of_fame] = fame
   end
 
@@ -115,6 +116,6 @@ class ArrayFormatter < BaseFormatter
   end
 
   def version
-    Application::VERSION
+    Teuton::VERSION
   end
 end

data/lib/teuton/report/formatter/default/txt.rb

@@ -91,6 +91,7 @@ class TXTFormatter < ArrayFormatter
       w " (" + Rainbow(i[:score].to_s + "/" + i[:weight].to_s).color(color) + ")\n"
       w "#{tab * 4}Description : #{i[:description]}\n"
       w "#{tab * 4}Command     : #{i[:command]}\n"
+      w "#{tab * 4}Output      : #{i[:output]}\n"
       w "#{tab * 4}Duration    : #{i[:duration]} (#{i[:conn_type]})\n"
       w "#{tab * 4}Alterations : #{i[:alterations]}\n"
       w "#{tab * 4}Expected    : #{i[:expected]} (#{i[:expected].class})\n"

data/lib/teuton/report/formatter/resume/array.rb

@@ -1,4 +1,5 @@
 require_relative "../base_formatter"
+require_relative "../../../utils/project"
 
 class ResumeArrayFormatter < BaseFormatter
   def initialize(report)
@@ -36,10 +37,9 @@ class ResumeArrayFormatter < BaseFormatter
   end
 
   def build_hof_data
-    app = Application.instance
     fame = {}
-    if app.options[:case_number] > 2
-      app.hall_of_fame.each { |line| fame[line[0]] = line[1] }
+    if Project.value[:options][:case_number] > 2
+      Project.value[:hall_of_fame].each { |line| fame[line[0]] = line[1] }
     end
     @data[:hall_of_fame] = fame
   end

data/lib/teuton/report/formatter/resume/html.rb

@@ -1,6 +1,6 @@
 require "erb"
 require_relative "yaml"
-require_relative "../../../application"
+# require_relative "../../../../teuton"
 
 class ResumeHTMLFormatter < ResumeYAMLFormatter
   def initialize(report)
@@ -42,6 +42,6 @@ class ResumeHTMLFormatter < ResumeYAMLFormatter
   end
 
   def version
-    Application::VERSION
+    Teuton::VERSION
   end
 end

data/lib/teuton/report/report.rb

@@ -1,4 +1,5 @@
-require_relative "../application"
+require_relative "../utils/project"
+require_relative "../utils/settings"
 require_relative "formatter/formatter"
 
 class Report
@@ -12,7 +13,8 @@ class Report
   def initialize(id = "00")
     @id = id
     @filename = "case-#{@id}"
-    @output_dir = Application.instance.output_basedir
+    # @output_dir = Application.instance.output_basedir
+    @output_dir = Project.value[:output_basedir]
     @head = {}
     @lines = []
     @tail = {}
@@ -57,7 +59,6 @@ class Report
   # * fail_weight
   # * fail_counter
   def close
-    app = Application.instance
     max = 0.0
     good = 0.0
     fail = 0.0
@@ -68,11 +69,11 @@ class Report
       max += i[:weight] if i[:weight].positive?
       if i[:check]
         good += i[:weight]
-        @history += app.letter[:good]
+        @history += Settings.letter[:good]
       else
         fail += i[:weight]
         fail_counter += 1
-        @history += app.letter[:bad]
+        @history += Settings.letter[:bad]
       end
     end
     @tail[:max_weight] = max

data/lib/teuton/skeleton.rb

@@ -1,16 +1,18 @@
 require "fileutils"
 require "rainbow"
 
-module Skeleton
-  def self.create(project_dir)
+class Skeleton
+  def create(project_dir)
     project_name = File.basename(project_dir)
-    puts "\n[INFO] Creating #{Rainbow(project_name).bright} project skeleton"
+    puts "\nCreating #{Rainbow(project_name).bright} project"
     source_basedir = File.dirname(__FILE__)
     create_dir project_dir
     create_main_dir_and_files(project_dir, source_basedir)
   end
 
-  private_class_method def self.create_main_dir_and_files(project_dir, source_basedir)
+  private
+
+  def create_main_dir_and_files(project_dir, source_basedir)
     # Directory and files: Ruby script, Configfile, gitignore
     items = [
       {source: "files/config.yaml", target: "config.yaml"},
@@ -23,7 +25,7 @@ module Skeleton
     end
   end
 
-  private_class_method def self.create_dir(dirpath)
+  def create_dir(dirpath)
     if Dir.exist? dirpath
       puts "* Exists dir!       => #{Rainbow(dirpath).yellow}"
     else
@@ -36,11 +38,7 @@ module Skeleton
     end
   end
 
-  ##
-  # Copy file
-  # @param source (String) Source file
-  # @param dest (String) Dest file
-  private_class_method def self.copyfile(source, dest)
+  def copyfile(source, dest)
     if File.exist? dest
       puts "* Exists file!      => #{Rainbow(dest).yellow}"
     else

data/lib/teuton/{application.rb → utils/application.rb}

@@ -1,5 +1,5 @@
 require "singleton"
-require_relative "utils/name_file_finder"
+require_relative "name_file_finder"
 
 class Application
   include Singleton
@@ -33,7 +33,11 @@ class Application
     @running_basedir = Dir.getwd
     @output_basedir = "var"
     @default = {name: "teuton", format: :txt, debug: false}
-    @options = {"lang" => "en"}
+    @options = {
+      "lang" => "en",
+      "color" => true,
+      "panel" => false
+    }
     @verbose = true
 
     @global = {}
@@ -65,10 +69,14 @@ class Application
   # * Read color input option
   def add_input_params(projectpath, options)
     @options.merge! options
-    NameFileFinder.find_filenames_for(projectpath)
-    @options["color"] = true if @options["color"].nil?
     Rainbow.enabled = @options["color"]
-    @options["panel"] = false if @options["panel"].nil?
+
+    finder = NameFileFinder.new(@options)
+    finder.find_filenames_for(projectpath)
+    @project_path = finder.project_path
+    @script_path = finder.script_path
+    @config_path = finder.config_path
+    @test_name = finder.test_name
 
     unless @options["case"].nil?
       numbers = @options["case"].split(",")

data/lib/teuton/utils/name_file_finder.rb

@@ -1,10 +1,24 @@
 require "rainbow"
 
-module NameFileFinder
+class NameFileFinder
+  attr_reader :options
+  attr_reader :project_path
+  attr_reader :script_path
+  attr_reader :config_path
+  attr_reader :test_name
+
+  def initialize(options = {})
+    @options = options
+    @project_path = nil
+    @script_path = nil
+    @config_path = nil
+    @test_name = nil
+  end
+
   ##
   # Find project filenames from input project relative path
   # @param relprojectpath (String)
-  def self.find_filenames_for(relprojectpath)
+  def find_filenames_for(relprojectpath)
     projectpath = File.absolute_path(relprojectpath)
 
     # Define:
@@ -20,10 +34,10 @@ module NameFileFinder
     true
   end
 
-  ##
-  # Find project filenames from input folder path
-  # @param folder_path (String)
-  def self.find_filenames_from_directory(folder_path)
+  private
+
+  def find_filenames_from_directory(folder_path)
+    # Find project filenames from input folder path
     # COMPLEX MODE: We use start.rb as main RB file
     script_path = File.join(folder_path, "start.rb")
     unless File.exist? script_path
@@ -31,38 +45,34 @@ module NameFileFinder
       exit 1
     end
 
-    app = Application.instance
-    app.project_path = folder_path
-    app.script_path = script_path
-    app.test_name = folder_path.split(File::SEPARATOR)[-1]
+    @project_path = folder_path
+    @script_path = script_path
+    @test_name = folder_path.split(File::SEPARATOR)[-1]
 
     find_configfilename_from_directory(folder_path)
   end
 
-  ##
-  # Find project config filename from input folder path
-  # @param folder_path (String)
-  def self.find_configfilename_from_directory(folder_path)
+  def find_configfilename_from_directory(folder_path)
+    # Find project config filename from input folder path
     # COMPLEX MODE: We use config.yaml by default
-    app = Application.instance
     config_path = ""
 
-    if app.options["cpath"].nil?
+    if options["cpath"].nil?
       config_name = "config"
       # Config name file is introduced by cname arg option from teuton command
-      config_name = app.options["cname"] unless app.options["cname"].nil?
+      config_name = options["cname"] unless options["cname"].nil?
       config_path = File.join(folder_path, "#{config_name}.json")
       unless File.exist? config_path
         config_path = File.join(folder_path, "#{config_name}.yaml")
       end
     else
       # Config path file is introduced by cpath arg option from teuton command
-      config_path = app.options["cpath"]
+      config_path = options["cpath"]
     end
-    app.config_path = config_path
+    @config_path = config_path
   end
 
-  def self.find_filenames_from_rb(script_path)
+  def find_filenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
     if File.extname(script_path) != ".rb"
@@ -71,44 +81,29 @@ module NameFileFinder
       exit 1
     end
 
-    app = Application.instance
-    app.project_path = File.dirname(script_path)
-    app.script_path = script_path
-    app.test_name = File.basename(script_path, ".rb")
-
+    @project_path = File.dirname(script_path)
+    @script_path = script_path
+    @test_name = File.basename(script_path, ".rb")
     find_configfilenames_from_rb(script_path)
   end
 
-  def self.find_configfilenames_from_rb(script_path)
+  def find_configfilenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
-    app = Application.instance
-
     config_path = ""
-    if app.options["cpath"].nil?
+    if options["cpath"].nil?
       config_name = File.basename(script_path, ".rb")
       # Config name file is introduced by cname arg option from teuton command
-      config_name = app.options["cname"] unless app.options["cname"].nil?
+      config_name = options["cname"] unless options["cname"].nil?
 
-      config_path = File.join(app.project_path, config_name + ".json")
+      config_path = File.join(@project_path, config_name + ".json")
       unless File.exist? config_path
-        config_path = File.join(app.project_path, config_name + ".yaml")
+        config_path = File.join(@project_path, config_name + ".yaml")
       end
     else
       # Config path file is introduced by cpath arg option from teuton command
-      config_path = app.options["cpath"]
+      config_path = options["cpath"]
     end
-    app.config_path = config_path
-  end
-
-  def self.verboseln(text)
-    verbose(text + "\n")
-  end
-
-  def self.verbose(text)
-    return unless Application.instance.verbose
-    return if Application.instance.options["quiet"]
-
-    print text
+    @config_path = config_path
   end
 end

data/lib/teuton/utils/project.rb

@@ -0,0 +1,73 @@
+# Development in progress...
+
+require_relative "name_file_finder"
+
+class Project
+  def self.init
+    @project = {}
+    @project[:running_basedir] = Dir.getwd
+    @project[:output_basedir] = "var"
+    @project[:name] = "teuton"
+    @project[:format] = :txt
+    @project[:debug] = false
+    @project[:options] = {
+      "color" => true,
+      "lang" => "en",
+      "panel" => false,
+      "quiet" => false
+    }
+    @project[:verbose] = true
+    @project[:global] = {} # Hash of Global configuration params
+    @project[:ialias] = {} # Hash of Internal alias
+    @project[:macros] = {} # Hash of macros
+    @project[:groups] = [] # Array of groups
+    @project[:uses] = []   # TODO: Array of files used
+    @project[:hall_of_fame] = []
+  end
+
+  def self.value
+    @project
+  end
+
+  init
+
+  def self.debug?
+    value[:debug]
+  end
+
+  def self.name
+    value[:name]
+  end
+
+  def self.quiet?
+    return true if value[:options]["quiet"]
+    return true unless value[:verbose]
+
+    false
+  end
+
+  def self.verbose
+    value[:verbose]
+  end
+
+  ##
+  # Preprocess input options:
+  # * Convert input case options String to an Array of integers
+  # * Read color input option
+  def self.add_input_params(projectpath, options)
+    value[:options].merge! options
+    Rainbow.enabled = value[:options]["color"]
+
+    finder = NameFileFinder.new(value[:options])
+    finder.find_filenames_for(projectpath)
+    value[:project_path] = finder.project_path
+    value[:script_path] = finder.script_path
+    value[:config_path] = finder.config_path
+    value[:test_name] = finder.test_name
+
+    unless value[:options]["case"].nil?
+      numbers = value[:options]["case"].split(",")
+      value[:options]["case"] = numbers.collect!(&:to_i)
+    end
+  end
+end