ae_easy-qa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 162ba4d965200f38a598f82b2f0fcece1271661aed432dcb144192e298e36f0e
+  data.tar.gz: 3617c675139bff6c03aef23d84aec977f36ba38f5cefad71b0cbd55a93ef6cd5
+SHA512:
+  metadata.gz: 499f8a663a16a0916cbeca8b8e0ceb0faef97847281debd19ec4f931e3a9deda204f00fa2d18c06f1dede3576c990cfb685428a6943d7e7207e5b6cf94406453
+  data.tar.gz: 02e39006630eaabb1b7543d73659de897ffec688deaf4721a0631e405d131ccf2de816febbfc85d748e65d40de9bba799e5ccf32ca7e253c48ba0c6b749bde40

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ae_easy/qa"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ae_easy/cli/qa.rb

@@ -0,0 +1,11 @@
+module AnswersEngine
+  class CLI < Thor
+    class Qa < Thor
+
+      def test
+        puts "test"
+      end
+
+    end
+  end
+end

data/lib/ae_easy/qa/validate_rules.rb

@@ -0,0 +1,66 @@
+module AeEasy
+  module Qa
+    class ValidateRules
+      attr_reader :data, :errors, :rules
+      attr_accessor :errored_item
+
+      def initialize(data, errors, rules)
+        @data = data
+        @errors = errors
+        @rules = rules['individual_validations']
+      end
+
+      def run
+        handle_rules
+      end
+
+      private
+
+      def handle_rules
+        data.each do |data_hash|
+          reset_errored_item
+          rules.each{|field_to_validate, options|
+            options.each{|validation, value|
+              case validation
+              when 'required'
+                required_check(data_hash, field_to_validate) if value == true
+              when 'type'
+                ValidateType.new(data_hash, field_to_validate, value, rules, errored_item).run if options['required']
+              when 'value'
+                ValidateValue.new(data_hash, field_to_validate, value, errored_item).run if options['required']
+              when 'length'
+                validate_length(data_hash, field_to_validate, value) if options['required']
+              else
+                unknown_validation_error(validation) if validation !~ /format/
+              end
+            }
+          }
+          errors[:errored_items].push(errored_item) if errored_item && !errored_item[:failures].empty?
+        end
+      end
+
+      def required_check(data_hash, field_to_validate)
+        if data_hash[field_to_validate].nil? || (data_hash[field_to_validate].class == String && data_hash[field_to_validate].empty?)
+          add_errored_item(data_hash, field_to_validate, 'required')
+        end
+      end
+
+      def validate_length(data_hash, field_to_validate, length)
+        add_errored_item(data_hash, field_to_validate, 'length') if data_hash[field_to_validate].to_s.length != length
+      end
+
+      def add_errored_item(data_hash, field_to_validate, validation)
+        errored_item[:data] = data_hash if errored_item[:data].nil?
+        errored_item[:failures].push({ field_to_validate.to_sym => validation })
+      end
+
+      def reset_errored_item
+        self.errored_item = { failures: [] }
+      end
+
+      def unknown_validation_error(validation)
+        raise StandardError.new("The validation '#{validation}' is unknown.")
+      end
+    end
+  end
+end

data/lib/ae_easy/qa/validate_type.rb

@@ -0,0 +1,62 @@
+module AeEasy
+  module Qa
+    class ValidateType < ValidateRules
+      attr_reader :data_hash, :field_to_validate, :desired_type, :rules
+
+      def initialize(data_hash, field_to_validate, desired_type, rules, errored_item)
+        @data_hash = data_hash
+        @field_to_validate = field_to_validate
+        @desired_type = desired_type
+        @rules = rules
+        @errored_item = errored_item
+      end
+
+      def run
+        handle_types
+      end
+
+      private
+
+      def handle_types
+        case desired_type
+        when 'String'
+          add_errored_item(data_hash, field_to_validate, 'type') if data_hash[field_to_validate].class != String
+        when 'Integer'
+          add_errored_item(data_hash, field_to_validate, 'type') unless data_hash[field_to_validate].class == Fixnum || data_hash[field_to_validate].to_s =~ /\A\d+(\.\d+)?\z/
+        when 'Float'
+          add_errored_item(data_hash, field_to_validate, 'type') unless data_hash[field_to_validate].class == Float || data_hash[field_to_validate].to_s =~ /\A\d+(\.\d+)?\z/
+        when 'Date'
+          validate_date_type
+        when 'Url'
+          add_errored_item(data_hash, field_to_validate, 'type') if data_hash[field_to_validate] !~ /^(http|https):\/\//
+        else
+          unknown_type_error(desired_type)
+        end
+      end
+
+      def validate_date_type
+        format = rules[field_to_validate]['format']
+        missing_date_format_error if format.nil?
+        date_str = data_hash[field_to_validate]
+        begin
+          date = Time.strptime(date_str, format.gsub('%-m', '%m').gsub('%-d', '%d'))
+          add_errored_item(data_hash, field_to_validate, 'type') if date.strftime(format) != date_str
+        rescue ArgumentError => e
+          if e.to_s =~ /^invalid strptime format/
+            add_errored_item(data_hash, field_to_validate, 'type')
+          else
+            raise StandardError.new(e.to_s)
+          end
+        end
+      end
+
+      def unknown_type_error(desired_type)
+        raise StandardError.new("The validation type '#{desired_type}' is unknown.")
+      end
+
+      def missing_date_format_error
+        raise StandardError.new("Date validation is missing a format.")
+      end
+    end
+  end
+end

data/lib/ae_easy/qa/validate_value.rb

@@ -0,0 +1,78 @@
+module AeEasy
+  module Qa
+    class ValidateValue < ValidateRules
+      attr_reader :data_hash, :field_to_validate, :params
+
+      def initialize(data_hash, field_to_validate, params, errored_item)
+        @data_hash = data_hash
+        @field_to_validate = field_to_validate
+        @params = params
+        @errored_item = errored_item
+      end
+
+      def run
+        condition_exists? ? handle_conditions : main_value_check
+      end
+
+      private
+
+      def condition_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
+      end
+
+      def main_value_check
+        if params['equal']
+          if equal_with_operators?
+            equal_with_operators
+          else
+            add_errored_item(data_hash, field_to_validate, 'value') if(data_hash[field_to_validate] != params['equal'])
+          end
+        elsif params['less_than']
+          add_errored_item(data_hash, field_to_validate, 'value') if !(data_hash[field_to_validate] < params['less_than'])
+        elsif params['greater_than']
+          add_errored_item(data_hash, field_to_validate, 'value') if !(data_hash[field_to_validate] > params['greater_than'])
+        else
+          unknown_value_error
+        end
+      end
+
+      def equal_with_operators
+        case equal_operator
+        when 'or'
+          add_errored_item(data_hash, field_to_validate, 'value') if !or_statment
+        end
+      end
+
+      def or_statment
+        eval or_vals.map{|val| "data_hash[field_to_validate] == #{val}" }.join(' || ')
+      end
+
+      def equal_with_operators?
+        params['equal'].class == Hash
+      end
+
+      def equal_operator
+        params['equal'].keys.first
+      end
+
+      def or_vals
+        params['equal']['or']
+      end
+
+      def unknown_value_error
+        raise StandardError.new("The value rule '#{params}' is unknown.")
+      end
+    end
+  end
+end

data/lib/ae_easy/qa/version.rb

@@ -0,0 +1,5 @@
+module AeEasy
+  module Qa
+    VERSION = "0.0.1"
+  end
+end

data/lib/ae_easy/qa.rb

@@ -0,0 +1,48 @@
+require 'ae_easy/qa/version'
+require 'ae_easy/qa/validate_rules'
+require 'ae_easy/qa/validate_type'
+require 'ae_easy/qa/validate_value'
+require 'answersengine'
+
+module AeEasy
+  module Qa
+    class Validate
+      attr_accessor :rules
+      attr_reader :data, :errors
+
+      def initialize(data, options={})
+        load_rules
+        @data = data
+        @errors = { errored_items: [] }
+      end
+
+      def run
+        begin
+          ValidateRules.new(data, errors, rules).run if rules
+          return errors
+        rescue StandardError => e
+          puts "An error has occurred: #{e}"
+          return nil
+        end
+      end
+
+      def add_validation(method)
+        instance_eval(&method)
+      end
+
+      def fail_validation
+        self.errors[@name.to_sym] = 'fail'
+      end
+
+      private
+
+      def load_rules
+        self.rules = YAML.load(File.open(config_path))['qa'] if File.exists?(config_path)
+      end
+
+      def config_path
+        @config_path ||= File.expand_path('ae_easy.yaml', Dir.pwd)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: ae_easy-qa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Lynam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ae_easy-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: AnswersEngine Easy QA gem allows you to ensure the quality of output
+  on Fetch
+email:
+- dlynam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- bin/setup
+- lib/ae_easy/cli/qa.rb
+- lib/ae_easy/qa.rb
+- lib/ae_easy/qa/validate_rules.rb
+- lib/ae_easy/qa/validate_type.rb
+- lib/ae_easy/qa/validate_value.rb
+- lib/ae_easy/qa/version.rb
+homepage: https://answersengine.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://answersengine.com
+  source_code_uri: https://github.com/answersengine/ae_easy-qa
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: AnswersEngine Easy Quality Assurance gem
+test_files: []