bow-swift / bow Goto Github PK

Description

Add API reference for Ior data type.

A few issues with how Bow uses operators:

• All the custom operators introduced use the same precedence group that ships with Swift (AdditionPrecedence). This prevents them from playing nicely with one another. For example, a Kleisli chain with pure compositions requires parenthesizing when >>> should take precedence over >=>.

  f
    >>> impureG
    >=> pureH
    >>> impureI
    >=> impureJ

• Data defines infix operator >>=, but Swift already ships with >>= for bitwise shift assignment. Swift libraries tend to define >>- or >>>= instead as a result. In general, >>= seems less useful in Swift because you can define flatMap as an infix method, preserving readability where bind creates nesting.

• Optics overloads + for composition. It might make more sense to use <<< or introduce a new operator. PureScript's profunctor package once defined .., though they use plain-ole <<< these days.

Description

Add API docs for Typeclass.

One relevant thing could be integrate code coverage in the project.
Mode info: https://github.com/codecov/example-swift

What do you think?

I can do it if you are agree.

Write a document with guidelines for new contributors.

Description

Add API reference for Either data type.

Description

Add API docs for Curry.

Add RxSwift support to the Effects package, similar to the Arrow counterpart with RxJava 2.

The purpose is to implement typeclasses with less boilerplate.

Description

Add API reference for ArrayK data type.

Swift can define ap in a much more readable (left-to-right, non-nested) format that matches Haskell. By introducing a generic at function scope we can constrain F's A to be a function between generics:

-public func ap<B>(_ ff: F<(A) -> B>) -> F<B>
+public func ap<A1, B>(_ fa: F<A1>) -> F<B> where A == (A1) -> B

And in practice:

Option.pure(add).ap(one).ap(two)

// vs. the right-to-left, awkwardly nested:
two.ap(one.ap(Option.pure(add)))

FWIW many functional libraries in Swift introduce the <*> operator, as another option. That could be an alternate consideration if the inconsistency with Arrow is an issue, though I assume Bow should be optimized for Swift syntax in general.

Description

Add API docs for Memoization.

The description of the Podfile publishes only the Swift files that are on Sources/Bow, but not in the subfolders. Therefore, only the files on the top level folder are published.

Description

Add API docs for Predef.

Add API docs for MaybeInstances

Description

Add API documentation for BooleanFunctions.

The current implementation forces users of the library to depend on RxSwift and BrightFutures. We should split it into three:

• Bow
• Bow-Rx
• Bow-BrightFutures

Any other integration with other libraries should as well be kept separately, so that users do not need to depend on unnecessary stuff.

Description

Add API documentation for NumberInstances.

My iOS friends are about to try Bow but we are a little bit confused about naming of Option/Maybe.
Arrow for Kotlin is using Option, Bow is using Maybe and name Option is used for nullable types T?
Maybe is also in conflict with RxSwift's Maybe.

What are the reasons for using Maybe instead of Option in Bow?

Thanks for any hint!

We need to define and test/document/describe the flow to automate the Bow documentation generation and its website deployment process.

Missing things regarding optics:

• Typeclasses: At, Each, FilterIndex, Index
• Optics: Fold, Getter, Iso, Lens, Optional, Prism, Setter, Traversal
• Laws for all optics

Description

Add API docs for Reverse.

Description

Add API docs to Kind.

Add an issue template with common sections.

Hi there folks,

We should add the Google Analytics tracker to our websites to have more information about the visits and the impact of our library (and in the future to all the Gdocs to see how it works and how to improve it).

Here I attach the tracker we have to add it to the head of the site

<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-18433785-19"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'UA-18433785-19');
</script>

Cheers!

Currently, the library can be consumed via CocoaPods and Carthage. We need to update Swift Package Manager file (Package.swift) and make sure the library can be consumed using this tool.

I will create a Jekyll site

Cocoapods is complaining because we don't have a license file.

Create API reference for Option.

Documents methods and instances for Id.

Currently, the Xcode project only includes BowTests as a test target. We need to add all our tests targets as schemes.

If you are documenting one of these classes, create a separate issue and assign it to yourself so that everyone knows what is being done.

We will keep track of what is documented here. For now, I will list all current classes in the library. We should also generate the HTML documents based on this (perhaps using Jazzy or similar). Sorted by priority and with an indicator of difficulty (📗 easy, 📒 medium, 📕 hard to document):

Data

• Action 📕
• ArrayK 📗
• CoT 📕
• Const 📗
• Coproduct 📒
• Coreader 📒
• CoSum 📕
• Day 📕
• DictionaryK 📗
• Either 📗
• Endo 📒
• Eval 📗
• Id 📗
• Ior 📗
• Moore 📕
• NonEmptyArray 📗
• Option 📗
• Pairing 📕
• Puller 📕
• Reader 📗
• SetK 📗
• State 📗
• Sum 📕
• Trampoline 📒
• Try 📗
• Validated 📗
• Zipper 📕

Instances

• BoolInstances 📗
• OptionInstances 📗
• NumberInstances 📗
• StringInstances 📗

Syntax

• HigherKinds 📒
• BooleanFunctions 📗
• Curry 📗
• Memoization 📗
• PartialApplication 📗
• Predef 📗
• Reverse 📗

Typeclasses

• Alternative 📒
• Applicative 📗
• ApplicativeError 📗
• Bimonad 📒
• Comonad 📒
• ComonadEnv 📒
• ComonadStore 📒
• ComonadTraced 📒
• ComonadTrans 📒
• Contravariant 📗
• Decidable 📗
• Divide 📗
• Divisible 📗
• EquatableK 📗
• Foldable 📒
• Functor 📗
• FunctorFilter 📗
• Invariant 📗
• Monad 📗
• MonadCombine 📗
• MonadError 📗
• MonadFilter 📗
• MonadReader 📒
• MonadState 📒
• MonadWriter 📒
• Monoid 📗
• Monoidal 📗
• MonoidK 📗
• NonEmptyReducible 📗
• Reducible 📗
• Selective 📒
• Semigroup 📗
• SemigroupK 📗
• Semiring 📗
• Traverse 📒
• TraverseFilter 📒

Transformers

• EitherT 📒
• OptionT 📒
• StateT 📒
• WriterT 📒
• StoreT 📕
• TracedT 📕
• EnvT 📕

Effects

• Atomic 📒
• IO 📒
• Ref 📒
• Resource 📒

Effects/Foundation

• ConsoleIO 📗
• FileManager
• URLSession 📗

Effects/Rx

• MaybeK 📒
• ObservableK 📒
• SingleK 📒

Effects/Typeclasses

• Async 📒
• Bracket 📒
• Concurrent 📒
• ConcurrentEffect 📒
• Effect 📒
• MonadDefer 📒
• UnsafeRun 📒
• EffectComprehensions 📒

Arrow

• Cokleisli 📒
• Function0 📗
• Function1 📗
• FunctionK 📒
• Kleisli 📒

Optics/Typeclasses

• At 📒
• Cons 📒
• Each 📒
• FilterIndex 📒
• Index 📒
• Snoc 📒

Optics

• BoundSetter 📒
• Fold 📒
• Getter 📒
• Iso 📒
• Lens 📒
• Optional 📒
• Prism 📒
• Setter 📒
• Traversal 📒

Optics/DSL

• At+Optics 📒
• Each+Optics 📒
• Index+Optics 📒
• Kind+Optics 📒

Optics/Instances

• ArrayKOpticsInstances 📒
• ArrayOpticsInstances 📒
• ConstOpticsInstances 📒
• EitherKOpticsInstances 📒
• EitherOpticsInstances 📒
• IdOpticsInstances 📒
• IorOpticsInstances 📒
• OptionOpticsInstances 📒
• NonEmptyArrayOpticsInstances 📒
• StringOpticsInstances 📒
• TryOpticsInstances 📒
• ValidatedOpticsInstances 📒

Optics/STD

• Either+Optics 📗
• Id+Optics 📗
• Ior+Optics 📗
• ArrayK+Optics 📗
• Option+Optics 📗
• NonEmptyArray+Optics 📗
• Result+Optics 📗
• String+Optics 📗
• Try+Optics 📗
• Validated+Optics 📗

Optics/Tuple

• Tuple2 📗
• Tuple3 📗
• Tuple4 📗
• Tuple5 📗
• Tuple6 📗
• Tuple7 📗
• Tuple8 📗
• Tuple9 📗
• Tuple10 📗

Optics/Auto

• AutoFold 📗
• AutoGetter 📗
• AutoLens 📗
• AutoOptics 📗
• AutoOptional 📗
• AutoPrism 📗
• AutoSetter 📗
• AutoTraversal 📗

Free

• Cofree 📕
• Coyoneda 📕
• Free 📕
• Yoneda 📕

RecursionSchemes

• Recursion 📕

RecursionSchemes/Data

• Fix 📕
• Mu 📕
• Nu 📕

RecursionSchemes/Typeclasses

• Birecursive 📕
• Corecursive 📕
• Recursive 📕

Generic

• Generic 📕
• HList 📕
• Product 📕
• Coproduct2 📕
• Coproduct3 📕
• Coproduct4 📕
• Coproduct5 📕
• Coproduct6 📕
• Coproduct7 📕
• Coproduct8 📕
• Coproduct9 📕
• Coproduct10 📕

Description

Add API docs for PartialApplication.

Add API docs for BoolInstances.swift

@truizlop Maybe Israel and Calvellido can help with this but this is largely influenced by the options and choices you have on Swift.

I've made a first pass review of the library to see what is missing and I've found some things

Optics

• basically everything

Data

• Sequence

Free

• FreeApplicative
• Trampoline

Effects

• Rx

I didn't check in depth to see if there are methods missing yet
@raulraja

Add a PR template with common sections.

Adding some frameworks through Carthage has polluted a little bit the project and it needs to be cleaned.

Description

There are some data types that match names in Arrow but are not aligned with how they are called in Swift. The following data types should be renamed to:

• ListK -> ArrayK
• MapK -> DictionaryK
• NonEmptyList -> NonEmptyArray

It looks like not all the files are included in every target; therefore, building the library for other targets (like watchOS) fails to find some of the files.

Description

Add API docs to StringInstances.

Made the library compatible with the 3 most used dependency managers:

• Cocoapods
• Carthage
• Swift Package manager

• ev() -> fix()
• HK -> Kind
• DataF -> ForData

Write a code of conduct for the repository.

Operators >=> and >>= were marked as deprecated in the previous release. We are deleting them for next version.