cryptozoologist 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06601375b1385300471f4c3483d20b4b6879aa14
-  data.tar.gz: 129ff159258be07a66bd4bf7964e52171a60f871
+  metadata.gz: e52d93f21bb6d449f2e6ad9190323f9770519393
+  data.tar.gz: 848a2751e0bb8611a24f712dedc6e5e8c4dd18b3
 SHA512:
-  metadata.gz: 1cbbc6fb596e675a5d220c76813b745cfc37e23ac3cb3f3f5300adb5eee590a74ee37acd017834b03b03ae7abd870f8bfec0ec40daa7a934fc7da7f511421bfe
-  data.tar.gz: b7a67f991bd65d65559cb18e8659e9b1d307b1ad7d6586af4380e941bc88dbd02f0f7851970d49b8bddacc58d981c7ea847963b3717caf55c53a33d0414b6525
+  metadata.gz: e63efe1e7de416d9b40c48ed345e3bcf95660b2116ab7245fd035a417de8b53887e53d67a324cafb9b77dfd17e0bf553f6236933fa388ea63318d01a28a3d932
+  data.tar.gz: 145b991a02fc26aa9b94f44ec06e951018c334473ec5e478b3807cf4c86dd1470191d6fda633b0c0afcb4e3da0fe174d522d791493df14074b153f4b00dc0dec

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 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).
+
+**New features!**
+
+- now with lorem ipsum generation! `Cryptozoologist.lorem(sentence_count)`
+- added a street address method - you too can live at 1290 Sloth Circle! `Cryptozoologist.street_address`
+
+**API Changes**
+
+- configuration is now  _reset_ if you call the `configure` block again after having already called it
+- renamed `Cryptozoologist.generate` to `Cryptozoologist.random` (backwards compatible)
+
+**Bug fixes**
+
+- fix a bug where if you included `[:quantity]` words, you would get an extra quantity word for each time you called `generate` (lol this was very amusing)
+
+---
+
 ## 2.1.0
 
 - added test coverage

data/README.md

@@ -1,8 +1,8 @@
 # Cryptozoologist [![Build Status](https://travis-ci.org/feministy/cryptozoologist.svg?branch=master)](https://travis-ci.org/feministy/cryptozoologist)
 
-_Cryptozoologist is a fun little gem written as part of the [Gem guide](https://github.com/feministy/gem-guide) project._
+Cryptozoologist generates random strings from animal, clothing item, and color pairings, as well as lorem ipsum style sentences. 
 
-Cryptozoologist generates random strings from animal, clothing item, and color pairings. You could get something like "orange-clownfish-turtleneck" or "magenta-three-toed-sloth-shoe-horn". It's fun and silly, because why not?
+You could get something like "orange-clownfish-turtleneck" or "magenta-three-toed-sloth-shoe-horn". It's fun and silly, because why not? The gem can be configured to use a custom delimiter, exclude dictionaries, or add in speciality dictionaries.
 
 ## Installation
 
@@ -22,33 +22,75 @@ Or install it yourself as:
 
 ## Usage
 
-`Cryptozoologist.generate` method will return a string separated by `-` containing: a color, an animal, and an item of clothing.
+Cryptozoologist provides two 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)
+
+Each method will respect your configuration settings where applicable.
+
+See below for more detailed usage on each method.
+
+### Secret usage
+
+If you just want a word list, you can tap directly into the dictionaries. Each dictionary returns an array of strings, allowing you to use the Ruby enumerators that you want on your word list.
+
+The complete list of dictionaries includes:
+
+* `Cryptozoologist::Dictionary.animals`
+* `Cryptozoologist::Dictionary.clothing`
+* `Cryptozoologist::Dictionary.colors`
+* `Cryptozoologist::Dictionary.quantity`
+* `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.random`
+
+The `Cryptozoologist.random` method will return a string separated by `-` (or your custom delimiter) containing: a color, an animal, and an item of clothing.
+
+Example:
+
+```ruby
+Cryptozoologist.random # => 'steel-blue-tang-flak-jacket'
+Cryptozoologist.random # => 'blanched-almond-mandrill-headscarf'
+Cryptozoologist.random # => 'frozen-in-time-cockroach-bracelet'
+Cryptozoologist.random # => 'medium-sea-green-lobster-coat'
+Cryptozoologist.random # => 'blue-flying-squirrel-trench-coat'
+Cryptozoologist.random # => 'thistle-toucan-formal-wear'
+Cryptozoologist.random # => 'aquamarine-lemming-white-tie'
+Cryptozoologist.random # => 'tomato-cerberus-sweatshirt'
+Cryptozoologist.random # => 'forest-green-wasp-getup'
+```
+
+If your config includes the `Quantity` dictionary, it will be prepended to your string.
+
+### `Cryptozoologist.lorem(sentence_count)`
+
+`Cryptozoologist.lorem(sentence_count)` will return a string consisting of the number of sentences you request. It will use every dictionary available based on your config.
 
 Example:
 
 ```ruby
-Cryptozoologist.generate # => 'steel-blue-tang-flak-jacket'
-Cryptozoologist.generate # => 'blanched-almond-mandrill-headscarf'
-Cryptozoologist.generate # => 'frozen-in-time-cockroach-bracelet'
-Cryptozoologist.generate # => 'medium-sea-green-lobster-coat'
-Cryptozoologist.generate # => 'blue-flying-squirrel-trench-coat'
-Cryptozoologist.generate # => 'thistle-toucan-formal-wear'
-Cryptozoologist.generate # => 'aquamarine-lemming-white-tie'
-Cryptozoologist.generate # => 'tomato-cerberus-sweatshirt'
-Cryptozoologist.generate # => 'forest-green-wasp-getup'
+Cryptozoologist.lorem(3) # => 'Black rhinoceros and it hundreds at flamingo dream oodles acres gear it plum serval shrug phoenix blazer washed khaki! Phantom mist the gazillions hem alicorn light golden rod yellow leopard cat troop and galoshes a be. Are there stellers sea cow billions be plum indri dodger blue shift to t shirt cheetah tiara tons sky blue miles?'
+
+Cryptozoologist.lorem(1) # => 'And headscarf to potentially purple pygmy puff chocolate wide tights yak bundles the be?'
 ```
 
-### Generate a random color, animal, clothing item, or measure of quantity
+### `Cryptozoologist.street_address`
 
-These dictionaries will also follow your configuration settings (see below), _except for your delimiter_ (the delimiter is not used here).
+Haven't you always wanted a cool address like 12 Pygmy Puff Court? Me, too. 
 
 ```ruby
-Cryptozoologist::Dictionary.animals.sample # => 'sun bear'
-Cryptozoologist::Dictionary.clothing.sample # => 'fedora'
-Cryptozoologist::Dictionary.colors.sample # => 'light pink'
-Cryptozoologist::Dictionary.quantity.sample # => 'limitless'
+Cryptozoologist.street_address # => 2295 Red Panda Avenue
+Cryptozoologist.street_address # => 947 Valkyrie Way
+Cryptozoologist.street_address # => 2415 Goblin Street
+Cryptozoologist.street_address # => 2558 Sea Dragon Court
 ```
 
+This only uses the `Animal` dictionaries and will *ignore your configuration to exclude subdictionaries*.
+
 ## Configuration 
 
 Configuration blocks take the following options:
@@ -64,7 +106,7 @@ Configuration blocks take the following options:
 
 - `exclude` (array of symbols) allows you to exclude dictionary subtypes; defaults to no exclusions
 - `include` (array of symbols) allows you to include optional dictionaries; defaults to no inclusions
-- `order` (array of symbols) allows you to change the word order; defaults to animal-color-clothing
+- `order` (array of symbols) allows you to change the word order; defaults to `animal-color-clothing`
 - `delimiter` (string) allows you to specify a delimiter; defaults to `-`
 
 ### Configuration options
@@ -72,16 +114,18 @@ Configuration blocks take the following options:
 **Include (`config.include`, `[]`):**
 
 - if you include quantity, it will be added to the front of your generated string
-- `:quantity`
+- options: `:quantity`
 
 **Exclude (`config.exclude`, `[]`):**
 
+4 options are available for this, but you can only use 2 at a time (one from each category):
+
 - animals (1 of 2 allowed):
   - `:common`, `:mythical`
 - colors (1 of 2 allowed):
   - `:paint`, `:web`
 
-**Order (`config.order`, `[]`): **
+**Order (`config.order`, `[]`):**
 
 - **must provide all 3 keys** as an array in the order in which you want words to appear
 - `[:animals, :colors, :clothing]`
@@ -91,18 +135,18 @@ Configuration blocks take the following options:
 - defaults to `'-'`
 - any string is valid
 
-#### Example
+#### Example with all possible settings
 
 ```ruby
   Cryptozoologist.configure do |config|
-    config.exclude = [:common]
+    config.exclude = [:common, :paint]
     config.include = [:quantity]
     config.order = [:colors, :animals, :clothing]
     config.delimiter = '_'
   end
 
-  Cryptozoologist.generate # => 'masses_yellow_zombie_shrug'
-  Cryptozoologist.generate # => 'gazillions_polar_drift_goblin_umbrella'
-  Cryptozoologist.generate # => 'wide_orange_cynocephalus_helmet'
-  Cryptozoologist.generate # => 'some_light_pink_moke_fedora'
+  Cryptozoologist.random # => 'masses_yellow_zombie_shrug'
+  Cryptozoologist.random # => 'gazillions_purple_goblin_umbrella'
+  Cryptozoologist.random # => 'wide_orange_cynocephalus_helmet'
+  Cryptozoologist.random # => 'some_light_pink_moke_fedora'
 ```

data/lib/cryptozoologist.rb

@@ -7,6 +7,7 @@ Dir[dictionaries].each { |file| require file }
 
 require "cryptozoologist/dictionary"
 require "cryptozoologist/dictionaries"
+require "cryptozoologist/generator"
 
 module Cryptozoologist
   class << self
@@ -22,26 +23,24 @@ module Cryptozoologist
   end
 
   def self.configure
+    self.reset
     yield(configuration)
   end
 
-  def self.generate
-    string = ""
-    order = @configuration.order
-
-    order.unshift(:quantity) if @configuration.include_quantity?
+  def self.lorem(sentence_count=1)
+    Generator.lorem(sentence_count)
+  end
 
-    order.each do |library|
-      word = Dictionary.send(library).sample
-      compound_word = word.split(' ').join(@configuration.delimiter)
-      string += "#{compound_word}"
+  def self.random
+    Generator.random
+  end
 
-      unless library == @configuration.order.last
-        string += "#{@configuration.delimiter}" 
-      end
-    end
+  def self.generate
+    Generator.random
+  end
 
-    string
+  def self.street_address
+    Generator.street_address
   end
 
   protected 

data/lib/cryptozoologist/configuration.rb

@@ -14,7 +14,6 @@ module Cryptozoologist
       raise Errors::Configuration, "Order must contain 3 items" unless list.length == 3
       invalid_keys = list.select { |e| !valid_order.include?(e) }
       raise Errors::Configuration, "Invalid order setting provided: #{invalid_keys}" unless invalid_keys.empty?
-
       @order = list
     end
 
@@ -28,6 +27,8 @@ module Cryptozoologist
       raise Errors::Configuration, "Inclusions must be an array" unless inclusions.is_a?(Array)
 
       @include = inclusions.select { |e| valid_inclusions.include?(e) }
+      inclusions += @order
+      @order = inclusions
     end
 
     def exclude=(exclusions)

data/lib/cryptozoologist/dictionaries.rb

@@ -31,6 +31,18 @@ module Cryptozoologist
       }
     end
 
+    def filler
+      Filler.list
+    end
+
+    def punctuation
+      Punctuation.list
+    end
+
+    def addresses
+      Addresses.list
+    end
+
     private
     def create_list(key)
       list = []

data/lib/cryptozoologist/dictionaries/addresses.rb

@@ -0,0 +1,7 @@
+module Cryptozoologist
+  module Addresses
+    def self.list
+      ["Street", "Lane", "Avenue", "Boulevard", "Circle", "Court", "Way", "Drive"]
+    end
+  end
+end

data/lib/cryptozoologist/dictionaries/filler.rb

@@ -0,0 +1,9 @@
+module Cryptozoologist
+  module Dictionaries
+    module Filler
+      def self.list
+        ["the", "at", "it", "there", "are", "to", "and", "a", "be"]
+      end
+    end
+  end
+end

data/lib/cryptozoologist/dictionaries/punctuation.rb

@@ -0,0 +1,9 @@
+module Cryptozoologist
+  module Dictionaries
+    module Punctuation
+      def self.list
+        ["!", ".", "?"]
+      end
+    end
+  end
+end

data/lib/cryptozoologist/dictionary.rb

@@ -17,5 +17,17 @@ module Cryptozoologist
     def quantity
       Dictionaries.quantity
     end
+
+    def filler
+      Dictionaries.filler
+    end
+
+    def punctuation
+      Dictionaries.punctuation
+    end
+
+    def addresses
+      Dictionaries.addresses
+    end
   end
 end

data/lib/cryptozoologist/generator.rb

@@ -0,0 +1,59 @@
+module Cryptozoologist
+  module Generator
+    extend self
+
+    # 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
+      sentence_count.times do
+        words = []
+        length = rand(9..16)
+        per_dictionary = length / order.length
+
+        order.each do |library|
+          words += Dictionary.send(library).sample(per_dictionary)
+          words << Dictionary.filler.sample
+        end
+
+        words.shuffle!
+        sentence = words.join(" ")
+        sentence.capitalize!
+        sentence << Dictionary.punctuation.sample
+        sentences << sentence
+      end
+
+      sentences.join(" ")
+    end
+
+    # Generates a string using the dictionaries and delimiter from your config.
+    # 
+    def random
+      string = ""
+      order = Cryptozoologist.configuration.order
+      order.each do |library|
+        word = Dictionary.send(library).sample
+        compound_word = word.split(' ').join(Cryptozoologist.configuration.delimiter)
+        string += "#{compound_word}"
+
+        unless library == Cryptozoologist.configuration.order.last
+          string += "#{Cryptozoologist.configuration.delimiter}" 
+        end
+      end
+
+      string
+    end
+
+    # 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
+  end
+end

data/lib/cryptozoologist/version.rb

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

data/spec/cryptozoologist/configuration_spec.rb

@@ -12,6 +12,24 @@ describe Cryptozoologist::Configuration do
     end
   end
 
+  context 'configuration collision' do
+    it 'does not happen' do
+      Cryptozoologist.configure do |config|
+        config.delimiter = "_"
+      end
+
+      expect(Cryptozoologist.configuration.delimiter).to eq("_")
+      expect(Cryptozoologist.configuration.include_quantity?).to be false
+
+      Cryptozoologist.configure do |config|
+        config.include = [:quantity]
+      end      
+
+      expect(Cryptozoologist.configuration.delimiter).to_not eq("_")
+      expect(Cryptozoologist.configuration.include_quantity?).to be true
+    end
+  end
+
   context 'exclusions' do
     it 'filters out invalid exclusions' do
       Cryptozoologist.configure do |config|
@@ -66,7 +84,7 @@ describe Cryptozoologist::Configuration do
 
   context '#delimiter' do
     it 'defaults to "-"' do
-      expect(Cryptozoologist.generate.match('-')).to be_instance_of(MatchData)
+      expect(Cryptozoologist.random.match('-')).to be_instance_of(MatchData)
     end
 
     it 'requires a string' do
@@ -82,7 +100,7 @@ describe Cryptozoologist::Configuration do
         config.delimiter ='$'
       end
 
-      expect(Cryptozoologist.generate.match('$')).to be_instance_of(MatchData)
+      expect(Cryptozoologist.random.match('$')).to be_instance_of(MatchData)
     end
   end
 

data/spec/cryptozoologist/generator_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Cryptozoologist do
+  context '#lorem' do
+    it 'returns a string' do
+      expect(Cryptozoologist.lorem(1)).to be_instance_of(String)
+    end
+
+    it 'defaults to one sentence if an argument is not provided' do
+      expect(Cryptozoologist.lorem).to be_instance_of(String)
+      expect(Cryptozoologist::Dictionary.punctuation.include?(Cryptozoologist.lorem[-1])).to be true
+    end
+
+    it 'generates the number of sentences requested' do
+      sentence = Cryptozoologist.lorem(3)
+      punctuation = sentence.gsub!(/\w/, "").gsub!(" ", "")
+      expect(punctuation.length).to eq(3)
+    end
+  end
+
+  context '#random' do
+    it 'returns a string' do
+      expect(Cryptozoologist.random).to be_instance_of(String)
+    end
+
+    it 'returns a string with the delimiter' do
+      expect(Cryptozoologist.random.match('-')).to be_instance_of(MatchData)
+    end
+
+    describe('with quantity') do
+      before do
+        Cryptozoologist.configure do |config|
+          config.include = [:quantity]
+          config.delimiter = "_"
+        end
+      end
+
+      it 'returns a string with quantity' do
+        random = Cryptozoologist.random.split("_")
+        expect(Cryptozoologist::Dictionaries::Quantity.list.include?(random.first)).to be true
+      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)
+        end
+        expect(matches.length).to eq(1)
+      end
+    end
+  end
+
+  context '#street_address' do
+    before do
+      @street = Cryptozoologist.street_address.split(" ")
+    end
+
+    it 'includes a number' do
+      expect(@street.first.to_i).to be > 0
+      expect(@street.first.to_i).to be < 9001
+    end
+
+    it 'includes an animal' do
+      street = @street
+      street.pop
+      street.shift
+      street = street.join(" ").downcase
+      expect(Cryptozoologist::Dictionary.animals.include?(street)).to be true
+    end
+
+    it 'includes an address label' do
+      expect(Cryptozoologist::Dictionary.addresses.include?(@street.last)).to be true
+    end
+  end
+end

data/spec/cryptozoologist_spec.rb

@@ -14,14 +14,4 @@ describe Cryptozoologist do
     Cryptozoologist.reset
     expect(Cryptozoologist.configuration.exclude).to eq([])
   end
-
-  context '#generate' do
-    it 'returns a string' do
-      expect(Cryptozoologist.generate).to be_instance_of(String)
-    end
-
-    it 'returns a string with the delimiter' do
-      expect(Cryptozoologist.generate.match('-')).to be_instance_of(MatchData)
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptozoologist
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Liz Abinante
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,8 +81,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.4
 description: Cryptozoologist generates random strings from animal, clothing item,
-  and color pairings. You could get something like 'orange-clownfish-turtleneck' or
-  'magenta-three-toed-sloth-shoe-horn'. It's fun and silly, because why not?
+  and color pairings. It's fun and silly, because who doesn't want an orange sloth
+  turtleneck?
 email:
 - me@liz.codes
 executables: []
@@ -96,18 +96,23 @@ files:
 - lib/cryptozoologist.rb
 - lib/cryptozoologist/configuration.rb
 - lib/cryptozoologist/dictionaries.rb
+- lib/cryptozoologist/dictionaries/addresses.rb
 - lib/cryptozoologist/dictionaries/animals/common.rb
 - lib/cryptozoologist/dictionaries/animals/mythical.rb
 - lib/cryptozoologist/dictionaries/clothing.rb
 - lib/cryptozoologist/dictionaries/colors/paint.rb
 - lib/cryptozoologist/dictionaries/colors/web_safe.rb
+- lib/cryptozoologist/dictionaries/filler.rb
+- lib/cryptozoologist/dictionaries/punctuation.rb
 - lib/cryptozoologist/dictionaries/quantity.rb
 - lib/cryptozoologist/dictionary.rb
 - lib/cryptozoologist/errors.rb
+- lib/cryptozoologist/generator.rb
 - lib/cryptozoologist/version.rb
 - spec/cryptozoologist/configuration_spec.rb
 - spec/cryptozoologist/dictionaries_spec.rb
 - spec/cryptozoologist/dictionary_spec.rb
+- spec/cryptozoologist/generator_spec.rb
 - spec/cryptozoologist_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/feministy/cryptozoologist
@@ -122,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -138,5 +143,6 @@ test_files:
 - spec/cryptozoologist/configuration_spec.rb
 - spec/cryptozoologist/dictionaries_spec.rb
 - spec/cryptozoologist/dictionary_spec.rb
+- spec/cryptozoologist/generator_spec.rb
 - spec/cryptozoologist_spec.rb
 - spec/spec_helper.rb