The pg_auto_validate_enums plugin implements automatic validations for enum columns, ensuring that enum columns have a valid value. With this plugin, trying to save with an invalid enum value results in Sequel::ValidationFailed before saving, instead of Sequel::DatabaseError (wrapping PG::InvalidTextRepresentation or similar exception) during saving.
class Person < Sequel::Model # assume state enum column with allowed values active and inactive plugin :pg_auto_validate_enums end p = Person.new(state: "active").valid? # => true p = Person.new(state: "inactive").valid? # => true p = Person.new(state: "other").valid? # => false
While you can load this into individual model classes, typical use would be to load it into Sequel::Model or the appropriate model base class, and have all models that inherit from that class automatically pick it up.
This plugin depends on the validation_helpers plugin.
Classes and Modules
Public Class methods
Load the validation_helpers plugin.
# File lib/sequel/plugins/pg_auto_validate_enums.rb 26 def self.apply(model, opts=OPTS) 27 model.plugin(:validation_helpers) 28 end
Load the pg_enum extension into the database, and reload the schema if it is already loaded. The opts given are used for the validates_includes validations (with allow_nil: true and from: :values enabled by default, to avoid issues with nullable enum columns and cases where the column method has been overridden.
# File lib/sequel/plugins/pg_auto_validate_enums.rb 35 def self.configure(model, opts=OPTS) 36 model.instance_exec do 37 db.extension(:pg_enum) unless @db.instance_variable_get(:@enum_labels) 38 if @db_schema 39 get_db_schema(true) 40 _get_pg_pg_auto_validate_enums_metadata 41 end 42 @pg_auto_validate_enums_opts = {allow_nil: true, from: :values}.merge!(opts).freeze 43 end 44 end