Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taiansu/pipe_to
The enhanced elixir pipe operator which can specify the target position
https://github.com/taiansu/pipe_to
elixir
Last synced: about 1 month ago
JSON representation
The enhanced elixir pipe operator which can specify the target position
- Host: GitHub
- URL: https://github.com/taiansu/pipe_to
- Owner: taiansu
- License: other
- Archived: true
- Created: 2016-09-09T18:55:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-09-14T15:20:04.000Z (about 3 years ago)
- Last Synced: 2024-08-10T07:35:24.871Z (4 months ago)
- Topics: elixir
- Language: Elixir
- Homepage: https://taiansu.github.io/pipe_to
- Size: 89.8 KB
- Stars: 85
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - The enhanced pipe operator which can specify the target position. (Macros)
- fucking-awesome-elixir - pipe_to - The enhanced pipe operator which can specify the target position. (Macros)
- awesome-elixir - pipe_to - The enhanced pipe operator which can specify the target position. (Macros)
README
[](https://github.com/taiansu/pipe_to/actions)
# Disclaimer
Start from Elixir 1.12.0, we have [Kernel.then/2](https://hexdocs.pm/elixir/1.12.0/Kernel.html#then/2),
which let us pipe into a partial application, nativately. We should follow the official convention
while we could. For example:
```elixir
1
|> then(&Enum.at([1, 2, 3], &1))
5
|> then(&Enum.take(1..10, &1))
|> Enum.reverse()
```
I'll maintain this library for legacy Elixir versions, until they reach their end of lifes.
Thanks for all the starts. Let's move on, live long and prosper.
---
# PipeTo
The enhanced pipe operator which can specify the target position.
## Installation
To use PipeTo with your projects, edit your mix.exs file and add it as a dependency:
```elixir
def deps do
[{:pipe_to, "~> 0.2"}]
end
```
Then run `mix deps.get`
## Quick start
* `import PipeTo` in your module,
* pipe with `~>`
* use `_` to specify the target position of left-hand side expression.
```elixir
> import PipeTo
> 1 ~> Enum.at([1, 2, 3], _)
# 2
```
It works with pipe operator nicely.
```elixir
> 5 ~> Enum.take(1..10, _) |> Enum.reverse()
# [5, 4, 3, 2, 1]
```
In fact, if you don't specify the position with `_`, it acts just like normal `|>`
```elixir
> [4, 8, 1] ~> Enum.max()
# 8
```
## Override the `Kernel.|>/2`
Since `~>` is the enhanced pipe operator, you can override the `Kernel.|>/2` with it.
```elixir
defmodule Foo do
use PipeTo.Override
def bar do
2 |> Enum.drop(1..10, _) |> Enum.at(1)
end
end
Foo.bar
# 4
```
## Performance
use `PipeTo` sightly faster then normal pipe in all these cases below. For the __case 2__ and __case 3__, I will guess
that anonymous function slow down the oridinary pipe. But it doesn't explain why in the _case 1_ `PipeTo` insignificantly faster
then ordinary pipe. Any ideas?
### Case 1: Ordinary Pipe vs PipeTo without index
### Case 2: Pipe with anonymous function vs PipeTo with index
### Case 3: Pipe with anonymous vs use PipeTo.Override
## Disclaimer
I have read through the proposals of pipe operator enhancement on the [elixir-lang-core](https://groups.google.com/forum/#!forum/elixir-lang-core), like [this](https://groups.google.com/forum/#!searchin/elixir-lang-core/pipe$20argument%7Csort:relevance/elixir-lang-core/jKOJ1zUYwaE/SIKql6ybAQAJ), [this](https://groups.google.com/forum/#!searchin/elixir-lang-core/pipe$20argument|sort:relevance/elixir-lang-) or [this](https://groups.google.com/forum/#!searchin/elixir-lang-core/pipe$20argument|sort:relevance/elixir-lang-core/wTK072BdJus/GOUMaUrEEQAJ).
The reason I still want this is because the combination of curried function (or partial application) with pipe operator is so elegant, like [this F# example here](https://fsharpforfunandprofit.com/posts/partial-application/). Since Elixir doesn't have these mechnism, and also anonymous function call use `.()`, so syntactically (well, aesthetically) the only choice I have is to modify the pipe operator.
## Is it any good?
[Yes](https://news.ycombinator.com/item?id=3067434)
## License
Apache 2
## TODO
* Discard the default operator, user should specify the operator expicitly, to work with lib like Witchcraft better.
* Pipe into mutiple target at once
* Pipe into target in nested expression, instead of only the shallowest level like now.