Class: Mortar::Command::Config

Inherits:
Base
  • Object
show all
Defined in:
lib/mortar/command/config.rb

Overview

manage project config variables

Instance Attribute Summary

Attributes inherited from Base

#args, #options

Instance Method Summary collapse

Methods inherited from Base

#api, #ask_public, #config_parameters, #get_error_message_context, #git, #initialize, #initialize_embedded_project, namespace, #pig_parameters, #project, #register_api_call, #register_do, #register_project, #validate_project_name, #validate_project_structure

Methods included from Helpers

#action, #ask, #confirm, #copy_if_not_present_at_dest, #default_host, #deprecate, #display, #display_header, #display_object, #display_row, #display_table, #display_with_indent, #download_to_file, #ensure_dir_exists, #error, error_with_failure, error_with_failure=, extended, extended_into, #format_bytes, #format_date, #format_with_bang, #get_terminal_environment, #home_directory, #host, #hprint, #hputs, included, included_into, #installed_with_omnibus?, #json_decode, #json_encode, #line_formatter, #longest, #output_with_bang, #quantify, #redisplay, #retry_on_exception, #running_on_a_mac?, #running_on_windows?, #set_buffer, #shell, #spinner, #status, #string_distance, #styled_array, #styled_error, #styled_hash, #styled_header, #suggestion, #test_name, #ticking, #time_ago, #truncate, #warning, #with_tty, #write_to_file

Constructor Details

This class inherits a constructor from Mortar::Command::Base

Instance Method Details

#getObject

config:get KEY

display a config var for a project

Examples:

$ mortar config:get MY_CONFIG_VAR one



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/mortar/command/config.rb', line 69

def get
  unless key = shift_argument
    error("Usage: mortar config:get KEY\nMust specify KEY.")
  end
  validate_arguments!
  project_name = options[:project] || project.name

  vars = api.get_config_vars(project_name).body['config']
  key_name, value = vars.detect {|k,v| k == key}
  unless key_name
    error("Config var #{key} is not defined for project #{project_name}.")
  end
  
  display(value.to_s)
end

#indexObject

config

Display the config vars for a project.

-s, –shell # output config vars in shell format

$ mortar config A: one B: two

$ mortar config –shell A=one B=two



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/mortar/command/config.rb', line 41

def index
  validate_arguments!
  project_name = options[:project] || project.name
  vars = api.get_config_vars(project_name).body['config']
  if vars.empty?
    display("#{project_name} has no config vars.")
  else
    vars.each {|key, value| vars[key] = value.to_s}
    if options[:shell]
      vars.keys.sort.each do |key|
        display(%{#{key}=#{vars[key]}})
      end
    else
      styled_header("#{project_name} Config Vars")
      styled_hash(vars)
    end
  end
end

#setObject

config:set KEY1=VALUE1 [KEY2=VALUE2 …]

Set one or more config vars

Example:

$ mortar config:set A=one Setting config vars… done. A: one

$ mortar config:set A=one B=two Setting config vars… done. A: one B: two



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/mortar/command/config.rb', line 100

def set
  unless args.size > 0 and args.all? { |a| a.include?('=') }
    error("Usage: mortar config:set KEY1=VALUE1 [KEY2=VALUE2 ...]\nMust specify KEY and VALUE to set.")
  end

  vars = args.inject({}) do |vars, arg|
    key, value = arg.split('=', 2)
    vars[key] = value
    vars
  end

  project_name = options[:project] || project.name

  action("Setting config vars for project #{project_name}") do
    api.put_config_vars(project_name, vars)
  end

  vars.each {|key, value| vars[key] = value.to_s}
  styled_hash(vars)
end

#unsetObject

config:unset KEY1 [KEY2 …]

unset one or more config vars

$ mortar config:unset A Unsetting A… done

$ mortar config:unset A B Unsetting A… done Unsetting B… done



135
136
137
138
139
140
141
142
143
144
145
# File 'lib/mortar/command/config.rb', line 135

def unset
  if args.empty?
    error("Usage: mortar config:unset KEY1 [KEY2 ...]\nMust specify KEY to unset.")
  end
  project_name = options[:project] || project.name
  args.each do |key|
    action("Unsetting #{key} for project #{project_name}") do
      api.delete_config_var(project_name, key)
    end
  end
end