"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "README.rdoc" between
ruport-1.7.1.tar.gz and ruport-1.8.0.tar.gz

About: Ruport (Ruby Reports) is a simple, extensible reporting system built for Rubyists. It provides tools for data acquisition, database interaction, formatting, and parsing/munging.

README.rdoc  (ruport-1.7.1):README.rdoc  (ruport-1.8.0)
= What Ruport Is [![Build Status][BS img]](https://travis-ci.org/ruport/ruport)
[![Coverage Status][CS img]](https://coveralls.io/r/ruport/ruport)
## What Ruport Is
Ruby Reports (Ruport) is an extensible reporting system. Ruby Reports (Ruport) is an extensible reporting system.
It aims to be as lightweight as possible while still providing core support It aims to be as lightweight as possible while still providing core support
for data aggregation and manipulation as well as multi-format rendering for data aggregation and manipulation as well as multi-format rendering
of reports. of reports.
Ruport provides tools for using a number of data sources, including CSV files, Ruport provides tools for using a number of data sources, including CSV files,
ActiveRecord models, and raw SQL connections via RubyDBI (through ruport-util). ActiveRecord models, and raw SQL connections via RubyDBI (through ruport-util).
skipping to change at line 23 skipping to change at line 26
record, table, and grouping operations. These all can be extended to record, table, and grouping operations. These all can be extended to
implement custom behavior as needed. implement custom behavior as needed.
For common tasks, Ruport provides formatters for CSV, HTML, PDF, and text- For common tasks, Ruport provides formatters for CSV, HTML, PDF, and text-
based reports. However, the real power lies in building custom report based reports. However, the real power lies in building custom report
controllers and formatters. The base formatting libraries provide a number controllers and formatters. The base formatting libraries provide a number
of helper functions that will let you build complex reports while maintaining of helper functions that will let you build complex reports while maintaining
a DRY and consistent interface. a DRY and consistent interface.
To get a quick feel for what you can accomplish with Ruport, take a look at To get a quick feel for what you can accomplish with Ruport, take a look at
a few simple examples provided on our web site. a few simple examples provided on our web site:
http://ruport.github.io/examples.html https://ruport.github.io/examples.html
Since Ruport's core support is intentionally minimalistic, you may be looking Since Ruport's core support is intentionally minimalistic, you may be looking
for some higher level support for specific needs such as graphing, invoices, for some higher level support for specific needs such as graphing, invoices,
report mailing support, etc. For this, you may wish to take a look at the report mailing support, etc. For this, you may wish to take a look at the
ruport-util package, which contains some generally useful tools and libraries ruport-util package, which contains some generally useful tools and libraries
to extend Ruport's capabilities. to extend Ruport's capabilities.
= Installation ## Installation
To install ruport via rubygems: To install ruport via rubygems:
sudo gem install ruport ```sh
$ sudo gem install ruport
```
Check to see if it installed properly: Check to see if it installed properly:
ruby -rubygems -e "require 'ruport'; puts Ruport::VERSION" ```sh
$ ruby -e "require 'ruport'; puts Ruport::VERSION"
```
If you get an error, please let us know on our mailing list. If you get an error, please let us know on our mailing list.
=== Dependencies ### Dependencies
==== Formatting #### Formatting
Ruport relies on PDF::Writer for its formatting support. Ruport relies on PDF::Writer for its formatting support.
If you want to make use of textile helpers, you'll also need RedCloth. If you want to make use of textile helpers, you'll also need RedCloth.
==== Database interaction #### Database interaction
If you wish to use Ruport to report against a rails project, If you wish to use Ruport to report against a Rails project, you'll need
a camping project, or do standalone acts_as_reportable reports, you'll need ActiveRecord and the `acts_as_reportable` gem.
ActiveRecord and the acts_as_reportable gem.
If you want to use Ruport::Query for raw SQL support, you'll need to If you want to use Ruport::Query for raw SQL support, you'll need to
install ruport-util, RubyDBI and whatever database drivers you might need. install `ruport-util`, `RubyDBI` and whatever database drivers you might
need.
= Resources ## Resources
Our developers have published a free-content book about all things Our developers have published a free-content book about all things
Ruport, including complete coverage of acts_as_reportable and some of Ruport, including complete coverage of acts_as_reportable and some of
ruport-util's features. This book serves as the definitive guide to ruport-util's features. This book serves as the definitive guide to
Ruport, so all users should become acquainted with it: Ruport, so all users should become acquainted with it:
http://ruport.github.io https://ruport.github.io
The next best way to get help and make suggestions is the Ruport mailing list.
This software is on the move, so the list is the most reliable way of getting
up to date information.
- You can sign up and/or view the archives here:
http://groups.google.com/group/ruby-reports
If you are looking to dig a little deeper, there are a couple more resources If you are looking to dig a little deeper, there are a couple more resources
that may be helpful to you. that may be helpful to you.
- The latest stable API documentation is available at: - The latest stable API documentation is available at: http://rubydoc.info/gems/
http://rubydoc.info/gems/ruport/frames ruport/frames
- The code repository is on GitHub: https://github.com/ruport/ruport
- Our issues tracker is at http://github.com/ruport/ruport/issues - Our issues tracker is at https://github.com/ruport/ruport/issues
Our issues tracker is at <span class="insert">https://github.com/ruport/ruport/ ## Hacking
issues</span>
= Hacking
If you'd like to contribute code to Ruport, please join our development If you'd like to contribute code to Ruport, fork the repository and open a PR!
mailing list, and let us know what you'd like to do!
http://groups.google.com/group/ruport-dev
The main Git repository is on GitHub:
http://github.com/ruport/ruport
It also may be worthwhile to join this list if you plan on running edge
versions of Ruport, as this is where we make announcements about major
breakage in trunk.
We are very responsive to contributors, and review every patch we receive We are very responsive to contributors, and review every patch we receive
fairly quickly. Most contributors who successfully get a patch or two applied fairly quickly. Most contributors who successfully get a patch or two applied
are given write access to the repositories and invited to join Ruport's are given write access to the repositories and invited to join Ruport's
development team. Since we view every user as potential contributor, this development team. Since we view every user as potential contributor, this
approach works well for us. approach works well for us.
So if you want to help out with Ruport, we'll happy accept your efforts! So if you want to help out with Ruport, we'll happy accept your efforts!
[BS img]: https://travis-ci.org/ruport/ruport.svg?branch=master
[CS img]: https://coveralls.io/repos/ruport/ruport/badge.png?branch=master
 End of changes. 17 change blocks. 
40 lines changed or deleted 28 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)