Class: ChefDK::Command::Generate

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

Defined Under Namespace

Classes: GeneratorCommand

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#needs_version?, #run_with_default_options

Methods included from Helpers

#err, #msg, #omnibus_apps_dir, #omnibus_bin_dir, #omnibus_embedded_bin_dir, #omnibus_root, #stderr, #stdout, #system_command

Constructor Details

#initialize(*args) ⇒ Generate

chef generate app path/to/basename –skel=path/to/skeleton –example chef generate file name [path/to/cookbook_root] (inferred from cwd) –from=source_file



63
64
65
 
# File 'lib/chef-dk/command/generate.rb', line 63

def initialize(*args)
  super
end

Class Method Details



56
57
58
 
# File 'lib/chef-dk/command/generate.rb', line 56

def self.banner
  banner_headline + generator_list + "\n"
end



43
44
45
46
47
48
49
 
# File 'lib/chef-dk/command/generate.rb', line 43

def self.banner_headline
  "Usage: chef generate GENERATOR [options]\n\nAvailable generators:\n"
end

.generator(name, class_name, description) ⇒ Object 



31
32
33
 
# File 'lib/chef-dk/command/generate.rb', line 31

def self.generator(name, class_name, description)
  generators << GeneratorCommand.new(name, class_name, description)
end

.generator_list ⇒ Object 



51
52
53
54
 
# File 'lib/chef-dk/command/generate.rb', line 51

def self.generator_list
  justify_size = generators.map {|g| g.name.size }.max + 2
  generators.map {|g| "  #{g.name.to_s.ljust(justify_size)}#{g.description}"}.join("\n")
end

.generators ⇒ Object 



27
28
29
 
# File 'lib/chef-dk/command/generate.rb', line 27

def self.generators
  @generators ||= []
end

Instance Method Details

#generator_for(arg) ⇒ Object 



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

def generator_for(arg)
  self.class.generators.find {|g| g.name.to_s == arg}
end

#have_generator?(name) ⇒ Boolean

Returns:

  • (Boolean) 


91
92
93
 
# File 'lib/chef-dk/command/generate.rb', line 91

def have_generator?(name)
  self.class.generators.map {|g| g.name.to_s}.include?(name)
end

#needs_help?(params) ⇒ Boolean

In the Base class, this is defined to be true if any args match “-h” or “–help”. Here we override that behavior such that if the first argument is a valid generator name, like ‘chef generate cookbook -h`, we delegate the request to the specified generator.

Returns:

  • (Boolean) 


86
87
88
89
 
# File 'lib/chef-dk/command/generate.rb', line 86

def needs_help?(params)
  return false if have_generator?(params[0])
  super
end

#run(params) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/chef-dk/command/generate.rb', line 67

def run(params)
  if generator_spec = generator_for(params[0])
    params.shift
    generator = GeneratorCommands.build(generator_spec.class_name, params)
    generator.run
  else
    msg(banner)
    1
  end
end