• Stars
    star
    49
  • Rank 585,874 (Top 12 %)
  • Language
    Ruby
  • License
    MIT License
  • Created about 11 years ago
  • Updated about 4 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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

Burgundy

Travis-CI Code Climate Test Coverage Gem Gem

A simple wrapper for objects (think of Burgundy as a decorator/presenter) in less than 150 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.

class UserPresenter < Burgundy::Item
end

Then you can instantiate it:

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.

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.

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.

You may need to provide additional arguments to the item class. On your collection, all additional arguments will be delegated to the item classe, like the following example:

WorkshopPresenter.wrap(Workshop.all, current_user)
Burgundy::Collection.new(Workshop.all, WorkshopPresenter, current_user)

class WorkshopPresenter < Burgundy::Item
  def initialize(workshop, current_user)
    super(workshop)
    @current_user = current_user
  end
end

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

<%= 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

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

You can map attributes into a hash; I use this strategy for using presenters on API responses (so I can skip adding yet another dependency to my project).

class UserPresenter < Burgundy::Item
  attributes :username, :name, :email

  def profile_url
    routes.profile_url(item.username)
  end
end

UserPresenter.new(User.first).attributes
#=> {:username=>'johndoe', :name=>'John Doe', :email=>'[email protected]'}

UserPresenter.new(User.first).to_hash
#=> {:username=>'johndoe', :name=>'John Doe', :email=>'[email protected]'}

UserPresenter.new(User.first).to_h
#=> {:username=>'johndoe', :name=>'John Doe', :email=>'[email protected]'}

UserPresenter.new(User.first).as_json
#=> {:username=>'johndoe', :name=>'John Doe', :email=>'[email protected]'}

Notice that as_json will ignore any options provided.

If you want to remap an attribute, provide a hash.

class UserPresenter < Burgundy::Item
  attributes :name, :email, :username => :login

  def profile_url
    routes.profile_url(item.username)
  end
end

UserPresenter.new(User.first).attributes
#=> {:login=>'johndoe', :name=>'John Doe', :email=>'[email protected]'}

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

License

Copyright (c) 2013 Nando Vieira

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

More Repositories

1

i18n-js

It's a small library to provide the I18n translations on the Javascript. It comes with Rails support.
Ruby
3,702
star
2

browser

Do some browser detection with Ruby. Includes ActionController integration.
Ruby
2,388
star
3

kitabu

A framework for creating e-books from Markdown using Ruby. Using the Prince PDF generator, you'll be able to get high quality PDFs. Also supports EPUB, Mobi, Text and HTML generation.
Ruby
659
star
4

recurrence

A simple library that handles recurring events.
Ruby
556
star
5

sparkline

Generate SVG sparklines with JavaScript without any external dependency.
JavaScript
501
star
6

paypal-recurring

PayPal Express Checkout API Client for recurring billing.
Ruby
257
star
7

cpf_cnpj

πŸ‡§πŸ‡· Validate, generate and format CPF/CNPJ numbers. Include command-line tools.
Ruby
220
star
8

password_strength

Check password strength against several rules. Includes ActiveRecord/ActiveModel support.
JavaScript
182
star
9

cpf

πŸ‡§πŸ‡· Validate, generate and format CPF numbers
TypeScript
161
star
10

pagseguro

Um plugin para o Ruby on Rails que permite utilizar o PagSeguro
Ruby
141
star
11

coupons

Coupons is a Rails engine for creating discount coupons.
Ruby
140
star
12

cpf_cnpj.js

Validate, generate and format CPF/CNPJ numbers
JavaScript
118
star
13

i18n

A small library to provide the I18n translations on the JavaScript.
TypeScript
113
star
14

uptime_checker

Check if your sites are online for $7/mo.
112
star
15

module

Define namespaces as constructor functions (or any object).
JavaScript
105
star
16

qe

A simple interface over several background job libraries like Resque, Sidekiq and DelayedJob.
Ruby
102
star
17

has_calendar

A view helper that creates a calendar using a table. You can easily add events with any content.
Ruby
101
star
18

sinatra-subdomain

Separate routes for subdomains in Sinatra apps
Ruby
96
star
19

validators

Some ActiveModel/ActiveRecord validators
Ruby
96
star
20

dotfiles

My dotfiles
Shell
88
star
21

rack-api

Create web app APIs that respond to one or more formats using an elegant DSL.
Ruby
86
star
22

notifier

Send system notifications on several platforms with a simple and unified API. Currently supports Notification Center, Libnotify, OSD, KDE (Knotify and Kdialog) and Snarl
Ruby
84
star
23

factory_bot-preload

Preload factories (factory_bot) just like fixtures. It will be easy and, probably, faster!
Ruby
83
star
24

cnpj

πŸ‡§πŸ‡· Validate, generate and format CNPJ numbers
TypeScript
81
star
25

dispatcher-js

Simple jQuery dispatcher for web apps.
JavaScript
75
star
26

gem-open

Open gems into your favorite editor by running a specific gem command
Ruby
69
star
27

test_notifier

Display system notifications (dbus, growl and snarl) after running tests. It works on Mac OS X, Linux and Windows. Powerful when used with Autotest ZenTest gem for Rails apps.
Ruby
63
star
28

test_squad

Running JavaScript tests on your Rails app, the easy way.
Ruby
56
star
29

vscode-linter

Extension for code linting, all in one package. New linters can be easily added through an extension framework.
TypeScript
56
star
30

has_friends

Add friendship support to Rails apps with this plugin
Ruby
55
star
31

breadcrumbs

Breadcrumbs is a simple Rails plugin that adds a breadcrumbs object to controllers and views.
Ruby
55
star
32

minitest-utils

Some utilities for your Minitest day-to-day usage.
Ruby
52
star
33

photomatic

Your photography is what matters.
Ruby
50
star
34

normalize_attributes

Sometimes you want to normalize data before saving it to the database like down casing e-mails, removing spaces and so on. This Rails plugin allows you to do so in a simple way.
Ruby
49
star
35

ar-uuid

Override migration methods to support UUID columns without having to be explicit about it.
Ruby
46
star
36

rubygems_proxy

Rack app for caching RubyGems files. Very useful in our build server that sometimes fails due to our network or rubygems.org timeout.
Ruby
43
star
37

post_commit

Post commit allows you to notify several services with a simple and elegant DSL. Five services are supported for now: Basecamp, Campfire, FriendFeed, LightHouse and Twitter.
Ruby
42
star
38

permalink

Add permalink support to Rails apps with this plugin
Ruby
40
star
39

keyring-node

Simple encryption-at-rest with key rotation support for Node.js.
JavaScript
39
star
40

superconfig

Access environment variables. Also includes presence validation, type coercion and default values.
Ruby
38
star
41

sublime-better-ruby

Sublime Text Ruby package (snippets, builder, syntax highlight)
Ruby
37
star
42

simple_presenter

A simple presenter/facade/decorator/whatever implementation.
Ruby
33
star
43

voltage

A simple observer implementation on POROs (Plain Old Ruby Object) and ActiveRecord objects.
Ruby
31
star
44

redis-settings

Store application and user settings on Redis. Comes with ActiveRecord support.
Ruby
31
star
45

tokens

Add token support to Rails apps with this plugin
Ruby
31
star
46

boppers

A simple bot framework for individuals.
Ruby
29
star
47

babel-schmooze-sprockets

Add Babel support to sprockets using Schmooze.
JavaScript
29
star
48

streamdeck

A lean framework for developing Elgato Stream Deck plugins.
TypeScript
28
star
49

sublime-text

My SublimeText settings
26
star
50

has_ratings

Add rating support to Rails apps with this plugin
Ruby
25
star
51

commentable

Add comment support to Rails apps with this plugin
Ruby
23
star
52

sinatra-basic-auth

Authentication with BasicAuth that can require different credentials for different realms.
Ruby
23
star
53

rails-routes

Enable config/routes/*.rb on your Rails application.
Ruby
23
star
54

swiss_knife

Here's my swiss-knife Rails helpers.
Ruby
21
star
55

aitch

A simple HTTP client.
Ruby
21
star
56

messages-app

Use alert messages in your README.
HTML
19
star
57

rails-env

Avoid environment detection on Rails
Ruby
19
star
58

svg_optimizer

Some SVG optimization based on Node's SVGO
Ruby
18
star
59

defaults

Add default value for ActiveRecord attributes
Ruby
18
star
60

ar-check

Enable PostgreSQL's CHECK constraints on ActiveRecord migrations
Ruby
17
star
61

email_data

This project is a compilation of datasets related to emails. Includes disposable emails, disposable domains, and free email services.
Ruby
17
star
62

simple_auth

SimpleAuth is an authentication library to be used when everything else is just too complicated.
Ruby
17
star
63

attr_keyring

Simple encryption-at-rest with key rotation support for Ruby.
Ruby
17
star
64

has_bookmarks

Add bookmark support to Rails apps with this plugin
Ruby
17
star
65

sublime-text-screencasts

Screencasts sobre Sublime Text
HTML
17
star
66

paginate

Paginate collections using SIZE+1 to determine if there is a next page. Includes ActiveRecord and ActionView support.
Ruby
16
star
67

pry-meta

Meta package that requires several pry extensions.
Ruby
15
star
68

react-starter-pack

Starter-pack for react + webpack + hot reload + mocha + enzyme + production build
JavaScript
15
star
69

check_files

Check non-reloadable files changes on Rails apps.
Ruby
15
star
70

url_signature

Create and verify signed urls. Supports expiration time.
Ruby
15
star
71

activities

Activities is a gem that enables social activities in ActiveRecord objects.
Ruby
14
star
72

using-es6-with-asset-pipeline-on-ruby-on-rails

Example for my article about ES6 + Asset Pipeline
Ruby
14
star
73

whiteboard

A small app using Canvas + Socket.IO to provide a shared whiteboard.
JavaScript
14
star
74

sublime-better-rspec

Better RSpec syntax highlighting, with matchers for v3. Also includes implementation/spec toggling command.
Python
13
star
75

ar-sequence

Add support for PostgreSQL's SEQUENCE on ActiveRecord migrations.
Ruby
13
star
76

page_meta

Easily define <meta> and <link> tags. I18n support for descriptions, keywords and titles.
Ruby
13
star
77

boppers-uptime

A bopper to check if your sites are online.
Ruby
13
star
78

has_versions

A simple plugin to version ActiveRecord objects
Ruby
13
star
79

csr

Generate CSR (Certificate Signing Request) using Ruby and OpenSSL.
Ruby
13
star
80

haikunate

Generate Heroku-like memorable random names like adorable-ox-1234.
Ruby
13
star
81

module-component

Define auto-discoverable HTML UI components using Module.js.
JavaScript
12
star
82

alfred-workflows

Alfred workflows
12
star
83

twitter_cleanup

Remove old tweets periodically using Github Actions
Ruby
12
star
84

storage

This gem provides a simple API for multiple storage backends. Supported storages: Amazon S3 and FileSystem.
Ruby
12
star
85

has_layout

Add conditional layouts with ease
Ruby
11
star
86

kalendar

A view helper that creates a calendar using a table. You can easily add events with any content.
Ruby
11
star
87

stellar-paperwallet

Make paper wallets to keep your Stellar addresses safe.
JavaScript
10
star
88

tagger

Tagging plugin for Ruby on Rails apps
Ruby
10
star
89

page_title

Set the page title on Rails apps.
Ruby
10
star
90

dogo

A simple URL shortener service backed by Redis.
Ruby
10
star
91

has_notifications

This plugin was created to act as a proxy between different notification systems (Mail, Jabber, etc) based on the user's preferences.
Ruby
10
star
92

formatter

has_markup is an ActiveRecord plugin that integrates Tidy, Markdown, Textile and sanitize helper method into a single plugin.
Ruby
10
star
93

ar-enum

Add support for creating `ENUM` types in PostgreSQL with ActiveRecord
Ruby
9
star
94

shortcuts

Because mouse is for noobies.
Ruby
9
star
95

ar-timestamptz

Make ActiveRecord's PostgreSQL adapter use timestamptz as datetime columns.
Ruby
9
star
96

parsel-js

Encrypt and decrypt data with a given key.
JavaScript
8
star
97

ember-and-rails

Ruby
8
star
98

access_token

Access token for client-side and API authentication.
Ruby
8
star
99

sinatra-oauth-twitter

Sample app used on Guru-SP meetup
Ruby
8
star
100

need_help

A simple help/FAQ system using Rails Engine.
Ruby
8
star