summaryrefslogtreecommitdiff
path: root/lib/bundler/friendly_errors.rb
blob: 5721807a9006e10253e037637194df3405d6092d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# encoding: utf-8
require "cgi"
require "bundler/vendored_thor"

module Bundler
  def self.with_friendly_errors
    yield
  rescue Bundler::YamlSyntaxError => e
    Bundler.ui.error e.message
    Bundler.ui.trace e.orig_exception
    exit e.status_code
  rescue Bundler::Dsl::DSLError => e
    Bundler.ui.error e.message
    exit e.status_code
  rescue Bundler::GemRequireError => e
    Bundler.ui.error e.message
    Bundler.ui.trace e.orig_exception, nil, true
    exit e.status_code
  rescue Bundler::BundlerError => e
    Bundler.ui.error e.message, :wrap => true
    Bundler.ui.trace e
    exit e.status_code
  rescue Thor::AmbiguousTaskError => e
    Bundler.ui.error e.message
    exit 15
  rescue Thor::UndefinedTaskError => e
    Bundler.ui.error e.message
    exit 15
  rescue Thor::Error => e
    Bundler.ui.error e.message
    exit 1
  rescue LoadError => e
    raise e unless e.message =~ /cannot load such file -- openssl|openssl.so|libcrypto.so/
    Bundler.ui.error "\nCould not load OpenSSL."
    Bundler.ui.warn <<-WARN, :wrap => true
      You must recompile Ruby with OpenSSL support or change the sources in your \
      Gemfile from 'https' to 'http'. Instructions for compiling with OpenSSL \
      using RVM are available at http://rvm.io/packages/openssl.
    WARN
    Bundler.ui.trace e
    exit 1
  rescue Interrupt => e
    Bundler.ui.error "\nQuitting..."
    Bundler.ui.trace e
    exit 1
  rescue SystemExit => e
    exit e.status
  rescue Exception => e
    request_issue_report_for(e)
    exit 1
  end

  def self.request_issue_report_for(e)
    Bundler.ui.info <<-EOS.gsub(/^ {6}/, "")
      --- ERROR REPORT TEMPLATE -------------------------------------------------------
      - What did you do?

        I ran the command `#{$PROGRAM_NAME} #{ARGV.join(" ")}`

      - What did you expect to happen?

        I expected Bundler to...

      - What happened instead?

        Instead, what actually happened was...


      Error details

          #{e.class}: #{e.message}
            #{e.backtrace.join("\n            ")}

      #{Bundler::Env.new.report(:print_gemfile => false, :print_gemspecs => false).gsub(/\n/, "\n      ").strip}
      --- TEMPLATE END ----------------------------------------------------------------

    EOS

    Bundler.ui.error "Unfortunately, an unexpected error occurred, and Bundler cannot continue."

    Bundler.ui.warn <<-EOS.gsub(/^ {6}/, "")

      First, try this link to see if there are any existing issue reports for this error:
      #{issues_url(e)}

      If there aren't any reports for this error yet, please create copy and paste the report template above into a new issue. Don't forget to anonymize any private data! The new issue form is located at:
      https://github.com/bundler/bundler/issues/new
    EOS
  end

  def self.issues_url(exception)
    "https://github.com/bundler/bundler/search?q=" \
    "#{CGI.escape(exception.message.lines.first.chomp)}&type=Issues"
  end
end