Support helper method extension API

Abierto
#588 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 2 días

@st0012 ya está trabajando en esto.

Desde el 2/7/2023.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

enhancement

In #513, I proposed extension API for commands, but it doesn't cover all the extension needs. For example, Rails defines controller and helpers methods (and these methods too) for its Rails console, which are meant to be used as methods and be chained with other method calls. So they should not be treated as commands.

However, helper methods do share some common needs with commands, like:

  • Feature discovery, e.g. can be listed in the result of show_cmds (or help in the future)
  • Proper registration API and documentation (instead of manually including a module)

So I think we should provide (perhaps similar) extension for helper methods to fulfill such needs.

Details

Using Rails' controller helper as example:

module IRB
  module Helper
    class Controller < Helper::Base
      category "Rails"
      description "Gets a new instance of a controller object."

      def execute
        @controller ||= ApplicationController.new
      end
    end
  end
end

IRB::ExtendedCommandBundle.add_helper(:controller, IRB::Helper::Controller)
Lenguaje dominante
Ruby
Estrellas
477
Forks
165
Merge medio
1 d 19 h
PR fusionados (30 d)
5

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ruby/irb

Todos los issues de ruby/irb

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.