Contents

# Burgundy

A simple wrapper for objects (think of Burgundy as a decorator/presenter) in less than 100 lines.

## Installation

Add this line to your application's Gemfile:

    gem 'burgundy'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install burgundy

## Usage

First, define your wrapping class.

```ruby
class UserPresenter < Burgundy::Item
end
```

Then you can instantiate it:

```ruby
user = UserPresenter.new(User.first)
```

The `Burgundy::Item` has access to helper and route methods. Notice that the wrapper item is accessible through the `Burgundy::Item#item` method.

```ruby
class UserPresenter < Burgundy::Item
  def profile_url
    routes.profile_url(item.username)
  end
end
```

You don't have to expose attributes; everything is delegated to the wrapped item.

To wrap an entire collection, just use the `Burgundy::Collection` class.

```ruby
class WorkshopsController < ApplicationController
  def index
    @workshops = Burgundy::Collection.new(
      Workshop.sorted_by_name,
      WorkshopPresenter
    )
  end
end
```

or just call `WorkshopPresenter.wrap(Workshop.sorted_by_name)`. Both ways return a `Burgundy::Collection` instance.

The query will be performed only when needed, usually on the view. The collection is an enumerable object and can be passed directly to the `render` method. Each item will be wrapped by the provided class.

```erb
<%= render @workshops %>
```

Route URLs may require the default url options. Burgundy try to get them from the following objects:

* `Rails.configuration.action_mailer.default_url_options`
* `Rails.application.routes.default_url_options`

So you can just put this on your environment file

```ruby
config.action_controller.default_url_options = {
  host: "example.org"
}
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
burgundy-0.0.3	README.md