module MaRuKu::Errors

Constants

FRAME_WIDTH

Public Instance Methods

maruku_error(s, src=nil, con=nil, recover=nil) click to toggle source

Properly handles a formatting error. All such errors go through this method.

The behavior depends on {MaRuKu::Globals `MaRuKu::Globals`}. If this is `:warning`, this prints the error to stderr (or `@error_stream` if it's defined) and tries to continue. If `:on_error` is `:ignore`, this doesn't print anything and tries to continue. If it's `:raise`, this raises a {MaRuKu::Exception}.

By default, `:on_error` is set to `:warning`.

@overload def #maruku_error(s, src = nil, con = nil) @param s [String] The text of the error @param src [#describe, nil] The source of the error @param con [#describe, nil] The context of the error @param recover [String, nil] Recovery text @raise [MaRuKu::Exception] If `:on_error` is set to `:raise`

# File lib/maruku/errors.rb, line 24
def maruku_error(s, src=nil, con=nil, recover=nil)
  policy = get_setting(:on_error)

  case policy
  when :ignore
  when :raise
    raise_error create_frame(describe_error(s, src, con, recover))
  when :warning
    tell_user create_frame(describe_error(s, src, con, recover))
  else
    raise "Unknown on_error policy: #{policy.inspect}"
  end
end
maruku_recover(s, src=nil, con=nil, recover=nil) click to toggle source

This is like {#maruku_error} but will never raise.

# File lib/maruku/errors.rb, line 39
def maruku_recover(s, src=nil, con=nil, recover=nil)
  policy = get_setting(:on_error)

  case policy
  when :ignore
  when :raise, :warning
    tell_user create_frame(describe_error(s, src, con, recover))
  else
    raise "Unknown on_error policy: #{policy.inspect}"
  end
end
raise_error(s) click to toggle source
# File lib/maruku/errors.rb, line 51
def raise_error(s)
  raise MaRuKu::Exception, s, caller
end
tell_user(s) click to toggle source
# File lib/maruku/errors.rb, line 55
def tell_user(s)
  (self.attributes[:error_stream] || $stderr) << s << "\n"
end

Private Instance Methods

create_frame(s) click to toggle source
# File lib/maruku/errors.rb, line 61
    def create_frame(s)
      "\n" + <<FRAME
 #{"_" * FRAME_WIDTH}
| Maruku tells you:
+#{"-" * FRAME_WIDTH}
#{s.gsub(/^/, '| ').rstrip}
+#{"-" * FRAME_WIDTH}
#{caller[1...5].join("\n").gsub(/^/, '!')}
\\#{"_" * FRAME_WIDTH}
FRAME
    end
describe_error(s, src=nil, con=nil, recover=nil) click to toggle source
# File lib/maruku/errors.rb, line 73
def describe_error(s, src=nil, con=nil, recover=nil)
  s += "\n#{src.describe}\n" if src
  s += "\n#{con.describe}\n" if con
  s += "\nRecovering: #{recover}\n" if recover
  s
end