com.github.lombrozo.testnames.javaparser.JavaParserTestClass Maven / Gradle / Ivy

Go to download
/*
 * MIT License
 *
 * Copyright (c) 2022-2024 Volodya Lombrozo
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.github.lombrozo.testnames.javaparser;

import com.github.javaparser.ParseProblemException;
import com.github.lombrozo.testnames.TestCase;
import com.github.lombrozo.testnames.TestClass;
import com.github.lombrozo.testnames.TestClassCharacteristics;
import java.io.InputStream;
import java.io.UncheckedIOException;
import java.nio.file.Path;
import java.util.Collection;
import java.util.Collections;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.cactoos.scalar.Sticky;
import org.cactoos.scalar.Unchecked;

/**
 * Test cases code.
 *
 * @since 0.1.0
 */
public final class JavaParserTestClass implements TestClass {

    /**
     * Path to java class.
     */
    @SuppressWarnings("PMD.AvoidFieldNameMatchingMethodName")
    private final Path path;

    /**
     * Parsed Java class.
     */
    private final Unchecked unit;

    /**
     * Rules excluded for entire project.
     */
    private final Collection exclusions;

    /**
     * Ctor.
     *
     * @param klass Path to the class
     */
    JavaParserTestClass(final Path klass) {
        this(klass, JavaParserTestClass.parse(klass));
    }

    /**
     * Ctor.
     *
     * @param klass Path to the class
     * @param exclusions Rules excluded for entire project.
     */
    JavaParserTestClass(final Path klass, final Collection exclusions) {
        this(klass, JavaParserTestClass.parse(klass), exclusions);
    }

    /**
     * Ctor.
     *
     * @param klass Path to the class
     * @param stream Parsed Java class
     */
    JavaParserTestClass(final Path klass, final InputStream stream) {
        this(klass, JavaParserTestClass.parse(stream));
    }

    /**
     * Ctor.
     *
     * @param klass Path to the class
     * @param parsed Parsed class.
     */
    private JavaParserTestClass(final Path klass, final Sticky parsed) {
        this(klass, new Unchecked<>(parsed), Collections.emptySet());
    }

    /**
     * Ctor.
     *
     * @param klass Path to the class
     * @param stream Parsed Java class
     * @param exclusions Rules excluded for entire project.
     */
    JavaParserTestClass(
        final Path klass,
        final InputStream stream,
        final Collection exclusions
    ) {
        this(klass, JavaParserTestClass.parse(stream), exclusions);
    }

    /**
     * Ctor.
     *
     * @param klass Path to the class
     * @param parsed Parsed class.
     * @param exclusions Rules excluded for entire project.
     */
    JavaParserTestClass(
        final Path klass,
        final Sticky parsed,
        final Collection exclusions
    ) {
        this(klass, new Unchecked<>(parsed), exclusions);
    }

    /**
     * Constructor.
     * @param path Path to the class
     * @param unit Parsed class.
     * @param exclusions Rules excluded for entire project.
     */
    JavaParserTestClass(
        final Path path,
        final Unchecked unit,
        final Collection exclusions
    ) {
        this.path = path;
        this.unit = unit;
        this.exclusions = exclusions;
    }

    @Override
    public String name() {
        return this.path.getFileName().toString();
    }

    @Override
    public Collection all() {
        try {
            return this.unit.value()
                .methods(new TestsOnly())
                .map(method -> new JavaParserTestCase(method, this))
                .collect(Collectors.toSet());
        } catch (final UncheckedIOException | ParseProblemException ex) {
            throw new IllegalStateException(
                String.format("Failed to parse Java class by path %s", this.path),
                ex
            );
        }
    }

    @Override
    public Path path() {
        return this.path;
    }

    @Override
    public Collection suppressed() {
        return Stream.concat(
            this.unit.value().annotations().suppressed(),
            this.exclusions.stream()
        ).collect(Collectors.toSet());
    }

    @Override
    public TestClassCharacteristics characteristics() {
        return new JavaParserCharacteristics(this.unit.value());
    }

    /**
     * Parse Java class.
     * @param path Path to the class
     * @return Parsed class.
     */
    private static Sticky parse(final Path path) {
        return new Sticky<>(() -> new JavaParserClass(path));
    }

    /**
     * Parse Java class.
     * @param stream Raw class.
     * @return Parsed class.
     */
    private static Sticky parse(final InputStream stream) {
        return new Sticky<>(() -> new JavaParserClass(stream));
    }
}