[Core] Rename Mime-Type to Media-Type

Embeddings should be provided with some information to let formatters
and reporters know how to interpret the bytes they receive. This used to
be called `Mime-Type`. However since then as a standard the `Mime-Type`
has been upgraded and renamed to `Media-Type`.

By renaming `Mime-Type` to `Media-Type` we make it clear that consumer
and producers of embeddings should use the semantics outlined in:

https://tools.ietf.org/html/rfc7231#section-3.1.1.1

Author: mpkorstanje

core/src/main/java/io/cucumber/core/backend/TestCaseState.java

@@ -5,14 +5,7 @@
 import java.net.URI;
 import java.util.Collection;
 
-/**
- * Before or After Hooks that declare a parameter of this type will receive an instance of this class.
- * It allows writing text and embedding media into reports, as well as inspecting results (in an After block).
- * <p>
- * Note: This class is not intended to be used to create reports. To create custom reports use
- * the {@code io.cucumber.plugin.Plugin} class. The plugin system provides a much richer access to Cucumbers then
- * hooks after could provide. For an example see {@code io.cucumber.core.plugin.PrettyFormatter}.
- */
+
 @API(status = API.Status.STABLE)
 public interface TestCaseState {
     /**
@@ -31,32 +24,36 @@ public interface TestCaseState {
     boolean isFailed();
 
     /**
-     * Embeds data into the report(s). Some reporters (such as the progress one) don't embed data, but others do (html and json).
-     * Example:
-     *
+     * @param data      what to embed, for example an image.
+     * @param mediaType what is the data? Using the
+     * @see #embed(byte[], String, String)
+     * @see #embed(byte[], String, String)
+     * @deprecated use {@link TestCaseState#embed(byte[], String, String)} instead.
+     */
+    @Deprecated
+    void embed(byte[] data, String mediaType);
+
+    /**
+     * Embeds data into the report(s).
      * <pre>
      * {@code
      * // Embed a screenshot. See your UI automation tool's docs for
      * // details about how to take a screenshot.
-     * scenario.embed(pngBytes, "image/png");
+     * scenario.embed(pngBytes, "image/png", "Bartholomew and the Bytes of the Oobleck");
      * }
      * </pre>
+     * <p>
+     * To ensure reporting tools can understand what the data is a
+     * {@code mediaType} must be provided. For example: {@code text/plain},
+     * {@code image/png}, {@code text/html;charset=utf-8}.
+     * <p>
+     * Media types are defined in <a href= https://tools.ietf.org/html/rfc7231#section-3.1.1.1>RFC 7231 Section 3.1.1.1</a>.
      *
-     * @param data     what to embed, for example an image.
-     * @param mimeType what is the data?
-     * @deprecated use {@link TestCaseState#embed(byte[], String, String)} instead.
-     */
-    @Deprecated
-    void embed(byte[] data, String mimeType);
-
-    /**
-     * Like {@link TestCaseState#embed(byte[], String)}, but with name for the embedding.
-     *
-     * @param data     what to embed, for example an image.
-     * @param mimeType what is the data?
-     * @param name     embedding name
+     * @param data      what to embed, for example an image.
+     * @param mediaType what is the data?
+     * @param name      embedding name
      */
-    void embed(byte[] data, String mimeType, String name);
+    void embed(byte[] data, String mediaType, String name);
 
     /**
      * Outputs some text into the report.

core/src/main/java/io/cucumber/core/plugin/HTMLFormatter.java

@@ -165,17 +165,17 @@ private String getFunctionName(HookTestStep hookTestStep) {
     }
 
     private void handleEmbed(EmbedEvent event) {
-        String mimeType = event.getMimeType();
-        if (mimeType.startsWith("text/")) {
+        String mediaType = event.getMediaType();
+        if (mediaType.startsWith("text/")) {
             // just pass straight to the plugin to output in the html
-            jsFunctionCall("embedding", mimeType, new String(event.getData()), event.getName());
+            jsFunctionCall("embedding", mediaType, new String(event.getData()), event.getName());
         } else {
             // Creating a file instead of using data urls to not clutter the js file
-            String extension = MIME_TYPES_EXTENSIONS.get(mimeType);
+            String extension = MIME_TYPES_EXTENSIONS.get(mediaType);
             if (extension != null) {
                 StringBuilder fileName = new StringBuilder("embedded").append(embeddedIndex++).append(".").append(extension);
                 writeBytesToURL(event.getData(), toUrl(fileName.toString()));
-                jsFunctionCall("embedding", mimeType, fileName, event.getName());
+                jsFunctionCall("embedding", mediaType, fileName, event.getName());
             }
         }
     }

core/src/main/java/io/cucumber/core/plugin/JSONFormatter.java

@@ -124,7 +124,7 @@ private void handleWrite(WriteEvent event) {
     }
 
     private void handleEmbed(EmbedEvent event) {
-        addEmbeddingToHookMap(event.getData(), event.getMimeType(), event.getName());
+        addEmbeddingToHookMap(event.getData(), event.getMediaType(), event.getName());
     }
 
     private void handleTestStepFinished(TestStepFinished event) {
@@ -291,17 +291,17 @@ private void addOutputToHookMap(String text) {
         ((List<String>) currentStepOrHookMap.get("output")).add(text);
     }
 
-    private void addEmbeddingToHookMap(byte[] data, String mimeType, String name) {
+    private void addEmbeddingToHookMap(byte[] data, String mediaType, String name) {
         if (!currentStepOrHookMap.containsKey("embeddings")) {
             currentStepOrHookMap.put("embeddings", new ArrayList<Map<String, Object>>());
         }
-        Map<String, Object> embedMap = createEmbeddingMap(data, mimeType, name);
+        Map<String, Object> embedMap = createEmbeddingMap(data, mediaType, name);
         ((List<Map<String, Object>>) currentStepOrHookMap.get("embeddings")).add(embedMap);
     }
 
-    private Map<String, Object> createEmbeddingMap(byte[] data, String mimeType, String name) {
+    private Map<String, Object> createEmbeddingMap(byte[] data, String mediaType, String name) {
         Map<String, Object> embedMap = new HashMap<>();
-        embedMap.put("mime_type", mimeType);
+        embedMap.put("mime_type", mediaType); // Should be media-type but not worth migrating for
         embedMap.put("data", Base64.getEncoder().encodeToString(data));
         if (name != null) {
             embedMap.put("name", name);

core/src/main/java/io/cucumber/core/runner/TestCaseState.java

@@ -53,13 +53,13 @@ public boolean isFailed() {
 
     @Deprecated
     @Override
-    public void embed(byte[] data, String mimeType) {
-        bus.send(new EmbedEvent(bus.getInstant(), testCase, data, mimeType));
+    public void embed(byte[] data, String mediaType) {
+        bus.send(new EmbedEvent(bus.getInstant(), testCase, data, mediaType));
     }
 
     @Override
-    public void embed(byte[] data, String mimeType, String name) {
-        bus.send(new EmbedEvent(bus.getInstant(), testCase, data, mimeType, name));
+    public void embed(byte[] data, String mediaType, String name) {
+        bus.send(new EmbedEvent(bus.getInstant(), testCase, data, mediaType, name));
     }
 
     @Override

core/src/main/resources/io/cucumber/core/plugin/html/formatter.js

@@ -93,7 +93,7 @@ CucumberHTML.DOMFormatter = function(rootNode) {
     }
   };
 
-  this.embedding = function(mimeType, data, name) {
+  this.embedding = function(mediaType, data, name) {
     var nameHtml;
     if (!name) {
       nameHtml = "";
@@ -103,15 +103,15 @@ CucumberHTML.DOMFormatter = function(rootNode) {
     if (currentStepIndex == 1) {
       this.dummyStep();
     }
-    if (mimeType.match(/^image\//))
+    if (mediaType.match(/^image\//))
     {
       currentStep.append(nameHtml + '<img src="' + data + '">');
     }
-    else if (mimeType.match(/^video\//))
+    else if (mediaType.match(/^video\//))
     {
-      currentStep.append(nameHtml + '<video src="' + data + '" type="' + mimeType + '" autobuffer controls>Your browser doesn\'t support video.</video>');
+      currentStep.append(nameHtml + '<video src="' + data + '" type="' + mediaType + '" autobuffer controls>Your browser doesn\'t support video.</video>');
     }
-    else if (mimeType.match(/^text\//))
+    else if (mediaType.match(/^text\//))
     {
       this.write(nameHtml + data);
     }

core/src/test/java/io/cucumber/core/runner/TestCaseStateResultTest.java

@@ -155,17 +155,17 @@ void pending_followed_by_failed_yields_failed_error() {
 
     private static final class EmbedEventMatcher implements ArgumentMatcher<EmbedEvent> {
         private byte[] data;
-        private String mimeType;
+        private String mediaType;
 
-        EmbedEventMatcher(byte[] data, String mimeType) {
+        EmbedEventMatcher(byte[] data, String mediaType) {
             this.data = data;
-            this.mimeType = mimeType;
+            this.mediaType = mediaType;
         }
 
         @Override
         public boolean matches(EmbedEvent argument) {
             return (argument != null &&
-                Arrays.equals(argument.getData(), data) && argument.getMimeType().equals(mimeType));
+                Arrays.equals(argument.getData(), data) && argument.getMediaType().equals(mediaType));
         }
     }
 

core/src/test/java/io/cucumber/core/runner/TestHelper.java

@@ -116,18 +116,18 @@ public static Answer<Object> createWriteHookAction(final String output) {
         };
     }
 
-    public static Answer<Object> createEmbedHookAction(final byte[] data, final String mimeType) {
-        return createEmbedHookAction(data, mimeType, null);
+    public static Answer<Object> createEmbedHookAction(final byte[] data, final String mediaType) {
+        return createEmbedHookAction(data, mediaType, null);
     }
 
     @SuppressWarnings("deprecation")
-    public static Answer<Object> createEmbedHookAction(final byte[] data, final String mimeType, final String name) {
+    public static Answer<Object> createEmbedHookAction(final byte[] data, final String mediaType, final String name) {
         return invocation -> {
             TestCaseState state = (TestCaseState) invocation.getArguments()[0];
             if (name != null) {
-                state.embed(data, mimeType, name);
+                state.embed(data, mediaType, name);
             } else {
-                state.embed(data, mimeType);
+                state.embed(data, mediaType);
             }
             return null;
         };

java/src/main/java/io/cucumber/java/Scenario.java

@@ -6,6 +6,14 @@
 import java.net.URI;
 import java.util.Collection;
 
+/**
+ * Before or After Hooks that declare a parameter of this type will receive an instance of this class.
+ * It allows writing text and embedding media into reports, as well as inspecting results (in an After block).
+ * <p>
+ * Note: This class is not intended to be used to create reports. To create custom reports use
+ * the {@code io.cucumber.plugin.Plugin} class. The plugin system provides a much richer access to Cucumbers then
+ * hooks after could provide. For an example see {@code io.cucumber.core.plugin.PrettyFormatter}.
+ */
 @API(status = API.Status.STABLE)
 public final class Scenario {
 
@@ -28,12 +36,12 @@ public boolean isFailed() {
     }
 
     @Deprecated
-    public void embed(byte[] data, String mimeType) {
-        delegate.embed(data, mimeType);
+    public void embed(byte[] data, String mediaType) {
+        delegate.embed(data, mediaType);
     }
 
-    public void embed(byte[] data, String mimeType, String name) {
-        delegate.embed(data, mimeType, name);
+    public void embed(byte[] data, String mediaType, String name) {
+        delegate.embed(data, mediaType, name);
     }
 
     public void write(String text) {

java8/src/main/java/io/cucumber/java8/Scenario.java

@@ -6,6 +6,14 @@
 import java.net.URI;
 import java.util.Collection;
 
+/**
+ * Before or After Hooks that declare a parameter of this type will receive an instance of this class.
+ * It allows writing text and embedding media into reports, as well as inspecting results (in an After block).
+ * <p>
+ * Note: This class is not intended to be used to create reports. To create custom reports use
+ * the {@code io.cucumber.plugin.Plugin} class. The plugin system provides a much richer access to Cucumbers then
+ * hooks after could provide. For an example see {@code io.cucumber.core.plugin.PrettyFormatter}.
+ */
 @API(status = API.Status.STABLE)
 public final class Scenario {
 
@@ -28,12 +36,12 @@ public boolean isFailed() {
     }
 
     @Deprecated
-    public void embed(byte[] data, String mimeType) {
-        delegate.embed(data, mimeType);
+    public void embed(byte[] data, String mediaType) {
+        delegate.embed(data, mediaType);
     }
 
-    public void embed(byte[] data, String mimeType, String name) {
-        delegate.embed(data, mimeType, name);
+    public void embed(byte[] data, String mediaType, String name) {
+        delegate.embed(data, mediaType, name);
     }
 
     public void write(String text) {

plugin/src/main/java/io/cucumber/plugin/event/EmbedEvent.java

@@ -8,29 +8,39 @@
 @API(status = API.Status.STABLE)
 public final class EmbedEvent extends TestCaseEvent {
     private final byte[] data;
-    private final String mimeType;
+    private final String mediaType;
     public final String name;
 
-    public EmbedEvent(Instant timeInstant, TestCase testCase, byte[] data, String mimeType) {
+    public EmbedEvent(Instant timeInstant, TestCase testCase, byte[] data, String mediaType) {
         super(timeInstant, testCase);
         this.data = Objects.requireNonNull(data);
-        this.mimeType = Objects.requireNonNull(mimeType);
+        this.mediaType = Objects.requireNonNull(mediaType);
         this.name = null;
     }
 
-    public EmbedEvent(Instant timeInstant, TestCase testCase, byte[] data, String mimeType, String name) {
+    public EmbedEvent(Instant timeInstant, TestCase testCase, byte[] data, String mediaType, String name) {
         super(timeInstant, testCase);
         this.data = data;
-        this.mimeType = mimeType;
+        this.mediaType = mediaType;
         this.name = name;
     }
 
     public byte[] getData() {
         return data;
     }
 
+    public String getMediaType() {
+        return mediaType;
+    }
+
+    /**
+     * @deprecated use {@link #getMediaType()}
+     *
+     * @return media type of the embedding.
+     */
+    @Deprecated
     public String getMimeType() {
-        return mimeType;
+        return mediaType;
     }
 
     public String getName() {