Check if a field exists

var json1 = """{ "field1": "", "field2": "foo", "field3": 10, "field4": [] }"""
var json2 = """{ "field1": "", "field2": "foo", "field3": 10 }"""
var json3 = """{ "field1": "", "field2": "foo" }"""

var validator = new ObjectValidator
validator.add new RequiredField("field1")
validator.add new RequiredField("field2")
validator.add new RequiredField("field3")
validator.add new RequiredField("field4", required=false)

assert validator.validate(json1)
assert validator.validate(json2)
assert not validator.validate(json3)
assert validator.validation.error("field3") == ["Required field"]

Introduced properties

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

popcorn :: RequiredField :: defaultinit

fun required: nullable Bool

popcorn :: RequiredField :: required

Is this field required?

protected fun required=(required: nullable Bool)

popcorn :: RequiredField :: required=

Is this field required?

Redefined properties

redef type SELF: RequiredField

popcorn $ RequiredField :: SELF

Type of this instance, automatically specialized in every class

redef fun validate_field(v: ObjectValidator, obj: JsonObject): Bool

popcorn $ RequiredField :: 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.

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.

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

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class FieldValidator

popcorn :: FieldValidator

Something that can validate a JsonObject field

Children

class ArrayField

popcorn :: ArrayField

Check that a field is a JsonArray

class BoolField

popcorn :: BoolField

Check if a field is a Bool

class FloatField

popcorn :: FloatField

Check if a field is a Float

class IntField

popcorn :: IntField

Check if a field is an Int

class ObjectField

popcorn :: ObjectField

Check that a field is a JsonObject

class RegexField

popcorn :: RegexField

Check if a field match a regular expression

class StringField

popcorn :: StringField

Check if a field is a String

Descendants

class EmailField

popcorn :: EmailField

Check if a field is a valid email

class ISBNField

popcorn :: ISBNField

Check if a field is a valid ISBN

class URLField

popcorn :: URLField

Check if a field is a valid URL

class UniqueField

popcorn :: UniqueField

Check if a field value is already used

Class definitions

popcorn $ RequiredField

# Check if a field exists
#
# ~~~
# var json1 = """{ "field1": "", "field2": "foo", "field3": 10, "field4": [] }"""
# var json2 = """{ "field1": "", "field2": "foo", "field3": 10 }"""
# var json3 = """{ "field1": "", "field2": "foo" }"""
#
# var validator = new ObjectValidator
# validator.add new RequiredField("field1")
# validator.add new RequiredField("field2")
# validator.add new RequiredField("field3")
# validator.add new RequiredField("field4", required=false)
#
# assert validator.validate(json1)
# assert validator.validate(json2)
# assert not validator.validate(json3)
# assert validator.validation.error("field3") == ["Required field"]
# ~~~
class RequiredField
	super FieldValidator

	# Is this field required?
	var required: nullable Bool

	redef fun validate_field(v, obj) do
		var required = self.required
		if (required != null and required or required == null) and not obj.has_key(field) then
			v.validation.add_error(field, "Required field")
			return false
		end
		return true
	end
end

lib/popcorn/pop_validation.nit:280,1--312,3

class RequiredField

Summary

Check if a field exists

Introduced properties

defaultinit

required

required=

Redefined properties

SELF

validate_field

Check if a field exists

Introduced properties

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

fun required: nullable Bool

protected fun required=(required: nullable Bool)

Redefined properties

redef type SELF: RequiredField

redef fun validate_field(v: ObjectValidator, obj: JsonObject): Bool

Summary

All properties

!=

==

CLASS

SELF

class_factory

class_name

defaultinit

defaultinit

defaultinit

field

field=

get_class

hash

init

inspect

inspect_head

is_same_instance

is_same_serialized

is_same_type

object_id

output

output_class_name

required

required=

serialization_hash

sys

to_jvalue

to_s

validate_field

All properties

fun !=(other: nullable Object): Bool

fun ==(other: nullable Object): Bool

type CLASS: Class[SELF]

type SELF: Object

protected fun class_factory(name: String): CLASS

fun class_name: String

init defaultinit(field: String)

init defaultinit

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

fun field: String

protected fun field=(field: String)

fun get_class: CLASS

fun hash: Int

init init

fun inspect: String

protected fun inspect_head: String

intern fun is_same_instance(other: nullable Object): Bool

fun is_same_serialized(other: nullable Object): Bool

intern fun is_same_type(other: Object): Bool

intern fun object_id: Int

fun output

intern fun output_class_name

fun required: nullable Bool

protected fun required=(required: nullable Bool)

fun serialization_hash: Int

intern fun sys: Sys

abstract fun to_jvalue(env: JniEnv): JValue

fun to_s: String

abstract fun validate_field(v: ObjectValidator, obj: JsonObject): Bool

Summary