teuton-get 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6798e051552f8894c95ead5df65fe64b68d34bf34e79aeed4f9d841b199d2c83
-  data.tar.gz: f875b6b84834d25b81d312e292e566978474242709b868e0697eede5e903f163
+  metadata.gz: 562a19d3826cb7c518ab1233512970a4891cc6c27c187ed8950b9719efb626f1
+  data.tar.gz: 7ecf0a49739e45e824bd5d6ab95f0f0e7372a1ef6712f6262549e72f4df2ac00
 SHA512:
-  metadata.gz: e75bd99ed2db3b3e7ae6ac29e8cdad90538fdb248839cd01a91eb3c928f3cc60e256bd4679e585d5f41e8bf74a5033c69e60bb34b1933792a706756122bee73d
-  data.tar.gz: 8876f1b70c0e3e611212d3d09d271d156700220c62cf9a5057444313edc5129382c6a652933d806c514010106ccd193e29403229b2e8a2bb48ac1c6404b8f253
+  metadata.gz: 0bf1ab586485046eaac4198bfccd93fd96c4571fcf377f3de1a5a13090c5f5994d3f9e51ade60b11e9ce4474f4d404cd927cc6c9ca646f02b4203453634913e6
+  data.tar.gz: d8a419372d1559f5ac44f8279d3699120fa5c16c8192fe6aae6301256c96d26d607e8fc81be5d423ba53d2e3da00f8fe06249e2b210f6bb25a3620ed5ecbe2cc

data/README.md

@@ -7,9 +7,7 @@
 * Find and download _Teuton Tests_ from remote or local repositories.
 * Create _Teuton Test_ repository.
 
-![logo](./docs/images/logo.png)
-
-# Installation
+## Installation
 
 First install Ruby, then:
 
@@ -17,13 +15,12 @@ First install Ruby, then:
 gem install teuton-get
 ```
 
-# Usage
+## Usage
 
 * At first, **create config file**.
 
-```
-> teutonget init
-
+```bash
+$ teutonget init
 ==> Creating configuration files
     ✔ Create dir       : /home/quigon/.config/teuton
     ✔ Create file      : /home/quigon/.config/teuton/repos.ini
@@ -31,26 +28,24 @@ gem install teuton-get
 
 * **Refresh** repo catalog, from time to time:
 
-```
-> teutonget refresh
-
+```bash
+$ teutonget refresh
 ==> Refreshing active repos
     ✔ Repo teuton.en (10 tests)
     ✔ Repo teuton.es (4 tests)
 ```
 
-* **Search** test related with "usermin":
+* **Search** test related with *usermin*:
 
-```
-> teutonget search usermin
+```bash
+$ teutonget search usermin
 (x3) teuton.es:sistemas.3/scripting/usermin
 ```
 
-* Take a look at **test info**:
-
-```
-> teutonget info teuton.es:sistemas.3/scripting/usermin
+* **Show** test info:
 
+```bash
+$ teutonget show teuton.es:sistemas.3/scripting/usermin
 name    : usermin
 author  : fvarrui, dvarrui
 date    : 2022-11-05
@@ -59,26 +54,58 @@ 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** "teuton.es:sistemas.3/scripting/usermin":
+* **Download test** `teuton.es:sistemas.3/scripting/usermin`:
 
+```bash
+$ teutonget pull teuton.es:sistemas.3/scripting/usermin
+==> Progress [██████████████] 100%
+==> Download finished
 ```
-> teutonget download teuton.es:sistemas.3/scripting/usermin
 
-==> Progress [█████████████████████] 100%
-==> Download finished
+**Example:** Locate *TEST_ID* for `debian` related tests.
+
+```bash
+$ teutonget se debian
+(x04) teuton.en:systems.1/03-debian-conf
+(x04) teuton.en:systems.2/02-debian-basic-configuration
+(x04) teuton.en:systems.2/03-debian-mkdir-command
+(x04) teuton.en:systems.2/04-debian-users-grants
+(x04) teuton.en:systems.2/11-debian-custom-installation
 ```
 
-**Example:** Locate TEST_ID for "debian" related tests.
+## Build and install the gem from sources
+
+You can build `teuton-get` Ruby gem from sources following the next steps:
 
-![](docs/images/teutonget-search-debian.png)
+1. Clone the repo and change to its directory:
 
-# Documentation
+```bash
+git clone https://github.com/teuton-software/teuton-get
+cd teuton-get
+```
+
+2. Build the gem:
+
+```bash
+rake build
+```
+
+3. Install newly built gem:
+- On GNU/Linux or Mac OS:
+
+```bash
+sudo gem install pkg/teuton-get-*.gem
+```
+
+- On Windows as `Administrator`:
+
+```bash
+gem install pkg\teuton-get-*.gem
+```
+
+## Documentation
 
 * [Settings](docs/settings.md)
 * [Get](docs/get.md)
 * [Repository](docs/repo.md)
 * [Commands](docs/commands.md)
-
-# Contact
-
-* **Email**: `teuton.software@protonmail.com`

data/docs/commands.md

@@ -4,13 +4,14 @@
 Run `teutonget` to show available commands:
 ```
 Commands:
-  teutonget create-info [TEST-PATH]     # Create info data for Teuton test
-  teutonget create-repo [SOURCE-DIR]    # Create repo into SOURCE directory
-  teutonget download REPONAME@TESTNAME  # Download Teuton test
-  teutonget help [COMMAND]              # Describe available commands or one specific command
-  teutonget init                        # Create ini config file
-  teutonget refresh                     # Synchronize list of tests available.
-  teutonget repos                       # Show repo list
-  teutonget search [REPONAME@]FILTER    # Search Teuton test with FILTER
-  teutonget version                     # Show the program version
+  teutonget create-info DIRPATH       # Create info data for Teuton test
+  teutonget create-repo               # Create repo into current directory
+  teutonget help [COMMAND]            # Describe available commands or one specific command
+  teutonget init                      # Create ini config file
+  teutonget pull TESTID               # Download Teuton test
+  teutonget refresh                   # Synchronize list of available tests.
+  teutonget repos                     # Show repo list
+  teutonget search [REPONAME:]FILTER  # Search Teuton test with FILTER
+  teutonget show TESTID|FILTER        # Show info data for Teuton test
+  teutonget version                   # Show the program version
 ```

data/docs/get.md

@@ -5,7 +5,7 @@
 Find and download local or remote test files.
 
 1. [Search](#1-search)
-2. [Info](#2-info)
+2. [Show](#2-show)
 3. [Download](#3-download)
 
 ## 1. Search
@@ -28,7 +28,7 @@ teutonget search FILTER
 Example:
 
 ```
-❯ teutonget se window
+❯ teutonget search window
 (x3) teuton.en:systems.1/01-windows-conf
 (x1) teuton.en:systems.1/04-winserver-conf
 (x1) teuton.en:systems.2/01-install-w10-vbox
@@ -39,18 +39,19 @@ As a result we have a list of tests ordered from highest to lowest value accordi
 
 Ejample:
 ```
-❯ teutonget se script,fvarrui
+❯ teutonget search script,fvarrui
 (x6) teuton.es:sistemas.3/scripting/usermin
 (x1) teuton.en:systems.2/01-install-w10-vbox
 ```
 
 In this example, the filter is form by multiple words separated by commas. As result, will be shown tests that contain word 1 or word 2, or both. And appear in order from highest to lowest according to the number of times these words appear in the test metadata.
 
-## 2. Info
+## 2. Show
 
 Show info about test. Example:
+
 ```
-❯ teutonget info teuton.en:systems.1/03-debian-conf
+❯ teutonget show teuton.en:systems.1/03-debian-conf
 
 name    : Debian configuration
 author  : dvarrui
@@ -65,7 +66,7 @@ files   : README.md, config.yaml, debian.rb, network.rb, start.rb
 Download teuton test files identified by TESTID. Example:
 
 ```
-❯ teutonget download teuton.en:systems.1/03-debian-conf
+❯ teutonget pull teuton.en:systems.1/03-debian-conf
 
 ==> Downloading...
 ==> File: README.md

data/lib/teuton-get/cli.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "thor"
-require_relative "application"
 require_relative "version"
 require_relative "../teuton-get"
 
@@ -12,83 +11,110 @@ class CLI < Thor
   desc "version", "Show the program version"
 
   def version
-    puts "#{Version::EXECUTABLE} version #{Version::VERSION}"
+    puts "#{TeutonGet::EXECUTABLE} version #{TeutonGet::VERSION}"
   end
 
   map ["ci", "-ci", "--create-info", "create-info"] => "create_info"
-  desc "create-info [DIRPATH]", "Create info data for Teuton test"
+  option :color, type: :boolean
+  desc "create-info DIRPATH", "Create info data for Teuton test"
   long_desc <<-LONGDESC
     Create info data for Teuton test. Example: "teutonget create-info systems.1/02-opensuse-conf"
   LONGDESC
 
-  def create_info(testpath)
+  def create_info(testpath = ".")
+    TeutonGet::Format.disable if options["color"] == false
     TeutonGet.create_info(testpath)
   end
 
   map ["cr", "-cr", "--create-repo", "create-repo"] => "create_repo"
+  option :color, type: :boolean
   desc "create-repo", "Create repo into current directory"
   long_desc <<-LONGDESC
     Create index from SOURCE directory. Example: "teutonget create-repo"
   LONGDESC
   def create_repo
+    TeutonGet::Format.disable if options["color"] == false
     TeutonGet.create_repo(".")
   end
 
+  map ["d", "-d", "--download", "download", "--pull"] => "pull"
+  option :color, type: :boolean
+  desc "pull TESTID [DIRECTORY]", "Download Teuton test"
+  long_desc <<-LONGDESC
+  Example: "teutonget pull teuton.en:systems.1/02-opensuse-conf". Download test.
+  LONGDESC
+  def pull(testid, dirpath = ".")
+    TeutonGet::Format.disable if options["color"] == false
+    TeutonGet.download(testid, dirpath)
+  end
+
   map ["--init"] => "init"
+  option :color, type: :boolean
   desc "init", "Create ini config file"
   long_desc <<-LONGDESC
-    Create ini config file. Example: "teutonget init"
+    Create inital configuration files. Example: "teutonget init"
   LONGDESC
   def init
+    TeutonGet::Format.disable if options["color"] == false
     TeutonGet.init
   end
 
-  map ["i", "-i", "--info"] => "info"
-  desc "info TESTID", "Show info data for Teuton test"
+  map ["i", "-i", "--info", "info", "--show"] => "show"
+  option :color, type: :boolean
+  option :format, type: :string
+  desc "show TESTID|FILTER", "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
+    Example: "teutonget show teuton.en:systems.1/02-opensuse-conf". Show test info.
 
-  def info(test_id)
-    TeutonGet.show_info(test_id)
+    Example: "teutonget show foo --format=json". Show test info using JSON format.
+  LONGDESC
+  def show(test_id)
+    TeutonGet::Format.disable if options["color"] == false
+    TeutonGet.show_info(test_id, options)
   end
 
   map ["--repos"] => "repos"
+  option :color, type: :boolean
+  option :format, type: :string
   desc "repos", "Show repo list"
   long_desc <<-LONGDESC
-    Show repo list. Example: "teutonget repos"
+    Example: "teutonget repos". Show repo list.
+
+    Example: "teutonget repos --format=json". Show JSON repos list.
   LONGDESC
 
   def repos
-    TeutonGet.show_repo_list
+    TeutonGet::Format.disable if options["color"] == false
+    TeutonGet.show_repo_list(options)
   end
 
-  map ["r", "-r", "--refresh"] => "refresh"
+  map ["r", "-r", "--refresh", "--update", "update"] => "refresh"
+  option :color, type: :boolean
   desc "refresh", "Synchronize list of available tests."
   long_desc <<-LONGDESC
     Synchronize list of tests available. Example: "teutonget refresh"
   LONGDESC
   def refresh
+    TeutonGet::Format.disable if options["color"] == false
     TeutonGet.refresh
   end
 
   map ["s", "-s", "--search"] => "search"
+  option :color, type: :boolean
+  option :format, type: :string
   desc "search [REPONAME:]FILTER", "Search Teuton test with FILTER"
   long_desc <<-LONGDESC
-    Search Teuton test using FILTER. Example: "teutonget search opensuse"
+    Example: "teutonget search opensuse". Search tests filtering by 'opensuse'.
+
+    Example: "teutonget search debian --format=json". Search tests filtering by 'debian' and show JSON format output.
   LONGDESC
   def search(filter)
-    TeutonGet.search(filter)
+    TeutonGet::Format.disable if options["color"] == false
+    TeutonGet.search(filter, options)
   end
 
-  map ["d", "-d", "--download", "clone", "--clone"] => "download"
-  # option :dirname # FIXME
-  desc "download TESTID", "Download Teuton test"
-  long_desc <<-LONGDESC
-    Download Teuton test. Example: "teutonget download teuton.en:systems.1/02-opensuse-conf"
-  LONGDESC
-  def download(testname)
-    puts options unless options.empty?
-    TeutonGet.download(testname, options)
+  def respond_to_missing?(method_name, include_private = false)
+    # Respond to missing methods name
+    super
   end
 end

data/lib/teuton-get/downloader.rb

@@ -6,12 +6,13 @@ require_relative "reader/inifile_reader"
 require_relative "reader/url_reader"
 require_relative "repo/repo_config"
 require_relative "repo/repo_data"
+require_relative "settings"
 
 class Downloader
   def initialize
     @dev = TerminalWriter.new
-    @repo_config = RepoConfig.new_by_default.data
-    cache_dirpath = Application.instance.get(:cache_dirpath)
+    @repo_config = RepoConfig.default.data
+    cache_dirpath = Settings.get(:cache_dirpath)
     @repo_data = RepoData.new(
       config_reader: IniFileReader.new,
       progress_writer: TerminalWriter.new,
@@ -19,10 +20,10 @@ class Downloader
     )
   end
 
-  def run(id)
-    reponame, testpath = id.split(Application::SEPARATOR)
+  def run(id, dirpath = ".")
+    reponame, testpath = id.split(Settings::SEPARATOR)
 
-    repo_url, status = get_url_for reponame
+    repourl, status = get_url_for reponame
     unless status == :ok
       @dev.writeln "    #{status}"
       return false
@@ -34,7 +35,7 @@ class Downloader
       return false
     end
 
-    download(reponame, repo_url, testpath, files)
+    download(reponame, repourl, dirpath, testpath, files)
   end
 
   private
@@ -48,19 +49,27 @@ class Downloader
   end
 
   def get_files_for_test(id)
-    testdata = @repo_data.get(id)
-    return [], "ERROR: not found!" if testdata.nil?
-    files = testdata["files"]
+    testinfo = @repo_data.get_info(id)
+    return [], "ERROR: not found!" if testinfo.nil?
+    files = testinfo["files"]
     return [], "WARN: files no defined!" if files.nil?
     return [], "WARN: 0 files defined!" if files.size.zero?
     [files, :ok]
   end
 
-  def download(reponame, url, path, files)
-    bar = TTY::ProgressBar.new("==> Progress [:bar] :percent", total: files.size, bar_format: :block)
+  def download(reponame, url, dirpath, path, files)
+    bar = TTY::ProgressBar.new(
+      "==> Progress [:bar] :percent",
+      total: files.size,
+      bar_format: :block
+    )
+    localpath = if dirpath == "."
+      File.join(path.tr("/", "_"))
+    else
+      dirpath
+    end
+    FileUtils.mkdir_p(localpath) unless File.exist? localpath
 
-    localpath = path.tr("/", "_")
-    FileUtils.mkdir(localpath) unless File.exist? localpath
     files.each do |filename|
       bar.advance
 

data/lib/teuton-get/files/repos.ini

@@ -1,13 +1,13 @@
 # version 1
 
-[teuton.en]
+[dvarrui.en]
 type = teutontest
-description = Main Teuton repo
+description = Tests repository (dvarrui)
 URL = https://raw.githubusercontent.com/teuton-software/teuton-tests/master/en
 enable = true
 
-[teuton.es]
+[dvarrui.es]
 type = teutontest
-description = Repositorio principal de Teuton Test
+description = Repositorio de Tests (dvarrui)
 URL = https://raw.githubusercontent.com/teuton-software/teuton-tests/master/es
 enable = true

data/lib/teuton-get/repo/local_info.rb

@@ -1,4 +1,4 @@
-require_relative "../application"
+require_relative "../settings"
 require_relative "../writer/terminal_writer"
 require_relative "../reader/yaml_reader"
 require "erb"
@@ -11,12 +11,12 @@ class LocalInfo
     @data = {}
   end
 
-  def default_create(testpath)
+  def default_created(testpath)
     set_default_data(testpath)
     create(testpath)
   end
 
-  def user_create(testpath)
+  def user_created(testpath)
     ask_data(testpath)
     create(testpath)
   end
@@ -36,7 +36,7 @@ class LocalInfo
 
   def set_default_data(testpath)
     @data[:name] = File.basename(testpath)
-    @data[:author] = ENV["USER"]
+    @data[:author] = Settings.get("USER")
     @data[:date] = Time.now.strftime("%Y-%m-%d")
     @data[:desc] = "Write your description"
     @data[:tags] = ["Write your", "comma separated", "tags"]
@@ -60,7 +60,7 @@ class LocalInfo
       return false
     end
 
-    infofilename = Application::INFOFILENAME
+    infofilename = Settings::INFOFILENAME
     sourcepath = File.join(File.dirname(__FILE__), "..", "files", infofilename)
     template = File.read(sourcepath)
     content = ERB.new(template, trim_mode: "%>")

data/lib/teuton-get/repo/local_repo.rb

@@ -1,4 +1,4 @@
-require_relative "../application"
+require_relative "../settings"
 require_relative "../writer/file_writer"
 require_relative "../writer/terminal_writer"
 
@@ -9,7 +9,7 @@ class LocalRepo
     @dev = args[:progress_writer]
   end
 
-  def self.new_by_default
+  def self.default
     LocalRepo.new(
       repoindex_writer: FileWriter.new,
       progress_writer: TerminalWriter.new
@@ -17,19 +17,19 @@ class LocalRepo
   end
 
   def create(dirpath)
-    infofilename = Application::INFOFILENAME
+    infofilename = Settings::INFOFILENAME
     infofiles = Dir.glob(File.join(dirpath, "**", infofilename))
     return if infofiles.size.zero?
 
     @dev.writeln "\n==> Creating repository", color: :light_yellow
     data = read_files(infofiles)
 
-    filepath = File.join(dirpath, Application::INDEXFILENAME)
+    filepath = File.join(dirpath, Settings::INDEXFILENAME)
     @repoindex_writer.open(filepath)
     @repoindex_writer.write data.to_yaml
     @repoindex_writer.close
 
-    @dev.writeln "    Created file #{filepath} with #{data.keys.size} tests.", color: :white
+    @dev.writeln "    Created #{filepath} (#{data.keys.size} tests)", color: :white
     true
   end
 

data/lib/teuton-get/repo/repo_config.rb

@@ -1,7 +1,8 @@
 require "fileutils"
-require_relative "../application"
+require "json/pure"
+require_relative "../settings"
 require_relative "../reader/inifile_reader"
-require_relative "../utils/format"
+require_relative "../writer/format"
 require_relative "../writer/terminal_writer"
 
 # Create Teuton Repo config file
@@ -14,16 +15,16 @@ class RepoConfig
     @dev = args[:progress_writer]
 
     @config_dirpath = args[:config_dirpath] || ""
-    @config_filepath = File.join(@config_dirpath, Application::CONFIGFILE)
+    @config_filepath = File.join(@config_dirpath, Settings::CONFIGFILE)
   end
 
-  def self.new_by_default
-    config_filepath = Application.instance.get(:config_filepath)
+  def self.default
+    config_filepath = Settings.get(:config_filepath)
 
     RepoConfig.new(
       config_reader: IniFileReader.new(config_filepath),
       progress_writer: TerminalWriter.new,
-      config_dirpath: Application.instance.get(:config_dirpath)
+      config_dirpath: Settings.get(:config_dirpath)
     )
   end
 
@@ -33,13 +34,24 @@ class RepoConfig
     create_ini_file
   end
 
-  def show_list
+  def show_list(options)
+    if options["format"] == "json"
+      show_json_list
+    else
+      show_default_list
+    end
+  end
+
+  private
+
+  def show_default_list
     rows = []
     rows << ["E", "NAME", "DESCRIPTION"]
     rows << :separator
 
     index = 0
     @data.each_pair do |key, value|
+      next unless value["type"] == "teutontest"
       enable = "\u{2714}"
       enable = " " unless value["enable"]
       description = value["description"] || "?"
@@ -52,7 +64,16 @@ class RepoConfig
     @dev.writeln "#{@reader.source}\n", color: :white
   end
 
-  private
+  def show_json_list
+    alist = []
+    @data.each_pair do |key, values|
+      next unless values["type"] == "teutontest"
+
+      values["reponame"] = key
+      alist << values
+    end
+    puts JSON.dump(alist)
+  end
 
   def create_dir
     dirpath = @config_dirpath
@@ -73,7 +94,7 @@ class RepoConfig
   end
 
   def create_ini_file
-    src = File.join(File.dirname(__FILE__), "..", "files", Application::CONFIGFILE)
+    src = File.join(File.dirname(__FILE__), "..", "files", Settings::CONFIGFILE)
     copyfile(src, @config_filepath)
   end
 

data/lib/teuton-get/repo/repo_data.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "yaml"
-require_relative "../application"
+require_relative "../settings"
 require_relative "../reader/url_reader"
 require_relative "../reader/inifile_reader"
 require_relative "../reader/yaml_reader"
@@ -14,12 +16,12 @@ class RepoData
     @cache_dirpath = args[:cache_dirpath]
   end
 
-  def self.new_by_default
-    config_filepath = Application.instance.get(:config_filepath)
+  def self.default
+    config_filepath = Settings.get(:config_filepath)
     RepoData.new(
       config_reader: IniFileReader.new(config_filepath),
       progress_writer: TerminalWriter.new,
-      cache_dirpath: Application.instance.get(:cache_dirpath)
+      cache_dirpath: Settings.get(:cache_dirpath)
     )
   end
 
@@ -35,11 +37,11 @@ class RepoData
     save_database
   end
 
-  def get(test_id)
-    reponame, id = test_id.split(Application::SEPARATOR)
+  def get_info(test_id)
+    reponame, id = test_id.split(Settings::SEPARATOR)
     database = YamlReader.new.read(database_filename)
     return {} if database[reponame].nil?
-    database[reponame][id]
+    database[reponame][id] || {}
   end
 
   def show_testinfo(item)
@@ -113,7 +115,7 @@ class RepoData
   end
 
   def get_local_database(dirpath)
-    filepath = File.join(dirpath, Application::INDEXFILENAME)
+    filepath = File.join(dirpath, Settings::INDEXFILENAME)
     # @reader.read(filepath) # FIXME
     YAML.safe_load(
       File.read(filepath),
@@ -122,7 +124,7 @@ class RepoData
   end
 
   def get_remote_database(url_repo)
-    url_file = "#{url_repo}/#{Application::INDEXFILENAME}"
+    url_file = "#{url_repo}/#{Settings::INDEXFILENAME}"
     content_page = URLReader.new(url_file).read
     YAML.safe_load(
       content_page,

data/lib/teuton-get/searcher/result.rb

@@ -1,4 +1,4 @@
-require_relative "../application"
+require_relative "../settings"
 
 class Result
   @@repoindex = Set.new
@@ -15,13 +15,14 @@ class Result
   end
 
   def id
-    "#{reponame}#{Application::SEPARATOR}#{testname}"
+    "#{reponame}#{Settings::SEPARATOR}#{testname}"
   end
 
   def to_h
     {
       score: @score,
-      id: id, reponame: @reponame,
+      id: id,
+      reponame: @reponame,
       testname: @testname,
       repoindex: repoindex
     }

data/lib/teuton-get/searcher/search.rb

@@ -0,0 +1,110 @@
+require "json"
+require_relative "result"
+require_relative "../settings"
+require_relative "../writer/format"
+
+class Search
+  attr_reader :results
+
+  def initialize(database, dev)
+    @dev = dev
+    @database = database
+  end
+
+  def call(reponame_filter, filters)
+    @results = {}
+    @database.keys.each do |reponame|
+      if reponame_filter == :all || reponame.include?(reponame_filter)
+        search_inside_repo(reponame, filters)
+      end
+    end
+    sort_results
+  end
+
+  def show_json
+    list = []
+    @results.each do |i|
+      list << {
+        score: i[:score],
+        reponame: i[:reponame],
+        testname: i[:testname]
+      }
+    end
+    puts list.to_json
+  end
+
+  def show_screen
+    @results.each do |i|
+      @dev.write ("(x%02d) " % i[:score]), color: :white
+      reponame = TeutonGet::Format.colorize(i[:reponame], i[:repoindex])
+      @dev.writeln "#{reponame}#{Settings::SEPARATOR}#{i[:testname]}"
+    end
+  end
+
+  private
+
+  def search_inside_repo(reponame, filters)
+    return if reponame != :all && @database[reponame].nil?
+
+    @database[reponame].each do |testname, data|
+      result = Result.new(
+        score: 0,
+        reponame: reponame,
+        testname: testname
+      )
+      if filters == :all
+        add_result(result)
+        next
+      end
+      score = 0
+      filters.each do |filter|
+        score += evaluate_test(
+          testname: testname,
+          data: data,
+          filter: filter
+        )
+        if score > 0
+          result.score = score
+          add_result result
+        end
+      end
+    end
+  end
+
+  def add_result(result)
+    key = result.id
+    if @results[key].nil?
+      @results[key] = result
+      return
+    end
+    @results[key].score += result.score
+  end
+
+  def evaluate_test(args)
+    testname = args[:testname]
+    data = args[:data]
+    filter = args[:filter]
+    score = 0
+    data.each_pair do |key, value|
+      if value.instance_of? String
+        score += 1 if value.downcase.include? filter
+      elsif value.instance_of? Date
+        score += 1 if value.to_s.include? filter
+      elsif value.instance_of? Array
+        score += 1 if value.include? filter
+      end
+    end
+    score += 1 if testname.include? filter
+    score
+  end
+
+  def sort_results
+    results = []
+    @results.each_pair { |key, value| results += [value.to_h] }
+
+    results.sort_by! do |i|
+      [(Settings::MAGICNUMBER - i[:score]), i[:id]]
+    end
+    @results = results
+  end
+end

data/lib/teuton-get/searcher.rb

@@ -1,42 +1,36 @@
-require_relative "application"
+require "json"
+require_relative "settings"
 require_relative "reader/yaml_reader"
 require_relative "repo/repo_data"
-require_relative "searcher/result"
-require_relative "utils/format"
+require_relative "searcher/search"
+require_relative "writer/format"
 require_relative "writer/terminal_writer"
 
 class Searcher
-  def initialize(args)
-    @dev = args[:writer]
-
-    @repodata = args[:repodata]
-    filename = @repodata.database_filename
+  attr_reader :results
 
-    @reader = args[:reader]
-    @database = @reader.read(filename)
+  def initialize(args)
+    repodata = args[:repodata]
+    filename = repodata.database_filename
+    reader = args[:reader]
+    database = reader.read(filename)
 
-    @results = {}
+    dev = args[:writer]
+    @search = Search.new(database, dev)
   end
 
-  def self.new_by_default
+  def self.default
     Searcher.new(
       writer: TerminalWriter.new,
-      repodata: RepoData.new_by_default,
+      repodata: RepoData.default,
       reader: YamlReader.new
     )
   end
 
   def get(input)
     reponame_filter, filters = parse_input(input)
-    search_inside(reponame_filter, filters)
-  end
-
-  def show_result
-    @results.each do |i|
-      @dev.write ("(x%02d) " % i[:score]), color: :white
-      reponame = TeutonGet::Format.colorize(i[:reponame], i[:repoindex])
-      @dev.writeln "#{reponame}#{Application::SEPARATOR}#{i[:testname]}"
-    end
+    @search.call(reponame_filter, filters)
+    @search
   end
 
   private
@@ -44,7 +38,7 @@ class Searcher
   def parse_input(input)
     reponame_filter = :all
     filter = :all
-    options = input.split(Application::SEPARATOR)
+    options = input.split(Settings::SEPARATOR)
     if options.size == 1
       reponame_filter = :all
       filter = options[0]
@@ -63,82 +57,4 @@ class Searcher
     end
     [reponame_filter, filters]
   end
-
-  def search_inside(reponame_filter, filters)
-    @results = {}
-    if reponame_filter == :all
-      @database.keys.each { |reponame| search_inside_repo(reponame, filters) }
-    else
-      @database.keys.each do |reponame|
-        search_inside_repo(reponame, filters) if reponame.include? reponame_filter
-      end
-    end
-    sort_results
-  end
-
-  def search_inside_repo(reponame, filters)
-    return if reponame != :all && @database[reponame].nil?
-
-    @database[reponame].each do |testname, data|
-      result = Result.new(
-        score: 0,
-        reponame: reponame,
-        testname: testname
-      )
-      if filters == :all
-        add_result(result)
-        next
-      end
-      score = 0
-      filters.each do |filter|
-        score += evaluate_test(
-          testname: testname,
-          data: data,
-          filter: filter
-        )
-        if score > 0
-          result.score = score
-          add_result result
-        end
-      end
-    end
-  end
-
-  def evaluate_test(args)
-    testname = args[:testname]
-    data = args[:data]
-    filter = args[:filter]
-
-    score = 0
-    data.each_pair do |key, value|
-      if value.instance_of? String
-        score += 1 if value.downcase.include? filter
-      elsif value.instance_of? Date
-        score += 1 if value.to_s.include? filter
-      elsif value.instance_of? Array
-        score += 1 if value.include? filter
-      end
-    end
-    score += 1 if testname.include? filter
-    score
-  end
-
-  def add_result(result)
-    key = result.id
-    if @results[key].nil?
-      @results[key] = result
-      return
-    end
-    @results[key].score += result.score
-  end
-
-  def sort_results
-    results = []
-    @results.each_pair { |key, value| results += [value.to_h] }
-
-    results.sort_by! do |i|
-      [(Application::MAGICNUMBER - i[:score]), i[:id]]
-    end
-    @results = results
-  end
 end

data/lib/teuton-get/{application.rb → settings.rb}

@@ -1,39 +1,40 @@
-require "singleton"
-require_relative "application/environment"
-
-class Application
-  include Singleton
-
+class Settings
   CONFIGFILE = "repos.ini"
   INDEXFILENAME = "tt-repo.yaml"
   INFOFILENAME = "tt-info.yaml"
   MAGICNUMBER = 999
   SEPARATOR = ":"
 
-  def initialize
-    @env = Environment.new
-    init_params
-  end
-
-  def get(key)
+  def self.get(key)
     return @env.get(key) if key.instance_of? String
 
     @params[key] || "NODATA"
   end
 
-  private
+  class Environment
+    def initialize(reader = nil)
+      @env = ENV
+    end
 
-  def init_params
+    def get(key)
+      @env[key]
+    end
+  end
+
+  def self.init_params
     @params = {}
     home = get("HOME")
     config_dirpath = File.join(home, ".config", "teuton")
     @params[:config_dirpath] = config_dirpath
 
-    filename = Application::CONFIGFILE
+    filename = CONFIGFILE
     config_filepath = File.join(config_dirpath, filename)
     @params[:config_filepath] = config_filepath
 
     cache_dirpath = File.join(config_dirpath, "cache")
     @params[:cache_dirpath] = cache_dirpath
   end
+
+  @env = Environment.new
+  init_params
 end

data/lib/teuton-get/show_info.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "repo/repo_data"
+require_relative "searcher"
+require "json/pure"
+
+class ShowInfo
+  def initialize
+    @repo_data = RepoData.default
+  end
+
+  def call(testid, options)
+    testinfo = get_testinfo(testid)
+    if options["format"] == "json"
+      puts testinfo.to_json
+    else
+      @repo_data.show_testinfo(testinfo)
+    end
+  end
+
+  private
+
+  def get_testinfo(testid)
+    testinfo = @repo_data.get_info(testid)
+
+    if testinfo == {}
+      results = Searcher.default.get(testid).results
+      if results.size.zero?
+        puts "No results!"
+        exit 1
+      elsif results.size == 1
+        testid = results[0][:id]
+        testinfo = @repo_data.get_info(testid)
+        exit 1 if testinfo == {}
+      else
+        results.each { |i| puts "* #{i[:id]}" }
+        puts "#{results.size} results!"
+        exit 1
+      end
+    end
+
+    testinfo
+  end
+end

data/lib/teuton-get/version.rb

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

data/lib/teuton-get/writer/format.rb

@@ -0,0 +1,48 @@
+require "colorize"
+
+module TeutonGet
+  class Format
+    COLORS = [:light_blue, :light_magenta, :light_cyan, :red, :green, :yellow]
+
+    def self.disable
+      String.disable_colorization = true
+    end
+
+    def self.colorize(text = "", option = nil)
+      return text if option.nil?
+      color = if option.instance_of? Integer
+        if option < COLORS.size
+          COLORS[option]
+        else
+          COLORS[option - COLOR.size]
+        end
+      elsif option.instance_of? Symbol
+        option
+      else
+        :silver
+      end
+      text.colorize(color)
+    end
+  end
+end
+
+# class MyColor
+#  COLORS = {
+#    black: 30, red: 31, green: 32, yellow: 33,
+#    blue: 34, violet: 35, cyan: 36, white: 37
+#  }
+#
+#  def color(code)
+#    color = COLORS[code]
+#    if color.nil?
+#      color = COLORS[:violet]
+#      puts "[WARN] MyColor: unkown value color #{code}"
+#    end
+#
+#    if code == :white
+#      "\e[%dm#{@text}\e[0m" % color
+#    else
+#      "\e[%d;1m#{@text}\e[0m" % color
+#    end
+#  end
+# end

data/lib/teuton-get/writer/terminal_writer.rb

@@ -1,8 +1,14 @@
 require "tty-table"
 require_relative "writer"
-require_relative "../utils/format"
+require_relative "format"
 
 class TerminalWriter < Writer
+  attr_accessor :quiet
+
+  def initialize
+    @quiet = false
+  end
+
   def write(text = "", args = {})
     print TeutonGet::Format.colorize(text, args[:color])
   end
@@ -13,7 +19,6 @@ class TerminalWriter < Writer
 
   def write_table(rows)
     table = TTY::Table.new(rows)
-    # puts table.render(:basic)
     puts table.render(:ascii)
   end
 end

data/lib/teuton-get.rb

@@ -1,50 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "teuton-get/downloader"
 require_relative "teuton-get/repo/local_info"
 require_relative "teuton-get/repo/local_repo"
 require_relative "teuton-get/repo/repo_config"
 require_relative "teuton-get/repo/repo_data"
 require_relative "teuton-get/searcher"
-require_relative "teuton-get/downloader"
+require_relative "teuton-get/show_info"
 
 module TeutonGet
-  # Create metadata for local user teuton test
   def self.create_info(testpath)
-    LocalInfo.new.user_create(testpath)
+    # Create metadata for local user teuton test
+    LocalInfo.new.user_created(testpath)
   end
 
-  # Create metadata for local user teuton repository
   def self.create_repo(dirpath)
-    LocalRepo.new_by_default.create(dirpath)
+    # Create metadata for local user teuton repository
+    LocalRepo.default.create(dirpath)
   end
 
-  # Download remote teuton test
-  def self.download(test_id, options)
-    Downloader.new.run(test_id)
+  def self.download(...)
+    # Download teuton test from remote
+    Downloader.new.run(...)
   end
 
-  # Create Teuton Repo config file
   def self.init
-    RepoConfig.new_by_default.create
+    # Create Teuton Repo config file
+    RepoConfig.default.create
     refresh # Auto repo refresh
   end
 
-  # Refresh Teuton Repo Data
   def self.refresh
-    RepoData.new_by_default.refresh
+    # Refresh Teuton Repo Data
+    RepoData.default.refresh
   end
 
-  def self.show_repo_list
-    RepoConfig.new_by_default.show_list
+  def self.show_repo_list(...)
+    RepoConfig.default.show_list(...)
   end
 
-  def self.show_info(test_id)
-    repo_data = RepoData.new_by_default
-    info = repo_data.get(test_id)
-    repo_data.show_testinfo(info) unless info == {}
+  def self.show_info(...)
+    ShowInfo.new.call(...)
   end
 
-  def self.search(filter)
-    searcher = Searcher.new_by_default
-    searcher.get(filter)
-    searcher.show_result
+  def self.search(filter, options)
+    searcher = Searcher.default
+    search = searcher.get(filter)
+    exit 1 if search.results.size.zero?
+
+    if options["format"] == "json"
+      search.show_json
+    else
+      search.show_screen
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton-get
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-26 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: tty-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -117,8 +131,6 @@ files:
 - docs/repo.md
 - docs/settings.md
 - lib/teuton-get.rb
-- lib/teuton-get/application.rb
-- lib/teuton-get/application/environment.rb
 - lib/teuton-get/cli.rb
 - lib/teuton-get/downloader.rb
 - lib/teuton-get/files/repos.ini
@@ -134,9 +146,12 @@ files:
 - lib/teuton-get/repo/repo_data.rb
 - lib/teuton-get/searcher.rb
 - lib/teuton-get/searcher/result.rb
-- lib/teuton-get/utils/format.rb
+- lib/teuton-get/searcher/search.rb
+- lib/teuton-get/settings.rb
+- lib/teuton-get/show_info.rb
 - lib/teuton-get/version.rb
 - lib/teuton-get/writer/file_writer.rb
+- lib/teuton-get/writer/format.rb
 - lib/teuton-get/writer/null_writer.rb
 - lib/teuton-get/writer/terminal_writer.rb
 - lib/teuton-get/writer/writer.rb

data/lib/teuton-get/application/environment.rb

@@ -1,9 +0,0 @@
-class Environment
-  def initialize(reader = nil)
-    @env = ENV
-  end
-
-  def get(key)
-    @env[key]
-  end
-end

data/lib/teuton-get/utils/format.rb

@@ -1,23 +0,0 @@
-require "colorize"
-
-module TeutonGet
-  module Format
-    COLORS = [:light_blue, :light_magenta, :light_cyan, :red, :green, :yellow]
-
-    def self.colorize(text = "", option = nil)
-      return text if option.nil?
-      color = if option.instance_of? Integer
-        if option < COLORS.size
-          COLORS[option]
-        else
-          COLORS[option - COLOR.size]
-        end
-      elsif option.instance_of? Symbol
-        option
-      else
-        :silver
-      end
-      text.colorize(color)
-    end
-  end
-end