Skip to content

Commit

Permalink
Merge pull request #44 from stympy/master
Browse files Browse the repository at this point in the history
 Fix default values for arguments in Lorem doc (stympy#1636)
  • Loading branch information
sanikkenway committed Jun 21, 2019
2 parents 6279cc9 + b913e7c commit 211b147
Show file tree
Hide file tree
Showing 166 changed files with 188 additions and 3,704 deletions.
47 changes: 45 additions & 2 deletions CHANGELOG.md
Expand Up @@ -3,9 +3,25 @@
## HEAD Unreleased

### Bug/Fixes
### Chores
### Deprecation
### Documentation
### Feature Request
### Update/add locales

------------------------------------------------------------------------------

## [v1.9.4](https://github.com/stympy/faker/tree/v1.9.4) (2019-06-19)

### Bug/Fixes

- [PR #1605](https://github.com/stympy/faker/pull/1605) fix shallow_json for frozen_string_literal [@causztic](https://github.com/causztic)
- [PR #1597](https://github.com/stympy/faker/pull/1597) Fix broken test [@vbrazo](https://github.com/vbrazo)
- [PR #1578](https://github.com/stympy/faker/pull/1578) Namespaces should inherit Base [@vbrazo](https://github.com/vbrazo)

### Chores

- [PR #1626](https://github.com/stympy/faker/pull/1626) Update tty tree [@Zeragamba](https://github.com/Zeragamba)
- [PR #1559](https://github.com/stympy/faker/pull/1559) Fix name_with_middle field for en-AU [@psibi](https://github.com/psibi)
- [PR #1548](https://github.com/stympy/faker/pull/1548) Chore/improve pt-BR specs [@paulodiovani](https://github.com/paulodiovani)
- [PR #1542](https://github.com/stympy/faker/pull/1542) Fixed typos to the unreleased_README.md [@gkunwar](https://github.com/gkunwar)
Expand All @@ -19,17 +35,44 @@

### Documentation

- [PR #1636](https://github.com/stympy/faker/pull/1636) Fix default values for arguments in Lorem doc [@mikong](https://github.com/mikong)
- [PR #1617](https://github.com/stympy/faker/pull/1617) Fix Dota README [@TheSmartnik](https://github.com/TheSmartnik)
- [PR #1612](https://github.com/stympy/faker/pull/1612) Update returned example player [@ncallaway](https://github.com/ncallaway)
- [PR #1611](https://github.com/stympy/faker/pull/1611) Documentation error fix [@tomlockwood](https://github.com/tomlockwood)
- [PR #1575](https://github.com/stympy/faker/pull/1575) Add issues templates [@vbrazo](https://github.com/vbrazo)

### Feature Request

- [PR #1631](https://github.com/stympy/faker/pull/1631) Faker::Tezos: add block faker [@akettal](https://github.com/akettal)
- [PR #1619](https://github.com/stympy/faker/pull/1619) Add Faker::Music::Opera [@Adsidera](https://github.com/Adsidera)
- [PR #1607](https://github.com/stympy/faker/pull/1607) Add Faker::Game with title, genre, and platform generators. [@connorshea](https://github.com/connorshea)
- [PR #1603](https://github.com/stympy/faker/pull/1603) Add Faker::Internet.uuid [@ianks](https://github.com/ianks)
- [PR #1560](https://github.com/stympy/faker/pull/1560) Add Faker::Creature::Horse [@wndxlori](https://github.com/wndxlori)
- [PR #1507](https://github.com/stympy/faker/pull/1507) Add CLI - Integrate fakerbot 🤖 [@akabiru](https://github.com/akabiru)
- [PR #1540](https://github.com/stympy/faker/pull/1540) Add sic_code to company #355 [@bruno-b-martins](https://github.com/bruno-b-martins)
- [PR #1537](https://github.com/stympy/faker/pull/1537) Adds the Faker::Sports::Basketball generator [@ecbrodie](https://github.com/ecbrodie)
- [PR #1520](https://github.com/stympy/faker/pull/1520) Allow subdomains for Internet.domain_name [@cianooooo](https://github.com/cianooooo)

### Suggestion

### Update/add locales

- [PR #1629](https://github.com/stympy/faker/pull/1629) Fix sintax error on game.yml file [@ricardobsilva](https://github.com/ricardobsilva)
- [PR #1627](https://github.com/stympy/faker/pull/1627) add more data for Faker::Games [@BlazingRockStorm](https://github.com/BlazingRockStorm)
- [PR #1620](https://github.com/stympy/faker/pull/1620) Added Yuumi as a Champion [@eddorre](https://github.com/eddorre)
- [PR #1621](https://github.com/stympy/faker/pull/1621) Updated classes to match the changes that Blizzard rolled out late last year. Updated hero pool to add the latest two heroes added to the game. [@eddorre](https://github.com/eddorre)
- [PR #1602](https://github.com/stympy/faker/pull/1602) Remove white space, fix minor typos [@darylf](https://github.com/darylf)
- [PR #1595](https://github.com/stympy/faker/pull/1595) Fix accented French surnames [@Samy-Amar](https://github.com/Samy-Amar)
- [PR #1585](https://github.com/stympy/faker/pull/1585) Add Meepo to Dota heroes and quotes [@justinoue](https://github.com/justinoue)
- [PR #1594](https://github.com/stympy/faker/pull/1594) Changed Startrek to Stargate :) [@Defoncesko](https://github.com/Defoncesko)
- [PR #1591](https://github.com/stympy/faker/pull/1591) fix-chinese-city [@locez](https://github.com/locez)
- [PR #1592](https://github.com/stympy/faker/pull/1592) Add coffee country for Japanese [@schmurfy](https://github.com/schmurfy)
- [PR #1593](https://github.com/stympy/faker/pull/1593) removes duplicates in fr-CA and fr-CH [@schmurfy](https://github.com/schmurfy)
- [PR #1587](https://github.com/stympy/faker/pull/1587) Add ancient god for Japanese [@yizknn](https://github.com/yizknn)
- [PR #1582](https://github.com/stympy/faker/pull/1582) Add fighters and DLC to Faker::Games::SuperSmashBros [@boardfish](https://github.com/boardfish)
- [PR #1583](https://github.com/stympy/faker/pull/1583) updates to RuPaul [@notactuallypagemcconnell](https://github.com/notactuallypagemcconnell)
- [PR #1581](https://github.com/stympy/faker/pull/1581) add latest list of phish tunes from phish.net/song that are by the band and not covers [@notactuallypagemcconnell](https://github.com/notactuallypagemcconnell)
- [PR #1573](https://github.com/stympy/faker/pull/1573) Fix data of music albums [@sankichi92](https://github.com/sankichi92)
- [PR #1567](https://github.com/stympy/faker/pull/1567) Fix name_with_middle in Chinese locales [@rockymeza](https://github.com/rockymeza)
- [PR #1564](https://github.com/stympy/faker/pull/1564) Update League of legends content [@michebble](https://github.com/michebble)
- [PR #1558](https://github.com/stympy/faker/pull/1558) remove misspelling of Japanese [@michebble](https://github.com/michebble)
- [PR #1554](https://github.com/stympy/faker/pull/1554) Extend list of cryptocurrencies [@kamilbielawski](https://github.com/kamilbielawski)
- [PR #1552](https://github.com/stympy/faker/pull/1552) Fix subscription: Fix missing double quotes [@psibi](https://github.com/psibi)
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
faker (1.9.3)
faker (1.9.4)
i18n (>= 0.7)
pastel (~> 0.7.2)
thor (~> 0.20.0)
Expand Down
38 changes: 29 additions & 9 deletions README.md
@@ -1,3 +1,4 @@

![logotype a happy-07](https://user-images.githubusercontent.com/36028424/40263395-4318481e-5b44-11e8-92e5-3dcc1ce169b3.png)

# Faker
Expand All @@ -15,11 +16,14 @@ for the creation of this gem), having real-looking test data, and having your
database populated with more than one or two records while you're doing
development.

- [Installing](#installing)
- [Usage](#usage)
- [Faker](#faker)
- [NOTE](#note)
- [Installing](#installing)
- [Usage](#usage)
- [CLI](#cli)
- [Ensuring unique values](#ensuring-unique-values)
- [Deterministic Random](#deterministic-random)
- [Generators](#generators)
- [Generators](#generators)
- [Default](#default)
- [Blockchain](#blockchain)
- [Books](#books)
Expand All @@ -29,11 +33,12 @@ development.
- [Movies](#movies)
- [Music](#music)
- [Quotes](#quotes)
- [TV Shows](#tv-shows)
- [Customization](#customization)
- [Contributing](#contributing)
- [Contact](#contact)
- [License](#license)
- [Sports](#sports)
- [Tv Shows](#tv-shows)
- [Customization](#customization)
- [Contributing](#contributing)
- [Contact](#contact)
- [License](#license)

### NOTE
* While Faker generates data at random, returned values are not guaranteed to be unique by default.
Expand Down Expand Up @@ -62,6 +67,14 @@ Faker::Name.name #=> "Christophe Bartell"
Faker::Internet.email #=> "kirsten.greenholt@corkeryfisher.info"
```

### CLI

Usage Instructions [available here](https://github.com/stympy/faker/blob/master/lib/cli/README.md)

```bash
$ faker
```

### Ensuring unique values
Prefix your method call with `unique`. For example:
```ruby
Expand Down Expand Up @@ -218,8 +231,10 @@ gem 'faker', :git => 'https://github.com/stympy/faker.git', :branch => 'master'
- [Faker::Creature::Animal](doc/creature/animal.md)
- [Faker::Creature::Cat](doc/creature/cat.md)
- [Faker::Creature::Dog](doc/creature/dog.md)
- [Faker::Creature::Horse](doc/creature/horse.md)

### Games
- [Faker::Game](doc/games/game.md)
- [Faker::Games::Dota](doc/games/dota.md)
- [Faker::Games::ElderScrolls](doc/games/elder_scrolls.md)
- [Faker::Games::Fallout](doc/games/fallout.md)
Expand All @@ -245,7 +260,6 @@ gem 'faker', :git => 'https://github.com/stympy/faker.git', :branch => 'master'
- [Faker::Movie](doc/movies/movie.md)
- [Faker::Movies::BackToTheFuture](doc/movies/back_to_the_future.md)
- [Faker::Movies::Ghostbusters](doc/movies/ghostbusters.md)
- [Faker::Movies::GratefulDead](doc/movies/grateful_dead.md)
- [Faker::Movies::HarryPotter](doc/movies/harry_potter.md)
- [Faker::Movies::HitchhikersGuideToTheGalaxy](doc/movies/hitchhikers_guide_to_the_galaxy.md)
- [Faker::Movies::Hobbit](doc/movies/hobbit.md)
Expand All @@ -257,6 +271,8 @@ gem 'faker', :git => 'https://github.com/stympy/faker.git', :branch => 'master'

### Music
- [Faker::Music](doc/music/music.md)
- [Faker::Music::GratefulDead](doc/music/grateful_dead.md)
- [Faker::Music::Opera](doc/music/opera.md)
- [Faker::Music::Phish](doc/music/phish.md)
- [Faker::Music::RockBand](doc/music/rock_band.md)
- [Faker::Music::UmphreysMcgee](doc/music/umphreys_mcgee.md)
Expand All @@ -265,6 +281,10 @@ gem 'faker', :git => 'https://github.com/stympy/faker.git', :branch => 'master'
- [Faker::Quote](doc/quotes/quote.md)
- [Faker::Quotes::Shakespeare](doc/quotes/shakespeare.md)

### Sports
- [Faker::Sports::Basketball](doc/sports/basketball.md)
- [Faker::Sports::Football](doc/sports/football.md)

### Tv Shows
- [Faker::TvShows::AquaTeenHungerForce](doc/tv_shows/aqua_teen_hunger_force.md)
- [Faker::TvShows::BojackHorseman](doc/tv_shows/bojack_horseman.md)
Expand Down
2 changes: 2 additions & 0 deletions doc/blockchain/tezos.md
Expand Up @@ -9,5 +9,7 @@ Faker::Blockchain::Tezos.contract #=> "KT1MroqeP15nnitB4CnNfkqHYa2NErhPPLWF"

Faker::Blockchain::Tezos.operation #=> "onygWYXJX3xNstFLv9PcCrhQdCkENC795xwSinmTEc1jsDN4VDa"

Faker::Blockchain::Tezos.block #=> "BMbhs2rkY1dvAkAyRytvPsjFQ2RiPrBhYkxvWpY65dzkdSuw58a"

Faker::Blockchain::Tezos.signature #=> "edsigu165B7VFf3Dpw2QABVzEtCxJY2gsNBNcE3Ti7rRxtDUjqTFRpg67EdAQmY6YWPE5tKJDMnSTJDFu65gic8uLjbW2YwGvAZ"
```
9 changes: 9 additions & 0 deletions doc/creature/horse.md
@@ -0,0 +1,9 @@
# Faker::Creature::Horse

It might be available in the next version.

```ruby
Faker::Creature::Horse.name #=> "Noir"

Faker::Creature::Horse.breed #=> "Spanish Barb see Barb Horse"
```
3 changes: 3 additions & 0 deletions doc/default/company.md
Expand Up @@ -62,4 +62,7 @@ Faker::Company.brazilian_company_number #=> "18553414000618"

# Generate a formatted Brazilian company number (CNPJ)
Faker::Company.brazilian_company_number(formatted: true) #=> "00.000.000/0000-00"

# Generate a USA Standard Industrial Classification code (SIC)
Faker::Company.sic_code #=> "0851"
```
4 changes: 2 additions & 2 deletions doc/default/crypto_coin.md
Expand Up @@ -5,9 +5,9 @@ Faker::CryptoCoin.coin_name #=> "Bitcoin"

Faker::CryptoCoin.acronym #=> "BTC"

Faker::CryptoCoin.url_logo #=> "https://i.imgur.com/EFz61Ei.png"
Faker::CryptoCoin.url_logo #=> "https://i.imgur.com/EFz61Ei.png"

Faker::CryptoCoin.coin_array #=> ["Dash", "DASH", "https://i.imgur.com/2uX91cb.png"]

Faker::CryptoCoin.coin_hash {:name=>"Ethereum", :acronym=>"ETH", :url_logo=>"https://i.imgur.com/uOPFCXj.png"}
Faker::CryptoCoin.coin_hash {:name=>"Ethereum", :acronym=>"ETH", :url_logo=>"https://i.imgur.com/uOPFCXj.png"}
```
4 changes: 2 additions & 2 deletions doc/default/esport.md
Expand Up @@ -2,7 +2,7 @@

```ruby
# Random player
Faker::Esport.player #=> "Faker"
Faker::Esport.player #=> "Crimsix"

# Random team
Faker::Esport.team #=> "CLG"
Expand All @@ -15,4 +15,4 @@ Faker::Esport.event #=> "ESL Cologne"

# Random game
Faker::Esport.game #=> "Dota2"
```
```
16 changes: 0 additions & 16 deletions doc/default/football.md

This file was deleted.

3 changes: 2 additions & 1 deletion doc/default/internet.md
Expand Up @@ -42,7 +42,6 @@ Faker::Internet.password(10, 20, true) #=> "3k5qS15aNmG"

Faker::Internet.password(10, 20, true, true) #=> "*%NkOnJsH4"

# Optional arguments: subdomain=true
Faker::Internet.domain_name #=> "effertz.info"

Faker::Internet.domain_word #=> "haleyziemann"
Expand Down Expand Up @@ -80,4 +79,6 @@ Faker::Internet.slug('foo bar', '-') #=> "foo-bar"
# Optional argument: vendor=nil
Faker::Internet.user_agent #=> "Mozilla/5.0 (compatible; MSIE 9.0; AOL 9.7; AOLBuild 4343.19; Windows NT 6.1; WOW64; Trident/5.0; FunWebProducts)"
Faker::Internet.user_agent(:firefox) #=> "Mozilla/5.0 (Windows NT x.y; Win64; x64; rv:10.0) Gecko/20100101 Firefox/10.0"

Faker::Internet.uuid #=> "929ef6ef-b11f-38c9-111b-accd67a258b2"
```
16 changes: 9 additions & 7 deletions doc/default/lorem.md
Expand Up @@ -29,13 +29,13 @@ Faker::Lorem.sentences #=> ["Vero earum commodi soluta.", "Quaerat fuga cumque e
Faker::Lorem.sentences(1) #=> ["Ut perspiciatis explicabo possimus doloribus enim quia."]
Faker::Lorem.sentences(1, true) #=> ["Quis capillus curo ager veritatis voro et ipsum."]

# Optional arguments: sentence_count=3, supplemental=false, random_sentences_to_add=3
# Optional arguments: sentence_count=3, supplemental=false, random_sentences_to_add=0
# The 'random_sentences_to_add' argument increases the paragraph's sentence count by a random value within (0..random_sentences_to_add).
# To specify an exact sentence count for a paragraph, set sentence_count to the number you want and random_sentences_to_add equal to 0.
# By default, sentences will have a random number of words within the range (3..6).
Faker::Lorem.paragraph #=> "Neque dicta enim quasi. Qui corrupti est quisquam. Facere animi quod aut. Qui nulla consequuntur consectetur sapiente."
Faker::Lorem.paragraph(2) #=> "Illo qui voluptas. Id sit quaerat enim aut cupiditate voluptates dolorum. Porro necessitatibus numquam dolor quia earum."
Faker::Lorem.paragraph(2, true) #=> "Cedo vero adipisci. Theatrum crustulum coaegresco tonsor crastinus stabilis. Aliqua crur consequatur amor una tolero sum."
Faker::Lorem.paragraph #=> "Recusandae minima consequatur. Expedita sequi blanditiis. Ut fuga et."
Faker::Lorem.paragraph(2) #=> "Ducimus mollitia deserunt. Dicta et corporis."
Faker::Lorem.paragraph(2, true) #=> "Strues amplitudo dignissimos. Ver trucido charisma."
Faker::Lorem.paragraph(2, false, 4) #=> "Neque aut et nemo aut incidunt voluptates. Dolore cum est sint est. Vitae assumenda porro odio dolores fugiat. Est voluptatum quia rerum."
Faker::Lorem.paragraph(2, true, 4) #=> "Vomito unde uxor annus. Et patior utilis sursum."

Expand All @@ -44,9 +44,11 @@ Faker::Lorem.paragraphs #=> ["Dolores quis quia ad quo voluptates. Maxime delect
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?"]
# Optional arguments: word_count=4, supplemental=false, random_words_to_add=0
Faker::Lorem.question #=> "Vero eum dolore qui?"

# Optional arguments: question_count=3, supplemental=false
Faker::Lorem.questions(3) #=> ["Ratione eaque doloremque?", "Qui aliquid fuga?", "Est cum ipsum?"]

# Optional arguments: chars=3, supplemental=false
Faker::Lorem.paragraph_by_chars #=> "Truffaut stumptown trust fund 8-bit messenger bag portland. Meh kombucha selvage swag biodiesel. Lomo kinfolk jean shorts asymmetrical diy. Wayfarers portland twee stumptown. Wes anderson biodiesel retro 90's pabst. Diy echo 90's mixtape semiotics. Cornho."
Expand Down
2 changes: 1 addition & 1 deletion doc/default/space.md
Expand Up @@ -43,5 +43,5 @@ Faker::Space.distance_measurement #=> "15 parsecs"
Faker::Space.meteorite #=> "Ensisheim"

# Random launch vehicule name
Faker::Space.launch_vehicle #=> "Saturn IV"
Faker::Space.launch_vehicule #=> "Saturn IV"
```
4 changes: 2 additions & 2 deletions doc/games/dota.md
Expand Up @@ -7,7 +7,7 @@ Available since version 1.9.0.
Faker::Games::Dota.hero #=> "Abaddon"

# Random item
Faker::Games::Dota.item #=> "Armlet of Mordiggian"
Faker::Games::Dota.item #=> "You have called death upon yourself."

# Random team
Faker::Games::Dota.team #=> "Evil Geniuses"
Expand All @@ -17,6 +17,6 @@ Faker::Games::Dota.player #=> "Dendi"

# Random quote
# by default if you don't pass the hero parameter, the quote method will set hero as 'abbadon'
Faker::Games::Dota.quote #=> "You have called death upon yourself."
Faker::Games::Dota.quote #=> "Easy now, this stuff is explosive!"
Faker::Games::Dota.quote(hero: 'alchemist') #=> "Better living through alchemy!"
```
12 changes: 12 additions & 0 deletions doc/games/game.md
@@ -0,0 +1,12 @@
# Faker::Game

```ruby
# Random Game Title
Faker::Game.title #=> "Half-Life"

# Random Game Genre
Faker::Game.genre #=> "First-person shooter"

# Random Game Platform
Faker::Game.platform #=> "Nintendo DS"
```
8 changes: 8 additions & 0 deletions doc/music/grateful_dead.md
@@ -0,0 +1,8 @@
# Faker::Music::GratefulDead


```ruby
Faker::Music::GratefulDead.player #=> "Jerry Garcia"

Faker::Music::GratefulDead.song #=> "Cassidy"
```
8 changes: 8 additions & 0 deletions doc/music/opera.md
@@ -0,0 +1,8 @@
# Faker::Music::Opera

```ruby
Faker::Music::Opera.verdi #=> "Il Trovatore"
Faker::Music::Opera.rossini #=> "Il Barbiere di Siviglia"
Faker::Music::Opera.donizetti #=> "Lucia di Lammermoor"
Faker::Music::Opera.bellini #=> "Norma"
```
11 changes: 11 additions & 0 deletions doc/sports/basketball.md
@@ -0,0 +1,11 @@
# Faker::Sports::Basketball

```ruby
Faker::Sports::Basketball.team #=> "Golden State Warriors"

Faker::Sports::Basketball.player #=> "LeBron James"

Faker::Sports::Basketball.coach #=> "Gregg Popovich"

Faker::Sports::Basketball.position #=> "Point Guard"
```
15 changes: 15 additions & 0 deletions doc/sports/football.md
@@ -0,0 +1,15 @@
# Faker::Sports::Football

Available since version 1.9.0.

```ruby
Faker::Sports::Football.team #=> "Manchester United"

Faker::Sports::Football.player #=> "Lionel Messi"

Faker::Sports::Football.coach #=> "Jose Mourinho"

Faker::Sports::Football.competition #=> "FIFA World Cup"

Faker::Sports::Football.position #=> "Defensive Midfielder"
```

0 comments on commit 211b147

Please sign in to comment.