fibonacci_rng 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edf23cfb2d3c1fe1ce559fce4092779edb32ab88
-  data.tar.gz: 7df57182ab93e8c7256e9ace1624006a7a90c52a
+  metadata.gz: 9c8a1e946cc05b8a0f7ef15c0f9f332f7170c1a8
+  data.tar.gz: 69703e8ba9a17e3abb5b1cfbd67a91da806e8f7f
 SHA512:
-  metadata.gz: 21a5a5033f1596615ed750d0aae39e8ea57bbe926d3f16e7b51909c2a232836a900ea544ce3707654e9e1369ef40e3c9001a5dacdb1dd63c0e6f2e800269e861
-  data.tar.gz: eb4b5154352662c05f5535b975e33bfa09b208f6b9cb1781f85e50dddcc1ebb53abacc99534b9a49a2170e30608cbbe3e3f12ba7e469470874dcc43074289d42
+  metadata.gz: 9b285d3413bb9e669ca12030af0050672de993c0d65cf188cd25102a02d07b5df08c3091d7bf7d2f216d4d0a2b520243c0172494d62109c6ddeb738d0cda27da
+  data.tar.gz: 07d897637e993f0bb05088f8e336851e9f51177326dac0922de78b1bf63a09cef4e6af9cfe4c612a8dad4367b911e660f97a91340a5bb067f56097471792f9c7

data/README.md

@@ -23,47 +23,78 @@ Or install it yourself as:
 
 ## Usage
 
-    require 'fibonacci_rng'
+```ruby
+require 'fibonacci_rng'
+```
 
 Then in an appropriate place in the code:
 
-    @my_rng = FibonacciRng.new(depth, seed_value)
+```ruby
+@my_rng = FibonacciRng.new(depth, seed_value)
+```
 
-Where depth is an optional integer value between 3 and "are you kidding" and
-the seed value is a number or string or other object that has a repeatable
-value. You can also get a "random" generator of the default depth (8) and a
-randomized seed by using:
+Where depth is an optional integer value between 2 and 99 and the seed value
+is a number or string or other object that has a repeatable value. You can
+also get a "random" generator of the default depth (8) and a randomized
+seed. Here is an overview of the available options.
 
-    @my_rng = FibonacciRng.new
+```ruby
+@my_rng = FibonacciRng.new                            # Random seed, depth = 8
+@my_rng = FibonacciRng.new(seed)                      # Specified seed, depth = 8
+@my_rng = FibonacciRng.new(seed, 12)                  # Specified seed, depth = 12
+@my_rng = FibonacciRng.new(FibonacciRng.new_seed, 12) # Random seed, depth = 12
+
+```
 
 To get some data out here are some options:
 
-    @my_rng.dice(100)     # A "random" integer between 0 and 99
-    @my_rng.byte          # A "random" integer between 0 and 255
-    @my_rng.word          # A "random" integer between 0 and 65535
-    @my_rng.float         # A "random" float between 0 and less than 1.
+```ruby
+@my_rng.dice(100)     # A "random" integer between 0 and 99
+@my_rng.byte          # A "random" integer between 0 and 255
+@my_rng.word          # A "random" integer between 0 and 65535
+@my_rng.float         # A "random" float between 0 and less than 1.
+```
 
 and also available
 
-    @my_rng.reseed(value) # Reseed the sequence with the new value.
-    @my_rng.reseed        # Reseed the sequence with a "random" seed.
-    @my_rng.spin(count)   # Spin the generator count times.
-    @my_rng.spin          # Spin the generator once.
+```ruby
+@my_rng.reseed(value) # Reseed the sequence with the new value.
+@my_rng.reseed        # Reseed the sequence with a "random" seed.
+@my_rng.spin(count)   # Spin the generator count times.
+@my_rng.spin          # Spin the generator once.
+```
 
 If more than one stream of numbers is required, it is best to use multiple
-instances of FibonacciRng objects rather than rely on one.
+instances of FibonacciRng objects rather than rely on one. This will help avoid
+the two streams of data being correlated.
 
 ### Hashing
 
 As more as an experiment than anything else, it is also possible to use
 the generator as a primitive hash generator. To do so, create a new
 generator with a salt value, append data to it, and the retrieve the results
-as a (big) number of or a string.
-
-    fib = FibonacciRng.new('salt')
-    fib << "The quick brown fox jumps over the lazy dog."
-    puts fib.hash_string
-    #displays: j5jqhk7ntrze02icv38gj28efa2qrctr6mi5ejbr2p4nj
+as a (big) number or a string.
+
+```ruby
+fib = FibonacciRng.new('salt')
+fib << "The quick brown fox jumps over the lazy dog."
+puts fib.hash_string
+#displays: j5jqhk7ntrze02icv38gj28efa2qrctr6mi5ejbr2p4nj
+```
+Note that the length of the hash string is a function of the depth of the
+generator used to create it. This is about 5.5 characters per unit of depth.
+
+### Salting
+
+Another (more practical) use for the Fibonacci generator is the creation of
+salting strings for use in more capable hashing schemes. Here are some possible
+ways that this can be done:
+
+```ruby
+salt_string = FibonacciRng.new.hash_string
+salt_string = FibonacciRng.new(FibonacciRng.new_seed, 12).hash_string()
+```
+Each time any of these is run, a different salt string will be generated.
 
 ## Contributing
 

data/lib/fibonacci_rng.rb

@@ -38,7 +38,7 @@ class FibonacciRng
 
   #Initialize the PRN generator
   def initialize(seed=FibonacciRng.new_seed, depth=8)
-    fail "Invalid depth value (3..30)." unless (3..30) === depth
+    fail "Invalid depth value (2..99)." unless (2..99) === depth
     @depth = depth
     srand(seed)
   end
@@ -134,14 +134,17 @@ class FibonacciRng
   #A class instance variable to hold the tickle value.
   @tickle = '0'
 
+  #A synchronizer for access to the @tickle variable
+  @sync = Mutex.new
+
   #Create the default seed string.
   def self.new_seed
-    Time.now.to_s + @tickle.succ!
+    @sync.synchronize {Time.now.to_s + @tickle.succ!}
   end
 
   #Do the work of reseeding the PRNG
   def do_reseed(indxsrc, seedsrc)
-    1024.times do
+    (128*@depth).times do
       @buffer[indxsrc.next] += seedsrc.next
       do_spin
     end

data/lib/fibonacci_rng/version.rb

@@ -2,5 +2,5 @@
 
 #The class of Fibonacci inspired random number generators.
 class FibonacciRng
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/{Rakefile → rakefile.rb}

@@ -4,7 +4,7 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
-#Run the fOOrth unit test suite.
+#Run the Fibonacci unit test suite.
 Rake::TestTask.new do |t|
   #List out all the test files.
   t.test_files = FileList['tests/**/*.rb']
@@ -16,7 +16,7 @@ task :reek do |t|
   `reek --no-color lib > reek.txt`
 end
 
-desc "What version of fOOrth is this?"
+desc "What version of the Fibonacci is this?"
 task :vers do |t|
   puts
   puts "Fibonacci random number generator version = #{FibonacciRng::VERSION}"

data/tests/fibinacci_rng_tests.rb

@@ -11,6 +11,12 @@ class FibonacciRngTester < Minitest::Test
   #Track mini-test progress.
   include MinitestVisible
 
+
+  def test_that_rejects_bad_parms
+    assert_raises { FibonacciRng.new('seed', 1) }
+    assert_raises { FibonacciRng.new('seed', 65536) }
+  end
+
   def test_that_it_creates_dice_rolls
     prng = FibonacciRng.new
 
@@ -101,4 +107,15 @@ class FibonacciRngTester < Minitest::Test
 
     assert(buffa == buffb)
   end
+
+  def test_that_it_creates_unique_seeds
+    result = []
+    10_000.times do
+      result << FibonacciRng.new_seed
+    end
+
+    result.uniq!
+    assert_equal(10_000, result.length)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fibonacci_rng
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest_visible
@@ -106,11 +106,11 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - fibonacci_rng.gemspec
 - lib/fibonacci_rng.rb
 - lib/fibonacci_rng/version.rb
 - prng.rb
+- rakefile.rb
 - reek.txt
 - tests/fibinacci_rng_tests.rb
 - tests/hasher_tests.rb