cryptozoologist 3.1.0 → 3.2.0

data/lib/cryptozoologist/dictionary.rb

@@ -30,8 +30,20 @@ module Cryptozoologist
       Dictionaries.addresses
     end
 
+    def states
+      Dictionaries.states
+    end
+
     def cities
       Dictionaries.cities
     end
+
+    def first_name
+      Dictionaries.first_name
+    end
+    
+    def last_name 
+      Dictionaries.last_name
+    end
   end
 end

data/lib/cryptozoologist/generator.rb

@@ -4,7 +4,7 @@ module Cryptozoologist
 
     # Generates sentence_count sentences, ranging in length from 10-16 words,
     # using the dictionaries from your config.
-    # 
+    #
     def lorem(sentence_count)
       sentences = []
       order = Cryptozoologist.configuration.order
@@ -29,7 +29,7 @@ module Cryptozoologist
     end
 
     # Generates a string using the dictionaries and delimiter from your config.
-    # 
+    #
     def random
       string = ""
       order = Cryptozoologist.configuration.order
@@ -39,7 +39,7 @@ module Cryptozoologist
         string += "#{compound_word}"
 
         unless library == Cryptozoologist.configuration.order.last
-          string += "#{Cryptozoologist.configuration.delimiter}" 
+          string += "#{Cryptozoologist.configuration.delimiter}"
         end
       end
 
@@ -56,6 +56,25 @@ module Cryptozoologist
       "#{number} #{street} #{Dictionary.addresses.sample}"
     end
 
+    # Generates a string for a U.S. state name which is partially replaced by
+    # alliterative words from other dictionaries (e.g. "Oregon" can become "Oregoose" or "Orabbit")
+    # Does not respect config exclusions
+    # Note: optional arguments desired_library is an String containing the single replacement word of your choice
+    # desired_state is a String of the specific state name of your choice
+    #{}`desired_replace_index` is an integer that allows you to specify whether the first
+    #or second word will be replaced, or in the case of a one-word state - which letter is replaced
+    def state(desired_state, desired_library, desired_replace_index)
+      libraries = desired_library || [:animals, :clothing, :colors]
+      state_name = desired_state || Dictionary.states.sample
+      has_two_words = state_name.index(" ")
+
+      if has_two_words
+        handle_two_word(state_name, libraries, desired_replace_index)
+      else
+        handle_one_word(state_name, libraries, desired_replace_index)
+      end
+    end
+
     def city
       exclude = Cryptozoologist.configuration.exclude
       cities_words = Cryptozoologist::Cities::Words.list
@@ -67,10 +86,56 @@ module Cryptozoologist
       "#{one_word_animals.sample.capitalize}#{city_labels.sample}"
     end
 
+    def full_name
+      first_name = Cryptozoologist::Dictionaries::People::FirstName.list.sample
+      last_name = Cryptozoologist::Dictionaries::People::LastName.list.sample
+
+      "#{first_name} #{last_name}#{one_word_animals.sample.capitalize}"
+    end
+
     private
 
+    #completely replaces one random word from the state with an alliterative word from libraries
+    def handle_two_word(state_name, libraries, desired_replace_index)
+      base_state_words = state_name.split(" ")
+      replace_index = desired_replace_index || rand(0..1)
+      base_state_words[replace_index] = get_alliteration(libraries, base_state_words[replace_index][0]).capitalize
+      return base_state_words.join(" ")
+    end
+
+    #selects a random key_letter from state_name, and finds an alliterative word from libraries for replacement
+    def handle_one_word(state_name, libraries, desired_replace_index)
+      key_letter_index = desired_replace_index || rand(0...state_name.length-1)
+      insert_word = get_alliteration(libraries, state_name[key_letter_index]).downcase
+
+      #if the randomly selected word from libraries has more letters than the substring from key_letter_index to state_name.length
+      #completely replace that substring
+      if insert_word.length > (state_name.length - key_letter_index) && key_letter_index > 0
+        final_word = state_name.slice(0...key_letter_index) + insert_word
+      #otherwise, replace only the key_letter with the entire random word from libraries
+      else
+        state_name[key_letter_index] = insert_word
+        final_word = state_name
+      end
+
+      final_word.capitalize
+    end
+
+    #finds a word from libraries that begins with key_letter
+    def get_alliteration(libraries, key_letter)
+      return libraries if libraries.is_a? String #this is the case for testing
+      replacement_options = Dictionary.send(libraries.sample).select { |word| word[0] == key_letter || word[0] == key_letter.downcase }
+
+      #default to :animals library if the randomly-selected library has no words that begin with key_letter
+      if replacement_options.empty?
+        replacement_options = Dictionary.send(:animals).select { |word| word[0] == key_letter || word[0] == key_letter.downcase }
+      end
+
+      replacement_options.sample
+    end
+
     def one_word_animals
       Dictionary.animals.select {|animal| animal.split(' ').count == 1}
     end
   end
-end
+end

data/lib/cryptozoologist/version.rb

@@ -1,3 +1,3 @@
 module Cryptozoologist
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/spec/cryptozoologist/dictionaries_spec.rb

@@ -14,9 +14,10 @@ describe Cryptozoologist::Dictionaries do
     }
   }
 
-  dictionaries = { 
+  dictionaries = {
     "clothing": Cryptozoologist::Dictionaries::Clothing,
-    "quantity": Cryptozoologist::Dictionaries::Quantity
+    "quantity": Cryptozoologist::Dictionaries::Quantity,
+    "states": Cryptozoologist::Dictionaries::States
   }
 
   context '#libraries' do
@@ -29,6 +30,11 @@ describe Cryptozoologist::Dictionaries do
       keys = Cryptozoologist::Dictionaries.library[:colors].keys
       expect(keys.length).to eq(2)
     end
+
+    it 'contains states' do
+      states = Cryptozoologist::Dictionaries.states
+      expect(states.length).to eq(50)
+    end
   end
 
   subdictionaries.each do |type, subdictionary|

data/spec/cryptozoologist/dictionary_spec.rb

@@ -5,7 +5,7 @@ describe Cryptozoologist::Dictionary do
     @dictionary = Cryptozoologist::Dictionary
   end
 
-  lists = [:animals, :colors, :clothing, :quantity]
+  lists = [:animals, :colors, :clothing, :quantity, :states, :first_name, :last_name]
 
   context 'word lists' do
     lists.each do |list|

data/spec/cryptozoologist/generator_spec.rb

@@ -77,6 +77,25 @@ describe Cryptozoologist do
     end
   end
 
+  context '#state' do
+
+    it 'handles a one word state' do
+      expect(Cryptozoologist.state("Washington", "Seal", 2)).to eq('Wasealhington')
+    end
+
+    it 'handles a two word state' do
+      expect(Cryptozoologist.state("North Dakota", "Necktie", 0)).to eq('Necktie Dakota')
+    end
+
+    it 'handles a replacement word longer than the remainder of the state name' do
+      expect(Cryptozoologist.state("California", "Iguana", 8)).to eq('Californiguana')
+    end
+
+    it 'handles a replacement word shorter than the remainder of the state name' do
+      expect(Cryptozoologist.state("Oregon", "Rat", 1)).to eq('Orategon')
+    end
+  end
+
   context '#city' do
     before do
       @city = Cryptozoologist.city
@@ -104,4 +123,30 @@ describe Cryptozoologist do
       expect(has_city).to be true
     end
   end
+
+  context '#full_name' do
+    before do
+      @person = Cryptozoologist.full_name
+    end
+
+    it 'should return datatype string' do
+      expect(@person).to be_instance_of(String)
+    end
+
+    it 'should contain an animal' do
+      has_animal = false
+      Cryptozoologist::Dictionary.animals.each do |animal|
+        has_animal = true if @person.downcase.include?(animal)
+      end
+      expect(has_animal).to be true
+    end
+
+    it 'should contain an adjective for the animal' do
+      has_adjective = false
+      Cryptozoologist::Dictionaries::People::LastName.list.each do |adjective|
+        has_adjective = true if @person.include?(adjective)
+      end
+      expect(has_adjective).to be true
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -10,4 +10,4 @@ RSpec.configure do |config|
   config.before(:all) do
     Cryptozoologist.reset
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptozoologist
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Liz Abinante
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,8 +105,11 @@ files:
 - lib/cryptozoologist/dictionaries/colors/paint.rb
 - lib/cryptozoologist/dictionaries/colors/web_safe.rb
 - lib/cryptozoologist/dictionaries/filler.rb
+- lib/cryptozoologist/dictionaries/people/first_name.rb
+- lib/cryptozoologist/dictionaries/people/last_name.rb
 - lib/cryptozoologist/dictionaries/punctuation.rb
 - lib/cryptozoologist/dictionaries/quantity.rb
+- lib/cryptozoologist/dictionaries/states.rb
 - lib/cryptozoologist/dictionary.rb
 - lib/cryptozoologist/errors.rb
 - lib/cryptozoologist/generator.rb
@@ -148,4 +151,3 @@ test_files:
 - spec/cryptozoologist/generator_spec.rb
 - spec/cryptozoologist_spec.rb
 - spec/spec_helper.rb
-has_rdoc: