validate-rb 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d7f65479ecf94e4e15474fd5f86ca4bd8b46a4260b0a1e77b3d666ca0e52e8d
+  data.tar.gz: dec398c1f408cd2bfdee3281e386c313f19d67d9cfc5ade0c3c22bf16c3b764c
+SHA512:
+  metadata.gz: 32b614ffea7a9909f64a3ced25f761347b19358771f9b6579d0eaa55e7bda35c6cf30650026faa3e4149b7205cb77f5fdcfb574516ac6ad78eac59bf076e9b15
+  data.tar.gz: 897066f58c0f7f7197b1821902a5039279a34ac1cb3c196448a3d4a5caf2bc1e3fc45fa8fdf0919ad5ba45a09363a087afac3715d7201189b1127f31f3d6a8f9

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in validaterb.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,124 @@
+# Validate.rb
+
+Yummy constraint validations for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validaterb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install validaterb
+
+## Usage
+
+### Defining a validator
+
+Validators are a collection of constraints
+
+```ruby
+require 'validate'
+
+# validators can be named
+Validate::Validators.define(:create_user_request) do
+  # attr is a type of constraint that defines constraints on an attribute
+  attr(:username) { not_blank }
+  attr(:address) do
+    not_nil
+    # 'valid' constraint continues validation further down the object graph
+    valid
+  end
+end
+
+# validators can also be defined for a specific class
+Validate::Validators.define(Address) do
+  attr(:street) do
+    not_blank
+    is_a(String)
+    attr(:length) { max(255) }
+  end
+
+  attr(:zip) do
+    # constraints have default error messages, which can be changed
+    match(/[0-9]{5}\-[0-9]{4}/, message: '%{value.inspect} must be a zip')
+  end
+end
+
+address = Address.new(street: '123 Any Road', zip: '11223-3445')
+request = CreateUser.new(username: 'janedoe',
+                         address: address)
+
+violations = Validate.validate(request, as: :create_user_request)
+
+violations.group_by(&:path).each do |path, violations|
+  puts "#{path} is invalid:"
+  violations.each do |v|
+    puts "  #{v.message}"
+  end
+end
+```
+
+### Creating constraints
+
+Constraints have properties and can be evaluated
+
+```ruby
+# constraints must have a name
+Validate::Constraints.define(:not_blank) do
+  # evaluation can 'fail' or 'pass'
+  evaluate { |value| fail if value.nil? || value.empty? }
+end
+
+# 'attr' is just another constraint, like 'not_blank'
+Validate::Constraints.define(:attr) do
+  # constraints can have options
+  # every constraint at least has a :message option
+  # constraint options can have validation constraints
+  option(:name) { not_blank & is_a(Symbol) }
+  option(:validator) { is_a(Validate::Validators::Validator) }
+
+  # by default, constraints expect **kwargs for options
+  # initializer can be defined to translates from arbitrary args to options map
+  initialize do |name, &validation_block|
+    {
+      name: name,
+      # validators can be created anonymously
+      validator: Validate::Validators.create(&validation_block)
+    }
+  end
+
+  evaluate do |value, ctx|
+    # pass constraints on non-values to support optional validation
+    pass if value.nil?
+
+    # fetch an option
+    name = options[:name]
+    fail unless value.respond_to?(name)
+
+    # validation context can be used to traverse object graph
+    # `ValidationContext#attr(attribute)` creates a `ValidationContext` for object's `attribute`
+    # there is also `ValidationContext#key` to validate keys in a hash, useful for ENV validation
+    attr_ctx = ctx.attr(name)
+    options[:validator]&.validate(attr_ctx)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gusto-validation.
+

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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "validaterb"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/validate-rb.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'validate'

data/lib/validate.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "validaterb/version"
+
+module Validate
+end

data/lib/validate/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Validate
+  VERSION = '0.1.0.pre'.freeze
+end

data/validate-rb.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/validate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'validate-rb'
+  spec.version       = Validate::VERSION
+  spec.authors       = ['Bulat Shakirzyanov']
+  spec.email         = ['bulat.shakirzyanov@gusto.com']
+
+  spec.summary       = 'Yummy constraint validations for Ruby'
+  spec.description   = 'Simple, powerful, and constraint-based validation'
+  spec.homepage      = 'https://github.com/Gusto/validaterb'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata    = {
+    'homepage_uri' => 'https://github.com/Gusto/validaterb',
+    'changelog_uri' => 'https://github.com/Gusto/validaterb/releases',
+    'source_code_uri' => 'https://github.com/Gusto/validaterb',
+    'bug_tracker_uri' => 'https://github.com/Gusto/validaterb/issues',
+  }
+
+  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']
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: validate-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Bulat Shakirzyanov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-13 00:00:00.000000000 Z
+dependencies: []
+description: Simple, powerful, and constraint-based validation
+email:
+- bulat.shakirzyanov@gusto.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/validate-rb.rb
+- lib/validate.rb
+- lib/validate/version.rb
+- validate-rb.gemspec
+homepage: https://github.com/Gusto/validaterb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Gusto/validaterb
+  changelog_uri: https://github.com/Gusto/validaterb/releases
+  source_code_uri: https://github.com/Gusto/validaterb
+  bug_tracker_uri: https://github.com/Gusto/validaterb/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Yummy constraint validations for Ruby
+test_files: []