Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(#909): move to class; read from resources #943

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/maven.test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,12 @@ jobs:
strategy:
matrix:
os: [ ubuntu-20.04, macos-14, windows-2022 ]
java: [ 8, 11, 21 ]
# @todo #909:60min Add 8 version of Java to matrix.
# For now we're getting an infinite qulice check on
# Java 8. To fix this you need to set Java 8 version
# in your Maven configuration, after that you need to
# run `mvn clean install -Pqulice`.
java: [ 11, 21 ]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
Expand Down
24 changes: 24 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,30 @@ SOFTWARE.
</testResource>
</testResources>
<plugins>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.3.1</version>
<executions>
<execution>
<id>copy-resources</id>
<phase>compile</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.outputDirectory}</outputDirectory>
<resources>
<resource>
<directory>${project.basedir}</directory>
<includes>
<include>LICENSE.txt</include>
</includes>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<executions>
Expand Down
69 changes: 69 additions & 0 deletions src/main/java/org/eolang/jeo/representation/License.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* 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.jeo.representation;

import org.cactoos.Scalar;
import org.cactoos.Text;
import org.cactoos.io.ResourceOf;
import org.cactoos.text.Sticky;
import org.cactoos.text.TextOf;

/**
* Representation of project license.
*
* @since 0.6.27
*/
public final class License implements Scalar<String> {

/**
* The name of file with license.
*/
private final Text content;

/**
* Ctor with default value.
*/
public License() {
this("LICENSE.txt");
}

/**
* Primary ctor.
*
* @param content The name of file with license.
*/
public License(final String content) {
this.content = new Sticky(new TextOf(new ResourceOf(content)));
}

@Override
public String value() {
return this.content.toString();
}

@Override
public String toString() {
return this.value();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Iterator;
import org.cactoos.Scalar;
import org.eolang.jeo.representation.License;
import org.xembly.Directive;
import org.xembly.Directives;

Expand All @@ -37,6 +39,11 @@
*/
public final class DirectivesProgram implements Iterable<Directive> {

/**
* The license of project.
*/
private static final Scalar<String> LICENSE = new License();

/**
* Program listing.
*/
Expand Down Expand Up @@ -117,48 +124,12 @@ public Iterator<Directive> iterator() {
.add("listing")
.set(this.listing)
.up()
.add("license").set(DirectivesProgram.license()).up()
.add("license").set(DirectivesProgram.LICENSE).up()
.append(this.metas)
.attr("ms", this.milliseconds)
.add("objects");
directives.append(this.klass);
directives.up();
return directives.iterator();
}

/**
* Text of the license.
* @return License text.
* @todo #850 Retrieve License From The File.
* We use license as a file in the project root.
* See LICENSE.txt file.
* It's better to read this file and return its content.
* Otherwise, we have to maintain the license in two places.
*/
private static String license() {
return String.join(
"\n",
"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."
);
}
}
50 changes: 50 additions & 0 deletions src/test/java/org/eolang/jeo/representation/LicenseTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* 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.jeo.representation;

import org.cactoos.text.FormattedText;
import org.hamcrest.MatcherAssert;
import org.hamcrest.Matchers;
import org.junit.jupiter.api.Test;

/**
* Test suite for {@link License}.
*
* @since 0.6.27
*/
final class LicenseTest {

@Test
void readsLicenseFileCorrectly() throws Exception {
final String name = "LICENSE.txt";
MatcherAssert.assertThat(
new FormattedText(
"Unexpected file:'%s' content",
name
).asString(),
new License(name).value(),
Matchers.containsString("MIT")
);
}
}
Loading