yard-mruby 0.2.2 → 0.2.3

data/sample/src/sample.c

@@ -1,34 +1,34 @@
-#include "sample.h"
-
-mrb_value sample_api_method(mrb_state *mrb)
-{
-  return mrb_nil_value();
-}
-
-void sample_deprecated_method( void )
-{
-}
-
-/**
- * A sample Ruby method defined from C
- *
- * @return [String] Hello World!
- */
-mrb_value mrb_Sample_Hello__world(mrb_state *mrb, mrb_value self)
-{
-  return sample_inline_method( mrb_str_new_cstr(mrb, "Hello World!" ) );
-}
-
-void
-mrb_sample_gem_init(mrb_state *mrb)
-{
-  struct RClass *ns = mrb_define_module(mrb, "Sample");
-  struct RClass *cl = mrb_define_class_under(mrb, ns, "Hello", mrb->object_class);
-  mrb_define_method(mrb,cl, "world", mrb_Sample_Hello__world, MRB_ARGS_NONE() );
-}
-
-void
-mrb_sample_gem_final(mrb_state *mrb)
-{
-  // Your C finalization code goes here
-}
+#include "sample.h"
+
+mrb_value sample_api_method(mrb_state *mrb)
+{
+  return mrb_nil_value();
+}
+
+void sample_deprecated_method( void )
+{
+}
+
+/**
+ * A sample Ruby method defined from C
+ *
+ * @return [String] Hello World!
+ */
+mrb_value mrb_Sample_Hello__world(mrb_state *mrb, mrb_value self)
+{
+  return sample_inline_method( mrb_str_new_cstr(mrb, "Hello World!" ) );
+}
+
+void
+mrb_sample_gem_init(mrb_state *mrb)
+{
+  struct RClass *ns = mrb_define_module(mrb, "Sample");
+  struct RClass *cl = mrb_define_class_under(mrb, ns, "Hello", mrb->object_class);
+  mrb_define_method(mrb,cl, "world", mrb_Sample_Hello__world, MRB_ARGS_NONE() );
+}
+
+void
+mrb_sample_gem_final(mrb_state *mrb)
+{
+  // Your C finalization code goes here
+}

data/sample/test/sample_spec.rb

@@ -1,11 +1,11 @@
-describe Sample::Test do
-  it "foos" do
-    expect(subject.foo).to eq "bar"
-  end
-end
-
-describe Sample::Hello do
-  it "salutes" do
-    expect(subject.world).to eq "Hello World!"
-  end
-end
+describe Sample::Test do
+  it "foos" do
+    expect(subject.foo).to eq "bar"
+  end
+end
+
+describe Sample::Hello do
+  it "salutes" do
+    expect(subject.world).to eq "Hello World!"
+  end
+end

data/templates/default/fulldoc/html/full_list_functions.erb

@@ -1,10 +1,10 @@
-<% even_odd = 'odd'  %>
-<% @items.each do |item| %>
-  <li class="<%= even_odd %> <%= item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
-    <div class="item">
-      <%= linkify item, h(item.name(true)) %>
-      <small><%= item.header.title %></small>
-    </div>
-  </li>
-  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
-<% end %>
+<% even_odd = 'odd'  %>
+<% @items.each do |item| %>
+  <li class="<%= even_odd %> <%= item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+    <div class="item">
+      <%= linkify item, h(item.name(true)) %>
+      <small><%= item.header.title %></small>
+    </div>
+  </li>
+  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+<% end %>

data/templates/default/fulldoc/html/full_list_headers.erb

@@ -1,10 +1,10 @@
-<li id="object_" class="odd"><div class="item" style="padding-left:30px"><%= link_object(YARD::MRuby::CodeObjects::HEADERS_ROOT, "All Headers", nil, false) %></div></li>
-<% even_odd = 'odd'  %>
-<% @items.each do |item| %>
-   <li class="<%= even_odd %>">
-    <div class="item">
-      <%= linkify item, h(item.name(true)) %>
-    </div>
-  </li>
-  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
-<% end %>
+<li id="object_" class="odd"><div class="item" style="padding-left:30px"><%= link_object(YARD::MRuby::CodeObjects::HEADERS_ROOT, "All Headers", nil, false) %></div></li>
+<% even_odd = 'odd'  %>
+<% @items.each do |item| %>
+   <li class="<%= even_odd %>">
+    <div class="item">
+      <%= linkify item, h(item.name(true)) %>
+    </div>
+  </li>
+  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+<% end %>

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

@@ -1,62 +1,62 @@
-def init
-  super
-
-   YARD::MRuby::CodeObjects::HEADERS_ROOT.tap do |root|
-
-     # Generates the requirements splash page with the 'include' template
-     serialize root
-
-     root.headers.each do |header|
-       serialize header
-     end
-   end
-
-end
-
-def generate_header_list
-  headers = Registry.all(:header)
-  headers_ordered_by_name = headers.sort {|x,y| x.name.to_s <=> y.name.to_s }
-  generate_full_list headers_ordered_by_name, :headers
-end
-
-def generate_function_list
-  functions = Registry.all(:function)
-  functions_ordered_by_name = functions.sort {|x,y| x.name.to_s <=> y.name.to_s }
-  generate_full_list functions_ordered_by_name, :functions
-end
-
-# Helpler method to generate a full_list page of the specified objects with the
-# specified type.
-def generate_full_list(objects,type,options = {})
-  defaults = { :list_title => "#{type.to_s.capitalize} List",
-    :css_class => "class",
-    :list_filename => "#{type.to_s.gsub(/s$/,'')}_list.html" }
-
-  options = defaults.merge(options)
-
-  @items = objects
-  @list_type = type
-  @list_title = options[:list_title]
-  @list_class = options[:css_class]
-  asset options[:list_filename], erb(:full_list)
-end
-
-#
-# @note This method overrides YARD's default template class_list method.
-#
-# The existing YARD 'Class List' search field contains all the YARD namespace objects.
-# We, however, do not want the Include Namespace YARD Object (which holds the headers)
-# as it is a meta-object.
-#
-# This method removes the namespace from the root node, generates the class list,
-# and then adds it back into the root node.
-#
-def class_list(root = Registry.root)
-  return super unless root == Registry.root
-
-  include_namespace = YARD::MRuby::CodeObjects::HEADERS_ROOT
-  root.instance_eval { children.delete include_namespace }
-  out = super(root)
-  root.instance_eval { children.push include_namespace }
-  out
-end
+def init
+  super
+
+   YARD::MRuby::CodeObjects::HEADERS_ROOT.tap do |root|
+
+     # Generates the requirements splash page with the 'include' template
+     serialize root
+
+     root.headers.each do |header|
+       serialize header
+     end
+   end
+
+end
+
+def generate_header_list
+  headers = Registry.all(:header)
+  headers_ordered_by_name = headers.sort {|x,y| x.name.to_s <=> y.name.to_s }
+  generate_full_list headers_ordered_by_name, :headers
+end
+
+def generate_function_list
+  functions = Registry.all(:function)
+  functions_ordered_by_name = functions.sort {|x,y| x.name.to_s <=> y.name.to_s }
+  generate_full_list functions_ordered_by_name, :functions
+end
+
+# Helpler method to generate a full_list page of the specified objects with the
+# specified type.
+def generate_full_list(objects,type,options = {})
+  defaults = { :list_title => "#{type.to_s.capitalize} List",
+    :css_class => "class",
+    :list_filename => "#{type.to_s.gsub(/s$/,'')}_list.html" }
+
+  options = defaults.merge(options)
+
+  @items = objects
+  @list_type = type
+  @list_title = options[:list_title]
+  @list_class = options[:css_class]
+  asset options[:list_filename], erb(:full_list)
+end
+
+#
+# @note This method overrides YARD's default template class_list method.
+#
+# The existing YARD 'Class List' search field contains all the YARD namespace objects.
+# We, however, do not want the Include Namespace YARD Object (which holds the headers)
+# as it is a meta-object.
+#
+# This method removes the namespace from the root node, generates the class list,
+# and then adds it back into the root node.
+#
+def class_list(root = Registry.root)
+  return super unless root == Registry.root
+
+  include_namespace = YARD::MRuby::CodeObjects::HEADERS_ROOT
+  root.instance_eval { children.delete include_namespace }
+  out = super(root)
+  root.instance_eval { children.push include_namespace }
+  out
+end

data/templates/default/function_details/html/function_signature.erb

@@ -1,10 +1,10 @@
-<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
-  <%= fsignature(object, false) %>
-
-  <% 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 %>
-</h3>
+<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
+  <%= fsignature(object, false) %>
+
+  <% 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 %>
+</h3>

data/templates/default/function_details/html/header.erb

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

data/templates/default/function_details/html/source.erb

@@ -1,10 +1,10 @@
-<table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
-    </td>
-  </tr>
-</table>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
+    </td>
+  </tr>
+</table>

data/templates/default/function_details/setup.rb

@@ -1,12 +1,12 @@
-include YARD::MRuby::Templates::Helpers::HTMLHelper
-
-def init
-  sections :header, [:function_signature, T('docstring'), :source]
-end
-
-def source
-  return if owner != object.namespace
-  return if Tags::OverloadTag === object
-  return if object.source.nil?
-  erb(:source)
-end
+include YARD::MRuby::Templates::Helpers::HTMLHelper
+
+def init
+  sections :header, [:function_signature, T('docstring'), :source]
+end
+
+def source
+  return if owner != object.namespace
+  return if Tags::OverloadTag === object
+  return if object.source.nil?
+  erb(:source)
+end

data/templates/default/header/html/define_summary.erb

@@ -1,11 +1,11 @@
-<% if define_listing.size > 0 %>
-  <h2>Define Summary</h2>
-  <dl class="constants">
-    <% define_listing.each do |define| %>
-      <dt id="<%= anchor_for(define) %>" class="<%= define.has_tag?(:deprecated) ? 'deprecated' : '' %>"><small>#define</small> <%= define.name %>
-        <%= yieldall :object => define %>
-      </dt>
-      <dd><pre class="code"><%#= format_constant define.value %></pre></dd>
-    <% end %>
-  </dl>
-<% end %>
+<% if define_listing.size > 0 %>
+  <h2>Define Summary</h2>
+  <dl class="constants">
+    <% define_listing.each do |define| %>
+      <dt id="<%= anchor_for(define) %>" class="<%= define.has_tag?(:deprecated) ? 'deprecated' : '' %>"><small>#define</small> <%= define.name %>
+        <%= yieldall :object => define %>
+      </dt>
+      <dd><pre class="code"><%#= format_constant define.value %></pre></dd>
+    <% end %>
+  </dl>
+<% end %>

data/templates/default/header/html/function_details_list.erb

@@ -1,7 +1,7 @@
-<div id="functions_details" class="method_details_list">
-  <h2>Function Details</h2>
-
-  <% function_listing.each_with_index do |func, i| %>
-    <%= yieldall :object => func, :owner => object, :index => i %>
-  <% end %>
-</div>
+<div id="functions_details" class="method_details_list">
+  <h2>Function Details</h2>
+
+  <% function_listing.each_with_index do |func, i| %>
+    <%= yieldall :object => func, :owner => object, :index => i %>
+  <% end %>
+</div>

data/templates/default/header/html/function_summary.erb

@@ -1,12 +1,12 @@
-<% if function_listing.size > 0 %>
-  <h2>
-    Function Summary
-    <small><a href="#" class="summary_toggle">collapse</a></small>
-  </h2>
-
-  <ul class="summary">
-    <% function_listing.each do |func| %>
-      <%= yieldall :item => func %>
-    <% end %>
-  </ul>
-<% end %>
+<% if function_listing.size > 0 %>
+  <h2>
+    Function Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+    <% function_listing.each do |func| %>
+      <%= yieldall :item => func %>
+    <% end %>
+  </ul>
+<% end %>

data/templates/default/header/html/functions.erb

@@ -1 +1 @@
-Header functions!
+Header functions!

data/templates/default/header/html/header.erb

@@ -1 +1 @@
-<h1><%= format_object_title(object) %></h1>
+<h1><%= format_object_title(object) %></h1>

data/templates/default/header/html/includes.erb

@@ -1 +1 @@
-<!-- TODO: Included headers -->
+<!-- TODO: Included headers -->

data/templates/default/header/html/item_summary.erb

@@ -1,19 +1,19 @@
-<li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
-  <span class="summary_signature">
-    <%= fsignature(@item, true, false) %>
-
-    <% if @item.aliases.size > 0 %>
-      (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
-    <% end %>
-  </span>
-  <% if @item.visibility != :public %><span class="note title <%= @item.visibility %>"><%= @item.visibility %></span><% end %>
-  <% if @item.has_tag?(:abstract) %><span class="abstract note title">abstract</span><% end %>
-  <% if @item.has_tag?(:deprecated) %><span class="deprecated note title">deprecated</span><% end %>
-  <% if @item.has_tag?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">private</span><% end %>
-
-  <% if @item.has_tag?(:deprecated) %>
-    <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>
-  <% else %>
-    <span class="summary_desc"><%= htmlify_line docstring_summary(@item) %></span>
-  <% end %>
-</li>
+<li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+  <span class="summary_signature">
+    <%= fsignature(@item, true, false) %>
+
+    <% if @item.aliases.size > 0 %>
+      (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
+    <% end %>
+  </span>
+  <% if @item.visibility != :public %><span class="note title <%= @item.visibility %>"><%= @item.visibility %></span><% end %>
+  <% if @item.has_tag?(:abstract) %><span class="abstract note title">abstract</span><% end %>
+  <% if @item.has_tag?(:deprecated) %><span class="deprecated note title">deprecated</span><% end %>
+  <% if @item.has_tag?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">private</span><% end %>
+
+  <% if @item.has_tag?(:deprecated) %>
+    <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>
+  <% else %>
+    <span class="summary_desc"><%= htmlify_line docstring_summary(@item) %></span>
+  <% end %>
+</li>