token_phrase 1.0.4 → 1.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80a20c320997d8d943ec26d8544e7f7c89fb83e5
+  data.tar.gz: 047ae5ab470309acf7acdddb24ca565933a892b2
+SHA512:
+  metadata.gz: bb8ce0a04edcc6a41b66feba1d1e174450496cf1c5d13e0d96d0e8ac684828c0de6815659f733981099f6fb46956b53b31ea8a58c9f1c4f73b06db132d25cd2a
+  data.tar.gz: 31ca6d9702ac40a648b0a7130434a4f5a58f4f426669a6a0f702c9f464b32bc3433ed519e902ba4e5fc399092f42777ff375ee9fb77f38db23d90ef28c3eb4ad

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - jruby-19mode

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
+gem 'rake'
+gem 'minitest'
+gem 'backports', :require => false
+
 gemspec

data/README.md

@@ -1,11 +1,10 @@
-# TokenPhrase
+# TokenPhrase (v1.0.4)
+[![Build Status](https://travis-ci.org/genericsteele/token_phrase.png?branch=master)](https://travis-ci.org/genericsteele/token_phrase)
 
 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
 
 Add this line to your application's Gemfile:
@@ -27,14 +26,14 @@ By default, TokenPhrase uses the included dictionaries, separates everything wit
 
 ```ruby
 TokenPhrase.generate
-=> "ultimate-beige-tartan-pants557846"
+=> "groovy-red-fractal-fork-101589"
 
 5.times { p TokenPhrase.generate }
-"amazing-golden-plaid-dishwasher214832"
-"thunderous-yellow-matte-greyhound516648"
-"bodacious-violet-houndstooth-viper351290"
-"dancing-golden-spotted-cardinal623081"
-"sweet-jade-cracked-cape975328"
+"bodacious-blue-spotted-envelope-428491"
+"magnetic-burnt-orange-polka-dotted-spider-wolf-268974"
+"conservative-plum-paisley-banana-slug-771632"
+"bluetooth-chiffon-houndstooth-wolf-spider-700306"
+"sweet-violet-tartan-coyote-16101"
 ```
 
 With the current dictionaries and numbers, there are 4,199,040,000,000 (four trillion!) unique possibilites.
@@ -44,10 +43,10 @@ If you would like a different separator, just pass a string as an argument:
 
 ```ruby
 TokenPhrase.generate('$')
-=> "vegan$blue$spotted$capybara649484"
+=> "groovy$salmon$paisley$cape$848536"
 
 TokenPhrase.generate('MARSIPAN')
-=> "bodaciousMARSIPANaquaMARSIPANmatteMARSIPANcardinal611650"
+=> "sugarfilledMARSIPANcrimsonMARSIPANstripedMARSIPANfrogMARSIPAN860203"
 ```
 
 ### Dictionaries
@@ -62,35 +61,35 @@ If you want to replace the dictionary, just pass a hash with an array as an argu
 
 ```ruby
 TokenPhrase.generate :adjectives => %w(glowing)
-=> "glowing-white-striped-tapir168706"
+=> "glowing-peach-glossy-barracuda-743220"
 
 5.times { p TokenPhrase.generate :nouns => %w(Mercury Venus Earth Mars Jupiter Saturn Uranus Neptune Pluto) }
-"better-red-satin-Venus956045"
-"awesome-pearl-glossy-Saturn284244"
-"sour-sea-green-checked-Saturn711076"
-"groovy-lime-argyle-Venus213795"
-"old-fashioned-topaz-waved-Pluto922970"
+"stupendous-crimson-tartan-Uranus-431203"
+"tailored-khaki-fractal-Neptune-957683"
+"better-almond-striped-Pluto-299491"
+"soft-chiffon-tartan-Saturn-29752"
+"tailored-azure-honeycomb-Saturn-668823"
 ```
 You can pass multiple dictionaries: 
 
 ```ruby
 5.times { p TokenPhrase.generate :colors => %w(black white), :nouns => %w(cat dog) }
-"grass-fed-white-polka-dotted-cat307486"
-"grass-fed-black-cracked-cat882907"
-"bluetooth-white-satin-dog77769"
-"ultimate-black-fractal-dog328541"
-"spectacular-black-satin-cat815018"
+"windy-white-satin-dog-663888"
+"exciting-black-spotted-cat-502218"
+"sour-white-houndstooth-cat-591001"
+"thunderous-white-pinstriped-cat-375006"
+"grandpas-white-honeycomb-cat-23992"
 ```
 
 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^^^cornflower^^^blue^^^striped^^^machine662941"
-"awesome^^^pearl^^^striped^^^banana^^^slug313429"
-"awesome^^^navy^^^blue^^^striped^^^shirt279849"
-"awesome^^^midnight^^^blue^^^striped^^^shark379464"
-"awesome^^^ultraviolet^^^striped^^^hat748152"
+"awesome^^^aquamarine^^^striped^^^pen^^^345915"
+"great^^^salmon^^^striped^^^pants^^^852927"
+"great^^^white^^^striped^^^spider^^^wolf^^^646401"
+"awesome^^^blue^^^striped^^^people^^^314195"
+"awesome^^^aqua^^^striped^^^wolverine^^^113478"
 ```
 
 ### Numbers
@@ -99,7 +98,7 @@ To help with uniqueness, a random number is added to the token by default. This
 
 ```ruby
 TokenPhrase.generate(:numbers => false)
-=> "glazed-magenta-houndstooth-spider-wolf"
+=> "energetic-yellow-pinstriped-skunk"
 ```
 
 ## Dictionary Methods
@@ -115,8 +114,9 @@ Each of these dictionary methods accept an array as an argument that will merge
 
 ```ruby
 your_patterns = TokenPhrase.patterns %w(magic-eye)
-TokenPhrase.generate :patterns => your_patterns
-=> "awesome-mauve-magic-eye-giraffe"
+2.times { p TokenPhrase.generate :patterns => your_patterns }
+"prickly-magenta-matte-space-heater-687093"
+"stupendous-aquamarine-magic-eye-skunk-690072"
 ```
 
 ## TokenPhrase.permutations(dictionaries = {})
@@ -160,6 +160,6 @@ end
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## Sellmer
+## Thanks
 
-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.
+Thanks to [benolee](https://github.com/benolee) for [refactoring the generator model](https://github.com/genericsteele/token_phrase/commit/7e5a0877882ba7d08f0c5a40d7873ebb0d205a45)!

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*.rb']
+end
+
+desc "Run tests"
+task :default => :test

data/lib/token_phrase.rb

@@ -1,49 +1,14 @@
+require "token_phrase/dictionary"
+require "token_phrase/generator"
 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 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
+  def self.generate *args
+    Generator.new(*args).generate
   end
-  
-  def self.colors(more_colors = nil)
-    more_colors.nil? ? TokenPhrase::Colors : TokenPhrase::Colors | more_colors
-  end
-  
-  def self.patterns(more_patterns = nil)
-    more_patterns.nil? ? TokenPhrase::Patterns : TokenPhrase::Patterns | more_patterns
-  end
-  
-  def self.nouns(more_nouns = nil)
-    more_nouns.nil? ? TokenPhrase::Nouns : TokenPhrase::Nouns | more_nouns
-  end
-  
-  def self.generate(separator = nil, dictionaries = {})
-    if separator.is_a?(Hash)
-      dictionaries = separator
-      separator = nil
-    end
-    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 << 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
+
+  def self.permutations *args
+    Generator.new(*args).permutations
   end
 end
+

data/lib/token_phrase/dictionary.rb

@@ -0,0 +1,32 @@
+module TokenPhrase
+  def self.dictionary
+    {
+      :adjectives => %w(wireless furry fuzzy sleek messy incredible generous 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 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 bacon eggs cereal milk sausage ham turkey nerf-gun bowl plate lazy-susan safe fireworks table chair muscles trek journey quest mission laser-gun gladiator pumpkin),
+      :numbers => (1..1000000).to_a
+    }
+  end
+
+  def self.adjectives more = []
+    dictionary[:adjectives] | more
+  end
+
+  def self.colors more = []
+    dictionary[:colors] | more
+  end
+
+  def self.patterns more = []
+    dictionary[:patterns] | more
+  end
+
+  def self.nouns more = []
+    dictionary[:nouns] | more
+  end
+
+  def self.numbers more = []
+    dictionary[:numbers] | more
+  end
+end
+

data/lib/token_phrase/generator.rb

@@ -0,0 +1,34 @@
+require 'backports/1.9.1/array/sample'
+module TokenPhrase
+  class Generator
+    attr_accessor :separator, :dictionary, :order
+
+    def initialize separator = "-", options = {}
+      separator, options = "-", separator if separator.is_a? Hash
+      options[:numbers] = [] if options[:numbers] == false
+
+      @separator = separator
+      @dictionary = TokenPhrase.dictionary.merge options
+      @order = dictionary.keys
+    end
+
+    def generate
+      lists.map(&:sample).join(separator).chomp(separator).gsub(/-/, separator)
+    end
+
+    def permutations
+      lists.inject 1 do |p, list|
+        if list.empty?
+          p
+        else
+          p * list.uniq.count
+        end
+      end
+    end
+
+    def lists
+      dictionary.values_at(*order).compact
+    end
+  end
+end
+

data/lib/token_phrase/version.rb

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

data/test/generator_test.rb

@@ -0,0 +1,57 @@
+require 'minitest/autorun'
+require 'token_phrase'
+
+class GeneratorTest < MiniTest::Unit::TestCase
+  def test_that_numbers_can_be_excluded
+    phrase = TokenPhrase.generate :numbers => false
+    refute_match /\d+$/, phrase
+  end
+
+  def test_that_permutations_calculate_all_combinations
+    permutations = TokenPhrase.permutations(
+      :adjectives => %w(test),
+      :colors => %w(test),
+      :patterns => %w(test),
+      :nouns => %w(test),
+      :numbers => false
+    )
+    assert_equal 1, permutations
+  end
+
+  def test_that_separator_can_be_overridden
+    phrase = TokenPhrase.generate "+"
+    assert_match /\+/, phrase
+    refute_match /-/, phrase
+  end
+
+  def test_that_adjectives_can_be_overridden
+    phrase = TokenPhrase.generate :adjectives => %w(test)
+    assert_match /test/, phrase
+  end
+
+  def test_that_colors_can_be_overridden
+    phrase = TokenPhrase.generate :colors => %w(test)
+    assert_match /test/, phrase
+  end
+  
+  def test_that_patterns_can_be_overridden
+    phrase = TokenPhrase.generate :patterns => %w(test)
+    assert_match /test/, phrase
+  end
+  
+  def test_that_nouns_can_be_overridden
+    phrase = TokenPhrase.generate :nouns => %w(test)
+    assert_match /test/, phrase
+  end
+
+  def test_that_dictionaries_can_be_added_to
+    adjectives = TokenPhrase.adjectives %w(test)
+    colors = TokenPhrase.colors %w(test)
+    patterns = TokenPhrase.patterns %w(test)
+    nouns = TokenPhrase.nouns %w(test)
+    assert_equal (TokenPhrase.adjectives.count + 1), adjectives.count
+    assert_equal (TokenPhrase.colors.count + 1), colors.count
+    assert_equal (TokenPhrase.patterns.count + 1), patterns.count
+    assert_equal (TokenPhrase.nouns.count + 1), nouns.count
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+require 'minitest/autorun'

data/token_phrase.gemspec

@@ -4,6 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'token_phrase/version'
 
 Gem::Specification.new do |gem|
+  gem.add_dependency 'backports'
+  gem.add_development_dependency 'minitest'
+  
   gem.name          = "token_phrase"
   gem.version       = TokenPhrase::VERSION
   gem.authors       = ["Eric Steele"]

metadata

@@ -1,16 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: token_phrase
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.0.6
 platform: ruby
 authors:
 - Eric Steele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
-dependencies: []
+date: 2013-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A token-phrase generator
 email:
 - eric@notvelcro.com
@@ -19,36 +46,42 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/token_phrase.rb
+- lib/token_phrase/dictionary.rb
+- lib/token_phrase/generator.rb
 - lib/token_phrase/version.rb
+- test/generator_test.rb
+- test/test_helper.rb
 - token_phrase.gemspec
 homepage: https://github.com/genericsteele/token_phrase
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Token Phrase is a simple generator that creates friendlier unique tokens
   as phrases
-test_files: []
+test_files:
+- test/generator_test.rb
+- test/test_helper.rb