Module: EnvBranch

Defined in:
lib/env_branch.rb,
lib/env_branch/base.rb,
lib/env_branch/version.rb,
lib/env_branch/test_helper.rb

Overview

Build branch information from environment variables

Defined Under Namespace

Modules: TestHelper Classes: Base

Constant Summary collapse

VERSION =
'1.3.0'.freeze

Class Method Summary collapse

Class Method Details

.self.newBase .self.new { ... } ⇒ Base

Build branch information object from environment variables

Overloads:

  • .self.newBase

    Returns Branch information object.

    Examples:

    without user defined block

    env_branch = EnvBranch.new

    Returns:

    • (Base)

      Branch information object

  • .self.new { ... } ⇒ Base

    Returns Branch information object.

    Examples:

    with user defined block

    env_branch =
      EnvBranch.new do
        if ENV['USER_DEFINED_BRANCH'] &&
          !ENV['USER_DEFINED_BRANCH'].empty?
          ENV['USER_DEFINED_BRANCH']
        end
      end

    Yields:

    • user defined block

    Returns:

    • (Base)

      Branch information object



26
27
28
# File 'lib/env_branch.rb', line 26

def self.new(&block)
  Base.new(&block)
end