Class: RightDevelop::Utility::Shell

Inherits:
RightGit::Shell::Default
  • Object
show all
Defined in:
lib/right_develop/utility/shell.rb

Overview

extends default shell easy-singleton from right_git gem.

Defined Under Namespace

Classes: NullLoggerSingleton

Instance Method Summary collapse

Instance Method Details

#configure_executioner(executioner, options) ⇒ Object

Overrides ::RightGit::Shell::Default#configure_executioner



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/right_develop/utility/shell.rb', line 115

def configure_executioner(executioner, options)
  # super configure early to ensure that any custom env vars are set after
  # restoring the pre-bundler env.
  executioner = super(executioner, options)

  # clean all bundler env vars, if requested.
  if options[:clean_bundler_env] && defined?(::Bundler)
    executioner = lambda do |e|
      lambda { ::Bundler.with_clean_env { e.call } }
    end.call(executioner)
  end
  executioner
end

#default_logger ⇒ Logger

Returns RightSupport::Log::Mixin.default_logger.

Returns:

  • (Logger) —

    RightSupport::Log::Mixin.default_logger



79
80
81
 
# File 'lib/right_develop/utility/shell.rb', line 79

def default_logger
  RightSupport::Log::Mixin.default_logger
end

#execute(cmd, options = {}) ⇒ Integer

Overrides ::RightGit::Shell::Default#execute

Parameters:

  • cmd (String) —

    the shell command to run

  • options (Hash) (defaults to: {}) —

    for execution

Options Hash (options):

  • :directory (String) —

    to use as working directory during command execution or nil

  • :logger (Logger) —

    logger for shell execution (default = STDOUT)

  • :outstream (IO) —

    output stream to receive STDOUT and STDERR from command (default = none)

  • :raise_on_failure (TrueClass|FalseClass) —

    if true, wil raise a RuntimeError if the command does not end successfully (default), false to ignore errors

  • :set_env_vars (Hash) —

    environment variables to set during execution (default = none set)

  • :clear_env_vars (Hash) —

    environment variables to clear during execution (default = none cleared but see :clean_bundler_env)

  • :clean_bundler_env (TrueClass|FalseClass) —

    true to clear all bundler environment variables during execution (default), false to inherit bundler env from parent

  • :sudo (TrueClass|FalseClass) —

    if true, will wrap command in sudo if needed, false to run as current user (default)

Returns:

  • (Integer) —

    exitstatus of the command

Raises:

  • (ShellError) —

    on failure only if :raise_on_failure is true



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/right_develop/utility/shell.rb', line 99

def execute(cmd, options = {})
  options = {
    :clean_bundler_env => true,
    :sudo              => false
  }.merge(options)

  if options[:sudo]
    fail "Not available in Windows" if is_windows?
    cmd = "sudo #{cmd}" unless ::Process.euid == 0
  end

  # super execute.
  super(cmd, options)
end

#is_windows? ⇒ TrueClass|FalseClass

Returns true if running on Windows platform.

Returns:

  • (TrueClass|FalseClass) —

    true if running on Windows platform



67
68
69
 
# File 'lib/right_develop/utility/shell.rb', line 67

def is_windows?
  return !!(RUBY_PLATFORM =~ /mswin|win32|dos|mingw|cygwin/)
end

#null_logger ⇒ Logger

Creates a null logger.

Returns:

  • (Logger) —

    the null logger



74
75
76
 
# File 'lib/right_develop/utility/shell.rb', line 74

def null_logger
  NullLoggerSingleton.instance
end

#setup_clean_env ⇒ Object

bundle exec sets GEM_HOME and GEM_PATH (in Windows?) and these need to be wacked in order to have a pristing rubygems environment since bundler won’t clean them. also, if you ‘bundle exec rake …’ and then put arguments to the right of the task name, then these args won’t appear in Bundler::ORIGINAL_ENV. example: “bundle exec rake build:all DEBUG=true …”



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/right_develop/utility/shell.rb', line 49

def setup_clean_env
  # a little revisionist history music...
  ::ENV.each do |key, value|
    if key.start_with?('GEM_') || key.start_with?('BUNDLER_')
      ::Bundler::ORIGINAL_ENV[key] = nil
    elsif Bundler::ORIGINAL_ENV[key].nil?
      ::Bundler::ORIGINAL_ENV[key] = value
    end
  end
  ::Bundler.with_clean_env do
    # now the ENV is clean and not missing any right-hand args so replace
    # the ORIGINAL_ENV.
    ::Bundler::ORIGINAL_ENV.replace(ENV)
  end
  true
end