Add missing UnorderedTraverse syntax by andyscott · Pull Request #2148 · typelevel/cats

andyscott · 2018-01-11T02:53:36Z

Addresses #2147:

The import cats.syntax.traverse._ doesn't provide the .unorderedTraverse. This is inconsistent, as the import cats.syntax.foldable._ does provide the unorderedFold syntax.

andyscott · 2018-01-11T03:50:14Z

2.10 and 2.11 JVM failed the binary compatibility check. /cc @kailuowang

kailuowang · 2018-01-11T12:17:38Z

You can't touch an existing trait, you have to have the traverse object extend this extra trait instead of through the TraverseSyntax trait

andyscott · 2018-01-11T15:12:23Z

Aah yes. I'll get that switched today.

codecov-io · 2018-01-11T19:57:26Z

Codecov Report

Merging #2148 into master will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2148      +/-   ##
==========================================
+ Coverage   94.64%   94.66%   +0.01%     
==========================================
  Files         328      328              
  Lines        5548     5548              
  Branches      213      213              
==========================================
+ Hits         5251     5252       +1     
+ Misses        297      296       -1

Impacted Files	Coverage Δ
testkit/src/main/scala/cats/tests/CatsSuite.scala	`70% <ø> (ø)`	⬆️
core/src/main/scala/cats/UnorderedTraverse.scala	`100% <0%> (+50%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a296b8e...6375e01. Read the comment docs.

kailuowang · 2018-01-11T20:06:14Z

 package syntax

 trait TraverseSyntax extends Traverse.ToTraverseOps
+trait TraverseSyntaxBinCompat0 extends UnorderedTraverse.ToUnorderedTraverseOps


shall we just name this one UnorderedTraverseSyntax since we dont' have one?

We could. Is there any merit to keeping it as similar to Foldable/UnorderedFoldable (which doesn't have UnorderedFoldableSyntax)?

Foldable/UnorderedFoldable is the unconventional one. I am referring to
trait FoldableSyntax extends Foldable.ToFoldableOps with UnorderedFoldable.ToUnorderedFoldableOps
The convention in Cats is that the syntax trait of a TC does NOT extend the syntax of its parent TC. For users to get the parent syntax, they have to either explicitly import the parent syntax, or using the all inclusive import.
So I think having an UnorderdTraverseSyntax trait is more conventional.

TBC, I am okay with cats.syntax.traverse the object extending the UnorderedTraverseSyntax, but it's not really conventional in Cats.
More conventional way would be adding a cats.syntax.unorderedTraverse and having it extending the UnorderedTraverseSyntax, along with making cats.syntax.all and cats.implicits to extends this trait as well as a work-around for keeping bin-compat.

sorry about the bike shedding here. The main reason I am discussing more about it is that this would set up a precedence for working around bin compat breakage. although it's a bit atypical

kailuowang · 2018-01-11T20:07:41Z

also if this this not available in cats.implicits._ we need to have that one extend this trait as well.

kailuowang · 2018-01-22T18:59:54Z

@andyscott how do you want to proceed with this PR? I'll be happy to make the rename changes for you if you want.

andyscott · 2018-01-22T23:24:10Z

Sorry for the delay. I can take care of it within the next day.

…

On Mon, Jan 22, 2018 at 11:00 AM, Kai(luo) Wang ***@***.***> wrote: @andyscott <https://github.com/andyscott> how do you want to proceed with this PR? I'll be happy to make the rename changes for you if you want. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2148 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAS8W_tqMAW6BfBxBcLqWpI30zDGDVcWks5tNNqvgaJpZM4RaPzV> .

LukaJCB

Thanks a bunch, Andy! :)

kailuowang · 2018-01-24T17:25:21Z

    with VectorSyntax
    with WriterSyntax
+
+trait AllSyntaxBinCompat0


One more small thing, if we make this one abstract class (and maybe even have it extends AllSyntax) we can add more traits to it going forward.

How about an abstract class AllSyntaxBinCompat extends AllSyntax with AllSyntaxBinCompat0?

then what's the purpose of AllSyntaxBinCompat0? just as a versioning scheme?

A downstream consumer can't mix in the abstract class but they could mix in AllSyntax and AllSyntaxBinCompat0 to get roughly the same effect. Without AllSyntaxBinCompat0, but then you'd have to remember that AllSyntax is missing UnorderedTraverse syntax. So it's versioning scheme to facilitate downstream use.

I'm not sure if it's worth it though. It's just an idea.

I see. Makes sense to me

andyscott changed the title ~~Add missing .unorderedTraverse syntax~~ Add missing UnorderedTraverse syntax Jan 11, 2018

andyscott force-pushed the unorderedTraverse-syntax branch from c8712bf to a0f4152 Compare January 11, 2018 19:57

kailuowang reviewed Jan 11, 2018

View reviewed changes

kailuowang added the bug label Jan 11, 2018

kailuowang added this to the 1.1 milestone Jan 11, 2018

andyscott force-pushed the unorderedTraverse-syntax branch from a0f4152 to dfc8759 Compare January 11, 2018 20:46

andyscott force-pushed the unorderedTraverse-syntax branch from dfc8759 to 87fbbb9 Compare January 24, 2018 06:44

LukaJCB previously approved these changes Jan 24, 2018

View reviewed changes

kailuowang reviewed Jan 24, 2018

View reviewed changes

andyscott dismissed LukaJCB’s stale review via af487e1 January 25, 2018 02:18

andyscott force-pushed the unorderedTraverse-syntax branch from 87fbbb9 to af487e1 Compare January 25, 2018 02:18

Add missing .unorderedTraverse syntax

6375e01

andyscott force-pushed the unorderedTraverse-syntax branch 2 times, most recently from 671c93f to 6375e01 Compare January 25, 2018 03:36

kailuowang approved these changes Jan 25, 2018

View reviewed changes

kailuowang merged commit dc6b643 into typelevel:master Jan 25, 2018

This was referenced Jan 25, 2018

Guideline for adding functionality without breaking binary compatibility. #2142

Open

Add contains_, foldSmash and mkString_ to FoldableOps #2123

Merged

peterneyens mentioned this pull request Mar 25, 2018

cats.implicits._ doesn't include Show[Duration] instance #2216

Closed

andyscott deleted the unorderedTraverse-syntax branch July 13, 2018 22:08

Uh oh!

Conversation

andyscott commented Jan 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andyscott commented Jan 11, 2018

Uh oh!

kailuowang commented Jan 11, 2018

Uh oh!

andyscott commented Jan 11, 2018

Uh oh!

codecov-io commented Jan 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kailuowang Jan 11, 2018

Choose a reason for hiding this comment

Uh oh!

andyscott Jan 11, 2018

Choose a reason for hiding this comment

Uh oh!

kailuowang Jan 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kailuowang Jan 12, 2018

Choose a reason for hiding this comment

Uh oh!

kailuowang commented Jan 11, 2018

Uh oh!

kailuowang commented Jan 22, 2018

Uh oh!

andyscott commented Jan 22, 2018 via email

Uh oh!

LukaJCB left a comment

Choose a reason for hiding this comment

Uh oh!

kailuowang Jan 24, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andyscott Jan 24, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kailuowang Jan 24, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andyscott Jan 24, 2018

Choose a reason for hiding this comment

Uh oh!

kailuowang Jan 25, 2018

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

andyscott commented Jan 11, 2018 •

edited

Loading

codecov-io commented Jan 11, 2018 •

edited

Loading

kailuowang Jan 12, 2018 •

edited

Loading

kailuowang Jan 24, 2018 •

edited

Loading

andyscott Jan 24, 2018 •

edited

Loading

kailuowang Jan 24, 2018 •

edited

Loading