fair_random 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 todesking
+
+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,64 @@
+# FairRandom
+
+FairRandom is random number generator that outputs more 'fair' numer serquence than true random.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fair_random'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fair_random
+
+## Usage
+
+### FairRandom::Box
+
+`FairRandom::Box.new(N, M)` generates numbers that in range 0 to N-1(incusive).
+There is M numbers in the box and occurence of any number is same, M/N.
+Each `next` called, box will remove a element and return it.
+If box is empty, box contents will regenerate.
+
+(NOTE: M % N should == 0)
+
+```ruby
+# Example
+require 'fair_random'
+
+class FairCoinToss
+  def initialize
+    @rng = FairRandom::Box.new(2, 10)
+  end
+
+  # return 0 or 1
+  def toss!
+    @rng.next
+  end
+end
+
+#### Serialize state
+
+ You can serialize random state with to_poro/from_poro (with to_json or Marshal etc if needed).
+
+```ruby
+other_instance = FairRandom::Box.from_poro(random.to_poro)
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## Changes
+
+# 0.0.1
+* initial: FairRandom::Box

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fair_random.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fair_random/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fair_random"
+  spec.version       = FairRandom::VERSION
+  spec.authors       = ["todesking"]
+  spec.email         = ["discommunicative@gmail.com"]
+  spec.description   = %q{"Fair" random number generator}
+  spec.summary       = %q{"Fair" random number generator}
+  spec.homepage      = "https://github.com/todesking/fair_random"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-given"
+  spec.add_development_dependency "count_by"
+  spec.add_development_dependency "1_as_identity_function"
+end

data/lib/fair_random.rb

@@ -0,0 +1,47 @@
+require "fair_random/version"
+
+module FairRandom
+  class Box
+    def initialize(element_type_count, box_capacity)
+      raise ArgumentError if box_capacity % element_type_count != 0
+      @element_type_count = element_type_count
+      @box_capacity = box_capacity
+      reset_contents
+    end
+
+    def next
+      reset_contents if @index >= @contents.size
+      c = @contents[@index]
+      @index += 1
+      c
+    end
+
+    # Convert to PORO(Plain Old Ruby Object) for serialize.
+    def to_poro
+      {
+        'type_count' => @element_type_count,
+        'box_capacity' => @box_capacity,
+        'contents' => @contents,
+      }
+    end
+
+    def self.from_poro(poro)
+      instance = new(poro['type_count'], poro['box_capacity'])
+      instance.instance_eval do
+        @contents = poro['contents']
+      end
+      instance
+    end
+
+    private
+      def reset_contents
+        @contents = []
+        @index = 0
+        # type_index => count
+        @element_type_count.times do|type|
+          @contents.concat([type] * (@box_capacity / @element_type_count))
+        end
+        @contents = @contents.shuffle
+      end
+  end
+end

data/lib/fair_random/version.rb

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

data/spec/fair_random_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe FairRandom do
+  describe 'Box' do
+    Given(:box) { FairRandom::Box.new(element_type_count, box_capacity) }
+    context 'box size == type count' do
+      describe 'content count' do
+        Given(:box_capacity) { 4 }
+        Given(:element_type_count) { 2 }
+        When(:box_contents) { box_capacity.times.map { box.next } }
+        Then { box_contents.count_by(&1) == {0 => 2, 1 => 2} }
+      end
+      describe 'reset contents' do
+        Given(:box_capacity) { 4 }
+        Given(:element_type_count) { 2 }
+        When(:box_contents) { (box_capacity * 2).times.map { box.next } }
+        Then { box_contents.count_by(&1) == {0 => 4, 1 => 4} }
+      end
+    end
+    context 'box size MOD type count != 0' do
+      Given(:box_capacity) { 3 }
+      Given(:element_type_count) { 2 }
+      Then { expect{box}.to raise_error ArgumentError }
+    end
+    context 'serialize/deserialize with PORO' do
+      Given(:box_capacity) { 4 }
+      Given(:element_type_count) { 2 }
+      Given(:poro) { box.to_poro }
+      Given(:revived) { FairRandom::Box.from_poro(poro) }
+      When(:box_contents) { (box_capacity * 2).times.map { revived.next } }
+      Then { box_contents.count_by(&1) == {0 => 4, 1 => 4} }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec/given'
+require 'count_by'
+require '1_as_identity_function'
+require_relative '../lib/fair_random.rb'
+
+def scenario(*args)
+  context(*args)
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: fair_random
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- todesking
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: count_by
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: 1_as_identity_function
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '"Fair" random number generator'
+email:
+- discommunicative@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fair_random.gemspec
+- lib/fair_random.rb
+- lib/fair_random/version.rb
+- spec/fair_random_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/todesking/fair_random
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ! '"Fair" random number generator'
+test_files:
+- spec/fair_random_spec.rb
+- spec/spec_helper.rb