deacon 0.0.3

data/lib/deacon.rb

@@ -0,0 +1,7 @@
+require 'deacon/version'
+require 'deacon/generator'
+require 'deacon/mac_generator'
+require 'deacon/random_generator'
+
+module Deacon
+end

data/lib/deacon/generator.rb

@@ -0,0 +1,37 @@
+module Deacon
+  class Generator
+    DEFAULT_DATA_DIR = File.expand_path('../../../data', __FILE__)
+    GIVEN_MALE_NAMES_FILE = 'gmnames.txt'
+    GIVEN_FEMALE_NAMES_FILE = 'gfnames.txt'
+    SURNAMES_FILE = 'srnames.txt'
+    RECORD_LENGTH_GIVEN = 6
+    RECORD_LENGTH_SURNAME = 9
+
+    def initialize(data_dir = DEFAULT_DATA_DIR)
+      @data_dir = data_dir
+    end
+
+    private
+
+    def data_file(filename)
+      File.join(@data_dir, filename)
+    end
+
+    def find_name(index, filename, length)
+      File.open(filename, 'r') do |f|
+        f.seek(index * length)
+        f.readline.chomp.strip
+      end
+    rescue Exception => e
+      raise "Error when seeking to #{index} in #{filename}: #{e}"
+    end
+
+    def mac_to_bytes(mac)
+      mac.split(/[:-]/).collect{|x| x.to_i(16)}
+    end
+
+    def mac_to_shorts(mac)
+      mac_to_bytes(mac).each_slice(2).collect { |a, b| (a << 8) + b }
+    end
+  end
+end

data/lib/deacon/mac_generator.rb

@@ -0,0 +1,17 @@
+module Deacon
+  class MacGenerator < Generator
+    def generate(mac, female = false)
+      return [] if mac.nil? || mac.empty?
+      # B0 B1 B2 B3 B4 B5
+      # SHRT0 SHRT1 SHRT2
+      bytes = mac_to_bytes(mac)
+      shorts = mac_to_shorts(mac)
+      filename = (shorts[0] & 0x1) == 0 ? GIVEN_MALE_NAMES_FILE : GIVEN_FEMALE_NAMES_FILE
+      firstname1 = find_name(bytes[2], data_file(filename), RECORD_LENGTH_GIVEN)
+      firstname2 = find_name(bytes[3], data_file(filename), RECORD_LENGTH_GIVEN)
+      surname1 = find_name(shorts[0], data_file(SURNAMES_FILE), RECORD_LENGTH_SURNAME)
+      surname2 = find_name(shorts[2], data_file(SURNAMES_FILE), RECORD_LENGTH_SURNAME)
+      [firstname2, firstname1, surname1, surname2]
+    end
+  end
+end

data/lib/deacon/random_generator.rb

@@ -0,0 +1,42 @@
+module Deacon
+  class RandomGenerator < Generator
+    MASK = 0x1ffffff
+
+    # Fibonacci linear feedback shift register with x^25 + x^24 + x^23 + x^22 + 1 poly
+    def next_lfsr25(seed)
+      i = 1
+      i = (seed + 1) & MASK
+      raise ArgumentError, "Seed #{seed} out of bounds" if seed && i == 0
+      i = (seed + 1) & MASK while i == 0
+      i = (i >> 1) | ((i[0]^i[1]^i[2]^i[3]) << 0x18)
+      i = (i >> 1) | ((i[0]^i[1]^i[2]^i[3]) << 0x18) while i > MASK
+      i - 1
+    end
+
+    def generate(seed = Time.now.utc.to_i)
+      return [] if seed.nil? || seed == 0
+      index = seed
+      loop do
+        index = next_lfsr25(index)
+        break if unique?(seed, index)
+      end
+      given_file = (index & 0x1000000) == 0 ? GIVEN_MALE_NAMES_FILE : GIVEN_FEMALE_NAMES_FILE
+      givenname_ix = (index & 0xff0000) >> 16
+      surnname_ix = index & 0xffff
+      firstname = find_name(givenname_ix, data_file(given_file), RECORD_LENGTH_GIVEN)
+      surname = find_name(surnname_ix, data_file(SURNAMES_FILE), RECORD_LENGTH_SURNAME)
+      [index, firstname, surname]
+    end
+
+    def self.random_initial_seed
+      rand(MASK - 2) + 1
+    end
+
+    private
+
+    # is first (or gender) and last name different from the old value?
+    def unique?(ix1, ix2)
+      (((ix1 & 0xff0000) != (ix2 & 0xff0000)) || ((ix1 & 0x1000000) != (ix2 & 0x1000000))) && ((ix1 & 0xffff) != (ix2 & 0xffff))
+    end
+  end
+end

data/lib/deacon/version.rb

@@ -0,0 +1,3 @@
+module Deacon
+  VERSION = '0.0.3'
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require "deacon"

data/test/unit/mac_generator_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+
+class MacGeneratorTest < MiniTest::Unit::TestCase
+  def setup
+    dir = File.expand_path('../../../data', __FILE__)
+    @generator = Deacon::MacGenerator.new(dir)
+  end
+
+  def test_generates_empty_array_for_nil
+    assert_equal [], @generator.generate(nil)
+  end
+
+  def test_generates_empty_array_for_empty_string
+    assert_equal [], @generator.generate("")
+  end
+
+  def test_generates_a_male_name
+    assert_equal ["DEREK", "LEVI", "PRATICO", "CEDILLO"], @generator.generate("00:00:ca:fe:01:01")
+  end
+
+  def test_generates_a_female_name
+    assert_equal ["KATHY", "ALTA", "ROMEO", "CEDILLO"], @generator.generate("00:01:ca:fe:01:01")
+  end
+
+  def test_generates_same_middle_names_for_single_oid
+    name1 = @generator.generate("24:a4:3c:ec:76:06")
+    name2 = @generator.generate("24:a4:3c:e3:d3:92")
+    #puts name1.inspect
+    #puts name2.inspect
+    assert_equal name1[1], name2[1]
+    assert_equal name1[2], name2[2]
+  end
+end

data/test/unit/random_generator_test.rb

@@ -0,0 +1,121 @@
+require "test_helper"
+
+class RandomGeneratorTest < MiniTest::Unit::TestCase
+  # number of test iterations for some tests
+  TEST_ITERATIONS=10_000
+
+  def setup
+    @dir = File.expand_path('../../../data', __FILE__)
+    @generator = Deacon::RandomGenerator.new(@dir)
+    @random = rand((2 ** 25) - (TEST_ITERATIONS+3))
+  end
+
+  def test_generates_empty_array_for_nil
+    assert_equal [], @generator.generate(nil)
+  end
+
+  def test_generates_a_deterministic_sequence
+    expected = [
+      [0x1000000, 'VELMA', 'PRATICO'],
+      [0x17fffff, 'ANGIE', 'WARMBROD'],
+      [0x0017fff, 'GRANT', 'GOODGINE'],
+      [0x000bfff, 'ALTON', 'SIEBER'],
+      [0x100000b, 'VELMA', 'VANBEEK'],
+      [0x0800005, 'DON', 'OTERO'],
+      [0x0400002, 'SAM', 'HULAN'],
+      [0x0200000, 'AARON', 'PRATICO'],
+      [0x10fffff, 'SALLY', 'WARMBROD'],
+      [0x0087fff, 'TED', 'GOODGINE'],
+      [0x0043fff, 'CORY', 'THURSBY'],
+      [0x0021fff, 'GARRY', 'HANDREN'],
+      [0x0010fff, 'GRANT', 'STELMAN'],
+      [0x00087ff, 'ALTON', 'KAWSKI'],
+      [0x1000043, 'VELMA', 'MIRRA'],
+      [0x1800021, 'SUSAN', 'DARBY'],
+      [0x1c00010, 'MARIA', 'BOURDON'],
+      [0x1e00007, 'ANNIE', 'SCHMANDT'],
+      [0x1f00003, 'MAYRA', 'BURNAUGH'],
+      [0x1f80001, 'FAYE', 'ROMEO'],
+      [0x1fc0000, 'OPAL', 'PRATICO'],
+      [0x1fdffff, 'CLARA', 'WARMBROD'],
+      [0x07f7fff, 'DUANE', 'GOODGINE'],
+      [0x03fbfff, 'ERVIN', 'SIEBER'],
+      [0x01fdfff, 'ELDON', 'LEYUA'],
+      [0x00fefff, 'GARY', 'TRASHER'],
+      [0x007f7ff, 'BRET', 'ONDRICK'],
+      [0x003fbff, 'LANCE', 'BISTER'],
+      [0x001fdff, 'GRANT', 'KUZIEL'],
+      [0x000feff, 'ALTON', 'THOMPON'],
+      [0x10003fb, 'VELMA', 'SWILLE'],
+      [0x08001fd, 'DON', 'DEBRECHT'],
+      [0x14000fe, 'TARA', 'VAUGHNS'],
+      [0x0a0007e, 'HEATH', 'RUSHTON'],
+      [0x050003e, 'BRUCE', 'PHEONIX'],
+      [0x028001e, 'KURT', 'VEAZEY'],
+      [0x014000e, 'DEWEY', 'MOHSENI'],
+      [0x00a0006, 'ELI', 'DEWEY'],
+      [0x1050002, 'ROSA', 'HULAN'],
+      [0x0828000, 'JESUS', 'PONTON'],
+      [0x1413fff, 'MABEL', 'THURSBY'],
+      [0x0a09fff, 'HEATH', 'ZEHNDER'],
+      [0x0504fff, 'BRUCE', 'BARTOLO'],
+      [0x02827ff, 'KURT', 'MCCLEE'],
+      [0x01413ff, 'DEWEY', 'PASKELL'],
+      [0x00a09ff, 'ELI', 'HASFJORD'],
+      [0x00504ff, 'KARL', 'ANIBAL'],
+      [0x002827f, 'GARRY', 'SHALA'],
+      [0x001413f, 'GRANT', 'HIEBER'],
+      [0x000a09f, 'ALTON', 'PERIGO'],
+    ]
+    seq = []
+    ix = 1
+    (1..50).each do |_|
+      ix, first, last = tuple = @generator.generate(ix)
+      #puts "[0x#{sprintf("%07x", ix)}, '#{first}', '#{last}'],"
+      seq << tuple
+    end
+    assert_equal expected, seq
+  end
+
+  def test_generates_a_name_for_the_initial_round
+    assert_equal [16777216, "VELMA", "PRATICO"], @generator.generate(1)
+  end
+
+  def test_generates_a_name_for_the_last_round
+    assert_equal [32766, "ALTON", "MCCORY"], @generator.generate((2**25) - 2)
+  end
+
+  def test_generates_a_name_for_each_value_in_a_sequence
+    @random.step(@random + TEST_ITERATIONS, 1) do |i|
+      @generator.generate(i)
+    end
+  end
+
+  def test_generates_non_repeating_index_sequence
+    test_hash = {}
+    ix = 1
+    @random.step(@random + TEST_ITERATIONS, 1) do |i|
+      ix = @generator.next_lfsr25(ix)
+      if test_hash.include? ix
+        fail("Found duplicated index #{ix} (iteration #{i})")
+      else
+        test_hash[ix] = 1
+      end
+    end
+  end
+
+  def test_never_generates_two_same_names
+    test_hash = {}
+    ix = old_ix = 1
+    @random.step(@random + TEST_ITERATIONS, 1) do |i|
+      ix, first, last = @generator.generate(ix)
+      hash = first + last
+      if test_hash.include? hash
+        fail("Found duplicated name #{fn} #{sn} index #{old_ix}->#{ix} (iteration #{i})")
+      else
+        test_hash[hash] = 1
+      end
+      old_ix = ix
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: deacon
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Lukas Zapletal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: Provides human readable name using continious LFSR
+email:
+- lukas-x@zapletalovi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/deacon/random_generator.rb
+- lib/deacon/mac_generator.rb
+- lib/deacon/generator.rb
+- lib/deacon/version.rb
+- lib/deacon.rb
+- data/gmnames.txt
+- data/srnames.txt
+- data/gfnames.txt
+- LICENSE
+- Rakefile
+- README.md
+- test/unit/mac_generator_test.rb
+- test/unit/random_generator_test.rb
+- test/test_helper.rb
+homepage: https://github.com/lzap/deacon
+licenses:
+- GPLv3
+- Public domain
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Human readable random name generator
+test_files:
+- test/unit/mac_generator_test.rb
+- test/unit/random_generator_test.rb
+- test/test_helper.rb
+has_rdoc: