創建交互式Ruby控制檯應用程序

Question

我想使交互式應用，其中用戶運行它，並可以通過

例如鍵入命令（某種殼）做各種任務：

./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) 

我搜查，但couldn沒有找到任何寶石寶石，我可以專門用於控制檯交互，所以我即將做出我自己的...

我看着Thor，但那不完全如我wa NT，也許我可以使用它，但不知道...

它可能看起來像：

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]) 

所以我的問題是，什麼寶石我可以用它來做出這樣的控制檯類？也許有人已經做出了類似的東西？ 我計劃使用HighLine進行輸入/輸出，但任何其他建議我可以使用什麼？

Answer 1

你想要的是一個REPL - Read → Evaluate → Print Loop。例如，IRB爲Ruby語言實現了REPL。

這裏是一個非常簡單的實現應用程序的REPL的：

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和\z匹配的字符串分別開始和字符串的結尾。

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 

或者你可以使用撬命令，但擊敗 圖靈完備。可能使用命令來實現幫助，因爲我不知道我的方法效果如何。這些方法需要編碼爲 防禦性。我不記得如何使用類變量： -/

Answer 3

您也可以嘗試ripl。 （從文件）：

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

有插件RIPL的完整列表以及使用項目網站上RIPL控制檯應用程序列表： 創建和啓動自定義外殼的就是這麼簡單。

Answer 4

好的，所以我創建了這個庫，用於在ruby中創建控制檯應用程序。實際上它是前一陣子，但只是決定釋放它。如果與HighLine和Readline一起使用，它支持自動完成。

當我寫它沒有任何文檔和測試/規格，但現在我做了一些。仍然不多，但開始應該沒問題。

所以寶石cli-console和 代碼是在GitHub上，這裏的usage example

Answer 5

看看cliqr紅寶石的寶石。它看起來正是你所需要的。以下是描述性自述文件的github鏈接：https://github.com/anshulverma/cliqr

它可以直接或在內置shell中執行命令。

下面是它的混帳回購測試用例：

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是很容易做這樣的事情一個很好的寶石。你有足夠的工具可以單獨使用或者使用完整的toolkit。您可以使用顏色，提示，執行shell本機，與屏幕交互，打印表格，進度條和其他許多有用的命令行元素，以及簡單的goop api。

特別是tty-prompt對詢問用戶輸入非常有用。

你提出的情況下，一個簡單的例子：

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