faker 1.9.3 → 1.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f03350f51046e632c66e829e6386c993efe587c10d977d2ff7a889b753b236b2
-  data.tar.gz: 9c66012aa8accbc8d5202bc8d7af44e02627c48437004daa9414500b1e639977
+  metadata.gz: 4adc28503a1bd209dcf7c7bfea5794149f0b92bdb0869f67a920ce33fa96ce2a
+  data.tar.gz: 3698e9ce24f8625591c49fd3e032f8768c8396c40d501a9a73ab70d5e3ec506e
 SHA512:
-  metadata.gz: 7f0d97b3f14bbf9f37db1b0280e19a0d9cfc38af2fe40849280606f14ed5947ffaa01781d65979b3ab28f44e530721da18c5903722587031819bb009868c90ef
-  data.tar.gz: c2c3639d373065fd3479a5e5e3e03e01aa2529b4c55cb81e3c8ab95d9add1bc056f4674f4c201938a1f2e711d3709163cd84c5f467bf837df29092435fc5a233
+  metadata.gz: 36b7c6bce97ad335d681fb7cf509229f2dddb68fd0cf65ea0ecb5531babf049da3094f8a968b43b36ed88079811dca637fe1ee092796991e3abab57fe8d9e7e0
+  data.tar.gz: 7792629c3ceff4a0c7d1e0efb38beb0c0a58ed6cd7ad3ddb5b7869c434dac72dede781400e768006a2db3d3f02fd67c7cc35c376069856839bf2b3f8128e4d6e

data/CHANGELOG.md

@@ -3,19 +3,84 @@
 ## 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)
+- [PR #1541](https://github.com/stympy/faker/pull/1541) Add new categories to armenian [@hovikman](https://github.com/hovikman)
+
 ### Deprecation
 
+- [PR #1549](https://github.com/stympy/faker/pull/1549) Faker::Movies::GratefulDead => Faker::Music::GratefulDead [@bcharna](https://github.com/bcharna)
+- [PR #1538](https://github.com/stympy/faker/pull/1538) Add Sports namespace [@vbrazo](https://github.com/vbrazo)
+  - Deprecates `::Football`
+
 ### 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
 
-### Suggestion
+- [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)
 
 ### 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)
+- [PR #1551](https://github.com/stympy/faker/pull/1551) Yaml syntax for stargate.yml: Fix missing double quote [@psibi](https://github.com/psibi)
+- [PR #1550](https://github.com/stympy/faker/pull/1550) Fix kpop - yaml syntax issue. Double quote is missing [@psibi](https://github.com/psibi)
+- [PR #1545](https://github.com/stympy/faker/pull/1545) Remove trailing space from "kangaroo " & "gnu " translation in animals [@spikeheap](https://github.com/spikeheap)
+- [PR #1543](https://github.com/stympy/faker/pull/1543) Add pt-BR genders [@fladson](https://github.com/fladson)
+
 ------------------------------------------------------------------------------
 
 ## [v1.9.3](https://github.com/stympy/faker/tree/v1.9.2) (2019-02-12)

data/README.md

@@ -1,3 +1,4 @@
+
 ![logotype a happy-07](https://user-images.githubusercontent.com/36028424/40263395-4318481e-5b44-11e8-92e5-3dcc1ce169b3.png)
 
 # Faker
@@ -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)
@@ -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.
@@ -47,7 +52,7 @@ development.
 ```bash
 gem install faker
 ```
-Note: if you are getting a `uninitialized constant Faker::[some_class]` error, your version of the gem is behind the one documented here. To make sure that your gem is the one documented here, change the line in your gemfile to:
+Note: if you are getting a `uninitialized constant Faker::[some_class]` error, your version of the gem is behind the one documented here. To make sure that your gem is the one documented here, change the line in your Gemfile to:
 
 ```ruby
 gem 'faker', :git => 'https://github.com/stympy/faker.git', :branch => 'master'
@@ -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
@@ -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)
@@ -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)
@@ -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)
@@ -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)

data/bin/faker

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require 'cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Faker::CLI::Base.start
+rescue Faker::CLI::Base::Error => err
+  puts "ERROR: #{err.message}"
+  exit 1
+end

data/lib/cli.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+require 'cli/commands/list'
+require 'cli/commands/search'
+require 'faker/version'
+
+module Faker
+  module CLI
+    class Base < Thor
+      Error = Class.new(StandardError)
+      # Skip default deprecation warning output; the CLI will display that.
+      Gem::Deprecate.skip_during do
+        desc 'version', 'Faker version'
+        def version
+          puts "v#{Faker::VERSION}"
+        end
+        map %w[--version -v] => :version
+
+        desc 'list', 'List all Faker constants'
+        method_option :help, aliases: '-h', type: :boolean,
+                             desc: 'Display usage information'
+        method_option :show_methods, aliases: '-m', type: :boolean, default: true,
+                                     desc: 'Display Faker constants with methods'
+        method_option :verbose, aliases: '-v', type: :boolean,
+                                desc: 'Include sample Faker output'
+        def list(*)
+          if options[:help]
+            invoke :help, ['list']
+          else
+            Faker::CLI::Commands::List.new(options).execute
+          end
+        end
+
+        desc 'search [Faker]', 'Search Faker method(s)'
+        method_option :help, aliases: '-h', type: :boolean,
+                             desc: 'Display usage information'
+        method_option :show_methods, aliases: '-m', type: :boolean, default: true,
+                                     desc: 'Display Faker constants with methods'
+        method_option :verbose, aliases: '-v', type: :boolean,
+                                desc: 'Include sample Faker output'
+        def search(query)
+          if options[:help]
+            invoke :help, ['search']
+          else
+            Faker::CLI::Commands::Search.new(options).execute(query)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cli/README.md

@@ -0,0 +1,55 @@
+# faker (cli)
+
+## Usage
+
+1.) Run a quick lookup
+
+```bash
+$ faker search name
+# Faker::SwordArtOnline
+# └── real_name
+# └── game_name
+# Faker::Superhero
+# └── name
+# ....
+```
+
+2.) List methods
+
+```sh
+$ faker list
+# Faker::BackToTheFuture
+# ├── quote
+# ├── date
+# └── character
+# Faker::Finance
+# └── credit_card
+# ....
+```
+
+`faker` also includes an option to display sample output via the `--verbose` or `-v` flag. :wink:
+
+3.)
+
+```sh
+$ faker list -v
+# Faker::Appliance
+# ├── brand=> Whirlpool
+# └── equipment=> Sump pump
+# Faker::UmphreysMcgee
+# └── song=> Headphones & Snowcones
+$ faker search name -v
+# Faker::App
+# └── name=> Subin
+# Faker::Address
+# └── street_name=> Percy Landing
+# ....
+```
+
+## Features! :sunglasses: :dancers:
+
+- [x] List classes with methods E.g. Faker::FunnyName is displayed with `.name`,`.first_name` e.t.c.
+- [x] Expand search to Faker::Base sub classes
+- [x] Paginate results :book:
+
+![screenshot 2019-01-05 at 03 02 08](https://user-images.githubusercontent.com/17295175/50717135-59d85780-1096-11e9-8d0d-eca95646644d.jpg)

data/lib/cli/command.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require_relative 'renderer'
+
+module Faker
+  module CLI
+    class Command
+      extend Forwardable
+
+      def_delegators :command, :run
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def render(result, output)
+        Renderer.call(result, options, output)
+      end
+    end
+  end
+end

data/lib/cli/commands/list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../reflectors/list'
+
+module Faker
+  module CLI
+    module Commands
+      class List < Command
+        def execute(output: $stdout)
+          result = Reflectors::List.call(options)
+          render(result, output)
+        end
+      end
+    end
+  end
+end

data/lib/cli/commands/search.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../reflectors/search'
+
+module Faker
+  module CLI
+    module Commands
+      class Search < Command
+        def execute(input, output: $stdout)
+          result = Reflectors::Search.call(input)
+          render(result, output)
+        end
+
+        private
+
+        def render(result, output)
+          return not_found(output) if result.empty?
+
+          super(result, output)
+        end
+
+        def not_found(output)
+          output.puts "\nSorry, we couldn't find a match 😢", "\n"
+        end
+      end
+    end
+  end
+end

data/lib/cli/reflector.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'faker'
+
+module Faker
+  module CLI
+    # Abstract `Faker` Reflector - introspects the `Faker` module
+    #
+    # @api private
+    # @abstract
+    #
+    class Reflector
+      Faker::Base.class_eval do
+        # Select `Faker` subclasses
+        # @return [Array] `Faker::Base` sub classes
+        def self.descendants
+          @descendants ||= ObjectSpace.each_object(Class).select do |klass|
+            klass < self
+          end
+        end
+
+        # Select public class methods
+        # @return [Array] public methods
+        def self.my_singleton_methods
+          singleton_methods(false).select { |m| respond_to?(m) }
+        end
+      end
+
+      attr_reader :descendants_with_methods
+
+      def initialize(*)
+        @descendants_with_methods = Hash.new { |h, k| h[k] = [] }
+      end
+
+      protected
+
+      def store(descendant, methods)
+        return if methods.empty?
+
+        descendants_with_methods[descendant].concat(methods)
+      end
+
+      def faker_descendants
+        @faker_descendants ||= Faker::Base.descendants
+      end
+    end
+  end
+end