updawg 0.3.5 → 0.3.6

data/CHANGELOG

@@ -1,3 +1,5 @@
+0.3.6: 
+  * ADD unless_below, unless_above filters to deviation check
 0.3.3:
   * ADD text reporting
   * ADD check timeouts

data/README.rdoc

@@ -49,6 +49,8 @@ Checks are defined with a simple DSL:
     # Supports options:
     #   scale_factor - multiple of the std_dev to user (default: 2)
     #   smoothing - whether to ignore outliers in the dataset (default: true)
+    #   skip_if_minimum_below - set to a value to skip this check for values that would be very small (default: false)
+    #   skip_if_maximum_above - set to a value to skip this check for values that would be very large (default: false)
     deviation 'Hourly Transaction Value' do
       Transaction.group('hour').order('hour ASC') # will report if the last hour of data is our of range
     end

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

data/lib/updawg/checks/deviation_check.rb

@@ -5,7 +5,9 @@ module Updawg
     def initialize(name, options = {}, &block)
       super(name, options, &block)
       
-      unknown_keys = options.keys - [:deviates_high, :deviates_low, :scale_factor, :smoothing].flatten
+      unknown_keys = options.keys - [
+        :deviates_high, :deviates_low, :scale_factor, :smoothing, :unless_below, :unless_above
+      ].flatten
       raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
             
       @options = options
@@ -47,7 +49,10 @@ module Updawg
         
         min = mean - scale_factor * std_dev
         max = mean + scale_factor * std_dev
-                  
+            
+        return pass("SKIP due to low minimum value") if @options[:unless_below] && min < @options[:unless_below]
+        return pass("SKIP due to high maximum value") if @options[:unless_above] && max > @options[:unless_above]
+              
         return low(sample, min) if sample < min
         return high(sample, max) if sample > max
         return pass("#{sample} within expected range (#{min..max})")

data/spec/updawg/checks/deviation_check_spec.rb

@@ -120,6 +120,42 @@ describe Updawg::DeviationCheck do
         check = Updawg::DeviationCheck.new('test', @options){ @values + [@avg - 2 * @std_dev + 0.01] }
         check.perform.should be_success
       end
-    end    
-  end
+    end 
+    
+    describe 'when unless_below is set' do 
+      before(:each) do
+        @dataset = @values + [@avg - 2 * @std_dev - 1]
+      end 
+      
+      it 'should be error if values are above threshold' do
+        @options[:unless_below] = 1
+        check = Updawg::DeviationCheck.new('test', @options){ @dataset }
+        check.perform.should be_error
+      end
+      
+      it 'should pass if values are below threshold' do
+        @options[:unless_below] = 100
+        check = Updawg::DeviationCheck.new('test', @options){ @dataset }
+        check.perform.should be_success
+      end
+    end
+    
+    describe 'when unless_above is set' do 
+      before(:each) do
+        @dataset = @values + [@avg + 2 * @std_dev + 1]
+      end 
+
+      it 'should be error if values are below threshold' do
+        @options[:unless_above] = 100
+        check = Updawg::DeviationCheck.new('test', @options){ @dataset }
+        check.perform.should be_error
+      end
+
+      it 'should pass if values are above threshold' do
+        @options[:unless_above] = 1
+        check = Updawg::DeviationCheck.new('test', @options){ @dataset }
+        check.perform.should be_success
+      end
+    end   
+  end 
 end

data/updawg.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{updawg}
-  s.version = "0.3.5"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Griffin"]
-  s.date = %q{2011-03-23}
+  s.date = %q{2011-04-14}
   s.email = %q{matt@griffinonline.org}
   s.extra_rdoc_files = [
     "LICENSE",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: updawg
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Matt Griffin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 -04:00
+date: 2011-04-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency