A tour of dry-schema and dry-validation 1.0 - Speaker Deck

Tweet

Tweet

Slide 1

Slide 1 text

A tour of dry-schema and dry-validation 1.0 ROROSyd, June 2019

Slide 2

Slide 2 text

@timriley

Slide 3

Slide 3 text

@timriley @icelab

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

@dry_rb

Slide 8

Slide 8 text

@dry_rb @icelab ✕

Slide 9

Slide 9 text

dry-schema dry-validation

Slide 10

Slide 10 text

dry-schema dry-validation 1.1.0 1.0.0

Slide 11

Slide 11 text

dry-schema dry-validation

Slide 12

Slide 12 text

dry-schema dry-validation Validation of data structures

Slide 13

Slide 13 text

dry-schema dry-validation Validation of data structures Validation using business rules

Slide 14

Slide 14 text

Piotr Solnica @_solnic_

Slide 15

Slide 15 text

Why validate?

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

!

Slide 19

Slide 19 text

!

Slide 20

Slide 20 text

! "

Slide 21

Slide 21 text

dry-schema

Slide 22

Slide 22 text

dry-schema Focus on data structures & types

Slide 23

Slide 23 text

require "dry/schema" schema = Dry::Schema.Params do required(:email).filled(:string) required(:age).filled(:integer) end

Slide 24

Slide 24 text

require "dry/schema" schema = Dry::Schema.Params do required(:email).filled(:string) required(:age).filled(:integer) end

Slide 25

Slide 25 text

require "dry/schema" schema = Dry::Schema.Params do required(:email).filled(:string) required(:age).filled(:integer) end

Slide 26

Slide 26 text

require "dry/schema" schema = Dry::Schema.Params do required(:email).filled(:string) required(:age).filled(:integer) end

Slide 27

Slide 27 text

require "dry/schema" schema = Dry::Schema.Params do required(:email).filled(:string) required(:age).filled(:integer) end

Slide 28

Slide 28 text

require "dry/schema" schema = Dry::Schema.Params do required(:email).filled(:string) required(:age).filled(:integer) end Structure

Slide 29

Slide 29 text

require "dry/schema" schema = Dry::Schema.Params do required(:email).filled(:string) required(:age).filled(:integer) end Structure

Slide 30

Slide 30 text

require "dry/schema" schema = Dry::Schema.Params do required(:email).filled(:string) required(:age).filled(:integer) end Types Structure

Slide 31

Slide 31 text

result = schema.call( "email" => "jane@example.com", "age" => "35", ) # => #"jane@example.com", :age=>35 # } errors={}>

Slide 32

Slide 32 text

result = schema.call( "email" => "jane@example.com", "age" => "35", ) # => #"jane@example.com", :age=>35 # } errors={}>

Slide 33

Slide 33 text

result = schema.call( "email" => "jane@example.com", "age" => "35", ) # => #"jane@example.com", :age=>35 # } errors={}>

Slide 34

Slide 34 text

result = schema.call( "email" => "jane@example.com", "age" => "35", ) # => #"jane@example.com", :age=>35 # } errors={}>

Slide 35

Slide 35 text

result = schema.call( "email" => "jane@example.com", "age" => "35", ) # => #"jane@example.com", :age=>35 # } errors={}>

Slide 36

Slide 36 text

result = schema.call( "email" => "jane@example.com", "age" => "35", ) # => #"jane@example.com", :age=>35 # } errors={}>

Slide 37

Slide 37 text

result = schema.call( "email" => "jane@example.com", "age" => "35", ) # => #"jane@example.com", :age=>35 # } errors={}>

Slide 38

Slide 38 text

result = schema.call( "email" => "jane@example.com", "age" => "35", ) # => #"jane@example.com", :age=>35 # } errors={}>

Slide 39

Slide 39 text

result = schema.call( "email" => "jane@example.com", "age" => "35", ) # => #"jane@example.com", :age=>35 # } errors={}>

Slide 40

Slide 40 text

result = schema.call( "email" => "", "age" => "35", ) # => #"", :age=>35 # } # errors={ # :email=>["must be filled"] # }>

Slide 41

Slide 41 text

result = schema.call( "email" => "", "age" => "35", ) # => #"", :age=>35 # } # errors={ # :email=>["must be filled"] # }>

Slide 42

Slide 42 text

result = schema.call( "email" => "", "age" => "35", ) # => #"", :age=>35 # } # errors={ # :email=>["must be filled"] # }>

Slide 43

Slide 43 text

Dry::Schema.Params do required(:email).filled(:string) required(:age).maybe(:integer) end

Slide 44

Slide 44 text

Dry::Schema.Params do required(:email).filled(:string) required(:age).maybe(:integer) end

Slide 45

Slide 45 text

Dry::Schema.Params do required(:email).filled(:string) optional(:age).maybe(:integer) end

Slide 46

Slide 46 text

Dry::Schema.Params do required(:email).filled(:string) optional(:age).maybe(:integer) end

Slide 47

Slide 47 text

Dry::Schema.Params do required(:email).filled(:string) optional(:age).maybe(:integer) required(:address).hash do required(:city).filled(:string) required(:postcode).filled(:string) end end

Slide 48

Slide 48 text

Dry::Schema.Params do required(:email).filled(:string) optional(:age).maybe(:integer) required(:address).hash(AddressSchema) end

Slide 49

Slide 49 text

Dry::Schema.Params do required(:email).filled(:string) optional(:age).maybe(:integer) required(:address).maybe do hash(AddressSchema) end end

Slide 50

Slide 50 text

Dry::Schema.Params do required(:email).filled(:string) optional(:age).maybe(:integer) required(:address).maybe do hash(AddressSchema) end required(:nicknames).array(:string) end

Slide 51

Slide 51 text

Dry::Schema.Params do required(:email).filled(:string) optional(:age).maybe(:integer) required(:address).maybe do hash(AddressSchema) end required(:nicknames).array(:hash) do required(:name).filled(:string) required(:date_granted).maybe(:date) end end

Slide 52

Slide 52 text

Dry::Schema.Params do optional(:age).filled(:integer) end

Slide 53

Slide 53 text

Dry::Schema.Params do optional(:age).filled(:integer) end

Slide 54

Slide 54 text

Dry::Schema.Params do optional(:age).filled(:integer) end Dry::Types["params.integer"]

Slide 55

Slide 55 text

Dry::Schema.Params do optional(:age).filled(:integer) end Dry::Types["params.integer"]["35"] # => 35

Slide 56

Slide 56 text

Dry::Schema.Params do optional(:age).filled(:integer) end Dry::Types["params.integer"]["35"] # => 35

Slide 57

Slide 57 text

Dry::Schema.Params do optional(:age).filled(:integer) end Dry::Types["params.integer"]["35"] # => 35

Slide 58

Slide 58 text

module Types include Dry.Types StrippedString = Types::String.constructor(&:strip) end schema = Dry::Schema.Params do optional(:name).filled(Types::StrippedString) end schema.("name" => " Clover ") # => #"Clover"} errors={}>

Slide 59

Slide 59 text

module Types include Dry.Types StrippedString = Types::String.constructor(&:strip) end schema = Dry::Schema.Params do optional(:name).filled(Types::StrippedString) end schema.("name" => " Clover ") # => #"Clover"} errors={}>

Slide 60

Slide 60 text

module Types include Dry.Types StrippedString = Types::String.constructor(&:strip) end schema = Dry::Schema.Params do optional(:name).filled(Types::StrippedString) end schema.("name" => " Clover ") # => #"Clover"} errors={}>

Slide 61

Slide 61 text

module Types include Dry.Types StrippedString = Types::String.constructor(&:strip) end schema = Dry::Schema.Params do optional(:name).filled(Types::StrippedString) end schema.("name" => " Clover ") # => #"Clover"} errors={}>

Slide 62

Slide 62 text

module Types include Dry.Types StrippedString = Types::String.constructor(&:strip) end schema = Dry::Schema.Params do optional(:name).filled(Types::StrippedString) end schema.("name" => " Clover ") # => #"Clover"} errors={}>

Slide 63

Slide 63 text

module Types include Dry.Types StrippedString = Types::String.constructor(&:strip) end schema = Dry::Schema.Params do optional(:name).filled(Types::StrippedString) end schema.("name" => " Clover ") # => #"Clover"} errors={}>

Slide 64

Slide 64 text

dry-types

Slide 65

Slide 65 text

dry-validation

Slide 66

Slide 66 text

dry-validation Focus on business rules

Slide 67

Slide 67 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end end

Slide 68

Slide 68 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end end

Slide 69

Slide 69 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end end

Slide 70

Slide 70 text

contract = EventContract.new contract.( "name" => "ROROSyd", "starts_at" => "2019-06-11 18:00", "ends_at" => "2019-06-11 22:00", ) # => #"ROROSyd", # :starts_at=>2019-06-11 18:00:00 +1000, # :ends_at=>2019-06-11 22:00:00 +1000 # } errors={}>

Slide 71

Slide 71 text

contract = EventContract.new contract.call( "name" => "ROROSyd", "starts_at" => "2019-06-11 18:00", "ends_at" => "2019-06-11 22:00", ) # => #"ROROSyd", # :starts_at=>2019-06-11 18:00:00 +1000, # :ends_at=>2019-06-11 22:00:00 +1000 # } errors={}>

Slide 72

Slide 72 text

contract = EventContract.new contract.call( "name" => "ROROSyd", "starts_at" => "2019-06-11 18:00", "ends_at" => "2019-06-11 22:00", ) # => #"ROROSyd", # :starts_at=>2019-06-11 18:00:00 +1000, # :ends_at=>2019-06-11 22:00:00 +1000 # } errors={}>

Slide 73

Slide 73 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end end

Slide 74

Slide 74 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key.failure("must be after start time") end end end

Slide 75

Slide 75 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key.failure("must be after start time") end end end

Slide 76

Slide 76 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key.failure("must be after start time") end end end

Slide 77

Slide 77 text

contract = EventContract.new contract.call( "name" => "ROROSyd", "starts_at" => "2019-06-11 18:00", "ends_at" => "2019-06-11 17:00", ).errors.to_h # => {:ends_at=>["must be after start time”]}

Slide 78

Slide 78 text

contract = EventContract.new contract.( "name" => "ROROSyd", "starts_at" => "2019-06-11 18:00", "ends_at" => "2019-06-11 17:00", ).errors.to_h # => {:ends_at=>["must be after start time”]}

Slide 79

Slide 79 text

contract = EventContract.new contract.( "name" => "ROROSyd", "starts_at" => "2019-06-11 18:00", "ends_at" => "2019-06-11 17:00", ).errors.to_h # => {:ends_at=>["must be after start time"]}

Slide 80

Slide 80 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key.failure("must be after start time") end end end

Slide 81

Slide 81 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key.failure("must be after start time") end end end

Slide 82

Slide 82 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key.failure("must be after start time") end end end

Slide 83

Slide 83 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key(:ends_at).failure("must be…") end end end

Slide 84

Slide 84 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key(:ends_at).failure("must be…") end end end

Slide 85

Slide 85 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key(:times).failure("must be…") end end end

Slide 86

Slide 86 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key(:times).failure("must be…") end end end

Slide 87

Slide 87 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] base.failure("times must be…") end end end

Slide 88

Slide 88 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] base.failure("times must be…") end end end

Slide 89

Slide 89 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key.failure("must be after start time") end end end

Slide 90

Slide 90 text

class EventContract < Dry::Validation::Contract params do required(:name).filled(:string) required(:starts_at).filled(:time) required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do if value && value <= values[:starts_at] key.failure("must be after start time") end end end

Slide 91

Slide 91 text

contract = EventContract.new contract.( "name" => "ROROSyd", "starts_at" => "2019-06-11 18:00", "ends_at" => "last drinks", ).errors.to_h # => {:ends_at=>["must be a time”]}

Slide 92

Slide 92 text

contract = EventContract.new contract.( "name" => "ROROSyd", "starts_at" => "2019-06-11 18:00", "ends_at" => "last drinks", ).errors.to_h # => {:ends_at=>["must be a time"]}

Slide 93

Slide 93 text

# => {:ends_at=>["must be a time"]}

Slide 94

Slide 94 text

# => {:ends_at=>["must be a time"]} class EventContract params do # … required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do # … end end

Slide 95

Slide 95 text

# => {:ends_at=>["must be a time"]} class EventContract params do # … required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do # … end end

Slide 96

Slide 96 text

# => {:ends_at=>["must be a time"]} class EventContract params do # … required(:ends_at).maybe(:time) end rule(:ends_at, :starts_at) do # … end end

Slide 97

Slide 97 text

class EventContract < Dry::Validation::Contract option :repo params do required(:slug).filled(:string) end rule(:slug) do unless repo.unique?(:slug, slug) key.failure("is already used") end end end contract = EventContract.new(repo: repo)

Slide 98

Slide 98 text

class EventContract < Dry::Validation::Contract option :event_repo params do required(:slug).filled(:string) end rule(:slug) do unless repo.unique?(:slug, slug) key.failure("is already used") end end end contract = EventContract.new(repo: repo)

Slide 99

Slide 99 text

class EventContract < Dry::Validation::Contract option :event_repo params do required(:slug).filled(:string) end rule(:slug) do unless event_repo.unique?(:slug, value) key.failure("is already used") end end end contract = EventContract.new(repo: repo)

Slide 100

Slide 100 text

class EventContract < Dry::Validation::Contract option :event_repo params do required(:slug).filled(:string) end rule(:slug) do unless event_repo.unique?(:slug, value) key.failure("is already used") end end end contract = EventContract.new(repo: repo)

Slide 101

Slide 101 text

class EventContract < Dry::Validation::Contract option :event_repo params do required(:slug).filled(:string) end rule(:slug) do unless event_repo.unique?(:slug, slug) key.failure("is already used") end end end contract = EventContract.new(event_repo: repo)

Slide 102

Slide 102 text

class EventContract < Dry::Validation::Contract params do required(:slug).filled(:string) end end

Slide 103

Slide 103 text

class BaseContract < Dry::Validation::Contract register_macro :slug_format do unless value.match?(/^[1-9a-z][1-9a-z-]+/) key.failure("must be slug formatted") end end end

Slide 104

Slide 104 text

class BaseContract < Dry::Validation::Contract register_macro :slug_format do unless value.match?(/^[1-9a-z][1-9a-z-]+/) key.failure("must be slug formatted") end end end

Slide 105

Slide 105 text

class BaseContract < Dry::Validation::Contract register_macro :slug_format do unless value.match?(SLUG_REGEXP) key.failure("must be slug formatted") end end end

Slide 106

Slide 106 text

class EventContract < BaseContract params do required(:slug).filled(:string) end rule(:slug).validate(:slug_format) end

Slide 107

Slide 107 text

class EventContract < BaseContract params do required(:slug).filled(:string) end rule(:slug).validate(:slug_format) end

Slide 108

Slide 108 text

class EventContract < BaseContract params do required(:slug).filled(:string) end rule(:slug).validate(:slug_format) end

Slide 109

Slide 109 text

class EventContract < BaseContract params do required(:slug).filled(:string) end rule(:slug).validate(:slug_format) end

Slide 110

Slide 110 text

class EventContract < BaseContract params do required(:slug).filled(:string) end rule(:slug).validate(:slug_format) end

Slide 111

Slide 111 text

dry-schema dry-validation

Slide 112

Slide 112 text

dry-schema dry-validation # #

Slide 113

Slide 113 text

Precise

Slide 114

Slide 114 text

Precise Flexible

Slide 115

Slide 115 text

Precise Flexible Fast

Slide 116

Slide 116 text

Better applications

Slide 117

Slide 117 text

Validate…

Slide 118

Slide 118 text

Validate… Controller params

Slide 119

Slide 119 text

Validate… Controller params In form objects

Slide 120

Slide 120 text

Validate… Controller params In form objects In “service” objects

Slide 121

Slide 121 text

Validate… Controller params Foreign data In form objects In “service” objects

Slide 122

Slide 122 text

Validate… Controller params Foreign data API requests/responses In form objects In “service” objects

Slide 123

Slide 123 text

@timriley / timriley.info @dry_rb / dry-rb.org @icelab / icelab.com.au Thank you!