yard-docco 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.0.2 / 2013-01-02
+
+- Compat with YARD 0.8.3
+
 === 1.0.1 / 2011-08-01
 
 - FIX an issue with some inline comments not appearing

data/Rakefile

@@ -8,6 +8,6 @@ task :clean do
 end
 
 task :gendoc => :clean do
-  `yardoc -e ./lib/yard-docco.rb 'example/**/*' --debug`
+  puts `yardoc -e ./lib/yard-docco.rb 'example/**/*' --debug`
   #`open doc/index.html`
 end

data/lib/yard-docco.rb

@@ -1,5 +1,5 @@
 module DoccoInTheYARD
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end
 
 YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../templates'

data/templates/default/fulldoc/html/js/docco.js

@@ -1,13 +1,18 @@
 function createAnnotatedSourceLinks() {
-    $('.method_details_list .annotated_source_code').
-        before("<span class='showSource'>[<a href='#' class='annotatedToggleSource'>View annotated source</a>]</span>");
+    $('.method_details_list .annotated_source_code').each(function(index,element) {
+
+      var spanToggleAnnotatedSource = "<span class='showSource'>[<a href='#' class='annotatedToggleSource'>View Annotated source</a>]</span>";
+
+      $(element).before(spanToggleAnnotatedSource);
+    });
+
     $('.annotatedToggleSource').toggle(function() {
        $(this).parent().next().slideDown(100);
-       $(this).text("Hide annotated source");
+       $(this).text("Hide Annotated source");
     },
     function() {
         $(this).parent().next().slideUp(100);
-        $(this).text("View annotated source");
+        $(this).text("View Annotated source");
     });
 }
 

data/templates/default/fulldoc/html/setup.rb

@@ -1,7 +1,7 @@
 def init
   super
-  
+
   asset("js/docco.js",file("js/docco.js",true))
   asset("css/docco.css",file("css/docco.css",true))
-  
+
 end

data/templates/default/method_details/html/setup.rb

@@ -1,32 +1,29 @@
 def init
   super
-  
-  # Added the annotated source template to the end of the sections to be rendered.
-  sections.push(:annotated_source)
-  
-  # object contains the method details that are about to be processed. 
-  # 
+
+  # object contains the method details that are about to be processed.
+  #
   # object.source contains all the source within the method that we can use
   # to generate the inline documentation. We should allow for the normal sour
-  # 
-  # Source with annotations would simply look at the source and each line with 
+  #
+  # Source with annotations would simply look at the source and each line with
   # a comment would be lumped together with comments.
   object.annotated_source = annotate_source(object.source)
-  
+
 end
 
 #
 # The comments within a method are just strings and have not been converted into
 # Docstrings. Here we hijack the method object and send it to the docstring
 # template to be rendered with the new docstring.
-# 
+#
 # @param [String] comments that should be converted into a docstring and then
 #   rendered with the docstring template.
 # @return [String] the rendered results of the docstring
 def docstring_comment(comments)
   method_object = object.dup
   object.docstring = Docstring.new(comments,object)
-  
+
   result = T('docstring').run(options)
   object = method_object
   result
@@ -36,94 +33,94 @@ end
 # This method will find the comments and then the source code (non-comments) and
 # generate an array of comment-code pairs which should be displayed next to each
 # other.
-# 
+#
 # @param [String] source that will be scanned and annotated
-# 
+#
 # @return [Array<Array<String,String>>] an array of arrays. Each element contains
 #   in the first element the comments, the second contains the source code.
 def annotate_source(source)
-  
+
   annotated = []
   current_comment = nil
   current_code = nil
   finished_comment = nil
-  
+
   # Move through the source code line by line.
   # When we come to a comment line (starts with #) then we add a source
   # When we come to a non-comment line we are done builing that comment
   #   we would then start to build the source up line by line
   source.split("\n").each do |line|
-    
+
     if line =~ /^\s*#.*$/
-      
+
       # When parsing a comment
-      # 
+      #
       # If we are parsing the first comment then we need to look to see if there
       # was some code that we were parsing and finish that code. Then we need to
       # add the comment to a new array of comments
-      # 
+      #
       # If this is another comment, after the first one then we need to add it
       # to the list of comments.
       if current_comment
         current_comment << line[/^\s*#\s?(.+)/,1].to_s
       else
-        
+
         if current_code
           annotated << [ finished_comment, current_code ]
           finished_comment = current_code = nil
-          
+
         end
-      
+
         (current_comment ||=[]) << line[/^\s*#\s?(.+)/,1].to_s
       end
-      
+
     else
 
       # When parsing a line of code
-      # 
+      #
       # If we are parsing the first line of code then if there are any comments
       # then we are done with the comments that are associated with this line of
       # code (and any lines that follow). We want to save the finished block of
       # comments so that we can put it together with the code when we are finished
       # with it.
-      # 
+      #
       if current_comment
         finished_comment = current_comment
         current_comment = nil
       else
         # We were not working on a comment
       end
-      
+
       # Add the current code line to the current_code if one exists (create one if it does not exist)
       (current_code ||= []) << line.to_s
-      
+
     end
-    
+
   end
-  
+
   # If we have finished parsing lines and we still have code within a home, which
   # is likely if the the source code ends with an end. We want to create a new pair
   if current_code
     annotated << [ finished_comment, current_code ]
     current_code = nil
   end
-  
+
   # If we have a comment that still remains, then the comment exists without
   # source and we should add it the pairs.
   if current_comment
     annotated << [ current_comment, "" ]
     current_comment = nil
   end
-  
+
   return annotated
 end
 
 def show_annotated_lines(section)
   @current_count ||= object.line
-  
+
   # Add the comment line length to the line number
   @current_count += Array(section.first).length
-  
+
   lines = (@current_count..(@current_count+Array(section.last).length)).to_a.join("\n")
   @current_count += Array(section.last).length
   lines

data/yard-docco.gemspec

@@ -52,7 +52,7 @@ Gem::Specification.new do |s|
 
 }
 
-  s.add_dependency 'yard', '>= 0.7.0'
+  s.add_dependency 'yard', '~> 0.8.3'
   
   s.rubygems_version   = "1.3.7"
   s.files            = `git ls-files`.split("\n")

metadata

@@ -1,39 +1,42 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: yard-docco
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.2
   prerelease: 
-  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Franklin Webber
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-01 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.7.0
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
   type: :runtime
-  version_requirements: *id001
-description: " \n    YARD-Docco is a YARD extension that provides an additional source view that\n    will show comments alongside the source code within a method.  "
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+description: ! " \n    YARD-Docco is a YARD extension that provides an additional
+  source view that\n    will show comments alongside the source code within a method.
+  \ "
 email: franklin.webber@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - History.txt
-files: 
+files:
 - History.txt
 - README.md
 - Rakefile
@@ -42,40 +45,37 @@ files:
 - templates/default/fulldoc/html/css/docco.css
 - templates/default/fulldoc/html/js/docco.js
 - templates/default/fulldoc/html/setup.rb
-- templates/default/layout/html/setup.rb
 - templates/default/method_details/html/annotated_source.erb
 - templates/default/method_details/html/setup.rb
 - templates/default/method_details/html/source.erb
 - yard-docco.gemspec
-has_rdoc: true
 homepage: http://github.com/burtlo/yard-docco
 licenses: []
-
-post_install_message: "\n\
-  (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==)\n\n  Thank you for installing yard-docco 1.0.1 / 2011-08-01.\n  \n  Changes:\n    \n  - FIX an issue with some inline comments not appearing\n  \n\n\
-  (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==)\n\n"
-rdoc_options: 
+post_install_message: ! "\n(==) (==) (==) (==) (==) (==) (==) (==) (==) (==) (==)
+  (==) (==) (==) (==)\n\n  Thank you for installing yard-docco 1.0.2 / 2013-01-02.\n
+  \ \n  Changes:\n    \n  - Compat with YARD 0.8.3\n  \n\n(==) (==) (==) (==) (==)
+  (==) (==) (==) (==) (==) (==) (==) (==) (==) (==)\n\n"
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Docco style documentation within methods
 test_files: []
-
+has_rdoc: 

data/templates/default/layout/html/setup.rb

@@ -1,17 +0,0 @@
-def init
-  super
-end
-
-#
-# Append yard-docco stylesheet to yard core stylesheets
-# 
-def stylesheets
-  super + %w(css/docco.css)
-end
-
-#
-# Append yard-docco javascript to yard core javascripts
-# 
-def javascripts
-  super + %w(js/docco.js)
-end