Class: ConvenientService::Support::MethodParameters Private

Inherits:
Object
  • Object
show all
Defined in:
lib/convenient_service/support/method_parameters.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Note:

Method#parameters return value may look like the following.

def foo(a, b = 1, *args, c:, d: 2, **kwargs, &block) end

method(:foo).parameters

=> [[:req, :a], [:opt, :b], [:rest, :args], [:keyreq, :c], [:key, :d], [:keyrest, :kwargs], [:block, :block]]

Wrapps Method#parameters return value to provide a higher level interface.

See Also:

Since:

  • 1.0.0

Defined Under Namespace

Modules: Constants

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method_parameters) ⇒ void

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.

Parameters:

  • method_parameters (Array)

Since:

  • 1.0.0



43
44
45
 
# File 'lib/convenient_service/support/method_parameters.rb', line 43

def initialize(method_parameters)
  @method_parameters = method_parameters
end

Instance Attribute Details

#method_parameters ⇒ Object (readonly)

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.

Since:

  • 1.0.0



37
38
39
 
# File 'lib/convenient_service/support/method_parameters.rb', line 37

def method_parameters
  @method_parameters
end

Instance Method Details

#has_rest_kwargs? ⇒ Boolean

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.

Returns true when method definition has **kwargs.

Examples:

rest_kwargs means NOT named kwargs.


def foo(a, b = 1, *args, c:, d: 2, **kwargs, &block)
end

def bar(a, b = 1, *args, c:, d: 2, &block)
end

ConvenientService::Support::MethodParameters.new(method(:foo).parameters).has_rest_kwargs?
# => true

ConvenientService::Support::MethodParameters.new(method(:bar).parameters).has_rest_kwargs?
# => false

Returns:

  • (Boolean)

See Also:

Since:

  • 1.0.0



67
68
69
70
71
 
# File 'lib/convenient_service/support/method_parameters.rb', line 67

def has_rest_kwargs?
  return @has_rest_kwargs if defined? @has_rest_kwargs

  @has_rest_kwargs = method_parameters.any? { |type, _name| type == Constants::Types::REST_KEYWORDS }
end

#named_kwargs_keys ⇒ Array<Symbol>

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.

Note:

named_kwargs_keys is an optimized way to get required_kwargs_keys + optional_kwargs_keys.

Examples:

named_kwargs_keys are kwargs with or without defaults.


def foo(a, b = 1, *args, c:, d: 2, **kwargs, &block)
end

ConvenientService::Support::MethodParameters.new(method(:foo).parameters).named_kwargs_keys
# => [:c, :d]

Returns:

  • (Array<Symbol>)

See Also:

Since:

  • 1.0.0



87
88
89
 
# File 'lib/convenient_service/support/method_parameters.rb', line 87

def named_kwargs_keys
  @named_kwargs_keys ||= method_parameters.select { |type, _name| type == Constants::Types::REQUIRED_KEYWORD || type == Constants::Types::OPTIONAL_KEYWORD }.map { |_type, name| name }
end

#optional_kwargs_keys ⇒ Array<Symbol>

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.

Note:

optional_kwargs are named kwargs with defaults.

def foo(a, b = 1, *args, c:, d: 2, **kwargs, &block) end

ConvenientService::Support::MethodParameters.new(method(:foo).parameters).optional_kwargs_keys

=> [:d]

Returns:

  • (Array<Symbol>)

See Also:

Since:

  • 1.0.0



121
122
123
 
# File 'lib/convenient_service/support/method_parameters.rb', line 121

def optional_kwargs_keys
  @optional_kwargs_keys ||= method_parameters.select { |type, _name| type == Constants::Types::OPTIONAL_KEYWORD }.map { |_type, name| name }
end

#required_kwargs_keys ⇒ Array<Symbol>

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.

Note:

required_kwargs are named kwargs without defaults.

def foo(a, b = 1, *args, c:, d: 2, **kwargs, &block) end

ConvenientService::Support::MethodParameters.new(method(:foo).parameters).required_kwargs_keys

=> [:c]

Returns:

  • (Array<Symbol>)

See Also:

Since:

  • 1.0.0



104
105
106
 
# File 'lib/convenient_service/support/method_parameters.rb', line 104

def required_kwargs_keys
  @required_kwargs_keys ||= method_parameters.select { |type, _name| type == Constants::Types::REQUIRED_KEYWORD }.map { |_type, name| name }
end