Module: RHC::OutputHelpers

Included in:
Helpers
Defined in:
lib/rhc/output_helpers.rb

Instance Method Summary collapse

Instance Method Details

#default_display_env_var(env_var_name, env_var_value = nil) ⇒ Object 



168
169
170
 
# File 'lib/rhc/output_helpers.rb', line 168

def default_display_env_var(env_var_name, env_var_value=nil)
  info "#{env_var_name}#{env_var_value.nil? ? '' : '=' + env_var_value}"
end

#display_app(app, cartridges = nil, properties = nil, verbose = false) ⇒ Object

Application information



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rhc/output_helpers.rb', line 47

def display_app(app, cartridges=nil, properties=nil, verbose=false)
  paragraph do
    header [app.name, "@ #{app.app_url}", "(uuid: #{app.uuid})"] do
      section(:bottom => 1) do
        say format_table \
          nil,
          get_properties(app, properties ||
            [:domain,
            :creation_time,
            :gear_info,
            :git_url,
            :initial_git_url,
            :ssh_string,
            :auto_deploy,
            :aliases]),
          :delete => true
      end
      cartridges.each{ |c| section(:bottom => 1){ display_cart(c, verbose ? :verbose : []) } } if cartridges
    end
  end
end

#display_app_configurations(rest_app) ⇒ Object 



69
70
71
 
# File 'lib/rhc/output_helpers.rb', line 69

def display_app_configurations(rest_app)
  display_app(rest_app, nil, [:auto_deploy, :keep_deployments, :deployment_type, :deployment_branch])
end

#display_authorization(auth, default = nil) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/rhc/output_helpers.rb', line 136

def display_authorization(auth, default=nil)
  say format_table(
    auth.note || "<no description>",
    get_properties(auth, :token, :scopes, :creation_time, :expires_in_seconds),
    {
      :delete => true,
      :color => (:green if auth.token == default),
    }
  )
end

#display_cart(cart, *properties) ⇒ Object

Cartridge information



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/rhc/output_helpers.rb', line 106

def display_cart(cart, *properties)
  verbose = properties.delete(:verbose)
  say format_table \
    format_cart_header(cart),
      get_properties(cart, *properties).
        concat(verbose && cart.custom? ? [[:description, cart.description.strip]] : []).
        concat([[:downloaded_cartridge_url, cart.url]]).
        concat(verbose && cart.custom? ? [[:version, cart.version]] : []).
        concat(verbose && cart.custom? && cart.license.strip.downcase != 'unknown' ? [[:license, cart.license]] : []).
        concat(cart.custom? ? [[:website, cart.website]] : []).
        concat([[cart.scalable? ? :scaling : :gears, format_cart_gears(cart)]]).
        concat(cart.properties.map{ |p| ["#{table_heading(p['name'])}:", p['value']] }.sort{ |a,b| a[0] <=> b[0] }).
        concat(cart.environment_variables.present? ? [[:environment_variables, cart.environment_variables.map{|item| "#{item[:name]}=#{item[:value]}" }.sort.join(', ')]] : []),
    :delete => true

  say format_usage_message(cart) if cart.usage_rate?
end

#display_cart_storage_info(cart, title = "Storage Info") ⇒ Object 



154
155
156
157
158
 
# File 'lib/rhc/output_helpers.rb', line 154

def display_cart_storage_info(cart, title="Storage Info")
  say format_table \
    title,
    get_properties(cart,:base_gear_storage,:additional_gear_storage)
end

#display_cart_storage_list(carts) ⇒ Object 



160
161
162
 
# File 'lib/rhc/output_helpers.rb', line 160

def display_cart_storage_list(carts)
  carts.each{ |cart| paragraph{ display_cart_storage_info(cart, cart.display_name) } }
end

#display_deployment(item, highlight_active = true) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/rhc/output_helpers.rb', line 184

def display_deployment(item, highlight_active=true)
  deployment = item[:deployment]
  active = item[:active]
  paragraph do
    say format_table(
      "Deployment ID #{deployment.id} #{active ? '(active)' : '(inactive)'}",
      get_properties(deployment, :ref, :sha1, :created_at, :artifact_url, :hot_deploy, :force_clean_build, :activations),
      {
        :delete => true,
        :color => (:green if active && highlight_active)
      }
    )
  end
end

#display_deployment_list(deployment_activations, highlight_active = true) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/rhc/output_helpers.rb', line 199

def display_deployment_list(deployment_activations, highlight_active=true)
  if deployment_activations.present?
    paragraph do
      deployment_activations.each do |item|
        activation = item[:activation]
        deployment = item[:deployment]
        rollback = item[:rollback]
        rollback_to = item[:rollback_to]
        rolled_back = item[:rolled_back]
        active = item[:active]
        say color(
          date(activation.created_at.to_s) +
          ', deployment ' + deployment.id +
          (rollback ? " (rollback to #{date(rollback_to.to_s)}#{rolled_back ? ', rolled back' : ''})" : rolled_back ? ' (rolled back)' : ''),
            active ? :green : rolled_back ? :yellow : nil)
      end
    end
  end
end

#display_domain(domain, applications = nil, ids = false) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rhc/output_helpers.rb', line 22

def display_domain(domain, applications=nil, ids=false)
  paragraph do
    header ["Domain #{domain.name}", ("(owned by #{domain.owner})" if domain.owner.present?)] do
      section(:bottom => 1) do
        say format_table \
          nil,
          get_properties(
            domain,
            :creation_time,
            (:id if ids),
            (:allowed_gear_sizes unless domain.allowed_gear_sizes.nil?),
            :compact_members
          ),
          :delete => true
      end
      applications.each do |a|
        display_app(a,a.cartridges)
      end if applications.present?
    end
  end
end

#display_env_var_list(env_vars, opts = {}) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/rhc/output_helpers.rb', line 172

def display_env_var_list(env_vars, opts={})
  if env_vars.present?
    if opts[:table]
      say table(env_vars.collect{ |item| [item.name, opts[:quotes] ? "\"#{item.value}\"" : item.value] }, :header => ['Name', 'Value'])
    else
      env_vars.sort.each do |env_var|
        default_display_env_var(env_var.name, opts[:quotes] ? "\"#{env_var.value}\"" : env_var.value)
      end
    end
  end
end

#display_key(key, *properties) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/rhc/output_helpers.rb', line 124

def display_key(key, *properties)
  properties = [:fingerprint, :principal, :visible_to_ssh?] if properties.empty?
  say format_table(
    properties.include?(:name) ? nil : format_key_header(key),
    get_properties(key, *properties),
    {
      :delete => true,
      :color => (:green if properties.include?(:visible_to_ssh?) && key.visible_to_ssh?),
    }
  )
end

#display_team(team, ids = false) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/rhc/output_helpers.rb', line 4

def display_team(team, ids=false)
  paragraph do
    header ["Team #{team.name}", ("(owned by #{team.owner})" if team.owner.present?)] do
      section(:bottom => 1) do
        say format_table \
          nil,
          get_properties(
            team,
            (:id if ids),
            (:global if team.global?),
            :compact_members
          ),
          :delete => true
      end
    end
  end
end

#format_cart_gears(cart) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/rhc/output_helpers.rb', line 85

def format_cart_gears(cart)
  if cart.scalable?
    format_scaling_info(cart.scaling)
  elsif cart.shares_gears?
    "Located with #{cart.collocated_with.join(", ")}"
  elsif cart.external? && cart.current_scale == 0
    "none (external service)"
  else
    "%d %s" % [format_value(:current_scale, cart.current_scale), format_value(:gear_profile, cart.gear_profile)]
  end
end

#format_cart_header(cart) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/rhc/output_helpers.rb', line 73

def format_cart_header(cart)
  [
    cart.name,
    cart.name != cart.display_name ? "(#{cart.display_name})" : nil,
  ].compact
end

#format_gear_info(info) ⇒ Object 



97
98
99
100
 
# File 'lib/rhc/output_helpers.rb', line 97

def format_gear_info(info)
  "%d (defaults to %s)" %
    [:gear_count, :gear_profile].map{ |key| format_value(key, info[key]) } if info
end

#format_key_header(key) ⇒ Object 



147
148
149
150
151
152
 
# File 'lib/rhc/output_helpers.rb', line 147

def format_key_header(key)
  [
    key.name,
    "(type: #{key.type})",
  ].compact
end

#format_scaling_info(scaling) ⇒ Object 



80
81
82
83
 
# File 'lib/rhc/output_helpers.rb', line 80

def format_scaling_info(scaling)
  "x%d (minimum: %s, maximum: %s) on %s gears" %
    [:current_scale, :scales_from, :scales_to, :gear_profile].map{ |key| format_value(key, scaling[key]) } if scaling
end

#format_usage_message(cart) ⇒ Object 



164
165
166
 
# File 'lib/rhc/output_helpers.rb', line 164

def format_usage_message(cart)
  "This gear costs an additional $#{cart.usage_rate} per gear after the first 3 gears."
end