yard-rest-plugin 0.1.0

data/templates/rest/tags/html/example_response.erb

@@ -0,0 +1,9 @@
+<% if object.has_tag?(:example_response) %>
+  <div class="examples">
+    <h3>Example Respones:</h3>
+    <% object.tags(:example_response).each do |tag| %>
+      <h4><%= htmlify_line(tag.name) %></h4>
+      <pre class="example code"><%= html_syntax_highlight(tag.text, :plain) %></pre>
+    <% end %>
+  </div>
+<% end %>

data/templates/rest/tags/html/generic_tag.erb

@@ -0,0 +1,17 @@
+<h3><%= @label ? @label : YARD::Tags::Library.labels[@name] %>:</h3>
+<ul class="<%= @name %>">
+  <% object.tags(@name).each do |tag| %>
+    <li>
+      <% unless @no_types %>
+        <span class='type'><%= format_types(tag.types) %></span>
+      <% end %>
+      <% unless @no_names %>
+        <span class='name'><%= h tag.name %></span>
+      <% end %>
+      <% if tag.text && !tag.text.empty? %>
+        <% unless (@no_types || tag.types.nil? || tag.types.empty?) && @no_names %>&mdash;<% end %>
+        <%= htmlify_line(tag.text) %>
+      <% end %>
+    </li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,3 @@
+<div class="tags">
+  <%= yieldall %>
+</div>

data/templates/rest/tags/setup.rb

@@ -0,0 +1,22 @@
+def init
+  sections :index, [:argument, :example_response, :response_field]
+end
+
+def response_field
+  generic_tag :response_field
+end
+
+def argument
+  generic_tag :argument, :no_types => false
+end
+
+def generic_tag(name, opts = {})
+  return unless object.has_tag?(name)
+  @no_names = true if opts[:no_names]
+  @no_types = true if opts[:no_types]
+  @name = name
+  out = erb('generic_tag')
+  @no_names, @no_types = nil, nil
+  out
+end
+

data/yard-rest-plugin.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yard-rest-plugin}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aisha Fenton"]
+  s.date = %q{2010-04-26}
+  s.description = %q{A plugin for Yardoc that produces API documentation for Restful web services}
+  s.email = %q{aisha.fenton@visfleet.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "example/README.markdown",
+     "example/SampleController.rb",
+     "lib/yard_rest_plugin.rb",
+     "lib/yard_rest_plugin/base_helper.rb",
+     "templates/rest/.DS_Store",
+     "templates/rest/class/html/setup.rb",
+     "templates/rest/docstring/html/setup.rb",
+     "templates/rest/docstring/html/text.erb",
+     "templates/rest/fulldoc/.DS_Store",
+     "templates/rest/fulldoc/html/.DS_Store",
+     "templates/rest/fulldoc/html/css/common.css",
+     "templates/rest/fulldoc/html/css/full_list.css",
+     "templates/rest/fulldoc/html/css/style.css",
+     "templates/rest/fulldoc/html/full_list.erb",
+     "templates/rest/fulldoc/html/full_list_files.erb",
+     "templates/rest/fulldoc/html/full_list_service.erb",
+     "templates/rest/fulldoc/html/js/app.js",
+     "templates/rest/fulldoc/html/js/full_list.js",
+     "templates/rest/fulldoc/html/js/jquery.js",
+     "templates/rest/fulldoc/html/setup.rb",
+     "templates/rest/layout/html/footer.erb",
+     "templates/rest/layout/html/headers.erb",
+     "templates/rest/layout/html/index.erb",
+     "templates/rest/layout/html/layout.erb",
+     "templates/rest/layout/html/search.erb",
+     "templates/rest/layout/html/setup.rb",
+     "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",
+     "templates/rest/tags/html/index.erb",
+     "templates/rest/tags/setup.rb",
+     "yard-rest-plugin.gemspec"
+  ]
+  s.homepage = %q{http://github.com/visfleet/yard-rest-plugin}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A plugin for Yardoc that produces API documentation for Restful web services}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: yard-rest-plugin
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aisha Fenton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-26 00:00:00 +12:00
+default_executable: 
+dependencies: []
+
+description: A plugin for Yardoc that produces API documentation for Restful web services
+email: aisha.fenton@visfleet.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- example/README.markdown
+- example/SampleController.rb
+- lib/yard_rest_plugin.rb
+- lib/yard_rest_plugin/base_helper.rb
+- templates/rest/.DS_Store
+- templates/rest/class/html/setup.rb
+- templates/rest/docstring/html/setup.rb
+- templates/rest/docstring/html/text.erb
+- templates/rest/fulldoc/.DS_Store
+- templates/rest/fulldoc/html/.DS_Store
+- templates/rest/fulldoc/html/css/common.css
+- templates/rest/fulldoc/html/css/full_list.css
+- templates/rest/fulldoc/html/css/style.css
+- templates/rest/fulldoc/html/full_list.erb
+- templates/rest/fulldoc/html/full_list_files.erb
+- templates/rest/fulldoc/html/full_list_service.erb
+- templates/rest/fulldoc/html/js/app.js
+- templates/rest/fulldoc/html/js/full_list.js
+- templates/rest/fulldoc/html/js/jquery.js
+- templates/rest/fulldoc/html/setup.rb
+- templates/rest/layout/html/footer.erb
+- templates/rest/layout/html/headers.erb
+- templates/rest/layout/html/index.erb
+- templates/rest/layout/html/layout.erb
+- templates/rest/layout/html/search.erb
+- templates/rest/layout/html/setup.rb
+- 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
+- templates/rest/tags/html/index.erb
+- templates/rest/tags/setup.rb
+- yard-rest-plugin.gemspec
+has_rdoc: true
+homepage: http://github.com/visfleet/yard-rest-plugin
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A plugin for Yardoc that produces API documentation for Restful web services
+test_files: []
+