Class: RubiGen::Commands::Create
- Defined in:
- lib/rubigen/commands.rb
Overview
Create is the premier generator command. It copies files, creates directories, renders templates, and more.
Direct Known Subclasses
Instance Attribute Summary
Attributes inherited from Base
#args, #destination_root, #source_root, #stdout
Attributes included from Options
Instance Method Summary collapse
-
#class_collisions(*class_names) ⇒ Object
Check whether the given class names are already taken.
- #complex_template(relative_source, relative_destination, template_options = {}) ⇒ Object
-
#directory(relative_path) ⇒ Object
Create a directory including any missing parent directories.
-
#file(relative_source, relative_destination, file_options = {}, &block) ⇒ Object
Copy a file from source to destination with collision checking.
- #file_copy_each(files, path = nil, options = {}) ⇒ Object
- #folder(template_path, path = nil, options = {}) ⇒ Object
-
#identical?(source, destination, &block) ⇒ Boolean
Checks if the source and the destination file are identical.
-
#migration_template(relative_source, relative_destination, template_options = {}) ⇒ Object
When creating a migration, it knows to find the first available file in db/migrate and use the migration.rb template.
-
#readme(*relative_sources) ⇒ Object
Display a README.
- #route_resources(*resources) ⇒ Object
-
#template(relative_source, relative_destination, template_options = {}) ⇒ Object
Generate a file using an ERuby template.
- #template_copy_each(files, path = nil, options = {}) ⇒ Object
- #write_manifest(relative_destination) ⇒ Object
Methods inherited from Base
Methods inherited from Base
#after_generate, #base_name, #destination_path, #initialize, #manifest, #source_path
Methods included from Options
Constructor Details
This class inherits a constructor from RubiGen::Base
Instance Method Details
#class_collisions(*class_names) ⇒ Object
Check whether the given class names are already taken. In the future, expand to check other namespaces such as the rest of the user’s app.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/rubigen/commands.rb', line 180 def class_collisions(*class_names) class_names.flatten.each do |class_name| # Convert to string to allow symbol arguments. class_name = class_name.to_s # Skip empty strings. next if class_name.strip.empty? # Split the class from its module nesting. nesting = class_name.split('::') name = nesting.pop # Extract the last Module in the nesting. last = nesting.inject(Object) { |last, nest| break unless last.const_defined?(nest) last.const_get(nest) } # If the last Module exists, check whether the given # class exists and raise a collision if so. if last and last.const_defined?(name.camelize) raise_class_collision(class_name) end end end |
#complex_template(relative_source, relative_destination, template_options = {}) ⇒ Object
335 336 337 338 339 340 |
# File 'lib/rubigen/commands.rb', line 335 def complex_template(relative_source, relative_destination, = {}) = .dup [:assigns] ||= {} [:assigns]['template_for_inclusion'] = render_template_part() template(relative_source, relative_destination, ) end |
#directory(relative_path) ⇒ Object
Create a directory including any missing parent directories. Always skips directories which exist.
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'lib/rubigen/commands.rb', line 344 def directory(relative_path) path = destination_path(relative_path) if File.exist?(path) logger.exists relative_path else logger.create relative_path unless [:pretend] FileUtils.mkdir_p(path) # git doesn't require adding the paths, adding the files later will # automatically do a path add. # Subversion doesn't do path adds, so we need to add # each directory individually. # So stack up the directory tree and add the paths to # subversion in order without recursion. if [:svn] stack = [relative_path] until File.dirname(stack.last) == stack.last # dirname('.') == '.' stack.push File.dirname(stack.last) end stack.reverse_each do |rel_path| svn_path = destination_path(rel_path) system("svn add -N #{svn_path}") unless File.directory?(File.join(svn_path, '.svn')) end end end end end |
#file(relative_source, relative_destination, file_options = {}, &block) ⇒ Object
Copy a file from source to destination with collision checking.
The file_options hash accepts :chmod and :shebang and :collision options. :chmod sets the permissions of the destination file:
file 'config/empty.log', 'log/test.log', :chmod => 0664
:shebang sets the #!/usr/bin/ruby line for scripts
file 'bin/generate.rb', 'script/generate', :chmod => 0755, :shebang => '/usr/bin/env ruby'
:collision sets the collision option only for the destination file:
file 'settings/server.yml', 'config/server.yml', :collision => :skip
Collisions are handled by checking whether the destination file exists and either skipping the file, forcing overwrite, or asking the user what to do.
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/rubigen/commands.rb', line 219 def file(relative_source, relative_destination, = {}, &block) # Determine full paths for source and destination files. source = source_path(relative_source) destination = destination_path(relative_destination) destination_exists = File.exist?(destination) # If source and destination are identical then we're done. if destination_exists and identical?(source, destination, &block) return logger.identical(relative_destination) end # Check for and resolve file collisions. if destination_exists # Make a choice whether to overwrite the file. :force and # :skip already have their mind made up, but give :ask a shot. choice = case ([:collision] || [:collision]).to_sym #|| :ask when :ask then force_file_collision?(relative_destination, source, destination, , &block) when :force then :force when :skip then :skip else raise "Invalid collision option: #{[:collision].inspect}" end # Take action based on our choice. Bail out if we chose to # skip the file; otherwise, log our transgression and continue. case choice when :force then logger.force(relative_destination) when :skip then return(logger.skip(relative_destination)) else raise "Invalid collision choice: #{choice}.inspect" end # File doesn't exist so log its unbesmirched creation. else logger.create relative_destination end # If we're pretending, back off now. return if [:pretend] # Write destination file with optional shebang. Yield for content # if block given so templaters may render the source file. If a # shebang is requested, replace the existing shebang or insert a # new one. File.open(destination, 'wb') do |dest| dest.write render_file(source, , &block) end # Optionally change permissions. if [:chmod] FileUtils.chmod([:chmod], destination) end # Optionally add file to subversion or git system("svn add #{destination}") if [:svn] end |
#file_copy_each(files, path = nil, options = {}) ⇒ Object
275 276 277 278 279 280 |
# File 'lib/rubigen/commands.rb', line 275 def file_copy_each(files, path=nil, = {}) path = path ? "#{path}/" : "" files.each do |file_name| file "#{path}#{file_name}", "#{path}#{file_name}", end end |
#folder(template_path, path = nil, options = {}) ⇒ Object
282 283 284 285 286 287 288 289 290 |
# File 'lib/rubigen/commands.rb', line 282 def folder(template_path, path=nil, = {}) template_path = "/" if template_path.blank? source = source_path(template_path) files = Dir[source + '/*'].select { |file| File.file? file }.map { |file| file.sub(/^#{source}/,"") } files.each do |file_name| file "#{template_path}#{file_name}", "#{path}#{file_name}", end system("git add -v #{relative_destination}") if [:git] end |
#identical?(source, destination, &block) ⇒ Boolean
Checks if the source and the destination file are identical. If passed a block then the source file is a template that needs to first be evaluated before being compared to the destination.
295 296 297 298 299 300 |
# File 'lib/rubigen/commands.rb', line 295 def identical?(source, destination, &block) return false if File.directory? destination source = block_given? ? File.open(source) {|sf| yield(sf)} : IO.read(source) destination = IO.read(destination) source == destination end |
#migration_template(relative_source, relative_destination, template_options = {}) ⇒ Object
When creating a migration, it knows to find the first available file in db/migrate and use the migration.rb template.
419 420 421 422 423 424 |
# File 'lib/rubigen/commands.rb', line 419 def migration_template(relative_source, relative_destination, = {}) migration_directory relative_destination migration_file_name = [:migration_file_name] || file_name raise "Another migration is already named #{migration_file_name}: #{existing_migrations(migration_file_name).first}" if migration_exists?(migration_file_name) template(relative_source, "#{relative_destination}/#{next_migration_string}_#{migration_file_name}.rb", ) end |
#readme(*relative_sources) ⇒ Object
Display a README.
374 375 376 377 378 379 |
# File 'lib/rubigen/commands.rb', line 374 def readme(*relative_sources) relative_sources.flatten.each do |relative_source| logger.readme relative_source stdout.puts File.read(source_path(relative_source)) unless [:pretend] end end |
#route_resources(*resources) ⇒ Object
426 427 428 429 430 431 432 433 434 435 436 |
# File 'lib/rubigen/commands.rb', line 426 def route_resources(*resources) resource_list = resources.map { |r| r.to_sym.inspect }.join(', ') sentinel = 'ActionController::Routing::Routes.draw do |map|' logger.route "map.resources #{resource_list}" unless [:pretend] gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match| "#{match}\n map.resources #{resource_list}\n" end end end |
#template(relative_source, relative_destination, template_options = {}) ⇒ Object
Generate a file using an ERuby template. Looks up and evaluates a template by name and writes the result.
The ERB template uses explicit trim mode to best control the proliferation of whitespace in generated code. <%- trims leading whitespace; -%> trims trailing whitespace including one newline.
A hash of template options may be passed as the last argument. The options accepted by the file are accepted as well as :assigns, a hash of variable bindings. Example:
template 'foo', 'bar', :assigns => { :action => 'view' }
Template is implemented in terms of file. It calls file with a block which takes a file handle and returns its rendered contents.
316 317 318 319 320 321 322 323 324 325 326 |
# File 'lib/rubigen/commands.rb', line 316 def template(relative_source, relative_destination, = {}) file(relative_source, relative_destination, ) do |file| # Evaluate any assignments in a temporary, throwaway binding. vars = [:assigns] || {} b = binding vars.each { |k,v| eval "#{k} = vars[:#{k}] || vars['#{k}']", b } # Render the source file with the temporary binding. ERB.new(file.read, nil, '-').result(b) end end |
#template_copy_each(files, path = nil, options = {}) ⇒ Object
328 329 330 331 332 333 |
# File 'lib/rubigen/commands.rb', line 328 def template_copy_each(files, path = nil, = {}) path = path ? "#{path}/" : "" files.each do |file_name| template "#{path}#{file_name}", "#{path}#{file_name.gsub(/\.erb$/,'')}", end end |
#write_manifest(relative_destination) ⇒ Object
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
# File 'lib/rubigen/commands.rb', line 381 def write_manifest(relative_destination) files = ([relative_destination] + Dir["#{destination_root}/**/*"]) files.reject! { |file| File.directory?(file) } files.map! { |path| path.sub("#{destination_root}/","") } files = files.uniq.sort destination = destination_path(relative_destination) destination_exists = File.exists?(destination) # Check for and resolve file collisions. if destination_exists # Always recreate the Manifest (perhaps we need to give the option... like normal files) choice = :force logger.force(relative_destination) # File doesn't exist so log its unbesmirched creation. else logger.create relative_destination end # If we're pretending, back off now. return if [:pretend] # Write destination file with optional shebang. Yield for content # if block given so templaters may render the source file. If a # shebang is requested, replace the existing shebang or insert a # new one. File.open(destination, 'wb') do |dest| dest.write files.join("\n") dest.write "\n" end # Optionally add file to subversion system("svn add #{destination}") if [:svn] end |