newcomb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b718f0e37121533e31fe9c789e912422c12406f2
+  data.tar.gz: 49c5cb53702a3f6f8db7f2cb34c0fea50d732337
+SHA512:
+  metadata.gz: 57922988b4fc725ff86fc6d591e6398c86fdfbf378ef7aa627031834d0b979c7b5ef7dbfb68303513849eb671f417867bda55d8b17e6ac056746426b3646c81f
+  data.tar.gz: e5b2a92ddc77101a22f7899c8f1a70433cd5b16d4e991c2940da091bd510f51f2643414823737775d6733cf5512bb72ff41d25339f62d919ecc66687714988ea

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--order random
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,19 @@
+branches:
+  only:
+    - master
+env:
+  global:
+    secure: | # CODECLIMATE_REPO_TOKEN
+      XnaAxp9pN9OR+jSyLUXQwKkMVcUfNy+7muWXKLQRi/zIh2ObGBCEXTww/8mP
+      hwv4Rf8a4n7+gpQhmv6MEx3xwdArkxLChs1EX79XGNN9/g/DBPtfoiKB3FLd
+      UUJTuPurAlOklt/s+XvJTV5h50ThpvutSqkSenO5me8v/ODO6hw=
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+rvm:
+  - 1.9.3
+  - "2.0"
+  - "2.1"
+  - ruby-head
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "codeclimate-test-reporter", require: false
+  gem "rspec", "~> 3.0"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Steve Richert
+
+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,36 @@
+# Newcomb
+
+Generate random numbers that adhere to [Benford's Law](http://en.wikipedia.org/wiki/Benford's_law)
+
+[![Gem Version](https://img.shields.io/gem/v/newcomb.svg?style=flat)](http://rubygems.org/gems/newcomb)
+[![Build Status](https://img.shields.io/travis/laserlemon/newcomb/master.svg?style=flat)](https://travis-ci.org/laserlemon/newcomb)
+[![Code Climate](https://img.shields.io/codeclimate/github/laserlemon/newcomb.svg?style=flat)](https://codeclimate.com/github/laserlemon/newcomb)
+[![Code Coverage](http://img.shields.io/codeclimate/coverage/github/laserlemon/newcomb.svg?style=flat)](https://codeclimate.com/github/laserlemon/newcomb)
+[![Dependency Status](https://img.shields.io/gemnasium/laserlemon/newcomb.svg?style=flat)](https://gemnasium.com/laserlemon/newcomb)
+
+## Usage
+
+Newcomb works very much like `Kernel.rand` or `SecureRandom.random_number`. In
+order to fetch a random float between 0 (inclusive) and 1 (exclusive):
+
+```ruby
+Newcomb.random_number # => 0.49552091973604767
+```
+
+To fetch a random positive integer, provide the upper (exclusive) limit:
+
+```ruby
+Newcomb.random_number(100) # => 16
+```
+
+Over a sufficiently large sample size, the distribution of Newcomb's random
+numbers will demonstrate Benford's Law.
+
+## History
+
+While Benford's Law is named after American scientist [Frank Benford](http://en.wikipedia.org/wiki/Frank_Benford),
+the principle was original discovered by [Simon Newcomb](http://en.wikipedia.org/wiki/Simon_Newcomb)
+over fifty years earlier. In addition to his numerous accomplishments in
+mathematics and astronomy, Newcomb had a fantastic beard.
+
+![Exhibit A](http://upload.wikimedia.org/wikipedia/commons/thumb/9/92/Simon_Newcomb_01.jpg/640px-Simon_Newcomb_01.jpg)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/newcomb.rb

@@ -0,0 +1,11 @@
+require "securerandom"
+
+module Newcomb
+  def self.random_number(n = 0)
+    if n > 0
+      (random_number * n).floor
+    else
+      (10 ** SecureRandom.random_number - 1) / 9
+    end
+  end
+end

data/newcomb.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name    = "newcomb"
+  spec.version = "1.0.0"
+
+  spec.author      = "Steve Richert"
+  spec.email       = "steve.richert@gmail.com"
+  spec.summary     = "Generate natural random numbers"
+  spec.description = "Generate random numbers that adhere to Benford's Law"
+  spec.homepage    = "https://github.com/laserlemon/newcomb"
+  spec.license     = "MIT"
+
+  spec.files      = `git ls-files -z`.split("\x0")
+  spec.test_files = spec.files.grep(/^spec/)
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+end

data/spec/newcomb_spec.rb

@@ -0,0 +1,68 @@
+describe Newcomb do
+  describe ".random_number" do
+    let(:sample_size) { 1_000_000 }
+
+    def assert_benford(&block)
+      distribution = build_distribution(&block)
+
+      expect(distribution.keys).to match_array([1, 2, 3, 4, 5, 6, 7, 8, 9])
+
+      distribution.sort.each do |i, count|
+        expect(distribution[i]).to be_within(tolerance(i)).of(expected_count(i))
+      end
+    end
+
+    def build_distribution(&block)
+      sample_size.times.with_object({}) do |_, memo|
+        digit = block.call
+        memo[digit] ||= 0
+        memo[digit] += 1
+      end
+    end
+
+    def build_sample(&block)
+      sample_size.times.map(&block)
+    end
+
+    # TODO: Update to assert adherence to within one standard deviation
+    def tolerance(digit)
+      (expected_count(digit) * 0.01).round
+    end
+
+    def expected_count(digit)
+      (((Math.log(digit + 1) - Math.log(digit)) / Math.log(10)) * sample_size).round
+    end
+
+    context "when given no arguments" do
+      it "falls between zero (inclusive) and one (exclusive)" do
+        sample = build_sample { Newcomb.random_number }
+
+        expect(sample.map(&:class).uniq).to eq([Float])
+        expect(sample.map(&:floor).uniq).to eq([0])
+      end
+
+      it "is distributed according to Benford's law" do
+        assert_benford do
+          (Newcomb.random_number * 9).floor + 1
+        end
+      end
+    end
+
+    context "when given an argument" do
+      it "falls between zero (inclusive) and the given number (exclusive)" do
+        sample = sample_size.times.map { Newcomb.random_number(13) }
+
+        expect(sample.map(&:class).uniq).to eq([Fixnum])
+        floors = sample.map(&:floor)
+        expect(floors.min).to be >= 0
+        expect(floors.max).to be < 13
+      end
+
+      it "is distributed according to Benford's law" do
+        assert_benford do
+          Newcomb.random_number(9) + 1
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+if ENV["CODECLIMATE_REPO_TOKEN"]
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require "newcomb"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: newcomb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steve Richert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: Generate random numbers that adhere to Benford's Law
+email: steve.richert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/newcomb.rb
+- newcomb.gemspec
+- spec/newcomb_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/laserlemon/newcomb
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Generate natural random numbers
+test_files:
+- spec/newcomb_spec.rb
+- spec/spec_helper.rb