ndr_support 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3b89d3c13899b63bff25a98b9fa61eb2f96b48a
-  data.tar.gz: 0930523be4d656ccb9dcd26beb72f68677b5af6f
+  metadata.gz: 609a55a5903e1a1920b0870cb6338be2d3ce9d47
+  data.tar.gz: 15adfab49032115e4693bcbaace8b8d46837911b
 SHA512:
-  metadata.gz: 698f5dae240478b84e559fcad339e4c9a12f951ef90c489c58190bbc3431aba3d50d786d7c9899ddc53db7f6e850c052b1edcc094def201b6f3357cbfb071cf5
-  data.tar.gz: de6652923af6e94c83cd0c378569d7662a5f043bdd7df41d2f15d70732cbb22b87438bbd8887b0a980f06c027c7ff266cab194673e645665c549bc480f07f947
+  metadata.gz: f2270a5b0d7a368945b7276e92a0297a0ea6dacad884a85eefee2e565bac5079fdd92d85ab68e625bb5debb6626c242c050a27613e85dd46f3770f954b95b196
+  data.tar.gz: ac102ce2887029107c2d5adad88fbdb04df9ecc7eeb6698fc206a6abe982f807edc7715e9bab620bf955d90be439d76f8b8669ebf9eab0d74db0e75f12702c34

data/.gitignore

@@ -13,3 +13,7 @@
 *.o
 *.a
 mkmf.log
+
+# Ignore RuboCop's cache.
+.rubocop-https---raw-githubusercontent-com-PublicHealthEngland-ndr-dev-support-master--rubocop-yml
+

data/.rubocop.yml

@@ -1,29 +1 @@
-Rails:
-  Enabled: true
-
-# Multi-line method chaining should be done with trailing dots.
-Style/DotPosition:
-  EnforcedStyle: trailing
-
-# By default, would enforce { key: value } rather than { :key => value }.
-HashSyntax:
-  EnforcedStyle: hash_rockets
-  SupportedStyles:
-    - ruby19
-    - hash_rockets
-
-# Would enforce "-> { }", which we cannot use yet.
-Lambda:
-  Enabled: false
-
-# ...
-LineLength:
-  Max: 99
-
-# Relax some of the cops for tests
-Metrics/ClassLength:
-  Exclude:
-    - test/**/*.rb
-Metrics/MethodLength:
-  Exclude:
-    - test/**/*.rb
+inherit_from: 'https://raw.githubusercontent.com/PublicHealthEngland/ndr_dev_support/master/.rubocop.yml'

data/README.md

@@ -3,7 +3,7 @@
 This is the Public Health England (PHE) National Disease Registers (NDR) Support ruby gem, providing:
 
 1. core ruby class extensions;
-2. additional time, regular expression, file security and encoding classes.
+2. additional time, regular expression, file security, password checking/generation, and encoding classes.
 
 ## Installation
 
@@ -36,6 +36,7 @@ ndr_support extends/overrides the following core classes/modules:
 ndr_support adds the following classes:
 
 - Daterange
+- NdrSupport::Password
 - Ourdate
 - Ourtime
 - RegexpRange

data/code_safety.yml

@@ -3,15 +3,11 @@ file safety:
   ".gitignore":
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 412c86abb7b5fa545c1d4895aad4fe50cbc41faf
-  ".hound.yml":
-    comments: 
-    reviewed_by: timgentry
-    safe_revision: 9605fa85dca3d70c85927d3f1f5818c20ad922f0
+    safe_revision: a02f14cbf1fc36fbaf820365fdedfdc9af326db1
   ".rubocop.yml":
     comments: 
-    reviewed_by: timgentry
-    safe_revision: bd7dbaf2c72eb4a8f74db498f4dea67e02c8cb60
+    reviewed_by: josh.pencheon
+    safe_revision: a02f14cbf1fc36fbaf820365fdedfdc9af326db1
   ".travis.yml":
     comments: diff failed; reviewed whole file
     reviewed_by: josh.pencheon
@@ -35,7 +31,7 @@ file safety:
   README.md:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 764eca3766b00dbd105f4deb33181ea3d7235056
+    safe_revision: 799d9fe4d76759958926c0385fc7f5d8e405d0d0
   Rakefile:
     comments: 
     reviewed_by: timgentry
@@ -59,7 +55,7 @@ file safety:
   lib/ndr_support.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 7c32f5a80c1fb7aaf6e850d4b0651a7b47640e15
+    safe_revision: f5d1ba50d378286c0541f300d73844240e2eb7c1
   lib/ndr_support/array.rb:
     comments: 
     reviewed_by: pauleves
@@ -104,6 +100,14 @@ file safety:
     comments: 
     reviewed_by: pauleves
     safe_revision: 4a4ed24d2cfe7e1736baadf4cf6e0fece6823be1
+  lib/ndr_support/password.rb:
+    comments: with input from brian.shand
+    reviewed_by: josh.pencheon
+    safe_revision: f5d1ba50d378286c0541f300d73844240e2eb7c1
+  lib/ndr_support/password/constants.rb:
+    comments: with input from brian.shand
+    reviewed_by: josh.pencheon
+    safe_revision: f5d1ba50d378286c0541f300d73844240e2eb7c1
   lib/ndr_support/regexp_range.rb:
     comments: 
     reviewed_by: pauleves
@@ -147,7 +151,7 @@ file safety:
   lib/ndr_support/version.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 6a0de6c085dc9b6f996f06dd6233f80ac6a1757d
+    safe_revision: 802eaa1206e0f179d403aa46c7826b1d4ab7b369
   lib/ndr_support/yaml/serialization_migration.rb:
     comments: 
     reviewed_by: timgentry
@@ -155,7 +159,7 @@ file safety:
   ndr_support.gemspec:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 9a2ce0c2cdefd4726df33199ca8f1a5ece6f3042
+    safe_revision: 7e4f3d4ea1befdf75533b92415f74c9afaca04a3
   test/array_test.rb:
     comments: 
     reviewed_by: timgentry
@@ -192,6 +196,10 @@ file safety:
     comments: 
     reviewed_by: timgentry
     safe_revision: 2a5d30674dc9dde336e1dbbbf3c8a98905647432
+  test/password_test.rb:
+    comments: with input from brian.shand
+    reviewed_by: josh.pencheon
+    safe_revision: f5d1ba50d378286c0541f300d73844240e2eb7c1
   test/regexp_range_test.rb:
     comments: 
     reviewed_by: timgentry
@@ -214,8 +222,8 @@ file safety:
     safe_revision: d30717902e767bd63a35c0482b9a3ee52b0cdc73
   test/string/conversions_test.rb:
     comments: 
-    reviewed_by: timgentry
-    safe_revision: 2a5d30674dc9dde336e1dbbbf3c8a98905647432
+    reviewed_by: josh.pencheon
+    safe_revision: dfb7d1b94fc4d1578ab2129096945d5d1a1094fe
   test/test_helper.rb:
     comments: 
     reviewed_by: timgentry

data/lib/ndr_support.rb

@@ -6,6 +6,7 @@ require 'ndr_support/integer'
 require 'ndr_support/nil'
 require 'ndr_support/ourdate'
 require 'ndr_support/ourtime'
+require 'ndr_support/password'
 require 'ndr_support/regexp_range'
 require 'ndr_support/safe_file'
 require 'ndr_support/safe_path'

data/lib/ndr_support/password.rb

@@ -0,0 +1,121 @@
+require 'ndr_support/password/constants'
+
+module NdrSupport
+  # Contains logic for checking and generating secure passwords,
+  # in line with CESG guidelines.
+  module Password
+    include Constants
+
+    extend self
+
+    # Is the given `string` deemed a good password?
+    # An additional `word_list` can be provided; its entries add only
+    # minimally when considering the strength of `string`.
+    #
+    #   NdrSupport::Password.valid?('google password')    #=> false
+    #   NdrSupport::Password.valid?(SecureRandom.hex(12)) #=> true
+    #
+    def valid?(string, word_list: [])
+      string = prepare_string(string.to_s.dup)
+      slug   = slugify(strip_common_words(string, word_list))
+
+      meets_requirements?(slug)
+    end
+
+    # Generates a random #valid? password, using the 2048-word RFC1751 dictionary.
+    # Optionally, specify `number_of_words` and/or `separator`.
+    #
+    #   NdrSupport::Password.generate #=> "sill quod okay phi"
+    #   NdrSupport::Password.generate #=> "dint dale pew wane"
+    #   NdrSupport::Password.generate #=> "rent jude ding gent"
+    #
+    #   NdrSupport::Password.generate(number_of_words: 6) #=> "dad bide thee glen road beam"
+    #
+    #   NdrSupport::Password.generate(separator: '-') #=> "jail-net-skim-cup"
+    #
+    # Raises a RuntimeError if a strong enough password was not produced:
+    #
+    #   NdrSupport::Password.generate(number_of_words: 1) #=>
+    #     RuntimeError: Failed to generate a #valid? password!
+    #
+    def generate(number_of_words: 4, separator: ' ')
+      attempts = 0
+
+      loop do
+        words = Array.new(number_of_words) do
+          RFC1751_WORDS[SecureRandom.random_number(RFC1751_WORDS.length)].downcase
+        end
+
+        phrase = words.join(separator)
+        return phrase if valid?(phrase)
+
+        attempts += 1
+        raise 'Failed to generate a #valid? password!' if attempts > 10
+      end
+    end
+
+    private
+
+    def meets_requirements?(string)
+      string.length >= 6 && string.chars.uniq.length >= 5
+    end
+
+    def strip_common_words(string, common_words)
+      common_words += COMMON_PASSWORDS
+
+      # Try the longest common words first, in case some are substrings of others:
+      common_words = common_words.sort_by(&:length).reverse
+
+      common_words.each do |common_word|
+        pattern = prepare_string(common_word)
+
+        # Don't try to remove things that #slugify will be able to remove
+        # at least as effectively: [#6950#note-12]
+        next if slugify(pattern).length <= 2
+
+        string.gsub!(pattern) { |word| word.chars.first + word.chars.last }
+      end
+
+      string
+    end
+
+    def slugify(string)
+      input  = string.chars
+      output = []
+
+      until input.length.zero?
+        sequence = [input.shift]
+        sequence << input.shift while input.any? && no_added_value?(sequence.last, input.first)
+
+        sequence.slice!(1..-2) # discard interior of sequence
+        output.concat(sequence.uniq)
+      end
+
+      output.join
+    end
+
+    def no_added_value?(a, b)
+      sequential?(a, b) || repeating?(a, b)
+    end
+
+    def repeating?(a, b)
+      a == b
+    end
+
+    def sequential?(a, b, check_inverse: true)
+      # avoid non-alphanumeric characters being considered for sequencing:
+      # ';'.next #=> '<'
+      return false unless sequencible?(a) && sequencible?(b)
+
+      (a.next == b && b.length == 1) || (check_inverse && sequential?(b, a, check_inverse: false))
+    end
+
+    def sequencible?(string)
+      /\A([a-z]|[0-9])\z/i =~ string
+    end
+
+    def prepare_string(string)
+      string.downcase
+    end
+  end
+end

data/lib/ndr_support/password/constants.rb

@@ -0,0 +1,126 @@
+module NdrSupport
+  module Password
+    # Static lookups for password checking / generation
+    module Constants
+      COMMON_PASSWORDS = %w(
+        123456 123456789 qwerty 12345678 111111 1234567890 1234567 password
+        123123 987654321 qwertyuiop mynoob 123321 666666 18atcskd2w 7777777
+        1q2w3e4r 654321 555555 3rjs1la7qe google 1q2w3e4r5t 123qwe zxcvbnm
+      ).freeze
+
+      RFC1751_WORDS = %w(
+        A ABE ACE ACT AD ADA ADD AGO AID AIM AIR ALL ALP AM AMY AN ANA
+        AND ANN ANT ANY APE APS APT ARC ARE ARK ARM ART AS ASH ASK AT ATE AUG AUK AVE
+        AWE AWK AWL AWN AX AYE BAD BAG BAH BAM BAN BAR BAT BAY BE BED BEE BEG BEN BET
+        BEY BIB BID BIG BIN BIT BOB BOG BON BOO BOP BOW BOY BUB BUD BUG BUM BUN BUS BUT
+        BUY BY BYE CAB CAL CAM CAN CAP CAR CAT CAW COD COG COL CON COO COP COT COW COY
+        CRY CUB CUE CUP CUR CUT DAB DAD DAM DAN DAR DAY DEE DEL DEN DES DEW DID DIE DIG
+        DIN DIP DO DOE DOG DON DOT DOW DRY DUB DUD DUE DUG DUN EAR EAT ED EEL EGG EGO
+        ELI ELK ELM ELY EM END EST ETC EVA EVE EWE EYE FAD FAN FAR FAT FAY FED FEE FEW
+        FIB FIG FIN FIR FIT FLO FLY FOE FOG FOR FRY FUM FUN FUR GAB GAD GAG GAL GAM GAP
+        GAS GAY GEE GEL GEM GET GIG GIL GIN GO GOT GUM GUN GUS GUT GUY GYM GYP HA HAD
+        HAL HAM HAN HAP HAS HAT HAW HAY HE HEM HEN HER HEW HEY HI HID HIM HIP HIS HIT
+        HO HOB HOC HOE HOG HOP HOT HOW HUB HUE HUG HUH HUM HUT I ICY IDA IF IKE ILL
+        INK INN IO ION IQ IRA IRE IRK IS IT ITS IVY JAB JAG JAM JAN JAR JAW JAY JET JIG
+        JIM JO JOB JOE JOG JOT JOY JUG JUT KAY KEG KEN KEY KID KIM KIN KIT LA LAB LAC
+        LAD LAG LAM LAP LAW LAY LEA LED LEE LEG LEN LEO LET LEW LID LIE LIN LIP LIT LO
+        LOB LOG LOP LOS LOT LOU LOW LOY LUG LYE MA MAC MAD MAE MAN MAO MAP MAT MAW MAY
+        ME MEG MEL MEN MET MEW MID MIN MIT MOB MOD MOE MOO MOP MOS MOT MOW MUD MUG MUM
+        MY NAB NAG NAN NAP NAT NAY NE NED NEE NET NEW NIB NIL NIP NIT NO NOB NOD NON
+        NOR NOT NOV NOW NU NUN NUT O OAF OAK OAR OAT ODD ODE OF OFF OFT OH OIL OK
+        OLD ON ONE OR ORB ORE ORR OS OTT OUR OUT OVA OW OWE OWL OWN OX PA PAD PAL
+        PAM PAN PAP PAR PAT PAW PAY PEA PEG PEN PEP PER PET PEW PHI PI PIE PIN PIT PLY
+        PO POD POE POP POT POW PRO PRY PUB PUG PUN PUP PUT QUO RAG RAM RAN RAP RAT RAW
+        RAY REB RED REP RET RIB RID RIG RIM RIO RIP ROB ROD ROE RON ROT ROW ROY RUB RUE
+        RUG RUM RUN RYE SAC SAD SAG SAL SAM SAN SAP SAT SAW SAY SEA SEC SEE SEN SET SEW
+        SHE SHY SIN SIP SIR SIS SIT SKI SKY SLY SO SOB SOD SON SOP SOW SOY SPA SPY SUB
+        SUD SUE SUM SUN SUP TAB TAD TAG TAN TAP TAR TEA TED TEE TEN THE THY TIC TIE TIM
+        TIN TIP TO TOE TOG TOM TON TOO TOP TOW TOY TRY TUB TUG TUM TUN TWO UN UP US
+        USE VAN VAT VET VIE WAD WAG WAR WAS WAY WE WEB WED WEE WET WHO WHY WIN WIT WOK
+        WON WOO WOW WRY WU YAM YAP YAW YE YEA YES YET YOU ABED ABEL ABET ABLE ABUT ACHE
+        ACID ACME ACRE ACTA ACTS ADAM ADDS ADEN AFAR AFRO AGEE AHEM AHOY AIDA AIDE AIDS AIRY AJAR
+        AKIN ALAN ALEC ALGA ALIA ALLY ALMA ALOE ALSO ALTO ALUM ALVA AMEN AMES AMID AMMO AMOK AMOS
+        AMRA ANDY ANEW ANNA ANNE ANTE ANTI AQUA ARAB ARCH AREA ARGO ARID ARMY ARTS ARTY ASIA ASKS
+        ATOM AUNT AURA AUTO AVER AVID AVIS AVON AVOW AWAY AWRY BABE BABY BACH BACK BADE BAIL BAIT
+        BAKE BALD BALE BALI BALK BALL BALM BAND BANE BANG BANK BARB BARD BARE BARK BARN BARR BASE
+        BASH BASK BASS BATE BATH BAWD BAWL BEAD BEAK BEAM BEAN BEAR BEAT BEAU BECK BEEF BEEN BEER
+        BEET BELA BELL BELT BEND BENT BERG BERN BERT BESS BEST BETA BETH BHOY BIAS BIDE BIEN BILE
+        BILK BILL BIND BING BIRD BITE BITS BLAB BLAT BLED BLEW BLOB BLOC BLOT BLOW BLUE BLUM BLUR
+        BOAR BOAT BOCA BOCK BODE BODY BOGY BOHR BOIL BOLD BOLO BOLT BOMB BONA BOND BONE BONG BONN
+        BONY BOOK BOOM BOON BOOT BORE BORG BORN BOSE BOSS BOTH BOUT BOWL BOYD BRAD BRAE BRAG BRAN
+        BRAY BRED BREW BRIG BRIM BROW BUCK BUDD BUFF BULB BULK BULL BUNK BUNT BUOY BURG BURL BURN
+        BURR BURT BURY BUSH BUSS BUST BUSY BYTE CADY CAFE CAGE CAIN CAKE CALF CALL CALM CAME CANE
+        CANT CARD CARE CARL CARR CART CASE CASH CASK CAST CAVE CEIL CELL CENT CERN CHAD CHAR CHAT
+        CHAW CHEF CHEN CHEW CHIC CHIN CHOU CHOW CHUB CHUG CHUM CITE CITY CLAD CLAM CLAN CLAW CLAY
+        CLOD CLOG CLOT CLUB CLUE COAL COAT COCA COCK COCO CODA CODE CODY COED COIL COIN COKE COLA
+        COLD COLT COMA COMB COME COOK COOL COON COOT CORD CORE CORK CORN COST COVE COWL CRAB CRAG
+        CRAM CRAY CREW CRIB CROW CRUD CUBA CUBE CUFF CULL CULT CUNY CURB CURD CURE CURL CURT CUTS
+        DADE DALE DAME DANA DANE DANG DANK DARE DARK DARN DART DASH DATA DATE DAVE DAVY DAWN DAYS
+        DEAD DEAF DEAL DEAN DEAR DEBT DECK DEED DEEM DEER DEFT DEFY DELL DENT DENY DESK DIAL DICE
+        DIED DIET DIME DINE DING DINT DIRE DIRT DISC DISH DISK DIVE DOCK DOES DOLE DOLL DOLT DOME
+        DONE DOOM DOOR DORA DOSE DOTE DOUG DOUR DOVE DOWN DRAB DRAG DRAM DRAW DREW DRUB DRUG DRUM
+        DUAL DUCK DUCT DUEL DUET DUKE DULL DUMB DUNE DUNK DUSK DUST DUTY EACH EARL EARN EASE EAST
+        EASY EBEN ECHO EDDY EDEN EDGE EDGY EDIT EDNA EGAN ELAN ELBA ELLA ELSE EMIL EMIT EMMA ENDS
+        ERIC EROS EVEN EVER EVIL EYED FACE FACT FADE FAIL FAIN FAIR FAKE FALL FAME FANG FARM FAST
+        FATE FAWN FEAR FEAT FEED FEEL FEET FELL FELT FEND FERN FEST FEUD FIEF FIGS FILE FILL FILM
+        FIND FINE FINK FIRE FIRM FISH FISK FIST FITS FIVE FLAG FLAK FLAM FLAT FLAW FLEA FLED FLEW
+        FLIT FLOC FLOG FLOW FLUB FLUE FOAL FOAM FOGY FOIL FOLD FOLK FOND FONT FOOD FOOL FOOT FORD
+        FORE FORK FORM FORT FOSS FOUL FOUR FOWL FRAU FRAY FRED FREE FRET FREY FROG FROM FUEL FULL
+        FUME FUND FUNK FURY FUSE FUSS GAFF GAGE GAIL GAIN GAIT GALA GALE GALL GALT GAME GANG GARB
+        GARY GASH GATE GAUL GAUR GAVE GAWK GEAR GELD GENE GENT GERM GETS GIBE GIFT GILD GILL GILT
+        GINA GIRD GIRL GIST GIVE GLAD GLEE GLEN GLIB GLOB GLOM GLOW GLUE GLUM GLUT GOAD GOAL GOAT
+        GOER GOES GOLD GOLF GONE GONG GOOD GOOF GORE GORY GOSH GOUT GOWN GRAB GRAD GRAY GREG GREW
+        GREY GRID GRIM GRIN GRIT GROW GRUB GULF GULL GUNK GURU GUSH GUST GWEN GWYN HAAG HAAS HACK
+        HAIL HAIR HALE HALF HALL HALO HALT HAND HANG HANK HANS HARD HARK HARM HART HASH HAST HATE
+        HATH HAUL HAVE HAWK HAYS HEAD HEAL HEAR HEAT HEBE HECK HEED HEEL HEFT HELD HELL HELM HERB
+        HERD HERE HERO HERS HESS HEWN HICK HIDE HIGH HIKE HILL HILT HIND HINT HIRE HISS HIVE HOBO
+        HOCK HOFF HOLD HOLE HOLM HOLT HOME HONE HONK HOOD HOOF HOOK HOOT HORN HOSE HOST HOUR HOVE
+        HOWE HOWL HOYT HUCK HUED HUFF HUGE HUGH HUGO HULK HULL HUNK HUNT HURD HURL HURT HUSH HYDE
+        HYMN IBIS ICON IDEA IDLE IFFY INCA INCH INTO IONS IOTA IOWA IRIS IRMA IRON ISLE ITCH ITEM
+        IVAN JACK JADE JAIL JAKE JANE JAVA JEAN JEFF JERK JESS JEST JIBE JILL JILT JIVE JOAN JOBS
+        JOCK JOEL JOEY JOHN JOIN JOKE JOLT JOVE JUDD JUDE JUDO JUDY JUJU JUKE JULY JUNE JUNK JUNO
+        JURY JUST JUTE KAHN KALE KANE KANT KARL KATE KEEL KEEN KENO KENT KERN KERR KEYS KICK KILL
+        KIND KING KIRK KISS KITE KLAN KNEE KNEW KNIT KNOB KNOT KNOW KOCH KONG KUDO KURD KURT KYLE
+        LACE LACK LACY LADY LAID LAIN LAIR LAKE LAMB LAME LAND LANE LANG LARD LARK LASS LAST LATE
+        LAUD LAVA LAWN LAWS LAYS LEAD LEAF LEAK LEAN LEAR LEEK LEER LEFT LEND LENS LENT LEON LESK
+        LESS LEST LETS LIAR LICE LICK LIED LIEN LIES LIEU LIFE LIFT LIKE LILA LILT LILY LIMA LIMB
+        LIME LIND LINE LINK LINT LION LISA LIST LIVE LOAD LOAF LOAM LOAN LOCK LOFT LOGE LOIS LOLA
+        LONE LONG LOOK LOON LOOT LORD LORE LOSE LOSS LOST LOUD LOVE LOWE LUCK LUCY LUGE LUKE LULU
+        LUND LUNG LURA LURE LURK LUSH LUST LYLE LYNN LYON LYRA MACE MADE MAGI MAID MAIL MAIN MAKE
+        MALE MALI MALL MALT MANA MANN MANY MARC MARE MARK MARS MART MARY MASH MASK MASS MAST MATE
+        MATH MAUL MAYO MEAD MEAL MEAN MEAT MEEK MEET MELD MELT MEMO MEND MENU MERT MESH MESS MICE
+        MIKE MILD MILE MILK MILL MILT MIMI MIND MINE MINI MINK MINT MIRE MISS MIST MITE MITT MOAN
+        MOAT MOCK MODE MOLD MOLE MOLL MOLT MONA MONK MONT MOOD MOON MOOR MOOT MORE MORN MORT MOSS
+        MOST MOTH MOVE MUCH MUCK MUDD MUFF MULE MULL MURK MUSH MUST MUTE MUTT MYRA MYTH NAGY NAIL
+        NAIR NAME NARY NASH NAVE NAVY NEAL NEAR NEAT NECK NEED NEIL NELL NEON NERO NESS NEST NEWS
+        NEWT NIBS NICE NICK NILE NINA NINE NOAH NODE NOEL NOLL NONE NOOK NOON NORM NOSE NOTE NOUN
+        NOVA NUDE NULL NUMB OATH OBEY OBOE ODIN OHIO OILY OINT OKAY OLAF OLDY OLGA OLIN OMAN OMEN
+        OMIT ONCE ONES ONLY ONTO ONUS ORAL ORGY OSLO OTIS OTTO OUCH OUST OUTS OVAL OVEN OVER OWLY
+        OWNS QUAD QUIT QUOD RACE RACK RACY RAFT RAGE RAID RAIL RAIN RAKE RANK RANT RARE RASH RATE
+        RAVE RAYS READ REAL REAM REAR RECK REED REEF REEK REEL REID REIN RENA REND RENT REST RICE
+        RICH RICK RIDE RIFT RILL RIME RING RINK RISE RISK RITE ROAD ROAM ROAR ROBE ROCK RODE ROIL
+        ROLL ROME ROOD ROOF ROOK ROOM ROOT ROSA ROSE ROSS ROSY ROTH ROUT ROVE ROWE ROWS RUBE RUBY
+        RUDE RUDY RUIN RULE RUNG RUNS RUNT RUSE RUSH RUSK RUSS RUST RUTH SACK SAFE SAGE SAID SAIL
+        SALE SALK SALT SAME SAND SANE SANG SANK SARA SAUL SAVE SAYS SCAN SCAR SCAT SCOT SEAL SEAM
+        SEAR SEAT SEED SEEK SEEM SEEN SEES SELF SELL SEND SENT SETS SEWN SHAG SHAM SHAW SHAY SHED
+        SHIM SHIN SHOD SHOE SHOT SHOW SHUN SHUT SICK SIDE SIFT SIGH SIGN SILK SILL SILO SILT SINE
+        SING SINK SIRE SITE SITS SITU SKAT SKEW SKID SKIM SKIN SKIT SLAB SLAM SLAT SLAY SLED SLEW
+        SLID SLIM SLIT SLOB SLOG SLOT SLOW SLUG SLUM SLUR SMOG SMUG SNAG SNOB SNOW SNUB SNUG SOAK
+        SOAR SOCK SODA SOFA SOFT SOIL SOLD SOME SONG SOON SOOT SORE SORT SOUL SOUR SOWN STAB STAG
+        STAN STAR STAY STEM STEW STIR STOW STUB STUN SUCH SUDS SUIT SULK SUMS SUNG SUNK SURE SURF
+        SWAB SWAG SWAM SWAN SWAT SWAY SWIM SWUM TACK TACT TAIL TAKE TALE TALK TALL TANK TASK TATE
+        TAUT TEAL TEAM TEAR TECH TEEM TEEN TEET TELL TEND TENT TERM TERN TESS TEST THAN THAT THEE
+        THEM THEN THEY THIN THIS THUD THUG TICK TIDE TIDY TIED TIER TILE TILL TILT TIME TINA TINE
+        TINT TINY TIRE TOAD TOGO TOIL TOLD TOLL TONE TONG TONY TOOK TOOL TOOT TORE TORN TOTE TOUR
+        TOUT TOWN TRAG TRAM TRAY TREE TREK TRIG TRIM TRIO TROD TROT TROY TRUE TUBA TUBE TUCK TUFT
+        TUNA TUNE TUNG TURF TURN TUSK TWIG TWIN TWIT ULAN UNIT URGE USED USER USES UTAH VAIL VAIN
+        VALE VARY VASE VAST VEAL VEDA VEIL VEIN VEND VENT VERB VERY VETO VICE VIEW VINE VISE VOID
+        VOLT VOTE WACK WADE WAGE WAIL WAIT WAKE WALE WALK WALL WALT WAND WANE WANG WANT WARD WARM
+        WARN WART WASH WAST WATS WATT WAVE WAVY WAYS WEAK WEAL WEAN WEAR WEED WEEK WEIR WELD WELL
+        WELT WENT WERE WERT WEST WHAM WHAT WHEE WHEN WHET WHOA WHOM WICK WIFE WILD WILL WIND WINE
+        WING WINK WINO WIRE WISE WISH WITH WOLF WONT WOOD WOOL WORD WORE WORK WORM WORN WOVE WRIT
+        WYNN YALE YANG YANK YARD YARN YAWL YAWN YEAH YEAR YELL YOGA YOKE
+      ).freeze
+    end
+  end
+end

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.1.0'
+  VERSION = '5.2.0'
 end

data/ndr_support.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '>= 5.0.0'
   spec.add_development_dependency 'mocha', '~> 1.1'
 
-  spec.add_development_dependency 'ndr_dev_support', '~> 1.1', '>= 1.1.3'
+  spec.add_development_dependency 'ndr_dev_support', '~> 2.0'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'listen', '< 3.1' # Bundle 1.12 should be (but isn't) resolving Ruby 2.1 issue
   spec.add_development_dependency 'guard-rubocop'

data/test/password_test.rb

@@ -0,0 +1,129 @@
+require 'test_helper'
+
+# Tests password generation and checking library
+class PasswordTest < Minitest::Test
+  test 'checking length requirement' do
+    refute NdrSupport::Password.valid?('acegi')
+    assert NdrSupport::Password.valid?('acegik')
+  end
+
+  test 'checking character uniqueness requirement' do
+    refute NdrSupport::Password.valid?('acegacegacegacegacegacegaceg')
+    assert NdrSupport::Password.valid?('acefhacefhacefhacefhacefhace')
+  end
+
+  test 'when checking, dictionary words are considered' do
+    refute NdrSupport::Password.valid?('google password')
+    assert NdrSupport::Password.valid?('google the password')
+  end
+
+  test 'when checking, custom dictionary words are considered' do
+    refute NdrSupport::Password.valid?('google passphrase',     word_list: ['passphrase'])
+    assert NdrSupport::Password.valid?('google the passphrase', word_list: ['passphrase'])
+  end
+
+  test 'when checking, custom dictionary words that are also sequences are not over-counted' do
+    refute NdrSupport::Password.valid?('hijkl a ',  word_list: %w(hijkl hijklm))
+    refute NdrSupport::Password.valid?('hijklm a ', word_list: %w(hijkl hijklm))
+  end
+
+  test 'when checking, custom dictionary words substrings of others should not intefere' do
+    refute NdrSupport::Password.valid?('acegik a', word_list: %w(cegi acegik))
+    refute NdrSupport::Password.valid?('acegik a', word_list: %w(acegik cegi))
+  end
+
+  test 'checking blank input' do
+    refute NdrSupport::Password.valid?(nil)
+    refute NdrSupport::Password.valid?('')
+    refute NdrSupport::Password.valid?('                    ')
+  end
+
+  test 'checking with increasing sequences' do
+    refute NdrSupport::Password.valid?('12345678')
+    refute NdrSupport::Password.valid?('1234 5678')
+    refute NdrSupport::Password.valid?('456789')
+    refute NdrSupport::Password.valid?('456 789')
+    refute NdrSupport::Password.valid?('abcdefghijk')
+    refute NdrSupport::Password.valid?('abcde fghijk')
+    refute NdrSupport::Password.valid?('BCDEFGHIJKL')
+    refute NdrSupport::Password.valid?('BCDEFG HIJKL')
+
+    assert NdrSupport::Password.valid?('more 1234 5678')
+    assert NdrSupport::Password.valid?('1234 more 5678')
+    assert NdrSupport::Password.valid?('1234 5678 more')
+  end
+
+  test 'checking with decreasing sequences' do
+    refute NdrSupport::Password.valid?('87654321')
+    refute NdrSupport::Password.valid?('8765 4321')
+    refute NdrSupport::Password.valid?('987654')
+    refute NdrSupport::Password.valid?('987 654')
+    refute NdrSupport::Password.valid?('kjihgfedcba')
+    refute NdrSupport::Password.valid?('kjihg fedcba')
+    refute NdrSupport::Password.valid?('LKJIHGFEDCB')
+    refute NdrSupport::Password.valid?('LKJIHG FEDCB')
+
+    assert NdrSupport::Password.valid?('more 8765 4321')
+    assert NdrSupport::Password.valid?('8765 more 4321')
+    assert NdrSupport::Password.valid?('8765 4321 more')
+  end
+
+  test 'checking with increasing then decreasing sequences' do
+    refute NdrSupport::Password.valid?('123456787654321')
+    refute NdrSupport::Password.valid?('aBcDeFgFeDcBa')
+
+    assert NdrSupport::Password.valid?('something 123456787654321')
+    assert NdrSupport::Password.valid?('something aBcDeFgFeDcBa')
+  end
+
+  test 'checking with decreasing then increasing sequences' do
+    refute NdrSupport::Password.valid?('876543212345678')
+    refute NdrSupport::Password.valid?('gFeDcBaBcDeFg')
+
+    assert NdrSupport::Password.valid?('something 876543212345678')
+    assert NdrSupport::Password.valid?('something gFeDcBaBcDeFg')
+  end
+
+  test 'checking with repeating characters' do
+    refute NdrSupport::Password.valid?('happen')
+    assert NdrSupport::Password.valid?('happens')
+    assert NdrSupport::Password.valid?('hapqren')
+    assert NdrSupport::Password.valid?('hapqsen')
+
+    refute NdrSupport::Password.valid?('balloon')
+    refute NdrSupport::Password.valid?('ballllLLLllLLLllllooooOOooOOoooon')
+    assert NdrSupport::Password.valid?('baileon')
+  end
+
+  test 'generating' do
+    password = NdrSupport::Password.generate
+
+    assert NdrSupport::Password.valid?(password)
+    assert_equal 4, password.split(/\s/).length
+
+    password.scan(/\w+/) { |wd| assert NdrSupport::Password::RFC1751_WORDS.include?(wd.upcase) }
+  end
+
+  test 'generating with custom length' do
+    password = NdrSupport::Password.generate(number_of_words: 6)
+
+    assert NdrSupport::Password.valid?(password)
+    assert_equal 6, password.split(/\s/).length
+
+    password.scan(/\w+/) { |wd| assert NdrSupport::Password::RFC1751_WORDS.include?(wd.upcase) }
+  end
+
+  test 'generating with custom separator' do
+    password = NdrSupport::Password.generate(separator: '-')
+
+    assert NdrSupport::Password.valid?(password)
+    assert_equal 4, password.split(/-/).length
+
+    password.scan(/\w+/) { |wd| assert NdrSupport::Password::RFC1751_WORDS.include?(wd.upcase) }
+  end
+
+  test 'generating unrealistically' do
+    exception = assert_raises(RuntimeError) { NdrSupport::Password.generate(number_of_words: 1) }
+    assert_match(/failed to generate/i, exception.message)
+  end
+end

data/test/string/conversions_test.rb

@@ -169,9 +169,9 @@ class String::ConversionsTest < Minitest::Test
 
     # ONS wildcard date formats
     # (cannot convert to a Date, but need to parse into EBaseRecord date fields)
-    assert_equal nil, '19450000'.to_date('yyyymmdd')
-    assert_equal nil, '19450300'.to_date('yyyymmdd')
-    assert_equal nil, '19450013'.to_date('yyyymmdd')
+    assert_nil '19450000'.to_date('yyyymmdd')
+    assert_nil '19450300'.to_date('yyyymmdd')
+    assert_nil '19450013'.to_date('yyyymmdd')
 
     # parse our own date format correctly, regardless of format specification
     assert_equal Ourdate.build_datetime(1998, 02, 13), '13.02.1998'.to_date('yyyymmdd')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_support
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -112,20 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -231,7 +225,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".hound.yml"
 - ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -257,6 +250,8 @@ files:
 - lib/ndr_support/nil.rb
 - lib/ndr_support/ourdate.rb
 - lib/ndr_support/ourtime.rb
+- lib/ndr_support/password.rb
+- lib/ndr_support/password/constants.rb
 - lib/ndr_support/regexp_range.rb
 - lib/ndr_support/safe_file.rb
 - lib/ndr_support/safe_path.rb
@@ -279,6 +274,7 @@ files:
 - test/nil_test.rb
 - test/ourdate_test.rb
 - test/ourtime_test.rb
+- test/password_test.rb
 - test/regexp_range_test.rb
 - test/resources/filesystem_paths.yml
 - test/safe_file_test.rb
@@ -324,6 +320,7 @@ test_files:
 - test/nil_test.rb
 - test/ourdate_test.rb
 - test/ourtime_test.rb
+- test/password_test.rb
 - test/regexp_range_test.rb
 - test/resources/filesystem_paths.yml
 - test/safe_file_test.rb

data/.hound.yml

@@ -1,10 +0,0 @@
-fail_on_violations: true
-
-coffeescript:
-  enabled: false
-javascript:
-  enabled: false
-ruby:
-  config_file: .rubocop.yml
-scss:
-  enabled: false