irb icon indicating copy to clipboard operation
irb copied to clipboard

Support helper method extension API

Open st0012 opened this issue 2 years ago • 0 comments

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)

st0012 avatar May 21 '23 14:05 st0012