Base

GitHub

Base class for Contract-phase type builders.

Contract phase runs once per contract with representation at registration time. Use it to generate contract-specific types based on the representation.

Example

module Builder
  class Contract < Adapter::Builder::Contract::Base
    def build
      object(representation_class.root_key.singular.to_sym) do |object|
        object.string(:id)
        object.string(:name)
      end
    end
  end
end

Instance Methods

#api_class

#api_class

GitHub

See also

• Contract::Base.api_class

---

#build

#build

GitHub

Builds contract-level types.

Override this method to generate types based on the representation.

Returns

void

---

#contract_for

#contract_for(representation_class)

GitHub

See also

• Contract::Base.contract_for

---

#enum

#enum(name, values:, **options, &block)

GitHub

See also

• Contract::Base#enum

---

#enum?

#enum?(name)

GitHub

See also

• Contract::Base#enum?

---

#import

#import(type_name, from:)

GitHub

See also

• Contract::Base#import

---

#object

#object(name, **options, &block)

GitHub

See also

• Contract::Base#object

---

#scoped_enum_name

#scoped_enum_name(name)

GitHub

See also

• Contract::Base#scoped_enum_name

---

#scoped_type_name

#scoped_type_name(name)

GitHub

See also

• Contract::Base#scoped_type_name

---

#type?

#type?(name)

GitHub

See also

• Contract::Base#type?

---

#union

#union(name, **options, &block)

GitHub

See also

• Contract::Base#union

---