token_phrase 1.0.0 → 1.0.2

data/README.md

@@ -1,6 +1,10 @@
 # TokenPhrase
 
-TODO: Write a gem description
+TokenPhrase is a simple gem that generates unique phrases for you to use in your app as tokens.
+
+"Why?" you may be asking. Why not? Token phrases give your app a little personality and make support a lot easier.
+
+TokenPhrase was built for [Sellmer](http://justsellstuff.com), a simple yet powerful way to sell your digital goods.
 
 ## Installation
 
@@ -16,9 +20,94 @@ Or install it yourself as:
 
     $ gem install token_phrase
 
-## Usage
+## TokenPhrase.generate(separator = nil, dictionaries = {})
+
+### Defaults
+By default, TokenPhrase uses the included dictionaries and separates everything with a hyphen (-):
+
+```ruby
+TokenPhrase.generate
+=> "ultimate-blue-glossy-lamp"
+
+5.times { p TokenPhrase.generate }
+"energetic-white-checked-book"
+"genetically-modified-red-argyle-lego-set"
+"strong-yellow-wavy-machine"
+"sugarfilled-blue-glossy-jacket"
+"sour-ultraviolet-plaid-sand"
+```
+
+### Separators
+If you would like a different separator, just pass a string as an argument: 
+
+```ruby
+TokenPhrase.generate('$')
+=> "exciting$taupe$glossy$lake"
+
+TokenPhrase.generate('!!!eric!!!')
+=> "splendid!!!eric!!!golden!!!eric!!!glossy!!!eric!!!flounder"
+```
+
+### Dictionaries
+TokenPhrase combines words from four different dictionaries:
+
+* :adjectives
+* :colors
+* :patterns
+* :nouns
+
+If you want to replace the dictionary, just pass a hash with an array as an argument:
+
+```ruby
+TokenPhrase.generate :adjectives => %w(glowing)
+=> "glowing-tan-striped-sand"
+
+5.times { p TokenPhrase.generate :nouns => %w(Mercury Venus Earth Mars Jupiter Saturn Uranus Neptune Pluto) }
+"home-made-lime-plaid-Pluto"
+"bluetooth-lime-wavy-Jupiter"
+"sugarfilled-tan-pinstriped-Mars"
+"magnetic-pink-polka-dotted-Saturn"
+"grandmas-white-plaid-Pluto"
+```
+You can pass multiple dictionaries: 
+
+```ruby
+5.times { p TokenPhrase.generate :colors => %w(black white), :nouns => %w(cat dog) }
+"spectacular-white-argyle-dog"
+"wind-up-white-plaid-cat"
+"glazed-white-polka-dotted-cat"
+"bodacious-white-checked-cat"
+"genetically-modified-white-pinstriped-dog"
+```
+
+And you can, of course pass a separator before the dictionaries:
+
+```ruby
+5.times { p TokenPhrase.generate '^^^', :patterns => %w(striped), :adjectives =>%w(great awesome) }
+"great^^^brown^^^striped^^^door"
+"great^^^silver^^^striped^^^carpenter"
+"great^^^lime^^^striped^^^crane"
+"great^^^taupe^^^striped^^^envelope"
+"great^^^pink^^^striped^^^sand"
+```
+
+## Dictionary Methods
+
+If you like the existing dictionaries, but want to add your own words, you can use get an array of each dictionary:
+
+* TokenPhrase.adjectives(more_adjectives = nil)
+* TokenPhrase.colors(more_colors = nil)
+* TokenPhrase.patterns(more_patterns = nil)
+* TokenPhrase.nouns(more_nouns = nil)
+
+Each of these dictionary methods accept an array as an argument that will merge the existing dictionary with your array
+
+```ruby
+your_patterns = TokenPhrase.patterns %w(magic-eye)
+TokenPhrase.generate :patterns => your_patterns
+=> "awesome-mauve-magic-eye-giraffe"
+```
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/token_phrase/version.rb

@@ -1,3 +1,3 @@
 module TokenPhrase
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

data/lib/token_phrase.rb

@@ -6,32 +6,32 @@ module TokenPhrase
   Patterns = %w(striped checked spotted polka-dotted plaid wavy houndstooth argyle glossy matte pinstriped)
   Nouns = %w(floutist carpenter jacket president address machine computer mug lamp phone wall bicycle river lake fountain building book hat pants shirt cape soup gloves pen suit photograph sand profit energy fork compact-disk floppy-disk chandelier door window laboratory people tapir wolverine wolf spider wolf-spider spider-wolf banana-slug giraffe deer-mouse capybara dingo dragon cardinal owl octopus elk moose weasel elephant rhino iguana bullfrog greyhound stickbug ladybug ant rat coyote chimpanzee housecat barracuda raven crane fox panda racoon nessie whale dolphin shark viper frog toad flounder skunk wookie dishwasher bat space-heater bobble-head lego-set pinboard flag tv video-game envelope headphones mousepad jukebox)
   
-  def self.adjectives
-    TokenPhrase::Adjectives
+  def self.adjectives(more_adjectives = nil)
+    more_adjectives.nil? ? TokenPhrase::Adjectives : TokenPhrase::Adjectives | more_adjectives
   end
   
-  def self.colors
-    TokenPhrase::Colors
+  def self.colors(more_colors = nil)
+    more_colors.nil? ? TokenPhrase::Colors : TokenPhrase::Colors | more_colors
   end
   
-  def self.patterns
-    TokenPhrase::Patterns
+  def self.patterns(more_patterns = nil)
+    more_patterns.nil? ? TokenPhrase::Patterns : TokenPhrase::Patterns | more_patterns
   end
   
-  def self.nouns
-    TokenPhrase::Nouns
+  def self.nouns(more_nouns = nil)
+    more_nouns.nil? ? TokenPhrase::Nouns : TokenPhrase::Nouns | more_nouns
   end
   
-  def self.generate(separator = nil, parts = {})
+  def self.generate(separator = nil, dictionaries = {})
     if separator.is_a?(Hash)
-      parts = separator
+      dictionaries = separator
       separator = nil
     end
-    parts[:adjectives] ||= TokenPhrase::Adjectives
-    parts[:colors] ||= TokenPhrase::Colors
-    parts[:patterns] ||= TokenPhrase::Patterns
-    parts[:nouns] ||= TokenPhrase::Nouns
-    phrase = [parts[:adjectives].sample, parts[:colors].sample, parts[:patterns].sample, parts[:nouns].sample].join('-')
+    dictionaries[:adjectives] ||= TokenPhrase::Adjectives
+    dictionaries[:colors] ||= TokenPhrase::Colors
+    dictionaries[:patterns] ||= TokenPhrase::Patterns
+    dictionaries[:nouns] ||= TokenPhrase::Nouns
+    phrase = [dictionaries[:adjectives].sample, dictionaries[:colors].sample, dictionaries[:patterns].sample, dictionaries[:nouns].sample].join('-')
     phrase.gsub!(/-/, separator) unless separator.nil?
     return phrase
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: token_phrase
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors: