org.eolang.lints.comments.AsciiOnly Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lints Show documentation

Style checkers (linters) for EO language

There is a newer version: 0.0.15

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016-2024 Objectionary.com
 *
 * 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 NON-INFRINGEMENT. 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 org.eolang.lints.comments;

import com.jcabi.xml.XML;
import java.io.IOException;
import java.util.Collection;
import java.util.LinkedList;
import org.eolang.lints.Defect;
import org.eolang.lints.Lint;
import org.eolang.lints.Severity;

/**
 * A comment must include only ASCII characters.
 *
 * @since 0.1.0
 */
public final class AsciiOnly implements Lint {

    @Override
    public Collection defects(final XML xmir) throws IOException {
        final Collection defects = new LinkedList<>();
        for (final XML comment : xmir.nodes("/program/comments/comment")) {
            if (comment.xpath("text()").get(0).chars().anyMatch(chr -> chr < 32 || chr > 127)) {
                defects.add(
                    new Defect.Default(
                        "ascii-only",
                        Severity.ERROR,
                        Integer.parseInt(comment.xpath("@line").get(0)),
                        "Comment must contain only ASCII printable characters: 0x20-0x7f"
                    )
                );
            }
        }
        return defects;
    }
}