average 1.0

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 average.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Fernando
+
+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,29 @@
+# Average
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'average'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install average
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

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

data/average.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'average/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "average"
+  spec.version       = Average::VERSION
+  spec.authors       = ["Fernando"]
+  spec.email         = ["fgonzalezaguilera@gmail.com"]
+  spec.description   = %q{Find the arithmethic mean/mode/median of an array of numbers .}
+  spec.summary       = %q{Find the arithmethic mean/mode/median of an array of numbers .}
+  spec.homepage      = ""
+  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'
+end

data/lib/average.rb

@@ -0,0 +1,9 @@
+require "average/version"
+require "average/mean"
+require "average/median"
+require "average/mode"
+require "average/average_helper"
+
+module Average
+
+end

data/lib/average/average_helper.rb

@@ -0,0 +1,43 @@
+def valid_array?(array)
+  # Valid if:
+  # - the class of the parameter 'array' respond to Array
+  # - the parameter 'Array' is not null or empty.
+  # - The array given contains Integers, Floats, and Strings that could be turned to a valid digit.
+  ( array.is_a?(Array) && !array.nil? && !array.empty? && array_contain_digits?(array) )
+end
+
+def array_contain_digits?(array)
+  # Go through all elements
+  result = true
+  array.each do |array_element|
+    if not value_can_be_handled?(array_element)
+      result = false
+    end
+  end
+  result
+end
+
+def value_can_be_handled?(element)
+  # Check if the elements of the array 'look like numbers'.
+  element.is_a?(Integer) || element.is_a?(Float) || looks_like_a_digit?(element)
+end
+
+
+def looks_like_a_digit?(digit)
+  if digit.is_a?(String) && digit !~ /^\s*[+-]?((\d+_?)*\d+(\.(\d+_?)*\d+)?|\.(\d+_?)*\d+)(\s*|([eE][+-]?(\d+_?)*\d+)\s*)$/
+    # is _not_ a string that could be turned to a digit
+    false
+  else
+    # is a string that could be a digit
+    true
+  end
+end
+
+def clean_array(array)
+  array.each_with_index do |val, index|
+    if val.is_a?(String)
+      val.include?('.') ? (array[index] = val.to_f) : (array[index] = val.to_i)
+    end
+  end
+  array
+end

data/lib/average/mean.rb

@@ -0,0 +1,5 @@
+def mean(array)
+  return if !valid_array?(array)
+  array = clean_array(array)
+  array.inject(0) { |sum, x| sum += x } / array.size.to_f
+end

data/lib/average/median.rb

@@ -0,0 +1,22 @@
+def median(array)
+  return if !valid_array?(array)
+  array = clean_array(array)
+  get_median(array)
+end
+
+def get_median(array)
+  array.sort!
+  if array.length.even?
+    mean(middle_items_to_average(array))
+  else
+    array[ array.length / 2.to_f ]
+  end
+end
+
+def middle_item(array)
+  array.size / 2
+end
+
+def middle_items_to_average(array)
+  array[middle_item(array) -1 .. middle_item(array)]
+end

data/lib/average/mode.rb

@@ -0,0 +1,20 @@
+def mode(array)
+  return if !valid_array?(array)
+  array  = clean_array(array)
+  result = repetition_hash(array)
+  result[:hash_result].select { |key, value| value == result[:max_repetition] }.keys.collect { |float| float.to_i }
+end
+
+def repetition_hash(array)
+  return if !valid_array?(array)
+  array  = clean_array(array)
+  result = array.inject({}) { |key, value| key[value] = array.count(value.to_f); key }
+  { hash_result: result, max_repetition: result.values.max }
+end
+
+def unique_mode(array)
+  # only for Ruby versions bigger than 1.8.7 -> http://apidock.com/ruby/v1_8_7_72/Enumerable/max_by
+  return if !valid_array?(array)
+  array  = clean_array(array)
+  array.max_by { |x| array.count(x) }
+end

data/lib/average/version.rb

@@ -0,0 +1,3 @@
+module Average
+  VERSION = "1.0"
+end

data/spec/average_helper_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Average do
+
+  let(:valid_array)   { [3,'4.0', 5, '2', 0.3]         }
+
+  let(:invalid_array) { [3,'4.0w', 5, 'whatever', 0.3] }
+
+  describe '#valid_array?' do
+    context 'with a mixed array of valid elements' do
+      it 'should return true' do
+        expect(valid_array?(valid_array)).to be(true)
+      end
+    end
+
+    context 'with a mixed array of invalid elements' do
+      it 'should return true' do
+        expect(valid_array?(invalid_array)).to be(false)
+      end
+    end
+
+    context 'with a element that does not have an Array class' do
+      it 'should return false' do
+        expect(valid_array?('1, 3, 0.1')).to be(false)
+      end
+    end
+
+    context 'with a nil value' do
+      it 'should return false' do
+        expect(valid_array?(nil)).to be(false)
+      end
+    end
+
+    context 'with a empty array' do
+      it 'should return false' do
+        expect(valid_array?([])).to be(false)
+      end
+    end
+
+  end
+
+  describe '#array_contain_digits?' do
+    context 'with a mixed array of valid elements' do
+      it 'should return true' do
+        expect(array_contain_digits?(valid_array)).to be(true)
+      end
+    end
+
+    context 'with a mixed array of invalid elements' do
+      it 'should return false' do
+        expect(array_contain_digits?(invalid_array)).to be(false)
+      end
+    end
+
+  end
+
+  describe '#value_can_be_handled?' do
+    context 'when the element is a Integer' do
+      it 'should return true' do
+        expect(value_can_be_handled?(2)).to be(true)
+      end
+    end
+
+    context 'when the element is a Float' do
+      it 'should return true' do
+        expect(value_can_be_handled?(2.0)).to be(true)
+      end
+    end
+
+    context 'when the element is something unknown' do
+      it 'should return false' do
+        expect(value_can_be_handled?('whatever')).to be(false)
+      end
+    end
+
+  end
+
+  describe '#looks_like_a_digit?' do
+    context 'when the element is a string that looks like a Float' do
+      it 'should return true' do
+        expect(looks_like_a_digit?('9.0')).to be(true)
+      end
+    end
+
+    context 'when the element is a string that looks like a Integer' do
+      it 'should return true' do
+        expect(looks_like_a_digit?('9')).to be(true)
+      end
+    end
+
+    context 'when the element is something unknown' do
+      it 'should return false' do
+        expect(looks_like_a_digit?('whatever')).to be(false)
+      end
+    end
+
+  end
+
+  describe '#clean_array' do
+    context 'with an array that contains valid that could be converted to a digit' do
+      it 'should return an array without string and with the correct numeric format' do
+        expect(clean_array(valid_array)).to eq([3, 4.0, 5, 2, 0.3])
+      end
+    end
+  end
+
+end

data/spec/average_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Average do
+
+end

data/spec/mean_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Average do
+
+  let(:int_array)   { [3,4,5]                  }
+
+  let(:mixed_array) { [3, 4.0, 5, 2.0, 3, 1.0] }
+
+  describe '#mean' do
+
+    context 'with a array of integers' do
+      it 'should calculate the correct mean' do
+        expect(mean(int_array)).to eq(4)
+      end
+    end
+
+    context 'with a mixed array of integers and floats' do
+      it 'should calculate the correct mean' do
+        expect(mean(mixed_array)).to eq(3)
+      end
+    end
+
+    context 'with a empty array' do
+      it 'should give back a nil' do
+        expect(mean([])).to eq(nil)
+      end
+    end
+
+  end
+end

data/spec/median_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Average do
+
+  let(:int_array)          { [3, 4, 5]                }
+
+  let(:array)              { [1, 1, 2, 2, 3, 4]       }
+
+  let(:mixed_array)        { [3, 4.0, 5, 2.0, 3, 1.0] }
+
+  let(:array_to_average)   { [3, 4, 7, 8, 10, 12]     }
+
+  let(:mode_array_not_pair) { [1, 1, 2, 2, 3, 4, 5]   }
+
+  describe '#median' do
+
+    context 'with a array of integers' do
+      it 'should calculate the correct median' do
+        expect(median(int_array)).to eq(4)
+      end
+    end
+
+    context 'with a mixed array of integers and floats' do
+      it 'should calculate the correct median' do
+        expect(median(mixed_array)).to eq(3)
+      end
+    end
+
+    context 'with an empty array' do
+      it 'should gives back a nil' do
+        expect(median([])).to eq(nil)
+      end
+    end
+
+  end
+
+  describe '#get_median' do
+    context 'with an even array' do
+      it 'should give back the middle value' do
+        expect(get_median(array)).to eq(2.0)
+      end
+    end
+
+    context 'with a _not_ even array' do
+      it 'should give back the the element on the middle' do
+        expect(get_median(mode_array_not_pair)).to eq(2)
+      end
+    end
+  end
+
+  describe '#middle_item' do
+    context 'with a sorted array like [1,1,2,2,3,4]' do
+      it 'should give back the middle value' do
+        expect(middle_item(array)).to eq(3)
+      end
+    end
+  end
+
+  describe '#middle_items_to_average' do
+    context 'with an even array' do
+      it 'should give back two middle items' do
+        expect(middle_items_to_average(array_to_average)).to eq([7, 8])
+      end
+    end
+  end
+  
+end

data/spec/mode_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Average do
+
+  let(:int_array)   { [3,4,5]                  }
+
+  let(:mode_array)  { [1,1,2,2,3,4]            }
+
+  let(:mixed_array) { [3, 4.0, 5, 2.0, 3, 1.0] }
+
+  describe '#mode' do
+
+    context 'with a array of integers' do
+      it 'should calculate the correct mode' do
+        expect(mode(mode_array)).to eq([1, 2])
+      end
+    end
+
+    context 'with a empty array' do
+      it 'should return a empty array' do
+        expect(mode([])).to eq(nil)
+      end
+    end
+
+    context 'with a nil object' do
+      it 'should return a empty array' do
+        expect(mode([])).to eq(nil)
+      end
+    end
+
+  end
+
+  describe '#unique_mode' do
+
+    context 'with a array of integers' do
+      it 'should calculate the correct mode returning only one mode' do
+        expect(unique_mode(mode_array)).to eq(1)
+      end
+    end
+
+    context 'with a empty array' do
+      it 'should return nil' do
+        expect(unique_mode([])).to eq(nil)
+      end
+    end
+
+    context 'with a nil object' do
+      it 'should return nil' do
+        expect(unique_mode(nil)).to eq(nil)
+      end
+    end
+
+
+  end
+
+  describe '#repetition_hash' do
+
+    context 'should return a hash' do
+      subject { repetition_hash(mode_array) }
+      it 'with hash_result key' do
+        expect(subject).to include :hash_result
+      end
+
+      it 'with hash_result key' do
+        expect(subject[:hash_result]).to eql( { 1 => 2, 2 => 2, 3 => 1, 4 => 1 } )
+      end
+
+      it 'with max_repetition key' do
+        expect(subject).to include :max_repetition
+      end
+    end
+
+    context 'with a empty array' do
+      it 'should return nil' do
+        expect(repetition_hash([])).to eql(nil)
+      end
+    end
+
+    context 'with a empty array' do
+      it 'should return nil' do
+        expect(repetition_hash(nil)).to eql(nil)
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'average'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: average
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Fernando
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-26 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'
+description: Find the arithmethic mean/mode/median of an array of numbers .
+email:
+- fgonzalezaguilera@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- average.gemspec
+- lib/average.rb
+- lib/average/average_helper.rb
+- lib/average/mean.rb
+- lib/average/median.rb
+- lib/average/mode.rb
+- lib/average/version.rb
+- spec/average_helper_spec.rb
+- spec/average_spec.rb
+- spec/mean_spec.rb
+- spec/median_spec.rb
+- spec/mode_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: Find the arithmethic mean/mode/median of an array of numbers .
+test_files:
+- spec/average_helper_spec.rb
+- spec/average_spec.rb
+- spec/mean_spec.rb
+- spec/median_spec.rb
+- spec/mode_spec.rb
+- spec/spec_helper.rb