error.rb

# frozen_string_literal: true

module Dry
  class Files
    # Dry::Files base error
    #
    # @since 0.1.0
    # @api public
    class Error < StandardError
    end

    # Wraps low level I/O errors
    #
    # @see https://ruby-doc.org/core/Errno.html
    #
    # @since 0.1.0
    # @api public
    class IOError < Error
      # Instantiate a new `Dry::Files::IOError`
      #
      # @param cause [Exception] the low level exception
      #
      # @return [Dry::Files::IOError] the new error
      #
      # @since 0.1.0
      # @api private
      def initialize(cause)
        super(cause.message)
        @_cause = cause
      end

      # The original exception
      #
      # @see https://ruby-doc.org/core/Exception.html#method-i-cause
      #
      # @since 0.1.0
      # @api public
      def cause
        @_cause
      end
    end

    # File manipulations error.
    # Raised when the given `target` cannot be found in `path`.
    #
    # @since 0.1.0
    # @api public
    class MissingTargetError < Error
      # @param target [String,Regexp] the missing target
      # @param path [String,Pathname] the file
      #
      # @return [Dry::Files::MissingTargetError] the new error
      #
      # @since 0.1.0
      # @api private
      def initialize(target, path)
        super("cannot find `#{target}' in `#{path}'")

        @_target = target
        @_path = path
      end

      # The missing target
      #
      # @return [String, Regexp] the missing target
      #
      # @since 0.1.0
      # @api public
      def target
        @_target
      end

      # The missing target
      #
      # @return [String,Pathname] the file
      #
      # @since 0.1.0
      # @api public
      def path
        @_path
      end
    end

    # Unknown memory node
    #
    # Raised by the memory adapter (used for testing purposes)
    #
    # @since 0.1.0
    # @api public
    class UnknownMemoryNodeError < Error
      # Instantiate a new error
      #
      # @param node [String] node name
      #
      # @since 0.1.0
      # @api public
      def initialize(node)
        super("unknown memory node `#{node}'")
      end
    end

    # Not a memory file
    #
    # Raised by the memory adapter (used for testing purposes)
    #
    # @since 0.1.0
    # @api public
    class NotMemoryFileError < Error
      # Instantiate a new error
      #
      # @param path [String] path name
      #
      # @since 0.1.0
      # @api public
      def initialize(path)
        super("not a memory file `#{path}'")
      end
    end

    # Internal file system adapters can only take
    # strings as arguments to their `write` methods.
    # (The public API can take string or array of strings)
    #
    # @since x.x.x
    # @api private
    class CanOnlyWriteStringError < Error
      # Instantiate a new error
      #
      # @since x.x.x
      # @api private
      def initialize
        super("Can only write a String (use `join` or `to_s`)")
      end
    end
  end
end