Class: Hiera::Backend::Eyaml::Subcommand

Inherits:
Object
  • Object
show all
Defined in:
lib/hiera/backend/eyaml/subcommand.rb

Constant Summary collapse

@@global_options = 
[
 {:name          => :encrypt_method,
    :description => "Override default encryption and decryption method (default is PKCS7)", 
    :short       => 'n', 
    :default     => "pkcs7"},
 {:name          => :version,
    :description => "Show version information"},
 {:name          => :verbose,
    :description => "Be more verbose",
    :short       => 'v'},
 {:name          => :quiet,
    :description => "Be less verbose",
    :short       => 'q'},
 {:name          => :help,
    :description => "Information on how to use this command",
    :short       => 'h'}
]

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.global_options ⇒ Object

Returns the value of attribute global_options.



12
13
14
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 12

def global_options
  @global_options
end

.helptext ⇒ Object

Returns the value of attribute helptext.



12
13
14
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 12

def helptext
  @helptext
end

.options ⇒ Object

Returns the value of attribute options.



12
13
14
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 12

def options
  @options
end

Class Method Details

.all_options ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 44

def self.all_options 
  options = @@global_options.dup
  options += self.options if self.options
  options += Plugins.options
  # merge in defaults from configuration file
  config_file = self.load_config_file
  options.map!{ | opt| 
    key_name = "#{opt[:name]}"
    if config_file.has_key? key_name
      opt[:default] = config_file[key_name]
      opt
    else
      opt
    end
  }
  options
end

.attach_option(opt) ⇒ Object 



62
63
64
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 62

def self.attach_option opt
  self.suboptions += opt
end

.description ⇒ Object 



125
126
127
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 125

def self.description
  "no description"
end

.execute ⇒ Object

Raises:

  • (StandardError) 


133
134
135
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 133

def self.execute
  raise StandardError, "This command is not implemented yet (#{self.to_s.split('::').last})"
end

.find(commandname = "unknown_command") ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 66

def self.find commandname = "unknown_command"
  begin
    require "hiera/backend/eyaml/subcommands/#{commandname.downcase}"
  rescue Exception => e
    require "hiera/backend/eyaml/subcommands/unknown_command"
    return Hiera::Backend::Eyaml::Subcommands::UnknownCommand
  end          
  command_module = Module.const_get('Hiera').const_get('Backend').const_get('Eyaml').const_get('Subcommands')
  command_class = Utils.find_closest_class :parent_class => command_module, :class_name => commandname
  command_class || Hiera::Backend::Eyaml::Subcommands::UnknownCommand
end

.hidden? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 141

def self.hidden?
  false
end

.load_config_file ⇒ Object 



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 33

def self.load_config_file
  config_file=ENV['EYAML_CONFIG'] || "#{ENV['HOME']}/.eyaml/config.yaml"
  begin
    config = YAML.load_file(config_file)
    Utils::info "Loaded config from #{config_file}"
    config
  rescue Errno::ENOENT, IndexError
    {}
  end
end

.parse ⇒ Object 



78
79
80
81
82
83
84
85
86
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
112
113
114
115
116
117
118
119
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 78

def self.parse

  me = self

  options = Trollop::options do

    version "Hiera-eyaml version " + Hiera::Backend::Eyaml::VERSION.to_s
    banner ["eyaml #{me.prettyname}: #{me.description}", me.helptext, "Options:"].compact.join("\n\n")

    me.all_options.each do |available_option|

      skeleton = {:description => "",
                  :short => :none}

      skeleton.merge! available_option
      opt skeleton[:name], 
          skeleton[:desc] || skeleton[:description],  #legacy plugins 
          :short => skeleton[:short], 
          :default => skeleton[:default], 
          :type => skeleton[:type]

    end

    stop_on Eyaml.subcommands

  end

  if options[:verbose]
    Hiera::Backend::Eyaml.verbosity_level += 1
  end

  if options[:quiet]
    Hiera::Backend::Eyaml.verbosity_level = 0
  end

  if options[:encrypt_method]
    Hiera::Backend::Eyaml.default_encryption_scheme = options[:encrypt_method]
  end

  options

end

.prettyname ⇒ Object 



137
138
139
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 137

def self.prettyname
  Utils.snakecase self.to_s.split('::').last
end

.validate(args) ⇒ Object 



121
122
123
 
# File 'lib/hiera/backend/eyaml/subcommand.rb', line 121

def self.validate args
  args
end