sum_all_number_combinations 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83aedb673494ae05121f8a1d8c521512354b1dbc
-  data.tar.gz: b8e5b0a6aed87ff90bdae4a284d4cc51a77ca5fd
+  metadata.gz: 6e1f8e0f98d31ffb815c33896596e96d54f8e898
+  data.tar.gz: 86e45f3707f47bf30177696bd6f9b9b5c9169388
 SHA512:
-  metadata.gz: 978e45e9e78ffaa7966ef839857dc5a07be1bceef5519f121f86864b96c58d0e637c4320372c6f8c561338d95b3028c79bd645fee0df9422aadee878371a35dd
-  data.tar.gz: 7206a57e4a8003f4ea565127d55353bf38c18567904aaa9802bf3f57f3b3e80e682a5efc83d115c78e4ed9cc177387ab5e39f7156b9c0ba9c3102b20f1a89cfb
+  metadata.gz: 30e1ad7393c47f161989fc4ba7f5970479bcb1d8b88e9b0d9af3d30288b0ab45a21b656f4c999d13ed6ce6203229c7a0238313e40e57bd28a2b14265e4409c9d
+  data.tar.gz: bcb837914daa5ae4b28b078227d283698ca64134de93fb94dc750a985949af533d70d817efc887328ad5d180bdd2ad837cb41ff1033e540f8995af4ef0144643

data/README.md

@@ -21,7 +21,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create your instance variable, passing in the array you would like to sum all the combinations of.
+```ruby
+sum_of_all = SumAllCombinations.new([1,2,3])
+```
+Call the sum method and pass in the optional keyword arguments of remove_duplicates (default is false) and sort (default is true)
+```ruby
+sum_of_all.sum(remove_duplicates: false, sort: true)
+```
+The attributes available include:
+```ruby
+# passed in array
+@original
+
+# flattened array. After sum is called flattened will only include the numbers used for calculation, non-numeric objects  will be removed
+@flattened
+
+# calculated values array, which is the array holding all the numbers calculated from the addition of all of the possible number combinations, after sum is called 
+@calculated_values
+
+#combinations used array, which is the array holding all the information of how the numbers were combined to determine results
+@combinations_used
+```
+## Example
+```ruby
+sum_of_all = SumAllCombinations.new([1,2,[3,4], "house"])
+sum_of_all.original #=> [1, 2, [3, 4], "house"]
+sum_of_all.flattened #=> [1, 2, 3, 4, "house"]
+sum_of_all.sum #=> [3.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 9.0, 10.0]
+sum_of_all.calculated_values #=> [3.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 9.0, 10.0]
+sum_of_all.combinations_used #=> ["1.0+2.0+3.0+4.0=10.0", "1.0+2.0+3.0=6.0", "1.0+2.0+4.0=7.0", "1.0+2.0=3.0", "1.0+3.0+4.0=8.0", "1.0+3.0=4.0", "1.0+4.0=5.0", "2.0+3.0+4.0=9.0", "2.0+3.0=5.0", "2.0+4.0=6.0", "3.0+4.0=7.0"]
+```
 
 ## Development
 

data/lib/sum_all_number_combinations/version.rb

@@ -1,3 +1,3 @@
 module SumAllNumberCombinations
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sum_all_number_combinations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Paul Trott
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler