Warning: this gem can execute methods based on strings defined in a JSON file. Use at your own caution. This gem has not been security audited, and should not be used in a production environment!
Reportinator is a gem that allows you to easily define a report using a JSON file. Report templates can reference other report templates, allowing for report "partials" to easily be re-used.
Install the gem and add to the application's Gemfile by executing:
$ bundle add reportinator
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install reportinator
For a detailed walkthrough of creating your first report, see Creating my First Report
By default, Reportinator checks app/reports for reports.
It checks for files named *.json and *.report.json
More locations and suffixes can be added in the config.
Reportinator.report(template, params) will output a two dimensional array.
If you picture this as a table, each sub array is a row.
params is optional.
Reportinator.output(template, params, filename) will output the report to a csv,
in the configured output directory.
params and filename are optional.
Template is the name of the template file, minus the ".json" suffix. Here is how templates are resolved:
- "profit" => "app/reports/profit.json"
- "users/joined" => "app/reports/users/joined.json"
Params is a hash, accepting the same keys as a template would. Params are merged with those provided by the template, overriding any conflicts.
A Report template has four attributes:
| key | type | description |
|---|---|---|
| type | symbol | specifies the report type to use |
| template | string | references another template to load and merge with |
| metadata | hash | values accessible to parser functions |
| params | hash | report specific parameters |
Values in report templates are passed through the value parser. There are two main types of functions that can be parsed. String functions, and array functions.
String functions return a value based on the contents of a string input. They are useful for quick conversions, and simple functions.
Array functions return a value based on the contents of an array. They are used for more complex functions, as more can be expressed with them. The values in an array function are usually also parsed, although it is at the discretion of the function do so.
| prefix | example | output |
|---|---|---|
: |
":symbol" | :symbol |
& |
"&Constant" | Constant |
$ |
"$variable" | Value variable in variables metadata. |
!a |
"!a 1,2,3" | 6 |
!d |
"!d 1970-01-01" | 1970-01-01 00:00:00 |
!n |
"!n 100" | 100 |
!ni |
"!ni 103.34" | 103 |
!nf |
"!nf 103" | 103.0 |
!j |
"!j 1,2,3" | "123" |
!r |
"!r a,z" | ("a".."z") |
!rd |
"!rd 1970-01-01,1979-01-01" | (1970-01-01 00:00:00..1979-01-01 00:00:00) |
!rn |
"!rn 1,100" | (1..100) |
@true |
"@true" | true |
@false |
"@false" | false |
@nil |
"@nil" | nil |
@null |
"@null" | nil |
When an array has a string as it's first value, and that string has a certain prefix, the given array is parsed as an Array Function.
Array functions have a target, then an array of values. Often, the values will work with the target to achieve an outcome.
Take for example this array:
["#&Date", ":today", ":to_s"]
This array has the following
- a prefix:
# - a target:
&Date(Date) - values:
[":today", ":to_s"]([:today, :to_s])
The # prefix tells the parser to run it as a Method Array.
The target, &Date, is parsed, then the values [":today", ":to_s"]
are parsed, and sent as methods to it. The result is returned.
This array is equivalent to running Date.today.to_s.
Optionally, the prefix can be put on it's own, with no additional values after it. The second value, in this case "&Date", will become the target instead.
["#", "&Date", ":today", ":to_s"]
This will still return the same result. Note that this allows the target to be more flexible, as it no longer has to be resolved from a string.
["#", ["#&Date", ":today"], ":to_s"]
This array is equally valid, and still returns the same result.
| prefix | example | ruby equivalent |
|---|---|---|
# |
["#&Date", ":today"] |
Date.today |
>join |
[">join", " - ", "a", "b", "c"] |
["a", "b", "c"].join(" - ") |
>strf |
[">strf", ["#&Date", ":today"], "%b, %Y"] |
Date.today.strftime("%b, %Y") |
>offset |
[">offset $time", 2, ":month", ":end"] |
$time.advance(month: 2).at_end_of_month |
>title |
[">title", "hello", "world"] |
["hello", "world"].join(" ").titleize |
>snippet |
[">snippet :test", {"var1": "hi"}] |
See snippets section |
Metadata is defined in the "metadata" field of the template, and can be used by Parser Functions. Metadata is merged from parent to child report template. Child metadata takes precedence over parent.
Reportinator's built in Parser Functions use two metadata fields; "variables", and "snippets".
Variables are values that can be accessed with the "$" string function.
"metadata": {
"variables": {
"key": "value"
}
}
> Reportinator.parse "$key"
=> "value"
Variable values are also parsed, and themselves can even reference variables from parent templates.
# $date = 1970-01-01
"metadata": {
"variables": {
"formatted_date": [">strf", "$date", "%b %d, %Y"]
}
}
> Reportinator.parse "$formatted_date"
=> "Jan 01, 1970"
Snippets are values that are not parsed until called from the ">snippet" array function, as opposed to variables, which are parsed before they are able to be called.
Snippets can be passed variables with a hash in the first value of the array function.
Example:
"metadata": {
"snippets": {
"plus_10": [">sum", "$var", 10]
}
}
> Reportinator.parse [">snippet :plus_10", { "var": 5 }]
=> 15
Snippets help to reduce repetition of complex functionality in a report. However, if a report is getting unwieldy with complex values to parse, it might be a good idea to write a Custom Parser Function, or to write it into a method on a class, and call it from a "&Constant". See the next section for setting up custom functions.
Reportinator.configuration do |config|
config.output_directory = "my/report/dir"
config.report_directories = ["first/directory","other/directory"]
config.report_suffixes = ["custom.json", "txt"]
config.report_types = {
my_type: "MyModule::MyReportType"
}
config.parser_functions = [
"MyModule::MyParserFunction"
]
end
Configuration set will not override the default configuration.
The keys used in report types, eg. my_type, will be the same used in the "type" field
of the reports.
The requirements to make a Report are very simple.
- The report must inherit from
Reportinator::Report - The report should provide some attributes, to be set with the "params" field,
- The report must provide a
datamethod, which returns either a Reportinator::Row, or an array of them.
Here's an example of a basic report type:
class BasicReport < Reportinator::Report
attribute :values, default: []
def data
Reportinator::Row.create(values)
end
end
Reportinator::Row.create takes in an array, and turns it into a Row.
For more fine-grained control, an instance of a Row can have data
inserted into it with the insert method. insert takes any data, then
a position, being either :first, :last, or an index number, to indicate where in
the row the data should be inserted.
Once a report has been written, it must be registed as a report type. See the configuration section for more details.
The requirements to make a Parser Function are fairly simple:
- The function must inherit from either "Reportinator::StringFunction" or "Reportinator::ArrayFunction"
- The function must have a PREFIXES constant, with an array of the prefixes it'll accept.
- The function must provide an
outputmethod
All functions have access to the metadata variable.
String functions gain access to two additional variables:
prefix, the prefix that the string usedbody, the rest of the string with the prefix removed
Array functions gain access to three additional variables:
prefix, the prefix that was usedtarget, the first value after the prefixvalues, the rest of the values, with the target removed
Once a function has been written, it must be registed as a parser function. See the configuration section for more details.
class TitleizeStringFunction < Reportinator::StringFunction
PREFIXES = ["!t"]
def output
body.titleize
end
end
> Reportinator.parse "!t hello world"
=> "Hello World"
class TargetSumArrayFunction < Reportinator::ArrayFunction
PREFIXES = [">targetsum"]
def output
values.map { |value| value + target }
end
end
> Reportinator.parse [">targetsum", 10, 1, 2, 3]
=> [11, 12, 13]
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/moxvallix/reportinator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Reportinator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.