darthjee-core_ext 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a7679a554bc9075b9a2e6495e47f2602834f106
-  data.tar.gz: ae306ba662a111238d997a02c9f178ace1980421
+  metadata.gz: 76f54a19a0bf4ae4892e60d0473ac649c2c63966
+  data.tar.gz: '0183bd9098a782cfc4792c480435ec3ec93cec0e'
 SHA512:
-  metadata.gz: 3a9024a26c829e10daba4866d666a7b9ce0fb5ec92f89b839f5ca06263056326ceb85a400e2f35e416393b2c62123aeaddb42133d764d25fadd829aa525578ec
-  data.tar.gz: 4f672dce0e7ea9c55ae670480dfc4306d0776bec49fce1c336d5dfdc15a4927d214c1fe8cb1c5e220255acd47604843efc30bbf985b2c80099f7857e779d256c
+  metadata.gz: 7e24c2851a5462ec6e865e1779a68c4e625c2ea23b95298171261ff33b63ac9d0104ce584e32628c0825d355a4a49bf0b6a4b21b00a5ceaa6bd21dda67483ea4
+  data.tar.gz: 406126966cfd866c2576eeb1fb112ada5daae171e3ebbc87208b7d3d6fc9a0706c0e78899b52882525e26e6bcb98f4b27aaccefe4e6e7602ffddd66c057bfee1

data/ARRAY_README.md

@@ -1,4 +1,12 @@
 ## Array
+### #average
+returns the average of the values in the array
+
+```ruby
+array = [1, 2, 3, 4]
+array.average # returns 2.5
+```
+
 ### #map_to_hash
 map returning a hash with the original array for keys
 

data/README.md

@@ -9,7 +9,7 @@ Darthjee/CoreExt
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/darthjee-core_ext/2.7.1
+https://www.rubydoc.info/gems/darthjee-core_ext/1.7.2
 
 # Usage
 This project adds some new methods to the core ruby classes

data/lib/darthjee/core_ext/array.rb

@@ -21,6 +21,17 @@ module Darthjee
         Array::HashBuilder.new(self, keys).build
       end
 
+      # Calculate the average of all values in the array
+      #
+      # @return [::Float] average of all numbers
+      #
+      # @example Average of array of integer values
+      #   array = [1, 2, 3, 4]
+      #   array.average # returns 2.5
+      def average
+        sum * 1.0 / length
+      end
+
       # Maps the array using the given methods on each
       # element of the array
       #

data/lib/darthjee/core_ext/version.rb

@@ -2,6 +2,6 @@
 
 module Darthjee
   module CoreExt
-    VERSION = '1.7.1'
+    VERSION = '1.7.2'
   end
 end

data/spec/integration/yard/array_spec.rb

@@ -4,6 +4,14 @@ require 'spec_helper'
 
 describe Array do
   describe 'yard' do
+    describe '#average' do
+      subject(:array) { [1, 2, 3, 4] }
+
+      it 'returns the average' do
+        expect(array.average).to eq(2.5)
+      end
+    end
+
     describe '#mapk' do
       let(:array) { [{ a: { b: 1 }, b: 2 }, { a: { b: 3 }, b: 4 }] }
 

data/spec/lib/array_spec.rb

@@ -5,6 +5,14 @@ require 'spec_helper'
 describe Array do
   it_behaves_like 'an array with map_to_hash method'
 
+  describe '#average' do
+    subject(:array) { [1, 2, 3, 4] }
+
+    it 'returns the average' do
+      expect(array.average).to eq(2.5)
+    end
+  end
+
   describe '#mapk' do
     let(:array) { [{ a: { b: 1 }, b: 2 }, { a: { b: 3 }, b: 4 }] }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: darthjee-core_ext
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Darthjee