Create rule S4348[kotlin]: "iterator" should not return "this""

rules/S4348/description.adoc

@@ -0,0 +1,6 @@
+There are two classes in the standard library that deal with iterations: `Iterable<T>` and `Iterator<T>`. An `Iterable<T>` represents a data structure that can be the target of the "for-each loop" statement, and an `Iterator<T>` represents the state of an ongoing traversal. An `Iterable<T>` is generally expected to support multiple traversals.
+
+An `Iterator<T>` that also implements `Iterable<t>` by returning itself as its `iterator()` will not support multiple traversals since its state will be carried over.
+
+
+This rule raises an issue when the `iterator()` method of a class implementing both `Iterable<T>` and `Iterator<t>` returns `this`.

rules/S4348/java/metadata.json

@@ -1,27 +1,3 @@
 {
-  "title": "\"iterator\" should not return \"this\"",
-  "type": "BUG",
-  "status": "ready",
-  "remediation": {
-    "func": "Constant\/Issue",
-    "constantCost": "10min"
-  },
-  "tags": [
-    "pitfall"
-  ],
-  "extra": {
-    "coveredLanguages": [
-      "Java"
-    ],
-    "replacementRules": [
-
-    ]
-  },
-  "defaultSeverity": "Major",
-  "ruleSpecification": "RSPEC-4348",
-  "sqKey": "S4348",
-  "scope": "All",
-  "defaultQualityProfiles": [
-    "Sonar way"
-  ]
+
 }

rules/S4348/java/rule.adoc

@@ -1,9 +1,4 @@
-There are two classes in the Java standard library that deal with iterations: ``++Iterable<T>++`` and ``++Iterator<T>++``. An ``++Iterable<T>++`` represents a data structure that can be the target of the "for-each loop" statement, and an ``++Iterator<T>++`` represents the state of an ongoing traversal. An ``++Iterable<T>++`` is generally expected to support multiple traversals.
-
-An ``++Iterator<T>++`` that also implements ``++Iterable<t>++`` by returning itself as its ``++iterator()++`` will not support multiple traversals since its state will be carried over.
-
-
-This rule raises an issue when the ``++iterator()++`` method of a class implementing both ``++Iterable<T>++`` and ``++Iterator<t>++`` returns ``++this++``.
+include::../description.adoc
 
 
 == Noncompliant Code Example

rules/S4348/kotlin/metadata.json

@@ -0,0 +1,3 @@
+{
+
+}

rules/S4348/kotlin/rule.adoc

@@ -0,0 +1,36 @@
+include::../description.adoc
+
+
+== Noncompliant Code Example
+
+----
+class FooIterator : Iterator<Foo>, Iterable<Foo> {
+
+    override fun iterator(): Iterator<Foo> {
+        return this // Noncompliant
+    } 
+    // ...
+}
+----
+
+
+== Compliant Solution
+
+----
+class FooSequence : Iterable<Foo> {
+
+    override fun iterator(): Iterator<Foo> {
+        return object : Iterator<Foo> {
+            override fun hasNext(): Boolean {
+                //...
+            }
+
+            override fun next(): Foo {
+                //...
+            }
+        }
+    }
+    //...
+}
+----
+

rules/S4348/metadata.json

@@ -1,2 +1,27 @@
 {
+  "title": "\"iterator()\" should not return \"this\"",
+  "type": "BUG",
+  "status": "ready",
+  "remediation": {
+    "func": "Constant\/Issue",
+    "constantCost": "10min"
+  },
+  "tags": [
+    "pitfall"
+  ],
+  "extra": {
+    "coveredLanguages": [
+      "Java"
+    ],
+    "replacementRules": [
+
+    ]
+  },
+  "defaultSeverity": "Major",
+  "ruleSpecification": "RSPEC-4348",
+  "sqKey": "S4348",
+  "scope": "All",
+  "defaultQualityProfiles": [
+    "Sonar way"
+  ]
 }