Docs #1

pepegar · 2018-07-31T08:49:35Z

This PR:

adds some docs
adds test for the Avro conversions.
adds sbt-freestyle
creates mandatory sbt-freestyle files

Note that this is not the final version of docs, since a migration from turtles to droste is undergoing, and that will potentially affect external APIs.

juanpedromoreno · 2018-07-31T09:01:39Z

build.sbt

@@ -115,11 +115,11 @@ lazy val releaseSettings = {
    releasePublishArtifactsAction := PgpKeys.publishSigned.value,
    scmInfo := Some(


I think you might not need this setting, it's being set up by sbt-freestyle (sbt-org-policies).

juanpedromoreno · 2018-07-31T09:02:00Z

build.sbt

      )
    ),
-    homepage := Some(url("https://github.com/pepegar/skeuomorph")),
+    homepage := Some(url("https://github.com/frees-io/skeuomorph")),


juanpedromoreno · 2018-07-31T09:02:43Z

build.sbt

@@ -85,7 +86,6 @@ lazy val releaseSettings = {
      setReleaseVersion,
      commitReleaseVersion,
      tagRelease,
-      // For non cross-build projects, use releaseStepCommand("publishSigned")


releaseSettings are also being set up by sbt-freestyle (sbt-org-policies).

juanpedromoreno · 2018-07-31T09:04:02Z

build.sbt

@@ -32,44 +51,26 @@ onLoad in Global := { s =>

 // General Settings
 lazy val commonSettings = Seq(
-  organization := "com.pepegar",
+  organization := "io.frees",


I'd add startYear := Some(2018)

juanpedromoreno · 2018-07-31T09:05:55Z

src/test/scala/instances.scala

+      namespace  <- nonEmptyString
+      fieldNames <- Gen.nonEmptyContainerOf[Set, String](nonEmptyString).map(_.toList)
+      fields     <- fieldNames.traverse(field)
+    } yield AvroSchema.createRecord(name, doc, namespace, false, fields.asJava)


You could use applicative and mapN here to generate all the class fields values in parallel.

You'd need this https://github.com/ChristopherDavenport/cats-scalacheck or create an instance of Applicative of Gen

Yap, I already have it in the project

fedefernandez · 2018-07-31T09:29:34Z

README.md

-      .transCata[Mu[freestyle.Schema]](freestyle.utils.transformAvro) // skeuomorph.avro.Schema => skeuomorph.freestyle.Schema
-      .cata(freestyle.utils.render) // skeuomorph.freestyle.Schema => String
+val definition = """
+  {"namespace": "example.avro",


Can we improve the formatting? I'd use some online json formatter. For the documentation is better.

fedefernandez · 2018-07-31T09:32:22Z

README.md

+
+schema.ana[Mu[avro.Schema]](avro.util.fromAvro). // org.apache.avro.Schema => skeuomorph.avro.Schema
+      transCata[Mu[freestyle.Schema]](freestyle.util.transformAvro). // skeuomorph.avro.Schema => skeuomorph.freestyle.Schema
+      cata(freestyle.util.render) // skeuomorph.freestyle.Schema => String


Same here, what about something like:

schema .ana[Mu[avro.Schema]](avro.util.fromAvro) // org.apache.avro.Schema => skeuomorph.avro.Schema .transCata[Mu[freestyle.Schema]](freestyle.util.transformAvro) // skeuomorph.avro.Schema => skeuomorph.freestyle.Schema .cata(freestyle.util.render) // skeuomorph.freestyle.Schema => String

I wanted to format it this way too, but Tut complains about it, probably because it reads the block line by line. That's why I added dots at the end, to tell tut to read next line as part of the expression too.

fedefernandez · 2018-07-31T09:33:58Z

src/test/scala/instances.scala

+      namespace  <- nonEmptyString
+      fieldNames <- Gen.nonEmptyContainerOf[Set, String](nonEmptyString).map(_.toList)
+      fields     <- fieldNames.traverse(field)
+    } yield AvroSchema.createRecord(name, doc, namespace, false, fields.asJava)


You'd need this https://github.com/ChristopherDavenport/cats-scalacheck or create an instance of Applicative of Gen

diesalbla · 2018-07-31T09:49:57Z

build.sbt

-      </developers>
-    }
+    %%("cats-core"),
+    %%("specs2-core"),


Does this line need % Test?

Right, good cathc!

diesalbla · 2018-07-31T09:54:07Z

src/test/scala/instances.scala

+    def createGen(tpe: AvroType): Gen[AvroSchema] =
+      Gen.const(AvroSchema.create(tpe))
+
+    val primitives: Gen[AvroSchema] = Gen.oneOf(


You can use Gen.oneOf on a Seq[A], without using Gen.const. Also, you can use .map(AvroSchema.create).

diesalbla · 2018-07-31T09:57:48Z

src/test/scala/instances.scala

+      createGen(AvroType.NULL)
+    )
+
+    val nonEmptyString: Gen[String] = Gen.nonEmptyListOf(Gen.alphaChar).map(_.mkString)


Perhaps Gen.alphaStr.filterNot(_.isEmpty)?

Code

diesalbla · 2018-07-31T10:49:25Z

@pepegar There are some elements I would add to the README:

First, at the beginning I would add a clear phrase stating what skeuomorph is. Some examples from cats and shapeless.

Cats is a library which provides abstractions for functional programming in the Scala programming language. The name is a playful shortening of the word category.

shapeless is a type class and dependent type based generic programming library for Scala. It had its origins in several talks by Miles Sabin (@milessabin), given over the course of 2011, on implementing scrap your boilerplate and higher rank polymorphism in Scala.

In particular, whether it is a schema to schema transformation (like the avrohugger), or a coding-encoding library (like avro4s).
Another thing I would clarify is what is the relation between this library and freestyle. Does its functionality depend, or is primarilly intended for, either freestyle-core or freestyle-rpc?
As a matter of opinion, I would mention the key libraries it is based on. Would those be cats, shapeless, and turtles?

pepegar added 12 commits July 30, 2018 14:28

add tests for avro conversions

7a81545

add docs project

13c51f5

trim stuff from build.sbt

524e920

add sbt-freestyle, generate files

f899570

add headers

57b2b86

changes to README

e353dfe

add some content to the microsite

ded4ce0

add some docs to Service class

6af7593

add more stuff to docs

537575c

fix example in docs

b822e1f

fix docs

b8d883a

delete menu

b0d7a5d

pepegar requested a review from a team July 31, 2018 08:49

juanpedromoreno reviewed Jul 31, 2018

View reviewed changes

fedefernandez reviewed Jul 31, 2018

View reviewed changes

address PR comments

a66297e

diesalbla reviewed Jul 31, 2018

View reviewed changes

pepegar added 2 commits July 31, 2018 11:50

fix format in README

50bdef6

make specs2 only be available in Test

439333d

diesalbla reviewed Jul 31, 2018

View reviewed changes

some style changes in instances

8c57126

diesalbla approved these changes Jul 31, 2018

View reviewed changes

pepegar added 2 commits July 31, 2018 16:34

add some more stuff to README

db39813

fix org files to comply with validations

f76b91a

juanpedromoreno approved these changes Jul 31, 2018

View reviewed changes

pepegar merged commit f3add8a into master Jul 31, 2018

pepegar deleted the docs branch July 31, 2018 14:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs #1

Docs #1

pepegar commented Jul 31, 2018 •

edited

juanpedromoreno Jul 31, 2018

juanpedromoreno Jul 31, 2018

juanpedromoreno Jul 31, 2018

juanpedromoreno Jul 31, 2018

juanpedromoreno Jul 31, 2018 •

edited

fedefernandez Jul 31, 2018

pepegar Jul 31, 2018

fedefernandez Jul 31, 2018

pepegar Jul 31, 2018

fedefernandez Jul 31, 2018

pepegar Jul 31, 2018

fedefernandez Jul 31, 2018

diesalbla Jul 31, 2018 •

edited

pepegar Jul 31, 2018

diesalbla Jul 31, 2018

diesalbla Jul 31, 2018 •

edited

diesalbla commented Jul 31, 2018 •

edited

		@@ -115,11 +115,11 @@ lazy val releaseSettings = {
		releasePublishArtifactsAction := PgpKeys.publishSigned.value,
		scmInfo := Some(

Docs #1

Docs #1

Conversation

pepegar commented Jul 31, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juanpedromoreno Jul 31, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diesalbla Jul 31, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diesalbla Jul 31, 2018 • edited

Choose a reason for hiding this comment

diesalbla commented Jul 31, 2018 • edited

pepegar commented Jul 31, 2018 •

edited

juanpedromoreno Jul 31, 2018 •

edited

diesalbla Jul 31, 2018 •

edited

diesalbla Jul 31, 2018 •

edited

diesalbla commented Jul 31, 2018 •

edited