Check if a field is a String

min_size and max_size are optional

var validator = new ObjectValidator
validator.add new StringField("field", required=false)
assert validator.validate("""{}""")

validator = new ObjectValidator
validator.add new StringField("field")
assert not validator.validate("""{}""")
assert not validator.validate("""{ "field": 10 }""")

validator = new ObjectValidator
validator.add new StringField("field", min_size=3)
assert validator.validate("""{ "field": "foo" }""")
assert not validator.validate("""{ "field": "fo" }""")
assert not validator.validate("""{ "field": "" }""")

validator = new ObjectValidator
validator.add new StringField("field", max_size=3)
assert validator.validate("""{ "field": "foo" }""")
assert not validator.validate("""{ "field": "fooo" }""")

validator = new ObjectValidator
validator.add new StringField("field", min_size=3, max_size=5)
assert not validator.validate("""{ "field": "fo" }""")
assert validator.validate("""{ "field": "foo" }""")
assert validator.validate("""{ "field": "foooo" }""")
assert not validator.validate("""{ "field": "fooooo" }""")

Introduced properties

init defaultinit(field: String, required: nullable Bool, min_size: nullable Int, max_size: nullable Int)

popcorn :: StringField :: defaultinit

fun max_size: nullable Int

popcorn :: StringField :: max_size

String max size (default: not checked)
protected fun max_size=(max_size: nullable Int)

popcorn :: StringField :: max_size=

String max size (default: not checked)
fun min_size: nullable Int

popcorn :: StringField :: min_size

String min size (default: not checked)
protected fun min_size=(min_size: nullable Int)

popcorn :: StringField :: min_size=

String min size (default: not checked)

Redefined properties

redef type SELF: StringField

popcorn $ StringField :: SELF

Type of this instance, automatically specialized in every class
redef fun validate_field(v: ObjectValidator, obj: JsonObject): Bool

popcorn $ StringField :: validate_field

Validate field in obj

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
init defaultinit(field: String, required: nullable Bool, min_size: nullable Int, max_size: nullable Int)

popcorn :: StringField :: defaultinit

init defaultinit(field: String, required: nullable Bool)

popcorn :: RequiredField :: defaultinit

fun field: String

popcorn :: FieldValidator :: field

Field to validate
protected fun field=(field: String)

popcorn :: FieldValidator :: field=

Field to validate
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun max_size: nullable Int

popcorn :: StringField :: max_size

String max size (default: not checked)
protected fun max_size=(max_size: nullable Int)

popcorn :: StringField :: max_size=

String max size (default: not checked)
fun min_size: nullable Int

popcorn :: StringField :: min_size

String min size (default: not checked)
protected fun min_size=(min_size: nullable Int)

popcorn :: StringField :: min_size=

String min size (default: not checked)
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun required: nullable Bool

popcorn :: RequiredField :: required

Is this field required?
protected fun required=(required: nullable Bool)

popcorn :: RequiredField :: required=

Is this field required?
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
abstract fun validate_field(v: ObjectValidator, obj: JsonObject): Bool

popcorn :: FieldValidator :: validate_field

Validate field in obj
package_diagram popcorn::StringField StringField popcorn::RequiredField RequiredField popcorn::StringField->popcorn::RequiredField popcorn::FieldValidator FieldValidator popcorn::RequiredField->popcorn::FieldValidator ...popcorn::FieldValidator ... ...popcorn::FieldValidator->popcorn::FieldValidator popcorn::UniqueField UniqueField popcorn::UniqueField->popcorn::StringField

Ancestors

abstract class FieldValidator

popcorn :: FieldValidator

Something that can validate a JsonObject field
interface Object

core :: Object

The root of the class hierarchy.

Parents

class RequiredField

popcorn :: RequiredField

Check if a field exists

Children

class UniqueField

popcorn :: UniqueField

Check if a field value is already used

Class definitions

popcorn $ StringField
# Check if a field is a String
#
# `min_size` and `max_size` are optional
#
# ~~~
# var validator = new ObjectValidator
# validator.add new StringField("field", required=false)
# assert validator.validate("""{}""")
#
# validator = new ObjectValidator
# validator.add new StringField("field")
# assert not validator.validate("""{}""")
# assert not validator.validate("""{ "field": 10 }""")
#
# validator = new ObjectValidator
# validator.add new StringField("field", min_size=3)
# assert validator.validate("""{ "field": "foo" }""")
# assert not validator.validate("""{ "field": "fo" }""")
# assert not validator.validate("""{ "field": "" }""")
#
# validator = new ObjectValidator
# validator.add new StringField("field", max_size=3)
# assert validator.validate("""{ "field": "foo" }""")
# assert not validator.validate("""{ "field": "fooo" }""")
#
# validator = new ObjectValidator
# validator.add new StringField("field", min_size=3, max_size=5)
# assert not validator.validate("""{ "field": "fo" }""")
# assert validator.validate("""{ "field": "foo" }""")
# assert validator.validate("""{ "field": "foooo" }""")
# assert not validator.validate("""{ "field": "fooooo" }""")
# ~~~
class StringField
	super RequiredField

	# String min size (default: not checked)
	var min_size: nullable Int

	# String max size (default: not checked)
	var max_size: nullable Int

	redef fun validate_field(v, obj) do
		if not super then return false
		var val = obj.get_or_null(field)
		if val == null then
			if required == null or required == true then
				v.validation.add_error(field, "Expected String got `null`")
				return false
			else
				return true
			end
		end
		if not val isa String then
			v.validation.add_error(field, "Expected String got `{val.class_name}`")
			return false
		end
		var min_size = self.min_size
		if min_size != null and val.length < min_size then
			v.validation.add_error(field, "Must be at least `{min_size} characters long`")
			return false
		end
		var max_size = self.max_size
		if max_size != null and val.length > max_size then
			v.validation.add_error(field, "Must be at max `{max_size} characters long`")
			return false
		end
		return true
	end
end
lib/popcorn/pop_validation.nit:314,1--382,3