Table of Contents - yaks-0.13.0 Documentation
Pages
-
README
- Yaks
- Table of Contents
- Packages
- State of Development
- Concepts
- Mappers
- Attributes
- Forms
- Filtering
- Links
- Associations
- Behaviours
- OptionalIncludes
- Calling Yaks
- Rack env
- Namespace
- Custom attribute/link/subresource handling
- Resources, Formatters, Serializers
- Formats
- HAL
- HTML
- JSON-API
- Collection+JSON
- Transit
- Hooks
- Policy over Configuration
- derive_mapper_from_object
- mapper_for
- derive_mapper_from_collection
- derive_mapper_from_item
- derive_mapper_from_association
- derive_rel_from_association
- Primitivizer
- Integration
- Real World Usage
- Demo
- Cookbook
- Standards Based
- How to contribute
- License
Classes and Modules
- Yaks
- Yaks::Behaviour
- Yaks::Behaviour::OptionalIncludes
- Yaks::Builder
- Yaks::Changelog
- Yaks::CollectionMapper
- Yaks::CollectionResource
- Yaks::Config
- Yaks::Configurable
- Yaks::DefaultPolicy
- Yaks::FP
- Yaks::FP::Callable
- Yaks::Format
- Yaks::Format::CollectionJson
- Yaks::Format::Hal
- Yaks::Format::Halo
- Yaks::Format::JsonAPI
- Yaks::Format::Reader
- Yaks::HTML5Forms
- Yaks::Mapper
- Yaks::Mapper::Association
- Yaks::Mapper::AssociationMapper
- Yaks::Mapper::Attribute
- Yaks::Mapper::Config
- Yaks::Mapper::Form
- Yaks::Mapper::Form::Config
- Yaks::Mapper::Form::DynamicField
- Yaks::Mapper::Form::Field
- Yaks::Mapper::Form::Field::Option
- Yaks::Mapper::Form::Fieldset
- Yaks::Mapper::Form::Legend
- Yaks::Mapper::HasMany
- Yaks::Mapper::HasOne
- Yaks::Mapper::Link
- Yaks::NullResource
- Yaks::Pipeline
- Yaks::Primitivize
- Yaks::Reader
- Yaks::Reader::Hal
- Yaks::Reader::JsonAPI
- Yaks::Resource
- Yaks::Resource::Form
- Yaks::Resource::Form::Field
- Yaks::Resource::Form::Field::Option
- Yaks::Resource::Form::Fieldset
- Yaks::Resource::Form::Legend
- Yaks::Resource::HasFields
- Yaks::Resource::Link
- Yaks::Runner
- Yaks::Serializer
- Yaks::Serializer::JSONReader
- Yaks::Serializer::JSONWriter
- Yaks::Util
- Yaks::Util::Deprecated
Methods
- ::all — Yaks::Format
- ::all — Yaks::Serializer
- ::build — Yaks::Mapper::Form::Config
- ::build_with_object — Yaks::Mapper::Form::Config
- ::by_accept_header — Yaks::Format
- ::by_media_type — Yaks::Format
- ::by_name — Yaks::Format
- ::call — Yaks::Serializer::JSONWriter
- ::call — Yaks::Serializer::JSONReader
- ::create — Yaks::Mapper::Association
- ::create — Yaks::Mapper::Attribute
- ::create — Yaks::Mapper::Form
- ::create — Yaks::Mapper::Form::Config
- ::create — Yaks::Mapper::Form::DynamicField
- ::create — Yaks::Mapper::Form::Field
- ::create — Yaks::Mapper::Form::Field::Option
- ::create — Yaks::Mapper::Form::Fieldset
- ::create — Yaks::Mapper::Form::Legend
- ::create — Yaks::Mapper::Link
- ::create — Yaks::Primitivize
- ::extended — Yaks::Configurable
- ::find — Yaks::Format
- ::inverse — Yaks::Serializer::JSONWriter
- ::inverse — Yaks::Serializer::JSONReader
- ::mapper_name — Yaks::Mapper
- ::media_types — Yaks::Format
- ::names — Yaks::Format
- ::new — Yaks::Builder
- ::new — Yaks::DefaultPolicy
- ::new — Yaks::Format
- ::new — Yaks::Mapper
- ::new — Yaks::Mapper::AssociationMapper
- ::new — Yaks::NullResource
- ::new — Yaks::Primitivize
- ::new — Yaks::Resource
- ::new — Yaks::Resource::Form::Legend
- ::new — Yaks
- ::register — Yaks::Format
- ::register — Yaks::Serializer
- ::transitive? — Yaks::Serializer::JSONWriter
- ::transitive? — Yaks::Serializer::JSONReader
- #Resolve — Yaks::Util
- #[] — Yaks::Resource
- #[] — Yaks::Resource::Form
- #add_attributes — Yaks::Mapper::Config
- #add_form — Yaks::NullResource
- #add_form — Yaks::Resource
- #add_link — Yaks::Mapper::AssociationMapper
- #add_link — Yaks::NullResource
- #add_link — Yaks::Resource
- #add_rel — Yaks::Resource
- #add_subresource — Yaks::Mapper::AssociationMapper
- #add_subresource — Yaks::NullResource
- #add_subresource — Yaks::Resource
- #add_to_resource — Yaks::Mapper::Association
- #add_to_resource — Yaks::Mapper::Attribute
- #add_to_resource — Yaks::Mapper::Form
- #add_to_resource — Yaks::Mapper::Link
- #array — Yaks::Reader::Hal
- #associations — Yaks::Behaviour::OptionalIncludes
- #build — Yaks::Builder
- #build_mapper_class — Yaks::DefaultPolicy
- #call — Yaks::CollectionMapper
- #call — Yaks::Config
- #call — Yaks::Format
- #call — Yaks::Format::JsonAPI
- #call — Yaks::Mapper
- #call — Yaks::Mapper::AssociationMapper
- #call — Yaks::Pipeline
- #call — Yaks::Primitivize
- #call — Yaks::Reader::Hal
- #call — Yaks::Reader::JsonAPI
- #call — Yaks::Runner
- #camelize — Yaks::Util
- #collection — Yaks::Resource
- #collection? — Yaks::CollectionResource
- #collection? — Yaks::NullResource
- #collection? — Yaks::Resource
- #collection_mapper — Yaks::Mapper::HasMany
- #collection_rel — Yaks::CollectionMapper
- #collection_type — Yaks::CollectionMapper
- #condition — Yaks::Mapper::Form::Config
- #context — Yaks::Runner
- #convert_embedded — Yaks::Reader::Hal
- #convert_embedded — Yaks::Reader::JsonAPI
- #convert_links — Yaks::Reader::Hal
- #convert_links — Yaks::Reader::JsonAPI
- #create — Yaks::Builder
- #current — Yaks::Changelog
- #def_add — Yaks::Configurable
- #def_forward — Yaks::Configurable
- #def_set — Yaks::Configurable
- #deprecated_alias — Yaks::Util::Deprecated
- #derive_mapper_from_association — Yaks::DefaultPolicy
- #derive_mapper_from_collection — Yaks::DefaultPolicy
- #derive_mapper_from_item — Yaks::DefaultPolicy
- #derive_mapper_from_object — Yaks::DefaultPolicy
- #derive_rel_from_association — Yaks::DefaultPolicy
- #derive_type_from_collection — Yaks::DefaultPolicy
- #derive_type_from_mapper_class — Yaks::DefaultPolicy
- #detect_configured_mapper_for — Yaks::DefaultPolicy
- #each — Yaks::NullResource
- #each — Yaks::Resource
- #each_with_object — Yaks::Resource
- #env — Yaks::Mapper
- #env — Yaks::Runner
- #expand_rel — Yaks::DefaultPolicy
- #expand_uri — Yaks::Mapper
- #expand_value — Yaks::Mapper
- #extract_options — Yaks::Util
- #fields_flat — Yaks::Resource::HasFields
- #find_form — Yaks::Resource
- #form_is_query? — Yaks::Format::CollectionJson
- #format — Yaks::Config
- #format — Yaks::Runner
- #format_class — Yaks::Runner
- #format_options — Yaks::Config
- #formatter — Yaks::Runner
- #has_action? — Yaks::Resource::Form
- #hooks — Yaks::Runner
- #include_association? — Yaks::Behaviour::OptionalIncludes
- #inherited — Yaks::Configurable
- #insert_hooks — Yaks::Pipeline
- #inspect — Yaks::Builder
- #inverse — Yaks::Format::Hal
- #inverse — Yaks::Format::JsonAPI
- #inverse — Yaks::Pipeline
- #json_serializer — Yaks::Config
- #links? — Yaks::Format::CollectionJson
- #load_association — Yaks::Mapper
- #load_attribute — Yaks::Mapper
- #map — Yaks::Config
- #map — Yaks::NullResource
- #map — Yaks::Primitivize
- #map — Yaks::Resource
- #map — Yaks::Runner
- #map_attributes — Yaks::Mapper
- #map_fields — Yaks::Resource::HasFields
- #map_forms — Yaks::Mapper
- #map_links — Yaks::Mapper
- #map_rel — Yaks::Mapper::Association
- #map_resource — Yaks::Mapper::HasMany
- #map_resource — Yaks::Mapper::HasOne
- #map_subresources — Yaks::Mapper
- #map_to_primitive — Yaks::Config
- #map_to_resource_link — Yaks::Mapper::Link
- #mapper — Yaks::Runner
- #mapper_for — Yaks::Config
- #mapper_for_model — Yaks::CollectionMapper
- #mapper_name — Yaks::Mapper
- #mapper_namespace — Yaks::Config
- #mapper_stack — Yaks::Mapper
- #markdown — Yaks::Changelog
- #members — Yaks::Resource
- #merge_attributes — Yaks::NullResource
- #merge_attributes — Yaks::Resource
- #method? — Yaks::Resource::Form
- #next_class_for_lookup — Yaks::DefaultPolicy
- #null_resource? — Yaks::NullResource
- #null_resource? — Yaks::Resource
- #policy — Yaks::Config
- #policy — Yaks::Mapper
- #policy — Yaks::Mapper::AssociationMapper
- #primitivizer — Yaks::Runner
- #queries? — Yaks::Format::CollectionJson
- #raise_mapper_not_found — Yaks::DefaultPolicy
- #read — Yaks::Config
- #read — Yaks::Runner
- #reject_keys — Yaks::Util
- #rel? — Yaks::Mapper::Link
- #rel? — Yaks::Resource::Link
- #rel_template — Yaks::Config
- #render_as_link? — Yaks::Mapper::Association
- #resolve_association_mapper — Yaks::Mapper::Association
- #resource_attributes — Yaks::Mapper::Form::Field
- #resource_link_options — Yaks::Mapper::Link
- #resource_options — Yaks::Mapper::Form::Field
- #runner — Yaks::Config
- #select_options_for_value — Yaks::Resource::Form::Field
- #self_link — Yaks::Resource
- #seq — Yaks::CollectionResource
- #seq — Yaks::NullResource
- #seq — Yaks::Resource
- #serialize — Yaks::Config
- #serialize — Yaks::Format
- #serialize_embedded — Yaks::Format::Hal
- #serialize_form — Yaks::Format::Halo
- #serialize_form_field — Yaks::Format::Halo
- #serialize_forms — Yaks::Format::Halo
- #serialize_included_resources — Yaks::Format::JsonAPI
- #serialize_included_subresources — Yaks::Format::JsonAPI
- #serialize_items — Yaks::Format::CollectionJson
- #serialize_link — Yaks::Format::Hal
- #serialize_links — Yaks::Format::CollectionJson
- #serialize_links — Yaks::Format::Hal
- #serialize_links — Yaks::Format::JsonAPI
- #serialize_queries — Yaks::Format::CollectionJson
- #serialize_relationship — Yaks::Format::JsonAPI
- #serialize_relationships — Yaks::Format::JsonAPI
- #serialize_resource — Yaks::Format
- #serialize_resource — Yaks::Format::CollectionJson
- #serialize_resource — Yaks::Format::Hal
- #serialize_resource — Yaks::Format::Halo
- #serialize_resource — Yaks::Format::JsonAPI
- #serialize_subresource — Yaks::Format::JsonAPI
- #serialize_template — Yaks::Format::CollectionJson
- #serializer — Yaks::Config
- #serializer — Yaks::Runner
- #singular? — Yaks::Format::Hal
- #singular_name — Yaks::Mapper::HasMany
- #singular_name — Yaks::Mapper::HasOne
- #slice_hash — Yaks::Util
- #steps — Yaks::Runner
- #symbolize_keys — Yaks::Util
- #template? — Yaks::Format::CollectionJson
- #template_form_exists? — Yaks::Format::CollectionJson
- #templated? — Yaks::Mapper::Link
- #templated? — Yaks::Resource::Link
- #title — Yaks::Resource::Link
- #to_proc — Yaks::FP::Callable
- #to_resource_field_option — Yaks::Mapper::Form::Field::Option
- #to_resource_fields — Yaks::Mapper::Form::Config
- #to_resource_fields — Yaks::Mapper::Form::DynamicField
- #to_resource_fields — Yaks::Mapper::Form::Field
- #to_resource_fields — Yaks::Mapper::Form::Fieldset
- #to_resource_fields — Yaks::Mapper::Form::Legend
- #to_resource_form — Yaks::Mapper::Form
- #transitive? — Yaks::Format::Hal
- #transitive? — Yaks::Pipeline
- #type — Yaks::Resource::Form::Fieldset
- #type_from_links — Yaks::Reader::Hal
- #underscore — Yaks::Util
- #value — Yaks::Resource::Form::Field
- #values — Yaks::Resource::Form
- #versions — Yaks::Changelog
- #with_collection — Yaks::Resource
- #with_members — Yaks::Resource
- #with_value — Yaks::Resource::Form::Field