faker 2.1.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8ec0243e0079d2e81fdf6bfa46e9619a97ce96eb9a0521be7699c36a8408e5a
-  data.tar.gz: 7e5a20f1d6595b3fcda89a802dbaaa3e97b2027bcd21f1fad6bb164e433b12ea
+  metadata.gz: c140b70507d530616f9c4ab8253cde32bab8bd7489eec025ebc3e0d81027e0be
+  data.tar.gz: b752dafd7f9a6816b811e7b886b0097389fb12f2bb4ff714babcab5215c1528b
 SHA512:
-  metadata.gz: 6de044051ced1eea9bbc6b3a1693e3d9f809195289c0ceb68238459ec9420eccb7cb6eb7761f23f88a3c94e68292cdd42785cc97da9d4e5680e7240afd0dd3a4
-  data.tar.gz: 0c9e6ad646d0772e3e116b7534940270c1be804c3e231b0aba974cc0f9478750125ac591b18ee4d2f5b851e9df29898c42b69067ec0e9c411b5c96de350d21c2
+  metadata.gz: 01f9d799d52e5b502b21ba569a046f078c45d59e8f0c82e09fa5f79b13bcbf0633a2150d2017623c6ad50256536e94273fc30b59c1835fca639ca4772cf85839
+  data.tar.gz: 4f0fc396d99449791e7edf1ff9013842617e6ecd4c8d153574a773b81041801750c02fb3974c6e05cdfc4429c26bc54528e00a509fa0b8dfd3d788fc5ff0e335

data/CHANGELOG.md

@@ -1,15 +1,101 @@
 # Change Log
 
-## [v2.1.0](https://github.com/stympy/faker/tree/2.1.0) (2019-31-07)
+## [v2.2.2](https://github.com/faker-ruby/faker/tree/v2.2.2) (2019-05-09)
 
 ## 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)
+
+- [PR #1717](https://github.com/faker-ruby/faker/pull/1717) Fix ambiguity in element_symbol field [@psibi](https://github.com/psibi)
+
+## Chores
+
+- [PR #1724](https://github.com/faker-ruby/faker/pull/1724) Include rubocop-faker autocorrect in deprecation [@koic](https://github.com/koic)
+
+## Documentation
+
+- [PR #1726](https://github.com/faker-ruby/faker/pull/1726) Include 2.x breaking return value change in changelog [@zorab47](https://github.com/zorab47)
+- [PR #1722](https://github.com/faker-ruby/faker/pull/1722) Fix examples in the Dota docs [@bzf](https://github.com/bzf)
+
+## Update local dependencies
+
+The following development dependencies were updated:
+- rake requirement from = 12.3.1 to = 12.3.3 (#1719)
+- rubocop requirement from = 0.59.1 to = 0.74.0 (#1721)
+- simplecov requirement from = 0.16.1 to = 0.17.0 (#1718)
+
+------------------------------------------------------------------------------
+
+## [v2.2.1](https://github.com/faker-ruby/faker/tree/v2.2.1) (2019-30-08)
+
+## Bug/Fixes
+
+- [PR #1712](https://github.com/faker-ruby/faker/pull/1712) Fix number(digits: 1) always returns 0 [@ianlet](https://github.com/ianlet)
+
+`Faker::Number.number(digits: 1)` was always returning `0`.
+
+Fixing number with one digit caused the test_insignificant_zero to fail. As it seemed that the behavior tested by test_insignificant_zero was already covered by test_number and test_decimal, we removed it to prevent duplication.
+
+## [v2.2.0](https://github.com/faker-ruby/faker/tree/v2.2.0) (2019-25-08)
+
+## Deprecate
+
+- [PR #1698](https://github.com/faker-ruby/faker/pull/1698) Add warn for positional arguments when using Faker 2.0 [@koic](https://github.com/koic)
+
+Add deprecation warning for positional arguments to notify users that are coming from Faker version < 2.0. Its main goal is to make upgrades easier.
+
+## Documentation
+
+- [PR #1688](https://github.com/faker-ruby/faker/pull/1688) Update README install instructions [@EduardoGHdez](https://github.com/EduardoGHdez)
+- [PR #1689](https://github.com/faker-ruby/faker/pull/1689) Update README.md [@Zeragamba](https://github.com/Zeragamba)
+- [PR #1690](https://github.com/faker-ruby/faker/pull/1690) Update issue url in PULL_REQUEST_TEMPLATE [@bugtender](https://github.com/bugtender)
+- [PR #1703](https://github.com/faker-ruby/faker/pull/1703) Return HTTPS URLs from Lorem Flickr [@connorshea](https://github.com/connorshea)
+
+## Feature Request
+- [PR #1686](https://github.com/faker-ruby/faker/pull/1686) Update test-unit gem to 3.3.3 [@connorshea](https://github.com/connorshea)
+
+## Bug/Fixes
+- [PR #1702](https://github.com/faker-ruby/faker/pull/1702) Fix an argument for test_faker_stripe.rb [@koic](https://github.com/koic)
+- [PR #1694](https://github.com/faker-ruby/faker/pull/1694) Ensure mix_case returns at least one lower and one upper case letter [@bpleslie](https://github.com/bpleslie)
+
+------------------------------------------------------------------------------
+
+## [v2.1.2](https://github.com/faker-ruby/faker/tree/v2.1.2) (2019-10-08)
+
+## Enhancements
+
+- [PR #1495](https://github.com/faker-ruby/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/faker-ruby/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/faker-ruby/faker/pull/1677) Fix docs for Internet#password generator [@ur5us](https://github.com/ur5us)
+
+------------------------------------------------------------------------------
+
+## [v2.1.0](https://github.com/faker-ruby/faker/tree/v2.1.0) (2019-31-07)
+
+## Bug/Fixes
+- [PR #1675](https://github.com/faker-ruby/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)
+## [v2.0](https://github.com/faker-ruby/faker/tree/v2.0) (2019-31-07)
 
 ## Important Note:
 
@@ -140,6 +226,10 @@ Version 2 has several `breaking changes`. We replaced positional arguments with
 - `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)`
 
+Additionally the following methods changed return values:
+
+- `Faker::Number.number` now returns `Numeric` instead of `String` (see [PR #510](https://github.com/faker-ruby/faker/pull/510))
+
 ### Bug/Fixes
 
 - [PR #1660](https://github.com/stympy/faker/pull/1660) Update FillMurray Links To Include www [@RaymondFallon](https://github.com/RaymondFallon)

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)
@@ -55,7 +55,7 @@ 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:
 
 ```ruby
-gem 'faker', :git => 'https://github.com/stympy/faker.git', :branch => 'master'
+gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'master'
 ```
 
 ## Usage
@@ -117,7 +117,7 @@ Faker::Company.bs #=> "cultivate viral synergies"
 **NOTE: Some of the generators below aren't released yet. If you want to use them, change the line in your gemfile to:**
 
 ```ruby
-gem 'faker', :git => 'https://github.com/stympy/faker.git', :branch => 'master'
+gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'master'
 ```
 
 ### Default

data/lib/faker.rb

@@ -40,9 +40,12 @@ module Faker
   class Base
     Numbers = Array(0..9)
     ULetters = Array('A'..'Z')
-    Letters = ULetters + Array('a'..'z')
+    LLetters = Array('a'..'z')
+    Letters = ULetters + LLetters
 
     class << self
+      NOT_GIVEN = Object.new
+
       ## by default numerify results do not start with a zero
       def numerify(number_string, leading_zero: false)
         return number_string.gsub(/#/) { rand(10).to_s } if leading_zero
@@ -245,6 +248,58 @@ module Faker
       ensure
         I18n.enforce_available_locales = old_enforce_available_locales
       end
+
+      private
+
+      def warn_for_deprecated_arguments
+        keywords = []
+        yield(keywords)
+
+        return if keywords.empty?
+
+        method_name = caller.first.match(/`(?<method_name>.*)'/)[:method_name]
+
+        keywords.each.with_index(1) do |keyword, index|
+          i = case index
+              when 1 then '1st'
+              when 2 then '2nd'
+              when 3 then '3rd'
+              else "#{index}th"
+              end
+
+          warn_with_uplevel(<<~MSG, uplevel: 5)
+            Passing `#{keyword}` with the #{i} argument of `#{method_name}` is deprecated. Use keyword argument like `#{method_name}(#{keyword}: ...)` instead.
+          MSG
+        end
+
+        warn(<<~MSG)
+
+          To automatically update from positional arguments to keyword arguments,
+          install rubocop-faker and run:
+
+          rubocop \\
+            --require rubocop-faker \\
+            --only Faker/DeprecatedArguments \\
+            --auto-correct
+
+        MSG
+      end
+
+      # Workaround for emulating `warn '...', uplevel: 1` in Ruby 2.4 or lower.
+      def warn_with_uplevel(message, uplevel: 1)
+        at = parse_caller(caller[uplevel]).join(':')
+        warn "#{at}: #{message}"
+      end
+
+      def parse_caller(at)
+        # rubocop:disable Style/GuardClause
+        if /^(.+?):(\d+)(?::in `.*')?/ =~ at
+          file = Regexp.last_match(1)
+          line = Regexp.last_match(2).to_i
+          [file, line]
+        end
+        # rubocop:enable Style/GuardClause
+      end
     end
   end
 end

data/lib/faker/blockchain/tezos.rb

@@ -8,13 +8,13 @@ module Faker
     class Tezos < Base
       class << self
         PREFIXES = {
-          tz1:   [6, 161, 159],
-          KT1:   [2, 90, 121],
-          edpk:  [13, 15, 37, 217],
-          edsk:  [13, 15, 58, 7],
+          tz1: [6, 161, 159],
+          KT1: [2, 90, 121],
+          edpk: [13, 15, 37, 217],
+          edsk: [13, 15, 58, 7],
           edsig: [9, 245, 205, 134, 18],
-          B:     [1, 52],
-          o:     [5, 116]
+          B: [1, 52],
+          o: [5, 116]
         }.freeze
 
         def account

data/lib/faker/books/dune.rb

@@ -19,7 +19,11 @@ module Faker
           fetch('dune.planets')
         end
 
-        def quote(character: nil)
+        def quote(legacy_character = NOT_GIVEN, character: nil)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :character if legacy_character != NOT_GIVEN
+          end
+
           quoted_characters = translate('faker.dune.quotes').keys
 
           if character.nil?
@@ -36,7 +40,11 @@ module Faker
           fetch('dune.quotes.' + character)
         end
 
-        def saying(source: nil)
+        def saying(legacy_source = NOT_GIVEN, source: nil)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :source if legacy_source != NOT_GIVEN
+          end
+
           sourced_sayings = translate('faker.dune.sayings').keys
 
           if source.nil?

data/lib/faker/books/lovecraft.rb

@@ -8,7 +8,11 @@ module Faker
           fetch('lovecraft.location')
         end
 
-        def fhtagn(number: 1)
+        def fhtagn(legacy_number = NOT_GIVEN, number: 1)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :number if legacy_number != NOT_GIVEN
+          end
+
           Array.new(number) { fetch('lovecraft.fhtagn') }.join('. ')
         end
 
@@ -20,7 +24,12 @@ module Faker
           fetch('lovecraft.tome')
         end
 
-        def sentence(word_count: 4, random_words_to_add: 6)
+        def sentence(legacy_word_count = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, random_words_to_add: 6)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :word_count if legacy_word_count != NOT_GIVEN
+            keywords << :random_words_to_add if legacy_random_words_to_add != NOT_GIVEN
+          end
+
           words(number: word_count + rand(random_words_to_add.to_i).to_i, spaces_allowed: true).join(' ').capitalize + '.'
         end
 
@@ -29,7 +38,12 @@ module Faker
           random_word =~ /\s/ ? word : random_word
         end
 
-        def words(number: 3, spaces_allowed: false)
+        def words(legacy_number = NOT_GIVEN, legacy_spaces_allowed = NOT_GIVEN, number: 3, spaces_allowed: false)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :number if legacy_number != NOT_GIVEN
+            keywords << :spaces_allowed if legacy_spaces_allowed != NOT_GIVEN
+          end
+
           resolved_num = resolve(number)
           word_list = translate('faker.lovecraft.words')
           word_list *= ((resolved_num / word_list.length) + 1)
@@ -40,7 +54,11 @@ module Faker
           words.each_with_index { |w, i| words[i] = word if w =~ /\s/ }
         end
 
-        def sentences(number: 3)
+        def sentences(legacy_number = NOT_GIVEN, number: 3)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :number if legacy_number != NOT_GIVEN
+          end
+
           [].tap do |sentences|
             1.upto(resolve(number)) do
               sentences << sentence(word_count: 3)
@@ -48,11 +66,20 @@ module Faker
           end
         end
 
-        def paragraph(sentence_count: 3, random_sentences_to_add: 3)
+        def paragraph(legacy_sentence_count = NOT_GIVEN, legacy_random_sentences_to_add = NOT_GIVEN, sentence_count: 3, random_sentences_to_add: 3)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :sentence_count if legacy_sentence_count != NOT_GIVEN
+            keywords << :random_sentences_to_add if legacy_random_sentences_to_add != NOT_GIVEN
+          end
+
           sentences(number: resolve(sentence_count) + rand(random_sentences_to_add.to_i).to_i).join(' ')
         end
 
-        def paragraphs(number: 3)
+        def paragraphs(legacy_number = NOT_GIVEN, number: 3)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :number if legacy_number != NOT_GIVEN
+          end
+
           [].tap do |paragraphs|
             1.upto(resolve(number)) do
               paragraphs << paragraph(sentence_count: 3)
@@ -60,7 +87,11 @@ module Faker
           end
         end
 
-        def paragraph_by_chars(characters: 256)
+        def paragraph_by_chars(legacy_characters = NOT_GIVEN, characters: 256)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :characters if legacy_characters != NOT_GIVEN
+          end
+
           paragraph = paragraph(sentence_count: 3)
 
           paragraph += ' ' + paragraph(sentence_count: 3) while paragraph.length < characters

data/lib/faker/default/address.rb

@@ -5,7 +5,11 @@ module Faker
     flexible :address
 
     class << self
-      def city(options: {})
+      def city(legacy_options = NOT_GIVEN, options: {})
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :options if legacy_options != NOT_GIVEN
+        end
+
         parse(options[:with_state] ? 'address.city_with_state' : 'address.city')
       end
 
@@ -13,7 +17,11 @@ module Faker
         parse('address.street_name')
       end
 
-      def street_address(include_secondary: false)
+      def street_address(legacy_include_secondary = NOT_GIVEN, include_secondary: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :include_secondary if legacy_include_secondary != NOT_GIVEN
+        end
+
         numerify(parse('address.street_address') + (include_secondary ? ' ' + secondary_address : ''))
       end
 
@@ -29,7 +37,11 @@ module Faker
         parse('address.community')
       end
 
-      def zip_code(state_abbreviation: '')
+      def zip_code(legacy_state_abbreviation = NOT_GIVEN, state_abbreviation: '')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :state_abbreviation if legacy_state_abbreviation != NOT_GIVEN
+        end
+
         if state_abbreviation.empty?
           letterified_string = letterify(fetch('address.postcode'))
           return numerify(letterified_string, leading_zero: true)
@@ -71,11 +83,19 @@ module Faker
         fetch('address.country')
       end
 
-      def country_by_code(code: 'US')
+      def country_by_code(legacy_code = NOT_GIVEN, code: 'US')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :code if legacy_code != NOT_GIVEN
+        end
+
         fetch('address.country_by_code.' + code)
       end
 
-      def country_name_to_code(name: 'united_states')
+      def country_name_to_code(legacy_name = NOT_GIVEN, name: 'united_states')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :name if legacy_name != NOT_GIVEN
+        end
+
         fetch('address.country_by_name.' + name)
       end
 

data/lib/faker/default/alphanumeric.rb

@@ -2,22 +2,54 @@
 
 module Faker
   class Alphanumeric < Base
-    class << self
-      ALPHABET = ('a'..'z').to_a
-      ALPHANUMS = ALPHABET + (0..9).to_a
+    ALPHANUMS = LLetters + Numbers
 
-      def alpha(number: 32)
+    class << self
+      def alpha(legacy_number = NOT_GIVEN, number: 32)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
         char_count = resolve(number)
         return '' if char_count.to_i < 1
 
-        Array.new(char_count) { sample(ALPHABET) }.join
+        Array.new(char_count) { sample(self::LLetters) }.join
       end
 
-      def alphanumeric(number: 32)
+      ##
+      # Produces a random string of alphanumeric characters
+      #
+      # @param [Integer] number
+      # @param [Integer] min_alpha
+      # @param [Integer] min_numeric
+      #
+      # @return [String]
+      #
+      # @example Faker::Alphanumeric.alphanumeric(number: 10) #=> "3yfq2phxtb"
+      # @example Faker::Alphanumeric.alphanumeric(number: 10, min_alpha: 3) #=> "3yfq2phxtb"
+      # @example Faker::Alphanumeric.alphanumeric(number: 10, min_alpha: 3, min_numeric: 3) #=> "3yfq2phx8b"
+      #
+      # @faker.version 2.1.3
+      def alphanumeric(legacy_number = NOT_GIVEN, number: 32, min_alpha: 0, min_numeric: 0)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
         char_count = resolve(number)
         return '' if char_count.to_i < 1
+        raise ArgumentError, 'min_alpha must be greater than or equal to 0' if min_alpha&.negative?
+        raise ArgumentError, 'min_numeric must be greater than or equal to 0' if min_numeric&.negative?
+
+        return Array.new(char_count) { sample(ALPHANUMS) }.join if min_alpha.zero? && min_numeric.zero?
+
+        raise ArgumentError, 'min_alpha + min_numeric must be <= number' if min_alpha + min_numeric > char_count
+
+        random_count = char_count - min_alpha - min_numeric
+
+        alphas = Array.new(min_alpha) { sample(self::LLetters) }
+        numbers = Array.new(min_numeric) { sample(self::Numbers) }
+        randoms = Array.new(random_count) { sample(ALPHANUMS) }
 
-        Array.new(char_count) { sample(ALPHANUMS) }.join
+        combined = alphas + numbers + randoms
+        combined.shuffle.join
       end
     end
   end