Optics modules (arrow-kt#1492)

* Move mtl Setter ops

* Move Traversal State to mtl and add docs

* Move Lens Reader/State extensions to optis-mtl

* Getter mtl

* Prism mtl

* Split arrow-optics into arrow-optics-core

* Optional kdocs

* Fix docs

* Merge arrow-optics and arrow-optics-core

* Fix docs

Author: nomisRev

modules/core/arrow-test/src/main/kotlin/arrow/test/laws/PrismLaws.kt

@@ -11,7 +11,6 @@ import arrow.core.extensions.id.applicative.applicative
 import arrow.core.orElse
 import arrow.core.value
 import arrow.optics.Prism
-import arrow.optics.modify
 import arrow.typeclasses.Const
 import arrow.typeclasses.Eq
 import arrow.typeclasses.Monoid

modules/docs/arrow-docs/build.gradle

@@ -14,7 +14,7 @@ dependencies {
     compile project(':arrow-fx')
     compile project(':arrow-fx-rx2')
     compile project(':arrow-fx-reactor')
-    compile project(':arrow-optics')
+    compile project(':arrow-optics-mtl')
     compile project(':arrow-validation')
     compile project(':arrow-recursion')
     compile project(':arrow-integrations-retrofit-adapter')

modules/docs/arrow-docs/docs/docs/optics/getter/README.md

@@ -47,6 +47,7 @@ val tupleGetter: Getter<Tuple2<String, Int>, String> = Tuple2.first<String, Int>
 `Getter` also has some convenience methods to make working with [Reader]({{ '/docs/arrow/data/reader' | relative_url }}) easier.
 
 ```kotlin:ank
+import arrow.optics.mtl.*
 import arrow.mtl.*
 
 val reader: Reader<NonEmptyList<String>, String> = NonEmptyList.head<String>().asGetter().ask()
@@ -64,6 +65,7 @@ NonEmptyList.head<String>().asGetter().asks(String::decapitalize)
 There are also some convenience methods to make working with [State]({{ '/docs/arrow/data/state' | relative_url }}) easier.
 
 ```kotlin:ank
+import arrow.optics.mtl.*
 import arrow.mtl.*
 
 val inspectHealth = healthGetter.extract()

modules/docs/arrow-docs/docs/docs/optics/lens/README.md

@@ -63,6 +63,7 @@ liftF(player)
 There are also some convenience methods to make working with [Reader]({{ '/docs/arrow/data/reader' | relative_url }}) easier.
 
 ```kotlin:ank
+import arrow.optics.mtl.*
 import arrow.mtl.*
 
 val reader: Reader<Player, Int> = playerLens.ask()

modules/docs/arrow-docs/docs/docs/optics/setter/README.md

@@ -58,6 +58,8 @@ There are also some convenience methods to make working with [State]({{ '/docs/a
 This can make working with nested structures in stateful computations significantly more elegant.
 
 ```kotlin:ank
+import arrow.optics.mtl.*
+
 val takeDamage = playerSetter.update_ { it - 15 }
 takeDamage.run(Player(75))
 ```

modules/docs/arrow-docs/docs/docs/optics/traversal/README.md

@@ -65,6 +65,8 @@ There are also some convenience methods to make working with [State]({{ '/docs/a
 This can make working with nested structures in stateful computations significantly more elegant.
 
 ```kotlin:ank
+import arrow.optics.mtl.*
+
 data class Enemy(val health: Int)
 val battlefield = listOf(Enemy(70), Enemy(80), Enemy(65)).k()
 

modules/meta/arrow-meta/src/test/resources/arrow/ap/objects/iso/Iso.kt

@@ -1,8 +1,11 @@
 package `arrow`.`ap`.`objects`.`iso`
 
+import arrow.core.Option
+import arrow.core.Tuple3
+import arrow.optics.Iso
 
-
-inline val `arrow`.`ap`.`objects`.`iso`.`Iso`.Companion.iso: arrow.optics.Iso<`arrow`.`ap`.`objects`.`iso`.`Iso`, arrow.core.Tuple3<`kotlin`.`String`, `kotlin`.`String`?, `arrow`.`core`.`Option`<`kotlin`.`String`>>> inline get()= arrow.optics.Iso(
-  get = { iso: `arrow`.`ap`.`objects`.`iso`.`Iso` -> arrow.core.Tuple3(iso.`field`, iso.`nullable`, iso.`option`) },
-  reverseGet = { tuple: arrow.core.Tuple3<`kotlin`.`String`, `kotlin`.`String`?, `arrow`.`core`.`Option`<`kotlin`.`String`>> -> `arrow`.`ap`.`objects`.`iso`.`Iso`(tuple.a, tuple.b, tuple.c) }
-)
+inline val `arrow`.`ap`.`objects`.`iso`.`Iso`.Companion.iso: Iso<`Iso`, Tuple3<`String`, `String`?, `Option`<`String`>>>
+  inline get()= Iso(
+    get = { iso: `Iso` -> Tuple3(iso.`field`, iso.`nullable`, iso.`option`) },
+    reverseGet = { tuple: Tuple3<`String`, `String`?, `Option`<`String`>> -> `Iso`(tuple.a, tuple.b, tuple.c) }
+  )

modules/meta/arrow-meta/src/test/resources/arrow/ap/objects/iso/IsoSecondaryConstructor.kt

@@ -1,8 +1,10 @@
 package `arrow`.`ap`.`objects`.`iso`
 
+import arrow.core.Tuple2
+import arrow.optics.Iso
 
-
-inline val `arrow`.`ap`.`objects`.`iso`.`IsoSecondaryConstructor`.Companion.iso: arrow.optics.Iso<`arrow`.`ap`.`objects`.`iso`.`IsoSecondaryConstructor`, arrow.core.Tuple2<`kotlin`.`Int`, `kotlin`.`String`>> inline get()= arrow.optics.Iso(
-  get = { isoSecondaryConstructor: `arrow`.`ap`.`objects`.`iso`.`IsoSecondaryConstructor` -> arrow.core.Tuple2(isoSecondaryConstructor.`fieldNumber`, isoSecondaryConstructor.`fieldString`) },
-  reverseGet = { tuple: arrow.core.Tuple2<`kotlin`.`Int`, `kotlin`.`String`> -> `arrow`.`ap`.`objects`.`iso`.`IsoSecondaryConstructor`(tuple.a, tuple.b) }
-)
+inline val `arrow`.`ap`.`objects`.`iso`.`IsoSecondaryConstructor`.Companion.iso: Iso<`IsoSecondaryConstructor`, Tuple2<`Int`, `String`>>
+  inline get()= Iso(
+    get = { isoSecondaryConstructor: `IsoSecondaryConstructor` -> Tuple2(isoSecondaryConstructor.`fieldNumber`, isoSecondaryConstructor.`fieldString`) },
+    reverseGet = { tuple: Tuple2<`Int`, `String`> -> `IsoSecondaryConstructor`(tuple.a, tuple.b) }
+  )

modules/meta/arrow-meta/src/test/resources/arrow/ap/objects/prism/Prism.kt

@@ -1,26 +1,27 @@
 package `arrow`.`ap`.`objects`.`prism`
 
-import arrow.core.left
-import arrow.core.right
 import arrow.core.identity
+import arrow.optics.Prism
 
-inline val `arrow`.`ap`.`objects`.`prism`.`Prism`.Companion.prismSealed1: arrow.optics.Prism<`arrow`.`ap`.`objects`.`prism`.`Prism`, arrow.ap.objects.prism.Prism.PrismSealed1> inline get()= arrow.optics.Prism(
-  getOrModify = { prism: `arrow`.`ap`.`objects`.`prism`.`Prism` ->
-    when (prism) {
-      is arrow.ap.objects.prism.Prism.PrismSealed1 -> prism.right()
-      else -> prism.left()
-    }
-  },
-  reverseGet = ::identity
-)
+inline val `arrow`.`ap`.`objects`.`prism`.`Prism`.Companion.prismSealed1: Prism<`Prism`, Prism.PrismSealed1>
+  inline get()= Prism(
+    getOrModify = { prism: `Prism` ->
+      when (prism) {
+        is Prism.PrismSealed1 -> prism.right()
+        else -> prism.left()
+      }
+    },
+    reverseGet = ::identity
+  )
 
 
-inline val `arrow`.`ap`.`objects`.`prism`.`Prism`.Companion.prismSealed2: arrow.optics.Prism<`arrow`.`ap`.`objects`.`prism`.`Prism`, arrow.ap.objects.prism.Prism.PrismSealed2> inline get()= arrow.optics.Prism(
-  getOrModify = { prism: `arrow`.`ap`.`objects`.`prism`.`Prism` ->
-    when (prism) {
-      is arrow.ap.objects.prism.Prism.PrismSealed2 -> prism.right()
-      else -> prism.left()
-    }
-  },
-  reverseGet = ::identity
-)
+inline val `arrow`.`ap`.`objects`.`prism`.`Prism`.Companion.prismSealed2: Prism<`Prism`, Prism.PrismSealed2>
+  inline get()= Prism(
+    getOrModify = { prism: `Prism` ->
+      when (prism) {
+        is Prism.PrismSealed2 -> prism.right()
+        else -> prism.left()
+      }
+    },
+    reverseGet = ::identity
+  )

modules/optics/arrow-optics-mtl/build.gradle

@@ -0,0 +1,8 @@
+apply plugin: 'kotlin-kapt'
+
+dependencies {
+    compile project(':arrow-mtl-data')
+    compile project(':arrow-optics')
+}
+
+apply from: rootProject.file('gradle/gradle-mvn-push.gradle')