#16: Rename Envelopes considering their types

dgroup · web-flow · commit 07c80c414d94 · 2019-02-03T08:16:58.000Z
diff --git a/src/main/java/io/github/dgroup/term4j/arg/Alt.java b/src/main/java/io/github/dgroup/term4j/arg/Alt.java
@@ -32,7 +32,7 @@
  * @param <X> Type of command-line argument.
  * @since 0.1.0
  */
-public final class Alt<X> extends Envelope<X> {
+public final class Alt<X> extends ArgEnvelope<X> {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/arg/ArgEnvelope.java b/src/main/java/io/github/dgroup/term4j/arg/ArgEnvelope.java
@@ -41,7 +41,7 @@
  * @since 0.1.0
  * @checkstyle ClassDataAbstractionCouplingCheck (200 lines)
  */
-public class Envelope<X> implements Arg<X> {
+public class ArgEnvelope<X> implements Arg<X> {
 
     /**
      * Origin.
@@ -54,7 +54,7 @@ public class Envelope<X> implements Arg<X> {
      * @param args All command-line arguments.
      * @param fnc To convert string argument value to instance of {@code <X>}.
      */
-    public Envelope(
+    public ArgEnvelope(
         final String label, final List<String> args, final Func<String, X> fnc
     ) {
         this(
@@ -71,7 +71,7 @@ public Envelope(
      * @param err Error message in case if argument is absent/missing.
      * @checkstyle ParameterNumberCheck (5 lines)
      */
-    public Envelope(
+    public ArgEnvelope(
         final String label, final List<String> args, final Func<String, X> fnc,
         final Text err
     ) {
@@ -106,7 +106,7 @@ public boolean specifiedByUser() {
      * Ctor.
      * @param origin Origin.
      */
-    public Envelope(final Arg<X> origin) {
+    public ArgEnvelope(final Arg<X> origin) {
         this.origin = new StickyScalar<>(() -> origin);
     }
 
diff --git a/src/main/java/io/github/dgroup/term4j/arg/EnvOf.java b/src/main/java/io/github/dgroup/term4j/arg/EnvOf.java
@@ -31,7 +31,7 @@
  *
  * @since 0.1.0
  */
-public final class EnvOf extends Envelope<String> {
+public final class EnvOf extends ArgEnvelope<String> {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/arg/FileOf.java b/src/main/java/io/github/dgroup/term4j/arg/FileOf.java
@@ -33,7 +33,7 @@
  *
  * @since 0.1.0
  */
-public final class FileOf extends Envelope<File> {
+public final class FileOf extends ArgEnvelope<File> {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/arg/NumberOf.java b/src/main/java/io/github/dgroup/term4j/arg/NumberOf.java
@@ -30,7 +30,7 @@
  *
  * @since 0.1.0
  */
-public final class NumberOf extends Envelope<Number> {
+public final class NumberOf extends ArgEnvelope<Number> {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/arg/PathOf.java b/src/main/java/io/github/dgroup/term4j/arg/PathOf.java
@@ -33,7 +33,7 @@
  *
  * @since 0.1.0
  */
-public final class PathOf extends Envelope<Path> {
+public final class PathOf extends ArgEnvelope<Path> {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/arg/PropOf.java b/src/main/java/io/github/dgroup/term4j/arg/PropOf.java
@@ -31,7 +31,7 @@
  *
  * @since 0.1.0
  */
-public final class PropOf extends Envelope<String> {
+public final class PropOf extends ArgEnvelope<String> {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/arg/StringOf.java b/src/main/java/io/github/dgroup/term4j/arg/StringOf.java
@@ -30,7 +30,7 @@
  *
  * @since 0.1.0
  */
-public final class StringOf extends Envelope<String> {
+public final class StringOf extends ArgEnvelope<String> {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/arg/TextOf.java b/src/main/java/io/github/dgroup/term4j/arg/TextOf.java
@@ -31,7 +31,7 @@
  *
  * @since 0.1.0
  */
-public final class TextOf extends Envelope<Text> {
+public final class TextOf extends ArgEnvelope<Text> {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/arg/scalar/Envs.java b/src/main/java/io/github/dgroup/term4j/arg/scalar/Envs.java
@@ -33,7 +33,6 @@
  * The system environment.
  *
  * @since 0.1.0
- * @todo #/DEV Rename Envelopes considering their types.
  */
 public final class Envs implements Scalar<Properties> {
 
diff --git a/src/main/java/io/github/dgroup/term4j/highlighted/Black.java b/src/main/java/io/github/dgroup/term4j/highlighted/Black.java
@@ -32,7 +32,7 @@
  *
  * @since 0.1.0
  */
-public final class Black extends Envelope {
+public final class Black extends HighlightedText {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/highlighted/Blue.java b/src/main/java/io/github/dgroup/term4j/highlighted/Blue.java
@@ -32,7 +32,7 @@
  *
  * @since 0.1.0
  */
-public final class Blue extends Envelope {
+public final class Blue extends HighlightedText {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/highlighted/Bold.java b/src/main/java/io/github/dgroup/term4j/highlighted/Bold.java
@@ -32,7 +32,7 @@
  *
  * @since 0.1.0
  */
-public final class Bold extends Envelope {
+public final class Bold extends HighlightedText {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/highlighted/Green.java b/src/main/java/io/github/dgroup/term4j/highlighted/Green.java
@@ -32,7 +32,7 @@
  *
  * @since 0.1.0
  */
-public final class Green extends Envelope {
+public final class Green extends HighlightedText {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/highlighted/HighlightedText.java b/src/main/java/io/github/dgroup/term4j/highlighted/HighlightedText.java
@@ -33,11 +33,14 @@
 import org.fusesource.jansi.Ansi.Color;
 
 /**
- * The envelope for {@link Highlighted}.
+ * The highlighted text.
+ *
+ * @see Highlighted
+ * @see Text
  *
  * @since 0.1.0
  */
-public class Envelope implements Highlighted, Comparable<Text> {
+public class HighlightedText implements Highlighted, Comparable<Text> {
 
     /**
      * Origin.
@@ -49,7 +52,7 @@ public class Envelope implements Highlighted, Comparable<Text> {
      * @param msg Message which should be highlighted.
      * @param color Color which should be used for highlighting.
      */
-    public Envelope(final Object msg, final Color color) {
+    public HighlightedText(final Object msg, final Color color) {
         this(msg, ansi -> ansi.fgBright(color));
     }
 
@@ -58,15 +61,15 @@ public Envelope(final Object msg, final Color color) {
      * @param msg Message which should be highlighted.
      * @param fnc The function to
      */
-    public Envelope(final Object msg, final Func<Ansi, Ansi> fnc) {
+    public HighlightedText(final Object msg, final Func<Ansi, Ansi> fnc) {
         this(() -> () -> fnc.apply(Ansi.ansi()).a(msg).reset().toString());
     }
 
     /**
      * Ctor.
      * @param msg The original message.
      */
-    public Envelope(final Scalar<Text> msg) {
+    public HighlightedText(final Scalar<Text> msg) {
         this.msg = msg;
     }
 
diff --git a/src/main/java/io/github/dgroup/term4j/highlighted/Magenta.java b/src/main/java/io/github/dgroup/term4j/highlighted/Magenta.java
@@ -32,7 +32,7 @@
  *
  * @since 0.1.0
  */
-public final class Magenta extends Envelope {
+public final class Magenta extends HighlightedText {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/highlighted/Red.java b/src/main/java/io/github/dgroup/term4j/highlighted/Red.java
@@ -32,7 +32,7 @@
  *
  * @since 0.1.0
  */
-public final class Red extends Envelope {
+public final class Red extends HighlightedText {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/highlighted/White.java b/src/main/java/io/github/dgroup/term4j/highlighted/White.java
@@ -32,7 +32,7 @@
  *
  * @since 0.1.0
  */
-public final class White extends Envelope {
+public final class White extends HighlightedText {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/highlighted/Yellow.java b/src/main/java/io/github/dgroup/term4j/highlighted/Yellow.java
@@ -32,7 +32,7 @@
  *
  * @since 0.1.0
  */
-public final class Yellow extends Envelope {
+public final class Yellow extends HighlightedText {
 
     /**
      * Ctor.
diff --git a/src/main/java/io/github/dgroup/term4j/std/Inmem.java b/src/main/java/io/github/dgroup/term4j/std/Inmem.java
@@ -34,7 +34,7 @@
  *
  * @since 0.1.0
  */
-public final class Inmem extends Envelope {
+public final class Inmem extends StdEnvelope {
 
     /**
      * The lines printed to the STD output.
diff --git a/src/main/java/io/github/dgroup/term4j/std/StdEnvelope.java b/src/main/java/io/github/dgroup/term4j/std/StdEnvelope.java
@@ -35,7 +35,7 @@
  *
  * @since 0.1.0
  */
-public class Envelope implements Std {
+public class StdEnvelope implements Std {
 
     /**
      * The procedure to print the text to the standart output.
@@ -46,7 +46,7 @@ public class Envelope implements Std {
      * Ctor.
      * @param prc The procedure to print the text to the standart output.
      */
-    public Envelope(final Proc<Iterable<Text>> prc) {
+    public StdEnvelope(final Proc<Iterable<Text>> prc) {
         this.prc = prc;
     }
 
diff --git a/src/main/java/io/github/dgroup/term4j/std/StdOf.java b/src/main/java/io/github/dgroup/term4j/std/StdOf.java
@@ -34,7 +34,7 @@
  *
  * @since 0.1.0
  */
-public final class StdOf extends Envelope {
+public final class StdOf extends StdEnvelope {
 
     /**
      * The indent from the left side for more fancy/readable messages.
diff --git a/src/test/java/io/github/dgroup/term4j/highlighted/EnvelopeTest.java b/src/test/java/io/github/dgroup/term4j/highlighted/EnvelopeTest.java
@@ -30,7 +30,7 @@
 import org.llorllale.cactoos.matchers.Assertion;
 
 /**
- * Test case for {@link Envelope} which is {@link Highlighted}.
+ * Test case for {@link HighlightedText} which is {@link Highlighted}.
  *
  * @since 0.1.0
  * @checkstyle JavadocMethodCheck (500 lines)
diff --git a/src/test/java/io/github/dgroup/term4j/highlighted/HighlightedTextTest.java b/src/test/java/io/github/dgroup/term4j/highlighted/HighlightedTextTest.java
@@ -0,0 +1,73 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2019 Yurii Dubinka
+ *
+ * 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 io.github.dgroup.term4j.highlighted;
+
+import org.fusesource.jansi.Ansi;
+import org.hamcrest.core.IsEqual;
+import org.junit.Test;
+import org.llorllale.cactoos.matchers.Assertion;
+import org.llorllale.cactoos.matchers.IsTrue;
+
+/**
+ * Test case for {@link HighlightedText}.
+ *
+ * @since 0.2.0
+ * @checkstyle JavadocMethodCheck (500 lines)
+ */
+@SuppressWarnings("PMD.AvoidDuplicateLiterals")
+public final class HighlightedTextTest {
+
+    @Test
+    public void hashcode() {
+        new Assertion<>(
+            "two texts have same hash codes",
+            () -> new HighlightedText("green", Ansi.Color.GREEN).hashCode(),
+            new IsEqual<>(
+                new Green("green").hashCode()
+            )
+        ).affirm();
+    }
+
+    @Test
+    public void equality() {
+        new Assertion<>(
+            "two texts are equal",
+            () -> new HighlightedText("green", Ansi.Color.GREEN)
+                .equals(new Green("green")),
+            new IsTrue()
+        ).affirm();
+    }
+
+    @Test
+    public void compareTo() {
+        new Assertion<>(
+            "two texts are equal using compareTo",
+            () -> new HighlightedText("green", Ansi.Color.GREEN).compareTo(
+                new Green("green")
+            ),
+            new IsEqual<>(0)
+        ).affirm();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`*`
`32`	`32`	`* @since 0.1.0`
`33`	`33`	`*/`
`34`		`-public final class EnvOf extends Envelope<String> {`
	`34`	`+public final class EnvOf extends ArgEnvelope<String> {`
`35`	`35`
`36`	`36`	`/**`
`37`	`37`	`* Ctor.`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`*`
`34`	`34`	`* @since 0.1.0`
`35`	`35`	`*/`
`36`		`-public final class FileOf extends Envelope<File> {`
	`36`	`+public final class FileOf extends ArgEnvelope<File> {`
`37`	`37`
`38`	`38`	`/**`
`39`	`39`	`* Ctor.`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`*`
`31`	`31`	`* @since 0.1.0`
`32`	`32`	`*/`
`33`		`-public final class NumberOf extends Envelope<Number> {`
	`33`	`+public final class NumberOf extends ArgEnvelope<Number> {`
`34`	`34`
`35`	`35`	`/**`
`36`	`36`	`* Ctor.`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,6 @@`
`33`	`33`	`* The system environment.`
`34`	`34`	`*`
`35`	`35`	`* @since 0.1.0`
`36`		`- * @todo #/DEV Rename Envelopes considering their types.`
`37`	`36`	`*/`
`38`	`37`	`public final class Envs implements Scalar<Properties> {`
`39`	`38`