teuton-get 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbdff5b1a781df1aeb1ddb23fc43b504787f0a43a255d44e72fcea0789e92f99
-  data.tar.gz: f557290df95c13818dcfce2d79756cead6c757ed320261a046a7cff0c5a8b955
+  metadata.gz: b783cab2c10f1a23f61fe5b8e53e108dcce79fb8b97a0ab1a717b4244a0f193c
+  data.tar.gz: 576048fe21ce48012784d2ff48ba21198f94d63cff33f55d8091a5dc137947e4
 SHA512:
-  metadata.gz: 3745b13fb5ae095f5c1b87c39ac9471795ee39dff9f844a96012ce4ac613971237f122504828f6cfd21189394545acd22fa452187b28daf72f2a70abc116cd16
-  data.tar.gz: 17448758d158b88b1370b45dffe0bc7310c2e5c3efd8ecff7a90b35b4358a729c1857e289dca68758be2d47c6a27e4fa6f948dc99e7597005dd06aca763682f7
+  metadata.gz: 93a9660d795aabc86399f2a7393175b07359ff22294d9c66487367478dd234fbf93f764a5c9310c89fb2de176876a9a7860acb74081e5a9cc1e7919d4eea4493
+  data.tar.gz: 4bc2009d8d715113336b0970beef9d4e92b949c48689358d328238dcc851aa88747d6ee6d4efe86c54ed2a1beeb212f0d51c94670ba9604f28fef4084dc5eae1

data/README.md

@@ -15,19 +15,68 @@
 # Use
 
 1. `teutonget init`, at first, create config file.
-1. `teutonget search FILTER`. then, search tests. Example: `teutonget search linux`, will show a list with "linux" related tests.
+1. `teutonget refresh`, to refresh repo catalog.
+1. `teutonget search FILTER`. then, search tests.
 1. `teutonget download REPONAME:TESTPATH`, download test files.
 
-## Example
+## Examples
 
-* Search test and show details:
+**Example 1: search and download**
 
-![](docs/images/teutonget-info.png)
+* Create config files:
+
+```
+> teutonget init
+
+==> Creating configuration files
+    ✔ Create dir       : /home/quigon/.config/teuton
+    ✔ Create file      : /home/quigon/.config/teuton/repos.ini
+```
+
+* Refresh repo catalog:
+
+```
+> teutonget refresh
+
+==> Refreshing active repos
+    ✔ Repo teuton.en (10 tests)
+    ✔ Repo teuton.es (4 tests)
+```
+
+* Search test:
+
+```
+> teutonget search usermin
+(x3) teuton.es:sistemas.3/scripting/usermin
+```
+
+* Show details:
+
+```
+> teutonget info teuton.es:sistemas.3/scripting/usermin
+
+name    : usermin
+author  : fvarrui, dvarrui
+date    : 2022-11-05
+desc    : Usermin. Script para la gestión de usuarios
+tags    : script, usuario, crear, consultar, listar, eliminar
+files   : INSTALL.md, README.md, bin/docker.run, bin/up_environ.sh, config.yaml, lib/docker/consultar.rb, lib/docker/eliminar.rb, lib/docker/help.rb, lib/docker/listar.rb, lib/docker/nuevo.rb, lib/vm/consultar.rb, lib/vm/eliminar.rb, lib/vm/help.rb, lib/vm/listar.rb, lib/vm/nuevo.rb, start.rb, tt-info.yaml, vagrant/install-software.sh, vagrant/profesor.rb, vm.rb, vm.yaml
+```
 
 * Download test:
 
-![](docs/images/teutonget-download.png)
+```
+> teutonget download teuton.es:sistemas.3/scripting/usermin
+
+==> Progress [█████████████████████] 100%
+==> Download OK
+```
+
+**Example 2: Locate TEST ID**
+
+Teuton test ID (TESTID) is `REPONAME:TESTPATH`.
 
+![](docs/images/teutonget-search-debian.png)
 
 # Contact
 

data/docs/repo.md

@@ -65,6 +65,7 @@ Example:
 
 ```
 [REPONAME]
+type = teutontest
 description = WRITE REPO DESCRIPTION
 URL = https://write.here/your/repo/url
 enable = true
@@ -72,6 +73,8 @@ enable = true
 
 * Run `teutonget repos` to check configuration.
 
+> Every repo is showed with different color automatically.
+
 ## 4. Configure local repository
 
 The usual thing will be to have remote repositories from where to download the tests. This process requires a network connection between our local machine and the remote repository.
@@ -85,6 +88,7 @@ Example:
 
 ```
 [LOCALREPONAME]
+type = teutontest
 description = WRITE LOCAL REPO DESCRIPTION
 URL = /path/to/your/local/repo/folder
 enable=true

data/lib/teuton-get/cli.rb

@@ -6,56 +6,59 @@ require_relative "version"
 require_relative "../teuton-get"
 
 class CLI < Thor
-  map ["h", "-h", "--help"] => "help"
+  map ["-help", "--help"] => "help"
 
-  map ["v", "-v", "--version"] => "version"
+  map ["-version", "--version"] => "version"
   desc "version", "Show the program version"
 
   def version
     puts "#{Version::EXECUTABLE} (version #{Version::VERSION})"
   end
 
-  map ["ci", "-ci", "--create-info"] => "create_info"
+  map ["ci", "-ci", "--create-info", "create-info"] => "create_info"
   desc "create-info [DIRPATH]", "Create info data for Teuton test"
   long_desc <<-LONGDESC
-  Create info data for Teuton test.
+    Create info data for Teuton test. Example: "teutonget create-info systems.1/02-opensuse-conf"
   LONGDESC
+
   def create_info(testpath)
     TeutonGet.create_info(testpath)
   end
 
-  map ["i", "-i", "--info"] => "info"
-  desc "info TESTID", "Show info data for Teuton test"
-  long_desc <<-LONGDESC
-  Show info data for Teuton test.
-  LONGDESC
-  def info(test_id)
-    TeutonGet.show_info(test_id)
-  end
-
-  map ["cr", "-cr", "--create-repo"] => "create_repo"
+  map ["cr", "-cr", "--create-repo", "create-repo"] => "create_repo"
   desc "create-repo", "Create repo into current directory"
   long_desc <<-LONGDESC
-  Create index from SOURCE directory.
+    Create index from SOURCE directory. Example: "teutonget create-repo"
   LONGDESC
   def create_repo
     TeutonGet.create_repo(".")
   end
 
-  map ["i", "-i", "--init"] => "init"
+  map ["--init"] => "init"
   desc "init", "Create ini config file"
   long_desc <<-LONGDESC
-    Create ini config file
+    Create ini config file. Example: "teutonget init"
   LONGDESC
   def init
     TeutonGet.init
   end
 
+  map ["i", "-i", "--info"] => "info"
+  desc "info TESTID", "Show info data for Teuton test"
+  long_desc <<-LONGDESC
+    Show info data for Teuton test. Example: "teutonget info teuton.en:systems.1/02-opensuse-conf"
+  LONGDESC
+
+  def info(test_id)
+    TeutonGet.show_info(test_id)
+  end
+
   map ["--repos"] => "repos"
   desc "repos", "Show repo list"
   long_desc <<-LONGDESC
-    Show repo list.
+    Show repo list. Example: "teutonget repos"
   LONGDESC
+
   def repos
     TeutonGet.show_repo_list
   end
@@ -63,7 +66,7 @@ class CLI < Thor
   map ["r", "-r", "--refresh"] => "refresh"
   desc "refresh", "Synchronize list of available tests."
   long_desc <<-LONGDESC
-    Synchronize list of tests available.
+    Synchronize list of tests available. Example: "teutonget refresh"
   LONGDESC
   def refresh
     TeutonGet.refresh
@@ -72,18 +75,20 @@ class CLI < Thor
   map ["s", "-s", "--search"] => "search"
   desc "search [REPONAME:]FILTER", "Search Teuton test with FILTER"
   long_desc <<-LONGDESC
-  Search Teuton test with FILTER.
+    Search Teuton test using FILTER. Example: "teutonget search opensuse"
   LONGDESC
   def search(filter)
     TeutonGet.search(filter)
   end
 
-  map ["d", "-d", "--download"] => "download"
+  map ["d", "-d", "--download", "clone", "--clone"] => "download"
+  # option :dirname # FIXME
   desc "download TESTID", "Download Teuton test"
   long_desc <<-LONGDESC
-    Download Teuton test. Example: "teutonget main@system/opensuse"
+    Download Teuton test. Example: "teutonget download teuton.en:systems.1/02-opensuse-conf"
   LONGDESC
   def download(testname)
-    TeutonGet.download(testname)
+    puts options unless options.empty?
+    TeutonGet.download(testname, options)
   end
 end

data/lib/teuton-get/downloader.rb

@@ -1,4 +1,5 @@
 require "fileutils"
+require "tty-progressbar"
 require_relative "writer/file_writer"
 require_relative "writer/terminal_writer"
 require_relative "reader/inifile_reader"
@@ -56,16 +57,19 @@ class Downloader
   end
 
   def download(reponame, url, path, files)
-    @dev.writeln "==> Downloading '#{path}' from repo '#{reponame}'...", color: :light_yellow
+    bar = TTY::ProgressBar.new("==> Progress [:bar] :percent", total: files.size, bar_format: :block)
+
     localpath = path.tr("/", "_")
     FileUtils.mkdir(localpath) unless File.exist? localpath
     files.each do |filename|
-      @dev.writeln "==> File: #{filename} ", color: :white
+      bar.advance
+
       uri = "#{url}/#{path}/#{filename}"
       out = FileWriter.new
       out.open(File.join(localpath, filename))
       out.write(URLReader.new(uri).read)
       out.close
     end
+    @dev.writeln "==> Download OK", color: :white
   end
 end

data/lib/teuton-get/searcher.rb

@@ -33,7 +33,7 @@ class Searcher
 
   def show_result
     @results.each do |i|
-      @dev.write "(x#{i[:score]}) ", color: :white
+      @dev.write ("(x%02d) " % i[:score]), color: :white
       reponame = TeutonGet::Format.colorize(i[:reponame], i[:repoindex])
       @dev.writeln "#{reponame}#{Application::SEPARATOR}#{i[:testname]}"
     end

data/lib/teuton-get/version.rb

@@ -1,6 +1,6 @@
 module Version
   NAME = "teuton-get"
   EXECUTABLE = "teutonget"
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
   HOMEPAGE = "https://github.com/teuton-software/#{NAME}"
 end

data/lib/teuton-get.rb

@@ -17,7 +17,7 @@ module TeutonGet
   end
 
   # Download remote teuton test
-  def self.download(test_id)
+  def self.download(test_id, options)
     Downloader.new.run(test_id)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton-get
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 description: "    Find and download Teuton Test.\n"
 email: teuton.software@protonmail.com
 executables:
@@ -138,7 +152,7 @@ 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:
   - - ">="