Class: Restspec::Schema::Types::StringType

Inherits:

BasicType

• Object
• BasicType
• Restspec::Schema::Types::StringType

Defined in:

lib/restspec/schema/types/string_type.rb

Instance Method Summary

• #example_for(attribute) ⇒ String

  Generates a random word.

• #valid?(attribute, value) ⇒ true, false

  If the value is a string.

Methods inherited from BasicType

#initialize, #of, #to_s, #totally_valid?, #|

Constructor Details

This class inherits a constructor from Restspec::Schema::Types::BasicType

Instance Method Details

#example_for(attribute) ⇒ String

Generates a random word.

Parameters:

• attribute (Restspec::Schema::Attribute) —

  the atribute of the schema.

Returns:

• (String) —

  A random word.

# File 'lib/restspec/schema/types/string_type.rb', line 8

def example_for(attribute)
  Faker::Lorem.word
end

#valid?(attribute, value) ⇒ true, false

Returns If the value is a string.

Parameters:

• attribute (Restspec::Schema::Attribute) —

  the atribute of the schema.

• value (Object) —

  the value of the attribute.

Returns:

• (true, false) —

  If the value is a string.

# File 'lib/restspec/schema/types/string_type.rb', line 16

def valid?(attribute, value)
  value.is_a?(String)
end