darthjee-core_ext 1.5.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b584506156a0622988d8fe4b00681f318ebc9660
-  data.tar.gz: 3f554744e539f3440408f9d971bdd45b5dbf24f5
+  metadata.gz: b2c5c7d0ee2381eb9ee8247dcf6958d094cc5048
+  data.tar.gz: c2edd6e256d0af3754a452dd1866ffab79e54c2b
 SHA512:
-  metadata.gz: 428fc4e08889758330f638d25299cb5b26aee30cf284b3e7fcf548872e972e59dc27f61a69d753ec845e32ae4be0a17c0134ffcc3b7629632d0ceb91caf67d1a
-  data.tar.gz: b2fd1bac68f74aeabe0a4e0095c0d1db5a5364e0ea36cb3929c79f9633f110cfb465965fb01f661f85ec0879da0a02fd3d6805acc293bfff836922ff69538ca7
+  metadata.gz: a563d810e044f19c03347289e619c8ab3fae73572a475b14996009714ce136fcd50fd6586d814ef6b417d247f15d977be2b3c5d64545a2a15ec56548fd246fe9
+  data.tar.gz: 894aad77a3355ed2cd43104de005088acce770872bef017e0467363b4b66c9eb119bf2e5216661ae1ee911bb4f9e52fc4207d382a99573f4c971dbd6ba049d0b

data/MATH_README.md

@@ -0,0 +1,30 @@
+## MATH
+
+### .average
+calculates the average of the given values
+
+```ruby
+Math.average([ 0, 1, 2, 3, 4 ])
+```
+
+returns
+```
+2
+```
+
+It can also be used to calculate the average of weighted values
+
+```ruby
+Math.average(
+  0 => 1,
+  1 => 2,
+  2 => 3,
+  3 => 4,
+  4 => 5
+)
+```
+
+returns
+```
+2.6666
+```

data/README.md

@@ -38,3 +38,5 @@ bundle install darthjee-core_ext
 [DATE_README.md](DATE_README.md)
 ## Object
 [OBJECT_README.md](OBJECT_README.md)
+## Math
+[MATH_README.md](MATH_README.md)

data/lib/darthjee/core_ext.rb

@@ -7,6 +7,7 @@ require 'darthjee/core_ext/numeric'
 require 'darthjee/core_ext/date'
 require 'darthjee/core_ext/time'
 require 'darthjee/core_ext/object'
+require 'darthjee/core_ext/math'
 
 module Darthjee
   module CoreExt

data/lib/darthjee/core_ext/math.rb

@@ -0,0 +1,9 @@
+module Math
+  def self.average(values)
+    values = values.map { |v| [v,1] }.to_h unless values.is_a?(Hash)
+
+    values.inject(0) do |sum, vals|
+      sum + vals.inject { |a,b| a * b }
+    end / values.values.sum.to_f
+  end
+end

data/lib/darthjee/core_ext/version.rb

@@ -1,5 +1,5 @@
 module Darthjee
   module CoreExt
-    VERSION = '1.5.3'
+    VERSION = '1.5.4'
   end
 end

data/spec/lib/math_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Math do
+  describe '.average' do
+    context 'when passing an array of values' do
+      let(:values) { [0, 1, 2, 3, 4] }
+
+      it 'returns the average' do
+        expect(described_class.average(values)).to eq(2)
+      end
+
+      context 'when average is not a round number' do
+        let(:values) { [0, 1, 2, 3] }
+        it 'returns the average' do
+          expect(described_class.average(values)).to eq(1.5)
+        end
+      end
+    end
+
+    context 'when passing a hash' do
+      let(:values) do
+        {
+          0 => 1,
+          1 => 2,
+          2 => 3,
+          3 => 4,
+          4 => 5
+        }
+      end
+
+      it 'uses the keys as values and the values as weights (frequency)' do
+        expect(described_class.average(values)).to eq(8 / 3.0)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darthjee-core_ext
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.4
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-05 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -137,6 +137,7 @@ files:
 - Gemfile
 - HASH_README.md
 - LICENSE
+- MATH_README.md
 - OBJECT_README.md
 - README.md
 - Rakefile
@@ -154,6 +155,7 @@ files:
 - lib/darthjee/core_ext/hash/deep_hash_constructor.rb
 - lib/darthjee/core_ext/hash/key_changer.rb
 - lib/darthjee/core_ext/hash/value_changer.rb
+- lib/darthjee/core_ext/math.rb
 - lib/darthjee/core_ext/numeric.rb
 - lib/darthjee/core_ext/object.rb
 - lib/darthjee/core_ext/object/default_value.rb
@@ -166,6 +168,7 @@ files:
 - spec/lib/hash/deep_hash_constructor_spec.rb
 - spec/lib/hash/key_changer_spec.rb
 - spec/lib/hash_spec.rb
+- spec/lib/math_spec.rb
 - spec/lib/numeric_spec.rb
 - spec/lib/object/default_value_spe.rb
 - spec/lib/object_spec.rb
@@ -219,6 +222,7 @@ test_files:
 - spec/lib/hash/deep_hash_constructor_spec.rb
 - spec/lib/hash/key_changer_spec.rb
 - spec/lib/hash_spec.rb
+- spec/lib/math_spec.rb
 - spec/lib/numeric_spec.rb
 - spec/lib/object/default_value_spe.rb
 - spec/lib/object_spec.rb