Создание интерактивного консольного приложения ruby

Я хочу сделать интерактивное приложение, где пользователь запускает его и может выполнять различные задачи, набрав команды (какая-то оболочка)

пример:

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

Я искал, но не смог найти никаких рубиновых камней, которые я мог бы использовать специально для взаимодействия с консолью, поэтому я собираюсь сделать свой собственный...

Я посмотрел на Тор, но это не совсем так, как я хочу, может быть, я мог бы использовать его, но не уверен...

это может выглядеть как: 

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 для ввода/вывода, но любое другое предложение, что я могу использовать?

13
console interactive ruby

6 ответов

что вы хотите-это REPL – Read → Evaluate → Print Loop.

IRB, например, реализует REPL для языка Ruby.

вот очень простая реализация 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 соответствует началу строки и концу строки, соответственно.

18

вы также можете попробовать рипл. (из документации): Создание и запуск пользовательской оболочки так же просто, как:

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

существует полный список плагинов для ripl, а также список консольных приложений, использующих ripl на веб-сайте проектов.

5

ok, поэтому я сделал эту библиотеку для создания консольных приложений в ruby. На самом деле это было некоторое время назад, но только сейчас решил выпустить его. Он поддерживает автоматическое завершение при использовании с HighLine и Readline.

когда я писал это, не было никакой документации или тестов / спецификаций, но теперь я сделал некоторые. Еще не много, но для начала должно быть нормально.

Так командной строки-консоль и код находится в GitHub, вот пример использования

5

посмотри cliqr рубиновый камень. Похоже, это именно то, что тебе нужно. Вот ссылка github с описательным readme:https://github.com/anshulverma/cliqr

Он может выполнять команды непосредственно или через встроенный оболочки.

вот тестовый пример из его репозитория git:

    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
4

TTY - это действительно хорошая находка для легко делать такого рода вещи. У вас есть много инструментов, которые могут работать в одиночку или с полным набором инструментов. Вы можете использовать цвета, подсказки, выполнять аборигены оболочки, взаимодействовать с экраном, печатать таблицы, progressbars и многие другие полезные элементы командной строки с помощью простого api goop.

особенно 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
4
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, но это побеждает Тьюринг-полнота. Помощь может быть реализована с помощью команд, так как я не уверен, что мой подход сработает. Эти методы должны быть закодированная оборона. Я не помню, как использовать переменные класса: -/

2