From 4bc81aa0b38e5e3c11b0cb12d0a1958d537fa7c4 Mon Sep 17 00:00:00 2001 From: Ashish Rao Date: Sat, 5 Oct 2019 08:53:58 +0530 Subject: [PATCH 1/6] add Faker::Relationship YARD docs --- lib/faker/default/relationship.rb | 45 +++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/lib/faker/default/relationship.rb b/lib/faker/default/relationship.rb index 4134723876..cf87f68c28 100644 --- a/lib/faker/default/relationship.rb +++ b/lib/faker/default/relationship.rb @@ -5,6 +5,15 @@ class Relationship < Base flexible :relationship class << self + ## + # Produces a random family relationship. + # + # @return [String] + # + # @example + # Faker::Relationship.familial #=> "Grandfather" + # + # @faker.version next def familial(legacy_connection = NOT_GIVEN, connection: nil) warn_for_deprecated_arguments do |keywords| keywords << :connection if legacy_connection != NOT_GIVEN @@ -26,18 +35,54 @@ def familial(legacy_connection = NOT_GIVEN, connection: nil) fetch('relationship.familial.' + connection) end + ## + # Produces a random in-law relationship . + # + # @return [String] + # + # @example + # Faker::Relationship.in_law #=> "Brother-in-law" + # + # @faker.version next def in_law fetch('relationship.in_law') end + ## + # Produces a random spouse relationship. + # + # @return [String] + # + # @example + # Faker::Relationship.spouse #=> "Husband" + # + # @faker.version next def spouse fetch('relationship.spouse') end + ## + # Produces a random parent relationship. + # + # @return [String] + # + # @example + # Faker::Relationship.parent #=> "Father" + # + # @faker.version next def parent fetch('relationship.parent') end + ## + # Produces a random sibling relationship. + # + # @return [String] + # + # @example + # Faker::Relationship.sibling #=> "Sister" + # + # @faker.version next def sibling fetch('relationship.sibling') end From afe3f9022021711e943b1d0c665bc7a2ba08e54f Mon Sep 17 00:00:00 2001 From: Ashish Rao Date: Tue, 8 Oct 2019 13:08:33 +0530 Subject: [PATCH 2/6] Update lib/faker/default/relationship.rb add version 1.9.2 Co-Authored-By: Connor Shea --- lib/faker/default/relationship.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/faker/default/relationship.rb b/lib/faker/default/relationship.rb index cf87f68c28..72ffe86eca 100644 --- a/lib/faker/default/relationship.rb +++ b/lib/faker/default/relationship.rb @@ -13,7 +13,7 @@ class << self # @example # Faker::Relationship.familial #=> "Grandfather" # - # @faker.version next + # @faker.version 1.9.2 def familial(legacy_connection = NOT_GIVEN, connection: nil) warn_for_deprecated_arguments do |keywords| keywords << :connection if legacy_connection != NOT_GIVEN From 53f629f60390ed92bd4cb82fe1853c26a3a3e526 Mon Sep 17 00:00:00 2001 From: Ashish Rao Date: Sat, 5 Oct 2019 08:53:58 +0530 Subject: [PATCH 3/6] add Faker::Relationship YARD docs --- lib/faker/default/relationship.rb | 45 +++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/lib/faker/default/relationship.rb b/lib/faker/default/relationship.rb index 4134723876..cf87f68c28 100644 --- a/lib/faker/default/relationship.rb +++ b/lib/faker/default/relationship.rb @@ -5,6 +5,15 @@ class Relationship < Base flexible :relationship class << self + ## + # Produces a random family relationship. + # + # @return [String] + # + # @example + # Faker::Relationship.familial #=> "Grandfather" + # + # @faker.version next def familial(legacy_connection = NOT_GIVEN, connection: nil) warn_for_deprecated_arguments do |keywords| keywords << :connection if legacy_connection != NOT_GIVEN @@ -26,18 +35,54 @@ def familial(legacy_connection = NOT_GIVEN, connection: nil) fetch('relationship.familial.' + connection) end + ## + # Produces a random in-law relationship . + # + # @return [String] + # + # @example + # Faker::Relationship.in_law #=> "Brother-in-law" + # + # @faker.version next def in_law fetch('relationship.in_law') end + ## + # Produces a random spouse relationship. + # + # @return [String] + # + # @example + # Faker::Relationship.spouse #=> "Husband" + # + # @faker.version next def spouse fetch('relationship.spouse') end + ## + # Produces a random parent relationship. + # + # @return [String] + # + # @example + # Faker::Relationship.parent #=> "Father" + # + # @faker.version next def parent fetch('relationship.parent') end + ## + # Produces a random sibling relationship. + # + # @return [String] + # + # @example + # Faker::Relationship.sibling #=> "Sister" + # + # @faker.version next def sibling fetch('relationship.sibling') end From 9e3617d1e18b7ed0489da4e8eb7fe12f8b28f3e4 Mon Sep 17 00:00:00 2001 From: Ashish Rao Date: Tue, 8 Oct 2019 13:08:33 +0530 Subject: [PATCH 4/6] Update lib/faker/default/relationship.rb add version 1.9.2 Co-Authored-By: Connor Shea --- lib/faker/default/relationship.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/faker/default/relationship.rb b/lib/faker/default/relationship.rb index cf87f68c28..72ffe86eca 100644 --- a/lib/faker/default/relationship.rb +++ b/lib/faker/default/relationship.rb @@ -13,7 +13,7 @@ class << self # @example # Faker::Relationship.familial #=> "Grandfather" # - # @faker.version next + # @faker.version 1.9.2 def familial(legacy_connection = NOT_GIVEN, connection: nil) warn_for_deprecated_arguments do |keywords| keywords << :connection if legacy_connection != NOT_GIVEN From 5e4bf88d73882edeaa56d9653a4228304f6a0f1f Mon Sep 17 00:00:00 2001 From: Ashish Rao Date: Tue, 8 Oct 2019 13:10:50 +0530 Subject: [PATCH 5/6] add faker version as 1.9.2 --- lib/faker/default/relationship.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/faker/default/relationship.rb b/lib/faker/default/relationship.rb index 72ffe86eca..5ef72f6581 100644 --- a/lib/faker/default/relationship.rb +++ b/lib/faker/default/relationship.rb @@ -43,7 +43,7 @@ def familial(legacy_connection = NOT_GIVEN, connection: nil) # @example # Faker::Relationship.in_law #=> "Brother-in-law" # - # @faker.version next + # @faker.version 1.9.2 def in_law fetch('relationship.in_law') end @@ -56,7 +56,7 @@ def in_law # @example # Faker::Relationship.spouse #=> "Husband" # - # @faker.version next + # @faker.version 1.9.2 def spouse fetch('relationship.spouse') end @@ -69,7 +69,7 @@ def spouse # @example # Faker::Relationship.parent #=> "Father" # - # @faker.version next + # @faker.version 1.9.2 def parent fetch('relationship.parent') end @@ -82,7 +82,7 @@ def parent # @example # Faker::Relationship.sibling #=> "Sister" # - # @faker.version next + # @faker.version 1.9.2 def sibling fetch('relationship.sibling') end From a71c5c036a3a87dfc28d0f0b9fcbcfdf77cddbbf Mon Sep 17 00:00:00 2001 From: Ashish Rao Date: Tue, 8 Oct 2019 13:20:18 +0530 Subject: [PATCH 6/6] remove trailing whitespace --- lib/faker/default/relationship.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/faker/default/relationship.rb b/lib/faker/default/relationship.rb index 5ef72f6581..fadea00e78 100644 --- a/lib/faker/default/relationship.rb +++ b/lib/faker/default/relationship.rb @@ -36,7 +36,7 @@ def familial(legacy_connection = NOT_GIVEN, connection: nil) end ## - # Produces a random in-law relationship . + # Produces a random in-law relationship. # # @return [String] #