NdrDevSupport 
This is the Public Health England (PHE) National Disease Registers (NDR) Developer Support ruby gem, providing:
- rake tasks to manage code auditing of ruby based projects; and
- a rake task to limit Rubocop's output to changed (and related) code.
Installation
Add this line to your application's Gemfile:
gem 'ndr_dev_support', group: :development
And then execute:
$ bundle
Or install it yourself as:
$ gem install ndr_dev_support
Usage
Code Auditing Rake Tasks
ndr_dev_support provides a mechanism to manage the state of routine code quality and security peer reviews. It should be used as part of wider quality and security policies.
It provides rake tasks to help manage the process of persisting the state of security reviews.
Once files have been reviewed as secure, the revision number for that file is stored in code_safety.yml. If used within a Rails app, this file is stored in the config/ folder, otherwise it is kept in the project's root folder.
Note: This feature works with svn and git repositories and svn, git-svn and git working copies.
For more details of the audit tasks available, execute:
$ rake -T audit
RuboCop filtering
ndr_dev_support provides rake tasks to enable more targeted use of RuboCop, to analyse only relevant code changes:
$ rake rubocop:diff HEAD
$ rake rubocop:diff HEAD~3..HEAD~2
$ rake rubocop:diff HEAD~3..HEAD~2
$ rake rubocop:diff aef12fd4
$ rake rubocop:diff master
$ rake rubocop:diff path/to/file
$ rake rubocop:diff dir/
As well as the primary rubocop:diff task, there are a number of convenience tasks provided:
$ rake rubocop:diff:head
$ rake rubocop:diff:staged
$ rake rubocop:diff:unstaged
$ find . -iregex .*\.rake$ | xargs rake rubocop:diff:file
To add development support tasks to your project, add this line to your application's Rakefile:
require 'ndr_dev_support/tasks'
Development
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 tags, and push the .gem file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/PublicHealthEngland/ndr_dev_support. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
- Fork it ( https://github.com/PublicHealthEngland/ndr_dev_support/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
License
The gem is available as open source under the terms of the MIT License.