Module: Alba::Resource::ClassMethods
- Included in:
- Alba::Resource
- Defined in:
- lib/alba/resource.rb
Overview
Class methods
Instance Method Summary collapse
-
#association(name, condition = nil, resource: nil, serializer: nil, source: nil, key: nil, with_traits: nil, params: {}, **options, &block) ⇒ void
(also: #one, #many, #has_one, #has_many)
Set association.
-
#attribute(name, **options, &block) ⇒ void
Set an attribute with the given block.
-
#attributes(*attrs, if: nil, **attrs_with_types) ⇒ void
Set multiple attributes at once.
-
#collection_key(key) ⇒ void
Sets key for collection serialization.
-
#helper(mod = @_helper || Module.new, &block) ⇒ void
Define helper methods.
- #inherited(subclass) ⇒ Object private
-
#layout(file: nil, inline: nil) ⇒ void
Set layout.
-
#meta(key = :meta, &block) ⇒ void
Set metadata.
-
#method_added(method_name) ⇒ Object
This ‘method_added` is used for defining “resource methods”.
-
#nested_attribute(name, **options, &block) ⇒ void
(also: #nested)
Set a nested attribute with the given block.
-
#on_error(handler = nil, &block) ⇒ void
Set error handler If this is set it’s used as a error handler overriding global one.
-
#on_nil(&block) ⇒ void
Set nil handler.
-
#prefer_object_method! ⇒ void
DSL for alias, purely for readability.
-
#prefer_resource_method! ⇒ void
DSL for alias, purely for readability.
-
#root_key(key, key_for_collection = nil) ⇒ void
Set root key.
-
#root_key! ⇒ void
Set root key to true.
-
#root_key_for_collection(key) ⇒ void
Set root key for collection.
-
#trait(name, &block) ⇒ void
Set a trait.
-
#transform_keys(type, root: true, cascade: true) ⇒ void
Transform keys as specified type.
-
#transform_keys!(type) ⇒ Object
Transform keys as specified type AFTER the class is defined Note that this is an experimental API and may be removed/changed.
Instance Method Details
#association(name, condition = nil, resource: nil, serializer: nil, source: nil, key: nil, with_traits: nil, params: {}, **options, &block) ⇒ void Also known as: one, many, has_one, has_many
This method returns an undefined value.
Set association
444 445 446 447 448 449 450 451 452 453 |
# File 'lib/alba/resource.rb', line 444 def association(name, condition = nil, resource: nil, serializer: nil, source: nil, key: nil, with_traits: nil, params: {}, **, &block) resource ||= serializer transformation = @_key_transformation_cascade ? @_transform_type : :none assoc = Association.new( name: name, condition: condition, resource: resource, source: source, with_traits: with_traits, params: params, nesting: nesting, key_transformation: transformation, helper: @_helper, &block ) @_attributes[key&.to_sym || name.to_sym] = [:if] ? ConditionalAttribute.new(body: assoc, condition: [:if]) : assoc end |
#attribute(name, **options, &block) ⇒ void
This method returns an undefined value.
Set an attribute with the given block
421 422 423 424 425 |
# File 'lib/alba/resource.rb', line 421 def attribute(name, **, &block) raise ArgumentError, 'No block given in attribute method' unless block @_attributes[name.to_sym] = [:if] ? ConditionalAttribute.new(body: block, condition: [:if]) : block end |
#attributes(*attrs, if: nil, **attrs_with_types) ⇒ void
This method returns an undefined value.
Set multiple attributes at once
387 388 389 390 391 |
# File 'lib/alba/resource.rb', line 387 def attributes(*attrs, if: nil, **attrs_with_types) if_value = binding.local_variable_get(:if) assign_attributes(attrs, if_value) assign_attributes_with_types(attrs_with_types, if_value) end |
#collection_key(key) ⇒ void
This method returns an undefined value.
Sets key for collection serialization
583 584 585 |
# File 'lib/alba/resource.rb', line 583 def collection_key(key) @_collection_key = key.to_sym end |
#helper(mod = @_helper || Module.new, &block) ⇒ void
This method returns an undefined value.
Define helper methods
623 624 625 626 627 628 |
# File 'lib/alba/resource.rb', line 623 def helper(mod = @_helper || Module.new, &block) mod.module_eval(&block) if block extend mod @_helper = mod end |
#inherited(subclass) ⇒ Object
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.
373 374 375 376 |
# File 'lib/alba/resource.rb', line 373 def inherited(subclass) super INTERNAL_VARIABLES.each_key { |name| subclass.instance_variable_set(:"@#{name}", instance_variable_get(:"@#{name}").clone) } end |
#layout(file: nil, inline: nil) ⇒ void
This method returns an undefined value.
Set layout
537 538 539 |
# File 'lib/alba/resource.rb', line 537 def layout(file: nil, inline: nil) @_layout = Layout.new(file: file, inline: inline) end |
#meta(key = :meta, &block) ⇒ void
This method returns an undefined value.
Set metadata
528 529 530 |
# File 'lib/alba/resource.rb', line 528 def (key = :meta, &block) @_meta = [key, block] end |
#method_added(method_name) ⇒ Object
This ‘method_added` is used for defining “resource methods”
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/alba/resource.rb', line 352 def method_added(method_name) # rubocop:disable Metrics/MethodLength case method_name when :collection_converter, :converter warn "Defining ##{method_name} methods is deprecated", category: :deprecated, uplevel: 1 alias_method :serializable_hash_for_collection, :deprecated_serializable_hash_for_collection private(:serializable_hash_for_collection) alias_method :serializable_hash, :deprecated_serializable_hash alias_method :to_h, :deprecated_serializable_hash when :attributes warn 'Overriding `attributes` is deprecated, use `select` instead.', category: :deprecated, uplevel: 1 when :select @_select_arity = instance_method(:select).arity when :_setup # noop else _resource_methods << method_name.to_sym end super end |
#nested_attribute(name, **options, &block) ⇒ void Also known as: nested
This method returns an undefined value.
Set a nested attribute with the given block
476 477 478 479 480 481 482 |
# File 'lib/alba/resource.rb', line 476 def nested_attribute(name, **, &block) raise ArgumentError, 'No block given in attribute method' unless block key_transformation = @_key_transformation_cascade ? @_transform_type : :none attribute = NestedAttribute.new(key_transformation: key_transformation, &block) @_attributes[name.to_sym] = [:if] ? ConditionalAttribute.new(body: attribute, condition: [:if]) : attribute end |
#on_error(handler = nil, &block) ⇒ void
This method returns an undefined value.
Set error handler If this is set it’s used as a error handler overriding global one
593 594 595 596 597 598 |
# File 'lib/alba/resource.rb', line 593 def on_error(handler = nil, &block) raise ArgumentError, 'You cannot specify error handler with both Symbol and block' if handler && block raise ArgumentError, 'You must specify error handler with either Symbol or block' unless handler || block @_on_error = block || validated_error_handler(handler) end |
#on_nil(&block) ⇒ void
This method returns an undefined value.
Set nil handler
615 616 617 |
# File 'lib/alba/resource.rb', line 615 def on_nil(&block) @_on_nil = block end |
#prefer_object_method! ⇒ void
This method returns an undefined value.
DSL for alias, purely for readability
638 639 640 |
# File 'lib/alba/resource.rb', line 638 def prefer_object_method! alias_method :fetch_attribute_from_object_and_resource, :_fetch_attribute_from_object_first end |
#prefer_resource_method! ⇒ void
This method returns an undefined value.
DSL for alias, purely for readability
632 633 634 |
# File 'lib/alba/resource.rb', line 632 def prefer_resource_method! alias_method :fetch_attribute_from_object_and_resource, :_fetch_attribute_from_resource_first end |
#root_key(key, key_for_collection = nil) ⇒ void
This method returns an undefined value.
Set root key
504 505 506 507 |
# File 'lib/alba/resource.rb', line 504 def root_key(key, key_for_collection = nil) @_key = key.to_sym @_key_for_collection = key_for_collection&.to_sym end |
#root_key! ⇒ void
This method returns an undefined value.
Set root key to true
521 522 523 524 |
# File 'lib/alba/resource.rb', line 521 def root_key! @_key = true @_key_for_collection = true end |
#root_key_for_collection(key) ⇒ void
This method returns an undefined value.
Set root key for collection
514 515 516 517 |
# File 'lib/alba/resource.rb', line 514 def root_key_for_collection(key) @_key = true @_key_for_collection = key.to_sym end |
#trait(name, &block) ⇒ void
This method returns an undefined value.
Set a trait
491 492 493 494 495 496 |
# File 'lib/alba/resource.rb', line 491 def trait(name, &block) raise ArgumentError, 'No block given in trait method' unless block name = name.to_sym @_traits[name] = block end |
#transform_keys(type, root: true, cascade: true) ⇒ void
This method returns an undefined value.
Transform keys as specified type
549 550 551 552 553 554 555 556 557 558 559 |
# File 'lib/alba/resource.rb', line 549 def transform_keys(type, root: true, cascade: true) type = type.to_sym unless %i[none snake camel lower_camel dash].include?(type) # This should be `ArgumentError` but for backward compatibility it raises `Alba::Error` raise ::Alba::Error, "Unknown transform type: #{type}. Supported type are :camel, :lower_camel and :dash." end @_transform_type = type @_transforming_root_key = root @_key_transformation_cascade = cascade end |
#transform_keys!(type) ⇒ Object
Transform keys as specified type AFTER the class is defined Note that this is an experimental API and may be removed/changed
565 566 567 568 569 570 571 572 573 574 575 576 577 |
# File 'lib/alba/resource.rb', line 565 def transform_keys!(type) dup.class_eval do transform_keys(type, root: @_transforming_root_key, cascade: @_key_transformation_cascade) if @_key_transformation_cascade # We need to update key transformation of associations and nested attributes @_attributes.each_value do |attr| attr.key_transformation = type if attr.is_a?(Association) || attr.is_a?(NestedAttribute) end end self # Return the new class end end |