class Bake::Recipe

Structured access to an instance method in a bakefile.

Constants

COMMENT

Attributes

instance [R]

The {Base} instance that this recipe is attached to.

name [R]

The name of this recipe.

Public Class Methods

new (instance, name, method = nil)

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 18
def initialize(instance, name, method = nil)
        @instance = instance
        @name = name
        @command = nil
        @comments = nil
        @signature = nil
        @documentation = nil
        
        @method = method
        @arity = nil
end

Initialize the recipe.

@parameter instance [Base] The instance this recipe is attached to. @parameter name [String] The method name. @parameter method [Method | Nil] The method if already known.

Public Instance Methods

<=> (other)

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 37
def <=> other
        (self.source_location || []) <=> (other.source_location || [])
end

Sort by location in source file.

arity ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 91
def arity
        if @arity.nil?
                @arity = method.parameters.count{|type, name| type == :req}
        end
        
        return @arity
end

The method’s arity, the required number of positional arguments.

call (*arguments, **options, &block)

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 109
def call(*arguments, **options, &block)
        if options.any? and self.options?
                @instance.send(@name, *arguments, **options, &block)
        else
                # Ignore options...
                @instance.send(@name, *arguments, &block)
        end
end

Call the recipe with the specified arguments and options. If the recipe does not accept options, they will be ignored.

command ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 82
def command
        @command ||= compute_command
end

The command name for this recipe.

comments ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 120
def comments
        @comments ||= read_comments
end

Any comments associated with the source code which defined the method. @returns [Array(String)] The comment lines.

documentation ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 126
def documentation
        @documentation ||= Documentation.new(self.comments)
end

The documentation object which provides structured access to the {comments}. @returns [Documentation]

method ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 42
def method
        @method ||= @instance.method(@name)
end

The method implementation.

options? ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 63
def options?
        if parameters = self.parameters
                parameters.any? do |type, name|
                        type == :keyrest || type == :keyreq || type == :key
                end
        end
end

Whether this recipe has optional arguments. @returns [Boolean]

parameters ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 53
def parameters
        parameters = method.parameters
        
        unless parameters.empty?
                return parameters
        end
end

The recipe’s formal parameters, if any. @returns [Array | Nil]

prepare (arguments, last_result = nil)

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 103
def prepare(arguments, last_result = nil)
        Arguments.extract(self, arguments, input: last_result)
end

Process command line arguments into the ordered and optional arguments. @parameter arguments [Array(String)] The command line arguments @returns ordered [Array] @returns options [Hash]

required_options ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 71
def required_options
        if parameters = self.parameters
                parameters.map do |(type, name)|
                        if type == :keyreq
                                name
                        end
                end.compact
        end
end

signature ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 132
def signature
        @signature ||= read_signature
end

The documented type signature of the recipe. @returns [Array] An array of {Type} instances.

Also aliased as: types

source_location ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 47
def source_location
        self.method.source_location
end

The source location of this recipe.

to_s ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/recipe.rb, line 86
def to_s
        self.command
end

types ()

@deprecated Use {signature} instead.

Alias for: signature