sluggo 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzU0OTcxMjNjMzdiZmRkYWM3YjVlY2ZiMDc0NTdhZTRmY2Q5NTFiMg==
+  data.tar.gz: !binary |-
+    YjQ3ODVkNDk2OTk4OGZlMGI3Zjc3NzU5MzY0ZjQ2OTAzMmNmMmVkMw==
+SHA512:
+  metadata.gz: !binary |-
+    MTljZDBmMDYwMDNjMDYxM2IxNmFlZGQwODI3OTU5NTUyY2VlNjM5MzE2NDhk
+    MTQ1NjYwOWFhMmQyMDM0ZGM1MTc5MmY5ODNkYzY2ZTZlY2U5ZGMzOWNmMzNm
+    OGQ1M2QyMGI4OGU2MGVhOWI1Mzg3M2E4NTZlMWM0NjM2MDI4ZDg=
+  data.tar.gz: !binary |-
+    ZGY5ZDJmNTBlMzAyNWUzZDQwMGE2ZmQ4NmIyYzZmNGRhYTdhYmE1NmI4ODYz
+    NjkyYjBjNmE4MTI5MTI4ZGMxOTRlZTE0OTFhYzU2Yzc5ZDI2MmY2NTcxN2Jh
+    ODlhNmJjNjFkMjk3OTBmMTM5MzJhMjYwYWNhYmU3M2RlMjc3MTM=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle
+/.yardoc
+/bin
+/doc
+/tmp
+/pkg
+
+*.swp
+*~

data/.ruby-gemset

@@ -0,0 +1 @@
+slugmill

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in biblesearch-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    sluggo (0.0.1)
+      radix62 (~> 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    metaclass (0.0.1)
+    minitest (5.0.8)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    radix62 (1.0.1)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0.8)
+  mocha
+  rake (~> 10.1.0)
+  sluggo!

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Dennis Walters
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Sluggo #
+
+Sometimes, we just want a string of quasi-random gobbledeygook to use as
+a token of some sort. We may want these strings to be unique (or at least
+somewhat close to it), or we may just them to be a given length.
+
+That's what this is for.
+
+## Important Note ##
+
+This is very much not ready for primetime. I'm only releasing right now so
+as to stop working on it and accept a baseline.
+
+## Install ##
+
+You can add it to your Gemfile:
+
+    gem 'sluggo'
+
+Or you can do it the hard way:
+
+    gem install sluggo
+
+## Usage ##
+
+```ruby
+require 'sluggo'
+
+# Let's get a 6-character random base62 slug
+
+slug = Sluggo::Random.base62(6)
+
+# Heck, let's get a possibly unique 6-character base62 slug
+# This works by passing a block to the rare method. If the block
+# returns true, we assume that the proposed slug is unique and
+# return it. We're going to assume that we're working with a
+# Widget with a .open_key? method that returns true if the 
+# supplied key isn't in use.
+
+slug = Sluggo.rare(6) {|slug| Widget.open_key?(slug)}
+```
+
+## License ##
+
+MIT License. Copyright 2013 Ess

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+RUBY_TEST_VERSIONS = [
+  '1.8.7',
+  '1.9.2-p180',
+  '1.9.3',
+  '2.0.0'
+]
+
+Rake::TestTask.new do |t|
+  t.libs.push "spec"
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+task :default => :test
+
+desc 'Tests the library against several rubies'
+task :overtest do
+  system "rvm #{RUBY_TEST_VERSIONS.map{|x| "#{x}@slugmill"}.join(',')} do bundle exec rake test"
+end

data/lib/sluggo.rb

@@ -0,0 +1,56 @@
+require 'radix62'
+require 'sluggo/version'
+require 'sluggo/random'
+
+# Sluggo generates strings that look like tokens
+module Sluggo
+    # Repeatedly attempt to generate a unique token, where uniqueness is
+    # determined by a provided code block. This may not actually end up
+    # generating a unique token, but possibly just a rare token.
+    # @param options [Hash]
+    # @option options [Integer] :length (6) the length of the token to return
+    # @option options [Integer] :chances (100) the number of tries before
+    #   giving up on uniqueness
+    # @param is_unique [Proc] a proc that returns true if the supplied
+    #   |slug| is unique
+    # @raise [ArgumentError] if no block is given
+    # @raise [ArgumentError] if chances are provided, but is < 1
+    # @raise [ArgumentError] if length is provided, but is < 1
+    def self.rare(options = {}, &is_unique)
+      length, chances, is_unique = sanitize_options(
+        options.merge({:is_unique => is_unique})
+      )
+
+      while (chances -= 1) >= 0 do
+        current_slug = Random.base62(length)
+        break if is_unique.call(current_slug)
+      end
+      current_slug
+    end
+
+  class << self
+    private
+    def sanitize_options(options = {})
+      if options[:is_unique].nil?
+        raise ArgumentError.new(rare_error_message(:is_unique))
+      end
+
+      options[:chances].tap do |chances|
+        unless chances.nil?
+          raise ArgumentError.new(rare_error_message(:chances, chances)) if chances < 1
+        end
+      end
+
+      [options[:length] || 6, options[:chances] || 100, options[:is_unique]]
+    end
+
+    def rare_error_message(option, value = nil)
+      case option
+      when :is_unique
+        'You must provide a block to determine uniqueness'
+      when :chances
+        "You must allow at least one chance (chances: #{value})"
+      end
+    end
+  end
+end

data/lib/sluggo/random.rb

@@ -0,0 +1,24 @@
+require 'radix62'
+
+module Sluggo
+  # Used for generating random strings of gobbledeygook
+  class Random
+    # Generate a random base62-encoded string
+    # @param length (Integer)
+    # @return [String] a random selection of base62 digits
+    # @raise [ArgumentError] when length < 1
+    def self.base62(length = 1)
+      length = sanitize_length(length)
+      Array.new(length).map {Radix62.encode62(rand(62))}.join
+    end
+
+    class << self
+      private
+      def sanitize_length(length)
+        length = length.to_i
+        raise ArgumentError.new('length must be at lest 1') if length < 1
+        length
+      end
+    end
+  end
+end

data/lib/sluggo/version.rb

@@ -0,0 +1,3 @@
+module Sluggo
+  VERSION = "0.0.1"
+end

data/sluggo.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sluggo/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dennis Walters"]
+  gem.email         = ["dennis@elevatorup.com"]
+  gem.description   = %q{A gobbledeygook string generator}
+  gem.summary       = %q{A gobbledeygook string generator}
+  gem.homepage      = "http://github.com/ess/sluggo"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sluggo"
+  gem.require_paths = ["lib"]
+  gem.version       = Sluggo::VERSION
+
+  gem.add_dependency 'radix62', '~> 1.0.1'
+  gem.add_development_dependency 'minitest', '~> 5.0.8'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rake', '~> 10.1.0'
+end

data/spec/sluggo/random_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'sluggo/random'
+
+describe Sluggo::Random do
+  let(:klass) {Sluggo::Random}
+
+  describe %{.base62} do
+    it %{defaults to a length of 1} do
+      klass.base62.length.must_equal 1
+    end
+
+    it %{can take a specific length} do
+      klass.base62(12).length.must_equal 12
+    end
+
+    it %{is comprised of valid slug characters} do
+      klass.base62.split('').each do |character|
+        (0..61).to_a.must_include Radix62.decode62(character)
+      end
+    end
+
+    it %{requires that a provided length be > 0} do
+      lambda {klass.base62(0)}.must_raise ArgumentError
+    end
+  end
+end

data/spec/sluggo_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'sluggo'
+
+describe Sluggo do
+  let(:klass) {Sluggo}
+  let(:random) {Sluggo::Random}
+
+  describe %{.rare} do
+    it %{requires a block to check for uniqueness} do
+      lambda {klass.rare}.must_raise ArgumentError
+      klass.rare {true}.must_be_kind_of String
+    end
+
+    it %{allows a length} do
+      generated = klass.rare(:length => 12) {true}
+      generated.length.must_equal 12
+    end
+
+    it %{is uses Sluggo::Random} do
+      random.expects(:base62)
+      klass.rare {true}
+    end
+
+    it %{has 100 chances to generate a unique slug by default} do
+      chances = 100
+      random.expects(:base62).at_most(100).at_least(100)
+      klass.rare(:length => 1) {false}
+    end
+
+    it %{also accepts a number of chances to generate a unique slug} do
+      chances = 10
+      random.expects(:base62).at_most(chances)
+      klass.rare(:length => 1, :chances => chances) {false}
+    end
+
+    it %{needs at least 1 chance to generate a unique slug} do
+      lambda {klass.rare(:length => 1, :chances => 0) {false}}.must_raise ArgumentError
+      klass.rare(:length => 1, :chances => 1) {false}.must_be_kind_of String
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'radix62'
+
+$:.unshift File.join('.', 'lib')

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: sluggo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dennis Walters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: radix62
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+description: A gobbledeygook string generator
+email:
+- dennis@elevatorup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/sluggo.rb
+- lib/sluggo/random.rb
+- lib/sluggo/version.rb
+- sluggo.gemspec
+- spec/sluggo/random_spec.rb
+- spec/sluggo_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ess/sluggo
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A gobbledeygook string generator
+test_files:
+- spec/sluggo/random_spec.rb
+- spec/sluggo_spec.rb
+- spec/spec_helper.rb