Monocle uses a couple libraries to deliver high quality components.
| Dependency | Version |
|---|---|
| View Components | 2.53.0 |
| Bootstrap | 5.0 |
| Group Date | 6.1.0 |
| ApexCharts | 3.36.3 |
Add this line to your application's Gemfile:
# Gemfile
gem 'monocle'And then execute:
$ bundle install
Or install it yourself as:
$ gem install monocle
To generate the migration and build the data model, run:
rails generate monocle:authorization_exceptions
rails db:migrate
Once you have Monocle loaded you can render any of its view components. For example, you could render the Monocle::ControllersOverTimeComponent with:
<%= render Monocle::ControllersOverTimeComponent.new(events: AuthorizationException.all) %>With a full list of components here:
| Component | Purpose |
|---|---|
| ControllersOverTimeComponent | Shows the number of events over time. |
| ExceptionsByControllerComponent | Shows the number of events grouped by controller name. |
| ExceptionsByRequestComponent | Shows the number of events grouped by request. |
| ExceptionsByUserComponent | Shows the number of events grouped by user id. |
| ExceptionsSinceTimeAgoComponent | Shows the number of exceptions over a specified period of time and the percentage increase over time. |
| HighestControllerActionCountComponent | Shows the controller endpoint which has caused the most authorization exceptions given the events passed in. |
| TopTenUsersComponent | Shows the top ten users in terms of who caused most authorization exceptions. |
| UsersAffectedSinceTimeAgoComponent | Shows the number of users affected over a given time period. |
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/harled/monocle. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
Want to help us out? Here are some steps to make sure you are contributing
- Find an issue you like, or create a new issue here Please ask for any questions or clarifications in the associated issues or in new issues! 🤔
- Assign yourself to the issue and create a branch , following GitHub Issue's naming scheme. 🛠️ The naming scheme should follow (#issueNumber-issue-name) ie. (#10-create-new-component)
- Get on your local machine and ensure you have the repo cloned. Checkout the branch you just made with git checkout branch-name and pull the latest merged changes from the repo with git pull origin main to make sure you have the most up-to-date code from the repo. 👩💻
- Add your amazing changes along with any documentation you feel would be useful. Then commit and push your changes. 🌟
- Go back to the repo on GitHub and create a pull request! Then wait for an admin of the repo to get back to your pull request, address any comments and once you are finally approved, merge your code into Monocle! 🎉
If you want some more tips on contributing to GitHub projects, check out this resource from Data School.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Monocle project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.