Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add YARD docs for Faker::Construction #1980

Merged
merged 5 commits into from May 17, 2020
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
54 changes: 54 additions & 0 deletions lib/faker/default/construction.rb
Expand Up @@ -2,26 +2,80 @@

module Faker
class Construction < Base
##
# Produces a random material.
#
# @return [String]
#
# @example
# Faker::Construction.material #=> "Wood"
#
# @faker.version 1.9.2
def self.material
fetch('construction.materials')
end

##
# Produces a random subcontract category.
danielTiringer marked this conversation as resolved.
Show resolved Hide resolved
#
# @return [String]
#
# @example
# Faker::Construction.subcontract_category #=> "Curb & Gutter"
danielTiringer marked this conversation as resolved.
Show resolved Hide resolved
#
# @faker.version 1.9.2
def self.heavy_equipment
fetch('construction.heavy_equipment')
end

##
# Produces a random heavy_equipment.
danielTiringer marked this conversation as resolved.
Show resolved Hide resolved
#
# @return [String]
#
# @example
# Faker::Construction.heavy_equipment #=> "Excavator"
danielTiringer marked this conversation as resolved.
Show resolved Hide resolved
#
# @faker.version 1.9.2
def self.trade
fetch('construction.trades')
end

##
# Produces a random trade.
danielTiringer marked this conversation as resolved.
Show resolved Hide resolved
#
# @return [String]
#
# @example
# Faker::Construction.trade #=> "Carpenter"
danielTiringer marked this conversation as resolved.
Show resolved Hide resolved
#
# @faker.version 1.9.2
def self.subcontract_category
fetch('construction.subcontract_categories')
end

##
# Produces a random standard_cost_code.
danielTiringer marked this conversation as resolved.
Show resolved Hide resolved
#
# @return [String]
#
# @example
# Faker::Construction.standard_cost_code #=> "1-000 - Purpose"
#
# @faker.version 1.9.2
def self.standard_cost_code
fetch('construction.standard_cost_codes')
end

##
# Produces a random role.
#
# @return [String]
#
# @example
# Faker::Construction.role #=> "Engineer"
#
# @faker.version 1.9.2
def self.role
fetch('construction.roles')
end
Expand Down