Contents

module Byebug
  class HelpTestCase < TestCase
    include Columnize

    def setup
      @example = -> do
        byebug
      end

      super
    end

    def available_cmds
      @available_cmds ||= Command.commands.map(&:names).flatten.uniq.sort
    end

    %w(help h).each do |cmd_alias|
      define_method(:"test_#{cmd_alias}_shows_help_for_help_command_itself") do
        enter 'set width 50', cmd_alias
        debug_proc(@example)
        check_output_includes \
          'Type "help <command-name>" for help on a specific command',
          'Available commands:', columnize(available_cmds, 50)
      end
    end

    def test_help_with_specific_command_shows_help_for_it
      enter 'help break'
      debug_proc(@example)
      check_output_includes \
        "b[reak] file:line [if expr]\n" \
        "b[reak] class(.|#)method [if expr]\n\n" \
        "Set breakpoint to some position, (optionally) if expr == true\n"
    end

    def test_help_with_undefined_command_shows_an_error
      enter 'help foobar'
      debug_proc(@example)
      check_error_includes 'Undefined command: "foobar". Try "help"'
    end

    def test_help_with_command_and_subcommand_shows_subcommands_help
      enter 'help info breakpoints'
      debug_proc(@example)
      check_output_includes(/Status of user-settable breakpoints/)
    end

    def test_help_set_shows_help_for_set_command
      enter 'help set'
      debug_proc(@example)
      check_output_includes(/Modifies parts of byebug environment/)
    end

    def test_help_set_plus_a_setting_shows_help_for_that_setting
      enter 'help set width'
      debug_proc(@example)
      check_output_includes(/Number of characters per line in byebug's output/)
    end

    def test_help_show_shows_help_for_show_command
      enter 'help show'
      debug_proc(@example)
      check_output_includes(/Generic command for showing byebug settings/)
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
byebug-3.5.1	test/commands/help_test.rb
byebug-3.5.0	test/commands/help_test.rb
byebug-3.4.2	test/commands/help_test.rb
byebug-3.4.1	test/commands/help_test.rb
byebug-3.4.0	test/commands/help_test.rb
byebug-3.3.0	test/commands/help_test.rb