Merge pull request #1368 from pkowalcze/resource-surround

surround and surroundK added to Resource

core/shared/src/test/scala/cats/effect/ResourceSpec.scala

@@ -469,6 +469,25 @@ class ResourceSpec extends BaseSpec with ScalaCheck with Discipline {
     //   }
     // }
 
+    "surround - should wrap an effect in a usage and ignore the value produced by resource" in ticked {
+      implicit ticker =>
+        val r = Resource.liftF(IO.pure(0))
+        val surroundee = IO("hello")
+        val surrounded = r.surround(surroundee)
+
+        surrounded eqv surroundee
+    }
+
+    "surroundK - should wrap an effect in a usage, ignore the value produced by resource and return FunctionK" in ticked {
+      implicit ticker =>
+        val r = Resource.liftF(IO.pure(0))
+        val surroundee = IO("hello")
+        val surround = r.surroundK
+        val surrounded = surround(surroundee)
+
+        surrounded eqv surroundee
+    }
+
   }
 
   {

kernel/shared/src/main/scala/cats/effect/kernel/Resource.scala

@@ -417,6 +417,20 @@ sealed abstract class Resource[+F[_], +A] {
    */
 
   private[effect] def invariant: Resource.InvariantResource[F0, A]
+
+  /**
+   * Acquires the resource, runs `gb` and closes the resource once `gb` terminates, fails or gets interrupted
+   */
+  def surround[G[x] >: F[x]: Resource.Bracket, B](gb: G[B]): G[B] =
+    use(_ => gb)
+
+  /**
+   * Creates a FunctionK that can run `gb` within a resource, which is then closed once `gb` terminates, fails or gets interrupted
+   */
+  def surroundK[G[x] >: F[x]: Resource.Bracket]: G ~> G =
+    new (G ~> G) {
+      override def apply[B](gb: G[B]): G[B] = surround(gb)
+    }
 }
 
 object Resource extends ResourceInstances with ResourcePlatform {