readable-token 0.1.0a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc23a3a8458248c0942242a0533b312da56af97d
+  data.tar.gz: 53f48a46cc46d711464e31342b903fcb684659c6
+SHA512:
+  metadata.gz: 7ced1ed8683e1d289e05d94eb630de2c12fed73db4be739893f1d278fa70d89d4e68327a3953e99662f202c24307f2d79e5f1da3f5cc4f9d5d132f1662181caa
+  data.tar.gz: 15b1988ac12655c9a4a46a389971d10e687affd3bfba4c53185dad5243a8f6ecd6ec1ccb5070c2f78e6d243f3a5d90c02e1b821c60e3cbf45c5a4271bbec57f3

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/HISTORY.md

@@ -0,0 +1,3 @@
+## HEAD
+
+* Initial development/hacking initiated.

data/README.md

@@ -0,0 +1,46 @@
+readable-token
+========
+
+[![Build Status](https://secure.travis-ci.org/lantins/readable-token.png?branch=master)](http://travis-ci.org/lantins/readable-token)
+[![Gem Version](https://badge.fury.io/rb/readable-token.png)](http://badge.fury.io/rb/readable-token)
+
+A tiny Ruby library for generating human readable "tokens".
+
+## Installation
+
+Add this line to your Gemfile:
+
+    gem 'readable-token'
+
+And then execute:
+
+    bundle install
+
+Require the gem in your code:
+
+    require 'readable-token'
+
+## Usage
+
+### Generate a token
+
+    ReadableToken.generate
+    ReadableToken.generate(min: 6)
+    ReadableToken.generate(max: 8)
+    ReadableToken.generate(separator: '|')
+
+### Loading your own word list
+
+    generator = ReadableToken.new(%w(cat penguin password))
+
+# Development
+
+## Development Commands
+
+    # run all tests and build code coverage
+    bundle exec rake test
+
+    # hints where to improve docs
+    bundle exec inch
+
+# TODO

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+require 'rake'
+require 'rake/testtask'
+
+# by default run unit tests.
+task :default => 'test'
+
+desc 'Run full test suite and generate code coverage -- COVERAGE=false to disable code coverage'
+Rake::TestTask.new(:test) do |task|
+  ENV['COVERAGE'] ||= 'yes'
+  task.libs << 'test'
+  task.pattern = 'test/**/*_test.rb'
+  task.verbose = true
+end

data/lib/readable-token.rb

@@ -0,0 +1,60 @@
+require 'readable-token/version'
+
+class ReadableToken
+
+  def initialize
+    @records = []
+  end
+
+  def self.generate(opts = {})
+    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
+
+    looped = 0
+    while current_length_of(segments) < options[:min]
+      segments.delete_if(&:nil?).delete_if(&:empty?)
+      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
+        new_word = filter_by_length(words, remaining - 1).sample
+      else
+        new_word = words.sample
+      end
+
+      new_length = current_length_of(segments + [new_word])
+      next if options[:max] && options[:max] > 0 && new_length > options[:max]
+
+      segments << new_word
+    end
+    segments.delete_if(&:nil?).delete_if(&:empty?)
+
+    # join it all together to give us a token
+    segments.reverse.join('-')
+  end
+
+  private
+
+  def self.current_length_of(segments)
+    segments.join('-').length
+  end
+
+  def self.filter_by_length(words, max)
+    filtered = words.select { |w| w.length <= max }
+    filtered
+  end
+
+end

data/lib/readable-token/test_case.rb

@@ -0,0 +1,27 @@
+#
+# test_case.rb - A file used to setup the testing enviroment for the library.
+#
+
+require 'rubygems'
+
+# --- code coverage on MRI 1.9 ruby only, but disabled by default --------------
+if RUBY_VERSION >= '1.9' && RUBY_ENGINE == 'ruby' && ENV['COVERAGE']
+  require 'simplecov'
+  #SimpleCov.command_name 'test:unit'
+  SimpleCov.start do
+    # code coverage groups.
+    add_filter 'test/'
+  end
+end
+
+# --- load our dependencies using bundler --------------------------------------
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+# --- Load lib to test ---------------------------------------------------------
+require 'readable-token'
+
+# --- Extend Minitest::Test ----------------------------------------------------
+class ReadableToken::TestCase < Minitest::Test
+end

data/lib/readable-token/version.rb

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

data/readable-token.gemspec

@@ -0,0 +1,33 @@
+require './lib/readable-token/version'
+
+spec = Gem::Specification.new do |s|
+  # gem information/details
+  s.name                = 'readable-token'
+  s.version             = ReadableToken::Version
+  s.date                = Time.now.strftime('%Y-%m-%d')
+  s.summary             = 'Generate human readable "tokens".'
+  s.license             = 'MIT'
+  s.homepage            = 'https://github.com/lantins/readable-token'
+  s.authors             = ['Luke Antins']
+  s.email               = ['luke@float64.uk']
+
+  # gem settings for what files to include.
+  s.files               = %w(Rakefile README.md HISTORY.md Gemfile readable-token.gemspec)
+  s.files              += Dir.glob('{test/**/*,lib/**/*}')
+  s.require_paths       = ['lib']
+
+  # development dependencies
+  s.add_development_dependency('bundler',        '~> 1.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')
+  s.add_development_dependency('inch',           '~> 0.3')
+
+  # long description.
+  s.description       = <<-EOL
+A tiny Ruby library that generates human readable "tokens" that are easy to read and remember.
+end
+EOL
+
+end

data/test/generate_test.rb

@@ -0,0 +1,38 @@
+require 'readable-token/test_case'
+
+class GenerateTest < ReadableToken::TestCase
+
+  N_TIMES = 0..1000
+
+  def assert_valid_token(token)
+    assert token, 'we should have a token'
+    assert_match /^([a-z]+-)+\d+$/i, token, 'token does not match expected pattern'
+  end
+
+  def test_generate_with_defaults
+    (N_TIMES).each do
+      token = ReadableToken.generate
+      assert_valid_token(token)
+    end
+  end
+
+  def test_generate_min_length
+    (N_TIMES).each do
+      @min = 20
+      token = ReadableToken.generate(min: @min)
+      assert_valid_token(token)
+      assert_operator token.length, :>=, @min, 'token does not meet minimum length'
+    end
+  end
+
+  def test_generate_max_length
+    (N_TIMES).each do
+      @max = 8
+      token = ReadableToken.generate(max: @max)
+      assert_valid_token(token)
+      assert_operator token.length, :<=, @max, 'token exceeds maximum length'
+    end
+
+  end
+
+end

data/test/version_test.rb

@@ -0,0 +1,9 @@
+require 'readable-token/test_case'
+
+class VersionTest < ReadableToken::TestCase
+
+  def test_should_have_a_version
+    assert ReadableToken::Version, 'unable to access the version number'
+  end
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: readable-token
+version: !ruby/object:Gem::Version
+  version: 0.1.0a
+platform: ruby
+authors:
+- Luke Antins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  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
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: |
+  A tiny Ruby library that generates human readable "tokens" that are easy to read and remember.
+  end
+email:
+- luke@float64.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- HISTORY.md
+- README.md
+- Rakefile
+- lib/readable-token.rb
+- lib/readable-token/test_case.rb
+- lib/readable-token/version.rb
+- readable-token.gemspec
+- test/generate_test.rb
+- test/version_test.rb
+homepage: https://github.com/lantins/readable-token
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Generate human readable "tokens".
+test_files: []
+has_rdoc: