yard-rest-plugin 0.1.4 → 0.1.5

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/lib/yard-rest-plugin/base_helper.rb

@@ -1,18 +1,33 @@
+require 'pp'
+
 module YARD::Templates::Helpers
   module BaseHelper
 
     # Adds additional test that only includes Objects that contain a URL tag
     def run_verifier(list)
+        
       if options[:verifier]
-        list = list.reject {|item| options[:verifier].call(item).is_a?(FalseClass) }
+        list.reject! {|item| options[:verifier].call(item).is_a?(FalseClass) }
       end
 
+	    reject_module(list)
       reject_without_url(list)
+      reject_without_topic(list)
+      
+      list
     end
 
+    def reject_module(list)
+    	list.reject! { |object| [:root, :module].include?(object.type) }
+  	end
+	
     def reject_without_url(list)
-      list.reject {|object| object.tags("url").empty? }
+      list.reject!  { |object| [:class,:method].include?(object.type) and object.tags("url").empty? }
+    end
+
+    def reject_without_topic(list)
+      list.reject!  { |object| [:class].include?(object.type) and object.tags("topic").empty? }
     end
-  
+    
   end
 end

data/lib/yard-rest-plugin.rb

@@ -8,6 +8,7 @@ YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../tem
 
 # Define custom tags
 YARD::Tags::Library.define_tag("URL for Service", :url)
+YARD::Tags::Library.define_tag("Topic for Service", :topic)
 YARD::Tags::Library.define_tag("Arguments", :argument, :with_types_and_name)
 YARD::Tags::Library.define_tag("Example Responses", :example_response)
 YARD::Tags::Library.define_tag("Response Fields", :response_field, :with_name)

data/templates/rest/class/html/header.erb

@@ -0,0 +1,8 @@
+<div class="service">
+  <h1><span class="minor_heading">Resource: </span><%= object.tag("url").text %></h1>
+  <% unless object.tag("topic").nil? %>
+  <!-- fixme: needs style -->
+    <h1><span class="minor_heading">Topic: </span><%= object.tag("topic").text %></h1>
+  <% end %>
+  <%= yieldall %>
+</div>

data/templates/rest/class/html/setup.rb

@@ -1 +1,9 @@
-include T('rest/module/html')
+def init
+  sections :header, [T('docstring'), :method_details_list, [T('method_details')]]
+end
+
+def method_details_list
+  @meths = object.meths(:inherited => false, :included => false) 
+  @meths = run_verifier(@meths)
+  erb(:method_details_list)
+end

data/templates/rest/fulldoc/html/full_list_service.erb

@@ -1,6 +1,8 @@
 <li><a href="<%= url_for('_index.html') %>">/</a></li>
 <% n = 1 %>
 <% @items.sort_by {|s| s.name.to_s }.each do |service| %>
-  <li class="r<%= n %>"><%= linkify(service, service.tags("url").first.text) %></li>
-  <% n = n == 2 ? 1 : 2 %>
+<% unless service.tags("topic").first.nil? %>
+  <li class="r<%= n %>"><%= linkify(service, service.tags("topic").first.text) %></li>
+<% end %>
+<% n = n == 2 ? 1 : 2 %>
 <% end %>

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

@@ -1,7 +1,10 @@
 include Helpers::ModuleHelper
 
+
 def init
+  pp "--1--", options[:objects]
   options[:objects] = objects = run_verifier(options[:objects])
+  pp "--2--", options[:objects]
   options[:files] = ([options[:readme]] + options[:files]).compact.map {|t| t.to_s }
   options[:readme] = options[:files].first
   options[:title] ||= "Documentation by YARD #{YARD::VERSION}"

data/templates/rest/layout/html/index.erb

@@ -13,7 +13,7 @@
   <% end %>
   <div class="clear"></div>
 
-  <h2>Services A-Z</h2>
+  <h2>Topics A-Z</h2>
   <% i = 0 %>
   <table>
     <tr>
@@ -27,9 +27,11 @@
             <li class="letter"><%= letter %></li>
             <ul>
               <% objects.each do |obj| %>
-                <li>
-                  <%= linkify(obj, obj.tags("url").first.text) %> 
-                </li>
+                <% unless obj.tags("topic").first.nil? %>
+                  <li>
+                    <%= linkify(obj, obj.tags("topic").first.text) %> 
+                  </li>
+                <% end %>
               <% end %>
             </ul>
           </ul>
@@ -37,4 +39,5 @@
       </td>
     </tr>
   </table>
+
 </div>

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

@@ -26,8 +26,8 @@ end
 
 def index
   @objects_by_letter = {}
-  objects = @objects.reject {|o| o.root? }.sort_by {|o| o.name.to_s }
-  objects.each {|o| (@objects_by_letter[o.name.to_s[0,1].upcase] ||= []) << o }
+  objects = @objects.reject {|o| o.root? || o.tags('topic').empty? }.sort_by {|o| o.tags('topic').first.text }
+  objects.each {|o| (@objects_by_letter[o.tags('topic').first.text[0,1].upcase] ||= []) << o }
   erb(:index)
 end
 

data/templates/rest/module/setup.rb

@@ -1,9 +1,4 @@
 def init
-  sections :header, [T('docstring'), :method_details_list, [T('method_details')]]
+  
 end
 
-def method_details_list
-  @meths = object.meths(:inherited => false, :included => false) 
-  @meths = run_verifier(@meths)
-  erb(:method_details_list)
-end

data/yard-rest-plugin.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yard-rest-plugin}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aisha Fenton"]
-  s.date = %q{2010-05-14}
+  s.date = %q{2010-07-16}
   s.description = %q{A plugin for Yardoc that produces API documentation for Restful web services. See README.markdown for more details}
   s.email = %q{aisha.fenton@visfleet.com}
   s.extra_rdoc_files = [
@@ -23,7 +23,10 @@ Gem::Specification.new do |s|
      "example/SampleController.rb",
      "lib/yard-rest-plugin.rb",
      "lib/yard-rest-plugin/base_helper.rb",
+     "pkg/yard-rest-plugin-0.1.5.gem",
      "templates/rest/.DS_Store",
+     "templates/rest/class/html/header.erb",
+     "templates/rest/class/html/method_details_list.erb",
      "templates/rest/class/html/setup.rb",
      "templates/rest/docstring/html/setup.rb",
      "templates/rest/docstring/html/text.erb",
@@ -48,8 +51,6 @@ Gem::Specification.new do |s|
      "templates/rest/method_details/html/header.erb",
      "templates/rest/method_details/html/method_signature.erb",
      "templates/rest/method_details/html/setup.rb",
-     "templates/rest/module/html/header.erb",
-     "templates/rest/module/html/method_details_list.erb",
      "templates/rest/module/setup.rb",
      "templates/rest/tags/html/example_response.erb",
      "templates/rest/tags/html/generic_tag.erb",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Aisha Fenton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-14 00:00:00 +12:00
+date: 2010-07-16 00:00:00 +12:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,7 +46,10 @@ files:
 - example/SampleController.rb
 - lib/yard-rest-plugin.rb
 - lib/yard-rest-plugin/base_helper.rb
+- pkg/yard-rest-plugin-0.1.5.gem
 - templates/rest/.DS_Store
+- templates/rest/class/html/header.erb
+- templates/rest/class/html/method_details_list.erb
 - templates/rest/class/html/setup.rb
 - templates/rest/docstring/html/setup.rb
 - templates/rest/docstring/html/text.erb
@@ -71,8 +74,6 @@ files:
 - templates/rest/method_details/html/header.erb
 - templates/rest/method_details/html/method_signature.erb
 - templates/rest/method_details/html/setup.rb
-- templates/rest/module/html/header.erb
-- templates/rest/module/html/method_details_list.erb
 - templates/rest/module/setup.rb
 - templates/rest/tags/html/example_response.erb
 - templates/rest/tags/html/generic_tag.erb

data/templates/rest/module/html/header.erb

@@ -1,4 +0,0 @@
-<div class="service">
-  <h1><span class="minor_heading">Service: </span><%= object.tag("url").text %></h1>
-  <%= yieldall %>
-</div>