001/*
002 * Copyright (C) 2022 - 2024, the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *    http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package io.github.ascopes.jct.assertions;
017
018import static org.assertj.core.api.Assertions.assertThat;
019
020import io.github.ascopes.jct.filemanagers.PathFileObject;
021import org.apiguardian.api.API;
022import org.apiguardian.api.API.Status;
023import org.assertj.core.api.AbstractPathAssert;
024import org.jspecify.annotations.Nullable;
025
026/**
027 * Assertions for {@link PathFileObject Path file objects}.
028 *
029 * @author Ashley Scopes
030 * @since 0.0.1
031 */
032@API(since = "0.0.1", status = Status.STABLE)
033public final class PathFileObjectAssert
034    extends AbstractJavaFileObjectAssert<PathFileObjectAssert, PathFileObject> {
035
036  /**
037   * Create a new instance of this assertion object.
038   *
039   * @param actual the path file object to assert upon.
040   */
041  public PathFileObjectAssert(@Nullable PathFileObject actual) {
042    super(actual, PathFileObjectAssert.class);
043  }
044
045  /**
046   * Perform an assertion on the file object's relative path.
047   *
048   * <p>The path is relative to the base directory holding all the
049   * sources relative to their package names.
050   *
051   * @return the assertions for the path.
052   * @throws AssertionError if the file object is null.
053   */
054  public AbstractPathAssert<?> relativePath() {
055    isNotNull();
056
057    return assertThat(actual.getRelativePath());
058  }
059
060  /**
061   * Perform an assertion on the file object's absolute path.
062   *
063   * <p>You generally should prefer using {@link #relativePath}.
064   *
065   * @return the assertions for the path.
066   * @throws AssertionError if the file object is null.
067   */
068  public AbstractPathAssert<?> absolutePath() {
069    isNotNull();
070
071    return assertThat(actual.getAbsolutePath());
072  }
073}