readable-token 0.1.0a → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc23a3a8458248c0942242a0533b312da56af97d
-  data.tar.gz: 53f48a46cc46d711464e31342b903fcb684659c6
+  metadata.gz: 61f4a07f28254f0700997c34242a384860624614
+  data.tar.gz: a7d272ac34c7db671bdfb6df2cca39fbc528aa94
 SHA512:
-  metadata.gz: 7ced1ed8683e1d289e05d94eb630de2c12fed73db4be739893f1d278fa70d89d4e68327a3953e99662f202c24307f2d79e5f1da3f5cc4f9d5d132f1662181caa
-  data.tar.gz: 15b1988ac12655c9a4a46a389971d10e687affd3bfba4c53185dad5243a8f6ecd6ec1ccb5070c2f78e6d243f3a5d90c02e1b821c60e3cbf45c5a4271bbec57f3
+  metadata.gz: a665f67d6e2bd5f6d6504c87fd27ab36dcbf0751c16be6afef992fb0ddbf29eeca59f8c2dfc72b52aa620a1b65950f0a2f2a2c4e16a3693acb6850b12fd4d427
+  data.tar.gz: 7965e8bb82bbcc51776f29009f975c91563af5273f8723a1bbbbf72d8adc6b3a3f9228b8adaf04ea63ab8720abc59dd91930790b397d31534f44d5ba55700c03

data/HISTORY.md

@@ -1,3 +1,3 @@
-## HEAD
+## 0.1.0 (2014-12-01)
 
-* Initial development/hacking initiated.
+* Initial version.

data/README.md

@@ -24,14 +24,14 @@ Require the gem in your code:
 
 ### Generate a token
 
-    ReadableToken.generate
-    ReadableToken.generate(min: 6)
-    ReadableToken.generate(max: 8)
-    ReadableToken.generate(separator: '|')
+    ReadableToken.generate          # => "barista-spoon-1"
+    ReadableToken.generate(min: 20) # => "doughnut-fork-aroma-7"
+    ReadableToken.generate(max: 10) # => "penguin-2"
 
 ### Loading your own word list
 
-    generator = ReadableToken.new(%w(cat penguin password))
+    ReadableToken.words = %w(cat penguin password)
+    ReadableToken.generate
 
 # Development
 
@@ -42,5 +42,3 @@ Require the gem in your code:
 
     # hints where to improve docs
     bundle exec inch
-
-# TODO

data/lib/readable-token.rb

@@ -1,32 +1,41 @@
 require 'readable-token/version'
 
-class ReadableToken
+# A tiny Ruby library for generating human readable "tokens".
+module ReadableToken
 
-  def initialize
-    @records = []
+  # Access to current list of words
+  def self.words
+    @@words ||= %w{dream season applause music venue talk top spoon fork tea coffee soup eat drink chat social happy doughnut beans bistro cafe lunch java ruby penguin lion leopard cake tiger crab fish moo milk owl roast aroma balance barista blend body decaf espresso flavor mocha latte organic friend}
   end
 
+  # Set list of words to the given array
+  def self.words=(vals)
+    @@words = vals
+  end
+
+  # Generate a new token.
   def self.generate(opts = {})
+    # set default options and merge with user provided
     options = {
       min: 8,
       max: nil
     }.merge(opts)
 
-    words = %w{music venue talk top spoon fork tea coffee soup eat drink chat social happy doughnut beans bistro cafe lunch java ruby penguin lion leopard cake tiger crab fish moo milk owl roast aroma balance barista blend body decaf espresso flavor mocha latte organic friend}
-
     segments = []
 
     # add number
     segments << rand(1..9).to_s
 
+    # count number of loops so were not spinning our wheels if we can't meet
+    # the criteria requested by the user.
     looped = 0
     while current_length_of(segments) < options[:min]
-      segments.delete_if(&:nil?).delete_if(&:empty?)
+      new_word = ''
+      remove_blanks!(segments)
+
       looped += 1
       break if looped > 20
 
-      new_word = ''
-
       current_length = current_length_of(segments)
       if options[:max] && options[:max] > 0
         remaining = options[:max] - current_length
@@ -40,7 +49,7 @@ class ReadableToken
 
       segments << new_word
     end
-    segments.delete_if(&:nil?).delete_if(&:empty?)
+    remove_blanks!(segments)
 
     # join it all together to give us a token
     segments.reverse.join('-')
@@ -48,13 +57,19 @@ class ReadableToken
 
   private
 
+  # Remove blank, empty, nil array elements
+  def self.remove_blanks!(segments)
+    segments.delete_if(&:nil?).delete_if(&:empty?)
+  end
+
+  # Calculate the current length
   def self.current_length_of(segments)
     segments.join('-').length
   end
 
+  # Filter array of words by their maximum length
   def self.filter_by_length(words, max)
-    filtered = words.select { |w| w.length <= max }
-    filtered
+    words.select { |w| w.length <= max }
   end
 
 end

data/lib/readable-token/version.rb

@@ -1,3 +1,3 @@
-class ReadableToken
-  Version = '0.1.0a'
+module ReadableToken
+  Version = '0.1.0'
 end

data/readable-token.gemspec

@@ -18,7 +18,7 @@ spec = Gem::Specification.new do |s|
 
   # development dependencies
   s.add_development_dependency('bundler',        '~> 1.0')
-  s.add_development_dependency('rake',           '>= 9.0')
+  s.add_development_dependency('rake',           '~> 9.0')
   s.add_development_dependency('minitest',       '~> 5.0')
   s.add_development_dependency('simplecov',      '~> 0.7.1')
   s.add_development_dependency('yard',           '~> 0.8')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readable-token
 version: !ruby/object:Gem::Version
-  version: 0.1.0a
+  version: 0.1.0
 platform: ruby
 authors:
 - Luke Antins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-30 00:00:00.000000000 Z
+date: 2014-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,14 +28,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '9.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '9.0'
 - !ruby/object:Gem::Dependency
@@ -128,9 +128,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.2