teuton 2.1.11 → 2.2.2

data/lib/teuton/{project → utils}/name_file_finder.rb

@@ -3,8 +3,9 @@
 require 'rainbow'
 require_relative '../application'
 
-# Project:
-# * find_filenames_for, verbose, verboseln
+##
+# NameFileFinder module
+# Methods: find_filenames_for, verbose, verboseln
 module NameFileFinder
   ##
   # Find project filenames from input project relative path
@@ -28,6 +29,8 @@ module NameFileFinder
   ##
   # Find project filenames from input folder path
   # @param folder_path (String)
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def self.find_filenames_from_directory(folder_path)
     # COMPLEX MODE: We use start.rb as main RB file
     script_path = File.join(folder_path, 'start.rb')
@@ -45,15 +48,20 @@ module NameFileFinder
 
     find_configfilename_from_directory(folder_path)
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 
   ##
   # Find project config filename from input folder path
   # @param folder_path (String)
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Style/IfUnlessModifier
   def self.find_configfilename_from_directory(folder_path)
     # COMPLEX MODE: We use config.yaml by default
     app = Application.instance
-
     config_path = ''
+
     if app.options['cpath'].nil?
       config_name = 'config'
       # Config name file is introduced by cname arg option from teuton command
@@ -68,7 +76,12 @@ module NameFileFinder
     end
     app.config_path = config_path
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Style/IfUnlessModifier
 
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def self.find_filenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
@@ -86,7 +99,12 @@ module NameFileFinder
 
     find_configfilenames_from_rb(script_path)
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Style/IfUnlessModifier
   def self.find_configfilenames_from_rb(script_path)
     # SIMPLE MODE: We use script_path as main RB file
     # This must be fullpath to DSL script file
@@ -108,32 +126,33 @@ module NameFileFinder
     end
     app.config_path = config_path
   end
-
-  def self.puts_input_info_on_screen
-    app = Application.instance
-
-    verbose Rainbow('[INFO] ScriptPath => ').blue
-    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
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Style/IfUnlessModifier
+
+  #  def self.puts_input_info_on_screen
+  #    app = Application.instance
+  #
+  #    verbose Rainbow('[INFO] ScriptPath => ').blue
+  #    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
 
   ##
   # Trim string text when is too long
-  # @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
-    offset = (Dir.pwd).length + 1
-    output = "#{input[offset, input.size]}"
-    output.to_s
-  end
+  #  def self.trim(input)
+  #    return input unless input.to_s.start_with? Dir.pwd.to_s
+  #
+  #    output = input.to_s
+  #    offset = (Dir.pwd).length + 1
+  #    output = "#{input[offset, input.size]}"
+  #    output.to_s
+  #  end
 
   def self.verboseln(text)
     verbose(text + "\n")
@@ -142,6 +161,7 @@ module NameFileFinder
   def self.verbose(text)
     return unless Application.instance.verbose
     return if Application.instance.options['quiet']
+
     print text
   end
 end

data/lib/teuton/version.rb

@@ -0,0 +1,8 @@
+
+module Teuton
+  VERSION = '2.2.2'
+  APPNAME = 'teuton'
+  GEMNAME = 'teuton'
+  DOCKERNAME = "dvarrui/#{GEMNAME}"
+  HOMEPAGE = "https://github.com/teuton-software/teuton"
+end

data/lib/teuton.rb

@@ -1,47 +1,54 @@
+# frozen_string_literal: true
+
 require_relative 'teuton/application'
-require_relative 'teuton/project/project'
-require_relative 'teuton/project/skeleton'
+require_relative 'teuton/skeleton'
 
-##
-# Main Teuton functions
 module Teuton
-  ##
-  # Create new Teuton project
   def self.create(path_to_new_dir)
     Skeleton.create(path_to_new_dir)
   end
 
-  ##
-  # Play (run) Teuton project.
-  # @param path_to_rb_file [String] Path to main rb file.
-  # @param options [Hash] Options like
-  # * :export [String]
-  # * :cname [String]
-  # * :cpath [String]
-  # * :case [String]
-  # * :quiet [Boolean]
-  def self.play(path_to_rb_file, options = {})
-    Project.play(path_to_rb_file, options)
+  # Run test
+  # @param projectpath (String) Path to teuton test
+  # @param options (Array) Array of input options
+  def self.run(projectpath, options = {})
+    Application.instance.add_input_params(projectpath, options)
+    require_dsl_and_script('teuton/case_manager/dsl') # Define DSL keywords
   end
 
-  ##
-  # Generate readme for Teuton project.
-  # @param path_to_rb_file [String] Path to main rb file.
-  def self.readme(path_to_rb_file)
-    Project.readme(path_to_rb_file, options)
+  # Create Readme file for a test
+  # @param projectpath (String) Path to teuton test
+  # @param options (Array) Array of input options
+  def self.readme(projectpath, options = {})
+    Application.instance.add_input_params(projectpath, options)
+    require_dsl_and_script('teuton/readme/readme') # Define DSL keywords
+
+    app = Application.instance
+    readme = Readme.new(app.script_path, app.config_path)
+    readme.show
   end
 
-  ##
-  # Simulate play Teuton project, check syntax and display stats.
-  # @param path_to_rb_file [String] Path to main rb file.
-  def self.check(path_to_rb_file)
-    Project.check(path_to_rb_file, options)
+  # Check teuton test syntax
+  # @param projectpath (String) Path to teuton test
+  # @param options (Array) Array of input options
+  def self.check(projectpath, options = {})
+    Application.instance.add_input_params(projectpath, options)
+    require_dsl_and_script('teuton/check/laboratory') # Define DSL keywords
+
+    app = Application.instance
+    lab = Laboratory.new(app.script_path, app.config_path)
+    lab.show unless options[:panelconfig]
+    lab.show_panelconfig if options[:panelconfig]
   end
 
-  ##
-  # Display Teuton version
-  def self.version
-    print Rainbow(Application::NAME).bright.blue
-    puts  ' (version ' + Rainbow(Application::VERSION).green + ')'
+  private_class_method def self.require_dsl_and_script(dslpath)
+    app = Application.instance
+    require_relative dslpath
+    begin
+      require_relative app.script_path
+    rescue SyntaxError => e
+      puts e.to_s
+      puts Rainbow.new("[ FAIL ] SyntaxError into file #{app.script_path}").red
+    end
   end
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.1.11
+  version: 2.2.2
 platform: ruby
 authors:
 - David Vargas Ruiz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2022-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json_pure
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: net-telnet
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.74'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: |2
     Intrastructure test, useful for:
     (1) Sysadmin teachers to evaluate students remote machines.
@@ -153,44 +195,47 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
-- docs/learn/example-03-remote-hosts.md
-- docs/learn/example-07-readme.md
-- docs/learn/example-05-debug.md
-- docs/learn/example-02-config.md
-- docs/learn/example-11-first-test.md
-- docs/learn/videos.md
-- docs/learn/example-06-log.md
-- docs/learn/example-08-preserve.md
-- docs/learn/example-04-use.md
-- docs/learn/example-01-target.md
-- docs/learn/README.md
-- docs/changelog/v2.1.md
-- docs/changelog/v2.2.md
-- docs/changelog/contributions.md
-- docs/changelog/servidor-de-retos.md
-- docs/changelog/v2.0.md
-- docs/commands/example_run.md
 - docs/commands/README.md
 - docs/commands/example_check.md
+- docs/commands/example_run.md
+- docs/learn/README.md
+- docs/learn/example-01-target.md
+- docs/learn/example-02-config.md
+- docs/learn/example-03-remote-hosts.md
+- docs/learn/example-04-new-test.md
+- docs/learn/example-05-use.md
+- docs/learn/example-06-debug.md
+- docs/learn/example-07-log.md
+- docs/learn/example-08-readme.md
+- docs/learn/example-09-preserve.md
+- docs/learn/videos.md
+- docs/dsl/README.md
+- docs/dsl/setting/get.md
+- docs/dsl/setting/set.md
 - docs/dsl/definition/result.md
-- docs/dsl/definition/target.md
-- docs/dsl/definition/group.md
 - docs/dsl/definition/expect.md
-- docs/dsl/definition/run_local.md
+- docs/dsl/definition/group.md
 - docs/dsl/definition/run_remote.md
+- docs/dsl/definition/run_local.md
+- docs/dsl/definition/target.md
 - docs/dsl/execution/export.md
 - docs/dsl/execution/play.md
 - docs/dsl/execution/send.md
 - docs/dsl/execution/show.md
-- docs/dsl/setting/set.md
-- docs/dsl/setting/get.md
-- docs/dsl/README.md
 - docs/Challenge-Server-Project.md
-- docs/install/modes_of_use.md
-- docs/install/vagrant_docker.md
-- docs/install/scripts.md
+- docs/videos.md
 - docs/install/README.md
 - docs/install/manual.md
+- docs/install/modes_of_use.md
+- docs/install/scripts.md
+- docs/install/vagrant_docker.md
+- docs/changelog/v2.2.md
+- docs/changelog/v2.0.md
+- docs/changelog/servidor-de-retos.md
+- docs/changelog/contributions.md
+- docs/changelog/v2.1.md
+- docs/changelog/ideas.md
+- docs/changelog/version2.1.md
 files:
 - LICENSE
 - README.md
@@ -198,10 +243,12 @@ files:
 - bin/teuton
 - docs/Challenge-Server-Project.md
 - docs/changelog/contributions.md
+- docs/changelog/ideas.md
 - docs/changelog/servidor-de-retos.md
 - docs/changelog/v2.0.md
 - docs/changelog/v2.1.md
 - docs/changelog/v2.2.md
+- docs/changelog/version2.1.md
 - docs/commands/README.md
 - docs/commands/example_check.md
 - docs/commands/example_run.md
@@ -227,13 +274,14 @@ files:
 - docs/learn/example-01-target.md
 - docs/learn/example-02-config.md
 - docs/learn/example-03-remote-hosts.md
-- docs/learn/example-04-use.md
-- docs/learn/example-05-debug.md
-- docs/learn/example-06-log.md
-- docs/learn/example-07-readme.md
-- docs/learn/example-08-preserve.md
-- docs/learn/example-11-first-test.md
+- docs/learn/example-04-new-test.md
+- docs/learn/example-05-use.md
+- docs/learn/example-06-debug.md
+- docs/learn/example-07-log.md
+- docs/learn/example-08-readme.md
+- docs/learn/example-09-preserve.md
 - docs/learn/videos.md
+- docs/videos.md
 - lib/teuton.rb
 - lib/teuton/application.rb
 - lib/teuton/case_manager/case/builtin/main.rb
@@ -270,29 +318,19 @@ files:
 - lib/teuton/case_manager/report.rb
 - lib/teuton/case_manager/show.rb
 - lib/teuton/case_manager/utils.rb
+- lib/teuton/check/builtin.rb
+- lib/teuton/check/dsl.rb
+- lib/teuton/check/laboratory.rb
+- lib/teuton/check/show.rb
 - lib/teuton/cli.rb
-- lib/teuton/cli/check.rb
-- lib/teuton/cli/main.rb
-- lib/teuton/cli/play.rb
-- lib/teuton/cli/readme.rb
-- lib/teuton/cli/version.rb
 - lib/teuton/files/README.md
 - lib/teuton/files/config.yaml
-- lib/teuton/files/gitignore
 - lib/teuton/files/start.rb
 - lib/teuton/files/template/case.html
 - lib/teuton/files/template/resume.html
-- lib/teuton/project/configfile_reader.rb
-- lib/teuton/project/laboratory/builtin.rb
-- lib/teuton/project/laboratory/dsl.rb
-- lib/teuton/project/laboratory/laboratory.rb
-- lib/teuton/project/laboratory/show.rb
-- lib/teuton/project/name_file_finder.rb
-- lib/teuton/project/project.rb
-- lib/teuton/project/readme/dsl.rb
-- lib/teuton/project/readme/lang.rb
-- lib/teuton/project/readme/readme.rb
-- lib/teuton/project/skeleton.rb
+- lib/teuton/readme/dsl.rb
+- lib/teuton/readme/lang.rb
+- lib/teuton/readme/readme.rb
 - lib/teuton/report/close.rb
 - lib/teuton/report/formatter/array_formatter.rb
 - lib/teuton/report/formatter/base_formatter.rb
@@ -313,12 +351,16 @@ files:
 - lib/teuton/report/formatter/yaml_formatter.rb
 - lib/teuton/report/report.rb
 - lib/teuton/report/show.rb
+- lib/teuton/skeleton.rb
+- lib/teuton/utils/configfile_reader.rb
+- lib/teuton/utils/name_file_finder.rb
 - lib/teuton/utils/verbose.rb
-homepage: https://github.com/teuton-software/teuton/tree/devel
+- lib/teuton/version.rb
+homepage: https://github.com/teuton-software/teuton
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: Thanks for installing!
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -326,15 +368,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.5.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Teuton (Teuton Software)
 test_files: []

data/lib/teuton/cli/check.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-# CLI#test
-class CLI < Thor
-  map ['t', '-t', '--test', 'test'] => 'check'
-  option :c, type: :boolean
-  option :cname, type: :string
-  option :cpath, type: :string
-  desc 'check [OPTIONS] DIRECTORY',
-       'Test or check challenge contents'
-  long_desc <<-LONGDESC
-
-  (1) teuton test path/to/dir/foo
-  , Test content of start.rb and config.yaml files.
-
-  (2) teuton test path/to/dir/foo -c
-  , Only test CONFIG information from config.yaml.
-
-  (3) teuton test path/to/dir/foo --cname=demo
-  , Test content of start.rb and demo.yaml files.
-
-  (4) teuton test path/to/file/foo.rb
-  , Test content of foo.rb and foo.yaml files.
-
-  (5) teuton test path/to/file/foo.rb -c
-  , Only test CONFIG information from foo.yaml.
-
-  (6) teuton test path/to/file/foo.rb --cname=demo
-  , Test content of foo.rb and demo.yaml files.
-
-  LONGDESC
-  ##
-  # Verify or test Teuton test units syntax
-  # @param path_to_rb_file [String] Route to main rb Teuton file
-  def check(path_to_rb_file)
-    Project.check(path_to_rb_file, options)
-  end
-end

data/lib/teuton/cli/main.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'check'
-require_relative 'play'
-require_relative 'readme'
-require_relative 'version'

data/lib/teuton/cli/play.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-# CLI#play
-class CLI < Thor
-  map ['p', '-p', 'play', '--play', '--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 challenge 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 play foo, same as (1).
-
-  (3) teuton play --export=json foo, run challenge and export using json format.
-  Others output formats availables are: txt, colored_text, json, yaml.
-
-  (4) teuton play --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
-  ##
-  # Execute Teuton test unit
-  # @param filepath [String] Route to main: rb file or folder
-  def play(filepath)
-    Project.play(filepath, options)
-  end
-end

data/lib/teuton/cli/readme.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# CLI#readme
-class CLI < Thor
-  map ['--readme'] => 'readme'
-  option :lang, type: :string
-  desc 'readme DIRECTORY',
-       'Create README.md file from challenge 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.
-
-  By default lang=es, but It's available lang=en too.
-
-  LONGDESC
-  ##
-  # Create README from teuton test
-  # @param path_to_rb_file [String] Route to main rb Teuton file
-  def readme(path_to_rb_file)
-    Project.readme(path_to_rb_file, options)
-  end
-end

data/lib/teuton/cli/version.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-# Class method Teuton#version
-class CLI < Thor
-  map ['v', '-v', '--version'] => 'version'
-  desc 'version', 'Show the program version'
-  ##
-  # Display version
-  def version
-    puts "#{Application::NAME} (version #{Application::VERSION})"
-  end
-end

data/lib/teuton/files/gitignore

@@ -1,2 +0,0 @@
-*.yaml
-*.json