Contents

# Mongoid Report

Library for easy building aggregation report using mongodb aggregation
framework.

[![Build Status](https://secure.travis-ci.org/oivoodoo/mongoid-report.png?branch=master)](https://travis-ci.org/oivoodoo/mongoid-report)

[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/oivoodoo/mongoid-report)

### Example

```ruby
  class Model
    include Mongoid::Document

    field :field1, type: Integer, default: 0

    field :day,    type: Date
  end

  class Report1
    include Mongoid::Report

    aggregation_field :field1, for: Model
  end

  class Report2
    include Mongoid::Report

    attach_to Model do
      aggregation_field :field1
    end
  end

  class Report3
    include Mongoid::Report

    group_by :day, for: Model

    aggregation_field :field1, for: Model
  end

  class Report4
    include Mongoid::Report

    attach_to Model do
      group_by :day

      aggregation_field :field1
    end
  end

  class Report5
    include Mongoid::Report

    attach_to Model, as: 'summary-report' do
      group_by :day

      aggregation_field :field1
    end
  end
```

```ruby
  example = Report4.new
  scope = example.aggregate_for(Model)
  scope = scope.query('match' => { 'field1' => 1 })
  result = scope.all

  result.is_a?(Array) => true
  result[0].is_a?(Hash) => true

  example = Report5.new
  scope = example.aggregate_for('summary-report')
  result = scope.all
```

## Installation

Add this line to your application's Gemfile:

    gem 'mongoid-report'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install mongoid-report

## Contributing

1. Fork it ( http://github.com/oivoodoo/mongoid-report/fork )
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

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
mongoid-report-0.0.11	README.md
mongoid-report-0.0.10	README.md
mongoid-report-0.0.9	README.md
mongoid-report-0.0.8	README.md
mongoid-report-0.0.7	README.md