teuton 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8888bb5a43b357d2968cdcf354d1bad4851649f282a4ef1d24f7ad26ba04243
-  data.tar.gz: 2c476f06e9b429c19c4fc87c0fd783b30fd4931bf2887fcf7fe834c86463e028
+  metadata.gz: 118f06096e18d4e4e8a820460912f2585fa6cb2a22297defd54f45a59306cc37
+  data.tar.gz: 871b5189621de21ecf4c3de56434a7ded8c20fe486459c7bc3f7605b5c3c07ee
 SHA512:
-  metadata.gz: b0ca5960c2334209ae1bf9058cb017554664b58b1d7b7854b647efb9bf240e09098d4a939f0325b3056910029251412b76aea57a06d72db20a3e1febe091266f
-  data.tar.gz: e6a0f6a97d6a77a4c7e7ad9286de04de2145c15d40be0b781f9d7f98db5d28cdc662ff570cb7e4573c264f03cac6bd56946935d32852eafbee9bb9647b343ac3
+  metadata.gz: 523106ae12c17ff1fc1de7d43b276c51c17c3c92cf7e0498f12fcd665650dc4e98bc0decf8569985a81baa1cc83dc3dccb26f9a81102f072034fb0fa26199219
+  data.tar.gz: 456521fc910d9f2fa4787c05239a40701c3366584c897723e213032351c4bfed79a3216d97e60758c3cbafcf05099d60b1a425b61483ca75bf86f1dc61a0826c

data/bin/teuton

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
-require 'teuton'
-Teuton.start(ARGV)
+require 'teuton/command'
+TeutonCommand.start(ARGV)

data/lib/teuton/application.rb

@@ -4,8 +4,8 @@ require 'singleton'
 class Application
   include Singleton
 
-  VERSION = '2.1.0'
-  NAME = 'teuton'
+  VERSION = '2.1.1' # Application version
+  NAME = 'teuton'   # Application name
 
   attr_reader   :letter
   attr_reader   :running_basedir, :output_basedir

data/lib/teuton/command/main.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'create'
-require_relative 'download'
 require_relative 'play'
 require_relative 'readme'
 require_relative 'test'

data/lib/teuton/command/play.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Teuton#play
-class Teuton < Thor
+class TeutonCommand < Thor
   map ['p', '-p', 'play', '--play'] => 'play'
   option :export, type: :string
   option :cname, type: :string
@@ -28,6 +28,9 @@ class Teuton < Thor
   (5) teuton foo/demo.rb, Run challenge from foo/demo.rb with foo/demo.yaml config file.
 
   LONGDESC
+  ##
+  # Execute Teuton test unit
+  # @param path_to_rb_file [String] Route to main rb Teuton file
   def play(path_to_rb_file)
     Project.play(path_to_rb_file, options)
   end

data/lib/teuton/command/readme.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Teuton#readme
-class Teuton < Thor
+class TeutonCommand < Thor
   map ['r', '-r', '--readme'] => 'readme'
   option :lang, type: :string
   desc 'readme DIRECTORY',

data/lib/teuton/command/test.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Teuton#test
-class Teuton < Thor
+class TeutonCommand < Thor
   map ['t', '-t', '--test'] => 'test'
   option :c, type: :boolean
   option :cname, type: :string

data/lib/teuton/command/update.rb

@@ -3,7 +3,7 @@
 require 'rainbow'
 
 # Class method Teuton#update
-class Teuton < Thor
+class TeutonCommand < Thor
   map ['--update', '-u', 'u'] => 'update'
   desc 'update', 'Update TEUTON from git repo'
   long_desc <<-LONGDESC

data/lib/teuton/command/version.rb

@@ -3,7 +3,7 @@
 require 'rainbow'
 
 # Class method Teuton#version
-class Teuton < Thor
+class TeutonCommand < Thor
   map ['v', '-v', '--version'] => 'version'
   desc 'version', 'Show the program version'
   def version

data/lib/teuton/command.rb

@@ -0,0 +1,34 @@
+require 'thor'
+require_relative 'application'
+require_relative 'project/project'
+require_relative 'project/project_creator.rb'
+require_relative 'command/main'
+
+##
+# Command Line User Interface
+class TeutonCommand < Thor
+  map ['h', '-h', '--help'] => 'help'
+
+  def method_missing(method, *_args, &_block)
+    play(method.to_s)
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    super
+  end
+
+  map ['c', '-c', '--create'] => 'create'
+  desc 'create DIRECTORY', 'Create skeleton for a new project'
+  long_desc <<-LONGDESC
+  Create files for a new project: foo.rb, foo.yaml and .gitignore
+
+  Example:
+
+  #{$PROGRAM_NAME} create foo/demo
+  LONGDESC
+  ##
+  # Command create new Teuton project
+  def create(path_to_new_dir)
+    ProjectCreator.create(path_to_new_dir)
+  end
+end

data/lib/teuton/project/configfile_reader.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require 'json'
+require 'json/pure'
 
 # Functions that read data from ConfigFile using formats YAML and JSON
 # * read

data/lib/teuton/project/project_creator.rb

@@ -25,10 +25,10 @@ module ProjectCreator
   def self.create_main_dir_and_files(project_dir, source_basedir)
     # Directory and files: Ruby script, Configfile, gitignore
     items = [
-      { source: 'lib/files/config.yaml', target: 'config.yaml' },
-      { source: 'lib/files/start.rb', target: 'start.rb' },
-      { source: 'lib/files/README.md', target: 'README.md' },
-      { source: 'lib/files/gitignore', target: '.gitignore' }
+      { source: 'teuton/files/config.yaml', target: 'config.yaml' },
+      { source: 'teuton/files/start.rb', target: 'start.rb' },
+      { source: 'teuton/files/README.md', target: 'README.md' },
+      { source: 'teuton/files/gitignore', target: '.gitignore' }
     ]
     items.each do |item|
       source = File.join(source_basedir, item[:source])
@@ -54,7 +54,7 @@ module ProjectCreator
       begin
         FileUtils.mkdir_p(dirpath)
         puts "* Create dir        => #{Rainbow(dirpath).green}"
-      rescue StandarError
+      rescue StandardError
         puts "* Create dir  ERROR => #{Rainbow(dirpath).red}"
       end
     end
@@ -68,10 +68,11 @@ module ProjectCreator
     if File.exist? dest
       puts "* Exists file!      => #{Rainbow(dest).yellow}"
     else
+      puts "* File not found!   => #{Rainbow(target).yellow}" unless File.exist? target
       begin
         FileUtils.cp(target, dest)
         puts "* Create file       => #{Rainbow(dest).green}"
-      rescue StandarError
+      rescue StandardError
         puts "* Create file ERROR => #{Rainbow(dest).red}"
       end
     end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'json/pure'
 require_relative 'array_formatter'
 
 # JSONFormatter class

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

@@ -1,4 +1,5 @@
 
+require 'json/pure'
 require_relative 'resume_array_formatter'
 
 # JSONFormatter class

data/lib/teuton.rb

@@ -1,17 +1,47 @@
-require 'thor'
 require_relative 'teuton/application'
 require_relative 'teuton/project/project'
-require_relative 'teuton/command/main'
+require_relative 'teuton/project/project_creator'
 
-# Command Line User Interface
-class Teuton < Thor
-  map ['h', '-h', '--help'] => 'help'
+##
+# Main Teuton functions
+module Teuton
+  ##
+  # Create new Teuton project
+  def self.create(path_to_new_dir)
+    ProjectCreator.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)
+  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)
+  end
 
-  def method_missing(method, *_args, &_block)
-    play(method.to_s)
+  ##
+  # Simulate play Teuton project, check syntax and display stats.
+  # @param path_to_rb_file [String] Path to main rb file.
+  def self.test(path_to_rb_file)
+    Project.test(path_to_rb_file, options)
   end
 
-  def respond_to_missing?(method_name, include_private = false)
-    super
+  ##
+  # Display Teuton version
+  def self.version
+    print Rainbow(Application::NAME).bright.blue
+    puts  ' (version ' + Rainbow(Application::VERSION).green + ')'
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: teuton
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2019-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -137,15 +137,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.74'
 description: |2
-    Intrastructure Test Software.
-
-    Some dependencies require compilation.
-    Ensure these packages are installed into your local hosts:
-    [ALL] ruby, make, gcc
-    [Debian] ssh, ruby-dev
-    [OpenSUSE] openssh, ruby-devel
+    Intrastructure test, useful for:
+    (1) Sysadmin teachers to evaluate students remote machines.
+    (2) Sysadmin apprentices to evaluate their learning process as a game.
+    (3) Professional sysadmin to monitor remote machines.
 
-    Read Teuton documentation: https://github.com/teuton-software/teuton/wiki/
+    Allow us:
+    (a) Write test units for real or virtual machines using simple DSL.
+    (b) Check compliance with requirements on remote machines.
 email: teuton.software@protonmail.com
 executables:
 - teuton
@@ -193,8 +192,7 @@ files:
 - lib/teuton/case_manager/report.rb
 - lib/teuton/case_manager/show.rb
 - lib/teuton/case_manager/utils.rb
-- lib/teuton/command/create.rb
-- lib/teuton/command/download.rb
+- lib/teuton/command.rb
 - lib/teuton/command/main.rb
 - lib/teuton/command/play.rb
 - lib/teuton/command/readme.rb

data/lib/teuton/command/create.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../project/project_creator.rb'
-
-# Teuton#create
-class Teuton < Thor
-  map ['c', '-c', '--create'] => 'create'
-  desc 'create DIRECTORY', 'Create skeleton for a new project'
-  long_desc <<-LONGDESC
-  Create files for a new project: foo.rb, foo.yaml and .gitignore
-
-  Example:
-
-  #{$PROGRAM_NAME} create foo/demo
-
-  LONGDESC
-  def create(path_to_new_dir)
-    ProjectCreator.create(path_to_new_dir)
-  end
-end

data/lib/teuton/command/download.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'rainbow'
-
-# Class method Teuton#download
-class Teuton < Thor
-  map ['-dc', '--dc', '--download'] => 'download'
-  desc 'download', 'Download Teuton challenges from git repo'
-  long_desc <<-LONGDESC
-  - Download Teuton challenges from git repo.
-
-  - Same as:
-    git clone https://github.com/teuton-software/teuton-challenges.git
-
-  Example:
-
-  #{$PROGRAM_NAME} download
-
-  LONGDESC
-  def download
-    repo = 'teuton-challenges'
-    puts "[INFO] Downloading <#{repo}> repo..."
-    ok = system("git clone https://github.com/teuton-software/#{repo}.git")
-    if ok
-      puts "[INFO] Your files are into <#{Rainbow(repo).bright}> directory..."
-    else
-      puts Rainbow('[ERROR] Ensure: ').red
-      puts Rainbow('  1. Git is installed.').red
-      puts Rainbow('  2. Your Internet connection is working.').red
-    end
-  end
-end