Contents

module Rbnotes
  ##
  # A base class for each error class of rbnotes.

  class Error < StandardError; end

  # :stopdoc:

  module ErrMsg
    MISSING_ARGUMENT  = "Missing argument: %s"
    MISSING_TIMESTAMP = "Missing timestamp: %s"
    NO_EDITOR         = "No editor is available: %s"
    PROGRAM_ABORT     = "External program was aborted: %s"
    UNKNOWN_KEYWORD   = "Unknown keyword: %s"
    INVALID_TIMESTAMP_PATTERN = "Invalid timestamp pattern: %s"
  end

  # :startdoc:

  ##
  # An error raised if an essential argument was missing.

  class MissingArgumentError < Error
    def initialize(args)
      super(ErrMsg::MISSING_ARGUMENT % args.to_s)
    end
  end

  ##
  # An error raised if a given timestamp was not found in the
  # repository.

  class MissingTimestampError < Error
    def initialize(timestamp)
      super(ErrMsg::MISSING_TIMESTAMP % timestamp)
    end
  end

  ##
  # An error raised if no external editor is available to edit a note,
  # even "nano" or "vi".

  class NoEditorError < Error
    def initialize(names)
      super(ErrMsg::NO_EDITOR % names.to_s)
    end
  end

  ##
  # An error raised when a external program such an editor was aborted
  # during its execution.

  class ProgramAbortError < Error
    def initialize(cmdline)
      super(ErrMsg::PROGRAM_ABORT % cmdline.join(" "))
    end
  end

  ##
  # An eeror raised when an unknown keyword was specified as a
  # timestamp string pattern.

  class UnknownKeywordError < Error
    def initialize(keyword)
      super(ErrMsg::UNKNOWN_KEYWORD % keyword)
    end
  end

  ##
  # An error raised when an invalid timestamp pattern was specified.

  class InvalidTimestampPatternError < Error
    def initialize(pattern)
      super(ErrMsg::INVALID_TIMESTAMP_PATTERN % pattern)
    end
  end

end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
rbnotes-0.4.10	lib/rbnotes/error.rb
rbnotes-0.4.9	lib/rbnotes/error.rb