yard-web-plugin 0.1.2

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

@@ -0,0 +1,5 @@
+<div id="search">
+  <!-- <a id="topic_list_link" href="#">Topic List</a> -->
+  <a id="resource_list_link" href="#">Resource List</a>
+  <a id="file_list_link" href="#">File List</a>
+</div>

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

@@ -0,0 +1,69 @@
+include Helpers::FilterHelper
+
+def init
+  @breadcrumb = []
+
+  @page_title = options[:title]
+
+  if @file
+    @contents = File.read_binary(@file)
+    @file = File.basename(@file)
+    sections :layout, [:diskfile]
+  elsif object
+    case object
+    when '_index.html'
+      sections :layout, [:index, [T('class')]]
+    when CodeObjects::Base
+      type = object.root? ? :module : object.type
+      sections :layout, [T(type)]
+    end
+  else
+    sections :layout, [:contents]
+  end
+end
+
+def contents
+  @contents
+end
+
+def index
+
+  legitimate_objects = index_objects(@objects).reject {|o| o.root? }
+  @topics = {}
+
+  legitimate_objects.each do |object|
+    object.tags('topic').each { |topic| (@topics[topic.text] ||= []) << object }
+  end
+
+  @resources = legitimate_objects.sort_by {|o| o.tags('url').first.text }
+
+  @overall_objects = @objects.find_all {|o| o.has_tag?('overall')}.sort_by {|o| o.tag('overall').text}
+
+  erb(:index)
+end
+
+def diskfile
+  "<div id='filecontents'>" +
+  case (File.extname(@file)[1..-1] || '').downcase
+  when 'htm', 'html'
+    @contents
+  when 'txt'
+    "<pre>#{@contents}</pre>"
+  when 'textile', 'txtile'
+    htmlify(@contents, :textile)
+  when 'markdown', 'md', 'mdown', 'mkd'
+    htmlify(@contents, :markdown)
+  else
+    htmlify(@contents, diskfile_shebang_or_default)
+  end +
+  "</div>"
+end
+
+def diskfile_shebang_or_default
+  if @contents =~ /\A#!(\S+)\s*$/ # Shebang support
+    @contents = $'
+    $1.to_sym
+  else
+    options[:markup]
+  end
+end

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

@@ -0,0 +1,3 @@
+<div class="method_details <%= @index == 0 ? 'first' : '' %>">
+  <%= yieldall %>
+</div>

data/templates/rest/method_details/html/method_signature.erb

@@ -0,0 +1,28 @@
+<ul class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
+  <li>
+  <% if object.tags(:overload).size == 1 %>
+    <%= signature(object.tag(:overload), false) %>
+  <% elsif object.tags(:overload).size > 1 %>
+    <% object.tags(:overload).each do |overload| %>
+      <span class="overload"><%= signature(overload, false) %></span>
+    <% end %>
+  <% else %>
+    <%= signature(object, false) %>
+  <% end %>
+
+  <% if object.aliases.size > 0 %>
+    <span class="aliases">Also known as:
+    <span class="names"><%= object.aliases.map {|o| 
+      "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
+    </span>
+  <% end %>
+  </li>
+</ul>
+<% if object.tags(:url).size > 0 %>
+<h3>Url:</h3>
+<ul id="<%= anchor_for(object) %>">  
+  <% object.tags(:url).each do |url| %>
+  <li><%= url.text %></li>
+  <% end %>
+</ul>
+<% end %>

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

@@ -0,0 +1,7 @@
+def init
+  sections :header, [:method_signature, T('docstring')]
+end
+
+def header
+  erb(:header)
+end

data/templates/rest/module/setup.rb

@@ -0,0 +1,4 @@
+def init
+  
+end
+

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

@@ -0,0 +1,9 @@
+<% if object.has_tag?(:example_request) %>
+  <div class="examples">
+    <h3>Example Request:</h3>
+    <% object.tags(:example_request).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/example_response.erb

@@ -0,0 +1,9 @@
+<% if object.has_tag?(:example_response) %>
+  <div class="examples">
+    <h3>Example Response:</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,41 @@
+def init
+  super
+  sections :index, [:argument,
+                    :example_request,
+                    :request_field,
+                    :example_response,
+                    :response_field,
+                    :header,
+                    :response_code]
+end
+
+def request_field
+  generic_tag :request_field
+end
+
+def response_field
+  generic_tag :response_field
+end
+
+def argument
+  generic_tag :argument, :no_types => false
+end
+
+def header
+  generic_tag :header
+end
+
+def response_code
+  generic_tag :response_code
+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
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: yard-web-plugin
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Alexey Ilyichev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-15 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id001
+description: See yard-rest-plugin for more detail
+email: alexey.ilyichev@qik.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/yard-web-plugin.rb
+- lib/yard-web-plugin/base_helper.rb
+- templates/rest/class/html/header.erb
+- templates/rest/class/html/method_details_list.erb
+- templates/rest/class/html/setup.rb
+- templates/rest/disqus/html/disqus.erb
+- templates/rest/disqus/setup.rb
+- templates/rest/docstring/html/setup.rb
+- templates/rest/docstring/html/text.erb
+- 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_resource.erb
+- templates/rest/fulldoc/html/full_list_topic.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/setup.rb
+- templates/rest/tags/html/example_request.erb
+- 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
+has_rdoc: true
+homepage: http://github.com/alexz77/yard-web-plugin
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This is a fork of yard-rest-plugin
+test_files: []
+