proquint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 600b3df2f02f5225349f541dc4266bd25130cf68
+  data.tar.gz: af78b6ac37f47f43f47835356f73c0daec4f6c14
+SHA512:
+  metadata.gz: d256e818fea8f45a4c09253dfb72bec737c153dae86a4577f5fb488c4a6b8c2b00a5484d8c985b68050538acdd9f47cd3e46a00fdf35a1943ac7db5cc686fd9b
+  data.tar.gz: 459f5580334a2cb37993da41c7122c38dba34fcb40f822483eaba85501d4f9e7999ae2f6410d8dabf780b5efc54c97f56d2651b8a70e4a3fc1b9bbe9d00a712b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 JJ Buckley
+
+MIT License
+
+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,40 @@
+# Proquint
+
+A library for converting numbers to readable, pronounceable, spellable
+identifiers.
+
+See http://arxiv.org/html/0901.4016.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'proquint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install proquint
+
+## Usage
+
+    require 'proquint'
+    Proquint.encode(1)                  #=> "babad"
+    Proquint.encode(1234567890123456)   #=> "babah-karij-gufap-rorab"
+    Proquint.encode(0x462d53c8abac0)    #=> "babah-karij-gufap-rorab"
+    Proquint.encode(0x1234567890abcdef) #=> "damuh-jinum-nafor-suloz"
+    Proquint.decode("nobol-gonad")      #=> [38951, 14913]
+    Proquint.words2num([38951, 14913])  #=> 2552707649
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/proquint/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/proquint/version.rb

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

data/lib/proquint.rb

@@ -0,0 +1,96 @@
+require "proquint/version"
+
+# A Proquint is a readable, spellable, pronouncable representation of a
+# number. In Ruby, a proquint is a string, such as "badab-lufiv", which
+# represents the number 0x407d92 (or 4226450 in decimal).
+#
+# See http://arxiv.org/html/0901.4016 for more details.
+#
+# The main API is provided by `encode` and `decode`, the former of which takes
+# a number, or an array of words (unsigned 16-bit integers) to make a
+# proquint, and the latter of which takes a proquint and returns an array of
+# words. There are also some convenience methods for getting a complete number
+# from an array of words, for getting an array of words from a number, and for
+# converting between dotted-decimal IP-addresses and hex IP addresses.
+module Proquint
+  CONSONANTS = %w[b d f g h j k l m n p r s t v z]
+  VOWELS = %w[a i o u]
+  REVERSE = {}
+  CONSONANTS.each_with_index { |c, i| REVERSE[c] = i }
+  VOWELS.each_with_index { |c, i| REVERSE[c] = i }
+  DQUAD_PATTERN = /^(\d{1,3}).(\d{1,3}).(\d{1,3}).(\d{1,3})$/
+  HEX_PATTERN = /^x(\h+)$/
+
+  def dquad2hex(dquad)
+    if dquad =~ DQUAD_PATTERN
+      i = (($1.to_i << 24) + ($2.to_i << 16) + ($3.to_i << 8) + $4.to_i)
+      "x#{i.to_s(16)}"
+    else
+      raise ArgumentError.new("Invalid dotted quad")
+    end
+  end
+
+  def hex2dquad(hex)
+    if hex =~ HEX_PATTERN
+      i = $1.to_i(16)
+      [(i & 0xff000000) >> 24, (i & 0xff0000) >> 16, (i & 0xff00) >> 8, i & 0xff].join('.')
+    else
+      raise ArgumentError.new("Invalid hex address")
+    end
+  end
+
+  def num2words(num)
+    words = [num & 0xffff]
+    while num > 0xffff
+      num >>= 16
+      words.unshift(num & 0xffff)
+    end
+    words
+  end
+
+  def words2num(words)
+    num = words.shift || 0
+    until words.empty?
+      num <<= 16
+      num += words.shift
+    end
+    num
+  end
+
+  # Convert a string, number or array of uint16s to a proquint
+  def encode(i, sep = "-")
+    case i
+      when Fixnum
+        raise ArgumentError.new("Can't encode negative numbers") if i < 0
+        return encode(num2words(i)) if i > 0xffff
+        CONSONANTS[(i & 0xf000) >> 12] +
+          VOWELS[(i & 0xc00) >> 10] +
+          CONSONANTS[(i & 0x3c0) >> 6] +
+          VOWELS[(i & 0x30) >> 4] +
+          CONSONANTS[i & 0xf]
+      when Array then i.map { |x| encode(x) }.join(sep)
+      when DQUAD_PATTERN then encode(dquad2hex(i)[1..-1].to_i(16))
+      when String then encode(str2words(i))
+      else raise ArgumentError.new("Can't encode #{i}")
+    end
+  end
+
+  # Convert a proquint to an array of numbers (between 0 and 0xffff)
+  def decode(s, sep = "-")
+    s.split(sep).map do |p|
+      p = p.downcase
+      raise ArgumentError.new("Invalid proquint") unless p.bytes.length == 5
+      (REVERSE[p[0]]   << 12) +
+        (REVERSE[p[1]] << 10) +
+        (REVERSE[p[2]] << 6) +
+        (REVERSE[p[3]] << 4) +
+        (REVERSE[p[4]])
+    end
+  end
+
+  # Convert a proquint to a number
+  def quint2num(s, sep = "-")
+    words2num(decode(s))
+  end
+  extend self
+end

data/proquint.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'proquint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "proquint"
+  spec.version       = Proquint::VERSION
+  spec.authors       = ["JJ Buckley"]
+  spec.email         = ["jj@bjjb.org"]
+  spec.summary       = %q{Readable, spellable, pronounceable identifiers}
+  spec.homepage      = "http://bjjb.github.io/proquint"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4.3"
+end

data/test/proquint_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+require 'proquint'
+
+describe Proquint do
+  it "can convert dotted quads to hex" do
+    Proquint.dquad2hex('127.0.0.1').must_equal 'x7f000001'
+    Proquint.dquad2hex('123.123.123.123').must_equal 'x7b7b7b7b'
+  end
+
+  it "can convert hex to dotted quad" do
+    Proquint.hex2dquad('x7f000001').must_equal '127.0.0.1'
+    Proquint.hex2dquad('x7b7b7b7b').must_equal '123.123.123.123'
+  end
+
+  it "can split large numbers into unsigned 16-bit integers" do
+    Proquint.num2words(0x1).must_equal [1]
+    Proquint.num2words(0x1111).must_equal [0x1111]
+    Proquint.num2words(0x10000).must_equal [1, 0]
+    Proquint.num2words(0x10001).must_equal [1, 1]
+    Proquint.num2words(0xa000a000a).must_equal [10, 10, 10]
+  end
+
+  it "can combine an array or unsigned 16-bit integers" do
+    Proquint.words2num([1]).must_equal 1
+    Proquint.words2num([1, 1]).must_equal 0x10001
+    Proquint.words2num([1, 0]).must_equal 0x10000
+    Proquint.words2num([10, 10, 10]).must_equal 0xa000a000a
+  end
+
+  it "can encode numbers" do
+    Proquint.encode(0).must_equal 'babab'
+    Proquint.encode(0x10000).must_equal 'babad-babab'
+    Proquint.encode(0x7f000001).must_equal 'lusab-babad'
+    Proquint.encode(1234567890123456).must_equal 'babah-karij-gufap-rorab'
+    Proquint.encode(0x1234567890abcdef).must_equal 'damuh-jinum-nafor-suloz'
+  end
+
+  it "can encode and decode IP addresses" do
+    Proquint.encode("192.168.1.1").must_equal "safom-bahad"
+    Proquint.decode("safom-bahad").must_equal [49320, 257]
+  end
+
+  it "can decode proquints" do
+    Proquint.decode('babab').must_equal [0]
+    Proquint.decode('babad-babab').must_equal [1, 0]
+    Proquint.decode('lusab-babad').must_equal [0x7f00, 1]
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: proquint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- JJ Buckley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+description: 
+email:
+- jj@bjjb.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/proquint.rb
+- lib/proquint/version.rb
+- proquint.gemspec
+- test/proquint_test.rb
+- test/test_helper.rb
+homepage: http://bjjb.github.io/proquint
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Readable, spellable, pronounceable identifiers
+test_files:
+- test/proquint_test.rb
+- test/test_helper.rb