clir 0.22.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04a1f95d975d1d275d120e81fb1a3226e2d8ff93807ad70578e6ac1171c6d525
+  data.tar.gz: 2f16578c4588470f8d4e5ad49971febf3a50201c6fd874b5986b65f53c85fcdb
+SHA512:
+  metadata.gz: cd859cd9d54f2d689939786042943cd65a39ee476964e3d089bef9a5c9468fb3b508ad7fb335ad7e76899745ff19c172de2b302dfffd032521aecc449debd299
+  data.tar.gz: 7d1a4acba85f7d6cb7197b6b7b98407b8c6280091a867017afc54fe4460fb43b04e138b407773c230ac7ff031e5dc60d09999030485e04aed7b80be81fd80e4f

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,229 @@
+* 022.0
+
+  - Extension pour la clas CSV (lecture en arrière)
+
+* 0.19.0
+  
+  - Amélioration du manuel
+
+* 0.18.2
+
+  - petite correction pour rubycop…
+
+* 0.18.1
+
+  - mkdir_p alias de mkdir
+    (à cause des changements de FileUtils…)
+
+* 0.18.0
+
+  - Add File#append method
+
+* 0.17.2
+
+  - Add human_date/date_humaine method
+
+* 0.17.1
+
+  - Add File#affix method
+
+* 0.16.1
+
+  - Fixed bug String#camelize (frozen string)
+
+* 0.16.0
+
+  - Ajout du gem FileUtils
+
+* 0.15.2
+
+  - Minibug sur @params fixed
+
+* 0.15.1
+
+  - String#max and String#max!
+
+* 0.14.4
+
+  - :sentence => :verbal in formate_date
+
+* 0.14.3
+
+  - Cosmetic
+
+* 0.14.2
+
+  - Improvement of formate_date
+
+* 0.14.1
+
+  - Improvement of formate_date
+
+* 0.14.0
+
+  - formate_date
+  - date_from
+  - date_for_file
+
+* 0.13.0
+
+  - String#cjust
+  - Alignment in table columns
+
+* 0.11.2
+
+  - Col max width in Clir::Table
+
+* 0.11.1
+
+  - Cosmetic for Clir::Table
+
+* 0.11.0
+
+  - Utils method for number (devise methods)
+  - Powerfull Clir::Table
+
+* 0.10.0
+
+  - Date utils methods
+  - Yard for documentation
+
+* 0.9.0
+
+  - Methods semaine, jour, heure, minute (et pluriel + anglaises)
+
+* 0.8.0
+
+  - Method camelize
+  - Method decamelize
+  - Method titleize
+
+* 0.7.1
+
+  - Add colors (backgrounds and foregrounds)
+
+* 0.7.0
+
+  - Add File extension file
+  - New method: File.tail
+
+* 0.6.3
+
+  - Fixed bug in TTY::MyPrompt (2)
+
+* 0.6.2
+
+  - Fixed bug in TTY::MyPrompt
+
+* 0.6.1
+
+  - Marker for TTY::MyPrompt to be able to keep interactive mode
+  - during the tests.
+  - Methods TTY::MyPrompt::set_mode_interactive, TTY::MyPrompt::set_mode_inputs, TTY::MyPrompt::unset_mode_interactive
+
+* 0.6.0
+
+  - Method CLI::set_tests_on_with_marker
+  - Method CLI::unset_tests_on_with_marker
+  - To universalize the test state.
+
+* 0.5.1
+
+  - Method TTY::MyPrompt.set_mode_inputs (alias)
+
+* 0.5.0
+
+  - Enable to toggle interactive/inputs mode in TTY::MyPrompt
+  - current instance. ((efficient))
+
+* 0.4.9
+
+  - Enable to toggle interactive/inputs mode in TTY::MyPrompt
+  - current instance. ((inefficient))
+
+* 0.4.8
+
+  - Environment constant 'NO_CLI_TEST_INPUTS' to use TTY-Prompt in
+  - regular mode.
+
+* 0.4.7
+
+  - Options :template pour formate_date
+
+* 0.4.6
+
+  - Ajout de la méthode Q.default_name_for_value
+
+* 0.4.5
+
+  - Ajout de la méthode String#patronize
+
+* 0.4.4
+
+  - Ajout de la méthode String#normalize[d]
+
+* 0.4.3
+
+  - Ajout de la méthode round
+
+* 0.4.2
+
+  - Ajout de la méthode String#numeric?
+
+* 0.4.1
+
+  - Ajout de la méthode Symbol#in?
+
+* 0.4.0
+
+  - Ajout des méthodes in? pour String et Integer
+
+* 0.3.1
+
+  - Ajout des méthodes TTY-Prompt yes? et no?
+
+* 0.3.0
+
+  - Remise de TTY-MyPrompt
+
+* 0.2.1
+
+  - 'less' pour les tests (on écrit directement le texte)
+
+* 0.2.0
+
+  - Ajout de méthode String (as_title, columnize, etc.)
+
+* 0.1.8
+
+  - Amélioration de 'clear' (qui sautait une ligne)
+
+* 0.1.7
+
+  - Ajout de la méthode utile 'formate_date'
+
+* 0.1.6
+
+  - Ajout de la couleur vert clair (ligth_green, vert_clair)
+
+* 0.1.5
+
+  - Ajout des méthode CLI.option(key) et CLI.param(key)
+
+* 0.1.4
+
+  - Ajout de la méthode 'require_folder' qui requiert tous les scripts
+  - ruby d'un dossier donné en argument.
+
+* 0.1.3
+
+  - Ajout du strike pour barrer du texte, italic pour mettre en
+  - italic et underline pour souligner, en console.
+
+* 0.1.1
+
+  - Auto-init CLI (parse) when app calls :options, :params, etc.
+
+* 0.1.0
+
+  - Création du Gem

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in clir.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "yard"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    clir (0.22.0)
+      json
+      tty-prompt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (2.6.3)
+    minitest (5.16.3)
+    minitest-color (0.0.2)
+      minitest (~> 5)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (12.3.3)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    webrick (1.7.0)
+    wisper (2.0.1)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  clir!
+  minitest (~> 5.0)
+  minitest-color
+  rake (~> 12.0)
+  yard
+
+BUNDLED WITH
+   2.1.4

data/Manual/Manuel_fr.md

@@ -0,0 +1,222 @@
+# Manuel du gem `clir`
+
+~~~ruby
+require 'clir'
+~~~
+
+
+
+> NOTE : CE DOCUMENT EST TRÈS LOIN DE PRÉSENTER TOUTES LES MÉTHODES
+
+
+
+[TOC]
+
+
+
+## L'application
+
+### CLI
+
+Si on joue cette commande dans le terminal : `macom --version help -n pour voir valeur=12`
+
+On obtiendra : 
+
+~~~ruby
+
+CLI.command_name
+# => 'macom'
+ 
+CLI.main_command
+# => 'help'
+
+CLI.options
+# => {version: true, n: true} # ou remplacement de :n
+
+CLI.params
+# => {value: 12}
+
+CLI.components
+# => ['pour', 'voir']
+
+~~~
+
+### Options de la ligne de commande
+
+~~~ruby
+CLI.options # => liste complète des options
+CLI.option(:option) # => true si l'option --option est activité
+~~~
+
+L’option peut aussi avoir une valeur :
+
+~~~
+> macommande -n=4 -o
+
+# =>
+
+# {n: 4, o: true}
+~~~
+
+Voir aussi [les options propres à l’application](#app-own-options).
+
+### Rejouer une commande (mode `Replayer`)
+
+Pour rejouer une commande — pas seulement la commmande mais aussi toutes les entrées qui ont été faites — on joue juste `app _`.
+
+> Attention : il faut vraiment qu'il n'y ait que '\_' après la commande et rien d'autre, même pas une option.
+
+C'est une commande particulièrement utile quand on teste l'application car elle évite d'avoir à retaper chaque fois les commandes et les options.
+
+
+
+---
+
+## File extensions
+
+### `File#tail`
+
+Retourne les x dernières du fichier sans avoir à le lire en intégralité (parfait pour les fichiers énormes.
+
+~~~ruby
+@syntax
+	File.tail(path, nombre_lignes)
+
+# Par exemple
+
+File.tail("monfichier.txt", 2000)
+# => Retourne les 2000 dernières lignes du fichier (ou moins s'il y en a moins)
+# Note : les lignes sont dans le même ordre.
+~~~
+
+
+
+## CLI Tests
+
+### inputs
+
+#### Simuler l'interruption forcée du programme
+
+Dans l'input, utiliser `EXIT` ou `CTRL-C` (et ses variantes avec tiret plat ou espace) ou `^C`.
+
+#### Pour `Q.yes?`
+
+`with_inputs` peut contenir :
+
+* "o", "y", 1, "true", "yes", "oui" pour retourner `true`
+* toute autre valeur retournera `false`
+
+#### Pour `Q.select`
+
+`with_inputs` peut contenir :
+
+* la valeur explicite à retourner
+
+  ~~~ruby
+  with_inputs ['valeur explicite']
+  ~~~
+
+* la valeur par le nom du menu (non sensible à la casse)
+
+  ~~~ruby
+  with_inputs [{name:"le nom du menu"}]
+  ~~~
+
+* la valeur par une expression régulière (non sensible à la casse)
+
+  ~~~ruby
+  with_inputs [{rname: "men"}] # => le premier menu contenant "men"
+  ~~~
+
+* la valeur par un index (1-start) de menu
+
+  ~~~ruby
+  with_inputs [{index:2}] # => la valeur du deuxième menu
+  ~~~
+
+
+#### Pour `Q.multiselect`
+
+`with_inputs` peut contenir :
+
+* les valeurs explicites à retourner
+
+  ~~~ruby
+  with_inputs [
+    ['valeurs','explicites']
+  ]
+  ~~~
+
+* les valeur par le nom des menus (non sensible à la casse)
+
+  ~~~ruby
+  with_inputs [{names:["premier", "deuxième"]}]
+  ~~~
+
+* les valeurs par une expression régulière (non sensible à la casse)
+
+  ~~~ruby
+  with_inputs [{rname: "men"}] # => Tous les menus contenant "men"
+  ~~~
+
+* les valeurs par plusieurs expressions régulières
+
+  ~~~ruby
+  with_inputs [{rnames: ["men", "nue"]}] # => Tous les menus contenant "men" ou "nue"
+  ~~~
+
+* les valeurs par liste d'index (1-start) de menu
+
+  ~~~ruby
+  with_inputs [{index:[2,4]}] # => la valeur du 2e et 4e menu
+  ~~~
+
+#### Pour `Q.multiline`
+
+On peut envoyer le texte explicite qu'aurait tapé l'utilisateur :
+
+~~~ruby
+with_inputs = ["Le\nTexte\nExplicite"]
+~~~
+
+Pour simuler les touches ⌃D (control et D), on peut utiliser au choix : `CTRL-D`, `CTRL D`, `CTRL_D` ou `^D`.
+
+> Note : mais cela revient simplement à mettre un texte vide.
+
+### Mode interactif/entrées
+
+Parfois, pendant les tests, on peut vouloir taper les entrées à la main (ou par osascript). Dans ce cas, il faut changer TTY-Prompt de mode. Cela se fait à l'aide de :
+
+~~~ruby
+TTY::MyPrompt.set_mode_interactive
+# => Q passe en mode interactif, avec l'affichage à l'écran du prompt
+~~~
+
+~~~ruby
+TTY::MyPrompt.unset_mode_interactive
+# => Pour revenir en mode par inputs
+~~~
+
+Pour vérifier le mode courant, on peut faire appel à :
+
+~~~ruby
+Q.mode
+# => :interactive ou :inputs
+~~~
+
+
+
+<a name="app-own-options"></a>
+
+## Options propres à l’application
+
+Pour définir ses propres options en ligne de commande :
+
+~~~ruby
+CLI.set_options_table({
+  s: :simulation,
+  ...
+})
+~~~
+
+> Noter que les deux éléments doivent être des `Symbol`s.

data/README.md

@@ -0,0 +1,63 @@
+# Clir
+
+A lot of usefull methods to deal with CLI application and more. Its my Swizerland's Knife.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clir'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install clir
+
+## Usage
+
+[TODO] Reprendre toutes les méthodes
+
+### Test state
+
+~~~ruby
+# Use it in test_helper.rb ou spec_helper.rb
+
+require 'clir'
+
+CLI.set_tests_on_with_marker
+# => universal test marker. Whereever you call the app, test?
+# will be true
+
+# Don't forget to use :
+CLI.unset_tests_on_with_marker
+# … to remove test on
+~~~
+
+### Mode test with interactive mode for TTY
+
+When tests are ON, TTY::(My)Prompt toggle in `inputs_mode` so tests can send it the fake-user inputs. Sometimes though, tests use `Osascript` to run *real live test* (like if an user stokes real keys). In this case, `TTY::Prompt` must stay in `interactive mode`. To do so, tests have to call these methods:
+~~~ruby
+
+TTY::MyPrompt.set_mode_interactive
+# => TTY:MyPrompt toggles in interactive mode during the tests
+
+TTY::MyPrompt.set_mode_inputs
+# => TTY::MyPrompt toggles in inputs mode during the tests (or not…)
+
+~~~
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clir.
+

data/REFLEXIONS.md

@@ -0,0 +1,8 @@
+# Réflexions
+
+# Replayer
+
+En fait, le replayer et le mode test pourraient partager les mêmes choses puisqu'au fond ils fonctionnent de la même manière :
+
+* le mode test définit des `inputs` qui sont les entrées de l'utilisateur simulé
+* le mode replay définit de la même manière les `inpupts` précédents

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,9 @@
+# Todo list
+
+* Faire une application fictive (dans les tests) qui permettent de :
+  - l'utiliser pour voir si tout fonctionne bien
+  - l'utiliser avec les tests pour une "vraie" application
+
+## Fonctionnalités
+
+* Développer la class `Config`

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clir"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clir.gemspec

@@ -0,0 +1,40 @@
+require_relative 'lib/clir/version'
+
+Gem::Specification.new do |s|
+  s.name          = "clir"
+  s.version       = Clir::VERSION
+  s.authors       = ["Philippe Perret"]
+  s.email         = ["philippe.perret@yahoo.fr"]
+
+  s.summary       = %q{Command Line Interface for Ruby applications}
+  s.description   = %q{Command Line Interface for Ruby applications}
+  # s.homepage      = "https://github.com/PhilippePerret/clir"
+  s.homepage      = "https://rubygems.org/gems/clir"
+  s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # --- Development dependencies ---
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-color'
+
+  # --- Dependencies ---
+
+  s.add_dependency "json"
+  s.add_dependency "tty-prompt"
+
+
+  s.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/PhilippePerret/clir"
+  s.metadata["changelog_uri"] = "https://github.com/PhilippePerret/clir/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/clir/Array.ext.rb

@@ -0,0 +1,9 @@
+class Array
+
+  def pretty_join
+    return self.first if self.count == 1
+    ary = self.dup
+    dernier = ary.pop
+    ary.join(', ') + ' et ' + dernier.to_s
+  end
+end