Module: Debrew Private

Extended by:
Mutex_m, Predicable
Defined in:
debrew.rb

Overview

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Helper module for debugging formulae.

Defined Under Namespace

Modules: Formula Classes: Menu

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Predicable

attr_predicate

Class Attribute Details

.debugged_exceptionsObject (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



82
83
84
# File 'debrew.rb', line 82

def debugged_exceptions
  @debugged_exceptions
end

Class Method Details

.debrewObject

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'debrew.rb', line 85

def self.debrew
  @active = true
  Ignorable.hook_raise

  begin
    yield
  rescue SystemExit
    raise
  rescue Exception => e # rubocop:disable Lint/RescueException
    e.ignore if debug(e) == :ignore # execution jumps back to where the exception was thrown
  ensure
    Ignorable.unhook_raise
    @active = false
  end
end

.debug(e) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'debrew.rb', line 101

def self.debug(e)
  raise(e) if !active? || !debugged_exceptions.add?(e) || !try_lock

  begin
    puts e.backtrace.first.to_s
    puts Formatter.error(e, label: e.class.name)

    loop do
      Menu.choose do |menu|
        menu.prompt = "Choose an action: "

        menu.choice(:raise) { raise(e) }
        menu.choice(:ignore) { return :ignore } if e.is_a?(Ignorable::ExceptionMixin)
        menu.choice(:backtrace) { puts e.backtrace }

        if e.is_a?(Ignorable::ExceptionMixin)
          menu.choice(:irb) do
            puts "When you exit this IRB session, execution will continue."
            set_trace_func proc { |event, _, _, id, binding, klass|
              if klass == Object && id == :raise && event == "return"
                set_trace_func(nil)
                synchronize { IRB.start_within(binding) }
              end
            }

            return :ignore
          end
        end

        menu.choice(:shell) do
          puts "When you exit this shell, you will return to the menu."
          interactive_shell
        end
      end
    end
  ensure
    unlock
  end
end