Add missing documentation - Faker::Address to Faker::Myst

README.md

@@ -28,6 +28,7 @@ Contents
   - [Faker::Ancient](doc/ancient.md)
   - [Faker::App](doc/app.md)
   - [Faker::Appliance](doc/appliance.md)
+  - [Faker::Artist](doc/artist.md)
   - [Faker::AquaTeenHungerForce](doc/aqua_teen_hunger_force.md)
   - [Faker::Avatar](doc/avatar.md)
   - [Faker::BackToTheFuture](doc/back_to_the_future.md)
@@ -37,6 +38,7 @@ Contents
   - [Faker::Book](doc/book.md)
   - [Faker::Boolean](doc/boolean.md)
   - [Faker::BossaNova](doc/bossa_nova.md)
+  - [Faker::BreakingBad](doc/breaking_bad.md)
   - [Faker::Business](doc/business.md)
   - [Faker::Cannabis](doc/cannabis.md)
   - [Faker::Cat](doc/cat.md)
@@ -48,48 +50,54 @@ Contents
   - [Faker::Community](doc/community.md)
   - [Faker::Company](doc/company.md)
   - [Faker::Compass](doc/compass.md)
-  - [Faker::Currency](doc/currency.md)
   - [Faker::Crypto](doc/crypto.md)
+  - [Faker::Currency](doc/currency.md)
   - [Faker::Date](doc/date.md)
   - [Faker::Demographic](doc/demographic.md)
   - [Faker::Dessert](doc/dessert.md)
   - [Faker::Dog](doc/dog.md)
   - [Faker::Dota](doc/dota.md)
-  - [Faker::DragonBall](doc/dragon_ball.md)
   - [Faker::DrWho](doc/dr_who.md)
+  - [Faker::DragonBall](doc/dragon_ball.md)
   - [Faker::DumbAndDumber](doc/dumb_and_dumber.md)
   - [Faker::Dune](doc/dune.md)
   - [Faker::Educator](doc/educator.md)
   - [Faker::ElderScrolls](doc/elder_scrolls.md)
+  - [Faker::Esport](doc/esport.md)
   - [Faker::Fallout](doc/fallout.md)
   - [Faker::FamilyGuy](doc/family_guy.md)
+  - [Faker::FamousLastWords](doc/famous_last_words.md)
   - [Faker::File](doc/file.md)
   - [Faker::Fillmurray](doc/fillmurray.md)
+  - [Faker::Finance](doc/finance.md)
   - [Faker::Food](doc/food.md)
   - [Faker::Football](doc/football.md)
   - [Faker::Friends](doc/friends.md)
+  - [Faker::FunnyName](doc/funny_name.md)
   - [Faker::GameOfThrones](doc/game_of_thrones.md)
   - [Faker::Gender](doc/gender.md)
   - [Faker::Hacker](doc/hacker.md)
   - [Faker::HarryPotter](doc/harry_potter.md)
   - [Faker::HeyArnold](doc/hey_arnold.md)
   - [Faker::Hipster](doc/hipster.md)
+  - [Faker::HitchhikersGuideToTheGalaxy](doc/hitchhikers_guide_to_the_galaxy.md)
   - [Faker::Hobbit](doc/hobbit.md)
   - [Faker::HowIMetYourMother](doc/how_i_met_your_mother.md)
-  - [Faker::HitchhikersGuideToTheGalaxy](doc/hitchhikers_guide_to_the_galaxy.md)
   - [Faker::IDNumber](doc/id_number.md)
   - [Faker::Internet](doc/internet.md)
   - [Faker::Job](doc/job.md)
   - [Faker::Kpop](doc/kpop.md)
   - [Faker::LeagueOfLegends](doc/league_of_legends.md)
+  - [Faker::Lebowski](doc/lebowski.md)
   - [Faker::LordOfTheRings](doc/lord_of_the_rings.md)
+  - [Faker::Lorem](doc/lorem.md)
   - [Faker::LoremFlickr](doc/lorem_flickr.md)
   - [Faker::LoremPixel](doc/lorem_pixel.md)
-  - [Faker::Lorem](doc/lorem.md)
   - [Faker::Lovecraft](doc/lovecraft.md)
   - [Faker::Markdown](doc/markdown.md)
   - [Faker::Matz](doc/matz.md)
   - [Faker::Measurement](doc/measurement.md)
+  - [Faker::MichaelScott](doc/michael_scott.md)
   - [Faker::MostInterestingManInTheWorld](doc/most_interesting_man_in_the_world.md)
   - [Faker::Movie](doc/movie.md)
   - [Faker::Music](doc/music.md)

doc/address.md

@@ -43,4 +43,6 @@ Faker::Address.latitude #=> "-58.17256227443719"
 
 Faker::Address.longitude #=> "-156.65548382095133"
 
+Faker::Address.full_address #=> "282 Kevin Brook, Imogeneborough, CA 58517"
+
 ```

doc/aqua_teen_hunger_force.md

@@ -2,3 +2,4 @@
 
 ```ruby
 Faker::AquaTeenHungerForce.character #=> "Master Shake"
+```

doc/artist.md

@@ -0,0 +1,7 @@
+# Faker::Artist
+
+Available since version 1.8.8.
+
+```ruby
+Faker::Artist.name #=> "Michelangelo"
+```

doc/bitcoin.md

@@ -2,5 +2,6 @@
 
 ```ruby
 Faker::Bitcoin.address #=> "1HUoGjmgChmnxxYhz87YytV4gVjfPaExmh"
+
 Faker::Bitcoin.testnet_address #=> "msHGunDvoEwmVFXvd2Bub1SNw5RP1YHJaf"
 ```

doc/bossa_nova.md

@@ -2,5 +2,6 @@
 
 ```ruby
 Faker::BossaNova.artist #=> "Tom Jobin"
+
 Faker::BossaNova.song #=> "Chega de Saudade"
 ```

doc/breaking_bad.md

@@ -0,0 +1,9 @@
+# Faker::BreakingBad
+
+Available since version 1.8.8.
+
+```ruby
+Faker::BreakingBad.character #=> "Walter White"
+
+Faker::BreakingBad.episode #=> "Cancer Man"
+```

doc/commerce.md

@@ -13,10 +13,12 @@ Faker::Commerce.material #=> "Steel"
 Faker::Commerce.product_name #=> "Practical Granite Shirt"
 
 Faker::Commerce.price #=> "44.6"
+Faker::Commerce.price(range = 0..10.0, as_string = false) #=> "2.18"
 
 # Generate a random promotion code.
 # Optional argument digits = 6 for number of random digits in suffix
 Faker::Commerce.promotion_code #=> "AmazingDeal829102"
+Faker::Commerce.promotion_code(digits = 2) #=> "AmazingPrice57"
 
 Faker::Commerce.material #=> "Plastic"
 ```

doc/community.md

@@ -3,5 +3,5 @@
 ```ruby
 Faker::Community.characters #=> "Jeff Winger"
 
-Faker::Community.quote #=> I fear a political career could shine a negative light on my drug dealing."
+Faker::Community.quotes #=> I fear a political career could shine a negative light on my drug dealing."
 ```

doc/currency.md

@@ -6,5 +6,4 @@ Faker::Currency.name #=> "Swedish Krona"
 Faker::Currency.code #=> "USD"
 
 Faker::Currency.symbol #=> "$"
-
 ```

doc/dota.md

@@ -15,4 +15,5 @@ Faker::Dota.player #=> "Dendi"
 
 # Random quote
 Faker::Dota.quote #=> "Easy now, this stuff is explosive!"
+Faker::Dota.quote(hero = 'alchemist') #=> "Better living through alchemy!"
 ```

doc/dune.md

@@ -3,10 +3,16 @@
 
 ```ruby
 Faker::Dune.character #=> "Leto Atreides"
+
 Faker::Dune.title #=> "Duke"
+
 Faker::Dune.planet #=> "Caladan"
+
 Faker::Dune.quote #=> "A dead man, surely, no longer requires that water."
+
 Faker::Dune.quote("baron_harkonnen") #=> "He who controls the spice, controls the universe!"
+
 Faker::Dune.saying #=> "You do not beg the sun for mercy."
+
 Faker::Dune.saying("fremen") #=> "May thy knife chip and shatter."
 ```

doc/esport.md

@@ -0,0 +1,18 @@
+# Faker::Esport
+
+```ruby
+# Random player
+Faker::Esport.player #=> "Crimsix"
+
+# Random team
+Faker::Esport.team #=> "CLG"
+
+# Random league
+Faker::Esport.league #=> "IEM"
+
+# Random event
+Faker::Esport.event #=> "ESL Cologne"
+
+# Random game
+Faker::Esport.game #=> "Dota2"
+```

doc/finance.md

@@ -0,0 +1,8 @@
+# Faker::Finance
+
+```ruby
+# Random credit_card
+Faker::Finance.credit_card #=> "3018-348979-1853"
+Faker::Finance.credit_card(:mastercard) #=> "6771-8921-2291-6236"
+Faker::Finance.credit_card(:mastercard, :visa) #=> "4448-8934-1277-7195"
+```

doc/food.md

@@ -20,5 +20,4 @@ Faker::Food.measurement #=> "1/4 tablespoon"
 
 Faker::Food.metric_measurement #=> "centiliter"
 
-
 ```

doc/game_of_thrones.md

@@ -9,5 +9,7 @@ Faker::GameOfThrones.house #=> "Stark"
 
 Faker::GameOfThrones.city #=> "Lannisport"
 
+Faker::GameOfThrones.quote #=> "Never forget who you are. The rest of the world won't. Wear it like an armor and it can never be used against you."
+
 Faker::GameOfThrones.dragon #=> "Drogon"
 ```

doc/gender.md

@@ -2,5 +2,6 @@
 
 ```ruby
 Faker::Gender.type #=> "Non-binary"
+
 Faker::Gender.binary_type #=> "Female"
 ```

doc/hey_arnold.md

@@ -9,4 +9,5 @@ Faker::HeyArnold.character #=> "Arnold"
 Faker::HeyArnold.location #=> "Big Bob's Beeper Emporium"
 
 Faker::HeyArnold.quote #=> "Stoop Kid's afraid to leave his stoop!"
+
 ```

doc/internet.md

@@ -42,8 +42,6 @@ Faker::Internet.password(10, 20, true, true) #=> "*%NkOnJsH4"
 
 Faker::Internet.domain_name #=> "effertz.info"
 
-Faker::Internet.fix_umlauts('äöüß') #=> "aeoeuess"
-
 Faker::Internet.domain_word #=> "haleyziemann"
 
 Faker::Internet.domain_suffix #=> "info"

doc/kpop.md

@@ -1,6 +1,7 @@
 # Faker::Kpop
 
 ```ruby
+
 Faker::Kpop.i_groups # 1990's og groups =>  "Seo Taiji and Boys"
 
 Faker::Kpop.ii_groups # 2000's groups =>  "Girls' Generation"

doc/lebowski.md

@@ -0,0 +1,11 @@
+# Faker::Lebowski
+
+Available since version 1.8.8.
+
+```ruby
+Faker::Lebowski.actor #=> "John Goodman"
+
+Faker::Lebowski.character #=> "Jackie Treehorn"
+
+Faker::Lebowski.quote #=> "Forget it, Donny, you're out of your element!"
+```

doc/lorem.md

@@ -41,4 +41,8 @@ Faker::Lorem.paragraph(2, true, 4) #=> "Vomito unde uxor annus. Et patior utilis
 Faker::Lorem.paragraphs #=> ["Dolores quis quia ad quo voluptates. Maxime delectus totam numquam. Necessitatibus vel atque qui dolore.", "Id neque nemo. Dolores iusto facere est ad. Accusamus ipsa dolor ut.", "Et officiis ut hic. Sunt asperiores minus distinctio debitis ipsa dolor. Minima eos deleniti."]
 Faker::Lorem.paragraphs(1) #=> ["Labore voluptas sequi. Ratione nulla eaque quia molestiae fugit. At quam laboriosam aut ut dignissimos."]
 Faker::Lorem.paragraphs(1, true) #=> ["Depulso animi cunctatio amicitia adficio. Vester viduo qui despirmatio voluptas. Validus laudantium adopto ut agnitio venustas. Aer arcus odio esse."]
+
+# Optional arguments: question_count = 3, supplemental = false
+Faker::Lorem.question #=> "Aliquid culpa aut ipsam unde ullam labore?"
+Faker::Lorem.questions(3) #=> ["Necessitatibus deserunt animi?", "At hic dolores autem consequatur ut?", "Aliquam velit ex adipisci voluptatem placeat?"]
 ```

doc/measurement.md

@@ -1,8 +1,8 @@
 # Faker::Measurement
 
-# For each, if you don't pass in an integer or float, it randomly selects an integer between 1 and 10.
-# If you pass in "none", it returns the singular version of the measurement unit, without a number.
-# If you pass in "all", it returns the plural version of the measurement unit, without a number.
+### For each, if you don't pass in an integer or float, it randomly selects an integer between 1 and 10.
+### If you pass in "none", it returns the singular version of the measurement unit, without a number.
+### If you pass in "all", it returns the plural version of the measurement unit, without a number.
 
 ```ruby
 Faker::Measurement.height #=> "6 inches"

lib/faker/company.rb

@@ -43,6 +43,14 @@ def logo
         "https://pigment.github.io/fake-logos/logos/medium/color/#{rand_num}.png"
       end
 
+      def type
+        fetch('company.type')
+      end
+
+      def profession
+        fetch('company.profession')
+      end
+
       # rubocop:disable Style/AsciiComments
       # Get a random Spanish organization number. See more here https://es.wikipedia.org/wiki/Número_de_identificación_fiscal
       # rubocop:enable Style/AsciiComments
@@ -93,10 +101,6 @@ def australian_business_number
         (99 - (abn_checksum(abn) % 89)).to_s + base
       end
 
-      def profession
-        fetch('company.profession')
-      end
-
       # Get a random Polish taxpayer identification number More info https://pl.wikipedia.org/wiki/NIP
       def polish_taxpayer_identification_number
         result = []

lib/locales/en/lord_of_the_rings.yml

@@ -3,4 +3,4 @@ en:
     lord_of_the_rings:
       characters: ["Frodo Baggins", "Gandalf the Grey", "Samwise Gamgee", "Meriadoc Brandybuck", "Peregrin Took", "Aragorn", "Legolas", "Gimli", "Boromir", "Sauron", "Gollum", "Bilbo Baggins", "Tom Bombadil", "Glorfindel", "Elrond", "Arwen Evenstar", "Galadriel", "Saruman the White", "Éomer", "Théoden", "Éowyn", "Grìma Wormtongue", "Shadowfax", "Treebeard", "Quickbeam", "Shelob", "Faramir", "Denethor", "Beregond", "Barliman Butterbur"]
       locations: ["Aglarond", "Aldburg", "Andustar", "Angband", "Argonath", "Bag End", "Barad-dûr", "Black Gate", "Bridge of Khazad-dûm", "Carchost", "Cirith Ungol", "Coldfells", "Crack of Doom", "Dark Land", "Dol Guldur", "Dome of Stars", "Doors of Durin", "Doriath", "East Beleriand", "Eastfarthing", "East Road", "Eithel Sirion", "Elostirion", "Enchanted Isles", "Endless Stair", "Eä", "Falls of Rauros", "Fens of Serech", "Field of Celebrant", "Fords of Isen", "The Forsaken Inn", "Gap of Rohan", "Gladden Fields", "Gorgoroth", "Greenway", "Haudh-en-Nirnaeth", "Haven of the Eldar", "Helm's Deep", "Henneth Annûn", "Hobbit-hole", "Houses of Healing", "Hyarnustar", "Ilmen", "Inn of the Prancing Pony", "Isengard", "Isenmouthe", "Isle of Balar", "Land of the Sun", "Losgar", "Luthany", "Lothlorièn", "Maglor's Gap", "Marish", "Meduseld", "Minas Tirith", "Minhiriath", "Máhanaxar", "Narchost", "Nargothrond", "Núath", "Old Ford", "Old Forest", "Old Forest Road", "Orthanc", "Parth Galen", "Paths of the Dead", "Pelennor Fields", "Rath Dínen", "Regions of the Shire", "Rivendell", "The Rivers and Beacon-Hills of Gondor", "Sarn Ford", "Taur-en-Faroth", "Taur-im-Duinath", "Timeless Halls", "Tol Brandir", "Tol Galen", "Tol Morwen", "Tol-in-Gaurhoth", "Tumladen", "Utumno", "Vaiya", "Vista", "The Void", "Warning beacons of Gondor"]
-      quotes:   ["Often does hatred hurt itself!", "Go now, and die in what way seems best to you.", "Memory is not what the heart desires. That is only a mirror....", "Dwarves’ tongues run on when speaking of their handiwork, they say.", "But all’s well as ends well", "Sing, all ye children of the West", "...and all the stars flowered in the sky.", "Clothes are but little loss, if you escape from drowning.", "The wolf that one hears is worse than the orc that one fears. - Boromir", "I don't keep water in my pockets.", "For he gave it up in the end of his own accord: an important point. No,", "I could not 'make' you--except by force, which would break your mind.", "Their faces were as a rule good-natured rather than beautiful.", "The Lord of the Ringwraiths had met his doom.", "Many that live deserve death. And some that die deserve life", "Short cuts make delays, but inns make longer ones.", "But where the warg howls, there also the orc prowls. - Aragorn", "In winter here no heart could mourn for summer or for spring.","his old life lay behind in the mists, dark adventure lay in front.", "I sang of leaves, of leaves of gold, and leaves of gold there grew", "Someone else always has to carry on the story.", "It's the job that's never started as takes longest to finish.", "Moonlight drowns out all but the brightest stars.", "Fear nothing! Have peace until the morning! Heed no nightly noises!", "I’ll get there, if I leave everything but my bones behind,", "NO ADMITTANCE EXCEPT ON PARTY BUSINESS.", "Real names tell you the story of the things they belong to", "Deeds will not be less valiant because they are unpraised.", "Even the smallest person can change the course of the future.", "Who knows? Have patience. Go where you must go, and hope!", "Yet dawn is ever the hope of men,’ said Aragorn.", "You will soon be well, if I do not talk you to death.", "Memory is not what the heart desires. That is only a mirror,", "You have shown your usual cunning in getting up just in time for a meal.", "The great storm is coming, but the tide has turned.", "...as young and as ancient as Spring....", "Why couldn’t he stop talking and let them drink his health?", "Not all those who wander are lost", "But in this at least thou shalt not defy my will: to rule my own end.", "I look foul and feel fair.","It's the job that's never started as takes longest to finish.", "Moonlight drowns out all but the brightest stars.", "I didn't think it would end this way.", "Home is behind, the world ahead", "All's well that ends better.", "I want to be a healer, and love all things that grow and are not barren.", "Where there's life there's hope, and need of vittles.", "A hunted man sometimes wearies of distrust and longs for friendship.", "The leaves were long, the grass was green", "Begone, foul dwimmerlaik, lord of carrion! Leave the dead in peace!", "The world is indeed full of peril and in it there are many dark places.", "To the sea, to the sea! The white gulls are crying", "Do not scorn pity that is the gift of a gentle heart, Éowyn!", "I wish the Ring had never come to me. I wish none of this had happened."]
+      quotes: ["Often does hatred hurt itself!", "Go now, and die in what way seems best to you.", "Memory is not what the heart desires. That is only a mirror....", "Dwarves’ tongues run on when speaking of their handiwork, they say.", "But all’s well as ends well", "Sing, all ye children of the West", "...and all the stars flowered in the sky.", "Clothes are but little loss, if you escape from drowning.", "The wolf that one hears is worse than the orc that one fears. - Boromir", "I don't keep water in my pockets.", "For he gave it up in the end of his own accord: an important point. No,", "I could not 'make' you--except by force, which would break your mind.", "Their faces were as a rule good-natured rather than beautiful.", "The Lord of the Ringwraiths had met his doom.", "Many that live deserve death. And some that die deserve life", "Short cuts make delays, but inns make longer ones.", "But where the warg howls, there also the orc prowls. - Aragorn", "In winter here no heart could mourn for summer or for spring.","his old life lay behind in the mists, dark adventure lay in front.", "I sang of leaves, of leaves of gold, and leaves of gold there grew", "Someone else always has to carry on the story.", "It's the job that's never started as takes longest to finish.", "Moonlight drowns out all but the brightest stars.", "Fear nothing! Have peace until the morning! Heed no nightly noises!", "I’ll get there, if I leave everything but my bones behind,", "NO ADMITTANCE EXCEPT ON PARTY BUSINESS.", "Real names tell you the story of the things they belong to", "Deeds will not be less valiant because they are unpraised.", "Even the smallest person can change the course of the future.", "Who knows? Have patience. Go where you must go, and hope!", "Yet dawn is ever the hope of men,’ said Aragorn.", "You will soon be well, if I do not talk you to death.", "Memory is not what the heart desires. That is only a mirror,", "You have shown your usual cunning in getting up just in time for a meal.", "The great storm is coming, but the tide has turned.", "...as young and as ancient as Spring....", "Why couldn’t he stop talking and let them drink his health?", "Not all those who wander are lost", "But in this at least thou shalt not defy my will: to rule my own end.", "I look foul and feel fair.","It's the job that's never started as takes longest to finish.", "Moonlight drowns out all but the brightest stars.", "I didn't think it would end this way.", "Home is behind, the world ahead", "All's well that ends better.", "I want to be a healer, and love all things that grow and are not barren.", "Where there's life there's hope, and need of vittles.", "A hunted man sometimes wearies of distrust and longs for friendship.", "The leaves were long, the grass was green", "Begone, foul dwimmerlaik, lord of carrion! Leave the dead in peace!", "The world is indeed full of peril and in it there are many dark places.", "To the sea, to the sea! The white gulls are crying", "Do not scorn pity that is the gift of a gentle heart, Éowyn!", "I wish the Ring had never come to me. I wish none of this had happened."]

test/test_faker_company.rb

@@ -21,6 +21,10 @@ def test_buzzword
     assert @tester.buzzword.match(/\w+\.?/)
   end
 
+  def test_type
+    assert @tester.type.match(/\w+/)
+  end
+
   def test_spanish_organisation_number
     org_no = @tester.spanish_organisation_number
     assert org_no.match(/\D\d{7}/)