cryptozoologist 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd5e660c2e2933d44cc36660e28cbf7b020e22a7
-  data.tar.gz: a14810a76aa03107faacd3d8b4802efacb6bd1a7
+  metadata.gz: 9411dfc9037961beb292b84b3a010911a4df12d2
+  data.tar.gz: 7516103b3806e76b01be5ec74f482939aab0e06d
 SHA512:
-  metadata.gz: 00d2393f1aa24946ccbe019305e6d2b477252cb7c31b1df764caf708e825a568adc9f3788c1b574b9e78a9a19fbe004b9cc211080d5df95f987534430ef70333
-  data.tar.gz: fff4b36b58fd513a2db9f8e8089ec7f1d401db9fc293f1275ff718047383ca65e187577633e1281d3ac0cfad9008693f4190f92468fd8bc1ecad0c1d481d2620
+  metadata.gz: 0061af7c09ba38a8f4ffdfa25ba5a196f6dc3ff0600b6b6a179507cf338bf3fc078e72a6b25b1175dc83f71ec43198c6b699a5a52b4295975bfb987823221a50
+  data.tar.gz: 7b56a87a18854f844b9df9f51dee3ed4abb40123e6642e0374532df171afa37fa5412cdf6ef93a11c4365a9e18120378c1d760fb7f808859d28a9a748687827f

data/README.md

@@ -2,11 +2,7 @@
 
 _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. You could get something like "orange-clownfish-turtleneck" or "magenta-three-toed-sloth-shoe-horn". It's fun and silly - it's also very simple, which is why it is used as an example for the Gem guide project.
-
-This gem is still in active devemopment; complete documentation _will be added_ as the gem (and the Gem guide) progress!
-
-_(No, really, it will be added: it's part of the guide!)_
+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?
 
 ## Installation
 
@@ -26,68 +22,87 @@ Or install it yourself as:
 
 ## Usage
 
-Right now, this gem doesn't do much of anything except over architect a series of word lists.
+`Cryptozoologist.generate` method will return a string separated by `-` containing: a color, an animal, and an item of clothing.
 
-**Available word lists**
+Example:
 
-- colors
-- animals
-- clothing
-- quantity
+```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'
+```
 
-**Configuration options**
+### Generate a random color, animal, clothing item, or measure of quantity
 
-Exclude:
+These dictionaries will also follow your configuration settings (see below), _except for your delimeter_ (the delimeter is not used here).
 
-- animals:
-  - `:common`, `:mythical`
-- colors:
-    - `:paint`, `:web`
+```ruby
+Cryptozoologist::Dictionary.animals.sample # => 'sun bear'
+Cryptozoologist::Dictionary.clothing.sample # => 'fedora'
+Cryptozoologist::Dictionary.colors.sample # => 'light pink'
+Cryptozoologist::Dictionary.quantity.sample # => 'limitless'
+```
 
-*Note:* you can only exclude one of each or you won't have any words in your list!
+## Configuration 
 
-**Example**
+Configuration blocks take the following options:
 
 ```ruby
   Cryptozoologist.configure do |config|
-    config.exclude = [:common]
+    config.exclude = []
+    config.include = []
+    config.order = []
+    config.delimeter = ''
   end
-
-  dictionary = Cryptozoologist::Dictionary.new
-  animals = dictionary.animals
-  animals.sample # => "crumple horned snorkack"
 ```
 
-**Get a random animal**
+- `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
+- `delimeter` (string) allows you to specify a delimeter; defaults to `-`
 
-```ruby
-  dictionary = Cryptozoologist::Dictionary.new
-  animals = dictionary.animals
-  animals.sample # => "sun bear"
-```
+### Configuration options
 
-**Get a random color**
+**Include (`config.include`, `[]`):**
 
-```ruby
-  dictionary = Cryptozoologist::Dictionary.new
-  colors = dictionary.colors
-  colors.sample # => "pink"
-```
+- if you include quantity, it will be added to the front of your generated string
+- `:quantity`
 
-**Get a random measure of quantity**
+**Exclude (`config.exclude`, `[]`):**
 
-```ruby
-  dictionary = Cryptozoologist::Dictionary.new
-  quantity = dictionary.quantity
-  quantity.sample # => "limitless"
-```
+- animals (1 of 2 allowed):
+  - `:common`, `:mythical`
+- colors (1 of 2 allowed):
+  - `:paint`, `:web`
 
-**Get a random item of clothing**
+**Order (`config.order`, `[]`): **
 
-```ruby
-  dictionary = Cryptozoologist::Dictionary.new
-  clothing = dictionary.clothing
-  clothing.sample # => "suspenders"
-```
+- **must provide all 3 keys** as an array in the order in which you want words to appear
+- `[:animals, :colors, :clothing]`
+
+**Delimeter (`config.delimeter`, `''`):**
+
+- defaults to `'-'`
+- any string is valid
 
+#### Example
 
+```ruby
+  Cryptozoologist.configure do |config|
+    config.exclude = [:common]
+    config.include = [:quantity]
+    config.order = [:colors, :animals, :clothing]
+    config.delimeter = '_'
+  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'
+```

data/lib/cryptozoologist.rb

@@ -25,7 +25,26 @@ module Cryptozoologist
     yield(configuration)
   end
 
-  protected
+  def self.generate
+    string = ""
+    order = @configuration.order
+
+    order.unshift(:quantity) if @configuration.include_quantity?
+
+    order.each do |library|
+      word = Dictionary.send(library).sample
+      compound_word = word.split(' ').join(@configuration.delimeter)
+      string += "#{compound_word}"
+
+      unless library == @configuration.order.last
+        string += "#{@configuration.delimeter}" 
+      end
+    end
+
+    string
+  end
+
+  protected 
   def self.subdictionaries
     Dictionaries.library
   end

data/lib/cryptozoologist/configuration.rb

@@ -1,9 +1,33 @@
 module Cryptozoologist
   class Configuration
-    attr_reader :exclude
+    attr_reader :exclude, :delimeter, :order, :include
 
     def initialize
       @exclude = []
+      @delimeter = "-"
+      @order = [:colors, :animals, :clothing]
+      @include = []
+    end
+
+    def order=(list)
+      raise Errors::Configuration, "Order must be an array" unless list.is_a?(Array)
+      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
+
+    def delimeter=(string)
+      raise Errors::Configuration, "Delimeter must be a a string" unless string.is_a?(String)
+
+      @delimeter = string
+    end
+
+    def include=(inclusions)
+      raise Errors::Configuration, "Inclusions must be an array" unless inclusions.is_a?(Array)
+
+      @include = inclusions.select { |e| valid_inclusions.include?(e) }
     end
 
     def exclude=(exclusions)
@@ -12,11 +36,23 @@ module Cryptozoologist
       @exclude = exclusions.select { |e| valid_exclusions.include?(e) }
     end
 
+    def include_quantity?
+      @include.include?(:quantity)
+    end
+
     private
+    def valid_order
+      [:animals, :colors, :clothing]
+    end
+
     def valid_exclusions
       keys = []
       Cryptozoologist.subdictionaries.each { |key, value| keys += value.keys }
       keys
     end
+
+    def valid_inclusions
+      [:quantity]
+    end
   end
 end

data/lib/cryptozoologist/dictionary.rb

@@ -1,20 +1,13 @@
 module Cryptozoologist
-  class Dictionary
-    def initialize
-      @animals = []
-      @colors = []
-    end
+  module Dictionary
+    extend self
 
     def animals
-      @animals if @animals.any?
-      @animals = Dictionaries.animals
-      @animals
+      Dictionaries.animals
     end
 
     def colors
-      @colors if @colors.any?
-      @colors = Dictionaries.colors
-      @colors
+      Dictionaries.colors
     end
 
     def clothing

data/lib/cryptozoologist/version.rb

@@ -1,3 +1,3 @@
 module Cryptozoologist
-  VERSION = "1.3.1"
+  VERSION = "2.0.0"
 end

data/spec/cryptozoologist/configuration_spec.rb

@@ -1,6 +1,10 @@
 require_relative '../spec_helper'
 
 describe Cryptozoologist::Configuration do
+  before do
+    Cryptozoologist.reset
+  end
+
   context 'without configuration block' do
     it 'returns an empty Configuration' do
       expect(Cryptozoologist.configuration).to be_instance_of(Cryptozoologist::Configuration)
@@ -25,4 +29,97 @@ describe Cryptozoologist::Configuration do
       }.to raise_error(Cryptozoologist::Errors::Configuration)
     end
   end
+
+  context 'inclusions' do
+    it 'filters out invalid inclusions' do
+      Cryptozoologist.configure do |config|
+        config.include = [:tacos]
+      end
+
+      expect(Cryptozoologist.configuration.include).to eq([])
+    end
+
+    it 'requires an array' do
+      expect {
+        Cryptozoologist.configure do |config|
+          config.include = 1
+        end
+      }.to raise_error(Cryptozoologist::Errors::Configuration)
+    end
+
+    it 'sets valid inclusions' do
+      Cryptozoologist.configure do |config|
+        config.include = [:quantity]
+      end
+
+      expect(Cryptozoologist.configuration.include).to eq([:quantity])
+    end
+  end
+
+  context '#delimeter' do
+    it 'defaults to "-"' do
+      expect(Cryptozoologist.generate.match('-')).to be_instance_of(MatchData)
+    end
+
+    it 'requires a string' do
+      expect {
+        Cryptozoologist.configure do |config|
+          config.delimeter = 1
+        end
+      }.to raise_error(Cryptozoologist::Errors::Configuration)
+    end
+
+    it 'changes the delimeter when provided' do
+      Cryptozoologist.configure do |config|
+        config.delimeter ='$'
+      end
+
+      expect(Cryptozoologist.generate.match('$')).to be_instance_of(MatchData)
+    end
+  end
+
+  context '#order' do
+    it 'defaults to colors, animals, clothing' do
+      expect(Cryptozoologist.configuration.order).to eq([:colors, :animals, :clothing])
+    end
+
+    it 'rejects everything if anything invalid is passed' do
+      expect {
+        Cryptozoologist.configure do |config|
+          config.order = [:colors, :animals, :tacos]
+        end
+      }.to raise_error(Cryptozoologist::Errors::Configuration)
+    end
+
+    it 'rejects everything if fewer than 3 keys are passed' do
+      expect {
+        Cryptozoologist.configure do |config|
+          config.order = [:colors, :animals]
+        end
+      }.to raise_error(Cryptozoologist::Errors::Configuration)
+    end
+
+    it 'rejects everything if more than 3 keys are passed' do
+      expect {
+        Cryptozoologist.configure do |config|
+          config.order = [:colors, :animals, :clothing, :tacos]
+        end
+      }.to raise_error(Cryptozoologist::Errors::Configuration)
+    end
+
+    it 'requires an array' do
+      expect {
+        Cryptozoologist.configure do |config|
+          config.order = 1
+        end
+      }.to raise_error(Cryptozoologist::Errors::Configuration)
+    end
+
+    it 'changes the order of keys' do
+      Cryptozoologist.configure do |config|
+        config.order = [:clothing, :colors, :animals]
+      end
+      expect(Cryptozoologist.configuration.order).to eq([:clothing, :colors, :animals])
+    end
+  end
 end

data/spec/cryptozoologist/dictionary_spec.rb

@@ -2,7 +2,7 @@ require_relative '../spec_helper'
 
 describe Cryptozoologist::Dictionary do
   before do
-    @dictionary = Cryptozoologist::Dictionary.new
+    @dictionary = Cryptozoologist::Dictionary
   end
 
   lists = [:animals, :colors, :clothing, :quantity]

data/spec/cryptozoologist_spec.rb

@@ -14,4 +14,14 @@ 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 delimeter' 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: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Liz Abinante
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -82,8 +82,7 @@ dependencies:
         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 - it's also very simple,
-  which is why it is used as an example for the Gem guide project.
+  'magenta-three-toed-sloth-shoe-horn'. It's fun and silly, because why not?
 email:
 - me@liz.codes
 executables: []