netzke-draper

netzke-draper is a simple extension for all netzke components, that use the data accessor module (e.g. GridPanel). It automatically decorates your record(s) with a given decorator or one that matches the default naming convention.

Installation

In Rails 3 add this to your gem file and run the bundle command.

gem 'netzke-draper'

Usage

Simply set the class of your decorator of choice in the netzke configure method.

Example

Given the following grid panel:

class BooksGridPanel < Netzke::Basepack::GridPanel

  def configure(c)
    c.model = 'Book'
    c.decorator = 'BookDecorator'
  end

end

and a decorator class for your book model:

class BookDecorator < Draper::Base

  decorates :book

  def funky_title
    "#{title} - BOOM!"
  end

end

Now you can use all decorator methods (in this case funky_title) in your column definitions of the grid panel, since it automatically wraps all records with your decorator:

class BooksGridPanel < Netzke::Basepack::GridPanel

  # [...]

  column :funky_title do |c|
    c.text = "Funky Title"
  end
end

Which decorator will be used?

If you define a decorator in your config, that one will be used:

  def configure(c)
      c.decorator = 'YourDecorator'
  end

If no decorator is defined, it will try to gues your decorator's class by appending 'Decorator' to your model class.
If you set c.decorator to false, it won't decorate anything, even if a guess would be successful.
You can also disable the default usage of a decorator with an initializer. In this case, only if there is an explicit definition of a decorator in the configuration, it will decorate your records:

  # config/initializers/netzke-draper.rb
  Netzke::Draper.configure do |config|
      config.decorate_by_default = false
  end

Contributing to netzke-draper