Erstellen interaktive Rubin Konsolenanwendung

Question

I interaktive Anwendung machen will, wo es Benutzer starten und können durch Eingabe von Befehlen (eine Art von Shell)

Beispiel verschiedene Aufgaben tun:

./myapp.rb 
App says Hi 
Commands: 
    help - display help about command 
    open - open task 
    do - do action 
Start>help open 
    open <TaskName> 
    opens specified task 
Start>open Something 
Something>do SomeAction 
    Success! 
Something> (blinking cursor here) 

ich aber couldn gesucht Finde keine Ruby-Edelsteine, die ich speziell für die Konsoleninteraktion verwenden könnte, also bin ich dabei, meine eigene zu machen ...

Ich schaute auf Thor, aber das ist nicht genau so wie ich wa nt, vielleicht könnte ich es verwenden, aber nicht sicher ...

es etwas aussehen könnte:

meine Frage ist

class Tasks 
    attr_reader :opened_task 

    desc "open <TaskName>", "opens specified task" 
    def open(params) 
    end 

    desc "do <ActionName>", "do specified action" 
    def do(params) 
    end 
end 

tasks = Tasks.new 
# theoretical Console class 
console = Console.new 
console.addCommand("open",tasks.method(:open),"open task") 
console.addCommand("do",tasks.method(:do),"do action") 
console.start("%s>",[*tasks.opened_task]) 

ja, welche Edelsteine ​​kann ich verwende solche Konsole Klasse zu machen? Vielleicht hat jemand schon etwas Ähnliches gemacht? Ich plane mit HighLine für die Eingabe/Ausgabe, aber jeden anderen Vorschlag, was ich verwenden könnte?

Answer 1

Was Sie wollen, ist ein REPL - Read → Evaluate → Print Loop.

IRB zum Beispiel implementiert eine REPL für die Ruby-Sprache.

Hier ist eine sehr einfache Implementierung von REPL Ihrer Anwendung:

loop do 
    Application::Console.prompt.display 
    input = gets.chomp 
    command, *params = input.split /\s/ 

    case command 
    when /\Ahelp\z/i 
    puts Application::Console.help_text 
    when /\Aopen\z/i 
    Application::Task.open params.first 
    when /\Ado\z/i 
    Application::Action.perform *params 
    else puts 'Invalid command' 
    end 
end 

\A und \z Spiel der Anfang des Strings und das Ende des Strings sind.

Answer 2

class MyAPI 
    def self.__is__(text) 
    @__is__ = text 
    end 

    def self.method_added(method) 
    @__help__ ||= {} 
    @__help__[method.to_s] = @__is__ 
    @__is__ = nil 
    end 

    def self.help(of) 
    @__help__[of] 
    end 

    __is__ "open file <file>" 
    def open(file) 
    #... 
    end 

    __is__ "do X" 
    def do(*params) 
    #... 
    end 

    __is__ "calls help, use help <command>" 
    def help(*args, &block) 
    self.class.help(*args, &block) 
    end 
end 

MyAPI.new(...).pry 

Oder könnten Sie hebeln Befehle verwenden, aber das besiegt die Turing-Vollständigkeit. Hilfe könnte mithilfe von Befehlen implementiert werden, da ich nicht sicher bin, wie gut mein Ansatz funktioniert. Diese Methoden müssen codiert defensiv sein. Ich kann mich nicht erinnern, wie man Klassenvariablen benutzt: -

Answer 3

Sie könnten auch versuchen ripl. (Aus der Dokumentation): Erstellen und eine benutzerdefinierten Shell-Start ist so einfach wie:

require 'ripl' 
# Define plugins, load files, etc... 
Ripl.start 

Es ist eine umfassende Liste von Plugins für RIPL sowie Liste der Konsolenanwendungen RIPL auf den Projekten Website.

Answer 4

ok, also habe ich diese Bibliothek zum Erstellen von Konsolenanwendungen in Ruby gemacht. Eigentlich war es vor einiger Zeit, aber nur gerade beschlossen, es zu veröffentlichen. Es unterstützt die automatische Vervollständigung, wenn es mit HighLine und Readline verwendet wird.

Als ich es schrieb, gab es keine Dokumentation noch Tests/Spezifikationen, aber jetzt habe ich einige gemacht. Immer noch nicht viel aber für den Anfang sollte ok sein.

So gem cli-console und Code ist bei GitHub, hier ist usage example

Answer 5

Werfen Sie einen Blick auf cliqr ruby ​​gem. Es sieht genau so aus, wie du es brauchst.Hier ist der GitHub Link mit einer beschreibenden Readme: https://github.com/anshulverma/cliqr

Es kann die Befehle direkt oder innerhalb einer eingebauten Shell ausführen.

Hier ist ein Testfall von seinem git Repo:

it 'can execute a sub action from shell' do 
     cli = Cliqr.interface do 
     name 'my-command' 
     handler do 
      puts 'base command executed' 
     end 

     action :foo do 
      handler do 
      puts 'foo executed' 
      end 

      action :bar do 
      handler do 
       puts 'bar executed' 
      end 
      end 
     end 
     end 

     with_input(['', 'my-command', 'foo', 'foo bar', 'foo bar help']) do 
     result = cli.execute %w(my-command shell), output: :buffer 
     expect(result[:stdout]).to eq <<-EOS 
Starting shell for command "my-command" 
my-command > . 
base command executed 
my-command > my-command. 
base command executed 
my-command > foo. 
foo executed 
my-command > foo bar. 
bar executed 
my-command > foo bar help. 
my-command foo bar 

USAGE: 
    my-command foo bar [actions] [options] [arguments] 

Available options: 

    --help, -h : Get helpful information for action "my-command foo bar" along with its usage information. 

Available actions: 
[ Type "my-command foo bar help [action-name]" to get more information about that action ] 

    help -- The help action for command "my-command foo bar" which provides details and usage information on how to use the command. 
my-command > exit. 
shell exited with code 0 
     EOS 
     end 
    end 

Answer 6

TTY ist ein wirklich gutes Juwel für diese Art von Dingen leicht zu tun. Sie haben viele Werkzeuge, die alleine oder mit dem vollen ToolKit arbeiten können. Sie können Farben, Aufforderungen, Shell-Natives ausführen, mit dem Bildschirm interagieren, Tabellen, Fortschrittsbalken und viele andere nützliche Elemente von Befehlszeilen mit der Leichtigkeit einer Goop-API drucken.

Insbesondere tty-prompt ist wirklich nützlich für die Frage nach Benutzereingaben.

Ein kurzes Beispiel für den Fall, dass Sie vorgeschlagen:

require 'tty-prompt' 
require 'pastel' 

prompt = TTY::Prompt.new 
loop do 
    cmd, parms* = prompt.ask('user@machine$ ').split /\s/ 
    case cmd 
    when "hola" 
     puts "Hola amigo " parms 
    when "exit" 
     break if prompt.yes?('Do you really want to exit?') 
    end 
end