Class: Hanami::Entity::Schema Private

Inherits:

Object

• Object
• Hanami::Entity::Schema

Defined in:

lib/hanami/entity/schema.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Entity schema is a definition of a set of typed attributes.

Examples:

SQL Automatic Setup

require 'hanami/model'

 class Account < Hanami::Entity
 end

 account = Account.new(name: "Acme Inc.")
 account.name # => "Hanami"

 account = Account.new(foo: "bar")
 account.foo # => NoMethodError

Non-SQL Manual Setup

require 'hanami/model'

class Account < Hanami::Entity
  attributes do
    attribute :id,         Types::Int
    attribute :name,       Types::String
    attribute :codes,      Types::Array(Types::Int)
    attribute :users,      Types::Array(User)
    attribute :email,      Types::String.constrained(format: /@/)
    attribute :created_at, Types::DateTime
  end
end

account = Account.new(name: "Acme Inc.")
account.name # => "Acme Inc."

account = Account.new(foo: "bar")
account.foo # => NoMethodError

Schemaless Entity

require 'hanami/model'

class Account < Hanami::Entity
end

account = Account.new(name: "Acme Inc.")
account.name # => "Acme Inc."

account = Account.new(foo: "bar")
account.foo # => "bar"

Since:

• 0.7.0

Direct Known Subclasses

Model::Sql::Entity::Schema

Defined Under Namespace

Classes: Definition, Schemaless

Instance Method Summary

• #attribute?(name) ⇒ TrueClass, FalseClass private

  Check if the attribute is known.

• #call(attributes) ⇒ Object (also: #[]) private

  Process attributes.

• #initialize(type = nil, &blk) ⇒ Hanami::Entity::Schema constructor private

  Build a new instance of Schema with the attributes defined by the given block.

Constructor Details

#initialize(type = nil, &blk) ⇒ Hanami::Entity::Schema

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Build a new instance of Schema with the attributes defined by the given block

Parameters:

• blk (Proc) —

  the optional block that defines the attributes

Since:

• 0.7.0

# File 'lib/hanami/entity/schema.rb', line 224

def initialize(type = nil, &blk)
  @schema = if block_given?
              Definition.new(type, &blk)
            else
              Schemaless.new
            end
end

Instance Method Details

#attribute?(name) ⇒ TrueClass, FalseClass

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Check if the attribute is known

Parameters:

• name (Symbol) —

  the attribute name

Returns:

• (TrueClass, FalseClass) —

  the result of the check

Since:

• 0.7.0

# File 'lib/hanami/entity/schema.rb', line 258

def attribute?(name)
  schema.attribute?(name)
end

#call(attributes) ⇒ Object Also known as: []

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Process attributes

Parameters:

• attributes (#to_hash) —

  the attributes hash

Raises:

• (TypeError) —

  if the process fails

Since:

• 0.7.0

# File 'lib/hanami/entity/schema.rb', line 240

def call(attributes)
  Utils::Hash.deep_symbolize(
    schema.call(attributes)
  )
end