easystats 0.2.0 → 0.3.0

data/.gitignore

@@ -2,3 +2,4 @@ pkg/*
 *.gem
 .bundle
 Gemfile.lock
+coverage/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -2,7 +2,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - rbx-2.0
+  - rbx
   - jruby
   - ruby-head
   - ree

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source :rubygems
 
 gemspec
 

data/Guardfile

@@ -1,5 +1,6 @@
-guard :test do
-  watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
-  watch(%r{^test/.+_test\.rb$})
-  watch('test/test_helper.rb')  { "test" }
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
 end
+

data/README.md

@@ -0,0 +1,51 @@
+# Easystats [![Build Status](https://secure.travis-ci.org/mgrigajtis/easystats.png)](https://secure.travis-ci.org/mgrigajtis/easystats) 
+
+> Created by [Matthew Grigajtis](http://www.matthewgrigajtis.com)
+
+Provides easy to use statistical functions to use on an array 
+
+## Install
+
+In your shell:
+
+```sh
+gem install easystats
+```
+
+or in your Gemfile:
+
+```rb
+gem 'easystats'
+```
+
+## Example
+
+```rb
+require 'easystats'
+
+array = [4, 8, 15, 16, 23, 42, 42]
+
+%w[
+  average
+  median
+  mode
+  range
+  standard_deviation
+  sum
+  variance
+].each do |method|
+  puts "#{method}: #{array.send(method.to_sym)}"
+end
+```
+
+This will result in:
+
+```sh
+average: 21.428571428571427
+median: 16
+mode: 42
+range: 38
+standard_deviation: 15.295501984321435
+sum: 150
+variance: 200.53061224489798
+```

data/Rakefile

@@ -4,12 +4,11 @@ require 'rake/testtask'
 
 Bundler::GemHelper.install_tasks
 
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Run unit tests.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/*_test.rb'
-  t.verbose = true
-end
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+

data/easystats.gemspec

@@ -1,8 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "easystats/version"
-require "complex"
-include Math
 
 Gem::Specification.new do |s|
   s.name        = "easystats"
@@ -21,5 +19,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "guard-test"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov" 
 end

data/lib/easystats.rb

@@ -1,169 +1,143 @@
 class Array
+  # take in an array of numbers and calculate the mean (average)
+  def mean
+    return unless self.any?
 
-    # take in an array of numbers and calculate the sum
-    def sum
-      data = self
-      sum_of_numbers = 0
+    self.sum / self.count.to_f
+  end unless Array.instance_methods.include? "mean"
+  alias_method :average, :mean unless Array.instance_methods.include? "average"
 
-      # Get the total sum only if there are actually numbers to total
-      if data.count > 0
-        data.each do |num|
-          sum_of_numbers += num
-        end
-      else
-        sum_of_numbers = 0
-      end
+  # take in the array of numbers and calculate the median
+  def median
+    return unless self.any?
 
-      sum_of_numbers
-    end unless Array.instance_methods.include? "sum"
+    data = self
 
-    # take in an array of numbers and calculate the mean (average)
-    def mean
-      data = self
-
-      # Check to make sure there are numbers to avoid division by 0
-      if data.count > 0
-        self.sum / data.count.to_f
-      else
-        0
-      end
-    end unless Array.instance_methods.include? "mean"
-    alias_method :average, :mean unless Array.instance_methods.include? "average"
-
-    # take in an array of numbers and calculate the standard deviation
-    def standard_deviation
-      data = self
-      sum_of_deviations_squared = self.sum_of_deviations_squared
-
-      if data.count > 1
-        Math::sqrt(sum_of_deviations_squared / (data.count-1))
-      else
-        0
-      end
-    end unless Array.instance_methods.include? "standard_deviation"
-
-    def variance
-      data = self
-      average = self.mean
-      sum_of_deviations = self.sum_of_deviations_squared
- 
-      if data.count > 0
-        sum_of_deviations / data.count.to_f
-      else
-        0
-      end
-    end unless Array.instance_methods.include? "variance"
+    halfway = data.count / 2
 
-    # take in the array of numbers and calculate the median
-    def median
-      data = self
+    # Sort the array
+    data = data.sort
 
-      halfway = data.count / 2
+    # The median will be different based on the number of numbers in the array
+    # If there is an even number in the array
+    if(data.count % 2) == 0
+      median = (data[halfway] + data[halfway-1]) / 2.0
 
-      # Sort the array
-      data = data.sort
+    # Else, there is an odd number of elements in the array
+    else
+      median = data[halfway]
+    end
 
-      # The median will be different based on the number of numbers in the array
-      # If there is an even number in the array
-      if(data.count % 2) == 0
-        median = (data[halfway] + data[halfway-1]) / 2.0
+    median
+  end unless Array.instance_methods.include? "median"
 
-      # Else, there is an odd number of elements in the array
-      else
-        median = data[halfway]
-      end
+  # take in an array of numbers and return the mode
+  def mode
+    return unless self.any?
 
-      median
-    end unless Array.instance_methods.include? "median"
+    # Sort the array
+    data = self.sort
 
-    # take in an array of numbers and calculate the range
-    def range
-      data = self
-      data = data.sort
-      data[data.count-1] - data[0]
-    end unless Array.instance_methods.include? "range"
+    # create a flag to tell the user if all the numbers only appear once
+    no_mode = true
 
-    # take in an array of numbers and return the mode
-    def mode
-      data = self
+    # The variable that will hold the highest number
+    highest_value = 0
 
-      # Sort the array
-      data = data.sort
+    # The variable that holds the most time the value appears
+    most_times = 0
 
-      # create a flag to tell the user if all the numbers only appear once
-      no_mode = true
+    # Create a new hash to hold the numbers
+    tmp = Hash.new
 
-      # The variable that will hold the highest number
-      highest_value = 0
-   
-      # The variable that holds the most time the value appears
-      most_times = 0
+    # Populate the hash
+    data.each do |num|
+      if tmp["#{num}"].nil? == false
+        tmp["#{num}"] = tmp["#{num}"].to_i + 1
+      else
+        tmp["#{num}"] = 1
+      end
+    end
 
-      # Create a new hash to hold the numbers
-      tmp = Hash.new
+    # Check to make sure that there is a mode
+    data.each do |num|
+      if tmp["#{num}"].to_i > 0
+        no_mode = false
+      end
+    end
 
-      # Populate the hash
+    if no_mode == true
+      nil
+    else
       data.each do |num|
-        if tmp["#{num}"].nil? == false
-          tmp["#{num}"] = tmp["#{num}"].to_i + 1
-        else
-          tmp["#{num}"] = 1
+        if tmp["#{num}"].to_i > most_times
+          highest_value = num
+          most_times = tmp["#{num}"]
         end
       end
 
-      # Check to make sure that there is a mode
+      # now loop through again just to make sure another number doesn't appear an equal number of times
       data.each do |num|
-        if tmp["#{num}"].to_i > 0
-          no_mode = false
+        if num != highest_value
+          if tmp["#{num}"].to_i == most_times
+            no_mode = true
+          end
         end
       end
- 
+
       if no_mode == true
-        0
+        nil
       else
-        data.each do |num|
-          if tmp["#{num}"].to_i > most_times
-            highest_value = num
-            most_times = tmp["#{num}"]
-          end
-        end
-
-        # now loop through again just to make sure another number doesn't appear an equal number of times
-        data.each do |num|
-          if num != highest_value
-            if tmp["#{num}"].to_i == most_times
-              no_mode = true
-            end
-          end
-        end
- 
-        if no_mode == true
-          nil
-        else
-          highest_value
-        end
+        highest_value
       end
-    end unless Array.instance_methods.include? "mode"
-    
-    protected
-    
-    # this function returns the sum of each squared difference of mean
-    def sum_of_deviations_squared
-      data = self
-
-      deviations = Array.new
-      average = self.mean
-      sum_of_deviations_squared = 0
+    end
+  end unless Array.instance_methods.include? "mode"
 
-      data.each do |num|
-        deviations.push((num-average)**2)
-      end
+  # take in an array of numbers and calculate the range
+  def range
+    return unless self.any?
 
-      deviations.each do |num|
-        sum_of_deviations_squared += num
-      end
+    data = self.sort
+    data.last - data.first
+  end unless Array.instance_methods.include? "range"
+
+  # take in an array of numbers and calculate the standard deviation
+  def standard_deviation
+    return unless self.any?
+    return 0 if self.one?
 
-      sum_of_deviations_squared
+    Math::sqrt(self.sum_of_deviations_squared / (self.count-1))
+  end unless Array.instance_methods.include? "standard_deviation"
+
+  # take in an array of numbers and calculate the sum
+  def sum
+    self.reduce { |total, number| total + number }
+  end unless Array.instance_methods.include? "sum"
+
+  def variance
+    return unless self.any?
+
+    self.sum_of_deviations_squared / self.count.to_f
+  end unless Array.instance_methods.include? "variance"
+
+  protected
+
+  # this function returns the sum of each squared difference of mean
+  def sum_of_deviations_squared
+    data = self
+
+    deviations = Array.new
+    average = self.mean
+    sum_of_deviations_squared = 0
+
+    data.each do |num|
+      deviations.push((num-average)**2)
     end
-    
+
+    deviations.each do |num|
+      sum_of_deviations_squared += num
+    end
+
+    sum_of_deviations_squared
+  end
 end

data/lib/easystats/version.rb

@@ -1,3 +1,3 @@
 module Easystats
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/lib/easystats_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Array do
+  describe "#mean" do
+    it {        [].mean.should be_nil }
+    it {       [1].mean.should ==   1 }
+    it {     [1,2].mean.should == 1.5 }
+    it {   [1,2,3].mean.should ==   2 }
+    it { [1,2,3,4].mean.should == 2.5 }
+  end
+
+  describe "#average" do
+    it { [1,2,3,4].average.should == 2.5 }
+  end
+
+  describe "#median" do
+    it {        [].median.should be_nil }
+    it {       [1].median.should ==   1 }
+    it {     [1,2].median.should == 1.5 }
+    it {   [1,2,3].median.should ==   2 }
+    it { [1,2,3,4].median.should == 2.5 }
+    it { [1,2,2,4].median.should ==   2 }
+    it { [1,3,3,4].median.should ==   3 }
+  end
+
+  describe "#mode" do
+    it {        [].mode.should be_nil }
+    it {       [1].mode.should ==   1 }
+    it {     [1,2].mode.should be_nil }
+    it {   [1,2,3].mode.should be_nil }
+    it { [1,2,3,4].mode.should be_nil }
+    it { [1,2,2,4].mode.should ==   2 }
+    it { [1,3,3,4].mode.should ==   3 }
+  end
+
+  describe "#range" do
+    it {        [].range.should be_nil }
+    it {       [1].range.should == 0 }
+    it {     [1,2].range.should == 1 }
+    it {   [1,2,3].range.should == 2 }
+    it { [1,2,3,4].range.should == 3 }
+    it { [1,2,2,4].range.should == 3 }
+    it { [1,3,3,4].range.should == 3 }
+  end
+
+  describe "#standard_deviation" do
+    let(:delta) { 0.00000000000001 }
+
+    it {        [].standard_deviation.should be_nil }
+    it {       [1].standard_deviation.should == 0 }
+    it {     [1,2].standard_deviation.should be_within(delta).of(0.707106781186548) }
+    it {   [1,2,3].standard_deviation.should be_within(delta).of(1) }
+    it { [1,2,3,4].standard_deviation.should be_within(delta).of(1.29099444873581) }
+  end
+
+  describe "#sum" do
+    it {        [].sum.should be_nil }
+    it {       [1].sum.should ==  1 }
+    it {     [1,2].sum.should ==  3 }
+    it {   [1,2,3].sum.should ==  6 }
+    it { [1,2,3,4].sum.should == 10 }
+    it { [1,2,2,4].sum.should ==  9 }
+    it { [1,3,3,4].sum.should == 11 }
+  end
+
+  describe "#variance" do
+    it {        [].variance.should be_nil }
+    it {       [1].variance.should ==     0.0 }
+    it {     [1,2].variance.should ==    0.25 }
+    it {   [1,2,3].variance.should == 2.0/3.0 }
+    it { [1,2,3,4].variance.should ==    1.25 }
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'easystats'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easystats
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,8 +13,8 @@ cert_chain: []
 date: 2012-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: guard-test
-  requirement: &70355012085360 !ruby/object:Gem::Requirement
+  name: guard-rspec
+  requirement: &70146983589700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,40 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70355012085360
+  version_requirements: *70146983589700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70146983589240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70146983589240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70146983588620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70146983588620
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70146983588020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70146983588020
 description: This gem contains statistics functions that are very easy to use.  Much
   easier and much more complete than many of the other statistical gems available
   out there.  If you need a feature added, send me a message on Github!
@@ -34,17 +67,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc
 - .travis.yml
 - Gemfile
 - Guardfile
-- README
+- README.md
 - Rakefile
 - easystats.gemspec
 - lib/easystats.rb
 - lib/easystats/version.rb
-- test/easystats_test.rb
-- test/test_helper.rb
+- spec/lib/easystats_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mgrigajtis/easystats
 licenses: []
 post_install_message: 
@@ -70,5 +104,5 @@ signing_key:
 specification_version: 3
 summary: Easy to use statistics functions
 test_files:
-- test/easystats_test.rb
-- test/test_helper.rb
+- spec/lib/easystats_spec.rb
+- spec/spec_helper.rb

data/README

@@ -1,45 +0,0 @@
-Gem Name: Easystats
-Gem Author: Matthew Grigajtis (http://www.matthewgrigajtis.com)
-Description: Provides easy to use statistical functions to use on an array 
-
-Functions Provided:
-sum
-Returns: The sum of the numbers in the array
-
-mean
-Returns: The mean (average) of the numbers in the array
-
-average
-An alias of mean
-
-standard_deviation
-Returns: The standard deviation of the numbers in the array
-
-median
-Returns: The median of the numbers in the array
-
-range
-Returns: The range of the numbers
-
-mode
-Returns: The mode.  If there is no mode returns 0.
-
-variance
-Returns: The variance
-
-Example usage:
-
-require "rubygems"
-require "easystats"
-
-# Create a test array of numbers
-myNumbers = Array.new
-myNumbers = [4, 8, 15, 16, 23, 42]
-
-puts "Range: " + myNumbers.range.to_s
-puts "Sum: " + myNumbers.sum.to_s
-puts "Average: " + myNumbers.mean.to_s
-puts "Median: " + myNumbers.median.to_s
-puts "Variance: " + myNumbers.variance.to_s
-puts "Standard Deviation: " + myNumbers.standard_deviation.to_s
-puts "Mode: " + myNumbers.mode.to_s

data/test/easystats_test.rb

@@ -1,74 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/test_helper')
-
-# TODO: autotest "Unable to map class EasystatsTest to a file"
-class EasystatsTest < Test::Unit::TestCase
-  
-  def test_mean
-    assert_equal 1,         [1].mean, "1"
-    assert_equal 1.5,     [1,2].mean, "1,2"
-    assert_equal 2,     [1,2,3].mean, "1,2,3"
-    assert_equal 2.5, [1,2,3,4].mean, "1,2,3,4"
-  end
-  
-  def test_average_synonym_for_mean
-    assert_equal 2.5, [1,2,3,4].average, "1,2,3,4"
-  end
-  
-  def test_median
-    assert_equal 1,         [1].median, "1"
-    assert_equal 1.5,     [1,2].median, "1,2"
-    assert_equal 2,     [1,2,3].median, "1,2,3"
-    assert_equal 2.5, [1,2,3,4].median, "1,2,3,4"
-    assert_equal 2,   [1,2,2,4].median, "1,2,2,4"
-    assert_equal 3,   [1,3,3,4].median, "1,3,3,4"
-  end
-  
-  def test_mode
-    assert_equal   1,       [1].mode, "1"
-    assert_equal nil,     [1,2].mode, "1,2"
-    assert_equal nil,   [1,2,3].mode, "1,2,3"
-    assert_equal nil, [1,2,3,4].mode, "1,2,3,4"
-    assert_equal   2, [1,2,2,4].mode, "1,2,2,4"
-    assert_equal   3, [1,3,3,4].mode, "1,3,3,4"
-  end
-  
-  def test_range
-    assert_equal 0,       [1].range, "1"
-    assert_equal 1,     [1,2].range, "1,2"
-    assert_equal 2,   [1,2,3].range, "1,2,3"
-    assert_equal 3, [1,2,3,4].range, "1,2,3,4"
-    assert_equal 3, [1,2,2,4].range, "1,2,2,4"
-    assert_equal 3, [1,3,3,4].range, "1,3,3,4"
-  end
-  
-  def test_sum
-    assert_equal  1,         [1].sum, "1"
-    assert_equal  3,       [1,2].sum, "1,2"
-    assert_equal  6,     [1,2,3].sum, "1,2,3"
-    assert_equal 10,   [1,2,3,4].sum, "1,2,3,4"
-    assert_equal  9,   [1,2,2,4].sum, "1,2,2,4"
-    assert_equal 11,   [1,3,3,4].sum, "1,3,3,4"
-  end
-  
-  def test_variance
-    assert_equal 0.0,           [1].variance, "1"
-    assert_equal 0.25,        [1,2].variance, "1,2"
-    assert_equal 2.0/3.0,   [1,2,3].variance, "1,2,3"
-    assert_equal 1.25,    [1,2,3,4].variance, "1,2,3,4"
-  end
-  
-  def test_standard_deviation
-    delta = 0.00000000000001
-    assert_in_delta 0,                       [1].standard_deviation, delta, "1"
-    assert_in_delta 0.707106781186548,     [1,2].standard_deviation, delta, "1,2"
-    assert_in_delta 1,                   [1,2,3].standard_deviation, delta, "1,2,3"
-    assert_in_delta 1.29099444873581,  [1,2,3,4].standard_deviation, delta, "1,2,3,4"
-  end
-  
-  def test_should_not_be_able_to_access_protected_method_sum_of_deviations_squared
-    assert_raise(NoMethodError) do
-      [1].sum_of_deviations_squared
-    end
-  end
-  
-end

data/test/test_helper.rb

@@ -1,5 +0,0 @@
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-
-require 'rubygems'
-require 'test/unit'
-require 'easystats'