https://github.com/tiagopog/piped_ruby

Pipe things in Ruby
https://github.com/tiagopog/piped_ruby

Last synced: 3 months ago
JSON representation

Pipe things in Ruby

• Host: GitHub
• URL: https://github.com/tiagopog/piped_ruby
• Owner: tiagopog
• License: mit
• Created: 2016-05-31T22:53:57.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-07-13T20:24:44.000Z (almost 8 years ago)
• Last Synced: 2024-03-18T03:49:01.626Z (3 months ago)
• Language: Ruby
• Homepage:
• Size: 24.4 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Lists

• awesome-pipe - piped_ruby - Pipe things in Ruby (Ruby)

README

        
# Piped Ruby

[![Code Climate](https://codeclimate.com/github/tiagopog/piped_ruby/badges/gpa.svg)](https://codeclimate.com/github/tiagopog/piped_ruby)

[![Build Status](https://travis-ci.org/tiagopog/piped_ruby.svg?branch=master)](https://travis-ci.org/tiagopog/piped_ruby)

```ruby

-> { 'Pipe' }

  .>> { |e| "#{e} things"  }

  .>> { |e| "#{e} in Ruby!" }

  .unwrap #=> "Pipe things in Ruby!"

```

Piped Ruby is a tiny piece of code that aims to bring the beauty of pipe operators and data transformation to your Ruby application.

Credit to [Elixir's Pipe Operator](http://elixir-lang.org/getting-started/enumerables-and-streams.html#the-pipe-operator) and [Chainable Methods](https://github.com/akitaonrails/chainable_methods) gem which were the source of inspiration for this gem :-)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'piped_ruby'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install piped_ruby

And require the gem manually:

```ruby

require 'piped_ruby'

```

## Usage

With Piped Ruby doing this:

```ruby

-> { some_text.upcase }

  .>> { |e| MyModule.method_a(e) }

  .>> { |e| MyModule.method_b(e, "something") }

  .>> { |e| MyModule.method_c(e) { |c| do_something3(c) } }.unwrap

```

...is the same of doing this:

```ruby

a = some_text.upcase

b = MyModule.method_a(a)

c = MyModule.method_b(b, "something")

d = MyModule.method_c(c) { |c| do_something3(c) }

```

Let's take for example a method which imports records from a CSV file:

```ruby

#...

def call

  File.foreach(file) do |line|

    -> { values_from(line) }

      .>> { |values| match_fields_for(values) }

      .>> { |fields| sanitize(fields) }

      .>> { |fields| Save.new(attributes: fields).call }.unwrap

  end

end

```

The equivalent form would be this:

```ruby

#...

def call

  File.foreach(file) do |line|

    values = values_from(line) }

    fields = match_fields_for(values)

    fields = sanitize(fields)

    Save.new(attributes: fields).call

  end

end

```

## Backstage

Pipe operations happen between Proc objects (blocks). After requiring the gem every Proc in your Ruby program will be capable to start a pipe operation.

```ruby

operation = -> { 'Foo' }.>> { |e| "#{e}bar" }

operation.class #=> Proc

operation.unwrap #=> "Foobar"

```

The `PipedRuby#unwrap` method is the way to get the returning value from the last evaluated block:

```ruby

operation = -> { 'Foo' }.>> { |e| "#{e}bar" }

operation.>> { |e| puts e } #=> Prints "Foobar" and returns a Proc object

operation.>> { |e| puts e }.unwrap #=> Prints "Foobar" and returns nil

```

## TODO

- [ ] Write more cool examples in README;

- [ ] Introduce something similar to Elixir's Streams.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/piped_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).