Class: Veewee::Definitions
Instance Attribute Summary collapse
-
#env ⇒ Object
Returns the value of attribute env.
Instance Method Summary collapse
- #[](name) ⇒ Object
- #create_definition_dir_if_needed ⇒ Object
-
#define(definition_name, template_name, options = {}) ⇒ Object
This function 'defines'/'clones'/'instantiates a template: It copies from a template dir with template_name to a new definition dir with definition_name.
-
#each(&block) ⇒ Object
Fetch all definitions.
-
#initialize(env) ⇒ Definitions
constructor
A new instance of Definitions.
-
#undefine(definition_name, options = {}) ⇒ Object
This function undefines/removes the definition by removing the directoy with definition_name under env.definition_dir.
Constructor Details
#initialize(env) ⇒ Definitions
12 13 14 15 16 |
# File 'lib/veewee/definitions.rb', line 12 def initialize(env) @env = env @definitions = {} return self end |
Instance Attribute Details
#env ⇒ Object
Returns the value of attribute env
10 11 12 |
# File 'lib/veewee/definitions.rb', line 10 def env @env end |
Instance Method Details
#[](name) ⇒ Object
19 20 21 22 23 24 25 26 27 28 |
# File 'lib/veewee/definitions.rb', line 19 def [](name) if @definitions[name].nil? begin @definitions[name] = Veewee::Definition.load(name, env) rescue Veewee::DefinitionNotExist return nil end end @definitions[name] end |
#create_definition_dir_if_needed ⇒ Object
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/veewee/definitions.rb', line 169 def create_definition_dir_if_needed # Check if definition_dir already exists unless File.exists?(env.definition_dir) env.logger.debug("Creating definition base directory '#{env.definition_dir}' ") FileUtils.mkdir(env.definition_dir) env.logger.debug("Definition base directory '#{env.definition_dir}' succesfuly created") end if File.writable?(env.definition_dir) env.logger.debug("DefinitionDir '#{env.definition_dir}' is writable") if File.exists?("#{env.definition_dir}") env.logger.debug("DefinitionDir '#{env.definition_dir}' already exists") else env.logger.debug("DefinitionDir '#{env.definition_dir}' does not exist, creating it") FileUtils.mkdir(definition_dir) env.logger.debug("DefinitionDir '#{env.definition_dir}' succesfuly created") end else env.logger.fatal("DefinitionDir '#{env.definition_dir}' is not writable") raise Veewee::Error, "DefinitionDir '#{env.definition_dir}' is not writable" end end |
#define(definition_name, template_name, options = {}) ⇒ Object
This function 'defines'/'clones'/'instantiates a template: It copies from a template dir with template_name
to a new definition dir with definition_name
Options are : :force => true to overwrite an existing definition
Returns definition object
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/veewee/definitions.rb', line 61 def define(definition_name, template_name, = {}) # Default is not to overwrite = { 'force' => false }.merge() env.logger.debug("Forceflag : #{options['force']}") git_template = false # Check if the template is a git repo if template_name.start_with?("git://", "git+ssh://", "git+http://") git_template = true end # Check if template exists template = env.templates[template_name] if template.nil? and ! git_template env.logger.fatal("Template '#{template_name}' does not exist") raise Veewee::TemplateError, "Template '#{template_name}' does not exist" else env.logger.debug("Template '#{template_name}' exists") end create_definition_dir_if_needed # Check if definition does not exist definition = env.definitions[definition_name] unless definition.nil? env.logger.debug("Definition '#{definition_name}' exists") if ['force'] == true self.undefine(definition_name, ) else raise Veewee::DefinitionError, "Definition #{definition_name} already exists and no force option was given" end end env.logger.info("Creating definition #{definition_name} in directory '#{env.definition_dir}' ") dst_dir = "#{File.join(env.definition_dir, definition_name)}" FileUtils.mkdir(dst_dir) env.logger.debug("Definition Directory '#{File.join(env.definition_dir, definition_name)}' succesfuly created") # Start copying/cloning the directory of the template to the definition directory if (git_template) begin env.logger.info("Starting git clone #{template_name} #{dst_dir}") g = Grit::Git.new(dst_dir) g.clone({ :timeout => false }, template_name, dst_dir) rescue Exception => ex err = "git clone #{template_name} #{dst_dir} failed: #{ex}" env.logger.fatal(err) raise Veewee::DefinitionError, err end else begin env.logger.debug("Starting copy '#{template.path}' to '#{dst_dir}'") FileUtils.cp_r(template.path + "/.", dst_dir, :preserve => true) env.logger.debug("Copy '#{template.path}' to '#{dst_dir}' succesful") rescue Exception => ex env.logger.fatal("Copy '#{template.path}' to #{dst_dir}' failed: #{ex}") raise Veewee::Error, "Copy '#{template.path}' to #{dst_dir}' failed: #{ex}" end end # If the template includes a NOTICE.erb or NOTICE.txt file, display it to the user # .erb file takes priority, then .txt notice_erb = File.join(dst_dir, 'NOTICE.erb') notice_txt = File.join(dst_dir, 'NOTICE.txt') if File.exist?(notice_erb) template = File.read(notice_erb) text = ERB.new(template).result(binding) elsif File.exist?(notice_txt) text = File.read(notice_txt) end if text env.ui.warn("Template #{template_name} includes this NOTICE text you should first read:\n") env.ui.info("#{text}\n") end definition = env.definitions[definition_name] return definition end |
#each(&block) ⇒ Object
Fetch all definitions
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/veewee/definitions.rb', line 31 def each(&block) definitions = Hash.new env.logger.debug("[Definition] Searching #{env.definition_dir} for definitions:") subdirs = Dir.glob("#{env.definition_dir}/*") subdirs.each do |sub| name = File.basename(sub) env.logger.debug("[Definition] possible definition '#{name}' found") begin definitions[name] = Veewee::Definition.load(name, env) rescue Veewee::DefinitionError => ex env.logger.debug("[Definition] failed to load definition from directory '#{name}' #{ex}") end end if definitions.length == 0 env.logger.debug("[Definition] no definitions found") end definitions.each(&block) end |
#undefine(definition_name, options = {}) ⇒ Object
This function undefines/removes the definition by removing the directoy with definition_name under env.definition_dir
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/veewee/definitions.rb', line 146 def undefine(definition_name, = {}) definition = env.definitions[definition_name] unless definition.nil? #TODO: Needs to be more defensive!! env.logger.debug("[Undefine] About to remove '#{definition.path} for '#{definition_name}'") begin if File.exists?(File.join(definition.path, "definition.rb")) FileUtils.rm_rf(definition.path) else env.logger.fatal("Aborting delete: The directory definition.path does not contain a definition.rb file") raise Veewee::DefinitionError, "Aborting delete: The directory definition.path does not contain a definition.rb file" end rescue Exception => ex env.logger.fatal("Removing '#{definition.path} for '#{definition_name}' failed: #{ex}") raise Veewee::Error, "Removing '#{definition.path }for '#{definition_name}' failed: #{ex}" end env.logger.debug("Removing '#{definition.path} for '#{definition_name}' succesful") else raise Veewee::DefinitionError, "Definition '#{definition_name}' does not exist" end end |