yardocco 0.0.1 → 0.1.0

data/README.md

@@ -0,0 +1,14 @@
+yardocco
+========
+
+  YARD Templates for docco-style docs. See https://github.com/markiz/murdoc & http://jashkenas.github.com/docco/
+
+    gem install yardocco
+    
+  Add require 'yardocco' to your yard generate code. Something like this:
+  
+    require 'yard'
+    require 'yardocco'
+    YARD::Rake::YardocTask.new
+    
+  murdoc dependency is pygments (http://pygments.org/) for highlight code.

data/Rakefile

@@ -21,7 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.authors = ["Andrew Rudenko"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  gem.add_runtime_dependency 'murdoc', '~> 0.1.6'
   #  gem.add_development_dependency 'rspec', '> 1.2.3'
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/templates/default/module/html/murdoc.erb

@@ -4,7 +4,6 @@
 <div class="murdoc_wrapper">
   <div class="murdoc">
     <% @annotations.each do |a| %>
-    <% need_line, need_method = @definitions.shift %>
       <% a.paragraphs.each do |p| %>
         <% unless p.annotation.empty? %>
           <section><%= htmlify Docstring.new(p.annotation) %></section>
@@ -13,9 +12,12 @@
           <figure>
             <ol>
               <% 1.upto(p.source.split("\n").size) do |i| %>
-                <li<% if i + p.starting_line == need_line %> 
-                  id="<%= anchor_for(need_method) %>"
-                  <% need_line, need_method = @definitions.shift; end %>> <%= i + p.starting_line %> </li>
+                <li> 
+                  <% objects_for_line(i + p.starting_line).each do |o| %>
+                    <a id="<%= anchor_for(o) %>"></a>
+                  <% end %>
+                  <%= i + p.starting_line %> 
+                </li>
               <% end %>
             </ol>
             <code><%= p.formatted_source %></code>

data/templates/default/module/setup.rb

@@ -18,4 +18,12 @@ def murdoc
   end
     
   erb(:murdoc)
+end
+
+def objects_for_line(line)
+  res = []
+  while @definitions.first && @definitions.first[0] == line
+    res << @definitions.shift[1]
+  end
+  res
 end

data/yardocco.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yardocco}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Rudenko"]
+  s.date = %q{2011-01-25}
+  s.description = %q{Docco-style YARD template}
+  s.email = %q{ceo@prepor.ru}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/yardocco.rb",
+    "templates/default/module/html/murdoc.erb",
+    "templates/default/module/html/style.css",
+    "templates/default/module/setup.rb",
+    "yardocco.gemspec"
+  ]
+  s.homepage = %q{http://github.com/prepor/yardocco}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Docco-style YARD template}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<murdoc>, ["~> 0.1.6"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<murdoc>, ["~> 0.1.6"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<murdoc>, ["~> 0.1.6"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yardocco
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Andrew Rudenko
@@ -50,6 +50,22 @@ dependencies:
         - 2
         version: 1.5.2
   requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: murdoc
+  type: :runtime
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 1
+        - 6
+        version: 0.1.6
+  requirement: *id003
 description: Docco-style YARD template
 email: ceo@prepor.ru
 executables: []
@@ -58,19 +74,20 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/yardocco.rb
 - templates/default/module/html/murdoc.erb
 - templates/default/module/html/style.css
 - templates/default/module/setup.rb
+- yardocco.gemspec
 has_rdoc: true
 homepage: http://github.com/prepor/yardocco
 licenses: 

data/README.rdoc

@@ -1,19 +0,0 @@
-= yardocco
-
-Description goes here.
-
-== Contributing to yardocco
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Andrew Rudenko. See LICENSE.txt for
-further details.
-