Add ᐅ piping method to Ruby for an Elixir feel. First parameter must be an object that responds to :call.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
test
.codeclimate.yml
.gitignore
.rubocop.yml
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
elixirize.gemspec

README.md

Gem Version Code Climate Build Status Test Coverage Inline docs SayThanks.io

Elixirize

This adds the method to Ruby. It pipes in the returned value of the left as the first parameter of the Proc (or anything with :call defined) on the right.

Unicode ᐅ

To enter ᐅ you need to:

  • Linux: type CTRl-SHIFT-U and then 1405 followed by the Space or Enter key.
  • Mac: hold the Option key while you type 1405 and then release the Option key.
  • VIM: press CTRL-v then SHIFT-U then 1405 and hit Enter.
  • Emacs: press CTRL-x then 8 then Enter and type 1405 and hit Enter.

Installation

Add this line to your application's Gemfile:

gem 'elixirize'

And then execute:

$ bundle

Or install it yourself as:

$ gem install elixirize

Usage

def add a, b
  a + b
end

subtract = ->a, b{ a - b }

add(4, 5).ᐅ subtract, 15
# => -6

def divide a, b
  a / b
end

add(40, 60).ᐅ method(:divide), 20
# => 5

Extra

Since Ruby is designed largely to call methods on the object that was returned I've written the ~ method on Symbol to allow method calls on the returned object rather than only being the first parameter passed in.

Example:

s = "a b c d"
val = s.
  ᐅ(~:split, " ").
  ᐅ(~:join, "-").
  ᐅ ~:capitalize

val
# => "A-b-c-d"

You can mix both behaviors without any issue.

This may seem counter intuitive as it's the same thing as just calling the method on the object, but consider this a noticeable refactoring step. If you're designing a project in a manner where you want results piped in as the first parameter then the tilde-symbol will be your TODO reminder to convert/refactor how your code base is implemented.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/danielpclark/elixirize.

License

The gem is available as open source under the terms of the MIT License.