ffaker 2.7.0 → 2.21.0

data/lib/ffaker/address_ua.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'ffaker/address'
+# frozen_string_literal: true
 
 module FFaker
   module AddressUA
@@ -32,7 +30,7 @@ module FFaker
     end
 
     def street_address(include_secondary = false)
-      str = "#{street_name}, #{building_number}"
+      str = +"#{street_name}, #{building_number}"
       str << ", кв. #{appartment_number}" if include_secondary
       str
     end

data/lib/ffaker/address_uk.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'ffaker/address'
+# frozen_string_literal: true
 
 module FFaker
   module AddressUK

data/lib/ffaker/address_us.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'ffaker/address'
+# frozen_string_literal: true
 
 module FFaker
   module AddressUS
@@ -21,8 +19,12 @@ module FFaker
       fetch_sample(STATE)
     end
 
-    def state_abbr
-      fetch_sample(STATE_ABBR)
+    def state_abbr(st_name = nil)
+      return find_abbr(state) unless st_name
+
+      st_name = capitalize_all_words(st_name)
+      check_state_existence(st_name)
+      find_abbr(st_name)
     end
 
     def state_and_territories_abbr
@@ -36,5 +38,21 @@ module FFaker
     def continental_state_abbr
       fetch_sample(CONTINENTAL_STATE_ABBR)
     end
+
+    private
+
+    def check_state_existence(state_name)
+      return if STATE.include?(state_name)
+
+      raise ArgumentError, "Unexpected state name: '#{state_name}'"
+    end
+
+    def find_abbr(state)
+      STATE_ABBR[STATE.index(state)]
+    end
+
+    def capitalize_all_words(string)
+      string.split.map(&:capitalize).join(' ')
+    end
   end
 end

data/lib/ffaker/airline.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Airline

data/lib/ffaker/animal.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FFaker
+  module Animal
+    extend ModuleUtils
+    extend self
+
+    # @deprecated US animals name. Moved into {AnimalUS}
+    def common_name
+      warn '[common_name] is deprecated. For animal name in english please use the AnimalUS module'
+      fetch_sample(COMMON_NAMES)
+    end
+  end
+end

data/lib/ffaker/{animals.rb → animal_br.rb}

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
-  module Animal
+  module AnimalBR
     extend ModuleUtils
     extend self
 

data/lib/ffaker/animal_cn.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FFaker
+  module AnimalCN
+    extend ModuleUtils
+    extend self
+
+    def common_name
+      fetch_sample(COMMON_NAMES)
+    end
+  end
+end

data/lib/ffaker/animal_es.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FFaker
+  module AnimalES
+    extend ModuleUtils
+    extend self
+
+    def common_name
+      fetch_sample(COMMON_NAMES)
+    end
+  end
+end

data/lib/ffaker/animal_pl.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FFaker
+  # Inspirations:
+  # https://www.ekologia.pl/wiedza/zwierzeta/
+  module AnimalPL
+    extend ModuleUtils
+
+    module_function
+
+    def common_name
+      fetch_sample(COMMON_NAMES)
+    end
+  end
+end

data/lib/ffaker/animal_us.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FFaker
+  module AnimalUS
+    extend ModuleUtils
+    extend self
+
+    def common_name
+      fetch_sample(COMMON_NAMES)
+    end
+  end
+end

data/lib/ffaker/avatar.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Avatar
@@ -8,11 +8,29 @@ module FFaker
     SUPPORTED_FORMATS = %w[png jpg bmp].freeze
 
     def image(slug = nil, size = '300x300', format = 'png', 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)
-      raise ArgumentError, 'Not a supported background number. Choose eather 1 or 2' unless bgset.nil? || (1..2).cover?(bgset.to_i)
+      check_passed_params(size, format, bgset)
       slug ||= FFaker::Lorem.words.join
-      "https://robohash.org/#{slug}.#{format}?size=#{size}#{'&bgset=bg' + bgset.to_s unless bgset.nil?}"
+      "https://robohash.org/#{slug}.#{format}?size=#{size}#{'&bgset=bg' + bgset.to_s if bgset}"
+    end
+
+    private
+
+    def check_passed_params(size, format, bgset)
+      invalid_size_error unless size =~ /^[0-9]+x[0-9]+$/
+      invalid_format_error unless SUPPORTED_FORMATS.include?(format)
+      invalid_background_number unless bgset.nil? || (1..2).cover?(bgset.to_i)
+    end
+
+    def invalid_size_error
+      raise ArgumentError, 'Size should be specified in format 300x300'
+    end
+
+    def invalid_format_error
+      raise ArgumentError, "Supported formats are #{SUPPORTED_FORMATS.join(', ')}"
+    end
+
+    def invalid_background_number
+      raise ArgumentError, 'Not a supported background number. Choose eather 1 or 2'
     end
   end
 end

data/lib/ffaker/aws.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module AWS

data/lib/ffaker/bacon_ipsum.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'ffaker/lorem'
+# frozen_string_literal: true
 
 module FFaker
   # Thanks to http://baconipsum.com/

data/lib/ffaker/bank.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module FFaker
+  module Bank
+    extend ModuleUtils
+    extend self
+
+    COUNTRIES = {
+      'AA' => 'AL##########################', # Albania
+      'AD' => 'AD######################', # Andorra
+      'AT' => 'AT##################', # Austria
+      'AZ' => 'AZ##????####################', # Azerbaijan
+      'BH' => 'BH##????##############', # Bahrain
+      'BY' => 'BY##????####################', # Belarus
+      'BE' => 'BE##############', # Belgium
+      'BA' => 'BA##################', # Bosnia and Herzegovina
+      'BR' => 'BR#########################P#', # Brazil
+      'BG' => 'BG##????##############', # Bulgaria
+      'CR' => 'CR####################', # Costa Rica
+      'HR' => 'HR###################', # Croatia
+      'CY' => 'CY##########################', # Cyprus
+      'CZ' => 'CZ######################', # Czech Republic
+      'DK' => 'DK################', # Denmark
+      'DO' => 'DO##????####################', # Dominican Republic
+      'SV' => 'SV##????####################', # El Salvador
+      'EE' => 'EE##################', # Estonia
+      'FO' => 'FO################', # Faroe Islands
+      'FI' => 'FI################', # Finland
+      'FR' => 'FR#########################', # France
+      'GE' => 'GE##??################', # Georgia
+      'DE' => 'DE####################', # Germany
+      'GI' => 'GI##????###############', # Gibraltar
+      'GR' => 'GR#########################', # Greece
+      'GL' => 'GL################', # Greenland
+      'GT' => 'GT##AGRO####################', # Guatemala
+      'VA' => 'VA####################', # Holy See
+      'HU' => 'HU##########################', # Hungary
+      'IS' => 'IS########################', # Iceland
+      'IQ' => 'IQ##????###############', # Iraq
+      'IE' => 'IE##????##############', # Ireland
+      'IL' => 'IL#####################', # Israel
+      'IT' => 'IT##X######################', # Italy
+      'JO' => 'JO##????######################', # Jordan
+      'KZ' => 'KZ##################', # Kazakhstan
+      'XK' => 'XK##################', # Kosovo
+      'KW' => 'KW##????######################', # Kuwait
+      'LV' => 'LV##????#############', # Latvia
+      'LB' => 'LB##########################', # Lebanon
+      'LI' => 'LI###################', # Liechtenstein
+      'LT' => 'LT##################', # Lithuania
+      'LU' => 'LU##################', # Luxembourg
+      'MT' => 'MT##MALT#######################', # Malta
+      'MR' => 'MR#########################', # Mauritania
+      'MU' => 'MU##????###################MUR', # Mauritius
+      'MD' => 'MD##??##################', # Moldova
+      'MC' => 'MC#########################', # Monaco
+      'ME' => 'ME####################', # Montenegro
+      'NL' => 'NL##????##########', # Netherlands
+      'MK' => 'MK#################', # North Macedonia
+      'NO' => 'NO#############', # Norway
+      'PK' => 'PK##????################', # Pakistan
+      'PS' => 'PS##PALS#####################', # Palestine
+      'PL' => 'PL##########################', # Poland
+      'PT' => 'PT#######################', # Portugal
+      'QA' => 'QA##????#####################', # Qatar
+      'RO' => 'RO##????################', # Romania
+      'LC' => 'LC##????########################', # Saint Lucia
+      'SM' => 'SM##P######################', # San Marino
+      'ST' => 'ST#######################', # Sao Tome and Principe
+      'SA' => 'SA######################', # Saudi Arabia
+      'RS' => 'RS####################', # Serbia
+      'SC' => 'SC##????####################USD', # Seychelles
+      'SK' => 'SK######################', # Slovak Republic
+      'SI' => 'SI#################', # Slovenia
+      'ES' => 'ES######################', # Spain
+      'SE' => 'SE######################', # Sweden
+      'CH' => 'CH###################', # Switzerland
+      'TL' => 'TL#####################', # Timor-Leste
+      'TN' => 'TN######################', # Tunisia
+      'TR' => 'TR########################', # Turkey
+      'UA' => 'UA###########################', # Ukraine
+      'AE' => 'AE#####################', # United Arab Emirates
+      'GB' => 'GB##????##############', # United Kingdom
+      'VG' => 'VG##????################' # Virgin Islands, British
+    }.freeze
+
+    def iban(country_code: nil)
+      return formatify_iban(fetch_sample(COUNTRIES.values)) unless country_code
+
+      check_country_existence(country_code)
+      formatify_iban(COUNTRIES[country_code.upcase])
+    end
+
+    def card_number
+      FFaker.numerify('#### #### #### ####')
+    end
+
+    def card_expiry_date(year_range: 5, year_latest: -5, format: '%m/%y')
+      FFaker::Time.date({ year_range: year_range, year_latest: year_latest }).strftime(format)
+    end
+
+    def card_type
+      fetch_sample(CARD_TYPES)
+    end
+
+    private
+
+    def formatify_iban(code)
+      FFaker.bothify(code).upcase
+    end
+
+    def check_country_existence(country_code)
+      return if COUNTRIES.keys.include?(country_code.upcase)
+
+      raise ArgumentError, "Unexpected country code: '#{country_code}'"
+    end
+  end
+end

data/lib/ffaker/book.rb

@@ -1,7 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Book
+    require 'cgi'
+
     extend ModuleUtils
     extend self
 
@@ -32,6 +34,15 @@ module FFaker
       FFaker::Avatar.image(slug, size, format, bgset)
     end
 
+    def orly_cover(name = title, book_author = author, top_text = genre)
+      'https://orly-appstore.herokuapp.com/generate?'\
+        "title=#{CGI.escape(name)}&"\
+        "top_text=#{CGI.escape(top_text)}&"\
+        "author=#{CGI.escape(book_author)}&"\
+        "image_code=#{Random.rand(1..40)}&"\
+        "theme=#{Random.rand(1..16)}"
+    end
+
     private
 
     def simple_title

data/lib/ffaker/boolean.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Boolean

data/lib/ffaker/cheesy_lingo.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module CheesyLingo
@@ -31,11 +31,8 @@ module FFaker
     end
 
     def paragraph(number_of_phrases = 10)
-      p = fetch_sample(CHEESY_PHRASES).capitalize.to_s
-      (number_of_phrases - 1).times do |s|
-        s = " #{fetch_sample(CHEESY_PHRASES)}"
-        p << s
-      end
+      p = +fetch_sample(CHEESY_PHRASES).capitalize
+      (number_of_phrases - 1).times { p << " #{fetch_sample(CHEESY_PHRASES)}" }
       p << '.'
     end
   end

data/lib/ffaker/code.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module FFaker
+  module Code
+    extend ModuleUtils
+    extend self
+
+    def npi(legacy: false)
+      max = legacy ? 299_999_999 : 999_999_999
+      base_npi = rand(100_000_000..max).to_s
+
+      summed_digits = base_npi
+                      .chars
+                      .each_with_index
+                      .map { |n, i| (i.even? ? n.to_i * 2 : n).to_s }
+                      .join
+                      .chars
+                      .inject(0) { |sum, digit| sum + digit.to_i }
+
+      npi_checksum = (10 - (24 + summed_digits) % 10).to_s.chars.last
+
+      base_npi + npi_checksum
+    end
+
+    def ean
+      ean = rand(100_000_000_000..999_999_999_999).to_s
+
+      sum = 0
+      ean.chars.each_with_index { |c, i| sum += c.to_i * (i.odd? ? 3 : 1) }
+
+      nearest_multiple_of_ten = sum.round(-1)
+      nearest_multiple_of_ten += 10 if nearest_multiple_of_ten < sum
+
+      "#{ean}#{nearest_multiple_of_ten - sum}"
+    end
+  end
+end

data/lib/ffaker/color.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Color
@@ -18,15 +18,15 @@ module FFaker
     end
 
     def rgb_list
-      "#{random_rgb_value},#{random_rgb_value},#{random_rgb_value}"
+      rgb_array.join(',')
     end
 
     def rgba_array
-      [random_rgb_value, random_rgb_value, random_rgb_value, random_opacity_value]
+      rgb_array << random_opacity_value
     end
 
     def rgba_list
-      "#{random_rgb_value},#{random_rgb_value},#{random_rgb_value},#{random_opacity_value}"
+      rgba_array.join(',')
     end
 
     def hsl_array
@@ -34,15 +34,15 @@ module FFaker
     end
 
     def hsl_list
-      "#{random_hue_value},#{random_percentage_string},#{random_percentage_string}"
+      hsl_array.join(',')
     end
 
     def hsla_array
-      [random_hue_value, random_percentage_string, random_percentage_string, random_opacity_value]
+      hsl_array << random_opacity_value
     end
 
     def hsla_list
-      "#{random_hue_value},#{random_percentage_string},#{random_percentage_string},#{random_opacity_value}"
+      hsla_array.join(',')
     end
 
     private

data/lib/ffaker/color_pl.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FFaker
+  # Inspiration:
+  # https://pl.wikipedia.org/wiki/Lista_kolor%C3%B3w
+  module ColorPL
+    extend ModuleUtils
+    extend self
+
+    def name
+      fetch_sample(NAMES_LIST)
+    end
+  end
+end

data/lib/ffaker/color_ua.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module ColorUA

data/lib/ffaker/company.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Company
@@ -35,12 +35,9 @@ module FFaker
 
     def position
       case rand(0..2)
-      when 0 then
-        [fetch_sample(POSITION_PREFIXES), fetch_sample(POSITIONS)]
-      when 1 then
-        [fetch_sample(POSITION_AREAS), fetch_sample(POSITIONS)]
-      when 2 then
-        [fetch_sample(POSITION_PREFIXES), fetch_sample(POSITION_AREAS), fetch_sample(POSITIONS)]
+      when 0 then [fetch_sample(POSITION_PREFIXES), fetch_sample(POSITIONS)]
+      when 1 then [fetch_sample(POSITION_AREAS), fetch_sample(POSITIONS)]
+      when 2 then [fetch_sample(POSITION_PREFIXES), fetch_sample(POSITION_AREAS), fetch_sample(POSITIONS)]
       end.join(' ')
     end
   end

data/lib/ffaker/company_cn.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module CompanyCN

data/lib/ffaker/company_fr.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module FFaker
+  module CompanyFR
+    extend ModuleUtils
+    extend self
+
+    SUFFIXES = %w[SA et\ fils SARL Groupe].freeze
+
+    def name
+      case rand(0..2)
+      when 0 then "#{NameFR.last_name} #{suffix}"
+      when 1 then "#{NameFR.last_name}-#{NameFR.last_name}"
+      when 2 then format('%s, %s and %s', NameFR.last_name, NameFR.last_name, NameFR.last_name)
+      end
+    end
+
+    def suffix
+      fetch_sample(SUFFIXES)
+    end
+
+    # Get a random French SIREN number. See more here https://fr.wikipedia.org/wiki/Syst%C3%A8me_d%27identification_du_r%C3%A9pertoire_des_entreprises
+    def siren
+      base = FFaker.numerify('########')
+      base + luhn_check(base).to_s
+    end
+
+    # Produces a company french siret number.
+    def siret
+      location = rand(0..99).to_s.rjust(4, '0')
+      org_no = siren + location
+      org_no + luhn_check(org_no).to_s
+    end
+  end
+end

data/lib/ffaker/company_it.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module CompanyIT
@@ -33,7 +33,9 @@ module FFaker
       base = matricola + office_code.chars.map(&:to_i)
 
       # Thanks https://stackoverflow.com/a/9189731/1627766
-      sum = base.reverse.each_slice(2).flat_map { |x, y| [(x * 2).divmod(10), y || 0] }.flatten.reduce(:+)
+      sum = base.reverse.each_slice(2).flat_map do |x, y = 0|
+        [(x * 2).divmod(10), y]
+      end.flatten.sum
 
       control_digit = (10 - (sum % 10)) % 10
 

data/lib/ffaker/company_ja.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FFaker
+  module CompanyJA
+    extend ModuleUtils
+    extend self
+
+    TYPES = %w[株式会社 有限会社].freeze
+    DETAILED_TYPES = %w[ホールディングス 建設 商業 書店 不動産 銀行 証券].freeze
+    POSITIONS = %w[会長 社長 部長 課長 係長 社員 契約社員 派遣社員 アルバイト インターン].freeze
+
+    def name
+      case rand(0..2)
+      when 0 then "#{NameJA.last_name}#{fetch_sample(TYPES)}"
+      when 1 then "#{fetch_sample(TYPES)}#{NameJA.last_name}"
+      when 2 then "#{NameJA.last_name}#{fetch_sample(DETAILED_TYPES)}"
+      end
+    end
+
+    def position
+      fetch_sample(POSITIONS)
+    end
+  end
+end

data/lib/ffaker/company_se.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module CompanySE

data/lib/ffaker/conference.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Conference

data/lib/ffaker/{courses.rb → courses_fr.rb}

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module CoursesFR
     module Mathematiques
       extend ModuleUtils
       extend self
+
       def lesson
         fetch_sample(LESSONS)
       end
@@ -13,6 +14,7 @@ module FFaker
     module Philosophie
       extend ModuleUtils
       extend self
+
       def lesson
         fetch_sample(LESSONS)
       end

data/lib/ffaker/currency.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Currency
@@ -12,5 +12,9 @@ module FFaker
     def name
       fetch_sample(CURRENCY_NAME)
     end
+
+    def symbol
+      fetch_sample(CURRENCY_SYMBOL)
+    end
   end
 end

data/lib/ffaker/data/address/city_suffixes

@@ -16,4 +16,4 @@ mouth
 fort
 haven
 side
-shire
+shire

data/lib/ffaker/data/address/country

@@ -246,4 +246,4 @@ Wallis and Futuna
 Western Sahara
 Yemen
 Zambia
-Zimbabwe
+Zimbabwe