Module: Hanami::Model::Types::ClassMethods

Defined in:

lib/hanami/model/types.rb

Overview

Class level interface

Since:

• 0.7.0

Instance Method Summary

• #Collection(type) ⇒ Object

  Define an array of given type.

• #Entity(type) ⇒ Object

  Define an entity of the given type.

Instance Method Details

#Collection(type) ⇒ Object

Define an array of given type

Examples:

require "hanami/model"

class Account < Hanami::Entity
  attributes do
    # ...
    attribute :users, Types::Collection(User)
  end
end

account = Account.new(users: [User.new(name: "Luca")])
user    = account.users.first
user.class # => User
user.name  # => "Luca"

account = Account.new(users: [{ name: "MG" }])
user    = account.users.first
user.class # => User
user.name  # => "MG"

Parameters:

• type (Object) —

  an object

Since:

• 0.7.0

# File 'lib/hanami/model/types.rb', line 76

def Collection(type)
  type = Schema::CoercibleType.new(type) unless type.is_a?(Dry::Types::Definition)
  Types::Array.member(type)
end

#Entity(type) ⇒ Object

Define an entity of the given type

Examples:

require "hanami/model"

class Account < Hanami::Entity
  attributes do
    # ...
    attribute :owner, Types::Entity(User)
  end
end

account = Account.new(owner: User.new(name: "Luca"))
account.owner.class # => User
account.owner.name  # => "Luca"

account = Account.new(owner: { name: "MG" })
account.owner.class # => User
account.owner.name  # => "MG"

Parameters:

• type (Hanami::Entity) —

  an entity

Since:

• 1.1.0

# File 'lib/hanami/model/types.rb', line 46

def Entity(type)
  type = Schema::CoercibleType.new(type) unless type.is_a?(Dry::Types::Definition)
  type
end