Module: Cuprum::Collections::Relations::Scope

Included in:

Collection, Cuprum::Collections::Resource

Defined in:

lib/cuprum/collections/relations/scope.rb

Overview

Methods for defining a scope for a relation.

Instance Attribute Summary

• #scope ⇒ Cuprum::Collections::Scopes::Base readonly

  The configured scope for the relation.

Instance Method Summary

• #initialize(scope: nil, **) ⇒ Object
• #with_scope(value = nil, &block) ⇒ Object

Instance Attribute Details

#scope ⇒ Cuprum::Collections::Scopes::Base

Returns the configured scope for the relation.

Returns:

• (Cuprum::Collections::Scopes::Base) —

  the configured scope for the relation.

# File 'lib/cuprum/collections/relations/scope.rb', line 19

def scope
  @scope
end

Instance Method Details

#initialize(scope: nil, **) ⇒ Object

Parameters:

• scope (Cuprum::Collections::Scopes::Base, Hash, Proc, nil) (defaults to: nil) —

  the configured scope for the relation.

# File 'lib/cuprum/collections/relations/scope.rb', line 11

def initialize(scope: nil, **parameters)
  super(**parameters)

  @scope = apply_scope(default_scope, scope)
end

#with_scope(scope) ⇒ Cuprum::Collections::Relations::Scope #with_scope {|query| ... } ⇒ Cuprum::Collections::Relations::Scope

Overloads:

• #with_scope(scope) ⇒ Cuprum::Collections::Relations::Scope

  Copies the relation and applies the scope to the copy.

  Parameters:

  • scope (Cuprum::Collections::Scopes::Base, Hash, Proc) —

    the scope to apply. The scope will be combined with the existing scope on the relation, if any.

  Returns:

  • (Cuprum::Collections::Relations::Scope) —

    the copy of the relation.

• #with_scope {|query| ... } ⇒ Cuprum::Collections::Relations::Scope

  Copies the relation and applies the scope to the copy.

  Yield Parameters:

  • query —

    [Cuprum::Collections::Scopes::Criteria::Parser::BlockParser] the receiver for the scope block.

  Yield Returns:

  • (Hash) —

    the query hash for the scope.

  Returns:

  • (Cuprum::Collections::Relations::Scope) —

    the copy of the relation.

# File 'lib/cuprum/collections/relations/scope.rb', line 41

def with_scope(value = nil, &block)
  dup.tap { |copy| copy.scope = apply_scope(scope, value || block) }
end