token_phrase 1.0.2 → 1.0.3

data/README.md

@@ -23,18 +23,18 @@ Or install it yourself as:
 ## TokenPhrase.generate(separator = nil, dictionaries = {})
 
 ### Defaults
-By default, TokenPhrase uses the included dictionaries and separates everything with a hyphen (-):
+By default, TokenPhrase uses the included dictionaries, separates everything with a hyphen (-), and appends a random number between 1 and 1,000,000 :
 
 ```ruby
 TokenPhrase.generate
-=> "ultimate-blue-glossy-lamp"
+=> "ultimate-beige-tartan-pants557846"
 
 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"
+"amazing-golden-plaid-dishwasher214832"
+"thunderous-yellow-matte-greyhound516648"
+"bodacious-violet-houndstooth-viper351290"
+"dancing-golden-spotted-cardinal623081"
+"sweet-jade-cracked-cape975328"
 ```
 
 ### Separators
@@ -42,10 +42,10 @@ If you would like a different separator, just pass a string as an argument:
 
 ```ruby
 TokenPhrase.generate('$')
-=> "exciting$taupe$glossy$lake"
+=> "vegan$blue$spotted$capybara649484"
 
-TokenPhrase.generate('!!!eric!!!')
-=> "splendid!!!eric!!!golden!!!eric!!!glossy!!!eric!!!flounder"
+TokenPhrase.generate('MARSIPAN')
+=> "bodaciousMARSIPANaquaMARSIPANmatteMARSIPANcardinal611650"
 ```
 
 ### Dictionaries
@@ -60,35 +60,44 @@ If you want to replace the dictionary, just pass a hash with an array as an argu
 
 ```ruby
 TokenPhrase.generate :adjectives => %w(glowing)
-=> "glowing-tan-striped-sand"
+=> "glowing-white-striped-tapir168706"
 
 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"
+"better-red-satin-Venus956045"
+"awesome-pearl-glossy-Saturn284244"
+"sour-sea-green-checked-Saturn711076"
+"groovy-lime-argyle-Venus213795"
+"old-fashioned-topaz-waved-Pluto922970"
 ```
 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"
+"grass-fed-white-polka-dotted-cat307486"
+"grass-fed-black-cracked-cat882907"
+"bluetooth-white-satin-dog77769"
+"ultimate-black-fractal-dog328541"
+"spectacular-black-satin-cat815018"
 ```
 
 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"
+"great^^^cornflower^^^blue^^^striped^^^machine662941"
+"awesome^^^pearl^^^striped^^^banana^^^slug313429"
+"awesome^^^navy^^^blue^^^striped^^^shirt279849"
+"awesome^^^midnight^^^blue^^^striped^^^shark379464"
+"awesome^^^ultraviolet^^^striped^^^hat748152"
+```
+
+## 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:
+
+```ruby
+TokenPhrase.generate(:numbers => false)
+=> "glazed-magenta-houndstooth-spider-wolf"
 ```
 
 ## Dictionary Methods
@@ -108,6 +117,23 @@ TokenPhrase.generate :patterns => your_patterns
 => "awesome-mauve-magic-eye-giraffe"
 ```
 
+## Uniqueness
+
+The simplest way to create a unique token for your models is to add a before_create filter to your model: 
+
+```ruby
+#assuming your Thing model has a token property
+class Thing < ActiveRecord::Base
+  before_create :generate_token
+  
+  private
+  def generate_token
+    begin
+      self.token = TokenPhrase.generate
+    end while self.class.exists?(token: token)
+  end
+end
+```
 
 ## Contributing
 
@@ -116,3 +142,7 @@ TokenPhrase.generate :patterns => your_patterns
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Sellmer
+
+I built TokenPhrase for use with [Sellmer](http://justsellstuff.com). I'm using token phrases for public-facing sales tokens as a way to give the application a little more personality and to make supporting sales and transactions easier. Sellmer is almost ready for beta testers, so if you are interested in being one of the first people to get their hands on it, head over to the [Sellmer page](http://justsellstuff.com) and add your email to the list. I'm looking forward to launching with features as big and as small as token phrase.

data/lib/token_phrase/version.rb

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

data/lib/token_phrase.rb

@@ -2,8 +2,8 @@ require "token_phrase/version"
 
 module TokenPhrase
   Adjectives = %w(splendid superior spectacular amazing ultimate ferocious exciting lovely old-fashioned home-made grass-fed free-range grandmas grandpas governing prickly strong stellar awesome wonderful bodacious excellent stupendous groovy dancing energetic sweet sour sugarfilled glazed vegan letterman thunderous established magnetic better windy wind-up american soft genetically-modified tailored liberal conservative bluetooth)
-  Colors = %w(red yellow blue green violet taupe mauve lime golden silver grey black white tangello sunshine brown tan infrared ultraviolet pink beige)
-  Patterns = %w(striped checked spotted polka-dotted plaid wavy houndstooth argyle glossy matte pinstriped)
+  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)
   
   def self.adjectives(more_adjectives = nil)
@@ -32,6 +32,7 @@ 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.gsub!(/-/, separator) unless separator.nil?
     return phrase
   end

data/token_phrase.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["eric@notvelcro.com"]
   gem.description   = %q{A token-phrase generator}
   gem.summary       = %q{Token Phrase is a simple generator that creates friendlier unique tokens as phrases}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/genericsteele/token_phrase"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: token_phrase
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -26,7 +26,7 @@ files:
 - lib/token_phrase.rb
 - lib/token_phrase/version.rb
 - token_phrase.gemspec
-homepage: ''
+homepage: https://github.com/genericsteele/token_phrase
 licenses: []
 post_install_message: 
 rdoc_options: []