Port over dogs from stympy/faker (DiUS#310)

Author: dennyac

README.md

@@ -72,6 +72,7 @@ Fakers
 * Crypto
 * DateAndTime
 * Demographic
+* Dog
 * DragonBall
 * Educator
 * Esports

src/main/java/com/github/javafaker/Dog.java

@@ -0,0 +1,42 @@
+package com.github.javafaker;
+
+public class Dog {
+
+    private final Faker faker;
+
+    protected Dog(Faker faker) {
+        this.faker = faker;
+    }
+
+    public String name() {
+        return faker.fakeValuesService().resolve("dog.name", this, faker);
+    }
+
+    public String breed() {
+        return faker.fakeValuesService().resolve("dog.breed", this, faker);
+    }
+
+    public String sound() {
+        return faker.fakeValuesService().resolve("dog.sound", this, faker);
+    }
+
+    public String memePhrase() {
+        return faker.fakeValuesService().resolve("dog.meme_phrase", this, faker);
+    }
+
+    public String age() {
+        return faker.fakeValuesService().resolve("dog.age", this, faker);
+    }
+
+    public String coatLength() {
+        return faker.fakeValuesService().resolve("dog.coat_length", this, faker);
+    }
+
+    public String gender() {
+        return faker.fakeValuesService().resolve("dog.gender", this, faker);
+    }
+
+    public String size() {
+        return faker.fakeValuesService().resolve("dog.size", this, faker);
+    }
+}

src/main/java/com/github/javafaker/Faker.java

@@ -45,6 +45,7 @@ public class Faker {
     private final GameOfThrones gameOfThrones;
     private final DateAndTime dateAndTime;
     private final Demographic demographic;
+    private final Dog dog;
     private final Educator educator;
     private final Shakespeare shakespeare;
     private final SlackEmoji slackEmoji;
@@ -128,6 +129,7 @@ public Faker(Locale locale, Random random) {
         this.gameOfThrones = new GameOfThrones(this);
         this.dateAndTime = new DateAndTime(this);
         this.demographic = new Demographic(this);
+        this.dog = new Dog(this);
         this.educator = new Educator(this);
         this.shakespeare = new Shakespeare(this);
         this.slackEmoji = new SlackEmoji(this);
@@ -403,6 +405,10 @@ public Demographic demographic() {
         return demographic;
     }
 
+    public Dog dog() {
+        return dog;
+    }
+
     public Educator educator() {
         return educator;
     }

src/main/resources/en.yml

@@ -529,6 +529,15 @@ en:
       demonym: ["Afghan","Albanian","Algerian","American","Andorran","Angolan","Argentine","Armenian","Aromanian","Aruban","Australian","Austrian","Azerbaijani","Bahamian","Bahraini","Bangladeshi","Barbadian","Basotho","Basque","Belarusian","Belgian","Belizean","Bermudian","Bissau-Guinean","Boer","Bosniak","Brazilian","Breton","Briton","British Virgin Islander","Bruneian","Bulgarian","Burkinabè","Burundian","Cambodian","Cameroonian","Canadian","Catalan","Cape Verdean","Chadian","Chilean","Chinese","Colombian","Comorian","Congolese","Croatian","Cuban","Cypriot","Czech","Dane","Dominican","Dutch","East Timorese","Ecuadorian","Egyptian","Emirati","English","Eritrean","Estonian","Ethiopian","Falkland Islander","Faroese","Finn","Fijian","Filipino","French","Georgian","German","Ghanaian","Gibraltar","Greek","Grenadian","Guatemalan","French Guianan","Guinean","Guyanese","Haitian","Honduran","Hong Konger","Hungarian","Icelander","I-Kiribati","Indian","Indonesian","Iranian","Iraqi","Irish","Israeli","Italian","Ivoirian","Jamaican","Japanese","Jordanian","Kazakh","Kenyan","Korean","Kosovar","Kurd","Kuwaiti","Kyrgyz","Lao","Latvian","Lebanese","Liberian","Libyan","Liechtensteiner","Lithuanian","Luxembourger","Macanese","Macedonian","Malagasy","Malaysian","Malawian","Maldivian","Malian","Maltese","Manx","Mauritian","Mexican","Moldovan","Moroccan","Mongolian","Montenegrin","Namibian","Nepalese","New Zealander","Nicaraguan","Nigerien","Nigerian","Norwegian","Pakistani","Palauan","Palestinian","Panamanian","Papua New Guinean","Paraguayan","Peruvian","Pole","Portuguese","Puerto Rican","Quebecer","Romanian","Russian","Rwandan","Salvadoran","São Toméan","Saudi","Scottish","Senegalese","Serb","Sierra Leonean","Singaporean","Sindhian","Slovak","Slovene","Somali","Somalilander","South African","Spaniard","Sri Lankan","St Lucian","Sudanese","Surinamese","Swede","Swiss","Syriac","Syrian","Tajik","Taiwanese","Tanzanian","Thai","Tibetan","Tobagonian","Trinidadian","Tunisian","Turk","Tuvaluan","Ugandan","Ukrainian","Uruguayan","Uzbek","Vanuatuan","Venezuelan","Vietnamese","Welsh","Yemeni","Zambian","Zimbabwean"]
       educational_attainment: ["No schooling completed", "Nursery school", "Kindergarten", "Grade 1 though 11", "12th grade - No Diploma", "Regular high school diploma", "GED or alternative credential", "Some college", "Associate's degree", "Bachelor's degree", "Master's degree", "Professional degree", "Doctorate degree"]
       marital_status: ["Married", "Widowed", "Divorced", "Separated", "Never married"]
+    dog:
+      name: ["Buddy", "Max", "Bella", "Daisy", "Molly", "Rocky", "Lucy", "Bear", "Bailey", "Lucky", "Harley", "Maggie", "Princess", "Angel", "Charlie", "Sadie", "Jack", "Shadow", "Jake", "Coco", "Gizmo", "Chloe", "Sophie", "Toby", "Roxy", "Buster", "Ginger", "Lady", "Duke", "Baby", "Peanut", "Bandit", "Abby", "Sasha", "Lola", "Zoey", "Pepper", "Sam", "Gracie", "Sammy", "Precious", "Missy", "Riley", "Spike", "Lily", "Sassy", "Cooper", "Rusty", "Dakota", "Dixie", "Cody", "Lilly", "Zoe", "Cookie", "Chico", "Zeus", "Tucker", "Oreo", "Teddy", "Marley", "Oscar", "Honey", "Rex", "Tank", "Sugar", "Sandy", "Penny", "Tyson", "Chance", "Mia", "Diamond", "Bubba", "Blue", "Belle", "Shelby", "Rosie", "Casey", "Ruby", "Snoopy", "Cocoa", "Jasmine", "Diesel", "Patches", "Annie", "Sparky", "Taz", "Bruno", "Roxie", "Lexi", "Scooter", "Jasper", "Brutus", "Baxter", "Luna", "Snickers", "Misty", "Rascal", "Milo", "Murphy", "Bo", "Harvey"]
+      breed: ["Affenpinscher", "African", "Airedale", "Akita", "Appenzeller", "Basenji", "Beagle", "Bluetick", "Borzoi", "Bouvier", "Boxer", "Brabancon", "Briard", "Boston Bulldog", "French Bulldog", "Staffordshire Bullterrier", "Cairn", "Chihuahua", "Chow", "Clumber", "Border Collie", "Coonhound", "Cardigan Corgi", "Dachshund", "Great Dane", "Scottish Deerhound", "Dhole", "Dingo", "Doberman", "Norwegian Elkhound", "Entlebucher", "Eskimo", "Germanshepherd", "Italian Greyhound", "Groenendael", "Ibizan Hound", "Afghan Hound", "Basset Hound", "Blood Hound", "English Hound", "Walker Hound", "Husky", "Keeshond", "Kelpie", "Komondor", "Kuvasz", "Labrador", "Leonberg", "Lhasa", "Malamute", "Malinois", "Maltese", "Bull Mastiff", "Tibetan Mastiff", "Mexicanhairless", "Bernese Mountain", "Swiss Mountain", "Newfoundland", "Otterhound", "Papillon", "Pekinese", "Pembroke", "Miniature Pinscher", "German Pointer", "Pomeranian", "Miniature Poodle", "Standard Poodle", "Toy Poodle", "Pug", "Pyrenees", "Redbone", "Chesapeake Retriever", "Curly Retriever", "Flatcoated Retriever", "Golden Retriever", "Rhodesian Ridgeback", "Rottweiler", "Saluki", "Samoyed", "Schipperke", "Giant Schnauzer", "Miniature Schnauzer", "English Setter", "Gordon Setter", "Irish Setter", "English Sheepdog", "Shetland Sheepdog", "Shiba", "Shihtzu", "Blenheim Spaniel", "Brittany Spaniel", "Cocker Spaniel", "Irish Spaniel", "Japanese Spaniel", "Sussex Spaniel", "Welsh Spaniel", "English Springer", "Stbernard", "American Terrier", "Australian Terrier", "Bedlington Terrier", "Border Terrier", "Dandie Terrier", "Fox Terrier", "Irish Terrier", "Kerryblue Terrier", "Lakeland Terrier", "Norfolk Terrier", "Norwich Terrier", "Patterdale Terrier", "Rat Terrier", "Scottish Terrier", "Sealyham Terrier", "Silky Terrier", "Tibetan Terrier", "Toy Terrier", "Westhighland Terrier", "Wheaten Terrier", "Yorkshire Terrier", "Vizsla", "Weimaraner", "Whippet", "Irish Wolfhound"]
+      sound: ["woof", "woof woof", "bow wow", "ruff", "owooooo", "grrrrrr"]
+      meme_phrase: ["heck no pal", "11/10", "boop the snoot", "mlem", "blep", "long boi", "thicc doggo", "big ol' pupper", "smol pupperino", "zoom", "they're good dogs Brent"]
+      age: ["puppy", "young", "adult", "senior"]
+      coat_length: ["hairless", "short", "medium", "long", "wire", "curly"]
+      gender: ["female", "male"]
+      size: ["small", "medium", "large", "extra large"]
     harry_potter:
       characters: ["Hannah Abbott", "Bathsheda Babbling", "Ludo Bagman", "Bathilda Bagshot", "Marcus Belby", "Katie Bell", "Cuthbert Binns", "Phineas Nigellus Black", "Regulus Arcturus Black", "Sirius Black", "Broderick Bode", "Bogrod", "Amelia Bones", "Susan Bones", "Terry Boot", "Mr. Borgin", "Lavendar Brown", "Millicent Bulstrode", "Charity Burbage", "Frank Bryce", "Alecto Carrow", "Amycus Carrow", "Refinald Cattermole", "Mary Cattermole", "Cho Chang", "Penelope Clearwater", "Mrs. Cole", "Michael Corner", "Vincent Crabbe, Sr.", "Vincent Crabbe", "Dennis Creevey", "Dirk Cresswell", "Bartemius Crouch, Sr.", "Barty Crouch, Jr.", "Roger Davies", "John Dawlish", "Fleur Delacour", "Gabrielle Delacour", "Dedalus Diggle", "Amos Diggory", "Cedric Diggory", "Armando Dippet", "Elphias Doge", "Antonin Dolohov", "Abeforth Dumbledore", "Albus Dumbledore", "Ariana Dumbledore", "Dudley Dursley", "Marge Dursley", "Petunia Dursley", "Vernon Dursley", "Marietta Edgecombe", "Everard", "Arabella Figg", "Argus Filch", "Justin Finch-Fletchley", "Seamus Finnigan", "Marcus Flint", "Nicholas Flamel", "Mundungus Fletcher", "Filius Flitwick", "Florean Fortescue", "Cornelius Fudge", "Marvolo Gaunt", "Merope Gaunt", "Morfin Gaunt", "Anthony Goldstein", "Goyle Sr.", "Gregory Goyle", "Heromine Granger", "Gregorovitch", "Fenrir Greyback", "Gellert Grindelwald", "Wilhelmina Grubbly-Plank", "Godric Gryffindor", "Astoria Greengrass", "Rubeus Hagrid", "Rolanda Hooch", "Mafalda Hopkirk", "Helga Hufflepuff", "Andelina Johnson", "Lee Jordan", "Bertha Jorkins", "Igor Karkaroff", "Viktor Krum", "Bellatrix Lestrange", "Rabastan Lestrange", "Rodolphus Lestrange", "Gilderoy Lockhart", "Alice Longbottom", "Augusta Longbottom", "Frank Longbottom", "Neville Longbottom", "Luna Lovegood", "Xenophilius Lovegood", "Remus Lupin", "Walden Macnair", "Draco Malfoy", "Lucius Malfoy", "Narcissa Malfoy", "Madam Malkin", "Griselda Marchbanks", "Olympe Maxime", "Ernine Macmillan", "Minerva McGonagall", "Cormac McLaggen", "Graham Montague", "Alaster (Mad-Eye) Moody", "Moran", "Theodore Nott", "Bob Ogden", "Garrick Ollivander", "Pansy Parkinson", "Padma Patil", "Parvati Patil", "Petter Pettigrew", "Antioch Peverell", "Antioch Peverell", "Cadmus Peverell", "Ignotus Peverell", "Irma Prince", "Sturgis Podmore", "Poppy Pomfrey", "Harry Potter", "James Potter", "Lily Potter", "Fabian Prewett", "Gideon Prewett", "Quirinus Quirrell", "Helena Ravenclaw (The Grey Lady)", "Rowena Ravenclaw", "Tom Marvolo Riddle", "Mr. Roberts", "Demelza Robins", "Augustus Rookwood", "Albert Runcorn", "Scabior", "Newt Scamander", "Rolf Scamander", "Rufus Scrimgeour", "Kingsley Shacklebolt", "Stan Shunpike", "Aurora Sinistra", "Rita Skeeter", "Horace Slughorn", "Salazar Slytherin", "Hepzibah Smith", "Zacharias Smith", "Severus Snape", "Alicia Spinnet", "Pomona Sprout", "Pius Thicknesse", "Dean Thomas", "Andromeda Tonks", "Nymphadora Tonks", "Ted Tonks", "Travers", "Sybill Trelawney", "Wilky Twycross", "Dolores Jane Umbridge", "Emmeline Vance", "Romilda Vane", "Septima Vector", "Lord Voldemort", "Myrtle Warren", "Cassius Warrington", "Arthur Weasley", "Bill Weasley", "Charlie Weasley", "Fred Weasley", "George Weasley", "Ginny Weasley", "Molly Weasley", "Percy Weasley", "Ron Weasley", "Oliver Wood", "Kennilworthy Whisp", "Yaxley", "Blaise Zabini", "Aragog", "Bane", "Beedle the Bard", "The Bloody Baron", "Buckbeak", "Sir Cadogan", "Crookshanks", "Dobby", "Enid", "Errol", "Fang", "The Fat Friar", "Fridwulfa", "The Fat Lady", "Fawkes", "Firenze", "Fluffy", "Grawp", "Griphook", "Hedwig", "Hokey", "Kreacher", "Magorian", "Moaning Myrtle", "Mrs. Norris", "Great Aunt Muriel", "Nagini", "Nearly Headless Nick", "Norbert", "Peeves", "Pigwidgeon", "Madam Rosmerta", "Ronan", "Scabbers", "Trevor", "Winky"]
       locations: ["The Burrow", "Godric's Hollow", "Little Hangleton", "Malfoy Manor", "Number 12, Grimmauld Place", "Shell Cottage", "Sinner's End", "Beauxbatons", "Castlelobruxo", "Durmstrang", "Hogwarts", "Ilvermorny", "Mahoutokoro", "Uagadou", "Diagon Alley", "Eeylops Owl Emporium", "Florean Fortescue's Ice Cream Parlour", "Flourish & Blotts", "Gambol and Japes", "Gingotts Wizarding Bank", "Knockturn Alley", "Borgin & Burkes", "The Leaky Cauldron", "Madam Malkin's Robes for All Occasions", "Magical Menagerie", "Ollivanders", "Potage's Cauldron Shop", "Quality Quidditch Shop", "Slug and Jiggers Apothecary", "Stalls", "Twilfitt and Tatting's", "Weasleys' Wizard Wheezes", "Wiseacre's Wizarding Equipment", "Hogmeade", "The Three Broomsticks", "Honeydukes", "Zonko's Joke Shop", "Hogsmeade Station", "The Hog's Head", "Dervish & Banges", "Galdrags Wizardwear", "Scrivenshaft's Quill Shop", "Madam Puddifoot's", "Post Office", "Shrieking Shack", "Azkaban", "Ministry of Magic", "St. Mungo's Hospital for Magical Maladies and Injuries", "Numengard", "Platform 9 3/4"]

src/test/java/com/github/javafaker/DogTest.java

@@ -0,0 +1,49 @@
+package com.github.javafaker;
+
+import org.junit.Test;
+
+import static com.github.javafaker.matchers.MatchesRegularExpression.matchesRegularExpression;
+import static org.junit.Assert.assertThat;
+
+public class DogTest extends AbstractFakerTest {
+
+    @Test
+    public void name() {
+        assertThat(faker.dog().name(), matchesRegularExpression("[A-Za-z ]+"));
+    }
+
+    @Test
+    public void breed() {
+        assertThat(faker.dog().breed(), matchesRegularExpression("[A-Za-z ]+"));
+    }
+
+    @Test
+    public void sound() {
+        assertThat(faker.dog().sound(), matchesRegularExpression("[A-Za-z ]+"));
+    }
+
+    @Test
+    public void memePhrase() {
+        assertThat(faker.dog().memePhrase(), matchesRegularExpression("[A-Za-z0-9'\\/ ]+"));
+    }
+
+    @Test
+    public void age() {
+        assertThat(faker.dog().age(), matchesRegularExpression("[A-Za-z ]+"));
+    }
+
+    @Test
+    public void gender() {
+        assertThat(faker.dog().gender(), matchesRegularExpression("[A-Za-z ]+"));
+    }
+
+    @Test
+    public void coatLength() {
+        assertThat(faker.dog().coatLength(), matchesRegularExpression("[A-Za-z ]+"));
+    }
+
+    @Test
+    public void size() {
+        assertThat(faker.dog().size(), matchesRegularExpression("[A-Za-z ]+"));
+    }
+}

src/test/java/com/github/javafaker/integration/FakerIT.java

@@ -103,6 +103,7 @@ public void testAllFakerMethodsThatReturnStrings() throws Exception {
         testAllMethodsThatReturnStringsActuallyReturnStrings(faker.crypto());
         testAllMethodsThatReturnStringsActuallyReturnStrings(faker.demographic());
         testAllMethodsThatReturnStringsActuallyReturnStrings(faker.dragonBall());
+        testAllMethodsThatReturnStringsActuallyReturnStrings(faker.dog());
         testAllMethodsThatReturnStringsActuallyReturnStrings(faker.educator());
         testAllMethodsThatReturnStringsActuallyReturnStrings(faker.funnyName());
         testAllMethodsThatReturnStringsActuallyReturnStrings(faker.hitchhikersGuideToTheGalaxy());