qwack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68b356c4e1298450d74b96b5ccb7c9f65a7cf39bfd8a8cb283436029ae7219fa
+  data.tar.gz: aa175dc9cd62399b9c60c030031315eb569dabb2a68c9d71d986591192187bd5
+SHA512:
+  metadata.gz: b493dd31f15e44d5f92c907f04adb2a5a797f15f6e2e8fe05b4f8023ae4f0bb16049bbb04d416ea2f53cb6d06ad51139f2833ddc5c371fec12e3b8649349652e
+  data.tar.gz: d22f14d9decd84f70965c39faa15f2977de588675346379dd8a099a2616609b1ff7ef66d7c5528fcdced7cbc8443e3aaa75308ac55e5ad6fb1536a2d519cee2e

data/LICENSE.txt

@@ -0,0 +1,8 @@
+Copyright 2022 Laurent Humez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/lib/qwack/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative './errors'
+
+module Qwack
+  # Base module for types
+  module Base
+    def validation_errors(input, path = 'root')
+      raise NotImplementedError
+    end
+
+    def validate!(input, path = 'root')
+      errors = validation_errors(input, path)
+      raise Qwack::Errors::ValidationError, errors unless errors.empty?
+
+      input
+    end
+
+    def mock(input)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/qwack/base_array.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Qwack
+  # Base module for user defined arrays
+  module BaseArray
+    include Qwack::Base
+
+    def allowed_types
+      ancestors.reverse.each_with_object([]) do |ancestor, obj|
+        obj.append(*ancestor.own_allowed_types) \
+          if ancestor.respond_to?(:own_allowed_types)
+      end
+    end
+
+    def own_allowed_types
+      @own_allowed_types ||= []
+    end
+
+    def validation_errors(input, path = 'root')
+      return [{ path: path, name: name, desc: 'Is not an array', item: input }] \
+        unless input.is_a?(::Array)
+
+      all_allowed_types = allowed_types
+      input.each_with_object([]).with_index do |(item, errors), index|
+        all_allowed_types.each do |type|
+          errors.append(*type.validation_errors(item, "#{path}.#{index}"))
+        end
+      end
+    end
+
+    def mock(input = nil)
+      input || []
+    end
+
+    private
+
+    def allow_types(types)
+      own_allowed_types.append(*types)
+    end
+  end
+end

data/lib/qwack/base_enum.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Qwack
+  # Base module for user defined enums
+  module BaseEnum
+    include Qwack::Base
+
+    def allowed_values
+      ancestors.reverse.each_with_object([]) do |ancestor, obj|
+        obj.append(*ancestor.own_allowed_values) \
+          if ancestor.respond_to?(:own_allowed_values)
+      end
+    end
+
+    def own_allowed_values
+      @own_allowed_values ||= []
+    end
+
+    def validation_errors(input, path = 'root')
+      return [{ path: path, name: name, desc: 'Is not an allowed value', item: input }] \
+        unless allowed_values.include?(input)
+
+      []
+    end
+
+    def mock(input = nil)
+      input || own_allowed_values&.first
+    end
+
+    private
+
+    def allow_values(values)
+      own_allowed_values.append(*values)
+    end
+  end
+end

data/lib/qwack/base_hash.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Qwack
+  # Base module for user defined hashes
+  module BaseHash
+    include Qwack::Base
+
+    def attributes
+      ancestors.reverse.each_with_object({}) do |ancestor, obj|
+        obj.merge!(ancestor.own_attributes) if ancestor.respond_to?(:own_attributes)
+      end
+    end
+
+    def own_attributes
+      @own_attributes ||= {}
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def attribute_validation_errors(input, path, key, errors)
+      if !attributes.key?(key)
+        errors << { path: path, name: name, desc: 'Extraneous keys', item: key }
+      elsif !input.key?(key)
+        errors << { path: path, name: name, desc: 'Missing non-optional key', item: key } \
+          unless attributes[key][:optional] == true
+      elsif input[key].nil?
+        errors << { path: path, name: name, desc: 'Key cannot be null', item: key } \
+          unless attributes[key][:null] == true
+      else
+        errors.append(*attributes[key][:type].validation_errors(input[key], "#{path}.#{key}"))
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def validation_errors(input, path = 'root')
+      return [{ path: path, name: name, desc: 'Is not a Hash', item: input }] \
+        unless input.is_a?(::Hash)
+
+      (attributes.keys + input.keys).uniq.each_with_object([]) do |key, errors|
+        attribute_validation_errors(input, path, key, errors)
+      end
+    end
+
+    def mock(input = nil)
+      attributes.each_with_object({}) do |(key, conf), obj|
+        obj[key] = conf[:type].mock(input&.fetch(key, nil) || conf[:mock])
+      end
+    end
+
+    private
+
+    def add_attribute(key, type:, **args)
+      own_attributes[key] = { type: type, **args }
+    end
+  end
+end

data/lib/qwack/base_type.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'pry'
+require_relative './base'
+
+module Qwack
+  # Base module for user defined types
+  module BaseType
+    include Qwack::Base
+
+    def validators
+      ancestors.reverse.each_with_object([]) do |ancestor, obj|
+        obj.append(*ancestor.own_validators) \
+          if ancestor.respond_to?(:own_validators)
+      end
+    end
+
+    def own_validators
+      @own_validators = [] unless instance_variable_defined?('@own_validators')
+
+      @own_validators
+    end
+
+    def own_default_mock
+      @own_default_mock = nil unless instance_variable_defined?('@own_default_mock')
+
+      @own_default_mock
+    end
+
+    def validation_errors(input, path = 'root')
+      validators.each_with_object([]) do |validator, errors|
+        error = validator.call(input)
+        errors << { path: path, name: name, desc: error, item: input } \
+          unless error.nil?
+      end
+    end
+
+    def mock(input = nil)
+      input || own_default_mock
+    end
+
+    private
+
+    def add_validator(validator)
+      own_validators.push(validator)
+    end
+
+    def default_mock(value)
+      @own_default_mock = value
+    end
+  end
+end

data/lib/qwack/errors.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'pp'
+
+module Qwack
+  module Errors
+    # Wrapper exception around validation errors
+    class ValidationError < StandardError
+      attr_reader :validation_errors
+
+      def initialize(validation_errors = [])
+        @validation_errors = validation_errors
+        super("Found the following errors:\n #{validation_errors.pretty_inspect}")
+      end
+    end
+  end
+end

data/lib/qwack/meta.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative './base_array'
+
+module Qwack
+  # Shorthand for defining Array types
+  class Meta
+    def self.array_of(type)
+      Class.new do
+        extend Qwack::Base
+        extend Qwack::BaseArray
+        allow_types(type)
+      end
+    end
+  end
+end

data/lib/qwack/types/boolean.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../base_type'
+
+module Qwack
+  module Types
+    class Boolean
+      extend Qwack::BaseType
+
+      add_validator ->(input) { 'Not a boolean' unless [true, false].include?(input) }
+
+      default_mock false
+    end
+  end
+end

data/lib/qwack/types/date.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'date'
+require_relative '../base_type'
+
+module Qwack
+  module Types
+    class Date
+      extend Qwack::BaseType
+
+      add_validator lambda { |input|
+        begin
+          DateTime.parse(input)
+          nil
+        rescue StandardError
+          'Not a date'
+        end
+      }
+
+      default_mock '1990-01-01T00:00:00+00'
+    end
+  end
+end

data/lib/qwack/types/email.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../base_type'
+
+module Qwack
+  module Types
+    class Email
+      extend Qwack::BaseType
+
+      add_validator ->(input) { 'Not an email' unless input&.match?(URI::MailTo::EMAIL_REGEXP) }
+
+      default_mock 'name@domain'
+    end
+  end
+end

data/lib/qwack/types/float.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../base_type'
+
+module Qwack
+  module Types
+    class Float
+      extend Qwack::BaseType
+
+      add_validator ->(input) { 'Not a float' unless input.is_a?(::Float) }
+
+      default_mock 0.0
+    end
+  end
+end

data/lib/qwack/types/integer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../base_type'
+
+module Qwack
+  module Types
+    class Integer
+      extend Qwack::BaseType
+
+      add_validator ->(input) { 'Not an integer' unless input.is_a?(::Integer) }
+
+      default_mock 0
+    end
+  end
+end

data/lib/qwack/types/string.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../base_type'
+
+module Qwack
+  module Types
+    class String
+      extend Qwack::BaseType
+
+      add_validator ->(input) { 'Not a string' unless input.is_a?(::String) }
+
+      default_mock ''
+    end
+  end
+end

data/lib/qwack/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Qwack
+  module Version
+    STRING = '0.1.0'
+  end
+end

data/lib/qwack.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative './qwack/base'
+require_relative './qwack/base_array'
+require_relative './qwack/base_enum'
+require_relative './qwack/base_hash'
+require_relative './qwack/base_type'
+require_relative './qwack/errors'
+require_relative './qwack/meta'
+require_relative './qwack/types/boolean'
+require_relative './qwack/types/date'
+require_relative './qwack/types/email'
+require_relative './qwack/types/float'
+require_relative './qwack/types/integer'
+require_relative './qwack/types/string'

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: qwack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Laurent Humez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      Qwack is an extensible, lightweight DLS to dynamically
+      verify and mock scalar types.
+      It is meant primilarily to handle parsed JSON objects
+      eg: from an API or a database field
+email: lahumez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- lib/qwack.rb
+- lib/qwack/base.rb
+- lib/qwack/base_array.rb
+- lib/qwack/base_enum.rb
+- lib/qwack/base_hash.rb
+- lib/qwack/base_type.rb
+- lib/qwack/errors.rb
+- lib/qwack/meta.rb
+- lib/qwack/types/boolean.rb
+- lib/qwack/types/date.rb
+- lib/qwack/types/email.rb
+- lib/qwack/types/float.rb
+- lib/qwack/types/integer.rb
+- lib/qwack/types/string.rb
+- lib/qwack/version.rb
+homepage: https://github.com/godric/qwack
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/godric/qwack
+  source_code_uri: https://github.com/godric/qwack
+  bug_tracker_uri: https://github.com/godric/qwack/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Dynamic typing DLS for plain hashes.
+test_files: []