faker 1.9.6 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 182c6a436b64f259813bf79005eb3b0f5f2ce35d3c522b9fb2681ac68bdfe115
-  data.tar.gz: 96db38b14bf7a8afaf09ef6e0d232ad153e1bffcfeff85015b95b9b29cd7e1ea
+  metadata.gz: 7462443ac85163e4a2bfaaa60b52b0153d209004c68f498be7796bafdca56bb8
+  data.tar.gz: 83792726058a2a4bcae5a9e65faebd7b89271323b04c509c5e85a3ed3dcf87d7
 SHA512:
-  metadata.gz: c6c0ca2ab46c4775bc0ed36ad046a7598d322e5d452b14475725e2ef8a72a5aa1c5fb5d772b251dedf49a744e4245370c51a5d351618297bf5690b5b0626df8d
-  data.tar.gz: 63e374de8cc2ce4658b297978af85250a8767cde7dd365a1492ff2b381caf07faa90d95066a52346667b55eae95275c1003e14b3abecc32102115796fef791e8
+  metadata.gz: 13e01c3cf5c0f2f4813b4ebd5f47da32f5445234cb0bbc217e7b1b4836c8578b9e32bdafbafe68c9d9c8f85e2a14ec84a9fa13c3b611c3fa7f566b6bdf1176eb
+  data.tar.gz: d4ff9c657474b461ed8b4f54ec16e982ba805d3bc5fd815757bcfbb67b3823fba776ba004af140a1afb6d5424990f6819eda943a7b4bdfe24841713b9eb29f4c

data/CHANGELOG.md

@@ -1,21 +1,204 @@
 # Change Log
 
-## HEAD Unreleased
+## [v2.1.2](https://github.com/stympy/faker-ruby/faker/tree/2.1.2) (2019-10-08)
+
+## Enhancements
+
+- [PR #1495](https://github.com/stympy/faker/pull/1495) Add Brazilian documents generation and documentation [@lucasqueiroz](https://github.com/lucasqueiroz)
+
+## Issues
+
+We had to use `bundled with 1.7.3` to avoid some issues.
+
+## [v2.1.1](https://github.com/stympy/faker/tree/2.1.1) (2019-10-08)
+
+## Bug/Fixes
+
+- [PR #1685](https://github.com/stympy/faker/pull/1685) Upgrade i18n [@EduardoGHdez](https://github.com/EduardoGHdez)
+
+`bundler-audit` has identified that i18 has fix a security vulnerability, that has been fixed in the 0.8 version.
+
+- [PR #1683](https://github.com/stympy/faker/pull/1683) Rollback Faker::Time changes [@vbrazo](https://github.com/vbrazo)
+
+Rollback Faker::Time changes because we should expect the date format from activesupport's en.yml.
+
+## Documentation
+
+- [PR #1677](https://github.com/stympy/faker/pull/1677) Fix docs for Internet#password generator [@ur5us](https://github.com/ur5us)
+
+------------------------------------------------------------------------------
+
+## [v2.1.0](https://github.com/stympy/faker/tree/2.1.0) (2019-31-07)
+
+## Bug/Fixes
+- [PR #1675](https://github.com/stympy/faker/pull/1675) Fix off-by-one error when formatting month names [@jutonz](https://github.com/jutonz)
+
+This change required a quick release because it's a breaking issue. Every place where I18n.l() was used began to display the wrong date, causing test suite to fail.
+
+------------------------------------------------------------------------------
+
+## [v2.0](https://github.com/stympy/faker/tree/2.0) (2019-31-07)
+
+## Important Note:
+
+Version 2 has several `breaking changes`. We replaced positional arguments with keyword arguments and the list below contains all the changed methods:
+- `Faker::Books::Dune.quote(character = nil)` becomes `Faker::Books::Dune.quote(character: nil)`
+- `Faker::Books::Dune.saying(source = nil)` becomes `Faker::Books::Dune.saying(source: nil)`
+- `Faker::Books::Lovecraft.fhtagn(number_of = nil)` becomes `Faker::Books::Lovecraft.fhtagn(number: nil)`
+- `Faker::Books::Lovecraft.paragraph(sentence_count = nil, random_sentences_to_add = nil)` becomes `Faker::Books::Lovecraft.paragraph(sentence_count: nil, random_sentences_to_add: nil)`
+- `Faker::Books::Lovecraft.paragraph_by_chars(chars = nil)` becomes `Faker::Books::Lovecraft.paragraph_by_chars(characters: nil)`
+- `Faker::Books::Lovecraft.paragraphs(paragraph_count = nil)` becomes `Faker::Books::Lovecraft.paragraphs(number: nil)`
+- `Faker::Books::Lovecraft.sentence(word_count = nil, random_words_to_add = nil)` becomes `Faker::Books::Lovecraft.sentence(word_count: nil, random_words_to_add: nil)`
+- `Faker::Books::Lovecraft.sentences(sentence_count = nil)` becomes `Faker::Books::Lovecraft.sentences(number: nil)`
+- `Faker::Books::Lovecraft.words(num = nil, spaces_allowed = nil)` becomes `Faker::Books::Lovecraft.words(number: nil, spaces_allowed: nil)`
+- `Faker::Address.city(options = nil)` becomes `Faker::Address.city(options: nil)`
+- `Faker::Address.postcode(state_abbreviation = nil)` becomes `Faker::Address.postcode(state_abbreviation: nil)`
+- `Faker::Address.street_address(include_secondary = nil)` becomes `Faker::Address.street_address(include_secondary: nil)`
+- `Faker::Address.zip(state_abbreviation = nil)` becomes `Faker::Address.zip(state_abbreviation: nil)`
+- `Faker::Address.zip_code(state_abbreviation = nil)` becomes `Faker::Address.zip_code(state_abbreviation: nil)`
+- `Faker::Alphanumeric.alpha(char_count = nil)` becomes `Faker::Alphanumeric.alpha(number: nil)`
+- `Faker::Alphanumeric.alphanumeric(char_count = nil)` becomes `Faker::Alphanumeric.alphanumeric(number: nil)`
+- `Faker::Avatar.image(slug = nil, size = nil, format = nil, set = nil, bgset = nil)` becomes `Faker::Avatar.image(slug: nil, size: nil, format: nil, set: nil, bgset: nil)`
+- `Faker::Bank.account_number(digits = nil)` becomes `Faker::Bank.account_number(digits: nil)`
+- `Faker::Bank.iban(country_code = nil)` becomes `Faker::Bank.iban(country_code: nil)`
+- `Faker::ChileRut.full_rut(min_rut = nil, fixed = nil)` becomes `Faker::ChileRut.full_rut(min_rut: nil, fixed: nil)`
+- `Faker::ChileRut.rut(min_rut = nil, fixed = nil)` becomes `Faker::ChileRut.rut(min_rut: nil, fixed: nil)`
+- `Faker::Code.ean(base = nil)` becomes `Faker::Code.ean(base: nil)`
+- `Faker::Code.isbn(base = nil)` becomes `Faker::Code.isbn(base: nil)`
+- `Faker::Code.nric(min_age = nil, max_age = nil)` becomes `Faker::Code.nric(min_age: nil, max_age: nil)`
+- `Faker::Commerce.department(max = nil, fixed_amount = nil)` becomes `Faker::Commerce.department(max: nil, fixed_amount: nil)`
+- `Faker::Commerce.price(range = nil, as_string = nil)` becomes `Faker::Commerce.price(range: nil, as_string: nil)`
+- `Faker::Commerce.promotion_code(digits = nil)` becomes `Faker::Commerce.promotion_code(digits: nil)`
+- `Faker::Company.polish_register_of_national_economy(length = nil)` becomes `Faker::Company.polish_register_of_national_economy(length: nil)`
+- `Faker::CryptoCoin.acronym(coin = nil)` becomes `Faker::CryptoCoin.acronym(coin: nil)`
+- `Faker::CryptoCoin.coin_name(coin = nil)` becomes `Faker::CryptoCoin.coin_name(coin: nil)`
+- `Faker::CryptoCoin.url_logo(coin = nil)` becomes `Faker::CryptoCoin.url_logo(coin: nil)`
+- `Faker::Date.backward(days = nil)` becomes `Faker::Date.backward(days: nil)`
+- `Faker::Date.between(from, to)` becomes `Faker::Date.between(from:, to:)`
+- `Faker::Date.between_except(from, to, excepted)` becomes `Faker::Date.between_except(from:, to:, excepted:)`
+- `Faker::Date.birthday(min_age = nil, max_age = nil)` becomes `Faker::Date.birthday(min_age: nil, max_age: nil)`
+- `Faker::Date.forward(days = nil)` becomes `Faker::Date.forward(days: nil)`
+- `Faker::Demographic.height(unit = nil)` becomes `Faker::Demographic.height(unit: nil)`
+- `Faker::File.dir(segment_count = nil, root = nil, directory_separator = nil)` becomes `Faker::File.dir(segment_count: nil, root: nil, directory_separator: nil)`
+- `Faker::File.file_name(dir = nil, name = nil, ext = nil, directory_separator = nil)` becomes `Faker::File.file_name(dir: nil, name: nil, ext: nil, directory_separator: nil)`
+- `Faker::Fillmurray.image(grayscale = nil, width = nil, height = nil)` becomes `Faker::Fillmurray.image(grayscale: nil, width: nil, height: nil)`
+- `Faker::Finance.vat_number(country = nil)` becomes `Faker::Finance.vat_number(country: nil)`
+- `Faker::Hipster.paragraph(sentence_count = nil, supplemental = nil, random_sentences_to_add = nil)` becomes `Faker::Hipster.paragraph(sentence_count: nil, supplemental: nil, random_sentences_to_add: nil)`
+- `Faker::Hipster.paragraph_by_chars(chars = nil, supplemental = nil)` becomes `Faker::Hipster.paragraph_by_chars(characters: nil, supplemental: nil)`
+- `Faker::Hipster.paragraphs(paragraph_count = nil, supplemental = nil)` becomes `Faker::Hipster.paragraphs(number: nil, supplemental: nil)`
+- `Faker::Hipster.sentence(word_count = nil, supplemental = nil, random_words_to_add = nil)` becomes `Faker::Hipster.sentence(word_count: nil, supplemental: nil, random_words_to_add: nil)`
+- `Faker::Hipster.sentences(sentence_count = nil, supplemental = nil)` becomes `Faker::Hipster.sentences(number: nil, supplemental: nil)`
+- `Faker::Hipster.words(num = nil, supplemental = nil, spaces_allowed = nil)` becomes `Faker::Hipster.words(number: nil, supplemental: nil, spaces_allowed: nil)`
+- `Faker::Internet.domain_name(subdomain = nil)` becomes `Faker::Internet.domain_name(subdomain: nil)`
+- `Faker::Internet.email(name = nil, *separators)` becomes `Faker::Internet.email(name: nil, separators: nil)`
+- `Faker::Internet.fix_umlauts(string = nil)` becomes `Faker::Internet.fix_umlauts(string: nil)`
+- `Faker::Internet.free_email(name = nil)` becomes `Faker::Internet.free_email(name: nil)`
+- `Faker::Internet.mac_address(prefix = nil)` becomes `Faker::Internet.mac_address(prefix: nil)`
+- `Faker::Internet.password(min_length = nil, max_length = nil, mix_case = nil, special_chars = nil)` becomes `Faker::Internet.password(min_length: nil, max_length: nil, mix_case: nil, special_characters: nil)`
+- `Faker::Internet.safe_email(name = nil)` becomes `Faker::Internet.safe_email(name: nil)`
+- `Faker::Internet.slug(words = nil, glue = nil)` becomes `Faker::Internet.slug(words: nil, glue: nil)`
+- `Faker::Internet.url(host = nil, path = nil, scheme = nil)` becomes `Faker::Internet.url(host: nil, path: nil, scheme: nil)`
+- `Faker::Internet.user_agent(vendor = nil)` becomes `Faker::Internet.user_agent(vendor: nil)`
+- `Faker::Internet.user_name(specifier = nil, separators = nil)` becomes `Faker::Internet.user_name(specifier: nil, separators: nil)`
+- `Faker::Internet.username(specifier = nil, separators = nil)` becomes `Faker::Internet.username(specifier: nil, separators: nil)`
+- `Faker::Invoice.amount_between(from = nil, to = nil)` becomes `Faker::Invoice.amount_between(from: nil, to: nil)`
+- `Faker::Invoice.creditor_reference(ref = nil)` becomes `Faker::Invoice.creditor_reference(ref: nil)`
+- `Faker::Invoice.reference(ref = nil)` becomes `Faker::Invoice.reference(ref: nil)`
+- `Faker::Json.add_depth_to_json(json = nil, width = nil, options = nil)` becomes `Faker::Json.add_depth_to_json(json: nil, width: nil, options: nil)`
+- `Faker::Json.shallow_json(width = nil, options = nil)` becomes `Faker::Json.shallow_json(width: nil, options: nil)`
+- `Faker::Lorem.characters(char_count = nil)` becomes `Faker::Lorem.characters(number: nil)`
+- `Faker::Lorem.paragraph(sentence_count = nil, supplemental = nil, random_sentences_to_add = nil)` becomes `Faker::Lorem.paragraph(sentence_count: nil, supplemental: nil, random_sentences_to_add: nil)`
+- `Faker::Lorem.paragraph_by_chars(chars = nil, supplemental = nil)` becomes `Faker::Lorem.paragraph_by_chars(number: nil, supplemental: nil)`
+- `Faker::Lorem.paragraphs(paragraph_count = nil, supplemental = nil)` becomes `Faker::Lorem.paragraphs(number: nil, supplemental: nil)`
+- `Faker::Lorem.question(word_count = nil, supplemental = nil, random_words_to_add = nil)` becomes `Faker::Lorem.question(word_count: nil, supplemental: nil, random_words_to_add: nil)`
+- `Faker::Lorem.questions(question_count = nil, supplemental = nil)` becomes `Faker::Lorem.questions(number: nil, supplemental: nil)`
+- `Faker::Lorem.sentence(word_count = nil, supplemental = nil, random_words_to_add = nil)` becomes `Faker::Lorem.sentence(word_count: nil, supplemental: nil, random_words_to_add: nil)`
+- `Faker::Lorem.sentences(sentence_count = nil, supplemental = nil)` becomes `Faker::Lorem.sentences(number: nil, supplemental: nil)`
+- `Faker::Lorem.words(num = nil, supplemental = nil)` becomes `Faker::Lorem.words(number: nil, supplemental: nil)`
+- `Faker::LoremFlickr.colorized_image(size = nil, color = nil, search_terms = nil, match_all = nil)` becomes `Faker::LoremFlickr.colorized_image(size: nil, color: nil, search_terms: nil, match_all: nil)`
+- `Faker::LoremFlickr.grayscale_image(size = nil, search_terms = nil, match_all = nil)` becomes `Faker::LoremFlickr.grayscale_image(size: nil, search_terms: nil, match_all: nil)`
+- `Faker::LoremFlickr.image(size = nil, search_terms = nil, match_all = nil)` becomes `Faker::LoremFlickr.image(size: nil, search_terms: nil, match_all: nil)`
+- `Faker::LoremFlickr.pixelated_image(size = nil, search_terms = nil, match_all = nil)` becomes `Faker::LoremFlickr.pixelated_image(size: nil, search_terms: nil, match_all: nil)`
+- `Faker::LoremPixel.image(size = nil, is_gray = nil, category = nil, number = nil, text = nil, secure: nil)` becomes `Faker::LoremPixel.image(size: nil, is_gray: nil, category: nil, number: nil, text: nil, secure: nil)`
+- `Faker::Markdown.sandwich(sentences = nil, repeat = nil)` becomes `Faker::Markdown.sandwich(sentences: nil, repeat: nil)`
+- `Faker::Measurement.height(amount = nil)` becomes `Faker::Measurement.height(amount: nil)`
+- `Faker::Measurement.length(amount = nil)` becomes `Faker::Measurement.length(amount: nil)`
+- `Faker::Measurement.metric_height(amount = nil)` becomes `Faker::Measurement.metric_height(amount: nil)`
+- `Faker::Measurement.metric_length(amount = nil)` becomes `Faker::Measurement.metric_length(amount: nil)`
+- `Faker::Measurement.metric_volume(amount = nil)` becomes `Faker::Measurement.metric_volume(amount: nil)`
+- `Faker::Measurement.metric_weight(amount = nil)` becomes `Faker::Measurement.metric_weight(amount: nil)`
+- `Faker::Measurement.volume(amount = nil)` becomes `Faker::Measurement.volume(amount: nil)`
+- `Faker::Measurement.weight(amount = nil)` becomes `Faker::Measurement.weight(amount: nil)`
+- `Faker::Name.initials(character_count = nil)` becomes `Faker::Name.initials(number: nil)`
+- `Faker::NationalHealthService.check_digit(number = nil)` becomes `Faker::NationalHealthService.check_digit(number: nil)`
+- `Faker::Number.between(from = nil, to = nil)` becomes `Faker::Number.between(from: nil, to: nil)`
+- `Faker::Number.decimal(l_digits = nil, r_digits = nil)` becomes `Faker::Number.decimal(l_digits: nil, r_digits: nil)`
+- `Faker::Number.decimal_part(*args, &block)` becomes `Faker::Number.decimal_part(digits: nil)`
+- `Faker::Number.hexadecimal(digits = nil)` becomes `Faker::Number.hexadecimal(digits: nil)`
+- `Faker::Number.leading_zero_number(*args, &block)` becomes `Faker::Number.leading_zero_number(digits: nil)`
+- `Faker::Number.negative(from = nil, to = nil)` becomes `Faker::Number.negative(from: nil, to: nil)`
+- `Faker::Number.normal(mean = nil, standard_deviation = nil)` becomes `Faker::Number.normal(mean: nil, standard_deviation: nil)`
+- `Faker::Number.number(digits = nil)` becomes `Faker::Number.number(digits: nil)`
+- `Faker::Number.positive(from = nil, to = nil)` becomes `Faker::Number.positive(from: nil, to: nil)`
+- `Faker::Number.within(range = nil)` becomes `Faker::Number.within(range: nil)`
+- `Faker::PhoneNumber.extension(length = nil)` becomes `Faker::PhoneNumber.extension(length: nil)`
+- `Faker::PhoneNumber.subscriber_number(length = nil)` becomes `Faker::PhoneNumber.subscriber_number(length: nil)`
+- `Faker::Placeholdit.image(size = nil, format = nil, background_color = nil, text_color = nil, text = nil)` becomes `Faker::Placeholdit.image(size: nil, format: nil, background_color: nil, text_color: nil, text: nil)`
+- `Faker::Relationship.familial(connection = nil)` becomes `Faker::Relationship.familial(connection: nil)`
+- `Faker::Source.hello_world(lang = nil)` becomes `Faker::Source.hello_world(lang: nil)`
+- `Faker::Source.print_1_to_10(lang = nil)` becomes `Faker::Source.print_1_to_10(lang: nil)`
+- `Faker::String.random(length = nil)` becomes `Faker::String.random(length: nil)`
+- `Faker::Stripe.ccv(card_type = nil)` becomes `Faker::Stripe.ccv(card_type: nil)`
+- `Faker::Stripe.invalid_card(card_error = nil)` becomes `Faker::Stripe.invalid_card(card_error: nil)`
+- `Faker::Stripe.valid_card(card_type = nil)` becomes `Faker::Stripe.valid_card(card_type: nil)`
+- `Faker::Stripe.valid_token(card_type = nil)` becomes `Faker::Stripe.valid_token(card_type: nil)`
+- `Faker::Time.backward(days = nil, period = nil, format = nil)` becomes `Faker::Time.backward(days: nil, period: nil, format: nil)`
+- `Faker::Time.between(from, to, period = nil, format = nil)` becomes `Faker::Time.between(from:, to:, format: nil)`
+- `Faker::Time.forward(days = nil, period = nil, format = nil)` becomes `Faker::Time.forward(days: nil, period: nil, format: nil)`
+- `Faker::Types.complex_rb_hash(key_count = nil)` becomes `Faker::Types.complex_rb_hash(number: nil)`
+- `Faker::Types.rb_array(len = nil)` becomes `Faker::Types.rb_array(len: nil)`
+- `Faker::Types.rb_hash(key_count = nil, type = nil)` becomes `Faker::Types.rb_hash(number: nil, type: nil)`
+- `Faker::Types.rb_integer(from = nil, to = nil)` becomes `Faker::Types.rb_integer(from: nil, to: nil)`
+- `Faker::Types.rb_string(words = nil)` becomes `Faker::Types.rb_string(words: nil)`
+- `Faker::Vehicle.kilometrage(min = nil, max = nil)` becomes `Faker::Vehicle.kilometrage(min: nil, max: nil)`
+- `Faker::Vehicle.license_plate(state_abreviation = nil)` becomes `Faker::Vehicle.license_plate(state_abreviation: nil)`
+- `Faker::Vehicle.mileage(min = nil, max = nil)` becomes `Faker::Vehicle.mileage(min: nil, max: nil)`
+- `Faker::Vehicle.model(make_of_model = nil)` becomes `Faker::Vehicle.model(make_of_model: nil)`
+- `Faker::WorldCup.group(group = nil)` becomes `Faker::WorldCup.group(group: nil)`
+- `Faker::WorldCup.roster(country = nil, type = nil)` becomes `Faker::WorldCup.roster(country: nil, type: nil)`
+- `Faker::Movies::StarWars.quote(character = nil)` becomes `Faker::Movies::StarWars.quote(character: nil)`
 
 ### Bug/Fixes
-### Chores
+
+- [PR #1660](https://github.com/stympy/faker/pull/1660) Update FillMurray Links To Include www [@RaymondFallon](https://github.com/RaymondFallon)
+
 ### Deprecation
+
+- [PR #1634](https://github.com/stympy/faker/pull/1634) Corrected other occurrences of spelling vehicle spelling error, deprecated Space launch_vehicule [@Siyanda](https://github.com/Siyanda)
+
 ### Documentation
+
+- [PR #1653](https://github.com/stympy/faker/pull/1653) Add /faker-ruby/faker-bot to README [@vbrazo](https://github.com/vbrazo)
+
 ### Feature Request
+
+- [PR #1417](https://github.com/stympy/faker/pull/1417) Rework Faker::Time::between [@pjohnmeyer](https://github.com/pjohnmeyer)
+- [PR #510](https://github.com/stympy/faker/pull/510) Make Faker::Number return integers and floats instead of strings [@tejasbubane](https://github.com/tejasbubane)
+- [PR #1651](https://github.com/stympy/faker/pull/1651) Preparing for v2 [@vbrazo](https://github.com/vbrazo)
+- [PR #1664](https://github.com/stympy/faker/pull/1664) Replace positional arguments with keyword arguments [@vbrazo](https://github.com/vbrazo)
+
 ### Update/add locales
 
+- [PR #1658](https://github.com/stympy/faker/pull/1658) Update Faker::Games::SuperSmashBros entries [@boardfish](https://github.com/boardfish)
+- [PR #1649](https://github.com/stympy/faker/pull/1649) Remove mexicoMX [@vbrazo](https://github.com/vbrazo)
+
 ------------------------------------------------------------------------------
 
-## [v1.9.6](https://github.com/stympy/faker/tree/v1.9.5) (2019-07-05)
+## [v1.9.6](https://github.com/stympy/faker/tree/1.9.6) (2019-07-05)
 
 Fix lib/faker/version.rb
 
-## [v1.9.5](https://github.com/stympy/faker/tree/v1.9.5) (2019-07-04)
+## [v1.9.5](https://github.com/stympy/faker/tree/v.1.9.5) (2019-07-04)
 
 ### Bug
 
@@ -39,7 +222,7 @@ Fix lib/faker/version.rb
 
 ------------------------------------------------------------------------------
 
-## [v1.9.4](https://github.com/stympy/faker/tree/v1.9.4) (2019-06-19)
+## [v1.9.4](https://github.com/stympy/faker/tree/1.9.4) (2019-06-19)
 
 ### Bug/Fixes
 
@@ -111,7 +294,7 @@ Fix lib/faker/version.rb
 
 ------------------------------------------------------------------------------
 
-## [v1.9.3](https://github.com/stympy/faker/tree/v1.9.2) (2019-02-12)
+## [v1.9.3](https://github.com/stympy/faker/tree/v1.9.3) (2019-02-12)
 
 [Full Changelog](https://github.com/stympy/faker/compare/v1.9.2...v1.9.3)
 

data/README.md

@@ -2,7 +2,7 @@
 ![logotype a happy-07](https://user-images.githubusercontent.com/36028424/40263395-4318481e-5b44-11e8-92e5-3dcc1ce169b3.png)
 
 # Faker
-[![Build Status](https://travis-ci.org/stympy/faker.svg?branch=master)](https://travis-ci.org/stympy/faker)
+[![Build Status](https://travis-ci.org/faker-ruby/faker.svg?branch=master)](https://travis-ci.org/faker-ruby/faker)
 [![Gem Version](https://badge.fury.io/rb/faker.svg)](https://badge.fury.io/rb/faker)
 [![Inline docs](http://inch-ci.org/github/stympy/faker.svg?branch=master)](http://inch-ci.org/github/stympy/faker)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/ef54c7f9df86e965d64b/test_coverage)](https://codeclimate.com/github/stympy/faker/test_coverage)
@@ -20,6 +20,7 @@ development.
     - [NOTE](#note)
   - [Installing](#installing)
   - [Usage](#usage)
+    - [CLI](#cli)
     - [Ensuring unique values](#ensuring-unique-values)
     - [Deterministic Random](#deterministic-random)
   - [Generators](#generators)
@@ -66,6 +67,9 @@ Faker::Name.name      #=> "Christophe Bartell"
 Faker::Internet.email #=> "kirsten.greenholt@corkeryfisher.info"
 ```
 
+### CLI
+Instructions are available in the [faker-bot README](https://github.com/faker-ruby/faker-bot).
+
 ### Ensuring unique values
 Prefix your method call with `unique`. For example:
 ```ruby

data/lib/faker/books/dune.rb

@@ -19,7 +19,7 @@ module Faker
           fetch('dune.planets')
         end
 
-        def quote(character = nil)
+        def quote(character: nil)
           quoted_characters = translate('faker.dune.quotes').keys
 
           if character.nil?
@@ -36,7 +36,7 @@ module Faker
           fetch('dune.quotes.' + character)
         end
 
-        def saying(source = nil)
+        def saying(source: nil)
           sourced_sayings = translate('faker.dune.sayings').keys
 
           if source.nil?

data/lib/faker/books/lovecraft.rb

@@ -8,8 +8,8 @@ module Faker
           fetch('lovecraft.location')
         end
 
-        def fhtagn(number_of = 1)
-          Array.new(number_of) { fetch('lovecraft.fhtagn') }.join('. ')
+        def fhtagn(number: 1)
+          Array.new(number) { fetch('lovecraft.fhtagn') }.join('. ')
         end
 
         def deity
@@ -20,8 +20,8 @@ module Faker
           fetch('lovecraft.tome')
         end
 
-        def sentence(word_count = 4, random_words_to_add = 6)
-          words(word_count + rand(random_words_to_add.to_i).to_i, true).join(' ').capitalize + '.'
+        def sentence(word_count: 4, random_words_to_add: 6)
+          words(number: word_count + rand(random_words_to_add.to_i).to_i, spaces_allowed: true).join(' ').capitalize + '.'
         end
 
         def word
@@ -29,8 +29,8 @@ module Faker
           random_word =~ /\s/ ? word : random_word
         end
 
-        def words(num = 3, spaces_allowed = false)
-          resolved_num = resolve(num)
+        def words(number: 3, spaces_allowed: false)
+          resolved_num = resolve(number)
           word_list = translate('faker.lovecraft.words')
           word_list *= ((resolved_num / word_list.length) + 1)
 
@@ -40,32 +40,32 @@ module Faker
           words.each_with_index { |w, i| words[i] = word if w =~ /\s/ }
         end
 
-        def sentences(sentence_count = 3)
+        def sentences(number: 3)
           [].tap do |sentences|
-            1.upto(resolve(sentence_count)) do
-              sentences << sentence(3)
+            1.upto(resolve(number)) do
+              sentences << sentence(word_count: 3)
             end
           end
         end
 
-        def paragraph(sentence_count = 3, random_sentences_to_add = 3)
-          sentences(resolve(sentence_count) + rand(random_sentences_to_add.to_i).to_i).join(' ')
+        def paragraph(sentence_count: 3, random_sentences_to_add: 3)
+          sentences(number: resolve(sentence_count) + rand(random_sentences_to_add.to_i).to_i).join(' ')
         end
 
-        def paragraphs(paragraph_count = 3)
+        def paragraphs(number: 3)
           [].tap do |paragraphs|
-            1.upto(resolve(paragraph_count)) do
-              paragraphs << paragraph(3)
+            1.upto(resolve(number)) do
+              paragraphs << paragraph(sentence_count: 3)
             end
           end
         end
 
-        def paragraph_by_chars(chars = 256)
-          paragraph = paragraph(3)
+        def paragraph_by_chars(characters: 256)
+          paragraph = paragraph(sentence_count: 3)
 
-          paragraph += ' ' + paragraph(3) while paragraph.length < chars
+          paragraph += ' ' + paragraph(sentence_count: 3) while paragraph.length < characters
 
-          paragraph[0...chars - 1] + '.'
+          paragraph[0...characters - 1] + '.'
         end
       end
     end

data/lib/faker/creature/animal.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Faker
-  module Creature
+  class Creature
     class Animal < Base
       class << self
         def name

data/lib/faker/creature/cat.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Faker
-  module Creature
+  class Creature
     class Cat < Base
       flexible :cat
 

data/lib/faker/creature/dog.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Faker
-  module Creature
+  class Creature
     class Dog < Base
       flexible :dog
 

data/lib/faker/creature/horse.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Faker
-  module Creature
+  class Creature
     class Horse < Base
       flexible :horse
 

data/lib/faker/default/address.rb

@@ -5,7 +5,7 @@ module Faker
     flexible :address
 
     class << self
-      def city(options = {})
+      def city(options: {})
         parse(options[:with_state] ? 'address.city_with_state' : 'address.city')
       end
 
@@ -13,7 +13,7 @@ module Faker
         parse('address.street_name')
       end
 
-      def street_address(include_secondary = false)
+      def street_address(include_secondary: false)
         numerify(parse('address.street_address') + (include_secondary ? ' ' + secondary_address : ''))
       end
 
@@ -29,7 +29,7 @@ module Faker
         parse('address.community')
       end
 
-      def zip_code(state_abbreviation = '')
+      def zip_code(state_abbreviation: '')
         if state_abbreviation.empty?
           letterified_string = letterify(fetch('address.postcode'))
           return numerify(letterified_string, leading_zero: true)

data/lib/faker/default/alphanumeric.rb

@@ -6,15 +6,15 @@ module Faker
       ALPHABET = ('a'..'z').to_a
       ALPHANUMS = ALPHABET + (0..9).to_a
 
-      def alpha(char_count = 32)
-        char_count = resolve(char_count)
+      def alpha(number: 32)
+        char_count = resolve(number)
         return '' if char_count.to_i < 1
 
         Array.new(char_count) { sample(ALPHABET) }.join
       end
 
-      def alphanumeric(char_count = 32)
-        char_count = resolve(char_count)
+      def alphanumeric(number: 32)
+        char_count = resolve(number)
         return '' if char_count.to_i < 1
 
         Array.new(char_count) { sample(ALPHANUMS) }.join

data/lib/faker/default/avatar.rb

@@ -5,7 +5,7 @@ module Faker
     class << self
       SUPPORTED_FORMATS = %w[png jpg bmp].freeze
 
-      def image(slug = nil, size = '300x300', format = 'png', set = 'set1', bgset = nil)
+      def image(slug: nil, size: '300x300', format: 'png', set: 'set1', bgset: nil)
         raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
         raise ArgumentError, "Supported formats are #{SUPPORTED_FORMATS.join(', ')}" unless SUPPORTED_FORMATS.include?(format)