Rename current local to target

Author: st0012

lib/rdoc/generator/darkfish.rb

@@ -318,10 +318,8 @@ def generate_index
 
     render_template template_file, out_file do |io|
       here = binding
-      # suppress 1.9.3 warning
       here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
-      # some partials rely on the presence of current variable to render
-      here.local_variable_set(:current, @main_page)
+      here.local_variable_set(:target, @main_page)
       here
     end
   rescue => e
@@ -336,7 +334,7 @@ def generate_index
   # Generates a class file for +klass+
 
   def generate_class klass, template_file = nil
-    current = klass
+    target = klass
 
     template_file ||= @template_dir + 'class.rhtml'
 
@@ -348,16 +346,15 @@ def generate_class klass, template_file = nil
 
     asset_rel_prefix = rel_prefix + @asset_rel_path
 
-    breadcrumb = # used in templates
-    breadcrumb = generate_nesting_namespaces_breadcrumb(current, rel_prefix)
+    breadcrumb = generate_nesting_namespaces_breadcrumb(target, rel_prefix)
 
     @title = "#{klass.type} #{klass.full_name} - #{@options.title}"
 
     debug_msg "  rendering #{out_file}"
     render_template template_file, out_file do |io|
       here = binding
-      # suppress 1.9.3 warning
       here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here.local_variable_set(:breadcrumb, breadcrumb)
       here
     end
   end
@@ -372,16 +369,16 @@ def generate_class_files
     return unless template_file.exist?
     debug_msg "Generating class documentation in #{@outputdir}"
 
-    current = nil
+    target = nil
 
     @classes.each do |klass|
-      current = klass
+      target = klass
 
       generate_class klass, template_file
     end
   rescue => e
     error = RDoc::Error.new \
-      "error generating #{current.path}: #{e.message} (#{e.class})"
+      "error generating #{target.path}: #{e.message} (#{e.class})"
     error.set_backtrace e.backtrace
 
     raise error
@@ -404,10 +401,10 @@ def generate_file_files
     debug_msg "Generating file documentation in #{@outputdir}"
 
     out_file = nil
-    current = nil
+    target = nil
 
     @files.each do |file|
-      current = file
+      target = file
 
       if file.text? and page_file.exist? then
         generate_page file
@@ -440,9 +437,8 @@ def generate_file_files
 
       render_template template_file, out_file do |io|
         here = binding
-        # suppress 1.9.3 warning
         here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
-        here.local_variable_set(:current, current)
+        here.local_variable_set(:target, target)
         here
       end
     end
@@ -466,16 +462,15 @@ def generate_page file
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    current          = file
+    target = file
     asset_rel_prefix = rel_prefix + @asset_rel_path
 
     @title = "#{file.page_name} - #{@options.title}"
 
     debug_msg "  rendering #{out_file}"
     render_template template_file, out_file do |io|
       here = binding
-      # suppress 1.9.3 warning
-      here.local_variable_set(:current, current)
+      here.local_variable_set(:target, target)
       here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
       here
     end
@@ -500,7 +495,6 @@ def generate_servlet_not_found message
 
     render_template template_file do |io|
       here = binding
-      # suppress 1.9.3 warning
       here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
       here
     end
@@ -557,7 +551,6 @@ def generate_table_of_contents
 
     render_template template_file, out_file do |io|
       here = binding
-      # suppress 1.9.3 warning
       here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
       here
     end
@@ -738,15 +731,15 @@ def excerpt(comment)
     extracted_text[0...150].gsub(/\n/, " ").squeeze(" ")
   end
 
-  def generate_table_from_the_current_object(current)
-    return '' if current.nil?
+  def generate_table_from_target(target)
+    return '' if target.nil?
     comment =
-      if current.respond_to? :comment_location then
-        current.comment_location
+      if target.respond_to? :comment_location then
+        target.comment_location
       else
-        current.comment
+        target.comment
       end
-    current.parse(comment).table_of_contents.dup
+    target.parse(comment).table_of_contents.dup
   end
 
   def generate_ancestor_list(ancestors, klass)
@@ -813,10 +806,10 @@ def generate_sidebar_link(name, path, rel_prefix)
     %(<a href="#{rel_prefix}/#{path}">#{name}</a>)
   end
 
-  def generate_pages_index_content(page_files, rel_prefix, current)
+  def generate_pages_index_content(page_files, rel_prefix, target)
     return '' if page_files.empty?
 
-    dir = current&.full_name&.[](/\A[^\/]+(?=\/)/) || current&.page_name
+    dir = target&.full_name&.[](/\A[^\/]+(?=\/)/) || target&.page_name
     grouped_files = page_files.group_by { |f| f.full_name[/\A[^\/]+(?=\/)/] || f.page_name }
 
     traverse_tree(grouped_files) do |name, files|

lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml

@@ -2,6 +2,6 @@
 <div id="fileindex-section" class="nav-section">
   <h3>Pages</h3>
 
-  <%= generate_pages_index_content(@page_files, rel_prefix, current) %>
+  <%= generate_pages_index_content(@page_files, rel_prefix, target) %>
 </div>
 <%- end -%>

lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml

@@ -1,10 +1,10 @@
-<%- table = generate_table_from_the_current_object(current) -%>
+<%- table = generate_table_from_target(target) -%>
 <%- if table.length > 1 %>
 <div class="nav-section">
   <h3>Table of Contents</h3>
 
     <%- display_link = proc do |heading| -%>
-      <a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
+      <a href="#<%= heading.label target %>"><%= heading.plain_html %></a>
     <%- end -%>
 
     <%- list_siblings = proc do -%>

lib/rdoc/generator/template/darkfish/index.rhtml

@@ -7,7 +7,7 @@
     <%= render '_sidebar_search.rhtml' %>
   </div>
 
-  <%= render '_sidebar_table_of_contents.rhtml' if defined?(current) %>
+  <%= render '_sidebar_table_of_contents.rhtml' %>
   <%= render '_sidebar_pages.rhtml' %>
   <%= render '_sidebar_classes.rhtml' %>