Effective Reports

A dynamic ActiveRecord report builder.

Getting Started

This requires Rails 6+ and Twitter Bootstrap 4 and just works with Devise.

Please first install the effective_datatables gem.

Please download and install the Twitter Bootstrap4

Add to your Gemfile:

gem 'effective_reports'

Run the bundle command to install it:

bundle install

Then run the generator:

rails generate effective_reports:install

The generator will install an initializer which describes all configuration options and creates a database migration.

If you want to tweak the table names, manually adjust both the configuration file and the migration now.

Then migrate the database:

rake db:migrate

Please add the following to your User model:

acts_as_reportable

# { active: nil, inactive: nil, with_first_name: :string, not_in_good_standing: :boolean }
def reportable_scopes
  {}
end

and

Add a link to the admin menu:

```haml
- if can? :admin, :effective_reports
  - if can? :index, Effective::Reports
    = nav_link_to 'Reports', effective_reports.admin_reports_path

Configuration

Authorization

All authorization checks are handled via the effective_resources gem found in the config/initializers/effective_resources.rb file.

Effective Roles

This gem works with effective roles for the representative roles.

Configure your config/initializers/effective_roles.rb something like this:

</code>

Permissions

The permissions you actually want to define are as follows (using CanCan):

if user.persisted?
end

if user.admin?
  can :admin, :effective_reports
end

License

MIT License. Copyright Code and Effect Inc.

Testing

Run tests by:

rails test

Contributing

1. Fork it
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. Bonus points for test coverage
6. Create new Pull Request