nhsdigital / ndr_support Goto Github PK

View Code? Open in Web Editor NEW

4.0 15.0 6.0 1 MB

National Disease Registers support gem

License: MIT License

Ruby 100.00%

ndr_support's Introduction

NdrSupport

This is the Public Health England (PHE) National Disease Registers (NDR) Support ruby gem, providing:

core ruby class extensions;
additional time, regular expression, file security, password checking/generation, and encoding classes.

Installation

Add this line to your application's Gemfile:

gem 'ndr_support'

And then execute:

$ bundle

Or install it yourself by cloning the project, then executing:

$ gem install ndr_support.gem

Usage

ndr_support extends/overrides the following core classes/modules:

Array
Hash
Integer
NilClass
String
Time

ndr_support adds the following classes:

Daterange
NdrSupport::Password
Ourdate
Ourtime
RegexpRange
SafeFile
SafePath
UTF8Encoding

YAML Serialization Wrapper

ndr_support also provides a lightweight wrapper around YAML serialization to provide support for YAML engines and string encodings. This behavour is not enabled by default.

To enable this add the following line to your code:

include NdrSupport::YAML::SerializationMigration

Contributing

Fork it ( https://github.com/PublicHealthEngland/ndr_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

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Test Data

All test data in this repository is fictitious. Any resemblance to real persons, living or dead, is purely coincidental.

Note: Real codes exist in the tests, postcodes for example, but bear no relation to real patient data. Please ensure that you always only ever commit dummy data when contributing to this project.

ndr_support's People

Contributors

Stargazers

Watchers

Forkers

kosmas gitter-badger joshpencheon timgentry joecatling suezhou

ndr_support's Issues

NdrSupport::Obfuscator.obfuscate raises exception with nil name

NdrSupport::Obfuscator.obfuscate should gracefully handle a nil name rather than raise an exception. I would prefer that it return nil in this instance.

Keep list of Bank Holidays up to date

The WorkingDays concerns tracks public holidays (for England/Wales), but needs manual updating. As a result, it has fallen stale.

We should make use of https://www.gov.uk/bank-holidays/england-and-wales.json, perhaps baking the cache at rake build time. We can't presume to have internet connectivity once ndr_support is being used.

Replace PHE references with NHS Digital

With the move to NHS Digital, references to PHE need to be replaced across all the files in the project (regexs show case insensitivity):

Replace /raw.githubusercontent.com/PublicHealthEngland/i with raw.githubusercontent.com/NHSDigital
Replace /github.com/publichealthengland/i with github.com/NHSDigital
Replace /\bPHE\b/ with NHSD
Replace Public Health England with NHS Digital
Replace PublicHealthEngland with NHSDigital
Check LICENSE.txt copyright date range is up to date
Add /.rubocop-https---raw-githubusercontent-com-NHSDigital-ndr-dev-support-master--rubocop-yml to .gitignore (leave in the old PHE .rubocop cache reference)

Thread scanner tests failing

As a developer.
I need to be able to run all the tests reliably.
It's done when the thread scanner test no longer report missing method errors

Julian date conversion fails with some Ruby versions

The integer/julian_date_conversions.rb file is missing a require 'ndr_support/ourdate'. This causes an uncaught exception ('uninitialized constant Integer::Ourdate') with certain ruby versions under certain circumstance (Presumably sue to variances in auto-loading).

Fix deprecations with Ruby 2.4.0

Fixnum has been unified, so this gem now raises deprecation warnings:

ndr_support-5.0.0/lib/ndr_support/fixnum/julian_date_conversions.rb:4: warning: constant ::Fixnum is deprecated

We should address in way that is backwards-compatible with previous rubies.

Partition / Deprecate / Remove legacy logic from NdrSupport

Some of the code in NdrSupport was extracted from legacy systems. It would not always be desirable to add this blindly to other projects.

Some of this logic has been encapsulated (e.g. NdrSupport.attempt_date_patch!), but in the current release is still active-by-default.

We should list methods that are undesirable (resp. unused by internal NDR projects!?), and put them through a deprecation cycle, after which they would be disabled-by-default (resp. removed entirely).

@timgentry, does this sound sensible?

Code audit check on pkg build misses uncommitted changes

We should make it impossible to rake build when there are local modifications.

# For SVN:
$ svn status | grep -q [^AMCDG]; echo $?

# For Git:
$ git diff --quiet HEAD; echo $?