class Bake::Context

Represents a context of task execution, containing all relevant state.

Attributes

registry [R]

The registry which will be used to resolve recipes in this context.

root [R]

The root path of this context. @returns [String | Nil]

Public Class Methods

bakefile_path (path, bakefile: BAKEFILE)

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.24.0/lib/bake/context.rb, line 19
def self.bakefile_path(path, bakefile: BAKEFILE)
        if File.file?(path)
                return path
        end
        
        current = path
        
        while current
                bakefile_path = File.join(current, BAKEFILE)
                
                if File.exist?(bakefile_path)
                        return bakefile_path
                end
                
                parent = File.dirname(current)
                
                if current == parent
                        break
                else
                        current = parent
                end
        end
        
        return nil
end

Search upwards from the specified path for a {BAKEFILE}. If path points to a file, assume it’s a ‘bake.rb` file. Otherwise, recursively search up the directory tree starting from `path` to find the specified bakefile. @returns [String | Nil] The path to the bakefile if it could be found.

load (path = Dir.pwd)

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.24.0/lib/bake/context.rb, line 47
def self.load(path = Dir.pwd)
        if bakefile_path = self.bakefile_path(path)
                working_directory = File.dirname(bakefile_path)
        else
                working_directory = path
        end
        
        registry = Registry.default(working_directory, bakefile_path)
        context = self.new(registry, working_directory)
        
        context.bakefile
        
        return context
end

Load a context from the specified path. @path [String] A file-system path.

new (registry, root = nil)

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.24.0/lib/bake/context.rb, line 64
def initialize(registry, root = nil)
        @registry = registry
        @root = root
        
        @instances = Hash.new do |hash, key|
                hash[key] = instance_for(key)
        end
        
        @recipes = Hash.new do |hash, key|
                hash[key] = recipe_for(key)
        end
end

Initialize the context with the specified registry. @parameter registry [Registry]

Public Instance Methods

[] (command)

Alias for: lookup

bakefile ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.24.0/lib/bake/context.rb, line 77
def bakefile
        @instances[[]]
end

call (*commands) { |recipe, last_result| ... }

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.24.0/lib/bake/context.rb, line 97
def call(*commands, &block)
        recipe = nil
        last_result = nil
        
        # Invoke the recipes in the order they were specified:
        while command = commands.shift
                if recipe = @recipes[command]
                        arguments, options = recipe.prepare(commands, last_result)
                        last_result = recipe.call(*arguments, **options)
                else
                        raise ArgumentError, "Could not find recipe for #{command}!"
                end
        end
        
        # If a block is given, we yield the last recipe and its result:
        if block_given?
                yield recipe, last_result
        end
        
        return last_result
end

Invoke recipes on the context using command line arguments.

e.g. ‘context.call(“gem:release:version:increment”, “0,0,1”)`

@parameter commands [Array(String)] @yield {|recipe, result| If a block is given, it will be called with the last recipe and its result.

@parameter recipe [Recipe] The last recipe that was called.
@parameter result [Object | Nil] The result of the last recipe.

@returns [Object] The result of the last recipe.

inspect ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.24.0/lib/bake/context.rb, line 135
def inspect
        "\#<#{self.class} #{@root}>"
end

lookup (command)

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.24.0/lib/bake/context.rb, line 121
def lookup(command)
        @recipes[command]
end

Lookup a recipe for the given command name. @parameter command [String] The command name, e.g. ‘bundler:release`.

Also aliased as: []

to_s ()

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.24.0/lib/bake/context.rb, line 127
def to_s
        if @root
                "#{self.class} #{File.basename(@root)}"
        else
                self.class.name
        end
end