Reporting DSL for Ruby
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples add more detail to the example report Jan 24, 2013
lib bump to v0.5.1 Sep 19, 2016
spec fix multiple sorting and add some specs Aug 5, 2013
.gemtest initial commit Jun 7, 2012
.gitignore add .ruby-version for dev and update Gemfile/gitignore Jun 3, 2013
.rspec
.ruby-version
.rvmrc
Gemfile add .ruby-version for dev and update Gemfile/gitignore Jun 3, 2013
Gemfile.lock
LICENSE initial commit Jun 7, 2012
README.md Fix readme formatting Jan 28, 2013
Rakefile initial commit Jun 7, 2012
design merging upstream Jun 11, 2012
ruby_reportable.gemspec

README.md

Ruby Reportable - reporting in ruby

DESCRIPTION

Ruby Reportable is a DSL for writing reports using pure ruby. It allows you to use existing code (ie your Rails application) to grab data and the manipulate it.

If you have loaded it then Ruby Reportable can report on it.

Examples

See examples/ directory

Usage

Using Ruby Reportable is as easy as include RubyReportable in a new class. The include lets Ruby Reportable know this class is a new report and also brings in the DSL.

Source

Your source is the start of your data. All available configuration is shown below.

source do
  #
  # define how your outputs will see each element of the source data
  #
  as :element  # this is the default

  # Whatever you want your starting data to be
  logic do
    ObjectSpace.each_object.to_a.group_by(&:class).to_a
  end
end

INSTALLATION

Install as a gem or use as part of your Gemfile

$ [sudo] gem install ruby_reportable

Configuration

Version 0.2.X

There is a change in what is returned when a report is validated (object.report.valid?). In 0.1.X true/false is returned but in 0.2.X a hash is returned containing whether the report is valid (status) and an array of errors if any (errors).

{:status => true/false, :errors => array }