Skip to content

CHANGES.md

Latest commit

 

History

History
769 lines (610 loc) · 42.1 KB

CHANGES.md

File metadata and controls

769 lines (610 loc) · 42.1 KB

Version 0.7.2

2016 September 1

Version 0.7.2 is a patch release that was released to fix a major bug (#1346) that appeared in 0.7.0. It also contains several other improvements.

It should be safe to upgrade from 0.7.0 to 0.7.2 -- there are no major API changes between these releases.

Changes

Fixes:

  • #1347: fixes broken Monoid[Map[K, V]].combineAll implementation.
  • #1304: fix CoflatMap documentation.
  • #1322: fix SBT commands (release, validate, etc.).
  • #1311: rename some implicit instances for consistency.

Additions:

  • #1319: add missing BigDecimal instances.
  • #1324: add missing function and BitSet instances.

Note that 0.7.2 was preceeded by a botched 0.7.1. release. Please avoid using this version of Cats -- it has major incompatibilities with 0.7.0 and is not documented here.

Version 0.7.0

2016 August 21

Version 0.7.0 is the seventh Cats release, and includes several major rearrangements and changes to names.

Migration notes

If you're updating from Cats 0.6.0, it's likely that you'll need to make extensive (but mostly mechanical) changes. The following list includes some of the changes that are likely to be necessary for most projects; see the complete list of changes below for more detail.

  • All references to cats.std will need to be changed to cats.instances (#1140). If you're using cats.std.all or the other cats.std objects with wildcard imports, this is likely to be the only change you need to make. If you are importing or referring to instance definitions by name, you'll need to be aware that the naming convention has changed (see #1066, #1068, #1110, and #1122).
  • NonEmptyList and NonEmptyVector are no longer type aliases for OneAnd, so any code using OneAnd to construct or pattern match on these types will need to be changed to use NonEmptyList or NonEmptyVector directly. There are also some API changes; for example, unwrap calls will need to be replaced by toList or toVector, and NonEmptyList(1, 2, 3) is now NonEmptyList.of(1, 2, 3).
  • pureEval has been removed from Applicative (#1234), and has not been replaced, so if you are relying on it for laziness or effect capturing (which wasn't enforced or guaranteed), you'll need to find another approach.
  • All references to NaturalTransformation will need to be replaced by either FunctionK or ~>.
  • The FlatMap type class now has a tailRecM method that is designed to support stack-safe recursive monadic binding. If your monad's flatMap is stack safe, you can implement a stack-safe tailRecM by calling Monad#defaultTailRecM. The stack safety of tailRecM is not enforced, but if your implementation is stack safe, you should also provide an instance of the RecursiveTailRecM marker type class.
  • If you are interpreting a free algebra into a context F with foldMap, you'll now need F to have an instance of the RecursiveTailRecM marker type class (in addition to the Monad instance).

If you run into any issues while updating, please get in touch on Gitter.

Changes

This release includes a fix for a bug in 0.6.0 (also fixed in 0.6.1):

  • #1062: Order instances for tuples are now lexicographic (instead of only comparing first elements)

And other bug fixes:

  • #1096: inj and prj on Inject now work consistently with respect to null

And some additions:

  • #1289 and #1306: EitherT and improved Either syntax
  • #1280: FlatMap now has a tailRecM method
  • #1280: RecursiveTailRecM marker type class indicating that tailRecM is stack safe
  • #1266: FreeT monad transformer
  • #1225: FunctorFilter and TraverseFilter
  • #1121: valueOr and merge for Validated
  • #1188: toValidatedNel for XorT
  • #1127: toTry for Xor
  • #1269: catchNonFatal for ApplicativeError
  • #1130: isEmpty syntax method for Monoid
  • #1167: minimum, maximum, and related helper methods for Foldable and Reducible
  • #1243: distinct on NonEmptyList and NonEmptyVector
  • #1134: cats.syntax.list for à la carte list syntax imports
  • #1191: cats.syntax.monoid for à la carte Monoid syntax imports
  • #588 and #1063: IdT, the identity monad transformer
  • #1021 and #1221: Nested (represents nested composition of type constructors)
  • #1172: toNested for OptionT and XorT
  • #1102 and #1170: Comparison (represents the result of an Order comparison)
  • #1090: Kleisli.lift
  • #1169: lift, inspect, and related methods for StateT
  • #1114: size for Foldable
  • #1193: reduceLeftM for Reducible
  • #1097: Functor variance helpers (widen for Functor and narrow for Contravariant)
  • #1207: tell for Writer and WriterT, value for Writer
  • #1155: Convenience methods for constructing XorT values
  • #1085: runTailRec and foldLeftM for Free
  • #1299: ContravariantCartesian type class

And some name changes:

  • #1140: cats.std is now cats.instances
  • #1066, #1068, #1110, and #1122: More unique type class instance names
  • #1072: NaturalTransformation is now FunctionK
  • #1085: mapSuspension on Free is now compile
  • #1111: Free.Gosub is now Free.FlatMapped
  • #1133: Composite* traits for binary type classes are renamed to Composed* for consistency (and are now private)

And other API changes:

  • #1231: NonEmptyList is now a case class instead of a type alias for a OneAnd
  • #1137: NonEmptyVector is now a value class instead of a type alias for a OneAnd
  • #1267: Overloaded variadic apply on NonEmptyList and NonEmptyVector is now of
  • #1234: Applicative#pureEval has been removed
  • #1202: MonadFilter no longer has a filterM method (see #1225)
  • #1075: foldMap on Free now requires a MonadRec instance (instead of simply Monad)
  • #1085: Free.suspend no longer requires an Applicative instance
  • #1084: Safer toString for Free and FreeApplicative
  • #1100: Simplified constraints for methods on Xor and related types
  • #1171: Prioritization traits are now private

And many new instances:

  • #1059 and #1147: Monoid, MonadError, and other instances for scala.util.Try
  • #1299: Monad for Tuple2
  • #1211: Contravariant for Eq
  • #1220: Traverse and Comonad for Tuple2
  • #1103: Order, MonadError, and other instances for OptionT
  • #1106: Semigroup and Monoid for XorT
  • #1138: SemigroupK and MonadCombine for StateT
  • #1128 Semigroup and Monoid for Applicative
  • #1049: CoflatMap for WriterT
  • #1076 and #1261: MonadRec instances for Eval, StateT, and Future
  • #1105: Unapply instances for Nested shapes

And miscellaneous improvements to style and performance:

  • #1079: More consistent type lambdas
  • #1300: Much faster Monoid instances for Map

And improvements to the documentation:

  • #1145: Major rearrangements and additions
  • #1136: New chart for symbols
  • #1052: New "Why?" section
  • #1095, #1226, and #1227: New FAQ section
  • #1163: New import guide section
  • #1217, #1223, and #1239: New related projects
  • #1057 and #1157: Copy-paste-friendly code blocks
  • #1104 and #1115: Kitchen-sink imports in example code
  • #1050: Switch to rouge for syntax highlighting in the GitHub Pages site
  • #1119: Fix for contramap signature
  • #1141 and #1162: Fixes for cats-kernel documentation
  • #1149: Spelling consistency for "type class"
  • #1183: More documentation about use of Machinist, Simulacrum, and kind-projector
  • #1056: Clarification about forgetful functors and the free monad
  • #1131 and #1241: Simplified project structure listings
  • #1185, #1186, and #1189: Miscellaneous improvements for Traverse documentation

And the build:

  • #1159: Binary compatibility checking for cats-kernel via MiMa
  • #1256: More reliable Scala.js testing in Travis CI
  • #1123: cats-kernel is now included in the API documentation
  • #1051: Empty Scaladocs for 2.10 to avoid issues macros cause for API documentation generation on 2.10
  • #1154: Better POM hygiene: no Scoverage dependency
  • #1153 and #1218: More consistent use of Simulacrum for syntax
  • #1093: Scalastyle is now aware of shared and Scala.js-specific source files
  • #1142: Additional formatting rules for Scalastyle
  • #1099: Type lambda style is now enforced by Scalastyle
  • #1258: Version updates for SBT and SBT plugins

We also welcome Kailuo Wang, Peter Neyens, and Oscar Boykin as new Cats maintainers!

Version 0.6.1

2016 July 14

Version 0.6.1 is a patch release compatible with 0.6.0.

It contains one bug fix:

  • #1062: Fixed a bug in the Order and PartialOrder instances for Tuple2+ where only the first element was used in comparisons

It also contains a change to the build:

  • #1173: Add binary compatibility check to all published modules

Version 0.6.0

2016 May 19

Version 0.6.0 is the sixth release.

Highlights of this release:

  • #990: Separate free package into its own module
  • #1001: Introduce cats-kernel and remove algebra dependency

This release also includes some API changes:

  • #1046: summon ApplicativeErrorSyntax for F[_] instead of F[_, _]
  • #1034: Don't combine lefts on Xor and XorT combine
  • #1018: Remove blocking (JVM-only) Future instances
  • #877: Remove required laziness in Prod, fixes #615

And additions:

  • #1032: Added Coproduct fold
  • #1028: Added withFilter for OptionT
  • #1014: Added Monoid instance for WriterT
  • #1029: Added an ApplicativeError instance for Kleisli and a MonadError[Option, Unit] to std.option
  • #1023: Add XorT#fromEither
  • #984: Add Validated.ensure
  • #1020: Add Traverse.traverseM

And some code improvements:

  • #1015: Add Apply.map2Eval and allow traverse laziness
  • #1024: Override reverse on reversed PartialOrder to return original instance
  • #880: Optimize Eq[Vector[A]] instance
  • #1019: Use Future#successful in pureEval when possible

And bug fixes:

  • #1011: Add missing type parameters.

And some other improvements to the organization documentation, tutorials, laws and tests, including:

  • #1045: Add a link to the OptionT documentation from the monad docs.
  • #1043: Add notes about kind-projector usage in docs
  • #1042: Cats 0.5.0 no longer pre-release
  • #1036: Add FPiS to the "Resources for Learners" section
  • #1035: Run kernel-law tests for JS as part of build
  • #991: Replace ~> with NaturalTransformation
  • #1027: Remove unnecessary nelSemigroup from traverse doc
  • #1022: Add law-checking for asMeetPartialOrder and asJoinPartialOrder
  • #990: Separate free package into its own module

Version 0.5.0

2016 April 28

Version 0.5.0 is the fifth release.

This release includes some API changes:

cats.laws.discipline.eq no longer provides Eq instances for Tuple2 and Tuple3, these instances and together with some other new instances for Tuples are now provided by cats.std.tuple (through inheriting the instance trait defined in algebra 0.4.2).

  • #910: Remove Streaming and StreamingT
  • #967: product and map can be implemented in terms of ap
  • #970: Renamed Kleisli#applyto ap
  • #994: updated to latest algebra (brought in all the new goodies)

And additions:

  • #853: Adds a new LiftTrans type class
  • #864: Add Bifoldable
  • #875: Add .get method to StateT
  • #884: Add Applicative syntax
  • #886: Add map method to OneAnd
  • #927: XorT.ensure method
  • #925: Stack-safe foldM
  • #922: Add tell and writer syntax for creating Writers.
  • #903: Add Bitraverse
  • #928: Add missing Show instances
  • #940: More flexible TransLift
  • #946: Added OptionT.none
  • #947: Syntax for ApplicativeError
  • #971: Add toValidatedNel to Xor
  • #973: Add flatMapF for StateT
  • #985: Add object reducible for reducible syntax
  • #996: Add SemigroupK instance for Xor
  • #998: Add SemigroupK instance for Validated
  • #986: Add Bitraverse instances for Validated and XorT

And bug fixes:

  • #873: Fix OptionIdOps.some to always return Some
  • #958: Switch off scaladoc generation for Scala 2.10 due to macro problems
  • #955: Rename Id instances to idInstances to make selective import easier

And removals:

  • #910: Remove Streaming and StreamingT

And some other improvements to the documentation, tutorials, laws and tests, including:

  • #880: Optimize Eq[Vector[A]] instance
  • #878: Fix bug in freemonad doc
  • #870: Fixed doc string for StateT's runEmptyA()
  • #866: Add some tests for Coproduct and WriterT
  • #883: Delegate to Traverse.sequence in Applicative.sequence
  • #893: Add Reducible laws
  • #923: Make Call.loop @tailrec optimized
  • #916: add -P:scalajs:mapSourceURI option
  • #909: Make Bifunctor universal
  • #905: make Unapply serializable
  • #902: Make table in Kleisli readable
  • #897: Add Prod tests
  • #938: Onward to scala 2.11.8
  • #941: Type class composition and MonadState tests
  • #949: Add .ensime_cache to gitignore
  • #954: Switch to use nodeJsEnv as default jsEnv to build scala.js
  • #956: Upgrade scala.js from 0.6.7 -> 0.6.8
  • #960: More Reducible tests
  • #962: Improving test coverage
  • #964: Clarify stabilty guarantees; drop 'proof of concept' and 'experimental'
  • #972: Fix swapped f and g in invariant docs
  • #979: Fix outdated import for cats.syntax.apply._
  • #995: Move coverage away from bash
  • #1002: Correct the URL for Data types à la carte
  • #1005: fix broken link in foldable docs

As always thanks to everyone who filed issues, participated in the Cats Gitter channel, submitted code, or helped review pull requests.

Version 0.4.1

2016 February 4

Version 0.4.1 is a patch release in the 0.4 series and is binary compatible with version 0.4.0.

This patch fixes bugs with the dropWhile methods on Streaming and StreamingT.

This release corrects outdated build/POM metadata, which should fix API doc URLS.

Bug fixes:

  • #856: Fix Streaming and StreamingT dropWhile functions

Build/publishing changes:

  • #852 Update build with org change

Documentation and site improvements:

  • #859 Add Contravariant documentation page
  • #861 Docs: Revive useful links section. Update URLs

Version 0.4.0

2016 February 1

Version 0.4.0 is the fourth release of the Cats library, and the first release published under the org.typelevel group from the Typelevel organization on GitHub (previous releases had been published to org.spire-math from non/cats). This means that users will need to change the groupId for their Cats dependencies when updating. If you have a line like this in your SBT build configuration, for example:

libraryDependencies += "org.spire-math" %% "cats" % "0.3.0"

You will need to change it to the following:

libraryDependencies += "org.typelevel" %% "cats" % "0.4.0"

This release no longer includes cats-state or cats-free artifacts, since the cats.state and cats.free packages have been moved into cats-core.

If you've checked out the GitHub repository locally, it would be a good idea to update your remote to point to the new organization, which will typically look like this (note that you should confirm that origin is the appropriate remote name):

git remote set-url origin git@github.com:typelevel/cats.git

This release includes a large number of breaking changes, including most prominently the introduction of a new Cartesian type class that is a supertype of Monad (and many other types). If you use the |@| syntax that had previously been provided by Apply, you'll need to change your imports from cats.syntax.apply._ to cats.syntax.cartesian._. For example:

scala> import cats.Eval, cats.syntax.cartesian._
import cats.Eval
import cats.syntax.cartesian._

scala> (Eval.now("v") |@| Eval.now(0.4)).tupled
res0: cats.Eval[(String, Double)] = cats.Eval$$anon$5@104f8bbd

Other changes in this release are described below.

This version includes API changes:

  • #555: |@| syntax is now provided by cats.syntax.cartesian
  • #835: State and StateT are now in the cats.data package
  • #781: combine on SemigroupK is now combineK
  • #821 and #833: The order of arguments for ap has been reversed (now function first)
  • #833: ap on CartesianBuilderN is now apWith
  • #782: State now uses Eval instead of Trampoline for stack safety
  • #697: or for natural transformations is now an instance method
  • #725: orElse on XorT and does not unnecessarily constrain the type of the left side of the result
  • #648: Some types now extend Product and Serializable to improve type inference
  • #647: ProdInstancesN names changed for consistency
  • #636: Eval is now Serializable
  • #685: Fixes for copy-paste errors in method names for instances for Validated
  • #778: Unnecessary type parameter on Foldable's sequence_ has been removed

And additions:

  • #555 and #795: Cartesian
  • #671: Coproduct and Inject
  • #812: ApplicativeError
  • #765: State and Free (and related types) are now in the core module
  • #611: Validated now has an andThen method that provides binding (but without the for-comprehension syntactic sugar that the name flatMap would bring)
  • #796: sequenceU_ and traverseU_ on Foldable
  • #780: transformS for StateT
  • #807: valueOr for XorT
  • #714: orElse for XorT
  • #705: getOrElseF for XorT
  • #731: swap for Validated
  • #571: transform and subflatMap on OptionT and XorT
  • #757 and #843: compose for Alternative and composeK for MonoidK
  • #667: OptionT.liftF

And removals:

  • #613: Free and FreeApplicative constructors are now private
  • #605: filter on Validated
  • #698: MonadCombine instances for OptionT
  • #635: Kleisli's redundant lmap, which was equivalent to local
  • #752: Cokleisli.cokleisli, which was equivalent to Cokleisli.apply
  • #687: Unused XorTMonadCombine
  • #622: Many prioritization types are now private

And new type class instances:

  • #644: Traverse and Foldable instances for XorT
  • #691: Various instances for Function1
  • #628 and #696: Various instances for WriterT
  • #673: Bifunctor instances for WriterT
  • #715 and #716: Semigroup and Monoid instances for Validated
  • #717 and #718: Semigroup instances for Xor and Const
  • #818: CoflatMap instance for Vector
  • #626: Contravariant instances for Const and Kleisli
  • #621: Id instances for Kleisli
  • #772: Reducible instances for OneAnd
  • #816: Traverse instances for OneAnd
  • #639: Traverse instance for Id
  • #774 and #775: Show instances for Vector and Stream

And bug fixes:

  • #623 fixes #563, a bug in the behavior of dropWhile_ on Foldable
  • #665 fixes #662, a bug that resulted in re-evaluation after memoization in Streaming
  • #683 fixes #677, a bug in Streaming.thunk
  • #801: Fixes order effect bug in foldMap on FreeApplicative
  • #798: Fixes bug in filter on StreamingT
  • #656: Fixes bug in drop on StreamingT
  • #769: Improved stack consumption for Eval.Call

And some dependency updates:

  • #833: Update to Simulacrum 0.7.0
  • #764: 2.10 version is now 2.10.6
  • #643: Update to Catalysts 0.2.0
  • #727: Update to Scalastyle 0.8.0

There are also many improvements to the documentation, tutorials, laws, tests, and benchmarks, including the following:

  • #724: sbt-doctest is now used to validate Scaladoc examples
  • #806: Various improvements to use of Simulacrum, which is now a compile-time-only dependency
  • #734: Documentation on testing conventions
  • #710: Documentation for Invariant
  • #832: Updated Free documentation
  • #824: New examples for Foldable
  • #797: Scaladoc examples for methods on Arrow
  • #783 and others: Scaladoc examples for syntax methods
  • #720: Expanded documentation for FreeApplicative
  • #636: Law checking for Eval
  • #649 and #660: Better Arbitrary instances for Streaming and StreamingT
  • #722: More consistent toString for StreamingT
  • #672: Additional laws for Profunctor
  • #668, #669, #679, #680, and #681: Additional law checking for Xor, XorT, and Either
  • #707: Additional testing for State and StateT
  • #736: map / flatMap coherence
  • #748: Left and right identity laws for Kleisli
  • #753: Consistency tests for Cokleisli
  • #733: Associativity laws for Kleisli and Cokleisli composition
  • #741: Tests for Unapply-supported syntax
  • #690: Error reporting improvements for serializability tests
  • #701: Better documentation for the Travis CI script
  • #787: Support for cross-module Scaladoc links

Known issues:

  • #702: This change identified and fixed a stack safety bug in foldMap on Free, but raised other issues (see #712) and was reverted in #713; #721 now tracks the non-stack safety of Free's foldMap

As always thanks to everyone who filed issues, participated in the Cats Gitter channel, submitted code, or helped review pull requests.

Version 0.3.0

2015 November 8

Version 0.3.0 is the third release of the Cats library.

This version includes new type class instances:

  • #545: Semigroup instances for OneAnd
  • #521: Monoid instances for Xor when the left side has a Semigroup instance and the right side has a Monoid
  • #497: Monoid instances for Set
  • #559: Bifunctor instances for Validated, Ior, Xor, and XorT
  • #569: Functor instances for OptionT when F has a Functor instance but not a Monad
  • #600: Show instances for Option and OptionT
  • #601: Show instances for List
  • #602: Show instances for Set
  • #568: Several new Unapply shapes

And API changes:

  • #592: fromTryCatch on Xor and Validated is now catchOnly
  • #553: MonadError now characterizes type constructors of kind * -> * instead of (*, *) -> *
  • #598: OneAnd's type constructor type parameter is now before the element type
  • #610: XorT's toOption returns an OptionT[F, B] instead of an F[Option[B]]
  • #518: Free's resume method now returns an Xor instead of an Either
  • #575 and #606: orElse on Xor and Validated does not unnecessarily constrain the type of the left side of the result
  • #577: *Aux helper classes have been renamed *PartiallyApplied

And additions:

  • #542: WriterT
  • #567: Ior.fromOptions
  • #528: OptionT.fromOption
  • #562: handleErrorWith and related helper methods on MonadError
  • #520: toNel and fromList conversions from List to NonEmptyList
  • #533: Conversions between types with Foldable instances and Streaming
  • #507: isJvm and isJs macros in the new cats.macros.Platform
  • #572: analyze on FreeApplicative for compilation into a Monoid
  • #587: Syntax for lifting values (and optional values) into Validated

And several aliases:

  • #492: FlatMapSyntax now includes followedBy, which is an alias for >>, together with a new followedByEval, which allows the caller to choose the evaluation strategy of the second action
  • #523: Foldable now has a combineAll method that aliases fold and allows postfix usage via FoldableSyntax

And a few removals:

  • #524: FreeApplicative's redundant hoist, which was equivalent to compile
  • #531: Coyoneda's by
  • #612: Many prioritization and instance traits are now private

And bug fixes:

  • #547: The empty values for Monoid[Double] and Monoid[Float] are now 0 instead of 1
  • #530: Streaming.take(n).toList no longer evaluates the n + 1-st element
  • #538: OneAnd's instances are properly prioritized

There are also many improvements to the documentation, tutorials, laws, tests, and benchmarks:

  • #522: ScalaTest's === now uses Eq instances
  • #502: Traverse's laws verify the consistency of foldMap and traverse
  • #519: Benchmarks (and performance improvements) for Eval
  • …and many others

Thanks to everyone who filed issues, participated in the Cats Gitter channel, submitted code, or helped review pull requests.

Version 0.2.0

2015 August 31

Version 0.2.0 is the second release of the Cats library.

The most exciting feature of this release is Scala.js support, which comes courtesy of much hard work by the Scala.js community (especially Alistair Johnson). The SBT build configuration and project layout were updated to support building for both the JVM and JS platforms.

Since the 0.1.2 release there was wide agreement that the split between cats-core and cats-std was awkward. The two projects have been combined into cats-core, meaning that type class instances for common types like List are now available in cats-core.

There was also a concerted effort to improve and add documentation to the project. Many people helped find typos, broken links, and places where the docs could be improved. In particular, the following tutorials were added or overhauled:

  • Applicative
  • Const
  • Foldable
  • Free
  • FreeApplicative
  • Kleisli
  • Monad
  • Monoid
  • Semigroup
  • SemigroupK
  • Traverse
  • Validated
  • Xor

Several new type classes and data types were introduced:

  • Choice[F[_, _]]
  • Group[A]
  • MonadReader[F[_, _], R]
  • Streaming[A] and StreamingT[F[_], A]
  • Prod[F[_], G[_], A] and Func[F[_], A, B]

Syntax tests were added to ensure that existing syntax worked, and there has been some movement to enrich existing types with syntax to make converting them to Cats types easier.

The previous Fold[A] type, which was used to support lazy folds, has been replaced with Eval[A]. This type supports both strict and lazy evaluation, supports lazy map and flatMap, and is trampolined for stack safety. The definition of Foldable#foldRight has been updated to something much more idiomatic and easier to reason about. The goal is to support laziness in Cats via the Eval[A] type wherever possible.

In addition to these specific changes there were numerous small bug fixes, additions, improvements, and updates. Thanks to everyone who filed issues, participated in the Cats Gitter channel, submitted code, or helped review pull requests.

Version 0.1.2

2015 July 17

(Due to problems with publishing 0.1.0 and 0.1.1 are incomplete.)

Version 0.1.2 is the first non-snapshot version of the Cats library! It is intended to assist the creation of dependent libraries and to be an early look at Cats' design.

Much of the library is quite mature, but there are no source- or binary-compatibility guarantees at this time. The overarching design of the library is still somewhat in flux, although mostly we expect there will be new type classes, instances, and syntax. Some package and module boundaries may also shift.

For complete credits, see AUTHORS.md for a list of people whose work has made this release possible.