composite_rng 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1f340e108ce670dca8fd91ec9089ae5753eae06e
-  data.tar.gz: b992ad5f3defe4e2578090833730107b256bfc89
+SHA256:
+  metadata.gz: 8f212582253e788745139e57da549a2fe5e682a7117171a867d6e5b52e0a1f3a
+  data.tar.gz: 1994196919e99dd6da03bc3264307b4f15c6b9b530d3413dff16ba4d260dac9d
 SHA512:
-  metadata.gz: 1731dee7aeb11ec2f9006853c038211c89afcaa4a5e4e9f4e6b3f74e24339218d39c2108e270feea0b05aa01a9f6277d365fb27b59e1397d2799f06d314f828d
-  data.tar.gz: cf12a60cc2dba80842ef8f2e73dede341cb0a7e6766f1800a6bec6f16b00fbf3a2dd030f7e380818288f3670120f1d12a18d824985ea45dce084da9176f947a4
+  metadata.gz: f42e03369535712d75033f3f223726b8650917acf69cc5b4a02f314602af276d9a89a8b16acbd8f06d5dcfd7fed0ef8b9a5f131191afa0ce6d33780b1ec6f16a
+  data.tar.gz: 64d58b974b59f75059f0f448bdb9df0fac85128763aa6e717c14076d4477a0c693036b5b2f2ede4c475585f0226c5aeeb0125e4ad11b10979e5a6d1b17e29348

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at peter.c.camilleri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -1,53 +1,68 @@
 # CompositeRng
 
 The composite (psuedo) random number generator is a container for two other
-(psuedo) random number generators. By working together, these create higher
-quality pseudo-random number streams than either could by itself.
+(psuedo) random number generators. By working together, these generators
+create higher quality pseudo-random number streams than either could create
+by itself.
 
-The two generators do not need to be the same type. In fact it helps to reduce
-any possible correlation between the parent and the child if they are
-completely different sorts of generators. It is really not a good idea for them
-to be either the same instance, or the same type with the same seed, because
-this negates the advantage of compositing generators.
+## Installation
+
+Add this line to your application's Gemfile:
 
-The generators used must comply to the following duck characteristics:
+    gem 'composite_rng'
 
-    rand(max) - This method must compute a random integer from 0...max
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install composite_rng
+
+The composite_rng gem itself is found at: ( https://rubygems.org/gems/composite_rng )
 
-The constructor takes four arguments:
-* The parent PRNG that is used to "educate" the child.
-* The child PRNG that is the actual generator of data.
-* The optional churn_limit factor that controls how much tutoring the child
-can receive. This optional parameter defaults to 16. This value may be read
-back with the churn_limit property. Valid values are 2..256
-* The optional init factor that controls the amount of initial tutoring the
-child receives initially. This defaults to 0 for none. Valid values are 0..256
+##Usage
 
-The following shows how this could work:
 ```ruby
-parent = Random.new #Get the built in Mersenne Twister MT19937 PRNG
-child  = Random.new
-composite = CompositeRng.new(parent, child, 42, 11)
-# ...
-dice_roll = 1 + composite.rand(6)
-# ...
+require 'composite_rng'
 ```
 
-It is also possible to use the default PRNG as follows:
+Then in an appropriate place in the code:
+
 ```ruby
-parent = Object.new
+@my_rng = CompositeRng.new(parent, child, churn, init)
+```
+Where:
+* parent is a random number generator used to educate the child.
+* child is the random number generator used to generate the output.
+* churn is the limit on the education process. Default 16, Range 2..256
+* init is the number of initial churns done during initialization. Default 0, Range 0..256
+
+The parent and child generators do not need to be the same type. In fact it
+helps to reduce any possible correlation between the parent and the child
+if they are completely different sorts of generators. It is a really bad
+idea for them to be either the same instance, or the same type with the same
+seed, because this negates the advantage of compositing generators.
+
+To be used in a composite generator, both generators used must implement the
+following method:
+
+    rand(max)
+
+which method must return a pseudo-random integer in 0...max.
+
+The following are examples of this class in action.
+```ruby
+parent = Random.new #Get the built in Mersenne Twister MT19937 PRNG
 child  = Random.new
-composite = CompositeRng.new(parent, child)
+composite = CompositeRng.new(parent, child, 42, 11)
 # ...
 dice_roll = 1 + composite.rand(6)
 # ...
 ```
-This is because the default PRNG exists as methods of Object. Note that (as
-far as I can tell) only one instance of that PRNG exists, so it should only
-be used as parent or child but never both!.
 
-The composite generator also works with custom generator, that support rand(n)
-like my own Fibonacci generator:
+The composite generator also works with custom generators that support rand(n).
+For example my own Fibonacci generator:
 
 ```ruby
 parent = Random.new
@@ -77,24 +92,6 @@ more thorough job:
 crazy_string = 22.times.inject("") { |s| s << composite.churn.bytes(1) }
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'composite_rng'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install composite_rng
-
-The composite_rng gem itself is found at: ( https://rubygems.org/gems/composite_rng )
-
-The fibonacci_rng code lives at: ( https://github.com/PeterCamilleri/fibonacci_rng )
-
 ## Contributing
 
 #### Plan A
@@ -109,3 +106,14 @@ The fibonacci_rng code lives at: ( https://github.com/PeterCamilleri/fibonacci_r
 
 Go to the GitHub repository and raise an issue calling attention to some
 aspect that could use some TLC or a suggestion or an idea.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the fully_freeze project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/composite_rng.gemspec

@@ -23,10 +23,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", ">= 2.1.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency 'reek', "~> 1.3.8"
   spec.add_development_dependency 'minitest', "~> 5.8"
   spec.add_development_dependency 'rdoc', "~> 4.0.1"
-  spec.add_development_dependency 'minitest_visible', ">= 0.1.0"
 end

data/irbt.rb

@@ -2,8 +2,6 @@
 # An IRB + composite_rng Test bed
 
 require 'irb'
-$force_alias_read_line_module = true
-require 'mini_readline'
 
 puts "Starting an IRB console with composite_rng loaded."
 

data/lib/composite_rng/version.rb

@@ -1,4 +1,4 @@
 class CompositeRng
   #The CompositeRng version.
-  VERSION = "0.1.0"
+  VERSION = "0.1.5".freeze
 end

data/tests/composite_rng_tests.rb

@@ -3,14 +3,10 @@
 require_relative '../lib/composite_rng'
 gem              'minitest'
 require          'minitest/autorun'
-require          'minitest_visible'
 
 #Test the monkey patches applied to the Object class.
 class CompositeRngTester < Minitest::Test
 
-  #Track mini-test progress.
-  include MinitestVisible
-
   def test_that_it_checks_parms
     assert_raises { CompositeRng.new(Random.new, Random.new,  -1, 0) }
     assert_raises { CompositeRng.new(Random.new, Random.new, 300, 0) }

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: composite_rng
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.1
-- !ruby/object:Gem::Dependency
-  name: minitest_visible
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.0
 description: A composable random number generator.
 email:
 - peter.c.camilleri@gmail.com
@@ -102,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -131,10 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: A composable random number generation class.
 test_files: []
-has_rdoc: