deacon 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e187b773ec2162047c39e1361e68fcb92ae4286c
-  data.tar.gz: 40793e79b031f8a96dcdff81b4dbcf5bea4e9d57
+  metadata.gz: 0e50e2def3625ec24af7c8fc01d515ba4c4868d0
+  data.tar.gz: 9d4207b7f4d061aeedc62da00234d9abf3094a2e
 SHA512:
-  metadata.gz: 021b67ba552a35c6d6db59369ffb58f9322855706d132b72379c0af63d51995600a706863ef9b9d10999dc9d8bb3bae78b1d3d8843ba3850e7760a636d23ff08
-  data.tar.gz: 8b0e6d3bfafe6a61ce7a2f90b80fd455390bc0d29545fdbf6c73032e3ae8703f979f05436700c8345d8c286c7f36836b721ef2e7c06295d6b987fc166677e8da
+  metadata.gz: 4beaf81ad831e2590f1fa9b3b623b3a16963c40d0acdc19b1e2a905d20fe0ae6d87961bfff8bec8b0b7a74e6a20bbdbed55ae98f4651d1357f05c59023375063
+  data.tar.gz: 02818a6a6d50101d801b4e982727076de7f76334b3bf7de6c053253226a46e046594d17173abfa5f27a8bd8338a1f72072fcec2164e5ad6e8218da7a3954bd00

data/README.md

@@ -1,4 +1,4 @@
-# Deacon - human readable random name generator
+# [Deacon](https://rubygems.org/gems/deacon) - human readable random name generator
 
 Out of ideas for incoming bare-metal host names in your cluster? This little
 gem is a way out! It contains frequently occurring given names and surnames
@@ -19,12 +19,10 @@ combinations based on MAC adresses.
 
 The random name generator makes use of [Fibonacci linear feedback shift
 register](https://en.wikipedia.org/wiki/Linear_feedback_shift_register) which
-gives deterministic sequence of pseudo-random numbers. Additionally, algorighm
+gives deterministic sequence of pseudo-random numbers. Additionally, algorithm
 makes sure names with same first name (or gender) and last name are not
 returned in succession. Since there are about 1% of such cases, there are
-about 33 million unique total names. During plugin installation, the register
-is seeded with a random value, so each installation gets unique sequence.
-Example sequence:
+about 33 million unique total names. Example sequence:
 
 * velma-pratico.my.lan
 * angie-warmbrod.my.lan
@@ -34,10 +32,13 @@ Example sequence:
 * don-otero.my.lan
 * sam-hulan.my.lan
 
-The polynomial used in linear feedback shift register is x^25 + x^24 + x^23 + x^22 + 1.
+The polynomial used in linear feedback shift register is
+
+	x^25 + x^24 + x^23 + x^22 + 1.
 
 The key thing is to store register (a number) and use it for each generation
-in order to get non-repeating sequence of name combinations.
+in order to get non-repeating sequence of name combinations. See an example
+below.
 
 ### MAC generator
 
@@ -91,6 +92,11 @@ Example output:
 	PATSY CUSSON
 	HUGH SHIMER
 
+By default, same firstname or surname successions are removed. To avoid that
+behavior (e.g. in stateless applications where you can't store register), use
+
+	register, firstname, lastname = generator.generate(register, false)
+
 Random LFSR generator example:
 
 	require "deacon"

data/lib/deacon/random_generator.rb

@@ -13,12 +13,12 @@ module Deacon
       i - 1
     end
 
-    def generate(seed = Time.now.utc.to_i)
+    def generate(seed = Time.now.utc.to_i, test_uniquess = true)
       return [] if seed.nil? || seed == 0
       index = seed
       loop do
         index = next_lfsr25(index)
-        break if unique?(seed, index)
+        break if !test_uniquess || unique?(seed, index)
       end
       given_file = (index & 0x1000000) == 0 ? GIVEN_MALE_NAMES_FILE : GIVEN_FEMALE_NAMES_FILE
       givenname_ix = (index & 0xff0000) >> 16

data/lib/deacon/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deacon
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Lukas Zapletal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides human readable name using continious LFSR
+description: Provides human readable names using continious LFSR
 email:
 - lukas-x@zapletalovi.com
 executables: []