创建交互式 ruby​​ 控制台应用程序

Question

我想制作交互式应用程序，用户可以在其中启动它并可以通过键入命令（某种 shell）来完成各种任务

示例：

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

我搜索了但找不到任何可以专门用于控制台交互的 ruby​​ gem，所以我将自己制作...

我查看了Thor，但这并不是我想要的，也许我可以使用它，但不确定......

它可能看起来像：

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

你也可以试试ripl。 （来自文档）： 创建和启动自定义 shell 非常简单：

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

项目网站上有一个完整的 ripl 插件列表以及使用 ripl 的控制台应用程序列表。

Answer 3

好的，所以我制作了这个库，用于在 ruby​​ 中创建控制台应用程序。其实是很久以前的事了，只是刚刚决定发布。如果与 HighLine 和 Readline 一起使用，它确实支持自动完成。

当我写它时，没有任何文档或测试/规范，但现在我做了一些。仍然不多，但开始应该没问题。

所以宝石cli-console 和 代码在 GitHub，这里是usage example

Answer 4

TTY 是一个非常好的宝石，可以轻松完成此类事情。您有很多可以单独使用或与完整工具包一起使用的工具。您可以使用颜色、提示、执行 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

Answer 5

看看cliqr ruby​​ gem。它看起来正是您所需要的。这是带有描述性自述文件的 github 链接：https://github.com/anshulverma/cliqr

它可以直接执行命令，也可以在内置的 shell 中执行。

这是一个来自其 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

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

或者您可以使用 pry 命令，但这会破坏 图灵完备性。可以使用命令来实现帮助，就像我一样 不确定我的方法效果如何。这些方法需要 编码防御。我不记得如何使用类变量了：-/