teuton 3.1.0 → 3.2.1

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

@@ -6,19 +6,21 @@ require_relative "run"
 
 module ReadmeDSL
   def readme(text)
-    if @action[:target].nil?
+    if @action.description.nil?
       @current[:readme] << text # It's a group readme
     else
-      @action[:readme] << text # It's a target readme
+      @action.readme << text # It's a target readme
     end
   end
 
   def target(desc, args = {})
-    previous_host = @action[:host]
-    @action = {target: desc, host: previous_host, readme: []}
+    previous_host = @action.host
+    @action.description = desc
+    @action.host = previous_host
+    @action.readme = []
     weight = 1.0
     weight = args[:weight].to_f if args[:weight]
-    @action[:weight] = weight
+    @action.weight = weight
   end
   alias_method :goal, :target
 

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

@@ -2,7 +2,7 @@
 
 module ReadmeDSL
   def expect(_cond, _args = {})
-    @current[:actions] << @action
+    @current[:actions] << @action.to_h
     result.reset
   end
   alias_method :expect_any, :expect
@@ -12,7 +12,7 @@ module ReadmeDSL
   alias_method :expect_one, :expect
 
   def expect_fail
-    @current[:actions] << @action
+    @current[:actions] << @action.to_h
     result.reset
   end
   alias_method :expect_ok, :expect_fail
@@ -23,7 +23,7 @@ module ReadmeDSL
   alias_method :expect_nothing, :expect_none
 
   def expect_sequence(&block)
-    @current[:actions] << @action
+    @current[:actions] << @action.to_h
     result.reset
   end
 end

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

@@ -3,30 +3,24 @@ module ReadmeDSL
     unless host == :localhost
       b = {}
       a = :"#{host}_ip"
-      if @config[:global][a].nil? && !@setted_params.include?(a)
-        @cases_params << a
-      end
+      @cases_params << a if @config[:global][a].nil? && !@setted_params.include?(a)
       b[:ip] = @config[:global][a] if @config[:global][a]
       b[:ip] = @setted_params[a] if @setted_params[a]
 
       a = :"#{host}_username"
-      if @config[:global][a].nil? && !@setted_params.include?(a)
-        @cases_params << a
-      end
+      @cases_params << a if @config[:global][a].nil? && !@setted_params.include?(a)
       b[:username] = @config[:global][a] if @config[:global][a]
       b[:username] = @setted_params[a] if @setted_params[a]
 
       a = :"#{host}_password"
-      if @config[:global][a].nil? && !@setted_params.include?(a)
-        @cases_params << a
-      end
+      @cases_params << a if @config[:global][a].nil? && !@setted_params.include?(a)
       b[:password] = @config[:global][a] if @config[:global][a]
       b[:password] = @setted_params[a] if @setted_params[a]
 
       @required_hosts[host.to_s] = b
     end
-    @action[:host] = host
-    @action[:exec] = args[:exec] || "noexec"
+    @action.host = host
+    @action.exec = args[:exec] || "noexec"
   end
 
   def run(command, args = {})

data/lib/teuton/readme/main.rb

@@ -12,16 +12,23 @@ def use(filename)
 end
 
 def define_macro(name, *args, &block)
-  Project.value[:macros][name] = {args: args, block: block}
+  Project.value[:macros][name] = { args: args, block: block }
 end
 
 def group(name, &block)
-  Project.value[:groups] << {name: name, block: block}
+  Project.value[:groups] << { name: name, block: block }
 end
-alias task group
 
-def start(&block)
+def task(...)
+  Logger.warn "[DEPRECATED] Replace 'task' by 'group'"
+  group(...)
+end
+
+def play(&block)
   # don't do nothing
 end
-# alias_method "play", "start" # REVISE THIS
-alias play start
+
+def start(...)
+  Logger.warn "[DEPRECATED] Replace `start' by' play'"
+  play(...)
+end

data/lib/teuton/readme/readme.rb

@@ -3,12 +3,13 @@ require_relative "../utils/project"
 require_relative "../utils/config_file_reader"
 require_relative "../case/dsl/macro"
 require_relative "../version"
+require_relative "action"
 require_relative "dsl/all"
 require_relative "lang"
 require_relative "result"
 
 class Readme
-  include DSL
+  include DSL # Used by case/dsl/macro
   include ReadmeDSL
 
   attr_reader :result, :data
@@ -39,7 +40,7 @@ class Readme
     @data[:macros] = []
     @data[:groups] = []
     @data[:play] = []
-    reset_action
+    @action = Action.new
     @setted_params = {}
     @cases_params = []
     @global_params = {}
@@ -50,15 +51,11 @@ class Readme
     Project.value[:groups].each do |group|
       @current = {name: group[:name], readme: [], actions: []}
       @data[:groups] << @current
-      reset_action
+      @action.reset
       instance_eval(&group[:block])
     end
   end
 
-  def reset_action
-    @action = {readme: []}
-  end
-
   def show_head
     puts "```"
     puts format(Lang.get(:date), Time.now)
@@ -96,16 +93,16 @@ class Readme
       puts "\n## #{group[:name].capitalize}\n"
       group[:readme].each { |line| puts "#{line}\n" }
       previous_host = nil
-      group[:actions].each_with_index do |item, index|
-        item[:host] = group[:actions][0][:host] if item[:host].nil? && index.positive?
-        if previous_host.nil? || item[:host] != previous_host
-          previous_host = item[:host] || "null"
+      group[:actions].each_with_index do |a, index|
+        a[:host] = group[:actions][0][:host] if a[:host].nil? && index.positive?
+        if previous_host.nil? || a[:host] != previous_host
+          previous_host = a[:host] || "null"
           puts format(Lang.get(:goto), previous_host.upcase)
         end
-        weight = "(x#{item[:weight]}) "
-        last = item[:target].end_with?(".", ":") ? "" : "."
-        puts "* #{weight}#{item[:target]}#{last}"
-        item[:readme].each { |line| puts "    * #{line}\n" }
+        weight = "(x#{a[:weight]}) "
+        last = a[:description].end_with?(".", ":") ? "" : "."
+        puts "* #{weight}#{a[:description]}#{last}"
+        a[:readme].each { |line| puts "    * #{line}\n" }
       end
     end
   end

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

@@ -30,7 +30,7 @@ class BaseFormatter
 
   def trim(input)
     output = input.to_s
-    output = "...#{input[-50, input.size]}" if output.size > 65
-    output.to_s
+    output = "...#{output[-50, 50]}" if output.size > 65
+    output
   end
 end

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

@@ -112,8 +112,8 @@ class TXTFormatter < ArrayFormatter
     when :red
       Rainbow(text).color(:red)
     else
-      puts "[ERROR] TXTFormatter#colorize option=#{option}"
-      exit 1
+      Logger.warn "[TXTFormatter] colorize option=#{option}"
+      text
     end
   end
 end

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

@@ -41,10 +41,10 @@ module Formatter
   def self.call(report, options, filename)
     klass = get(options[:format])
     if klass.nil?
-      puts "[ERROR] Formatter:"
-      puts "        Unkown format <#{options[:format]}>. Fix line <export format: FORMAT>"
-      puts "        Available formats: #{Formatter.available_formats.join(",")}."
-      exit 1
+      Logger.warn "Formatter:"
+      Logger.warn "- Unkown format <#{options[:format]}>. Fix line <export format: FORMAT>"
+      Logger.warn "- Available formats: #{Formatter.available_formats.join(",")}."
+      return
     end
     formatter = klass.new(report)
     formatter.init(filename)
@@ -55,13 +55,4 @@ module Formatter
   def self.get(format)
     LIST[format]
   end
-
-  # def self.hide_feedback(report)
-  #  report2 = report.clone
-  #  report2.groups.each do |group|
-  #    group.each do |item|
-  #      puts item
-  #    end
-  #  end
-  # end
 end

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

@@ -113,8 +113,8 @@ class ResumeTXTFormatter < ResumeArrayFormatter
     when :red_bright
       Rainbow(text).red.bright
     else
-      puts "[ERROR] ResumeTXTFormatter#colorize option=#{option}"
-      exit 1
+      Logger.warn "[ResumeTXTFormatter] colorize option=#{option}"
+      text
     end
   end
 end

data/lib/teuton/utils/config_file_reader.rb

@@ -11,7 +11,7 @@ module ConfigFileReader
 
     return read_json(filepath) if File.extname(filepath) == ".json"
 
-    raise "[ERROR] ConfigFileReader.call: <#{filepath}>. Unkown extension!"
+    raise Rainbow("[ERROR] ConfigFileReader.call: <#{filepath}>. Unkown extension!").bright.red
   end
 
   def self.convert_string_keys_to_symbol(input)
@@ -61,9 +61,7 @@ module ConfigFileReader
     begin
       data = YAML.load(File.open(filepath))
     rescue => e
-      warn "[ERROR] ConfigFileReader.read_yaml: #{e}"
-      warn "[ERROR] Revise file content! <#{filepath}>"
-      exit 1
+      raise Teuton::ConfigFileError.new(filepath, e)
     end
     data = convert_string_keys_to_symbol(data)
     data[:global] = data[:global] || {}
@@ -111,10 +109,7 @@ module ConfigFileReader
     begin
       data = YAML.load(File.open(filepath))
     rescue => e
-      warn "[ERROR] Reading configurations from yaml:"
-      warn "[ERROR] - File : #{filepath}"
-      warn "[ERROR] - Type : #{e}"
-      exit 1
+      raise Teuton::ConfigFileError.new(filepath, e)
     end
     data[:tt_source_file] = relative_path(filepath)
     convert_string_keys_to_symbol(data)
@@ -124,10 +119,7 @@ module ConfigFileReader
     begin
       data = JSON.parse(File.read(filepath), symbolize_names: true)
     rescue => e
-      warn "[ERROR] Reading configurations from json:"
-      warn "[ERROR] - File : #{filepath}"
-      warn "[ERROR] - Type : #{e}"
-      exit 1
+      raise Teuton::ConfigFileError.new(filepath, e)
     end
     data[:tt_source_file] = relative_path(filepath)
     convert_string_keys_to_symbol(data)

data/lib/teuton/utils/logger.rb

@@ -3,30 +3,35 @@ require "rainbow"
 class Logger
   @verbose = true
 
-  def self.verbose=(value)
-    @verbose = value
+  class << self
+    attr_writer :verbose
   end
 
-  def self.verbose
-    @verbose
+  class << self
+    attr_reader :verbose
+  end
+
+  def self.puts(message)
+    Kernel.puts message if @verbose
   end
 
   def self.info(message)
-    puts message if @verbose
+    text = Rainbow("Info | #{message}").white
+    Kernel.puts text if @verbose
   end
 
   def self.warn(message)
-    text = Rainbow(message).bright.yellow
-    info(text)
+    text = Rainbow("Warn | #{message}").bright.yellow
+    Kernel.warn text if @verbose
   end
 
   def self.error(message)
-    text = Rainbow(message).bright.red
-    info(text)
+    text = Rainbow("Error | #{message}").bright.red
+    Kernel.warn text if @verbose
   end
 
   def self.debug(message)
     text = Rainbow(message).white
-    info(text)
+    puts text if @verbose
   end
 end

data/lib/teuton/utils/name_file_finder.rb

@@ -1,4 +1,4 @@
-require "rainbow"
+require_relative "logger"
 
 class NameFileFinder
   attr_reader :options, :project_path, :script_path, :config_path, :testname
@@ -33,10 +33,7 @@ class NameFileFinder
     # Find project filenames into directory <folder path>
     # COMPLEX MODE: main RB file is <start.rb>
     script_path = File.join(folder_path, "start.rb")
-    unless File.exist? script_path
-      warn Rainbow("[ERROR] Main script file not found! <#{script_path}>").bright.red
-      exit 1
-    end
+    raise Teuton::MainScriptNotFoundError, script_path unless File.exist? script_path
 
     @project_path = folder_path
     @script_path = script_path
@@ -66,12 +63,7 @@ class NameFileFinder
   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"
-      warn Rainbow("[ERROR] Main script file not found!").bright.red
-      warn Rainbow("[ERROR] Not found <#{script_path}/start.rb>").white
-      warn Rainbow("[ERROR] Not found <#{script_path}.rb>").white
-      exit 1
-    end
+    raise Teuton::MainScriptNotFoundError, script_path if File.extname(script_path) != ".rb"
 
     @project_path = File.dirname(script_path)
     @script_path = script_path

data/lib/teuton/version.rb

@@ -1,5 +1,5 @@
 module Teuton
-  VERSION = "3.1.0".freeze
+  VERSION = "3.2.1".freeze
   APPNAME = "teuton".freeze
   GEMNAME = "teuton".freeze
   DOCKERNAME = "dvarrui/#{GEMNAME}".freeze

data/lib/teuton.rb

@@ -1,5 +1,5 @@
 require_relative "teuton/utils/project"
-# require_relative "teuton/version"
+require_relative "teuton/errors"
 
 module Teuton
   def self.create(path_to_new_dir)
@@ -36,15 +36,10 @@ module Teuton
   private_class_method def self.require_dsl_and_script(dslpath)
     # Load DSL file and then load script file
     require_relative dslpath
-    begin
-      mainscriptfile = Project.value[:script_path]
-      require_relative mainscriptfile
-    rescue => e
-      warn Rainbow("[ERROR] #{e}").bright.red
-      e.backtrace&.first(3)&.each do |line|
-        warn Rainbow("[ERROR]   #{line}").red
-      end
-      exit 1
-    end
+
+    mainscriptfile = Project.value[:script_path]
+    raise MainScriptNotFoundError.new(mainscriptfile) unless File.exist?(mainscriptfile)
+
+    require_relative mainscriptfile
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.1
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -252,6 +252,7 @@ files:
 - docs/more.md
 - docs/tutorial/es/nginx/README.md
 - lib/teuton.rb
+- lib/teuton/case/action.rb
 - lib/teuton/case/builtin/main.rb
 - lib/teuton/case/builtin/package.rb
 - lib/teuton/case/builtin/service.rb
@@ -305,12 +306,15 @@ files:
 - lib/teuton/check/dsl/run.rb
 - lib/teuton/check/main.rb
 - lib/teuton/check/show.rb
-- lib/teuton/cli.rb
+- lib/teuton/cli/app.rb
+- lib/teuton/cli/run.rb
 - lib/teuton/deprecated/utils.rb
+- lib/teuton/errors.rb
 - lib/teuton/files/config.yaml
 - lib/teuton/files/start.rb
 - lib/teuton/files/template/case.html
 - lib/teuton/files/template/resume.html
+- lib/teuton/readme/action.rb
 - lib/teuton/readme/dsl/all.rb
 - lib/teuton/readme/dsl/expect.rb
 - lib/teuton/readme/dsl/getset.rb

data/lib/teuton/cli.rb

@@ -1,120 +0,0 @@
-require "thor"
-require_relative "version"
-require_relative "../teuton"
-
-class CLI < Thor
-  map ["h", "-h", "--help"] => "help"
-
-  map ["n", "-n", "--new"] => "new"
-  desc "new DIRECTORY", "Create skeleton for a new project"
-  long_desc <<-LONGDESC
-  Create files for a new project.
-  LONGDESC
-  def new(projectpath)
-    Teuton.create(projectpath)
-  end
-
-  map ["c", "-c", "--check"] => "check"
-  option :onlyconfig, type: :boolean
-  option :color, type: :boolean
-  option :cname, type: :string
-  option :cpath, type: :string
-  desc "check [OPTIONS] DIRECTORY", "Check test and config file content"
-  long_desc <<~LONGDESC
-
-    (1) teuton check PATH/TO/DIR , Check content of start.rb and config.yaml files.
-
-    (2) teuton check PATH/TO/DIR --cname=demo , Check content of start.rb and demo.yaml files:
-
-    (3) teuton check PATH/TO/DIR --onlyconfig  , Only show config file recomendations
-
-    (4) teuton check PATH/TO/DIR/foo.rb , Check content of foo.rb and foo.yaml files.
-
-    (5) teuton check PATH/TO/DIR/foo.rb --cname=demo , Check content of foo.rb and demo.yaml files.
-
-  LONGDESC
-  def check(projectpath)
-    Teuton.check(projectpath, options)
-  end
-
-  map ["co", "-co", "--config"] => "config"
-  desc "config [OPTIONS] DIRECTORY", "Suggest configuration."
-  long_desc <<~LONGDESC
-    config DIRECTORY, "Suggest the content of the configuration file based on the test"
-  LONGDESC
-  def config(projectpath)
-    # Check Test: suggest the content of the configuration file based on the test
-    opt = {"onlyconfig" => true}
-    Teuton.check(projectpath, opt)
-  end
-
-  map ["--readme"] => "readme"
-  option :lang, type: :string
-  desc "readme DIRECTORY", "Show README extracted from test contents"
-  long_desc <<-LONGDESC
-
-  (1) teuton readme foo
-  , Create README.md from foo/start.rb.
-
-  (2) teuton readme foo/demo.rb
-  , Create README.md from foo/demo.rb.
-  LONGDESC
-
-  def readme(projectpath)
-    # Create README from teuton test
-    Teuton.readme(projectpath, options)
-  end
-
-  map ["--run", "run"] => "play"
-  option :export, type: :string
-  option :cname, type: :string
-  option :cpath, type: :string
-  option :case, type: :string
-  option :color, type: :boolean
-  option :quiet, type: :boolean
-  desc "[run] [OPTIONS] DIRECTORY", "Run test from directory"
-  long_desc <<-LONGDESC
-  This function execute challenge from specified directory.
-  By default, show progress on the screen.
-
-  Let's see others options:
-
-  (1) teuton foo, run challenge from foo/start.rb with foo/config.yaml config file.
-
-  (2) teuton run foo, same as (1).
-
-  (3) teuton run --export=json foo, run challenge and export using json format.
-  Others output formats availables are: txt, html, yaml, json and colored_text.
-
-  (4) teuton run --cname=demo foo, run challenge from foo/start.rb with foo/demo.yaml config file.
-
-  (5) teuton foo/demo.rb, Run challenge from foo/demo.rb with foo/demo.yaml config file.
-
-  LONGDESC
-  def play(filepath)
-    Teuton.run(filepath, options)
-  end
-
-  map ["v", "-v", "--version"] => "version"
-  desc "version", "Show the program version"
-  def version
-    puts "#{Teuton::APPNAME} version #{Teuton::VERSION}"
-  end
-
-  ##
-  # These inputs are equivalents:
-  # * teuton dir/foo
-  # * teuton run dir/foo
-  def method_missing(method, *_args, &_block)
-    play(method.to_s)
-  end
-
-  def respond_to_missing?(method_name, include_private = false)
-    # Respond to missing methods name
-    super
-  end
-
-  def self.exit_on_failure?
-    true
-  end
-end