token_phrase 1.0.3 → 1.0.4

data/README.md

@@ -37,6 +37,8 @@ TokenPhrase.generate
 "sweet-jade-cracked-cape975328"
 ```
 
+With the current dictionaries and numbers, there are 4,199,040,000,000 (four trillion!) unique possibilites.
+
 ### Separators
 If you would like a different separator, just pass a string as an argument: 
 
@@ -91,7 +93,7 @@ And you can, of course pass a separator before the dictionaries:
 "awesome^^^ultraviolet^^^striped^^^hat748152"
 ```
 
-## Numbers
+### Numbers
 
 To help with uniqueness, a random number is added to the token by default. This may not be your cup of tea, so if you pass :numbers => false with the dictionaries, you can remove the number:
 
@@ -117,7 +119,22 @@ TokenPhrase.generate :patterns => your_patterns
 => "awesome-mauve-magic-eye-giraffe"
 ```
 
-## Uniqueness
+## TokenPhrase.permutations(dictionaries = {})
+
+If you want to see how many unique combinations you can generate, use the permutations method. Just pass it the dictionaries hash the same way you would use TokenPhrase.generate: 
+
+```ruby
+TokenPhrase.permutations
+=> 4199040000000
+
+TokenPhrase.permutations :nouns => %w(cat dog)
+=> 87480000000
+
+TokenPhrase.permutations :nouns => %w(scooter boat car vroom-vroom), :numbers => false
+=> 174960
+```
+
+## Rails Uniqueness
 
 The simplest way to create a unique token for your models is to add a before_create filter to your model: 
 

data/lib/token_phrase/version.rb

@@ -1,3 +1,3 @@
 module TokenPhrase
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/token_phrase.rb

@@ -5,6 +5,7 @@ module TokenPhrase
   Colors = %w(red yellow blue green violet taupe mauve lime golden silver grey black white tangello sunshine brown tan infrared ultraviolet pink beige almond aquamarine burnt-orange cerulean cornflower-blue denim forest-green midnight-blue peach plum sea-green ruby emerald jade rose topaz onyx pearl coral crimson cyan chocolate aqua azure lavendar chiffon khaki ivory magenta navy-blue olive salmon turquoise)
   Patterns = %w(striped checked spotted polka-dotted plaid wavy houndstooth argyle glossy matte pinstriped tartan paisley satin honeycomb fractal waved cracked )
   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)
+  Numbers = [*1..100]
   
   def self.adjectives(more_adjectives = nil)
     more_adjectives.nil? ? TokenPhrase::Adjectives : TokenPhrase::Adjectives | more_adjectives
@@ -32,8 +33,17 @@ module TokenPhrase
     dictionaries[:patterns] ||= TokenPhrase::Patterns
     dictionaries[:nouns] ||= TokenPhrase::Nouns
     phrase = [dictionaries[:adjectives].sample, dictionaries[:colors].sample, dictionaries[:patterns].sample, dictionaries[:nouns].sample].join('-')
-    phrase << [*1..1000000].sample.to_s unless dictionaries[:numbers] == false
+    phrase << Random.new.rand(1..1000000).to_s unless dictionaries[:numbers] == false
     phrase.gsub!(/-/, separator) unless separator.nil?
     return phrase
   end
+  
+  def self.permutations(dictionaries = {})
+    dictionaries[:adjectives] ||= TokenPhrase::Adjectives
+    dictionaries[:colors] ||= TokenPhrase::Colors
+    dictionaries[:patterns] ||= TokenPhrase::Patterns
+    dictionaries[:nouns] ||= TokenPhrase::Nouns
+    permutations = [:adjectives, :colors, :patterns, :nouns].map{ |key| dictionaries[key].uniq.count }.inject{ |product, total| product * total }
+    dictionaries[:numbers] == false ? permutations : permutations * 1000000
+  end
 end

metadata

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