AppReporter fetch data from the already generated application reports through brakeman and metric_fu. Based on some thresholds it checks for some major areas like security issues, test coverage and Rails best practices etc. It generates HTML report in applications root folder once you run final command.
Install other required gems
$ gem install brakeman $ gem install metric_fu
Add this line to your application's Gemfile:
gem 'app_reporter', '~> 1.0.0'And then execute:
$ bundle
Or install it yourself as:
$ gem install app_reporter
Run below commands
$ brakeman -o report.html -o report.json
$ metric_fu
TODO::
- Update passing and failing areas conditions into the templates.
- Make report template more attractive.
- Make it run the brakeman and metric_fu commands internally instead of manually.
Run AppReoprter
$ rake app_reporter:run
Check for the summary_report.html in root folder
- Fork it ( https://github.com/[my-github-username]/app_reporter/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request