Fetching contributors…
Cannot retrieve contributors at this time
197 lines (137 sloc) 4.35 KB


Ruby library that helps you to build and represent table-like data with:

  • Customizable filtering
  • Columns
  • Sort order
  • Localization
  • Export to CSV

ORM Support

  • ActiveRecord
  • Mongoid
  • MongoMapper

Create an issue if you want more.

Live Demo

Datagrid DEMO application is available live! Demo source code.


In order to create a grid:

class SimpleReport

  include Datagrid

  scope do

  filter(:category, :enum, :select => ["first", "second"])
  filter(:disabled, :eboolean)
  filter(:confirmed, :boolean)
  filter(:group_id, :integer, :multiple => true)
  integer_range_filter(:logins_count, :integer)
  filter(:group_name, :string, :header => "Group") do |value|
    self.joins(:group).where(:groups => {:name => value})

  column(:group, :order => "") do |user|
  column(:active, :header => "Activated") do |user|


Basic grid api:

report =
        :group_id => [1,2], :from_logins_count => 1, 
        :category => "first",
        :order => :group,
        :descending => true

report.assets # => Array of User instances: 
              # SELECT * FROM users WHERE users.group_id in (1,2) AND users.logins_count >= 1 AND users.category = 'first' ORDER BY DESC

report.header # => ["Group", "Name", "Activated"]
report.rows   # => [
              #      ["Steve", "Spammers", true],
              #      [ "John", "Spoilers", true],
              #      ["Berry", "Good people", false]
              #    ]   # => [ header, *rows]

report.to_csv # => Yes, it is

Grid DSL

In order to create a report, you need to define:

  • scope of objects to look through
  • filters that will be used to filter data
  • columns that should be displayed and sortable (if possible)


Default scope of objects to filter and display. In common case it is ActiveRecord::Base (or any other supported ORM) subclass with some generic scopes like in example above:

  scope do

More about scope


Each filter definition consists of:

  • name of the filter
  • type that will be used for value typecast
  • conditions block that applies to defined scope
  • additional options

Datagrid supports different type of filters including:

  • text
  • integer
  • date
  • boolean
  • eboolean - the select of "yes", "no" and any
  • enum
  • string

More about filters


Each column is represented by name and code block to calculate the value.

column(:activated, :header => "Active", :order => "activated") do

Some formatting options are also available. Each column is sortable.

More about columns

Front end

In order to create form for your report you can use all set of rails built-in tools. More over Datagrid provides you two additional form helpers:

  • datagrid_label
  • datagrid_filter

The easiest way to create a report form: (haml for readablity)

# Method `GET` is recommended for all report forms by default.
- form_for @report, :html => {:method => :get} do |f|
  - @report.filters.each do |filter|
      = f.datagrid_label filter
      = f.datagrid_filter filter
  = f.submit

Your controller:

map.resources :simple_reports, :only => [:index]

class SimpleReportsController < ApplicationController
  def index
    @report =[:simple_report])

There is a simple helper set of helpers that allows you display report: (require any pagination gem, will_paginate is used as an example)

- assets = @report.assets.paginate(:page => params[:page])

%div== Total #{assets.total_entries}
= datagrid_table(@report, assets)
= will_paginate assets

If you need a custom interface for your report you should probably build it yourself with datagrid helpers.

More about frontend


Like datagrid?

Follow the repository on GitHub.

Read author blog.