faker 1.8.7 → 1.9.1

data/lib/faker/invoice.rb

@@ -0,0 +1,94 @@
+module Faker
+  class Invoice < Base
+    flexible :invoice
+
+    class << self
+      # Generate random amount between values with 2 decimals
+      def amount_between(from = 0, to = 0)
+        Faker::Base.rand_in_range(from, to).round(2)
+      end
+
+      # International bank slip reference https://en.wikipedia.org/wiki/Creditor_Reference
+      # ref is optional so that we can create unit tests
+      def creditor_reference(ref = '')
+        ref = reference if ref.empty?
+
+        'RF' + iban_checksum('RF', ref) + ref
+      end
+
+      # Payment references have some rules in certain countries
+      # ref is optional so that we can create unit tests
+      def reference(ref = '')
+        pattern = fetch('invoice.reference.pattern')
+
+        ref = Base.regexify(/#{pattern}/) if ref.empty?
+
+        # If reference contains reserved '#' characters we need to calculate check_digits as well
+        check_digit_match = ref.match(/#+/)
+        if check_digit_match
+          # Get the method for selected language
+          check_digit_method = fetch('invoice.reference.check_digit_method')
+
+          # Calculate the check digit with matching method name
+          # Trim all '#' from the reference before calculating that
+          check_digit = send(check_digit_method, ref.tr('#', ''))
+
+          # Make sure that our check digit is as long as all of the '###' we found
+          check_digit = check_digit.to_s.rjust(check_digit_match[0].length, '0')
+
+          # Replace all of the
+          ref.sub!(check_digit_match[0], check_digit)
+        end
+
+        ref
+      end
+
+      private
+
+      # Calculates the mandatory checksum in 3rd and 4th characters in IBAN format
+      # source: https://en.wikipedia.org/wiki/International_Bank_Account_Number#Validating_the_IBAN
+      def iban_checksum(country_code, account)
+        # Converts letters to numbers according the iban rules, A=10..Z=35
+        account_to_number = "#{account}#{country_code}00".upcase.chars.map do |d|
+          d =~ /[A-Z]/ ? (d.ord - 55).to_s : d
+        end.join.to_i
+
+        # This is answer to (iban_to_num + checksum) % 97 == 1
+        checksum = (1 - account_to_number) % 97
+
+        # Use leftpad to make the size always to 2
+        checksum.to_s.rjust(2, '0')
+      end
+
+      # 731 Method
+      # Source: https://wiki.xmldation.com/support/fk/finnish_reference_number
+      def method_731(base)
+        weighted_sum = calculate_weighted_sum(base, [7, 3, 1])
+        mod10_remainder(weighted_sum)
+      end
+
+      # Norsk Modulus 10 - KIDMOD10
+      def kidmod10(base)
+        weighted_sum = calculate_weighted_sum(base, [1, 2])
+        mod10_remainder(weighted_sum)
+      end
+
+      # Calculates weigthed sum
+      #
+      # For example with 12345678, [1,2]
+      # Ref.num. 1 2 3 4 5 6 7 8
+      # Multipl. 1 2 1 2 1 2 1 2
+      # Total 1+ 4+ 3+ 8+ 5+1+2+ 7+1+6 = 38
+      def calculate_weighted_sum(base, weight_factors)
+        base.to_s.reverse.each_char.with_index.map do |digit, index|
+          digit.to_i * weight_factors.at(index % weight_factors.length)
+        end.reduce(:+) # reduce(:+) = sum() but with better ruby version support
+      end
+
+      # MOD-10 - remainder
+      def mod10_remainder(number)
+        -number % 10
+      end
+    end
+  end
+end

data/lib/faker/job.rb

@@ -3,14 +3,21 @@ module Faker
     flexible :job
 
     class << self
-
       def title
         parse('job.title')
       end
 
-      def field;     fetch('job.field'); end
-      def key_skill; fetch('job.key_skills'); end
+      def position
+        fetch('job.position')
+      end
 
+      def field
+        fetch('job.field')
+      end
+
+      def key_skill
+        fetch('job.key_skills')
+      end
     end
   end
 end

data/lib/faker/lebowski.rb

@@ -4,7 +4,7 @@ module Faker
       def actor
         fetch('lebowski.actors')
       end
-      
+
       def character
         fetch('lebowski.characters')
       end
@@ -14,4 +14,4 @@ module Faker
       end
     end
   end
-end
+end

data/lib/faker/lord_of_the_rings.rb

@@ -8,6 +8,10 @@ module Faker
       def location
         fetch('lord_of_the_rings.locations')
       end
+
+      def quote
+        fetch('lord_of_the_rings.quotes')
+      end
     end
   end
-end
+end

data/lib/faker/lorem.rb

@@ -14,7 +14,7 @@ module Faker
           translate('faker.lorem.words') +
           (supplemental ? translate('faker.lorem.supplemental') : [])
         )
-        word_list = word_list * ((resolved_num / word_list.length) + 1)
+        word_list *= ((resolved_num / word_list.length) + 1)
         shuffle(word_list)[0, resolved_num]
       end
 
@@ -28,31 +28,55 @@ module Faker
         Array.new(char_count) { sample(CHARACTERS) }.join
       end
 
-      def sentence(word_count = 4, supplemental = false, random_words_to_add = 6)
-        words(word_count + rand(random_words_to_add.to_i), supplemental).join(' ').capitalize + '.'
+      def multibyte
+        sample('faker.multibyte')
+      end
+
+      def sentence(word_count = 4, supplemental = false, random_words_to_add = 0)
+        words(word_count + rand(random_words_to_add.to_i), supplemental).join(' ').capitalize + locale_period
       end
 
       def sentences(sentence_count = 3, supplemental = false)
         1.upto(resolve(sentence_count)).collect { sentence(3, supplemental) }
       end
 
-      def paragraph(sentence_count = 3, supplemental = false, random_sentences_to_add = 3)
-        sentences(resolve(sentence_count) + rand(random_sentences_to_add.to_i), supplemental).join(' ')
+      def paragraph(sentence_count = 3, supplemental = false, random_sentences_to_add = 0)
+        sentences(resolve(sentence_count) + rand(random_sentences_to_add.to_i), supplemental).join(locale_space)
       end
 
       def paragraphs(paragraph_count = 3, supplemental = false)
         1.upto(resolve(paragraph_count)).collect { paragraph(3, supplemental) }
       end
 
-      def question(word_count = 4, supplemental = false, random_words_to_add = 6)
-        words(word_count + rand(random_words_to_add.to_i), supplemental).join(' ').capitalize + '?'
+      def paragraph_by_chars(chars = 256, supplemental = false)
+        paragraph = paragraph(3, supplemental)
+
+        paragraph += ' ' + paragraph(3, supplemental) while paragraph.length < chars
+
+        paragraph[0...chars - 1] + '.'
+      end
+
+      def question(word_count = 4, supplemental = false, random_words_to_add = 0)
+        words(word_count + rand(random_words_to_add), supplemental).join(' ').capitalize + locale_question_mark
       end
 
       def questions(question_count = 3, supplemental = false)
         1.upto(resolve(question_count)).collect { question(3, supplemental) }
       end
 
-    private
+      private
+
+      def locale_period
+        translate('faker.lorem.punctuation.period') || '.'
+      end
+
+      def locale_space
+        translate('faker.lorem.punctuation.space') || ' '
+      end
+
+      def locale_question_mark
+        translate('faker.lorem.punctuation.question_mark') || '?'
+      end
 
       # If an array or range is passed, a random value will be selected.
       # All other values are simply returned.

data/lib/faker/lorem_flickr.rb

@@ -0,0 +1,43 @@
+module Faker
+  class LoremFlickr < Base
+    class << self
+      SUPPORTED_COLORIZATIONS = %w[red green blue].freeze
+
+      def image(size = '300x300', search_terms = [], match_all = false)
+        build_url(size, nil, search_terms, match_all)
+      end
+
+      def grayscale_image(size = '300x300', search_terms = ['all'], match_all = false)
+        raise ArgumentError, 'Search terms must be specified for grayscale images' unless search_terms.any?
+
+        build_url(size, 'g', search_terms, match_all)
+      end
+
+      def pixelated_image(size = '300x300', search_terms = ['all'], match_all = false)
+        raise ArgumentError, 'Search terms must be specified for pixelated images' unless search_terms.any?
+
+        build_url(size, 'p', search_terms, match_all)
+      end
+
+      def colorized_image(size = '300x300', color = 'red', search_terms = ['all'], match_all = false)
+        raise ArgumentError, 'Search terms must be specified for colorized images' unless search_terms.any?
+        raise ArgumentError, "Supported colorizations are #{SUPPORTED_COLORIZATIONS.join(', ')}" unless SUPPORTED_COLORIZATIONS.include?(color)
+
+        build_url(size, color, search_terms, match_all)
+      end
+
+      private
+
+      def build_url(size, format, search_terms, match_all)
+        raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
+
+        url_parts = ['http://loremflickr.com']
+        url_parts << format
+        url_parts += size.split('x')
+        url_parts << search_terms.compact.join(',') if search_terms.any?
+        url_parts << 'all' if match_all
+        url_parts.compact.join('/')
+      end
+    end
+  end
+end

data/lib/faker/lorem_pixel.rb

@@ -1,21 +1,36 @@
 module Faker
   class LoremPixel < Base
     class << self
-      SUPPORTED_CATEGORIES = %w(abstract animals business cats city food nightlife fashion people nature sports technics transport)
+      SUPPORTED_CATEGORIES = %w[abstract
+                                animals
+                                business
+                                cats
+                                city
+                                food
+                                nightlife
+                                fashion
+                                people
+                                nature
+                                sports
+                                technics
+                                transport].freeze
 
-      def image(size = '300x300', is_gray = false, category = nil, number = nil, text = nil)
-        raise ArgumentError, 'Size should be specified in format 300x300' unless size.match(/^[0-9]+x[0-9]+$/)
+      # rubocop:disable Metrics/ParameterLists
+      def image(size = '300x300', is_gray = false, category = nil, number = nil, text = nil, secure: true)
+        raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
         raise ArgumentError, "Supported categories are #{SUPPORTED_CATEGORIES.join(', ')}" unless category.nil? || SUPPORTED_CATEGORIES.include?(category)
         raise ArgumentError, 'Category required when number is passed' if !number.nil? && category.nil?
-        raise ArgumentError, 'Number must be between 1 and 10' unless number.nil? || (1..10).include?(number)
+        raise ArgumentError, 'Number must be between 1 and 10' unless number.nil? || (1..10).cover?(number)
         raise ArgumentError, 'Category and number must be passed when text is passed' if !text.nil? && number.nil? && category.nil?
 
-        url_parts = ['http://lorempixel.com']
+        url_parts = secure ? ['https:/'] : ['http:/']
+        url_parts << ['lorempixel.com']
         url_parts << 'g' if is_gray
         url_parts += size.split('x')
         url_parts += [category, number, text].compact
         url_parts.join('/')
       end
+      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/faker/lovecraft.rb

@@ -6,7 +6,7 @@ module Faker
       end
 
       def fhtagn(number_of = 1)
-        number_of.times.collect { fetch('lovecraft.fhtagn') }.join(". ")
+        Array.new(number_of) { fetch('lovecraft.fhtagn') }.join('. ')
       end
 
       def deity
@@ -23,20 +23,19 @@ module Faker
 
       def word
         random_word = sample(translate('faker.lovecraft.words'))
-        random_word.match(/\s/) ? word : random_word
+        random_word =~ /\s/ ? word : random_word
       end
 
       def words(num = 3, spaces_allowed = false)
         resolved_num = resolve(num)
         word_list = translate('faker.lovecraft.words')
-        word_list = word_list * ((resolved_num / word_list.length) + 1)
+        word_list *= ((resolved_num / word_list.length) + 1)
 
         return shuffle(word_list)[0, resolved_num] if spaces_allowed
         words = shuffle(word_list)[0, resolved_num]
-        words.each_with_index { |w, i| words[i] = word if w.match(/\s/) }
+        words.each_with_index { |w, i| words[i] = word if w =~ /\s/ }
       end
 
-
       def sentences(sentence_count = 3)
         [].tap do |sentences|
           1.upto(resolve(sentence_count)) do
@@ -57,6 +56,14 @@ module Faker
         end
       end
 
+      def paragraph_by_chars(chars = 256)
+        paragraph = paragraph(3)
+
+        paragraph += ' ' + paragraph(3) while paragraph.length < chars
+
+        paragraph[0...chars - 1] + '.'
+      end
+
       private
 
       # If an array or range is passed, a random value will be selected.

data/lib/faker/markdown.rb

@@ -1,7 +1,6 @@
 module Faker
   class Markdown < Base
     class << self
-
       def headers
         "#{fetch('markdown.headers')} #{Lorem.word.capitalize}"
       end
@@ -20,7 +19,7 @@ module Faker
 
         result = []
         number.times do |i|
-          result << "#{i.to_s}. #{Faker::Lorem.sentence(1)} \n"
+          result << "#{i}. #{Faker::Lorem.sentence(1)} \n"
         end
         result.join('')
       end
@@ -29,7 +28,7 @@ module Faker
         number = rand(1..10)
 
         result = []
-        number.times do |i|
+        number.times do |_i|
           result << "* #{Faker::Lorem.sentence(1)} \n"
         end
         result.join('')
@@ -56,12 +55,21 @@ module Faker
         send(available_methods[rand(0..available_methods.length - 1)])
       end
 
+      def sandwich(sentences = 3, repeat = 1)
+        text_block = []
+        text_block << headers
+        repeat.times do
+          text_block << Faker::Lorem.paragraph(sentences)
+          text_block << random
+        end
+        text_block.join("\n")
+      end
+
       private
 
       def available_methods
         Markdown.public_methods(false) - Base.methods
       end
-
     end
   end
 end

data/lib/faker/measurement.rb

@@ -1,105 +1,43 @@
 module Faker
   class Measurement < Base
     class << self
-      ALL = "all"
-      NONE = "none"
+      ALL = 'all'.freeze
+      NONE = 'none'.freeze
 
       def height(amount = rand(10))
-        ensure_valid_amount(amount)
-        if amount == ALL
-          make_plural(fetch('measurement.height'))
-        elsif amount == NONE
-          fetch('measurement.height')
-        else
-          "#{amount.to_s} #{check_for_plural(fetch('measurement.height'), amount)}"
-        end
+        define_measurement_locale(amount, 'height')
       end
 
       def length(amount = rand(10))
-        ensure_valid_amount(amount)
-        if amount == ALL
-          make_plural(fetch('measurement.length'))
-        elsif amount == NONE
-          fetch('measurement.length')
-        else
-          "#{amount.to_s} #{check_for_plural(fetch('measurement.length'), amount)}"
-        end
+        define_measurement_locale(amount, 'length')
       end
 
       def volume(amount = rand(10))
-        ensure_valid_amount(amount)
-        if amount == ALL
-          make_plural(fetch('measurement.volume'))
-        elsif amount == NONE
-          fetch('measurement.volume')
-        else
-          "#{amount.to_s} #{check_for_plural(fetch('measurement.volume'), amount)}"
-        end
+        define_measurement_locale(amount, 'volume')
       end
 
       def weight(amount = rand(10))
-        ensure_valid_amount(amount)
-        if amount == ALL
-          make_plural(fetch('measurement.weight'))
-        elsif amount == NONE
-          fetch('measurement.weight')
-        else
-          "#{amount.to_s} #{check_for_plural(fetch('measurement.weight'), amount)}"
-        end
+        define_measurement_locale(amount, 'weight')
       end
 
       def metric_height(amount = rand(10))
-        ensure_valid_amount(amount)
-        if amount == ALL
-          make_plural(fetch('measurement.height'))
-        elsif amount == NONE
-          fetch('measurement.height')
-        else
-          "#{amount.to_s} #{check_for_plural(fetch('measurement.height'), amount)}"
-        end
+        define_measurement_locale(amount, 'metric_height')
       end
 
       def metric_length(amount = rand(10))
-        ensure_valid_amount(amount)
-        if amount == ALL
-          make_plural(fetch('measurement.length'))
-        elsif amount == NONE
-          fetch('measurement.length')
-        else
-          "#{amount.to_s} #{check_for_plural(fetch('measurement.length'), amount)}"
-        end
+        define_measurement_locale(amount, 'metric_length')
       end
 
       def metric_volume(amount = rand(10))
-        ensure_valid_amount(amount)
-        if amount == ALL
-          make_plural(fetch('measurement.volume'))
-        elsif amount == NONE
-          fetch('measurement.volume')
-        else
-          "#{amount.to_s} #{check_for_plural(fetch('measurement.volume'), amount)}"
-        end
+        define_measurement_locale(amount, 'metric_volume')
       end
 
       def metric_weight(amount = rand(10))
-        ensure_valid_amount(amount)
-        if amount == ALL
-          make_plural(fetch('measurement.weight'))
-        elsif amount == NONE
-          fetch('measurement.weight')
-        else
-          "#{amount.to_s} #{check_for_plural(fetch('measurement.weight'), amount)}"
-        end
+        define_measurement_locale(amount, 'metric_weight')
       end
 
       private
 
-      def ensure_valid_amount(amount)
-        unless amount == NONE || amount == ALL || amount.is_a?(Integer) || amount.is_a?(Float)
-          raise ArgumentError, 'invalid amount'
-        end
-      end
-
       def check_for_plural(text, number)
         if number && number != 1
           make_plural(text)
@@ -108,16 +46,33 @@ module Faker
         end
       end
 
+      def define_measurement_locale(amount, locale)
+        ensure_valid_amount(amount)
+        if amount == ALL
+          make_plural(fetch("measurement.#{locale}"))
+        elsif amount == NONE
+          fetch("measurement.#{locale}")
+        else
+          locale = check_for_plural(fetch("measurement.#{locale}"), amount)
+
+          "#{amount} #{locale}"
+        end
+      end
+
+      def ensure_valid_amount(amount)
+        raise ArgumentError, 'invalid amount' unless amount == NONE || amount == ALL || amount.is_a?(Integer) || amount.is_a?(Float)
+      end
+
       def make_plural(text)
         case text
-        when "foot"
-          "feet"
-        when "inch"
-          "inches"
-        when "fluid ounce"
-          "fluid ounces"
-        when "metric ton"
-          "metric tons"
+        when 'foot'
+          'feet'
+        when 'inch'
+          'inches'
+        when 'fluid ounce'
+          'fluid ounces'
+        when 'metric ton'
+          'metric tons'
         else
           "#{text}s"
         end