Contents

# Option

A Ruby port of Scala's Option monad. Tries to be faithful
but also pragmatic in RE: to duck typing.

Blog post: http://robares.com/2012/09/16/ruby-port-of-scala-option/

## Installation

Add this line to your application's Gemfile:

    gem 'option'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install option

## Usage

Generally, you want to use the Option(A) wrapper method to box
your value. This will make the right decision as to what your initial
value should be:

```ruby
foo = Option("bar")
```

This will allow you to now manipulate the value in the box via various means:

```ruby

# get the value
foo.get #=> "bar"

# return a default if the box is None
None.get_or_else { "default" } #=> "default"

# map the value to another option
foo.map { |v| v.upcase } #=> Some("BAR")

# does the value meet a requirement?
foo.exists? { |v| v == "bar" } #=> true

# return the value or nil depending on the state
foo.or_nil #=> "bar"

# chain values
foo.map { |v| v * 2 }.map { |v| v.upcase }.get_or_else { "missing" } #=> BARBAR

# attempt to extract a value but default if None
None.fold(-> { "missing" }) { |v| v.upcase } #=> missing

# filter values returning an option
foo.filter { |v| v == "baz" } #=> None

# Side-effects
foo.inside { |v| v.upcase! } #=> Some("BAR")

# use in a for loop
for value in foo
  puts value #=> bar
end
```

## Build Status
[![Travis CI](https://secure.travis-ci.org/rares/option.png)](http://travis-ci.org/rares/option)

## Code Climate
[![Code Climate](https://codeclimate.com/github/rares/option.png)](https://codeclimate.com/github/rares/option)

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Implement your feature. Patches not considered without accompanying tests.  
4. Commit your changes (`git commit -am 'Added some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create new Pull Request

Version data entries

2 entries across 2 versions & 2 rubygems

Version	Path
camertron-option-1.0.0	README.md
option-1.2.0	README.md