Module: YARD::Templates::Template::ClassMethods
- Defined in:
- lib/yard/templates/template.rb
Instance Attribute Summary (collapse)
-
- (Object) full_path
Returns the value of attribute full_path.
-
- (Object) path
Returns the value of attribute path.
Instance Method Summary (collapse)
-
- (String) find_file(basename)
Searches for a file identified by basename in the template's path as well as any mixed in template paths.
-
- (String) find_nth_file(basename, index = 1)
Searches for the nth file (where n = index) identified by basename in the template's path and any mixed in template paths.
- - (Object) full_paths
-
- (ClassMethods) initialize(path, full_paths)
A new instance of ClassMethods.
- - (Boolean) is_a?(klass)
-
- (Object) new(*args)
Creates a new template object to be rendered with #run.
- - (Object) run(*args)
-
- (Object) S(*args)
Alias for creating a Section with arguments.
- - (Object) T(*path)
Instance Attribute Details
- (Object) full_path
Returns the value of attribute full_path
27 28 29 |
# File 'lib/yard/templates/template.rb', line 27 def full_path @full_path end |
- (Object) path
Returns the value of attribute path
27 28 29 |
# File 'lib/yard/templates/template.rb', line 27 def path @path end |
Instance Method Details
- (String) find_file(basename)
Searches for a file identified by basename in the template's path as well as any mixed in template paths. Equivalent to calling #find_nth_file with index of 1.
53 54 55 |
# File 'lib/yard/templates/template.rb', line 53 def find_file(basename) find_nth_file(basename) end |
- (String) find_nth_file(basename, index = 1)
Searches for the nth file (where n = index) identified by basename in the template's path and any mixed in template paths.
64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/yard/templates/template.rb', line 64 def find_nth_file(basename, index = 1) n = 1 full_paths.each do |path| file = File.join(path, basename) if File.file?(file) return file if index == n n += 1 end end nil end |
- (Object) full_paths
29 30 31 32 33 34 |
# File 'lib/yard/templates/template.rb', line 29 def full_paths included_modules.inject([full_path]) do |paths, mod| paths |= mod.full_paths if mod.respond_to?(:full_paths) paths end end |
- (ClassMethods) initialize(path, full_paths)
A new instance of ClassMethods
36 37 38 39 40 41 42 43 |
# File 'lib/yard/templates/template.rb', line 36 def initialize(path, full_paths) full_path = full_paths.shift self.path = path self.full_path = full_path include_inherited(full_paths) include_parent load_setup_rb end |
- (Boolean) is_a?(klass)
77 78 79 80 |
# File 'lib/yard/templates/template.rb', line 77 def is_a?(klass) return true if klass == Template super(klass) end |
- (Object) new(*args)
Creates a new template object to be rendered with YARD::Templates::Template#run
83 84 85 86 87 88 |
# File 'lib/yard/templates/template.rb', line 83 def new(*args) obj = Object.new.extend(self) obj.class = self obj.send(:initialize, *args) obj end |
- (Object) run(*args)
90 91 92 |
# File 'lib/yard/templates/template.rb', line 90 def run(*args) new(*args).run end |
- (Object) S(*args)
Alias for creating a Section with arguments
101 102 103 |
# File 'lib/yard/templates/template.rb', line 101 def S(*args) Section.new(*args) end |
- (Object) T(*path)
94 95 96 |
# File 'lib/yard/templates/template.rb', line 94 def T(*path) Engine.template(*path) end |