ae_easy-qa 0.0.28 → 0.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1e3e0d4eb58a9471e48a6f2fd1dbd628f50d52ad608f135a787109bfec147b23
-  data.tar.gz: f780351ad816a33b67d2312ce554852b10288d24a6d9c0bf3892c543e1c1f214
+SHA1:
+  metadata.gz: e5541353f16b04175786b1ceb92a0e767032bbf7
+  data.tar.gz: 54910859a41cbfbe7aed8c21d719b44f48bca999
 SHA512:
-  metadata.gz: b2514ac3b1ca295ff59003ce3e79472dddb20e98a6257777f2c3e6427ada51944e7d620958e549a42d62c99f4336dc9f716964f84c5464fbe0bffba362f41aa6
-  data.tar.gz: 55d0bdeb9eb474d8c6aae60e60ec6180ee1e5ca3c991f206ce2176eb2a55b76fb5bdcc5e8c1c4b6f06a923d3bc4184502aa1640f8a327990c1b23e94a9f884c1
+  metadata.gz: 2c6b03b3151a72afd8c7e927c77e91f6ea92e1cc10944be3c5a7de93ec63cd38143d0937e83aeb93ee37e13076026b0b6dfb69f7e69ed78be360f53da9699ff6
+  data.tar.gz: 96bbb90dd55a2ba8ccaaf44c5f68efd0770a34c51184dfff24575c840ba54d047f80990b16dbc827be7f23a788361ba5ea5ee17e4d17c6d7865688d6795c53d7

data/lib/ae_easy/qa.rb

@@ -22,10 +22,12 @@ module AeEasy
         @data = data
       end
 
+      #this method is for validating "internal" scrapers that run on AnswersEngine
       def validate_internal(vars, outputs)
         ValidateInternal.new(vars, config, outputs).run
       end
 
+      #this method is for validating data from "external" sources
       def validate_external(outputs, collection_name)
         ValidateExternal.new(data, config, outputs, collection_name, options).run
       end

data/lib/ae_easy/qa/helpers.rb

@@ -6,6 +6,41 @@ module AeEasy
         errored_item[:failures][error_name.to_sym] = 'fail'
         errored_item[:item] = data_hash if errored_item[:data].nil?
       end
+
+      def pass_if?(if_params, data_hash)
+        case if_params.keys.first
+        when 'and', 'or'
+          operator = if_params.keys.first
+          evaluations = if_params[operator].collect{|child_if_params|
+            field_name = child_if_params.keys.first
+            condition_hash = child_if_params[field_name]
+            evaluate_condition(field_name, condition_hash, data_hash)
+          }
+          operator == 'and' ? evaluations.all? : evaluations.any?
+        else
+          field_name = if_params.keys.first
+          condition_hash = if_params[field_name]
+          evaluate_condition(field_name, condition_hash, data_hash)
+        end
+      end
+
+      def evaluate_condition(field_name, condition_hash, data_hash)
+        case condition_hash.keys.first
+        when 'value'
+          value_hash = condition_hash['value'] #Ex: {"equal"=>"A"}
+          if value_hash['equal']
+            data_hash[field_name] == value_hash['equal']
+          elsif value_hash['regex']
+            !(data_hash[field_name].to_s =~ Regexp.new(value_hash['regex'], true)).nil?
+          elsif value_hash['less_than']
+            data_hash[field_name].to_i < value_hash['less_than'].to_i
+          elsif value_hash['greater_than']
+            data_hash[field_name].to_i > value_hash['greater_than'].to_i
+          else
+            raise StandardError.new("The if condition '#{value_hash}' is unknown.")
+          end
+        end
+      end
     end
   end
 end

data/lib/ae_easy/qa/save_output.rb

@@ -28,6 +28,7 @@ module AeEasy
 
       private
 
+      #thresholds are a setting where you can ignore errors if they are under a specific error rate
       def gather_threshold_totals
         rules.each{|field_to_validate, field_options|
           field_threshold = return_threshold(field_to_validate, field_options)

data/lib/ae_easy/qa/validate_internal.rb

@@ -1,18 +1,19 @@
 module AeEasy
   module Qa
     class ValidateInternal
-      attr_reader :scraper_name, :collections, :rules, :outputs
+      attr_reader :scraper_name, :collections, :rules, :outputs, :data
 
       def initialize(vars, config, outputs)
         @scraper_name = vars['scraper_name']
         @collections = vars['collections']
         @rules = config['individual_validations']
         @outputs = outputs
+        @data = vars['data']
       end
 
       def run
         begin
-          ValidateScraper.new(scraper_name, collections, rules, outputs, thresholds).run
+          ValidateScraper.new(scraper_name, collections, rules, outputs, thresholds, data).run
         rescue StandardError => e
           puts "An error has occurred: #{e}"
           return nil
@@ -21,6 +22,7 @@ module AeEasy
 
       private
 
+      #thresholds are a setting where you can suppress errors if they are under a specific error rate
       def thresholds
         @thresholds ||= begin
                           file_path = File.expand_path('thresholds.yaml', Dir.pwd)
@@ -34,14 +36,15 @@ module AeEasy
     end
 
     class ValidateScraper
-      attr_reader :scraper_name, :collections, :rules, :outputs, :options
+      attr_reader :scraper_name, :collections, :rules, :outputs, :options, :data
 
-      def initialize(scraper_name, collections, rules, outputs, thresholds)
+      def initialize(scraper_name, collections, rules, outputs, thresholds, data)
         @scraper_name = scraper_name
         @collections = collections
         @rules = rules
         @outputs = outputs
         @options = {}
+        @data = data
         options['thresholds'] = thresholds[scraper_name] if thresholds && thresholds[scraper_name]
       end
 
@@ -74,7 +77,7 @@ module AeEasy
         collections.each do |collection_name|
           collection = collection_counts.find{|collection_hash| collection_hash['collection'] == collection_name }
           if collection
-            ValidateCollection.new(scraper_name, collection_name, collection['outputs'], rules, outputs, options).run
+            ValidateCollection.new(scraper_name, collection_name, collection['outputs'], rules, outputs, options.merge({'data' => @data})).run
           else
             puts "collection #{collection_name} is missing"
           end
@@ -107,6 +110,7 @@ module AeEasy
         @total_records = total_records
         @rules = rules
         @outputs = outputs
+        @data = options['data']
         @options = options
         @errors = { errored_items: [] }
       end

data/lib/ae_easy/qa/validate_rules.rb

@@ -27,12 +27,12 @@ module AeEasy
               options.each{|validation, value|
                 case validation
                 when 'type'
-                  ValidateType.new(data_hash, field_to_validate, value, rules, errored_item).run if options['required']
+                  ValidateType.new(data_hash, field_to_validate, value, rules, errored_item).run
                 when 'value'
-                  ValidateValue.new(data_hash, field_to_validate, value, errored_item).run if options['required']
+                  ValidateValue.new(data_hash, field_to_validate, value, errored_item).run
                 when 'length'
-                  validate_length(data_hash, field_to_validate, value) if options['required']
-                when /required|threshold/
+                  validate_length(data_hash, field_to_validate, value)
+                when /required|threshold|if/
                   nil
                 else
                   unknown_validation_error(validation) if validation !~ /format/
@@ -45,7 +45,23 @@ module AeEasy
       end
 
       def passes_required_check?(options, data_hash, field_to_validate)
-        if options['required'] == true && fails_required_check?(data_hash, field_to_validate)
+        if options['required'] == true
+          if options['if']
+            if pass_if?(options['if'], data_hash)
+              check_for_required_failure(data_hash, field_to_validate)
+            else
+              false
+            end
+          else
+            check_for_required_failure(data_hash, field_to_validate)
+          end
+        else
+          false
+        end
+      end
+
+      def check_for_required_failure(data_hash, field_to_validate)
+        if fails_required_check?(data_hash, field_to_validate)
           add_errored_item(data_hash, field_to_validate, 'required')
           false
         else

data/lib/ae_easy/qa/validate_value.rb

@@ -13,24 +13,17 @@ module AeEasy
       end
 
       def run
-        condition_exists? ? handle_conditions : main_value_check
+        if_exists? ? handle_if : main_value_check
       end
 
       private
 
-      def condition_exists?
+      def if_exists?
         !params['if'].nil?
       end
 
-      def handle_conditions
-        field_name = params['if'].keys.first
-        condition_hash = params['if'][field_name]
-        case condition_hash.keys.first
-        when 'value'
-          if(data_hash[field_name] == condition_hash.values.first)
-            main_value_check
-          end
-        end
+      def handle_if
+        main_value_check if pass_if?(params['if'], data_hash)
       end
 
       def main_value_check
@@ -43,9 +36,9 @@ module AeEasy
         elsif params['regex']
           add_errored_item(data_hash, field_to_validate, 'value') if (data_hash[field_to_validate].to_s !~ Regexp.new(params['regex'], true))
         elsif params['less_than']
-          add_errored_item(data_hash, field_to_validate, 'value') if !(data_hash[field_to_validate] < params['less_than'])
+          add_errored_item(data_hash, field_to_validate, 'value') if !(data_hash[field_to_validate].to_i < params['less_than'].to_i)
         elsif params['greater_than']
-          add_errored_item(data_hash, field_to_validate, 'value') if !(data_hash[field_to_validate] > params['greater_than'])
+          add_errored_item(data_hash, field_to_validate, 'value') if !(data_hash[field_to_validate].to_i > params['greater_than'].to_i)
         else
           unknown_value_error
         end

data/lib/ae_easy/qa/version.rb

@@ -1,5 +1,5 @@
 module AeEasy
   module Qa
-    VERSION = "0.0.28"
+    VERSION = "0.0.33"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ae_easy-qa
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.33
 platform: ruby
 authors:
 - David Lynam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: answersengine
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: AnswersEngine Easy Quality Assurance gem