st_validation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d05c5f917d6f84aa0156cde50c68081d41d0fc8328723008785c6056e3a9bf4
+  data.tar.gz: bff39f336727f38a08f86f7ad8b282e9d610937cb4cb0ef564c302bef826abe5
+SHA512:
+  metadata.gz: '0768162330257a317bbbc80b75ebafabbf8282784ee4a81d39cf1556672856b4c977fffc77e0e207c6556e707961a6781e4c258c765f336ee4624a31d4737959'
+  data.tar.gz: 02e9b0e68e2ca20cb0a89a3f3e366dbd7c141bd33170331a1c4c7849df5101af9d10df32e475ed87f695065ec02ee9accb677a0231668c53a7419c41ec5e21d0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in st_validation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dmitry Non
+
+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/README.org

@@ -0,0 +1,193 @@
+#+TITLE: St. Validation
+
+Incredibly simple and customisable validation DSL
+
+#+BEGIN_SRC ruby
+is_valid_user = StValidation.build(
+  id: Integer,
+  name: String,
+  age: ->(x) { x.is_a?(Integer) && (0..150).cover?(x) },
+  favourite_food: [String],
+  dog: Set[NilClass, { name: String, age: Integer, breed: Set[NilClass, String] }]
+)
+
+is_valid_user.call(
+  id: 123,
+  name: 'John',
+  age: 18,
+  favourite_food: %w[apples pies],
+  dog: { name: 'Lucky', age: 2 }
+)
+
+# ===> true
+#+END_SRC
+
+* Table of Contents   <-- :TOC: -->
+- [[#installation][Installation]]
+- [[#usage][Usage]]
+  - [[#terms][Terms]]
+  - [[#basic-syntax][Basic syntax]]
+    - [[#classes][Classes]]
+    - [[#sets-unions][Sets (unions)]]
+    - [[#arrays][Arrays]]
+    - [[#hashes][Hashes]]
+      - [[#when-we-dont-care-about-additional-keys][When we don't care about additional keys]]
+    - [[#misc][Misc]]
+      - [[#boolean][Boolean]]
+      - [[#maybe-optional-values][Maybe (optional values)]]
+  - [[#tinkering-dsl][Tinkering DSL]]
+    - [[#important-note][Important note!]]
+- [[#contributing][Contributing]]
+- [[#license][License]]
+
+* Installation
+
+#+BEGIN_SRC ruby
+gem 'st_validation'
+#+END_SRC
+
+* Usage
+
+** Terms
+
+- *validator* - proc-predicate or an object from
+  `StValidation::AbstractValidator` family and used for validating an object.
+  This is what you want to get from this gem in the end.
+- *factory* - refers to a `StValidation::ValidatorFactory` and transforms
+  /blueprints/ into /validators/ by given set of /transformations/.
+  - *blueprint* - a validator or something that can be transformed into a
+    validator by factory.
+  - *transformation* - function =f(blueprint, factory)= returning a
+    /blueprint/. The core of the DSL itself.
+
+** Basic syntax
+
+All of these are blueprints. Some of them are composable, e.g arrays and
+hashes.
+
+*** Classes
+
+By using a class as a blueprint the result validator will check if an object
+belongs to the class.
+
+#+BEGIN_SRC ruby
+is_int = StValidation.build(Integer)
+is_int.call(123) # ==> true
+is_int.call('123') # ==> false
+#+END_SRC
+
+*** Sets (unions)
+
+Checks if a value matches /any/ provided blueprint.
+
+#+BEGIN_SRC ruby
+is_str_or_int = Set[String, Integer]
+is_str_or_int.call(123) # ==> true
+is_str_or_int.call('123') # ==> true
+#+END_SRC
+
+*** Arrays
+
+Arrays are defined via =[<blueprint>]=. The result validator checks if its
+every element matches =blueprint=. Note that array should be of /exactly/ one element.
+
+#+BEGIN_SRC ruby
+is_bool_array = StValidation.build([Set[TrueClass, FalseClass]])
+is_bool_array.call(true) # ==> false
+is_bool_array.call([]) # ==> true
+is_bool_array.call([false]) # ==> true
+#+END_SRC
+
+*** Hashes
+
+Quite naturally, hashes just check if every key matches a blueprint.
+
+#+BEGIN_SRC ruby
+is_user = StValidation.build(
+  id: Integer,
+  email: String,
+  info: { first_name: String,
+          last_name: String }
+)
+#+END_SRC
+
+**** When we don't care about additional keys
+
+There's a =HashSubsetValidator= for that. It checks only provided keys.
+
+#+BEGIN_SRC ruby
+is_user = StValidation::Validators::HashSubsetValidator.new(
+  id: Integer,
+  email: String,
+  info: { first_name: String,
+          last_name: String }
+)
+
+is_user.call(
+  id: 123,
+  email: 'user@example.com',
+  info: { first_name: 'John', last_name: 'Doe' },
+  phone: '+123456',
+  notes: 'Loves beer'
+)
+# ==> true
+#+END_SRC
+
+*** Misc
+
+**** Boolean
+
+Ruby doesn't have a class for bool value.
+Instead, it has =TrueClass= and =FalseClass= which we can use with in a set:
+
+#+BEGIN_SRC ruby
+is_bool = Set[TrueClass, FalseClass]
+#+END_SRC
+
+**** Maybe (optional values)
+
+Again, sets are to rescue:
+
+#+BEGIN_SRC ruby
+maybe_int = Set[NilClass, Integer]
+#+END_SRC
+
+** Tinkering DSL
+
+The ultimate goal of the factory is to return a validator.
+In order to generate a validator from a blueprint is to /transform/ it.
+
+Factory instance has a collection of transformations.
+Each of them is applied to a blueprint until there's no transformations done.
+
+Let's introduce some sugar syntax for booleans.
+
+#+BEGIN_SRC ruby
+factory = StValidation.with_extra_transformations(
+  ->(bp, factory) { bp == :bool ? Set[TrueClass, FalseClass] : bp  }
+)
+
+is_user = factory.build(
+  name: String,
+  loves_beer: :bool
+)
+
+is_user.call(name: 'John Doe', loves_beer: true) # ==> true
+#+END_SRC
+
+*** Important note!
+
+A blueprint goes through *all* transformations.
+The process stops when no transformation changed the blueprint.
+
+Do *not* rely on order; it's not guarantueed.
+
+
+* Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/Nondv/st_validation.rb
+
+* License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "st_validation"
+
+# 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/st_validation/abstract_validator.rb

@@ -0,0 +1,11 @@
+module StValidation
+  class AbstractValidator
+    def call
+      raise 'implement this'
+    end
+
+    def to_proc
+      ->(x) { call(x) }
+    end
+  end
+end

data/lib/st_validation/errors.rb

@@ -0,0 +1,4 @@
+module StValidation
+  class Error < StandardError; end
+  class InvalidBlueprintError < StValidation::Error; end
+end

data/lib/st_validation/validator_factory.rb

@@ -0,0 +1,22 @@
+module StValidation
+  class ValidatorFactory
+    attr_reader :transformations
+
+    def initialize(transformations = [])
+      @transformations = transformations
+    end
+
+    def build(blueprint)
+      result = blueprint
+      loop do
+        old = result
+        result = transformations.reduce(result) { |res, t| t.call(res, self) }
+        break if result == old
+      end
+
+      raise InvalidBlueprintError unless result.is_a?(Proc) || result.is_a?(AbstractValidator)
+
+      result
+    end
+  end
+end

data/lib/st_validation/validators/array_validator.rb

@@ -0,0 +1,17 @@
+require_relative '../abstract_validator'
+
+module StValidation
+  module Validators
+    class ArrayValidator < AbstractValidator
+      def initialize(element_blueprint, factory)
+        @validator = factory.build(element_blueprint)
+      end
+
+      def call(value)
+        return false unless value.is_a?(Array)
+
+        value.all?(&@validator)
+      end
+    end
+  end
+end

data/lib/st_validation/validators/class_validator.rb

@@ -0,0 +1,15 @@
+require_relative '../abstract_validator'
+
+module StValidation
+  module Validators
+    class ClassValidator < AbstractValidator
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def call(value)
+        value.is_a?(@klass)
+      end
+    end
+  end
+end

data/lib/st_validation/validators/hash_subset_validator.rb

@@ -0,0 +1,24 @@
+require_relative '../abstract_validator'
+require_relative 'hash_validator'
+
+module StValidation
+  module Validators
+    # Use this when you don't care if there're extra keys set
+    class HashSubsetValidator < AbstractValidator
+      def initialize(blueprint, factory = StValidation.basic_factory)
+        @keys = blueprint.keys
+        @hash_validator = StValidation::Validators::HashValidator.new(blueprint, factory)
+      end
+
+      def call(value)
+        return false unless value.is_a?(Hash)
+
+        @hash_validator.call(value.slice(*keys))
+      end
+
+      private
+
+      attr_reader :keys, :hash_validator
+    end
+  end
+end

data/lib/st_validation/validators/hash_validator.rb

@@ -0,0 +1,23 @@
+require_relative '../abstract_validator'
+
+module StValidation
+  module Validators
+    class HashValidator < AbstractValidator
+      def initialize(blueprint, factory)
+        @validators = blueprint.map { |k, bp| [k, factory.build(bp)] }.to_h
+      end
+
+      def call(value)
+        return false unless value.is_a?(Hash) &&
+                            (value.keys - validators.keys).empty?
+
+        validators.each { |k, v| return false unless v.call(value[k]) }
+        true
+      end
+
+      private
+
+      attr_reader :validators
+    end
+  end
+end

data/lib/st_validation/validators/union_validator.rb

@@ -0,0 +1,21 @@
+require_relative '../abstract_validator'
+
+module StValidation
+  module Validators
+    ##
+    # Checks if a value matches any of given blueprints
+    #
+    class UnionValidator < AbstractValidator
+      def initialize(blueprint_list, factory)
+        # TODO: I think it's better to raise a different kind of error and transform it later
+        raise InvalidBlueprintError if blueprint_list.empty?
+
+        @validators = blueprint_list.map { |bp| factory.build(bp) }
+      end
+
+      def call(value)
+        @validators.any? { |v| v.call(value) }
+      end
+    end
+  end
+end

data/lib/st_validation/version.rb

@@ -0,0 +1,3 @@
+module StValidation
+  VERSION = "0.1.0"
+end

data/lib/st_validation.rb

@@ -0,0 +1,51 @@
+require 'set'
+
+require_relative "st_validation/version"
+require_relative "st_validation/errors"
+require_relative 'st_validation/validator_factory'
+
+Dir[File.join(__dir__, 'st_validation', 'validators', '*.rb')].each { |file| require file }
+
+module StValidation
+  class << self
+    def build(blueprint)
+      basic_factory.build(blueprint)
+    end
+
+    def with_extra_transformations(*transformations)
+      all_transformations = transformations + basic_transformations
+      StValidation::ValidatorFactory.new(all_transformations)
+    end
+
+    def basic_factory
+      StValidation::ValidatorFactory.new(basic_transformations)
+    end
+
+    private
+
+    def basic_transformations
+      [
+        ->(bp, _factory) { bp.is_a?(Class) ? class_validator(bp) : bp },
+        ->(bp, factory) { bp.is_a?(Set) ? union_validator(bp, factory) : bp },
+        ->(bp, factory) { bp.is_a?(Hash) ? hash_validator(bp, factory) : bp },
+        ->(bp, factory) { bp.is_a?(Array) && bp.size == 1 ? array_validator(bp[0], factory) : bp }
+      ]
+    end
+
+    def class_validator(klass)
+      Validators::ClassValidator.new(klass)
+    end
+
+    def union_validator(blueprint, factory)
+      Validators::UnionValidator.new(blueprint, factory)
+    end
+
+    def array_validator(blueprint, factory)
+      Validators::ArrayValidator.new(blueprint, factory)
+    end
+
+    def hash_validator(blueprint, factory)
+      Validators::HashValidator.new(blueprint, factory)
+    end
+  end
+end

data/st_validation.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "st_validation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "st_validation"
+  spec.version       = StValidation::VERSION
+  spec.authors       = ["Dmitry Non"]
+  spec.email         = ["mail@nondv.io"]
+
+  spec.summary       = 'Yet another validation library'
+  spec.homepage      = 'https://github.com/Nondv/st_validation.rb'
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: st_validation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Non
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- mail@nondv.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.org
+- Rakefile
+- bin/console
+- bin/setup
+- lib/st_validation.rb
+- lib/st_validation/abstract_validator.rb
+- lib/st_validation/errors.rb
+- lib/st_validation/validator_factory.rb
+- lib/st_validation/validators/array_validator.rb
+- lib/st_validation/validators/class_validator.rb
+- lib/st_validation/validators/hash_subset_validator.rb
+- lib/st_validation/validators/hash_validator.rb
+- lib/st_validation/validators/union_validator.rb
+- lib/st_validation/version.rb
+- st_validation.gemspec
+homepage: https://github.com/Nondv/st_validation.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Yet another validation library
+test_files: []