Merge pull request #10 from agorapulse/chore/rule-no-more

fixt is no longer a rule, updated license headers

build.gradle

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

docs/guide/guide.gradle

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

docs/guide/src/docs/asciidoc/index.adoc

@@ -32,8 +32,7 @@ test {
 }
 ----
 
-Fixt can be use directly or as a JUnit rule which will guarantee that the directories are created before
-the test run so adding new fixture files will be easier.
+Fixt guarantee that the directories are created before the test run so adding new fixture files will be easier.
 
 === Installation
 
@@ -67,7 +66,7 @@ dependencies {
 ----
 include::{root-dir}/libs/fixt/src/test/groovy/com/agorapulse/testing/fixt/FixtSpec.groovy[lines=18..-1]
 ----
-<1> Declare `Fixt` rule for the specification
+<1> Declare `Fixt` for the specification
 <2> Read the content of the file as stream
 <3> Read the content of the file as text
 <4> Create `Fixt` for the specific class (`ReferenceClass`)

gradle.properties

@@ -1,7 +1,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 #
-# Copyright 2018-2020 Agorapulse.
+# Copyright 2018-2021 Agorapulse.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

libs/fixt/fixt.gradle

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,6 @@ dependencies {
     // required by Groovy plugin
     compileOnly "org.codehaus.groovy:groovy:${groovyVersion}"
 
-    implementation "junit:junit:${junitVersion}"
     testImplementation "org.spockframework:spock-core:${spockVersion}"
     testImplementation 'com.github.stefanbirkner:system-rules:1.19.0'
 }

libs/fixt/src/main/groovy/com/agorapulse/testing/fixt/Fixt.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,21 +17,27 @@
  */
 package com.agorapulse.testing.fixt;
 
-import org.junit.rules.TestRule;
-import org.junit.runner.Description;
-import org.junit.runners.model.Statement;
-
-import java.io.*;
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.FileSystems;
 import java.nio.file.Files;
 import java.nio.file.StandardCopyOption;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Scanner;
 
 /**
  * Simple tool for managing test fixtures in folders which corresponds the package and the name of the specification class.
  */
-public class Fixt implements TestRule {
+public class Fixt {
 
     private static final String TEST_RESOURCES_FOLDER_PROPERTY_NAME = "testresourcesfolder";
     private static final String IGNORED_CHARACTERS = "[\\W_]";
@@ -42,21 +48,25 @@ public class Fixt implements TestRule {
      * @return new Fixt for the given object
      */
     public static Fixt create(Object object) {
-        return new Fixt(object instanceof Class ? (Class) object : object.getClass());
+        Fixt fixt = new Fixt(object instanceof Class ? (Class<?>) object : object.getClass());
+        fixt.mkdirs();
+        return fixt;
     }
 
     /**
      * Creates new Fixt for the given class.
      * @param clazz the given class
      * @return new Fixt for the given class
      */
-    public static Fixt create(Class clazz) {
-        return new Fixt(clazz);
+    public static Fixt create(Class<?> clazz) {
+        Fixt fixt = new Fixt(clazz);
+        fixt.mkdirs();
+        return fixt;
     }
 
-    private final Class clazz;
+    private final Class<?> clazz;
 
-    private Fixt(Class clazz) {
+    private Fixt(Class<?> clazz) {
         this.clazz = clazz;
     }
 
@@ -135,7 +145,7 @@ public InputStream readStream(String fileName) {
      * @param fileName the relative file name
      * @return the text stored in the given file
      */
-    public String readText(String fileName) throws IOException {
+    public String readText(String fileName) {
         InputStream stream = readStream(fileName);
         if (stream == null) {
             return null;
@@ -168,17 +178,6 @@ private String getFixtureLocation(String fileName) {
         return FileSystems.getDefault().getPath("", pathParams).toString();
     }
 
-    @Override
-    public Statement apply(Statement base, Description description) {
-        return new Statement() {
-            @Override
-            public void evaluate() throws Throwable {
-                mkdirs();
-                base.evaluate();
-            }
-        };
-    }
-
     private static String streamToText(InputStream stream) {
         try (Scanner scanner = new Scanner(stream, StandardCharsets.UTF_8.name()).useDelimiter("\\A")) {
             if (scanner.hasNext()) {

libs/fixt/src/test/groovy/FixtSpecNoPackageSpec.groovy

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
  */
 import com.agorapulse.testing.fixt.Fixt
 import org.junit.ClassRule
-import org.junit.Rule
 import org.junit.contrib.java.lang.system.EnvironmentVariables
 import org.junit.rules.TemporaryFolder
 import spock.lang.Shared
@@ -39,7 +38,6 @@ class FixtSpecNoPackageSpec extends Specification {
     @ClassRule @Shared
     EnvironmentVariables environmentVariables = new EnvironmentVariables()
 
-    @Rule
     Fixt fixt = Fixt.create(FixtSpecNoPackageSpec)
 
     void setupSpec() {

libs/fixt/src/test/groovy/com/agorapulse/testing/fixt/FixtSpec.groovy

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,7 +35,6 @@ class FixtSpec extends Specification {
     @Rule
     TemporaryFolder tmp = new TemporaryFolder()
 
-    @Rule
     Fixt fixt = Fixt.create(this)                                                       // <1>
 
     void 'reading existing files'() {

libs/fixt/src/test/groovy/com/agorapulse/testing/fixt/ReferenceClass.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/grails-job-testing-support/grails-job-testing-support.gradle

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 config {
     bintray {
         enabled = true

libs/grails-job-testing-support/src/main/groovy/com/agorapulse/testing/grails/job/JobExceptionListener.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/grails-job-testing-support/src/main/groovy/com/agorapulse/testing/grails/job/JobUnitTest.groovy

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/grails-job-testing-support/src/test/groovy/com/agorapulse/testing/grails/job/test/TestJob.groovy

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/grails-job-testing-support/src/test/groovy/com/agorapulse/testing/grails/job/test/TestJobSpec.groovy

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/office-unit.gradle

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 config {
     bintray {
         enabled = true

libs/office-unit/src/main/groovy/com/agorapulse/testing/officeunit/BinaryDifferenceCollector.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/main/groovy/com/agorapulse/testing/officeunit/DifferenceCollector.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/main/groovy/com/agorapulse/testing/officeunit/DocumentDifference.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/main/groovy/com/agorapulse/testing/officeunit/EmptyDifferenceCollector.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/main/groovy/com/agorapulse/testing/officeunit/OfficeUnit.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/main/groovy/com/agorapulse/testing/officeunit/OfficeUnitDifferenceCollector.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/main/groovy/com/agorapulse/testing/officeunit/SimpleDocumentDifference.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/main/groovy/com/agorapulse/testing/officeunit/XmlDifferenceCollector.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/main/groovy/com/agorapulse/testing/officeunit/XmlDocumentDifference.java

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/test/groovy/com/agorapulse/testing/officeunit/BinaryDifferenceCollectorSpec.groovy

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/test/groovy/com/agorapulse/testing/officeunit/EmptyDifferenceCollectorSpec.groovy

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

libs/office-unit/src/test/groovy/com/agorapulse/testing/officeunit/OfficeUnitDifferenceCollectorSpec.groovy

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: Apache-2.0
  *
- * Copyright 2018-2020 Agorapulse.
+ * Copyright 2018-2021 Agorapulse.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.