Sequel::Reporter

Sequel::Reporter is a small opinionated framework for writing web-based reports using the Sequel database toolkit. It provides a simple structure and helpers for easily writing reports. There's a tiny demo if you want to see an example.

$ gem install sequel-reporter

Generate a new reporting project using the sequel-reporter binary:

$ sequel-reporter new foo
$ cd foo
$ bundle install
$ bundle exec rackup

Then navigate your browser to http://localhost:9292

Reports are erb files located in views/reports. Here's a very simple example report:

<% @query = query do %>
  select "pete" as name, 28 as age
<% end %>
<%= table @query %>

The query helper takes a block of SQL and returns a Sequel::Reporter::Report instance. It can take a few options:

• :pivot is the name of a column to pivot the report on.
• :pivot_sort_order says how to order the resulting pivoted columns. Can be asc or desc. Defaults to asc.

Sequel Reporter uses Twitter Bootstrap for formatting, so you can use whatever you want to format your reports from there.

The table helper takes a query produced by the query helper and some options and builds an HTML table. This helper can take an optional block where you can set more options on the table. For example:

<%= table(@query) do |t|
  t.link /Account/ => '/register?account=:this'
  t.decorate /Amount/ => Sequel::Reporter::NumberDecorator.new
end %>

The link method links columns matching the given regex to the given URL pattern. URL patterns can reference the value in the current cell using :this, the current date with :now, the title of the column with :title, and any other value from the row using :N, where N is the 0-indexed row index. You can write your own decorators. See sequel-reporter/decorators.rb for examples.

Sometimes writing a report in a erb file isn't the most convenient thing. If you want, you can write the query portion of a report as a class and put it in the lib directory. All .rb files in lib and subdirectories will be loaded at application start up. The idiom to use is to construct a class with a class-level run method which takes a db, which is then passed to from_query. Here's an example:

class SomeComplicatedReport < Sequel::Reporter::Report
  def self.run(db)
    from_query(db, """
      select "something complicated" as foo
    """)
  end
end

Then in your erb report you'd use it like this:

<%= table SomeComplicatedReport.run(@db) %>

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