crunchr 0.0.1 → 0.0.2

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/crunchr.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "crunchr"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hartog C. de Mik"]
-  s.date = "2013-02-08"
+  s.date = "2013-02-11"
   s.description = "Crunch statistics"
   s.email = "hartog@organisedminds.com"
   s.extra_rdoc_files = [

data/lib/crunchr.rb

@@ -77,9 +77,29 @@ module Crunchr
 
   # given a string like 'keys - doors', returns the amount of spare keys
   #
+  # You can group calculations by surrounding them with (), eg:
+  #
+  #   (doors - keys) / (inhabitants - keys)
+  #
+  # Pass in real numbers if you like
+  #
+  #   (doors + 2) / keys
+  #
+  # @note
+  #   The result is *always* a float.
+  #   If anything fails, 0.0 is returned.
+  #
+  # @param  String key     The calculation to perform
+  # @return Float  result
+  #
   def calculate(key)
-    (left, op, right) = key.split(/\s/)
+    while key =~ /\(/ && key =~ /\)/
+      key.gsub!(/\(([^\(\)]+)\)/) do |calculation|
+        calculate(calculation.gsub(/[\(\)]/, ''))
+      end
+    end
 
+    (left, op, right) = key.split(/\s/)
 
     left = (
       left =~ /[^\d.]/ ? self.fetch(left) : BigDecimal.new(left)
@@ -101,33 +121,51 @@ module Crunchr
 
   module ClassMethods
     # pass in a list off data-objects with and get a nice table
-    #   list = [ Object.data({ doors: 1, keys: 2}), Object.data({ doors: 1, keys: 3 }, ... ]
+    #   list = [ Object.data({ doors: 1, keys: 2}),
+    #            Object.data({ doors: 1, keys: 3 },
+    #            ...
+    #          ]
     #
     #   table = Object.as_table(list, keys: %w[doors keys])
     #   # => [ [ 1, 2 ], [ 1, 3 ], [ 1, 4 ], [ 3, 8 ] ]
     #
     # Or use lists in lists
+    #
     #   deep_list = [ list, list list ]
-    #   table = Object.as_table(deep_list, keys: %[doors keys], list_operator: delta)
-    #   # => [ [ 2, 6 ] ]  (differnece of mac and min for both doors and keys)
+    #   table = Object.as_table(
+    #     deep_list, keys: %[doors keys], list_operator: delta
+    #   )
+    #   # => [ [ 2, 6 ] ]  (difference of max and min for both doors and keys)
+    #
+    # == Usage with dates/times
+    #
+    # If you include Crunchr into something Active-Modely that has 'created_at'
+    # as a (sane) attribute, you can supply a :date key, it will add a column
+    # with the value of created_at into the table. If you do not supply
+    # :date_fmt, it will call #to_date on the column
     #
     # @param [Array] list List (1d or 2d) of data objects
     # @param [Hash] opts Options
     # @option opts [Array] keys List of keys to fetch, may contain
     #     calculations, eg: ['doors', 'keys', 'doors / keys']
-    # @option opts [Symbol] list_operator With a 2d list, what operator to
-    #      apply to each given list to determine the 1d value, any of
-    #      - :mean
-    #      - :stddev
-    #      - :median
-    #      - :range
-    #      - :mode
-    #      - :sum
-    #      - :min
-    #      - ;max
+    # @option opts [Symbol] list_operator    With a 2d list, what operator to
+    #      apply to each given list to determine the 1d value see #delta for
+    #      more info
+    # @option opts [String] date_fmt  Use as input to #strftime for the value
+    #      in the date column
+    # @option opts [String] str_fmt   Use as input to #sprintf for the value
+    #      in **every** column. (Cannot be used together with :delta)
+    # @option opts [Boolean] delta    After the first row, fill every other row
+    #      with the difference to the previous row. (Cannot be used with
+    #      :str_fmt)
+    #
     def as_table(list, opts = {})
       keys = opts[:keys] || raise("Need keys")
 
+      if opts[:delta] && opts[:str_fmt]
+        raise ":delta and :str_fmt cannot be supplied together"
+      end
+
       table = []
 
       list.each do |statistic|
@@ -188,6 +226,23 @@ module Crunchr
       return table
     end
 
+    # flatten an array of rows by applying an operator vertically on each
+    # column and accepting the result as a single row
+    #
+    # @param [Array] array List of lists
+    # @param [Hash] opts Options
+    # @option opts [Symbol] list_operator  What operator to apply to the array
+    #   to get a single value, defaults to :mean, should be any of
+    #      - :mean
+    #      - :stddev
+    #      - :median
+    #      - :range
+    #      - :mode
+    #      - :sum
+    #      - :min
+    #      - :max
+    #      - :delta (takes the difference of max and min)
+    #
     def flatten(array, opts)
       keys = opts[:keys].dup
 
@@ -229,11 +284,16 @@ module Crunchr
       return [keys, collection]
     end
 
-
+    # Return a BigDecimal zero value
     def zero
       BigDecimal.new("0.0")
     end
 
+    # Make sure the value is zero if it is NaN, infinite, or nil
+    # Turn the value into a float if it is a BigDecimal
+    #
+    # @param value  The value to check
+    # @return [Float, Integer] the improved value
     def checked(value)
       value = zero() if value.respond_to?(:nan?) && value.nan?
       value = zero() if value.respond_to?(:infinity?) && value.infinity?

data/spec/crunchr_spec.rb

@@ -164,4 +164,23 @@ describe "Crunchr" do
     end
 
   end
+
+  context "Extended calculations" do
+    before(:each) do
+      subject.data = deep_hash
+    end
+
+    it "performs calculations successively" do
+      subject.fetch("(loans/requested/GBP + loans/payed/GBP) - commission/pending/GBP").should == (0.65395 + 145.23) - 1.3079
+    end
+
+    it "handles nested groupings" do
+      subject.fetch("((users/count + users/active) + users/active) + users/count").should == (((14 + 2) + 2) + 14).to_f
+    end
+
+    it "ignores malformed groupings" do
+      subject.fetch("(users/count + users/active").should == 2.0  # 0 + 2
+      subject.fetch("((users/count + users/active) + 12").should == 12.0
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crunchr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16830960 !ruby/object:Gem::Requirement
+  requirement: &24262560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *16830960
+  version_requirements: *24262560
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &12972500 !ruby/object:Gem::Requirement
+  requirement: &24290860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12972500
+  version_requirements: *24290860
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &12974440 !ruby/object:Gem::Requirement
+  requirement: &24297100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *12974440
+  version_requirements: *24297100
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &12969640 !ruby/object:Gem::Requirement
+  requirement: &24305540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *12969640
+  version_requirements: *24305540
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &12977560 !ruby/object:Gem::Requirement
+  requirement: &24329100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *12977560
+  version_requirements: *24329100
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &12997100 !ruby/object:Gem::Requirement
+  requirement: &24375820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12997100
+  version_requirements: *24375820
 description: Crunch statistics
 email: hartog@organisedminds.com
 executables: []
@@ -114,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1841846266649628700
+      hash: -971526191153423674
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: