tabs 0.8.0 → 0.8.1

data/README.md

@@ -52,7 +52,7 @@ To retrieve the counts for a given time period just call `Tabs#get_stats` with t
 ```ruby
 Tabs.get_stats("website-visits", 10.days.ago..Time.now, :hour)
 ```
-    
+
 This will return stats for the last 10 days by hour in the form of a `Tabs::Metrics::Counter::Stats` object.  This object is enumerable so you can iterate through the results like so:
 
 ```ruby
@@ -81,7 +81,7 @@ results.avg         #=> The avg count for timestamps in the period
 results.period      #=> The timestamp range that was requested
 results.resolution  #=> The resolution requested
 ```
-    
+
 Timestamps for the given period in which no events occurred will be "filled in" with a count value to make visualizations easier.
 
 The timestamps are also normalized.  For example, in hour resolution, the minutes and seconds of the timestamps are set to 00:00.  Likewise for the week resolution, the day is set to the first day of the week.
@@ -116,13 +116,13 @@ a metric as well:
 ```ruby
 Tabs.create_metric("new-user-age", "value")
 ```
-    
+
 Retrieving the stats for a value metric is just like retrieving a counter metric.
 
 ```ruby
 Tabs.get_stats("new-user-age", 6.months.ago..Time.now, :month)
 ```
-    
+
 This will return a `Tabs::Metrics::Value::Stats` object.  Again, this
 object is enumerable and encapsulates all the timestamps within the
 given period.
@@ -229,7 +229,7 @@ To drop a metric, just call `Tabs#drop_metric`
 ```ruby
 Tabs.drop_metric!("website-visits")
 ```
-    
+
 This will drop all recorded values for the metric so it may not be un-done...be careful.
 
 Even more dangerous, you can drop all metrics...be very careful.
@@ -240,17 +240,21 @@ Tabs.drop_all_metrics!
 
 ### Configuration
 
-There really isn’t much to configure with Tabs, it just works out of the box.  You can use the following configure block to set the Redis connection instance that Tabs will use.
+Tabs just works out of the box. However, if you want to override the default Redis connection or decimal precision, this is how:
 
 ```ruby
 Tabs.configure do |config|
 
   # set it to an existing connection
   config.redis = Redis.current
-  
+
   # pass a config hash that will be passed to Redis.new
   config.redis = { :host => 'localhost', :port => 6379 }
-  
+
+  # override default decimal precision (5)
+  # affects stat averages and task completion rate
+  config.decimal_precision = 2
+
 end
 ```
 

data/lib/tabs/config.rb

@@ -2,6 +2,14 @@ module Tabs
   module Config
     extend self
 
+    def decimal_precision
+      @decimal_precision ||= 5
+    end
+
+    def decimal_precision=(precision)
+      @decimal_precision = precision
+    end
+
     def redis=(arg)
       if arg.is_a?(Redis)
         @redis = arg

data/lib/tabs/helpers.rb

@@ -18,10 +18,5 @@ module Tabs
       period_end = Tabs::Resolution.normalize(resolution, period.last.utc)
       (period_start..period_end)
     end
-
-    def round_float(f)
-      (f*100).round / 100.0
-    end
-
   end
 end

data/lib/tabs/metrics/counter/stats.rb

@@ -33,7 +33,8 @@ module Tabs
         end
 
         def avg
-          round_float(self.total.to_f / values.size.to_f)
+          return 0 if values.size.zero?
+          (self.total.to_f / values.size.to_f).round(Config.decimal_precision)
         end
 
         def each(&block)

data/lib/tabs/metrics/task.rb

@@ -35,7 +35,7 @@ module Tabs
         started_tokens = tokens_for_period(range, resolution, "started")
         completed_tokens = tokens_for_period(range, resolution, "completed")
         matching_tokens = started_tokens & completed_tokens
-        completion_rate = round_float(matching_tokens.size.to_f / range.size)
+        completion_rate = (matching_tokens.size.to_f / range.size).round(Config.decimal_precision)
         elapsed_times = matching_tokens.map { |t| t.time_elapsed(resolution) }
         average_completion_time = (elapsed_times.inject(&:+)) / matching_tokens.size
         Stats.new(

data/lib/tabs/metrics/value/stats.rb

@@ -37,7 +37,8 @@ module Tabs
         end
 
         def avg
-          round_float(self.sum.to_f / self.count.to_f)
+          return 0 if count.zero?
+          (self.sum.to_f / self.count.to_f).round(Config.decimal_precision)
         end
 
         def each(&block)

data/lib/tabs/version.rb

@@ -1,3 +1,3 @@
 module Tabs
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/spec/lib/tabs/metrics/counter/stats_spec.rb

@@ -31,7 +31,12 @@ describe Tabs::Metrics::Counter::Stats do
   end
 
   it "avg returns the average for the entire set" do
-    expect(stats.avg).to eq 86.33
+    expect(stats.avg).to eq 86.33333
+  end
+
+  it "avg returns 0 if values empty" do
+    stats = Tabs::Metrics::Counter::Stats.new(period, resolution, [])
+    expect(stats.avg).to be_zero
   end
 
 end

data/spec/lib/tabs/metrics/value/stats_spec.rb

@@ -38,4 +38,24 @@ describe Tabs::Metrics::Value::Stats do
     expect(stats.avg).to eq 16.76
   end
 
+  it "avg returns 0 if set is empty" do
+    stats = Tabs::Metrics::Value::Stats.new(period, resolution, [])
+    expect(stats.avg).to be_zero
+  end
+
+  context "override decimal precision" do
+    before do
+      @precision = Tabs.config.decimal_precision
+      Tabs.config.decimal_precision = 1
+    end
+
+    after do
+      Tabs.config.decimal_precision = @precision
+    end
+
+    it "allows you to override decimal precision" do
+      expect(stats.avg).to eq 16.8
+    end
+  end
+
 end

data/spec/lib/tabs/metrics/value_spec.rb

@@ -95,7 +95,6 @@ describe Tabs::Metrics::Value do
       expect(stats).to include({ "timestamp" => (now + 3.years), "count"=>1, "min"=>10, "max"=>10, "sum"=>10, "avg"=>10})
       expect(stats).to include({ "timestamp" => (now + 6.years), "count"=>2, "min"=>15, "max"=>20, "sum"=>35, "avg"=>17})
     end
-
   end
 
   describe ".drop!" do

data/spec/lib/tabs/task_spec.rb

@@ -66,7 +66,7 @@ describe Tabs::Metrics::Task do
       expect(stats.started_within_period).to eq 3
       expect(stats.completed_within_period).to eq 2
       expect(stats.started_and_completed_within_period).to eq 2
-      expect(stats.completion_rate).to eq 0.18
+      expect(stats.completion_rate).to eq 0.18182
       expect(stats.average_completion_time).to eq 1.5
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tabs
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors: