class R10K::Environment::Git

This class implements an environment based on a Git branch.

@since 1.3.0

Attributes

ref[R]

@!attribute [r] ref

@return [String] The git reference to use for this environment

remote[R]

@!attribute [r] remote

@return [String] The URL to the remote git repository

repo[R]

@!attribute [r] repo

@api private
@return [R10K::Git::StatefulRepository] The git repo backing this environment

Public Class Methods

new(name, basedir, dirname, options = {}) click to toggle source

Initialize the given Git environment.

@param name [String] The unique name describing this environment. @param basedir [String] The base directory where this environment will be created. @param dirname [String] The directory name for this environment. @param options [Hash] An additional set of options for this environment.

@param options [String] :remote The URL to the remote git repository @param options [String] :ref The git reference to use for this environment

Calls superclass method R10K::Environment::WithModules::new

# File lib/r10k/environment/git.rb, line 38
def initialize(name, basedir, dirname, options = {})
  super
  setopts(options, {
    # Standard option interface
    :version => :ref,
    :source  => :remote,
    :type    => ::R10K::Util::Setopts::Ignore,

    # Type-specific options
    :ref     => :self,
    :remote  => :self,

  }, raise_on_unhandled: false)
  # TODO: in r10k 4.0.0, a major version bump, stop allowing garbage options.
  # We only allow them now, here, on this object, because prior to adopting
  # setopts in the constructor, this object type didn't do any validation
  # checking of options passed, and would permit garbage parameters.

  @repo = R10K::Git::StatefulRepository.new(@remote, @basedir, @dirname)
end

Public Instance Methods

desired_contents() click to toggle source

Returns an array of the full paths to all the content being managed. @note This implements a required method for the Purgeable mixin @return [Array<String>]

Calls superclass method R10K::Environment::WithModules#desired_contents

# File lib/r10k/environment/git.rb, line 88
def desired_contents
  desired = [File.join(@full_path, '.git')]
  desired += @repo.tracked_paths.map { |entry| File.join(@full_path, entry) }
  desired += super
end

signature() click to toggle source

Return a sting which uniquely identifies (per source) the current state of the environment.

@api public @return [String]

# File lib/r10k/environment/git.rb, line 79
def signature
  @repo.head
end

status() click to toggle source

# File lib/r10k/environment/git.rb, line 70
def status
  @repo.status(@ref)
end

sync() click to toggle source

Clone or update the given Git environment.

If the environment is being created for the first time, it will automatically update all modules to ensure that the environment is complete.

@api public @return [void]

# File lib/r10k/environment/git.rb, line 66
def sync
  @repo.sync(@ref)
end