FactMetrics

FactMetrics provides a collection of class methods for defining metrics on Fact models.

Install the gem and add to the application's Gemfile by executing:

bundle add fact_metrics

If bundler is not being used to manage dependencies, install the gem by executing:

gem install fact_metrics

In your Fact model you can add the following types of metric definitions.

The count metric is useful for counting the number of records that match a specific filter condition.

The most common situation is to capture all of the rows.

  count :sales, all: true

The count metric also supports the :equal and :condition keys.

The average metrics help to find averages for a given field.

  average :regular_unit_price

The :field key is also supported if you'd like to rename the average method.

  average :standard_unit_price, field: :regular_unit_price

Percentages support a number of condition options, :equal, :in, :all, and :condition.

  percentage :received, field: quantity_received, condition: "> 0"
  percentage :inspected, field: quantity_inspected, condition: "> 0"

Depending on your needs, you can either calculate all of the metrics, or a subset. If your Fact model defines a large number of metrics specifying a subset of them can often improve performance.

To get all available metrics:

  Fact::Sales.all_metrics

To get only sales_quantity_count:

  Fact::Sales.load_metrics(:sales_counts)

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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/PatchMonkeyHQ/fact_metrics.

The gem is available as open source under the terms of the MIT License.