cryptozoologist 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e52d93f21bb6d449f2e6ad9190323f9770519393
-  data.tar.gz: 848a2751e0bb8611a24f712dedc6e5e8c4dd18b3
+  metadata.gz: 09791606d26cc558e12ccd78ba862963ef208a7d
+  data.tar.gz: 26a3f40019b4274cd0b6f3f1e92e4e68fda64672
 SHA512:
-  metadata.gz: e63efe1e7de416d9b40c48ed345e3bcf95660b2116ab7245fd035a417de8b53887e53d67a324cafb9b77dfd17e0bf553f6236933fa388ea63318d01a28a3d932
-  data.tar.gz: 145b991a02fc26aa9b94f44ec06e951018c334473ec5e478b3807cf4c86dd1470191d6fda633b0c0afcb4e3da0fe174d522d791493df14074b153f4b00dc0dec
+  metadata.gz: 5d969c28223dfa7d731d3b7307a880fe672217235a3a903565f161ed51a500530ebad246652d092ef5d52cc2d1d3a9f05abca99e1f438364e42ef1d3012a8f76
+  data.tar.gz: 83b718c59a20eda2ec7fb45472e981fe6b1e293bb7b46c92880a7970e3a3307d0a53282555db272ebadef1a95b1b8e68e012b13e950993f6ff2cf91512654b5d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.1.0
+
+- added a city method - generate an animal city with `Cryptozoologist.city`!
+
 ## 3.0.0
 
 **Important!!** Now requires Ruby 2.3.0 or higher (as of writing, Ruby 2.2 is in security maintenance mode, while 2.3 is in normal maintanance mode).

data/README.md

@@ -22,11 +22,12 @@ Or install it yourself as:
 
 ## Usage
 
-Cryptozoologist provides two main functions:
+Cryptozoologist provides four main functions:
 
 * `Cryptozoologist.random`: returns a string separated by a delimiter (_Note_: aliased as `Cryptozoologist.generate` for backwards compatibility with anything below version 3)
 * `Cryptozoologist.lorem(sentence_count)`: returns `sentence_count` number of sentences, separated by punctuation randomly selected from `["!", ".", "?"]`
 * `Cryptozoologist.street_address`: returns a string formatted to US street address standards (house number and street name) using the animal dictionaries (_Note_: ignores animal subdictionary exclusions)
+* `Cryptozoologist.city`: returns a string representing a city that uses the animal dictionaries
 
 Each method will respect your configuration settings where applicable.
 
@@ -45,6 +46,7 @@ The complete list of dictionaries includes:
 * `Cryptozoologist::Dictionary.filler` ("a", "the", etc)
 * `Cryptozoologist::Dictionary.punctuation`
 * `Cryptozoologist::Dictionary.addresses` ("Lane", "Street", etc - I don't know what this part of an address is called!)
+* `Cryptozoologist::Dictionary.cities`
 
 ### `Cryptozoologist.random`
 
@@ -91,7 +93,20 @@ Cryptozoologist.street_address # => 2558 Sea Dragon Court
 
 This only uses the `Animal` dictionaries and will *ignore your configuration to exclude subdictionaries*.
 
-## Configuration 
+### `Cryptozoologist.city`
+
+The `Cryptozoologist.city` method will return a string containing an animal city.
+
+Example:
+
+```ruby
+Cryptozoologist.city # => Goat Tower
+Cryptozoologist.city # => Raccoon City
+Cryptozoologist.city # => Mandrill Hills
+Cryptozoologist.city # => Lionville
+```
+
+## Configuration
 
 Configuration blocks take the following options:
 

data/lib/cryptozoologist.rb

@@ -43,7 +43,11 @@ module Cryptozoologist
     Generator.street_address
   end
 
-  protected 
+  def self.city
+    Generator.city
+  end
+
+  protected
   def self.subdictionaries
     Dictionaries.library
   end

data/lib/cryptozoologist/dictionaries.rb

@@ -27,6 +27,10 @@ module Cryptozoologist
         colors: {
           paint: Colors::Paint,
           web: Colors::WebSafe
+        },
+        cities: {
+          words: Cities::Words,
+          terminologies: Cities::Terminologies
         }
       }
     end
@@ -43,6 +47,10 @@ module Cryptozoologist
       Addresses.list
     end
 
+    def cities
+      create_list(:cities)
+    end
+
     private
     def create_list(key)
       list = []

data/lib/cryptozoologist/dictionaries/cities/teminologies.rb

@@ -0,0 +1,9 @@
+module Cryptozoologist
+  module Cities
+    module Terminologies
+      def self.list
+        ['burg', 'field', 'land', 'landia', 'port', 'side', 'town', 'ville']
+      end
+    end
+  end
+end

data/lib/cryptozoologist/dictionaries/cities/words.rb

@@ -0,0 +1,9 @@
+module Cryptozoologist
+  module Cities
+    module Words
+      def self.list
+        ['city', 'heights', 'hills', 'park', 'tower']
+      end
+    end
+  end
+end

data/lib/cryptozoologist/dictionary.rb

@@ -29,5 +29,9 @@ module Cryptozoologist
     def addresses
       Dictionaries.addresses
     end
+
+    def cities
+      Dictionaries.cities
+    end
   end
 end

data/lib/cryptozoologist/generator.rb

@@ -48,12 +48,29 @@ module Cryptozoologist
 
     # Generates a string for a street address with a number and street. Only
     # uses animal dictionaries and does not respect config exclusions.
-    # 
+    #
     def street_address
       number = rand(1..9000)
       street = Dictionary.animals.sample
       street = street.split(" ").map! {|word| word.capitalize! }.join(" ")
       "#{number} #{street} #{Dictionary.addresses.sample}"
     end
+
+    def city
+      exclude = Cryptozoologist.configuration.exclude
+      cities_words = Cryptozoologist::Cities::Words.list
+      cities_terminologies = Cryptozoologist::Cities::Terminologies.list
+      words_formatted = exclude.include?(:words) ? [] : cities_words.map { |word| " #{word.capitalize}" }
+      terminologies = exclude.include?(:terminologies) ? [] : cities_terminologies
+      city_labels =  words_formatted + terminologies
+
+      "#{one_word_animals.sample.capitalize}#{city_labels.sample}"
+    end
+
+    private
+
+    def one_word_animals
+      Dictionary.animals.select {|animal| animal.split(' ').count == 1}
+    end
   end
 end

data/lib/cryptozoologist/version.rb

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

data/spec/cryptozoologist/generator_spec.rb

@@ -13,7 +13,7 @@ describe Cryptozoologist do
 
     it 'generates the number of sentences requested' do
       sentence = Cryptozoologist.lorem(3)
-      punctuation = sentence.gsub!(/\w/, "").gsub!(" ", "")
+      punctuation = sentence.scan(/[.|?|!]/)
       expect(punctuation.length).to eq(3)
     end
   end
@@ -28,7 +28,11 @@ describe Cryptozoologist do
     end
 
     describe('with quantity') do
+      let(:test_quantity_library) { ["quantity"] }
+
       before do
+        allow(Cryptozoologist::Dictionary).to receive(:send).and_call_original
+        allow(Cryptozoologist::Dictionary).to receive(:send).with(:quantity).and_return(test_quantity_library)
         Cryptozoologist.configure do |config|
           config.include = [:quantity]
           config.delimiter = "_"
@@ -41,7 +45,6 @@ describe Cryptozoologist do
       end
 
       it 'only has one word from the quantity list' do
-        Cryptozoologist.random
         random = Cryptozoologist.random.split("_")
         matches = Cryptozoologist::Dictionaries::Quantity.list.select do |word|
           random.include?(word)
@@ -73,4 +76,32 @@ describe Cryptozoologist do
       expect(Cryptozoologist::Dictionary.addresses.include?(@street.last)).to be true
     end
   end
+
+  context '#city' do
+    before do
+      @city = Cryptozoologist.city
+    end
+
+    it 'should return a string' do
+      expect(@city).to be_instance_of(String)
+    end
+
+    it 'should include an animal' do
+      has_animal = false
+      Cryptozoologist::Dictionary.animals.each do |animal|
+        has_animal = @city.downcase.include?(animal) if @city.downcase.include?(animal)
+      end
+
+      expect(has_animal).to be true
+    end
+
+    it 'should include a city label' do
+      has_city = false
+      Cryptozoologist::Dictionary.cities.each do |city|
+        has_city = @city.downcase.include?(city) if @city.downcase.include?(city)
+      end
+
+      expect(has_city).to be true
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptozoologist
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Liz Abinante
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-03 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,8 @@ files:
 - lib/cryptozoologist/dictionaries/addresses.rb
 - lib/cryptozoologist/dictionaries/animals/common.rb
 - lib/cryptozoologist/dictionaries/animals/mythical.rb
+- lib/cryptozoologist/dictionaries/cities/teminologies.rb
+- lib/cryptozoologist/dictionaries/cities/words.rb
 - lib/cryptozoologist/dictionaries/clothing.rb
 - lib/cryptozoologist/dictionaries/colors/paint.rb
 - lib/cryptozoologist/dictionaries/colors/web_safe.rb
@@ -146,3 +148,4 @@ test_files:
 - spec/cryptozoologist/generator_spec.rb
 - spec/cryptozoologist_spec.rb
 - spec/spec_helper.rb
+has_rdoc: