Add birds

doc/creature/bird.md

@@ -0,0 +1,39 @@
+# Faker::Creature::Bird
+
+```ruby
+# Random common family name of a bird
+Faker::Creature::Bird.common_family_name #=> "Owls"
+
+# Random taxonomic order from the class Aves (ie. those are birds)
+Faker::Creature::Bird.order #=> "Passeriformes" # Fun fact, 60% of birds are Passeriformes!
+
+# Random bird anatomy word
+Faker::Creature::Bird.anatomy #=> "rump"
+
+# Random bird anatomy word, in the past tense
+Faker::Creature::Bird.anatomy #=> "breasted"
+
+# Random bird geography word
+Faker::Creature::Bird.geo #=> "Eurasian"
+
+# Random bird color word
+Faker::Creature::Bird.color #=> "ferruginous"
+
+# Random bird adjective word
+Faker::Creature::Bird.adjective #=> "common"
+
+# Random emotional adjective NOT typically used in bird names
+Faker::Creature::Bird.emotional_adjective #=> "cantankerous"
+
+# Random silly adjective NOT used in bird names
+Faker::Creature::Bird.silly_adjective #=> "drunk"
+
+# Random common name for a bird
+Faker::Creature::Bird.common_name #=> 'wren'
+
+# Random plausible common name for a bird
+Faker::Creature::Bird.plausible_common_name #=> 'Hellinger's Wren'
+
+# Random implausible common name for a bird
+Faker::Creature::Bird.implausible_common_name #=> 'Hellinger's Cantankerous Chickadee'
+```

lib/faker/creature/bird.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module Faker
+  class Creature
+    class Bird < Base
+      flexible :bird
+
+      class << self
+        ##
+        # Produces a random common family name of a bird
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.common_family_name #=> "Owls"
+        #
+        # @faker.version 2.16.0
+        def common_family_name
+          fetch('creature.bird.common_family_name')
+        end
+
+        ##
+        # Produces a random common taxonomic order from the class Aves
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.order #=> "Passeriformes"
+        #
+        # @faker.version 2.16.0
+        def order
+          fetch('creature.bird.order')
+        end
+
+        ##
+        # Produces a random bird anatomy word
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.anatomy #=> "rump"
+        #
+        # @faker.version 2.16.0
+        def anatomy
+          fetch('creature.bird.anatomy')
+        end
+
+        ##
+        # Produces a random, past tensed bird anatomy word
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.anatomy #=> "breasted"
+        #
+        # @faker.version 2.16.0
+        def anatomy_past_tense
+          fetch('creature.bird.anatomy_past_tense')
+        end
+
+        ##
+        # Produces a random geographical word used in describing birds
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.geo #=> "Eurasian"
+        #
+        # @faker.version 2.16.0
+        def geo
+          fetch('creature.bird.geo')
+        end
+
+        ##
+        # Produces a random color word used in describing birds
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.color #=> "ferruginous"
+        #
+        # @faker.version 2.16.0
+        def color
+          fetch('creature.bird.colors')
+        end
+
+        ##
+        # Produces a random adjective used to described birds
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.adjective #=> 'common'
+        #
+        # @faker.version 2.16.0
+        def adjective
+          fetch('creature.bird.adjectives')
+        end
+
+        ##
+        # Produces a random emotional adjective NOT used to described birds
+        # ...but could be
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.emotional_adjective #=> 'cantankerous'
+        #
+        # @faker.version 2.16.0
+        def emotional_adjective
+          fetch('creature.bird.emotional_adjectives')
+        end
+
+        ##
+        # Produces a random adjective NOT used to described birds
+        # ...but probably shouldn't
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.silly_adjective #=> 'drunk'
+        #
+        # @faker.version 2.16.0
+        def silly_adjective
+          fetch('creature.bird.silly_adjectives')
+        end
+
+        ##
+        # Produces a random common name for a bird
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.common_name #=> 'wren'
+        #
+        # @faker.version 2.16.0
+        def common_name
+          fetch('creature.bird.common_names').downcase
+        end
+
+        ##
+        # Produces a random and plausible common name for a bird
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.plausible_common_name #=> 'Hellinger's Wren'
+        #
+        # @faker.version 2.16.0
+        def plausible_common_name
+          parse('creature.bird.plausible_common_names').capitalize
+        end
+
+        ##
+        # Produces a random and IMplausible common name for a bird
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.implausible_common_name #=> 'Hellinger's Cantankerous Chickadee'
+        #
+        # @faker.version 2.16.0
+        def implausible_common_name
+          parse('creature.bird.implausible_common_names').capitalize
+        end
+      end
+    end
+  end
+end