factory-helper

This gem began life as a fork of stympy's Faker. While the usage examples below use the FactoryHelper name, the Faker constant remains available. For example, Faker::Name.name.

FactoryHelper's purpose is to facilitate software testing by allowing factories to have a solid source of random data with defined characteristics, but the gem can be used for many other purposes as well as in production code.

Its main use-case is slightly different than Faker's and will evolve in that direction, with a primary focus on software testing and only a secondary focus on real-looking data. New features will also be added, some based on PRs submitted to the original repo, some based on things we've needed ourselves, and some based on incoming pull requests.

Build Status Coverage Status Gem Version

NOTE: While FactoryHelper generates data at random, returned values are not guaranteed to be unique. They can however be deterministic if you use the seeding feature.

Installing

gem install factory-helper

or in your Gemfile

gem 'factory-helper', '~> 1.7'

Usage

FactoryHelper::Name.name      #=> "Christophe Bartell"

FactoryHelper::Internet.email #=> "[email protected]"

Seeding

FactoryHelper now supports seeding of its pseudo-random number generator (PRNG) to provide deterministic output of repeated method calls.

FactoryHelper::Config.seed= 42 #=> 42
FactoryHelper::Company.bs #=> "seize collaborative mindshare"
FactoryHelper::Company.bs #=> "engage strategic platforms"
FactoryHelper::Config.seed= 42 #=> 42
FactoryHelper::Company.bs #=> "seize collaborative mindshare"
FactoryHelper::Company.bs #=> "engage strategic platforms"

FactoryHelper::Config.seed= nil # seeds the PRNG using default entropy sources
FactoryHelper::Config.seed #=> 6263681755117030645311740483944653976248826274740079170131
FactoryHelper::Company.bs #=> "cultivate viral synergies"

FactoryHelper::String

Random UTF-8 string with optional nested length arguments.

FactoryHelper::String.random #=> "3 뇦\u0017&y\u{3A109}$8^4* 녹豿4좘툢ꔾ쉙6ɉ\uA6 8TN畀챵|\"3쇤Ŵ"
FactoryHelper::String.random(4) #=> "⼨%0*"
FactoryHelper::String.random(3..12) #=> "\u{69FDC};秨툫"
FactoryHelper::String.random([0, 6]) #=> "I轤𣴒P溟L"
FactoryHelper::String.random([0, 3..12]) #=> "葓L#ћ"

FactoryHelper::MySQL

Generates values for a factory per the MySQL datatypes. Accepts options unsigned, min, max.

FactoryHelper::MySQL.integer #=> 1729  (int & integer are equivalent)
FactoryHelper::MySQL.tinyint #=> 42
FactoryHelper::MySQL.bigint #=> 9223372036854775807
FactoryHelper::MySQL.smallint(unsigned: true) #=> 55777
FactoryHelper::MySQL.int(min: 0, max: 1319) #=> 998
FactoryHelper::MySQL.mediumint #=> 7456451

FactoryHelper::Address

FactoryHelper::Address.city #=> "Imogeneborough"
FactoryHelper::Address.street_name #=> "Larkin Fork"
FactoryHelper::Address.street_address #=> "282 Kevin Brook"
FactoryHelper::Address.secondary_address #=> "Apt. 672"
FactoryHelper::Address.building_number #=> "7304"
FactoryHelper::Address.zip_code #=> "58517"
FactoryHelper::Address.zip #=> "58517"
FactoryHelper::Address.postcode #=> "58517"
FactoryHelper::Address.time_zone #=> "Asia/Yakutsk"
FactoryHelper::Address.street_suffix #=> "Street"
FactoryHelper::Address.city_suffix #=> "fort"
FactoryHelper::Address.city_prefix #=> "Lake"
FactoryHelper::Address.state_abbr #=> "AP"
FactoryHelper::Address.state #=> "California"
FactoryHelper::Address.state_abbr #=> "AP"
FactoryHelper::Address.country #=> "French Guiana"
FactoryHelper::Address.country_code #=> "IT"
FactoryHelper::Address.latitude #=> "-58.17256227443719"
FactoryHelper::Address.longitude #=> "-156.65548382095133"

FactoryHelper::Bitcoin

FactoryHelper::Bitcoin.address #=> "1HUoGjmgChmnxxYhz87YytV4gVjfPaExmh"
FactoryHelper::Bitcoin.testnet_address #=> "msHGunDvoEwmVFXvd2Bub1SNw5RP1YHJaf"

FactoryHelper::Business

FactoryHelper::Business.credit_card_number #=> "1228-1221-1221-1431"
FactoryHelper::Business.credit_card_expiry_date #=> <Date: 2015-11-11 ((2457338j,0s,0n),+0s,2299161j)>
FactoryHelper::Business.credit_card_type #=> "visa"

FactoryHelper::Code

FactoryHelper::Code.isbn #=> "759021701-8"
FactoryHelper::Code.ean #=> "4600051000057"

FactoryHelper::Commerce

FactoryHelper::Commerce.color #=> "lavender"

# Optional arguments max=3, fixed_amount=false
FactoryHelper::Commerce.department #=> "Grocery, Health & Beauty"
FactoryHelper::Commerce.department(5) #=> "Grocery, Books, Health & Beauty"
FactoryHelper::Commerce.department(2, true) #=> "Books & Tools"

FactoryHelper::Commerce.product_name #=> "Practical Granite Shirt"

FactoryHelper::Commerce.price #=> "44.6"

FactoryHelper::Company

FactoryHelper::Company.name #=> "Hirthe-Ritchie"

FactoryHelper::Company.suffix #=> "Group"

# Generate a buzzword-laden catch phrase.
FactoryHelper::Company.catch_phrase #=> "Business-focused coherent parallelism"

# When a straight answer won't do, BS to the rescue!
FactoryHelper::Company.bs #=> "empower one-to-one web-readiness"

FactoryHelper::Company.ein #=> "34-8488813"

FactoryHelper::Company.duns_number #=> "08-341-3736"

# Get a random company logo url in PNG format.
FactoryHelper::Company. #=> "http://pigment.github.com/fake-logos/logos/medium/color/5.png"

FactoryHelper::Date

# Random date between dates
FactoryHelper::Date.between(2.days.ago, Date.today) #=> "Wed, 24 Sep 2014"

# Random date in the future (up to maximum of N days)
FactoryHelper::Date.forward(23) #=> "Fri, 03 Oct 2014"

# Random date in the past (up to maximum of N days)
FactoryHelper::Date.backward(14) #=> "Fri, 19 Sep 2014"

FactoryHelper::Internet

# Optional argument name=nil
FactoryHelper::Internet.email #=> "[email protected]"
FactoryHelper::Internet.email('Nancy') #=> "[email protected]"

# Optional argument name=nil
FactoryHelper::Internet.free_email #=> "[email protected]"
FactoryHelper::Internet.free_email('Nancy') #=> "[email protected]"

# Optional argument name=nil
FactoryHelper::Internet.safe_email #=> "[email protected]"
FactoryHelper::Internet.safe_email('Nancy') #=> "[email protected]"

# Optional arguments specifier=nil, separators=%w(. _)
FactoryHelper::Internet.user_name #=> "alexie"
FactoryHelper::Internet.user_name('Nancy') #=> "nancy"
FactoryHelper::Internet.user_name('Nancy Johnson', %w(. _ -)) #=> "johnson-nancy"

# Optional arguments: min_length=8, max_length=16
FactoryHelper::Internet.password #=> "vg5msvy1uerg7"
FactoryHelper::Internet.password(8) #=> "yfgjik0hgzdqs0"
FactoryHelper::Internet.password(10, 20) #=> "eoc9shwd1hwq4vbgfw"

FactoryHelper::Internet.domain_name #=> "effertz.info"

FactoryHelper::Internet.fix_umlauts('äöüß') #=> "aeoeuess"

FactoryHelper::Internet.domain_word #=> "haleyziemann"

FactoryHelper::Internet.domain_suffix #=> "info"

FactoryHelper::Internet.ip_v4_address #=> "24.29.18.175"

FactoryHelper::Internet.ip_v6_address #=> "ac5f:d696:3807:1d72:2eb5:4e81:7d2b:e1df"

# Optional argument prefix=''
FactoryHelper::Internet.mac_address #=> "e6:0d:00:11:ed:4f"
FactoryHelper::Internet.mac_address('55:44:33') #=> "55:44:33:02:1d:9b"

# Optional arguments: host=domain_name, path="/#{user_name}"
FactoryHelper::Internet.url #=> "http://thiel.com/chauncey_simonis"
FactoryHelper::Internet.url('example.com') #=> "http://example.com/clotilde.swift"
FactoryHelper::Internet.url('example.com', '/foobar.html') #=> "http://example.com/foobar.html"

# Optional arguments: words=nil, glue=nil
FactoryHelper::Internet.slug #=> "pariatur_laudantium"
FactoryHelper::Internet.slug('foo bar') #=> "foo.bar"
FactoryHelper::Internet.slug('foo bar', '-') #=> "foo-bar"

FactoryHelper::Lorem

FactoryHelper::Lorem.word #=> "repellendus"

# Optional arguments: num=3, supplemental=false
FactoryHelper::Lorem.words #=> ["dolores", "adipisci", "nesciunt"]
FactoryHelper::Lorem.words(4) #=> ["culpa", "recusandae", "aut", "omnis"]
FactoryHelper::Lorem.words(4, true) #=> ["colloco", "qui", "vergo", "deporto"]

# Optional arguments: char_count=255
FactoryHelper::Lorem.characters #=> "uw1ep04lhs0c4d931n1jmrspprf5wrj85fefue0y7y6m56b6omquh7br7dhqijwlawejpl765nb1716idmp3xnfo85v349pzy2o9rir23y2qhflwr71c1585fnynguiphkjm8p0vktwitcsm16lny7jzp9t4drwav3qmhz4yjq4k04x14gl6p148hulyqioo72tf8nwrxxcclfypz2lc58lsibgfe5w5p0xv95peafjjmm2frkhdc6duoky0aha"
FactoryHelper::Lorem.characters(10) #=> "ang9cbhoa8"

# Optional arguments: word_count=4, supplemental=false, random_words_to_add=6
FactoryHelper::Lorem.sentence #=> "Dolore illum animi et neque accusantium."
FactoryHelper::Lorem.sentence(3) #=> "Commodi qui minus deserunt sed vero quia."
FactoryHelper::Lorem.sentence(3, true) #=> "Inflammatio denego necessitatibus caelestis autus illum."
FactoryHelper::Lorem.sentence(3, false, 4) #=> "Aut voluptatem illum fugit ut sit."
FactoryHelper::Lorem.sentence(3, true, 4) #=> "Accusantium tantillus dolorem timor."

# Optional arguments: sentence_count=3, supplemental=false
FactoryHelper::Lorem.sentences #=> ["Vero earum commodi soluta.", "Quaerat fuga cumque et vero eveniet omnis ut.", "Cumque sit dolor ut est consequuntur."]
FactoryHelper::Lorem.sentences(1) #=> ["Ut perspiciatis explicabo possimus doloribus enim quia."]
FactoryHelper::Lorem.sentences(1, true) #=> ["Quis capillus curo ager veritatis voro et ipsum."]

# Optional arguments: sentence_count=3, supplemental=false, random_sentences_to_add=3
FactoryHelper::Lorem.paragraph #=> "Neque dicta enim quasi. Qui corrupti est quisquam. Facere animi quod aut. Qui nulla consequuntur consectetur sapiente."
FactoryHelper::Lorem.paragraph(2) #=> "Illo qui voluptas. Id sit quaerat enim aut cupiditate voluptates dolorum. Porro necessitatibus numquam dolor quia earum."
FactoryHelper::Lorem.paragraph(2, true) #=> #<String:0x00000002bad3d8>
FactoryHelper::Lorem.paragraph(2, false, 4) #=> #<String:0x00000002ba3108>
FactoryHelper::Lorem.paragraph(2, true, 4) #=> #<String:0x00000002ba5b88>

# Optional arguments: paragraph_count=3, supplemental=false
FactoryHelper::Lorem.paragraphs #=> #<Array:0x00000002b95e18: #<String:0x00000002b9f968>, #<String:0x00000002b9cee8>>
FactoryHelper::Lorem.paragraphs(1) #=> #<Array:0x00000002720388: #<String:0x00000002b8f748>>
FactoryHelper::Lorem.paragraphs(1, true) #=> #<Array:0x00000002b7fc58: #<String:0x00000002b89758>>

FactoryHelper::Name

FactoryHelper::Name.name #=> "Tyshawn Johns Sr."
FactoryHelper::Name.first_name #=> "Kaci"
FactoryHelper::Name.last_name #=> "Ernser"
FactoryHelper::Name.prefix #=> "Mr."
FactoryHelper::Name.suffix #=> "IV"
FactoryHelper::Name.title #=> "Legacy Creative Director"
FactoryHelper::Name.female_name #=> "Marissa"
FactoryHelper::Name.male_name #=> "Brian"

FactoryHelper::Avatar

FactoryHelper::Avatar.image #=> "http://robohash.org/sitsequiquia.png?size=300x300"
FactoryHelper::Avatar.image("my-own-slug") #=> "http://robohash.org/my-own-slug.png?size=300x300"
FactoryHelper::Avatar.image("my-own-slug", "50x50") #=> "http://robohash.org/my-own-slug.png?size=50x50"
FactoryHelper::Avatar.image("my-own-slug", "50x50", "jpg") #=> "http://robohash.org/my-own-slug.jpg?size=50x50"
FactoryHelper::Avatar.image("my-own-slug", "50x50", "bmp") #=> "http://robohash.org/my-own-slug.bmp?size=50x50"

FactoryHelper::Number

# Optional parameter: digits
FactoryHelper::Number.number(10)      #=> "1968353479"
FactoryHelper::Number.number(10).to_i #=>  1968353479

FactoryHelper::Number.hexadecimal(10) #=> "9b7b26aa4c"

FactoryHelper::Number.digit #=> "1"

FactoryHelper::PhoneNumber

Phone numbers may be in any of the following formats:

  • 333-333-3333
  • (333) 333-3333
  • 1-333-333-3333
  • 333.333.3333
  • 333-333-3333
  • 333-333-3333 x3333
  • (333) 333-3333 x3333
  • 1-333-333-3333 x3333
  • 333.333.3333 x3333

(Don't let the example output below fool you - any format can be returned at random.)

FactoryHelper::PhoneNumber.phone_number #=> "397.693.1309"

FactoryHelper::PhoneNumber.cell_phone #=> "(186)285-7925"

# NOTE NOTE NOTE NOTE
# For the 'US only' methods below, first you must do the following:
FactoryHelper::Config.locale = 'en-US'

# US only
FactoryHelper::PhoneNumber.area_code #=> "201"

# US only
FactoryHelper::PhoneNumber.exchange_code #=> "208"

# Optional parameter: length=4
FactoryHelper::PhoneNumber.subscriber_number #=> "3873"

FactoryHelper::PhoneNumber.subscriber_number(2) #=> "39"

FactoryHelper::PhoneNumber.extension #=> "3764"

FactoryHelper::Time

# Random date between dates
FactoryHelper::Time.between(DateTime.now - 1, DateTime.now) #=> "2014-09-18 12:30:59 -0700"

# Random date between dates (within specified part of the day)
# You can install the active_support gem to facilitate time manipulation like 45.minutes + 2.hours
require "as-duration"
FactoryHelper::Time.between(2.days.ago, Time.now, :all) #=> "2014-09-19 07:03:30 -0700"
FactoryHelper::Time.between(2.days.ago, Time.now, :day) #=> "2014-09-18 16:28:13 -0700"
FactoryHelper::Time.between(2.days.ago, Time.now, :night) #=> "2014-09-20 19:39:38 -0700"
FactoryHelper::Time.between(2.days.ago, Time.now, :morning) #=> "2014-09-19 08:07:52 -0700"
FactoryHelper::Time.between(2.days.ago, Time.now, :afternoon) #=> "2014-09-18 12:10:34 -0700"
FactoryHelper::Time.between(2.days.ago, Time.now, :evening) #=> "2014-09-19 20:21:03 -0700"
FactoryHelper::Time.between(2.days.ago, Time.now, :midnight) #=> "2014-09-20 00:40:14 -0700"

# Random time in the future (up to maximum of N days)
FactoryHelper::Time.forward(23, :morning) # => "2014-09-26 06:54:47 -0700"

# Random time in the past (up to maximum of N days)
FactoryHelper::Time.backward(14, :evening) #=> "2014-09-17 19:56:33 -0700"

FactoryHelper::Timestamps

Generates random time between times up to the nanosecond level (that is 1_000_000_000th of a second)

#where `from` and `to` were set to:
from = ::Time.local(2012, 05, 05,  05,  05,  30, 222_222.222) # or Time.now - 1
to   = ::Time.local(2012, 05, 05,  05,  05,  33, 555_555.555) # or Time.now + 2

# Random time between times
FactoryHelper::Timestamps.between(from, to) #=> "2012-05-05 05:05:31 +0300"

# Random time up to N seconds in the future
FactoryHelper::Timestamps.forward(from, 60) #=> "2012-05-05 05:06:10 +0300"

# Random time up to N seconds in the past
FactoryHelper::Timestamps.backward(from, 60) #=> "2012-05-05 05:04:53 +0300"

FactoryHelper::Hacker

Are you having trouble writing tech-savvy dialogue for your latest screenplay? Worry not! Hollywood-grade technical talk is ready to fill out any form where you need to look smart.

# Full Phrase
FactoryHelper::Hacker.say_something_smart #=> "Try to compress the SQL interface, maybe it will program the back-end hard drive!"

# Short technical abbreviations
FactoryHelper::Hacker.abbreviation  #=> "RAM"

# Hacker centric adjectives
FactoryHelper::Hacker.adjective   #=> "open-source"

# Only the best hacker related nouns
FactoryHelper::Hacker.noun   #=> "bandwidth"

# Actions that hackers take
FactoryHelper::Hacker.verb  #=> "bypass"

# Verbs that end in -ing
FactoryHelper::Hacker.ingverb #=> "synthesizing"

FactoryHelper::App

FactoryHelper::App.name #=> "Treeflex"
FactoryHelper::App.version #=> "0.7.9"
FactoryHelper::App.author #=> "Daphne Swift"

FactoryHelper::SlackEmoji

Random Slack Emoji

# random emoji from any category
FactoryHelper::SlackEmoji.emoji #=> ":last_quarter_moon:"

# from people category
FactoryHelper::SlackEmoji.people #=> ":sleepy:"

# from nature category
FactoryHelper::SlackEmoji.nature #=> ":dog:"

# from food and drink category
FactoryHelper::SlackEmoji.food_and_drink #=> ":tangerine:"

# from activity category
FactoryHelper::SlackEmoji.activity #=> ":ice_hockey_stick_and_puck:"

# from travel and places category
FactoryHelper::SlackEmoji.travel_and_places #=> ":truck:"

# from objects category
FactoryHelper::SlackEmoji.objects #=> ":iphone:"

# from symbols category
FactoryHelper::SlackEmoji.symbols #=> ":cupid:"

# from flags category
FactoryHelper::SlackEmoji.flags #=> ":flag-pr:"

# from custom category
FactoryHelper::SlackEmoji.custom #=> ":glitch_crab:"

Customization

Since you may want to make addresses and other types of data look different depending on where in the world you are (US postal codes vs. UK postal codes, for example), FactoryHelper uses the I18n gem to store strings (like state names) and formats (US postal codes are NNNNN while UK postal codes are AAN NAA), allowing you to get different formats by switching locales. Just set FactoryHelper::Config.locale to the locale you want, and FactoryHelper will take care of the rest.

If your locale doesn't already exist, create it in the \lib\locales\ directory and you can then override or add elements to suit


en-au-ocker:
  factory_helper:
    name:
      # Existing factory_helper field, new data
      first_name: [Charlotte, Ava, Chloe, Emily]

      # New factory_helper fields
      ocker_first_name: [Bazza, Bluey, Davo, Johno, Shano, Shazza]
      region: [South East Queensland, Wide Bay Burnett, Margaret River, Port Pirie, Gippsland, Elizabeth, Barossa]

Contributing

See CONTRIBUTING.md.

Contact

Comments and feedback are welcome via GitHub Issues.

License

This code is free to use under the terms of the MIT license.