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

issue/14: Add license header and copyright note to all source files #15

Merged
merged 1 commit into from
Nov 27, 2023
Merged
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
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.build.ossrh;

import org.gradle.api.Plugin;
Expand All @@ -12,6 +28,8 @@

/**
* Internal plugin that applies the necessary configuration to publish to SonaType OSSRH (OSS Repository Hosting).
*
* @author Florian McKee
*/
public class OssrhPublishPlugin implements Plugin<Project> {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.build.ossrh;

/**
* Extension that allows for customization of the {@link OssrhPublishPlugin}.
*
* @author Florian McKee
*/
public class OssrhPublishPluginExtension {

// e.g., Skippy Core
Expand Down
18 changes: 18 additions & 0 deletions skippy-core/src/main/java/io/skippy/core/AnalyzedFile.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

import org.apache.logging.log4j.LogManager;
Expand All @@ -17,6 +33,8 @@
* <li>MD5 hash of source file</li>
* <li>MD5 hash of class file</li>
* </ul>
*
* @author Florian McKee
*/
class AnalyzedFile {

Expand Down
18 changes: 18 additions & 0 deletions skippy-core/src/main/java/io/skippy/core/AnalyzedFileList.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

import org.apache.logging.log4j.LogManager;
Expand All @@ -13,6 +29,8 @@

/**
* A list of {@link AnalyzedFile}s with a couple of utility methods that operates on this list.
*
* @author Florian McKee
*/
class AnalyzedFileList {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,25 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

/**
* Allows for more meaningful typing, e.g., {@code Map<FullyQualifiedClassName, List<FullyQualifiedClassName>>}
* instead of {@code Map<String, List<String>>}.
*
* @author Florian McKee
*/
record FullyQualifiedClassName(String fqn) {}
18 changes: 18 additions & 0 deletions skippy-core/src/main/java/io/skippy/core/SkippyAnalysis.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

import org.apache.logging.log4j.LogManager;
Expand All @@ -11,6 +27,8 @@
* <li>a list of {@link AnalyzedFile}s</li>
* <li>a {@link TestImpactAnalysis} for all tests that use the Skippy extension</li>
* </ul>
*
* @author Florian McKee
*/
public class SkippyAnalysis {

Expand Down
18 changes: 18 additions & 0 deletions skippy-core/src/main/java/io/skippy/core/SkippyConstants.java
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

import java.nio.file.Path;

/**
* Comment to make the JavaDoc task happy.
*
* @author Florian McKee
*/
class SkippyConstants {

Expand Down
18 changes: 18 additions & 0 deletions skippy-core/src/main/java/io/skippy/core/TestImpactAnalysis.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

import org.apache.logging.log4j.LogManager;
Expand All @@ -17,6 +33,8 @@

/**
* A mapping between tests and the classes they cover.
*
* @author Florian McKee
*/
class TestImpactAnalysis {

Expand Down
21 changes: 21 additions & 0 deletions skippy-core/src/test/java/io/skippy/core/AnalyzedFileListTest.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

import org.junit.jupiter.api.Test;
Expand All @@ -8,6 +24,11 @@
import static java.util.Arrays.asList;
import static org.junit.jupiter.api.Assertions.assertEquals;

/**
* Tests for {@link AnalyzedFileList}.
*
* @author Florian McKee
*/
public class AnalyzedFileListTest {

@Test
Expand Down
21 changes: 21 additions & 0 deletions skippy-core/src/test/java/io/skippy/core/AnalyzedFileTest.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

import org.junit.jupiter.api.Test;
Expand All @@ -7,6 +23,11 @@

import static org.junit.jupiter.api.Assertions.assertEquals;

/**
* Tests for {@link AnalyzedFile}.
*
* @author Florian McKee
*/
public class AnalyzedFileTest {

@Test
Expand Down
21 changes: 21 additions & 0 deletions skippy-core/src/test/java/io/skippy/core/SkippyAnalysisTest.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

import org.junit.jupiter.api.Test;
Expand All @@ -11,6 +27,11 @@
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

/**
* Tests for {@link SkippyAnalysis}.
*
* @author Florian McKee
*/
public class SkippyAnalysisTest {

@Test
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.core;

import org.junit.jupiter.api.Test;
Expand All @@ -8,6 +24,11 @@
import static java.util.Arrays.asList;
import static org.junit.jupiter.api.Assertions.assertEquals;

/**
* Tests for {@link TestImpactAnalysis}.
*
* @author Florian McKee
*/
public class TestImpactAnalysisTest {

@Test
Expand Down
18 changes: 18 additions & 0 deletions skippy-gradle/src/main/java/io/skippy/gradle/SkippyPlugin.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2023 the original author or 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.
*/

package io.skippy.gradle;

import io.skippy.gradle.core.AnalyzedFile;
Expand All @@ -21,6 +37,8 @@

/**
* Adds the {@code skippyClean} and {@code skippyAnalyze} tasks to a project.
*
* @author Florian McKee
*/
public class SkippyPlugin implements org.gradle.api.Plugin<Project> {

Expand Down
Loading