ndr_support 5.7.1 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e95a05bf2c1dd28e2bfe10716b35e761c5db50ac58947f168585692b588c499
-  data.tar.gz: 49ed22feef4c4a22ea2094883263eaf81d24a497cff6d0977fa23c6889518e77
+  metadata.gz: 902f81bfb91abe5145aebc693e0f200b621db63183963e6c1bc0d2c7ef783c7e
+  data.tar.gz: 8bb91d0cfa4e64493330d9fa1eeb2765452e45547d751df43daf954da5a06ddd
 SHA512:
-  metadata.gz: aaa5b6b7e04962f01738e60815f338c3c54ca38c5862ab5b5a373a9f9628712670d75db1f7bae9e2e2830e6cf511a36b9bc0ec304822352e0e64b94caa375160
-  data.tar.gz: e204589b6cd0951139bea6d2d96d23d4ec0bfe7d0c2be501bdd0ed1668802d4dbb3a7866e73242d004bce25cfc9d8407b934051a3c5afe29b101fe813cee49d5
+  metadata.gz: b006ab6c6ea53f6ce5b47dc38fd290d1b9679995eacea4cbd269477e79e06bc2a1a752b273d707dce3a127e8c605b08fae8dfa6c1a606bb272f290521f66d971
+  data.tar.gz: 193a182ca039ba2113d1701c75511eb00bd8c4ce3e52e5797c7a6846c3963fdca392b3374faa79b9fdf78e25ad3514f87d1bbc2bc6545f68092f698b7ab93a33

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 ## [Unreleased]
 *no unreleased changes*
 
+## 5.8.0 / 2021-04-19
+## Added
+
+* Add ability to disable date reversing in Daterange
+
+## Fixed
+* Support Ruby 2.6-3.0.
+* Fix ruby warnings
+
 ## 5.7.1 / 2021-01-03
 ## Fixed
 * Postcodeize old Newport postcodes

data/README.md

@@ -1,4 +1,4 @@
-# NdrSupport [![Build Status](https://travis-ci.org/PublicHealthEngland/ndr_support.svg?branch=master)](https://travis-ci.org/PublicHealthEngland/ndr_support) [![Gem Version](https://badge.fury.io/rb/ndr_support.svg)](https://badge.fury.io/rb/ndr_support)
+# NdrSupport [![Build Status](https://github.com/publichealthengland/ndr_support/workflows/Test/badge.svg)](https://github.com/publichealthengland/ndr_support/actions?query=workflow%3Atest) [![Gem Version](https://badge.fury.io/rb/ndr_support.svg)](https://rubygems.org/gems/ndr_support)
 
 This is the Public Health England (PHE) National Disease Registers (NDR) Support ruby gem, providing:
 

data/code_safety.yml

@@ -1,5 +1,17 @@
 ---
 file safety:
+  ".github/CODEOWNERS":
+    comments: 
+    reviewed_by: ollietulloch
+    safe_revision: 993f7719b57eb6ddd8dffa7230ed9ffc69f48749
+  ".github/workflows/lint.yml":
+    comments: 
+    reviewed_by: ollietulloch
+    safe_revision: 993f7719b57eb6ddd8dffa7230ed9ffc69f48749
+  ".github/workflows/test.yml":
+    comments: 
+    reviewed_by: ollietulloch
+    safe_revision: 993f7719b57eb6ddd8dffa7230ed9ffc69f48749
   ".gitignore":
     comments: 
     reviewed_by: josh.pencheon
@@ -8,16 +20,10 @@ file safety:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: a02f14cbf1fc36fbaf820365fdedfdc9af326db1
-  ".travis.yml":
-    comments: 'diff failed; reviewed whole file. Revision c88f5ac8c12fd657bb142144e0d3afaa7f9bc361:
-      Slack notification secret is public/private key encrypted, so not a disclosure
-      risk. As a secondary protection, it''s excluded from the .gem file by ndr_support.gemspec'
-    reviewed_by: josh.pencheon
-    safe_revision: 0cfcfac5ddcd721a67dcd23f04cbf6bc2278b922
   CHANGELOG.md:
     comments: 
-    reviewed_by: brian.shand
-    safe_revision: f7cfb534917c991a6e1811f1eb4cff2083c141d2
+    reviewed_by: ollietulloch
+    safe_revision: b0dc20ab24516ac5c3ecb6c7078b56a20dd2fbd5
   CODE_OF_CONDUCT.md:
     comments: 
     reviewed_by: timgentry
@@ -36,8 +42,8 @@ file safety:
     safe_revision: 90328cca8494539257e192a63b240a91c89f0616
   README.md:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 2685f35c907af6968a69eabb5ab9424b490d0f40
+    reviewed_by: ollietulloch
+    safe_revision: 993f7719b57eb6ddd8dffa7230ed9ffc69f48749
   Rakefile:
     comments: 
     reviewed_by: timgentry
@@ -69,7 +75,7 @@ file safety:
   lib/ndr_support/daterange.rb:
     comments: 
     reviewed_by: ollietulloch
-    safe_revision: 9a4b8e53f477725c2c2be5000b3c9e66f07d7389
+    safe_revision: 7b9c9525a5d9d319ddec75d5106c85a53f77e3f4
   lib/ndr_support/hash.rb:
     comments: 
     reviewed_by: pauleves
@@ -80,8 +86,8 @@ file safety:
     safe_revision: 2685f35c907af6968a69eabb5ab9424b490d0f40
   lib/ndr_support/integer/julian_date_conversions.rb:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 2685f35c907af6968a69eabb5ab9424b490d0f40
+    reviewed_by: ollietulloch
+    safe_revision: '09b3f97fb4c1afc88d0d070c39796b1f60c39d25'
   lib/ndr_support/integer/rounding.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -100,12 +106,12 @@ file safety:
     safe_revision: 50a4293953f9ae227823c390b069a3ed4825074c
   lib/ndr_support/ourdate.rb:
     comments: 
-    reviewed_by: pauleves
-    safe_revision: a18fb5c6c360806a177a9c5584458586e90b3530
+    reviewed_by: ollietulloch
+    safe_revision: '09b3f97fb4c1afc88d0d070c39796b1f60c39d25'
   lib/ndr_support/ourtime.rb:
     comments: 
-    reviewed_by: brian.shand
-    safe_revision: 73527378c53b7ac00d1037155572fe3f01324992
+    reviewed_by: ollietulloch
+    safe_revision: '09b3f97fb4c1afc88d0d070c39796b1f60c39d25'
   lib/ndr_support/password.rb:
     comments: with input from brian.shand
     reviewed_by: josh.pencheon
@@ -124,8 +130,8 @@ file safety:
     safe_revision: 2685f35c907af6968a69eabb5ab9424b490d0f40
   lib/ndr_support/safe_path.rb:
     comments: 
-    reviewed_by: timgentry
-    safe_revision: 4492da77f6a8b678c40dd571fdd46fd936052cca
+    reviewed_by: ollietulloch
+    safe_revision: '09b3f97fb4c1afc88d0d070c39796b1f60c39d25'
   lib/ndr_support/string/cleaning.rb:
     comments: 
     reviewed_by: brianshand
@@ -133,7 +139,7 @@ file safety:
   lib/ndr_support/string/conversions.rb:
     comments: 
     reviewed_by: ollietulloch
-    safe_revision: 9a4b8e53f477725c2c2be5000b3c9e66f07d7389
+    safe_revision: '09b3f97fb4c1afc88d0d070c39796b1f60c39d25'
   lib/ndr_support/tasks.rb:
     comments: 
     reviewed_by: timgentry
@@ -148,20 +154,20 @@ file safety:
     safe_revision: 8e024a4bacfd36e172aad4b800f1960faae0b4b6
   lib/ndr_support/utf8_encoding/control_characters.rb:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 8e024a4bacfd36e172aad4b800f1960faae0b4b6
+    reviewed_by: ollietulloch
+    safe_revision: '09b3f97fb4c1afc88d0d070c39796b1f60c39d25'
   lib/ndr_support/utf8_encoding/force_binary.rb:
     comments: 
-    reviewed_by: timgentry
-    safe_revision: 29595e6431587ff9b7db6e3ad3abbb3577bff99c
+    reviewed_by: ollietulloch
+    safe_revision: '09b3f97fb4c1afc88d0d070c39796b1f60c39d25'
   lib/ndr_support/utf8_encoding/object_support.rb:
     comments: 
-    reviewed_by: timgentry
-    safe_revision: f7adf44fc2772e1926df37abfd9041d41c303328
+    reviewed_by: ollietulloch
+    safe_revision: '09b3f97fb4c1afc88d0d070c39796b1f60c39d25'
   lib/ndr_support/version.rb:
     comments: 
-    reviewed_by: brian.shand
-    safe_revision: f7cfb534917c991a6e1811f1eb4cff2083c141d2
+    reviewed_by: ollietulloch
+    safe_revision: b0dc20ab24516ac5c3ecb6c7078b56a20dd2fbd5
   lib/ndr_support/working_days.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -172,8 +178,8 @@ file safety:
     safe_revision: 29595e6431587ff9b7db6e3ad3abbb3577bff99c
   ndr_support.gemspec:
     comments: 
-    reviewed_by: brianshand
-    safe_revision: befa1d4f27448d5be4e133f442c2b5fbac7d8f25
+    reviewed_by: ollietulloch
+    safe_revision: 993f7719b57eb6ddd8dffa7230ed9ffc69f48749
   test/array_test.rb:
     comments: 
     reviewed_by: timgentry
@@ -185,7 +191,7 @@ file safety:
   test/daterange_test.rb:
     comments: 
     reviewed_by: ollietulloch
-    safe_revision: 9a4b8e53f477725c2c2be5000b3c9e66f07d7389
+    safe_revision: 7b9c9525a5d9d319ddec75d5106c85a53f77e3f4
   test/hash_test.rb:
     comments: 
     reviewed_by: timgentry
@@ -245,7 +251,7 @@ file safety:
   test/string/conversions_test.rb:
     comments: 
     reviewed_by: ollietulloch
-    safe_revision: 9a4b8e53f477725c2c2be5000b3c9e66f07d7389
+    safe_revision: '09b3f97fb4c1afc88d0d070c39796b1f60c39d25'
   test/test_helper.rb:
     comments: 
     reviewed_by: josh.pencheon

data/lib/ndr_support/daterange.rb

@@ -8,6 +8,9 @@ class Daterange
 
   OKYEARS = 1880..2030
 
+  # Raised when dates are not supplied in the correct order if do_not_flip_dates is passed as true:
+  class WrongDateOrderError < StandardError; end
+
   def self.extract(dates_string)
     dates_string.to_s.split(',').map { |str| new(str) }
   end
@@ -17,15 +20,15 @@ class Daterange
     new(ranges.map(&:date1).compact.min, ranges.map(&:date2).compact.max)
   end
 
-  def initialize(x1 = nil, x2 = nil)
+  def initialize(x1 = nil, x2 = nil, do_not_sort_dates: false)
     x1 = x1.to_datetime if x1.is_a?(Date) || x1.is_a?(Time)
     x2 = x2.to_datetime if x2.is_a?(Date) || x2.is_a?(Time)
 
     if x1.is_a?(DateTime) && x2.is_a?(DateTime)
-      @date1 = [x1, x2].min
-      @date2 = [x1, x2].max
+      @date1 = do_not_sort_dates ? x1 : [x1, x2].min
+      @date2 = do_not_sort_dates ? x2 : [x1, x2].max
       @source = nil
-    elsif x1.is_a?(Daterange) && x2.nil?  # Patient model line 645
+    elsif x1.is_a?(Daterange) && x2.nil? # Patient model line 645
       @date1 = x1.date1
       @date2 = x1.date2
       @source = x1.source
@@ -34,12 +37,14 @@ class Daterange
       @date2 = x1
       @source = nil
     elsif x1.is_a?(String) && x2.nil?
-      self.source = (x1)
+      self.send(:source=, x1, do_not_sort_dates)
     else
       @date1 = nil
       @date2 = nil
       @source = nil
     end
+    raise WrongDateOrderError, 'Invalid date range order' if do_not_sort_dates && @date1 > @date2
+
     self.freeze
   end
 
@@ -137,22 +142,23 @@ class Daterange
   # +s+ consists of one or more dates separated with spaces.
   # Each date can be in various formats, e.g. d/m/yyyy, ddmmyyyy, yyyy-mm-dd, dd-mon-yyyy
   # Each date can omit days or months, e.g. yyyy, dd/yyyy, yyyy-mm, mon-yyyy
-  def source=(s)
+  def source=(s, do_not_sort_dates)
     @source = s
     ss = s.upcase.sub(/TO/, ' ') # accept default _to_s format
-    if ss =~ /[^\w0-9\-\/\. ]/i # only allow letters, digits, hyphen, slash, dot, space
+    if ss =~ %r{[^A-Z0-9\-/\. ]}i # only allow letters, digits, hyphen, slash, dot, space
       @date1 = @date2 = nil
     else
       da = [] # temporary array of arrays of dates
-      ss.split(' ').each do |vaguedate|
+      ss.split.each do |vaguedate|
         da << str_to_date_array(vaguedate)
       end
       da.flatten!
       if da.include?(nil)
-        @date1 = @date2 =  nil
+        @date1 = @date2 = nil
       else
-        da.sort!
-        @date1, @date2 = da.first, da.last
+        da.sort! unless do_not_sort_dates
+        @date1 = da.first
+        @date2 = da.last
       end
     end
   end

data/lib/ndr_support/integer/julian_date_conversions.rb

@@ -1,5 +1,3 @@
-require 'ndr_support/ourdate'
-
 # Extend Integer for use in our Daterange class
 class Integer
   # Julian date number to Ruby Date

data/lib/ndr_support/ourdate.rb

@@ -31,6 +31,8 @@ class Ourdate
   # with strings arguments only after the 1970 epoch; before, it returns nil.
   #++
   def self.build_datetime(year, month = 1, day = 1, hour = 0, min = 0, sec = 0, usec = 0)
+    return nil if year.nil?
+
     if ActiveRecord::Base.default_timezone == :local
       # Time.local_time(year, month, day, hour, min, sec, usec).to_datetime
       # Behave like oracle_adapter.rb
@@ -72,8 +74,8 @@ class Ourdate
   end
 
   def empty?
-    # An unspecified date will be empty. A valid or invalid date will not.
-    @thedate.nil? && @source.blank?
+    # An unspecified date will be empty. A valid date will not.
+    @thedate.nil?
   end
 
   def source=(s)

data/lib/ndr_support/ourtime.rb

@@ -28,8 +28,8 @@ class Ourtime
   end
 
   def empty?
-    # An unspecified time will be empty. A valid or invalid time will not.
-    @thetime.nil? && @source.blank?
+    # An unspecified time will be empty. A valid time will not.
+    @thetime.nil?
   end
 
   private

data/lib/ndr_support/safe_path.rb

@@ -118,6 +118,7 @@ class SafePath
 
     @path_space = path_space
     @maximum_prms = fs_paths[platform][path_space]['prms']
+    @prm = nil
 
     self.path = @root
   end

data/lib/ndr_support/string/conversions.rb

@@ -84,7 +84,7 @@ class String
 
   # Try to convert the string value into a date.
   # If given a pattern, use it to parse date, otherwise use default setting to parse it
-  def to_date(pattern = nil)
+  redefine_method :to_date do |pattern = nil|
     return nil if blank?
 
     pattern = '%d%m%Y' if 'ddmmyyyy' == pattern

data/lib/ndr_support/utf8_encoding/control_characters.rb

@@ -1,5 +1,3 @@
-require 'ndr_support/utf8_encoding'
-
 module UTF8Encoding
   # Allows any supported object to have control characters
   # escaped, using standard replacement scheme.

data/lib/ndr_support/utf8_encoding/force_binary.rb

@@ -1,5 +1,3 @@
-require 'ndr_support/utf8_encoding'
-
 module UTF8Encoding
   # Allows any supported object to have any high-ascii string
   # content to be force-encoded from UTF-8 to BINARY (/ASCII-8BIT).

data/lib/ndr_support/utf8_encoding/object_support.rb

@@ -1,5 +1,3 @@
-require 'ndr_support/utf8_encoding'
-
 # Allows any object (if supported) to have all related
 # strings encoded in place to UTF-8.
 module UTF8Encoding

data/lib/ndr_support/version.rb

@@ -3,5 +3,5 @@
 # This defines the NdrSupport version. If you change it, rebuild and commit the gem.
 # Use "rake build" to build the gem, see rake -T for all bundler rake tasks.
 module NdrSupport
-  VERSION = '5.7.1'
+  VERSION = '5.8.0'
 end

data/ndr_support.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ndr_support/version'
 
@@ -13,9 +13,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   # Exclude older versions of this gem from the package.
-  spec.files         = `git ls-files -z`.split("\x0").reject { |s| s =~ /^pkg\// }
-  # SECURE BNS 2018-08-06: Minimise sharing of (public-key encrypted) slack secrets in .travis.yml
-  spec.files         -= %w[.travis.yml] # Not needed in the gem
+  spec.files         = `git ls-files -z`.split("\x0").reject { |s| s =~ %r{^(\.github|pkg/)} }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
@@ -26,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '>= 12.3.3'
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.6.0'
 
   # Avoid std-lib minitest (which has different namespace)
   spec.add_development_dependency 'minitest', '>= 5.0.0'

data/test/daterange_test.rb

@@ -24,19 +24,47 @@ class DaterangeTest < Minitest::Test
     # assert_match(/\d\d\.\d\d\.\d\d\d\d to \d\d.\d\d.\d\d\d\d/, dr.to_s)
   end
 
-  def test_dates_in_reverse_order
-    d = Date.today
-    dr = Daterange.new d, d + 1
-    dr2 = Daterange.new d + 1, d
+  def test_date_time_dates_in_reverse_order_with_do_not_sort_dates_false
+    d = Time.zone.today
+    dr = Daterange.new(d, d + 1)
+    dr2 = Daterange.new(d + 1, d)
     assert_equal(dr.to_s, dr2.to_s)
   end
 
+  def test_date_time_dates_in_reverse_order_with_do_not_sort_dates_true
+    d = Time.zone.today
+    Daterange.new(d, d + 1, do_not_sort_dates: true)
+    assert_raises(Daterange::WrongDateOrderError) do
+      Daterange.new(d + 1, d, do_not_sort_dates: true)
+    end
+  end
+
+  def test_string_dates_in_reverse_order_with_do_not_sort_dates_false
+    dr = Daterange.new('01/01/2019 to 01/01/2020')
+    dr2 = Daterange.new('01/01/2020 to 01/01/2019')
+    assert_equal(dr.to_s, dr2.to_s)
+  end
+
+  def test_string_dates_in_reverse_order_with_do_not_sort_dates_true
+    Daterange.new('01/01/2019 to 01/01/2020', do_not_sort_dates: true)
+    assert_raises(Daterange::WrongDateOrderError) do
+      Daterange.new('01/01/2020 to 01/01/2019', do_not_sort_dates: true)
+    end
+  end
+
   def test_illegal_strings
     dr = Daterange.new('01/o1/2000')
     assert_equal '', dr.to_s
     assert_nil dr.date1
     assert_nil dr.date2
-    refute dr.empty?  # Illegal dates do not count as empty / blank,
+    refute dr.empty? # Illegal dates do not count as empty / blank,
+    refute_nil dr.source # but the illegal string is preserved
+
+    dr = Daterange.new('01_01_2000')
+    assert_equal '', dr.to_s
+    assert_nil dr.date1
+    assert_nil dr.date2
+    refute dr.empty? # Illegal dates do not count as empty / blank,
     refute_nil dr.source # but the illegal string is preserved
   end
 

data/test/string/conversions_test.rb

@@ -357,9 +357,9 @@ class String::ConversionsTest < Minitest::Test
   end
 
   def assert_ymd(ymd, date)
-    assert_equal ymd.first,  date.year,  'years were not equal'
-    assert_equal ymd.second, date.month, 'months were not equal'
-    assert_equal ymd.third,  date.day,   'days were not equal'
+    assert_equal ymd[0],  date.year,  'years were not equal'
+    assert_equal ymd[1], date.month, 'months were not equal'
+    assert_equal ymd[2],  date.day,   'days were not equal'
   end
 
   def assert_ymd_parsed(ymd, parse_results)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_support
 version: !ruby/object:Gem::Version
-  version: 5.7.1
+  version: 5.8.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-03 00:00:00.000000000 Z
+date: 2021-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -309,7 +309,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="