add: стабильная версия

This commit is contained in:
2024-02-27 14:20:49 +03:00
commit 38dd350d59
19 changed files with 749 additions and 0 deletions

10
.editorconfig Normal file
View File

@@ -0,0 +1,10 @@
root = true
[*]
charset = utf-8
end_of_line = lf
indent_size = 4
indent_style = space
insert_final_newline = true
max_line_length = 120
tab_width = 4

3
.gitattributes vendored Normal file
View File

@@ -0,0 +1,3 @@
gradlew text eol=lf
gradlew.bat -text
gradle/wrapper/gradle-wrapper.properties text eol=lf

10
.gitignore vendored Normal file
View File

@@ -0,0 +1,10 @@
### Gradle ###
/.gradle/
/build/
### IntelliJ IDEA ###
/.idea/libraries/
/.idea/compiler.xml
/.idea/jarRepositories.xml
/.idea/misc.xml
/.idea/modules.xml

8
.idea/.gitignore generated vendored Normal file
View File

@@ -0,0 +1,8 @@
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml

16
.idea/gradle.xml generated Normal file
View File

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="GradleSettings">
<option name="linkedExternalProjectsSettings">
<GradleProjectSettings>
<option name="externalProjectPath" value="$PROJECT_DIR$" />
<option name="gradleHome" value="" />
<option name="modules">
<set>
<option value="$PROJECT_DIR$" />
</set>
</option>
</GradleProjectSettings>
</option>
</component>
</project>

6
.idea/vcs.xml generated Normal file
View File

@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>

21
README.MD Normal file
View File

@@ -0,0 +1,21 @@
# XmlElement
## Подключение к проекту
### Gradle
```groovy
implementation("ru.di9:xml-element:1.0")
```
## Сборка
```shell
gradle build
```
## Установка в локальный Maven
```shell
gradle publishToMavenLocal
```

41
build.gradle Normal file
View File

@@ -0,0 +1,41 @@
plugins {
id "java-library"
id "maven-publish"
}
wrapper {
gradleVersion = "8.6"
distributionType = Wrapper.DistributionType.BIN
}
group = "ru.di9"
version = "1.0"
repositories {
mavenLocal()
mavenCentral()
}
dependencies {
api("it.unimi.dsi:fastutil:8.5.12")
def junit5_version = "5.9.2"
testImplementation("org.junit.jupiter:junit-jupiter-api:${junit5_version}")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:${junit5_version}")
}
test {
useJUnitPlatform()
}
publishing {
publications {
mavenBinary(MavenPublication) {
groupId = project.group
artifactId = project.name
version = project.version
from components.java
}
}
}

BIN
gradle/wrapper/gradle-wrapper.jar vendored Normal file

Binary file not shown.

View File

@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

249
gradlew vendored Executable file
View File

@@ -0,0 +1,249 @@
#!/bin/sh
#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
echo "$*"
} >&2
die () {
echo
echo "$*"
echo
exit 1
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
if ! command -v java >/dev/null 2>&1
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Collect all arguments for the java command:
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"

92
gradlew.bat vendored Normal file
View File

@@ -0,0 +1,92 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if %ERRORLEVEL% equ 0 goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
:end
@rem End local scope for the variables with windows NT shell
if %ERRORLEVEL% equ 0 goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

2
settings.gradle Normal file
View File

@@ -0,0 +1,2 @@
rootProject.name = "xml-element"

View File

@@ -0,0 +1,7 @@
package ru.di9.xml;
interface StringUtils {
static boolean isEmpty(String string) {
return string == null || string.isBlank() || string.isEmpty();
}
}

View File

@@ -0,0 +1,87 @@
package ru.di9.xml;
import it.unimi.dsi.fastutil.ints.IntArrayList;
import it.unimi.dsi.fastutil.ints.IntList;
import org.w3c.dom.Element;
import java.util.*;
import java.util.stream.Collectors;
/**
* Враппер над {@link Element org.w3c.dom.Element}
*/
public class XmlElement implements Iterable<XmlElement> {
private final Element element;
public XmlElement(Element element) {
this.element = element;
}
public String getTagName() {
return element.getTagName();
}
public String getValue() {
return element.getTextContent();
}
public int getValueAsInt() {
var value = element.getTextContent();
return StringUtils.isEmpty(value) ? 0 : Integer.parseInt(value);
}
public float getValueAsFloat() {
var value = element.getTextContent();
return StringUtils.isEmpty(value) ? 0.0f : Float.parseFloat(value);
}
public boolean getValueAsBool() {
var value = element.getTextContent();
return !StringUtils.isEmpty(value) && Boolean.parseBoolean(value);
}
public List<String> getValueAsListString() {
var value = element.getTextContent();
return StringUtils.isEmpty(value) ? Collections.emptyList() : Arrays.asList(value.split(","));
}
public IntList getValueAsListInt() {
var value = element.getTextContent();
return StringUtils.isEmpty(value) ? IntList.of() : Arrays.stream(value.split(","))
.map(Integer::parseInt)
.collect(Collectors.toCollection(IntArrayList::new));
}
public boolean hasAttribute(String key) {
return element.hasAttribute(key);
}
public String getAttribute(String key) {
return element.getAttribute(key);
}
public int getAttributeAsInt(String key) {
var value = element.getAttribute(key);
return StringUtils.isEmpty(value) ? 0 : Integer.parseInt(value);
}
public boolean getAttributeAsBool(String key) {
var value = element.getAttribute(key);
return !StringUtils.isEmpty(value) && Boolean.parseBoolean(value);
}
@SuppressWarnings("NullableProblems")
@Override
public Iterator<XmlElement> iterator() {
return new XmlElementIterator(element.getChildNodes());
}
public Optional<XmlElement> getFirstElementByTagName(String tagName) {
var iterator = new XmlElementIterator(this.element.getElementsByTagName(tagName));
if (iterator.hasNext()) {
return Optional.of(iterator.next());
} else {
return Optional.empty();
}
}
}

View File

@@ -0,0 +1,42 @@
package ru.di9.xml;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import java.util.Iterator;
public class XmlElementIterator implements Iterator<XmlElement> {
private final NodeList nodeList;
private int index = 0;
private XmlElement next;
XmlElementIterator(NodeList nodeList) {
this.nodeList = nodeList;
}
@Override
public boolean hasNext() {
if (index >= nodeList.getLength()) {
next = null;
return false;
}
Node node;
do {
node = nodeList.item(index++);
} while (index < nodeList.getLength() && node.getNodeType() != Node.ELEMENT_NODE);
if (node.getNodeType() != Node.ELEMENT_NODE) {
next = null;
return false;
}
next = new XmlElement((org.w3c.dom.Element) node);
return true;
}
@Override
public XmlElement next() {
return next;
}
}

View File

@@ -0,0 +1,7 @@
package ru.di9.xml;
public class XmlException extends RuntimeException {
public XmlException(Throwable cause) {
super(cause);
}
}

View File

@@ -0,0 +1,69 @@
package ru.di9.xml;
import org.xml.sax.SAXException;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Optional;
public class XmlParser {
private final DocumentBuilder documentBuilder;
public XmlParser() {
try {
this.documentBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
} catch (ParserConfigurationException e) {
throw new XmlException(e);
}
}
public XmlElement parse(InputStream inputStream) {
if (inputStream == null) {
return null;
}
try {
return new XmlElement(documentBuilder.parse(inputStream).getDocumentElement());
} catch (SAXException | IOException e) {
throw new XmlException(e);
}
}
public XmlElement parse(File file) {
if (file == null) {
return null;
}
try {
return new XmlElement(documentBuilder.parse(file).getDocumentElement());
} catch (SAXException | IOException e) {
throw new XmlException(e);
}
}
public XmlElement parse(String xml) {
if (StringUtils.isEmpty(xml)) {
return null;
}
return parse(new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8)));
}
public Optional<XmlElement> parseOptional(InputStream inputStream) {
return Optional.ofNullable(parse(inputStream));
}
public Optional<XmlElement> parseOptional(File file) {
return Optional.ofNullable(parse(file));
}
public Optional<XmlElement> parseOptional(String xml) {
return Optional.ofNullable(parse(xml));
}
}

View File

@@ -0,0 +1,72 @@
package ru.di9.xml;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import java.util.Arrays;
import java.util.Iterator;
import static org.junit.jupiter.api.Assertions.*;
class XmlElementTest {
// language=XML
final String xml = """
<?xml version="1.0" encoding="UTF-8"?>
<root>
<!-- Комментарий -->
<node_str attr="VA-123">some value</node_str>
<node_int attr="24">99</node_int>
<node_bool attr="false">true</node_bool>
<empty/>
<node_str_commented>
<!-- comment -->
content
</node_str_commented>
</root>
""";
XmlElement rootElement;
@BeforeEach
void setup() {
rootElement = new XmlParser().parse(xml);
assertNotNull(rootElement);
assertEquals("root", rootElement.getTagName());
}
@Test
void testIterator() {
Iterator<XmlElement> iteratorElement = rootElement.iterator();
Iterator<String> iteratorTagName = Arrays.asList("node_str", "node_int", "node_bool", "empty").iterator();
Iterator<Object> iteratorAttribute = Arrays.asList(new Object[]{"VA-123", 24, false, null}).iterator();
while (iteratorElement.hasNext() && iteratorTagName.hasNext() && iteratorAttribute.hasNext()) {
var element = iteratorElement.next();
var tagName = iteratorTagName.next();
var attr = iteratorAttribute.next();
assertEquals(tagName, element.getTagName());
switch (element.getTagName()) {
case "node_str" -> assertEquals(attr, element.getAttribute("attr"));
case "node_int" -> assertEquals(attr, element.getAttributeAsInt("attr"));
case "node_bool" -> assertEquals(attr, element.getAttributeAsBool("attr"));
case "empty" -> {
assertTrue(StringUtils.isEmpty(element.getValue()));
assertFalse(element.hasAttribute("attr"));
assertTrue(StringUtils.isEmpty(element.getAttribute("attr")));
}
default -> fail("Unknown tag '%s'".formatted(element.getTagName()));
}
}
}
@Test
void testCommentedContent() {
var optElement = rootElement.getFirstElementByTagName("node_str_commented");
assertNotNull(optElement);
assertTrue(optElement.isPresent());
var element = optElement.get();
assertEquals("content", element.getValue().trim());
}
}