Class: ChefDK::Command::ShellInit

Inherits:
Base
  • Object
show all
Defined in:
lib/chef-dk/command/shell_init.rb

Constant Summary collapse

SUPPORTED_SHELLS = 
%w[ bash fish zsh sh powershell posh].map(&:freeze).freeze

Instance Method Summary collapse

Methods inherited from Base

#needs_help?, #needs_version?, #run_with_default_options

Methods included from Helpers

#chefdk_home, #err, #msg, #omnibus_apps_dir, #omnibus_bin_dir, #omnibus_chefdk_location, #omnibus_embedded_bin_dir, #omnibus_install?, #stderr, #stdout, #system_command, #usr_bin_path, #usr_bin_prefix

Constructor Details

#initialize ⇒ ShellInit

Returns a new instance of ShellInit.



78
79
80
81
 
# File 'lib/chef-dk/command/shell_init.rb', line 78

def initialize
  super
  @shell_completion_template_context = nil
end

Instance Method Details

#completion_for(shell) ⇒ Object 



117
118
119
120
121
122
123
 
# File 'lib/chef-dk/command/shell_init.rb', line 117

def completion_for(shell)
  return "" unless (completion_template_basename = completion_template_for(shell))
  completion_template_path = expand_completion_template_path(completion_template_basename)
  erb = ERB.new(File.read(completion_template_path), nil, '-')
  context_binding = shell_completion_template_context.get_binding
  erb.result(context_binding)
end

#completion_template_for(shell) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/chef-dk/command/shell_init.rb', line 125

def completion_template_for(shell)
  case shell
  when "bash"
    "bash.sh.erb"
  when "fish"
    "chef.fish.erb"
  when "zsh"
    "zsh.zsh.erb"
  else
    # Pull requests accepted!
    nil
  end

end

#emit_shell_cmd(cmd) ⇒ Object 



113
114
115
 
# File 'lib/chef-dk/command/shell_init.rb', line 113

def emit_shell_cmd(cmd)
  msg(cmd) unless cmd.empty?
end

#expand_completion_template_path(basename) ⇒ Object 



140
141
142
 
# File 'lib/chef-dk/command/shell_init.rb', line 140

def expand_completion_template_path(basename)
  File.join(File.expand_path("../../completions", __FILE__), basename)
end

#export(shell, var, val) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/chef-dk/command/shell_init.rb', line 148

def export(shell, var, val)
  case shell
  when 'sh', 'bash', 'zsh'
    posix_shell_export(var, val)
  when 'fish'
    fish_shell_export(var, val)
  when 'powershell', 'posh'
    powershell_export(var, val)
  end
end

#fish_shell_export(var, val) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/chef-dk/command/shell_init.rb', line 163

def fish_shell_export(var, val)
  # Fish's syntax for setting PATH is special. Path elements are
  # divided by spaces (instead of colons). We also send STDERR to
  # /dev/null to avoid Fish's helpful warnings about nonexistent
  # PATH elements.
  if var == 'PATH'
    emit_shell_cmd(%Q(set -gx #{var} "#{val.split(':').join('" "')}" 2>/dev/null;))
  else
    emit_shell_cmd(%Q(set -gx #{var} "#{val}";))
  end
end

#omnibus_root ⇒ Object 



83
84
85
 
# File 'lib/chef-dk/command/shell_init.rb', line 83

def omnibus_root
  config[:omnibus_dir] || super
end

#posix_shell_export(var, val) ⇒ Object 



159
160
161
 
# File 'lib/chef-dk/command/shell_init.rb', line 159

def posix_shell_export(var, val)
  emit_shell_cmd(%Q(export #{var}="#{val}"))
end

#powershell_export(var, val) ⇒ Object 



175
176
177
 
# File 'lib/chef-dk/command/shell_init.rb', line 175

def powershell_export(var, val)
  emit_shell_cmd(%Q($env:#{var}="#{val}"))
end

#run(argv) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/chef-dk/command/shell_init.rb', line 87

def run(argv)
  # Currently we don't have any shell-specific features, so we ignore the
  # shell name. We'll need it if we add completion.
  remaining_args = parse_options(argv)
  shell_name = remaining_args.first
  if shell_name.nil?
    err("Please specify what shell you are using\n")
    err(opt_parser.to_s)
    return 1
  elsif !SUPPORTED_SHELLS.include?(shell_name)
    err("Shell `#{shell_name}' is not currently supported")
    err("Supported shells are: #{SUPPORTED_SHELLS.join(' ')}")
    return 1
  end

  env = omnibus_env.dup
  path = env.delete("PATH")
  export(shell_name, "PATH", path)
  env.each do |var_name, value|
    export(shell_name, var_name, value)
  end

  emit_shell_cmd(completion_for(shell_name))
  0
end

#shell_completion_template_context ⇒ Object 



144
145
146
 
# File 'lib/chef-dk/command/shell_init.rb', line 144

def shell_completion_template_context
  @shell_completion_template_context ||= ShellCompletionTemplateContext.new
end