Class: Apiwork::Adapter::Capability::Contract::Base

Inherits:

Builder::Contract::Base

• Object
• Builder::Contract::Base
• Apiwork::Adapter::Capability::Contract::Base

Defined in:

lib/apiwork/adapter/capability/contract/base.rb

Overview

Base class for capability Contract phase.

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

Direct Known Subclasses

Standard::Capability::Filtering::ContractBuilder, Standard::Capability::Including::ContractBuilder, Standard::Capability::Pagination::ContractBuilder, Standard::Capability::Sorting::ContractBuilder, Standard::Capability::Writing::ContractBuilder

Instance Attribute Summary

• #options ⇒ Configuration readonly

  The options for this contract.

• #scope ⇒ Object readonly

Attributes inherited from Builder::Contract::Base

#representation_class

Instance Method Summary

• #initialize(contract_class, representation_class, actions, options) ⇒ Base constructor

  A new instance of Base.

Methods inherited from Builder::Contract::Base

#api_class, #build, #contract_for, #enum, #enum?, #import, #object, #scoped_enum_name, #scoped_type_name, #type?, #union

Constructor Details

#initialize(contract_class, representation_class, actions, options) ⇒ Base

Returns a new instance of Base.

# File 'lib/apiwork/adapter/capability/contract/base.rb', line 28

def initialize(contract_class, representation_class, actions, options)
  super(contract_class, representation_class)
  @scope = Scope.new(representation_class, actions)
  @options = options
end

Instance Attribute Details

#options ⇒ Configuration (readonly)

The options for this contract.

Returns:

• (Configuration)

# File 'lib/apiwork/adapter/capability/contract/base.rb', line 23

def options
  @options
end

#scope ⇒ Object (readonly)

# File 'lib/apiwork/adapter/capability/contract/base.rb', line 23

attr_reader :options,
:scope