yard 0.5.8 → 0.6.0

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

@@ -6,6 +6,7 @@ def init
   options[:readme] = options[:files].first
   options[:title] ||= "Documentation by YARD #{YARD::VERSION}"
   
+  return serialize_onefile if options[:onefile]
   generate_assets
   serialize('_index.html')
   options[:files].each_with_index do |file, i| 
@@ -34,6 +35,14 @@ def serialize(object)
   end
 end
 
+def serialize_onefile
+  options[:css_data] = file('css/style.css', true) + "\n" + file('css/common.css', true)
+  options[:js_data] = file('js/jquery.js', true) + file('js/app.js', true)
+  Templates::Engine.with_serializer('index.html', options[:serializer]) do
+    T('onefile').run(options)
+  end
+end
+
 def serialize_index(options)
   Templates::Engine.with_serializer('index.html', options[:serializer]) do
     T('layout').run(options)

data/templates/default/layout/html/footer.erb

@@ -1,5 +1,5 @@
 <div id="footer">
   Generated on <%= Time.now.strftime("%c") %> by 
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
 </div>

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

@@ -1,7 +1,9 @@
 def init
   @breadcrumb = []
 
-  if @file
+  if @onefile
+    sections :layout
+  elsif @file
     @contents = File.read(@file)
     @file = File.basename(@file)
     @fname = @file.gsub(/\.[^.]+$/, '')
@@ -37,33 +39,13 @@ end
 
 def index
   @objects_by_letter = {}
-  objects = @objects.reject {|o| o.root? }.sort_by {|o| o.name.to_s }
+  objects = Registry.all(:class, :module).sort_by {|o| o.name.to_s }
+  objects = run_verifier(objects)
   objects.each {|o| (@objects_by_letter[o.name.to_s[0,1].upcase] ||= []) << o }
   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>"
+  data = htmlify(markup_file_contents(@contents), markup_for_file(@contents, @file))
+  "<div id='filecontents'>" + data + "</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/default/method_details/html/source.erb

@@ -4,7 +4,7 @@
       <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, object.source_type %></pre>
+      <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/module/html/attribute_summary.erb

@@ -1,5 +1,5 @@
-<% scopes(attr_listing) do |list, scope| %>
-  <h2><%= scope.to_s.capitalize %> Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+<% groups(attr_listing, "Attribute") do |list, name| %>
+  <h2><%= name %> <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
   <ul class="summary">
     <% list.each do |meth| %>
       <%= yieldall :item => meth %>

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

@@ -1,7 +1,7 @@
 <% if method_listing.size > 0 %>
-  <% scopes(method_listing) do |list, scope| %>
+  <% groups(method_listing) do |list, name| %>
     <h2>
-      <%= scope.to_s.capitalize %> Method Summary
+      <%= name %>
       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
     </h2>
 

data/templates/default/module/setup.rb

@@ -88,6 +88,29 @@ def docstring_summary(obj)
   docstring_full(obj).summary
 end
 
+def groups(list, type = "Method")
+  if groups_data = object.groups
+    others = list.select {|m| !m.group }
+    groups_data.each do |name|
+      items = list.select {|m| m.group == name }
+      yield(items, name) unless items.empty?
+    end
+  else
+    others = []
+    group_data = {}
+    list.each do |meth|
+      if meth.group
+        (group_data[meth.group] ||= []) << meth
+      else
+        others << meth
+      end
+    end
+    group_data.each {|group, items| yield(items, group) unless items.empty? }
+  end
+  
+  scopes(others) {|items, scope| yield(items, "#{scope.to_s.capitalize} #{type} Summary") }
+end
+
 def scopes(list)
   [:class, :instance].each do |scope|
     items = list.select {|m| m.scope == scope }
@@ -96,11 +119,11 @@ def scopes(list)
 end
 
 def mixed_into(object)
-  unless defined?(@@mixed_into) && @@mixed_into
-    @@mixed_into = {}
+  unless globals.mixed_into
+    globals.mixed_into = {}
     list = run_verifier Registry.all(:class, :module)
-    list.each {|o| o.mixins.each {|m| (@@mixed_into[m.path] ||= []) << o } }
+    list.each {|o| o.mixins.each {|m| (globals.mixed_into[m.path] ||= []) << o } }
   end
   
-  @@mixed_into[object.path] || []
+  globals.mixed_into[object.path] || []
 end

data/templates/default/onefile/html/files.erb

@@ -0,0 +1,5 @@
+<% @files.each do |file| %>
+  <% @file, @contents = file, read_file(file) %>
+  <h2><%= file %></h2>
+  <%= diskfile %>
+<% end %>

data/templates/default/onefile/html/layout.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=<%= charset %>" />
+    <title><%= @title %></title>
+    <style type="text/css" media="screen">
+      <%= @css_data %>
+    </style>
+    <script type="text/javascript" charset="utf-8">
+      <%= @js_data %>
+    </script>
+  </head>
+  <body>
+    <div id="content">
+      <h1><%= @title %></h1>
+      <%= yieldall %>
+    </div>
+    
+    <%= erb(:footer) %>
+  </body>
+</html>

data/templates/default/onefile/html/readme.erb

@@ -0,0 +1,3 @@
+<div id="readme">
+  <%= htmlify(parse_top_comments_from_file) %>
+</div>

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

@@ -0,0 +1,40 @@
+include T('default/layout/html')
+include YARD::Parser::Ruby::Legacy
+
+def init
+  override_serializer  
+  @object = YARD::Registry.root
+  @files.shift
+  @objects.delete(YARD::Registry.root)
+  @objects.unshift(YARD::Registry.root)
+  sections :layout, [:readme, :files, :all_objects]
+end
+
+def all_objects
+  @objects.map {|obj| obj.format(options) }.join("\n")
+end
+
+private
+
+def read_file(file)
+  File.read(file).force_encoding(charset)
+end
+
+def parse_top_comments_from_file
+  data = ""
+  tokens = TokenList.new(read_file(@readme))
+  tokens.each do |token|
+    break unless token.is_a?(RubyToken::TkCOMMENT) || token.is_a?(RubyToken::TkNL)
+    data << (token.text[/\A#\s{0,1}(.*)/, 1] || "\n")
+  end
+  YARD::Docstring.new(data)
+end
+
+def override_serializer
+  class << @serializer
+    def serialized_path(object)
+      return object if object.is_a?(String)
+      return 'index.html'
+    end
+  end
+end

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

@@ -0,0 +1 @@
+include T('default/module/html')

data/templates/default/tags/setup.rb

@@ -1,22 +1,8 @@
 def init
-  sections :index, [:example, :overload, [T('docstring')], :param, :option, :yields, 
-    :yieldparam, :yieldreturn, :return, :raises, :see, :author, :since, :version]
-end
-
-def param
-  tag :param
-end
-
-def yields
-  tag :yield, :no_names => true
-end
-
-def yieldparam
-  tag :yieldparam
-end
-
-def yieldreturn
-  tag :yieldreturn, :no_names => true
+  tags = Tags::Library.visible_tags - [:abstract, :deprecated, :note, :todo]
+  create_tag_methods(tags - [:example, :option, :overload, :see])
+  sections :index, tags
+  sections.any(:overload).push(T('docstring'))
 end
 
 def return
@@ -27,21 +13,7 @@ def return
   tag :return, :no_names => true
 end
 
-def raises
-  tag :raise, :no_names => true
-end
-
-def author
-  tag :author, :no_types => true, :no_names => true
-end
-
-def since
-  tag :since, :no_types => true, :no_names => true
-end
-
-def version
-  tag :version, :no_types => true, :no_names => true
-end
+private
 
 def tag(name, opts = {})
   return unless object.has_tag?(name)
@@ -52,3 +24,24 @@ def tag(name, opts = {})
   @no_names, @no_types = nil, nil
   out
 end
+
+def create_tag_methods(tags)
+  tags.each do |tag|
+    next if respond_to?(tag)
+    instance_eval(<<-eof, __FILE__, __LINE__ + 1)
+      def #{tag}
+        opts = {:no_types => true, :no_names => true}
+        case Tags::Library.factory_method_for(#{tag.inspect})
+        when :with_types
+          opts[:no_types] = false
+        when :with_types_and_name
+          opts[:no_types] = false
+          opts[:no_names] = false
+        when :with_name
+          opts[:no_names] = false
+        end
+        tag #{tag.inspect}, opts
+      end
+    eof
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: yard
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 8
-  version: 0.5.8
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Loren Segal
@@ -15,16 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-22 00:00:00 -04:00
+date: 2010-08-29 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
 description: "    YARD is a documentation generation tool for the Ruby programming language.\n    It enables the user to generate consistent, usable documentation that can be\n    exported to a number of formats very easily, and also supports extending for\n    custom Ruby constructs such as custom class level definitions.\n"
 email: lsegal@soen.ca
 executables: 
+- yard
 - yardoc
 - yri
-- yard-graph
 extensions: []
 
 extra_rdoc_files: []
@@ -44,13 +43,21 @@ files:
 - docs/Tags.md
 - docs/Templates.md
 - docs/WhatsNew.md
+- bin/yard
 - bin/yard-graph
+- bin/yard-server
 - bin/yardoc
 - bin/yri
 - lib/rubygems_plugin.rb
 - lib/yard/autoload.rb
-- lib/yard/cli/base.rb
-- lib/yard/cli/yard_graph.rb
+- lib/yard/cli/command.rb
+- lib/yard/cli/command_parser.rb
+- lib/yard/cli/diff.rb
+- lib/yard/cli/gems.rb
+- lib/yard/cli/graph.rb
+- lib/yard/cli/help.rb
+- lib/yard/cli/server.rb
+- lib/yard/cli/stats.rb
 - lib/yard/cli/yardoc.rb
 - lib/yard/cli/yri.rb
 - lib/yard/code_objects/base.rb
@@ -66,6 +73,7 @@ files:
 - lib/yard/core_ext/array.rb
 - lib/yard/core_ext/file.rb
 - lib/yard/core_ext/hash.rb
+- lib/yard/core_ext/insertion.rb
 - lib/yard/core_ext/module.rb
 - lib/yard/core_ext/string.rb
 - lib/yard/core_ext/symbol_hash.rb
@@ -124,6 +132,42 @@ files:
 - lib/yard/serializers/process_serializer.rb
 - lib/yard/serializers/stdout_serializer.rb
 - lib/yard/serializers/yardoc_serializer.rb
+- lib/yard/server/adapter.rb
+- lib/yard/server/commands/base.rb
+- lib/yard/server/commands/display_file_command.rb
+- lib/yard/server/commands/display_object_command.rb
+- lib/yard/server/commands/frames_command.rb
+- lib/yard/server/commands/library_command.rb
+- lib/yard/server/commands/library_index_command.rb
+- lib/yard/server/commands/list_command.rb
+- lib/yard/server/commands/search_command.rb
+- lib/yard/server/commands/static_file_command.rb
+- lib/yard/server/doc_server_helper.rb
+- lib/yard/server/doc_server_serializer.rb
+- lib/yard/server/library_version.rb
+- lib/yard/server/rack_adapter.rb
+- lib/yard/server/router.rb
+- lib/yard/server/static_caching.rb
+- lib/yard/server/templates/default/fulldoc/html/css/custom.css
+- lib/yard/server/templates/default/fulldoc/html/images/processing.gif
+- lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js
+- lib/yard/server/templates/default/fulldoc/html/js/live.js
+- lib/yard/server/templates/default/layout/html/breadcrumb.erb
+- lib/yard/server/templates/default/layout/html/headers.erb
+- lib/yard/server/templates/doc_server/frames/html/frames.erb
+- lib/yard/server/templates/doc_server/frames/html/setup.rb
+- lib/yard/server/templates/doc_server/full_list/html/full_list.erb
+- lib/yard/server/templates/doc_server/full_list/html/setup.rb
+- lib/yard/server/templates/doc_server/library_list/html/contents.erb
+- lib/yard/server/templates/doc_server/library_list/html/headers.erb
+- lib/yard/server/templates/doc_server/library_list/html/library_list.erb
+- lib/yard/server/templates/doc_server/library_list/html/setup.rb
+- lib/yard/server/templates/doc_server/library_list/html/title.erb
+- lib/yard/server/templates/doc_server/processing/html/processing.erb
+- lib/yard/server/templates/doc_server/processing/html/setup.rb
+- lib/yard/server/templates/doc_server/search/html/search.erb
+- lib/yard/server/templates/doc_server/search/html/setup.rb
+- lib/yard/server/webrick_adapter.rb
 - lib/yard/tags/default_factory.rb
 - lib/yard/tags/default_tag.rb
 - lib/yard/tags/library.rb
@@ -145,9 +189,15 @@ files:
 - lib/yard/templates/helpers/module_helper.rb
 - lib/yard/templates/helpers/text_helper.rb
 - lib/yard/templates/helpers/uml_helper.rb
+- lib/yard/templates/section.rb
 - lib/yard/templates/template.rb
 - lib/yard/verifier.rb
 - lib/yard.rb
+- spec/cli/command_parser_spec.rb
+- spec/cli/diff_spec.rb
+- spec/cli/help_spec.rb
+- spec/cli/server_spec.rb
+- spec/cli/stats_spec.rb
 - spec/cli/yardoc_spec.rb
 - spec/cli/yri_spec.rb
 - spec/code_objects/base_spec.rb
@@ -162,6 +212,7 @@ files:
 - spec/core_ext/array_spec.rb
 - spec/core_ext/file_spec.rb
 - spec/core_ext/hash_spec.rb
+- spec/core_ext/insertion_spec.rb
 - spec/core_ext/module_spec.rb
 - spec/core_ext/string_spec.rb
 - spec/core_ext/symbol_hash_spec.rb
@@ -227,6 +278,14 @@ files:
 - spec/serializers/file_system_serializer_spec.rb
 - spec/serializers/spec_helper.rb
 - spec/serializers/yardoc_serializer_spec.rb
+- spec/server/adapter_spec.rb
+- spec/server/commands/base_spec.rb
+- spec/server/commands/static_file_command_spec.rb
+- spec/server/doc_server_serializer_spec.rb
+- spec/server/router_spec.rb
+- spec/server/spec_helper.rb
+- spec/server/static_caching_spec.rb
+- spec/server/webrick_servlet_spec.rb
 - spec/spec_helper.rb
 - spec/tags/default_factory_spec.rb
 - spec/tags/default_tag_spec.rb
@@ -234,10 +293,14 @@ files:
 - spec/tags/overload_tag_spec.rb
 - spec/tags/ref_tag_list_spec.rb
 - spec/templates/class_spec.rb
+- spec/templates/constant_spec.rb
 - spec/templates/engine_spec.rb
 - spec/templates/examples/class001.html
 - spec/templates/examples/class001.txt
 - spec/templates/examples/class002.html
+- spec/templates/examples/constant001.txt
+- spec/templates/examples/constant002.txt
+- spec/templates/examples/constant003.txt
 - spec/templates/examples/method001.html
 - spec/templates/examples/method001.txt
 - spec/templates/examples/method002.html
@@ -251,6 +314,7 @@ files:
 - spec/templates/examples/module001.dot
 - spec/templates/examples/module001.html
 - spec/templates/examples/module001.txt
+- spec/templates/examples/module002.html
 - spec/templates/examples/tag001.txt
 - spec/templates/helpers/base_helper_spec.rb
 - spec/templates/helpers/html_helper_spec.rb
@@ -261,6 +325,7 @@ files:
 - spec/templates/helpers/text_helper_spec.rb
 - spec/templates/method_spec.rb
 - spec/templates/module_spec.rb
+- spec/templates/section_spec.rb
 - spec/templates/spec_helper.rb
 - spec/templates/tag_spec.rb
 - spec/templates/template_spec.rb
@@ -274,6 +339,8 @@ files:
 - templates/default/class/setup.rb
 - templates/default/class/text/setup.rb
 - templates/default/class/text/subclasses.erb
+- templates/default/constant/text/header.erb
+- templates/default/constant/text/setup.rb
 - templates/default/docstring/html/abstract.erb
 - templates/default/docstring/html/deprecated.erb
 - templates/default/docstring/html/index.erb
@@ -349,8 +416,13 @@ files:
 - templates/default/module/text/includes.erb
 - templates/default/module/text/instance_meths_list.erb
 - templates/default/module/text/setup.rb
+- templates/default/onefile/html/files.erb
+- templates/default/onefile/html/layout.erb
+- templates/default/onefile/html/readme.erb
+- templates/default/onefile/html/setup.rb
 - templates/default/root/dot/child.erb
 - templates/default/root/dot/setup.rb
+- templates/default/root/html/setup.rb
 - templates/default/tags/html/example.erb
 - templates/default/tags/html/index.erb
 - templates/default/tags/html/option.erb
@@ -399,7 +471,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -408,7 +479,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"