File Coverage

blib/lib/Faker/Plugin/EnUs/AddressRegionName.pm
Criterion Covered Total %
statement 14 14 100.0
branch 2 2 100.0
condition n/a
subroutine 5 5 100.0
pod 1 1 100.0
total 22 22 100.0


line stmt bran cond sub pod time code
1             package Faker::Plugin::EnUs::AddressRegionName;
2              
3 2     2   22109 use 5.018;
  2         8  
4              
5 2     2   14 use strict;
  2         5  
  2         50  
6 2     2   9 use warnings;
  2         5  
  2         89  
7              
8 2     2   23 use Venus::Class 'base';
  2         5  
  2         34  
9              
10             base 'Faker::Plugin::EnUs';
11              
12             # VERSION
13              
14             our $VERSION = '1.17';
15              
16             # METHODS
17              
18             sub execute {
19 6     6 1 1142 my ($self, $data) = @_;
20              
21 6 100       31 my $method = $self->faker->random->bit ? 'address_state_name' : 'address_state_abbr';
22              
23 6         237 return $self->faker->$method;
24             }
25              
26             1;
27              
28              
29              
30             =head1 NAME
31              
32             Faker::Plugin::EnUs::AddressRegionName - Address Region Name
33              
34             =cut
35              
36             =head1 ABSTRACT
37              
38             Address Region Name for Faker
39              
40             =cut
41              
42             =head1 VERSION
43              
44             1.17
45              
46             =cut
47              
48             =head1 SYNOPSIS
49              
50             package main;
51              
52             use Faker::Plugin::EnUs::AddressRegionName;
53              
54             my $plugin = Faker::Plugin::EnUs::AddressRegionName->new;
55              
56             # bless(..., "Faker::Plugin::EnUs::AddressRegionName")
57              
58             =cut
59              
60             =head1 DESCRIPTION
61              
62             This package provides methods for generating fake data for address region name.
63              
64             =encoding utf8
65              
66             =cut
67              
68             =head1 INHERITS
69              
70             This package inherits behaviors from:
71              
72             L
73              
74             =cut
75              
76             =head1 METHODS
77              
78             This package provides the following methods:
79              
80             =cut
81              
82             =head2 execute
83              
84             execute(HashRef $data) (Str)
85              
86             The execute method returns a returns a random fake address region name.
87              
88             I>
89              
90             =over 4
91              
92             =item execute example 1
93              
94             package main;
95              
96             use Faker::Plugin::EnUs::AddressRegionName;
97              
98             my $plugin = Faker::Plugin::EnUs::AddressRegionName->new;
99              
100             # bless(..., "Faker::Plugin::EnUs::AddressRegionName")
101              
102             # my $result = $plugin->execute;
103              
104             # "Massachusetts";
105              
106             # my $result = $plugin->execute;
107              
108             # "MO";
109              
110             # my $result = $plugin->execute;
111              
112             # "NE";
113              
114             =back
115              
116             =cut
117              
118             =head2 new
119              
120             new(HashRef $data) (Plugin)
121              
122             The new method returns a new instance of the class.
123              
124             I>
125              
126             =over 4
127              
128             =item new example 1
129              
130             package main;
131              
132             use Faker::Plugin::EnUs::AddressRegionName;
133              
134             my $plugin = Faker::Plugin::EnUs::AddressRegionName->new;
135              
136             # bless(..., "Faker::Plugin::EnUs::AddressRegionName")
137              
138             =back
139              
140             =cut