benford 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.10)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tijmen Brommet
+
+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.rdoc

@@ -0,0 +1,5 @@
+= benford
+
+Little tool to check out if a dataset conforms to [url=http://en.wikipedia.org/wiki/Benford's_law]Benford's Law[/url].
+
+Usage `benford path_to_file`

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "benford"
+  gem.homepage = "http://github.com/tijmenb/benford"
+  gem.license = "MIT"
+  gem.summary = %Q{Check the distribution if first digits in a dataset}
+  gem.description = %Q{Check if a dataset conforms to Benford's Law. More info: http://en.wikipedia.org/wiki/Benford's_law}
+  gem.email = "tijmen@gmail.com"
+  gem.authors = ["Tijmen Brommet"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "benford #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/benford.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{benford}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Tijmen Brommet}]
+  s.date = %q{2011-09-20}
+  s.description = %q{Check if a dataset conforms to Benford's Law. More info: http://en.wikipedia.org/wiki/Benford's_law}
+  s.email = %q{tijmen@gmail.com}
+  s.executables = [%q{benford}]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "benford.gemspec",
+    "bin/benford",
+    "lib/benford.rb",
+    "spec/benford_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tijmenb/benford}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Check the distribution if first digits in a dataset}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/bin/benford

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby
+
+require 'pp'
+require 'lib/benford'
+
+class Float
+  def perc
+    "%.1f%" % (self * 100)
+  end
+end
+
+beginning = Time.now
+
+file = File.open(ARGV[0], "rb")
+b = Benford.new
+data = file.read.gsub(',', '').scan(/\w+/) # remove , for correct parsing of '123,456,78'
+b.load! data
+
+puts ["digit", "count", "sample", "benford", "deviation"].join("\t\t")
+
+(1..9).each do |d|
+  d = d.to_s # the digits are string
+  puts [d, b.counts[d], b.distribution[d].perc , b.law[d].perc, b.deviation[d].perc ].join("\t\t")
+end
+
+puts "-> Analysis of #{b.numbers.count} samples in #{Time.now - beginning} seconds"

data/lib/benford.rb

@@ -0,0 +1,63 @@
+class Benford
+
+  def load!(nums)
+    @numbers = []
+    nums.each do |num|
+      num.gsub!(".", "")
+      num.gsub!(",", "")
+      @numbers << num.to_s if num.is_numeric?
+    end
+  end
+  
+  # P(d) = log10(1 + 1/d)
+  def law
+    return @benford unless @benford.nil?
+    benford = {}
+    (1..9).each { |d| benford[d.to_s] = Math.log10( 1 + 1 / d.to_f) }
+    @benford = benford
+  end
+  
+  def counts
+    return @digit_counts unless @digit_counts.nil?
+    digit_counts = Hash.new(0)
+    numbers.each do |v|
+      digit_counts[v.first] += 1
+    end
+    @digit_counts = digit_counts
+  end
+  
+  def distribution
+    return @dist unless @dist.nil?
+    dist = Hash.new(0.0)
+    counts.each do |k, v|
+      dist[k] = v.to_f / numbers.count
+    end
+    @dist = dist
+  end
+  
+  def numbers 
+    @numbers
+  end
+  
+  def deviation
+    return @variants unless @variants.nil?
+    variants = Hash.new(0.0)
+    law.each do |digit, occurence|
+      variants[digit] = distribution[digit] - occurence
+    end
+    @variants = variants
+  end
+  
+end
+
+
+class String
+  
+  def first
+    self.to_i.to_s[0,1]
+  end
+  
+  def is_numeric?
+    self.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/) == nil ? false : true 
+  end
+end

data/spec/benford_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Benford do
+
+  describe "after loading" do
+    
+    before(:each) do
+     @b = Benford.new
+    end
+    
+    it "counts the correct numbers" do
+       @b.load! ["6712", "1232"]
+       @b.numbers.count.should == 2
+    end
+     
+    it "counts floats" do
+      @b.load! ["6712", "65123.1", "1232"]
+      @b.numbers.count.should == 3
+    end
+
+    it "strips strings" do
+      @b.load! ["6712345", "kjaadish", "2713678"]
+      @b.numbers.count.should == 2  
+    end
+    
+    it "converts a 1 < float into an integer" do
+      @b.load! ["0.123"]
+      @b.numbers.first.first.should == "1" # first.first is confusing, but alas
+    end
+    
+    it "does not skip commas in numbers" do
+      @b.load! ["123,212.1"]
+      @b.numbers.count.should == 1
+    end
+    
+    it "get the counts per number right" do
+      @b.load! ["18213", "2187356", "2131234", "2131234"]
+      @b.counts["1"].should == 1
+      @b.counts["2"].should == 3
+    end
+    
+    it "gets the right distribution" do
+      @b.load! ["18213", "1187356", "2131234", "2131234"]
+      @b.distribution["1"].should == 0.5
+      @b.distribution["2"].should == 0.5
+    end
+    
+    it "also get another distribution" do
+      @b.load! ["111", "111", "111", "222"]
+      @b.distribution["1"].should == 0.75 
+      @b.distribution["2"].should == 0.25 
+    end
+
+    it "and another distribution" do
+      @b.load! ["1"]
+      @b.distribution["1"].should == 1
+    end
+    
+    it "gets the correct variant from the distribution" do
+      @b.load! ["111", "111", "222", "222"]
+      @b.deviation["1"].should be_between 0.19, 0.2
+      @b.deviation["2"].should be_between 0.32, 0.33
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'benford'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: benford
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Tijmen Brommet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  name: rspec
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  name: bundler
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  prerelease: false
+  name: jeweler
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: rcov
+  version_requirements: *id004
+description: "Check if a dataset conforms to Benford's Law. More info: http://en.wikipedia.org/wiki/Benford's_law"
+email: tijmen@gmail.com
+executables: 
+- benford
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- benford.gemspec
+- bin/benford
+- lib/benford.rb
+- spec/benford_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tijmenb/benford
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Check the distribution if first digits in a dataset
+test_files: []
+