123456789_123456789_123456789_123456789_123456789_

Module: YARD::Templates::Template::ClassMethods

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In:
::YARD::Templates::Template
Defined in: lib/yard/templates/template.rb

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#full_path (rw)

[ GitHub ] 

  


# File 'lib/yard/templates/template.rb', line 60



attr_accessor :path, :full_path


  








  

    #path   (rw)
  

  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 60



attr_accessor :path, :full_path


  







Instance Method Details



  

    #find_file(basename)  ⇒ String 
  



  

    
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.


  





  
Parameters:


    
  
  • 
    basename
    (String)
—    
    the filename to search for
    

    
  
    • 



Returns:


    
  
  • 
    (String)
—    
    the full path of a file on disk with filename
basename in one of the template's paths.
    

    
  
    • 


  
See Also:

  



  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 98



def find_file(basename)
  find_nth_file(basename)
end


  








  

    #find_nth_file(basename, index = 1)  ⇒ String 
  



  

    
Searches for the nth file (where n = index) identified
by basename in the template's path and any mixed in template paths.


  





  
Parameters:


    
  
  • 
    basename
    (String)
—    
    the filename to search for
    

    
  
    • 
  
  • 
    index
    (Fixnum)
    (defaults to: 1)
—    
    the nth existing file to return
    

    
  
    • 



Returns:


    
  
  • 
    (String)
—    
    the full path of the nth file on disk with
filename basename in one of the template paths
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 109



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


  








  

    #full_paths  ⇒ Array<String> 
  



  

    
  

    Note:
    
This method caches path results. Paths should not be modified
after this method is called; call #reset_full_paths to reset cache.



  



  





  
Returns:





  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 65



def full_paths
  reset_full_paths unless defined? @cached_included_modules
  return @full_paths if included_modules == @cached_included_modules

  @cached_included_modules = included_modules
  @full_paths = included_modules.inject([full_path]) do |paths, mod|
    paths |= mod.full_paths if mod.respond_to?(:full_paths)
    paths
  end
end


  








  

    #include_inherited(full_paths)   (private)
  

  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 170



def include_inherited(full_paths)
  full_paths.reverse.each do |full_path|
    include Engine.template!(path, full_path)
  end
end


  








  

    #include_parent   (private)
  

  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 157



def include_parent
  pc = path.to_s.split('/')
  if pc.size > 1
    pc.pop
    pc = pc.join('/')
    begin
      include Engine.template(pc)
    rescue ArgumentError
      include Engine.template!(pc, full_path.gsub(%r{/[^/]+$}, ''))
    end
  end
end


  








  

    #initialize(path, full_paths)  
  

  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 81



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


  








  

    #is_a?(klass)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 122



def is_a?(klass)
  return true if klass == Template
  super(klass)
end


  








  

    #load_setup_rb   (private)
  

  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 176



def load_setup_rb
  setup_file = File.join(full_path, 'setup.rb')
  if File.file? setup_file
    setup_code = File.read(setup_file)
    setup_code.taint if setup_code.respond_to?(:taint)
    module_eval(setup_code, setup_file, 1)
  end
end


  








  

    #new(*args)  
  



  

    
Creates a new template object to be rendered with YARD::Templates::Template#run


  



  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 128



def new(*args)
  obj = Object.new.extend(self)
  obj.class = self
  obj.send(:initialize, *args)
  obj
end


  








  

    #reset_full_paths  
  



  

    
Resets cache for #full_paths


  



  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 77



def reset_full_paths
  @cached_included_modules = nil
end


  








  

    #run(*args)  
  

  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 135



def run(*args)
  new(*args).run
end


  








  

    S(*args)  
  



  

    
Alias for creating a ::YARD::Templates::Section with arguments


  





    
See Also:

  
    
      
  • Section#initialize
    • 
      


Since:


    
  
  • 
    
    0.6.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 149



def S(*args)
  Section.new(*args)
end


  








  

    T(*path)  
  



  

    
Alias for creating Engine.template.


  



  [ GitHub ]


  

  


# File 'lib/yard/templates/template.rb', line 142



def T(*path)
  Engine.template(*path)
end