yard 0.8.7.6 → 0.9.0

data/lib/yard/server/commands/display_file_command.rb

@@ -5,20 +5,25 @@ module YARD
       #
       # @todo Implement better support for detecting binary (image) filetypes
       class DisplayFileCommand < LibraryCommand
+        attr_accessor :index
+
         def run
           ppath = library.source_path
           filename = File.cleanpath(File.join(library.source_path, path))
           raise NotFoundError if !File.file?(filename)
           if filename =~ /\.(jpe?g|gif|png|bmp)$/i
             headers['Content-Type'] = StaticFileCommand::DefaultMimeTypes[$1.downcase] || 'text/html'
-            render IO.read(filename)
+            render File.read_binary(filename)
           else
             file = CodeObjects::ExtraFileObject.new(filename)
-            options.update(:object => Registry.root, :type => :layout, :file => file)
+            options.update :object => Registry.root,
+                           :type => :layout,
+                           :file => file,
+                           :index => index ? true : false
             render
           end
         end
       end
     end
   end
-end
+end

data/lib/yard/server/commands/display_object_command.rb

@@ -8,9 +8,13 @@ module YARD
         def run
           if path.empty?
             if options.readme
-              url = url_for_file(options.readme)
-              self.status, self.headers, self.body = *router.send(:route, url)
-              cache(body.first)
+              filename = options.readme.filename
+              opts = adapter.options.merge(
+                :index => true, :library => library,
+                :path => filename.sub(%r{^#{library.source_path.to_s}/}, ''))
+              self.status, self.headers, self.body =
+                *DisplayFileCommand.new(opts).call(request)
+              cache(self.body)
               return
             else
               self.path = 'index'

data/lib/yard/server/doc_server_helper.rb

@@ -39,19 +39,13 @@ module YARD
       # Returns the frames URL for the page
       # @return (see Templates::Helpers::HtmlHelper#url_for_frameset)
       def url_for_frameset
-        url = options.file ? url_for_file(options.file) : url_for(object)
-        url = url.gsub(%r{^/#{base_path(router.docs_prefix)}/}, '')
-        File.join('', base_path(router.docs_prefix), "frames", url)
+        options.file ? url_for_file(options.file) : url_for(object)
       end
 
       # Returns the main URL, first checking a readme and then linking to the index
       # @return (see Templates::Helpers::HtmlHelper#url_for_main)
       def url_for_main
-        if options.frames && !options.command.path.empty?
-          File.join('', base_path(router.docs_prefix), options.command.path)
-        else
-          options.readme ? url_for_file(options.readme) : url_for_index
-        end
+        options.readme ? url_for_file(options.readme) : url_for_index
       end
 
       # Returns the URL for the alphabetic index page

data/lib/yard/server/doc_server_serializer.rb

@@ -1,12 +1,10 @@
-require 'webrick/httputils'
+require 'cgi'
 
 module YARD
   module Server
     # A custom {Serializers::Base serializer} which returns resource URLs instead of
     # static relative paths to files on disk.
     class DocServerSerializer < Serializers::FileSystemSerializer
-      include WEBrick::HTTPUtils
-
       def initialize(command = nil)
         super(:basepath => '', :extension => '')
       end
@@ -36,7 +34,7 @@ module YARD
         if name.respond_to?(:force_encoding)
           name = name.dup.force_encoding('binary')
         end
-        escape(name)
+        CGI.escape(name)
       end
     end
   end

data/lib/yard/server/router.rb

@@ -124,7 +124,7 @@ module YARD
         case paths.first
         when "frames"
           paths.shift
-          cmd = FramesCommand
+          cmd = DisplayObjectCommand
         when "file"
           paths.shift
           cmd = DisplayFileCommand

data/lib/yard/server/templates/default/fulldoc/html/css/custom.css

@@ -3,19 +3,68 @@
 #search_results ul { list-style-position: inside; padding-left: 0; list-style: none; }
 #search_results ul li { padding: 7px 15px; font-size: 1.1em; }
 
-#search_frame { z-index: 9999; }
-
 form.search {
-  position: relative;
+  z-index: 8000;
+  position: absolute;
   color: #fff;
-  margin-top: 3px; padding: 7px; border: 1px solid #99f; width: 315px; background: #05a;
-  -moz-border-radius: 4px; -webkit-border-radius: 4px;
-  margin-bottom: 10px;
+  border: 1px solid #99f; width: 210px; background: #05a;
+  border-radius: 4px; border-top-left-radius: 0; border-top-right-radius: 0;
+}
+form.search input {
+  height: 25px;
+  padding: 0;
+  padding-left: 4px;
+  margin: 4px;
+  margin-right: 0;
+  width: 202px;
+  border: 1px solid #99f;
+  border-radius: 3px;
+  font-size: 1.1em;
+  box-sizing: border-box;
+  -webkit-appearance: none;
+}
+
+@media (max-width: 920px) {
+  form.search {
+    position: absolute;
+    color: #fff;
+    width: 100%;
+    margin-top: 0;
+    background: #05a;
+    border-radius: 0;
+    border: 0;
+    margin-bottom: 10px;
+    left: 0;
+    top: 0;
+  }
+  form.search input {
+    margin-top: 9px;
+    margin-bottom: 11px;
+    margin-left: 12px;
+    padding-left: 6px;
+    border: 1px solid #eaf0ff;
+  }
+  #menu { margin-top: 41px; }
+  #search a {
+    border-top-left-radius: 3px; border-top-right-radius: 3px;
+    background: none;
+    border: 0;
+    box-shadow: none;
+    margin-top: 4px;
+    padding-bottom: 5px;
+    color: #eaf0ff; fill: #eaf0ff;
+  }
+  #search a.active {
+    background: #048; border: 0;
+  }
+}
+
+@media (min-width: 920px) {
+  form.search { right: 12px; top: 0; }
 }
-form.search input { margin-left: 5px; width: 250px; border: 1px solid #99f; -moz-border-radius: 3px; font-family: monospace; }
 
 #menu { padding-top: 5px; }
-#content h1 { margin-top: 0; border-top: 0; }
+#content h1 { margin-top: 15px; border-top: 0; }
 
 #content.error { font-size: 1.2em; }
 #content.error p tt { font-size: 1.2em; }

data/lib/yard/server/templates/default/layout/html/breadcrumb.erb

@@ -1,10 +1,10 @@
 <form class="search" method="get" action="/<%= base_path(router.search_prefix) %>">
-  Search: <input name="q" type="search" placeholder="Search" id="search_box" size="30" value="<%= h @query %>" />
+  <input name="q" type="search" placeholder="Search" id="search_box" size="30" value="<%= h @query %>" />
 </form>
 <script type="text/javascript" charset="utf-8">
   $(function() {
     $('#search_box').autocomplete($('#search_box').parent().attr('action'), {
-      width: document.body.className == 'frames' ? 250 : 340,
+      width: 200,
       formatItem: function(item) {
         var values = item[0].split(",");
         return values[0] + (values[1] == '' ? "" : " <small>(" + values[1] + ")</small>");
@@ -17,12 +17,6 @@
     });
   });
 </script>
-<style>
-  .frames form.search { position: absolute; right: 14px; top: -6px; padding-top: 10px; }
-  .frames #menu .noframes { float: none; }
-  .frames #menu { float: left; }
-  .frames #content h1 { margin-top: 15px; }
-</style>
 
 <div id="menu">
   <% unless @single_library %>
@@ -40,7 +34,5 @@
     <% if object != '_index.html' %><a href="<%= url_for_index %>">Index</a> &raquo; <% end %>
     <span class='title'><%= @breadcrumb_title %></span>
   <% end %>
-
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
 </div>
 

data/lib/yard/server/templates/default/layout/html/script_setup.erb

@@ -1,8 +1,7 @@
 <script type="text/javascript" charset="utf-8">
-  hasFrames = window.top.frames.main ? true : false;
+  pathId = <%= @path ? @path.inspect : 'null' %>
   relpath = '/';
   docsPrefix = '<%= base_path(router.docs_prefix) %>';
   listPrefix = '<%= base_path(router.list_prefix) %>';
   searchPrefix = '<%= base_path(router.search_prefix) %>';
-  framesUrl = '<%= url_for_frameset %>';
 </script>

data/lib/yard/server/templates/default/method_details/html/permalink.erb

@@ -1,4 +1,4 @@
 <script>
-$("#<%= anchor_for(object) %>").prepend(
-  '<a class="permalink" href="/<%= base_path(router.docs_prefix) %>/<%= serializer.serialized_path(object) %>">permalink</a>');
-</script>
+$(document.getElementById("<%= anchor_for(object) %>")).prepend(
+  '<a class="permalink" href="/<%= base_path(router.docs_prefix) %>/<%= urlencode serializer.serialized_path(object) %>">permalink</a>');
+</script>

data/lib/yard/server/templates/doc_server/processing/html/processing.erb

@@ -1,8 +1,7 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
 <html>
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta charset="utf-8">
     <link rel="stylesheet" href="/css/style.css" type="text/css" media="screen" charset="utf-8" />
     <link rel="stylesheet" href="/css/custom.css" type="text/css" media="screen" charset="utf-8" />
     <script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
@@ -28,7 +27,8 @@
       $(setFade);
     </script>
     <style type="text/css" media="screen">
-      body { overflow: hidden; }
+      body { overflow: hidden; margin: 12px; display: block; }
+      #menu { margin-top: 0 !important; padding-top: 0 !important; }
     </style>
     <title>Processing <%= @library.to_s(false) %></title>
   </head>

data/lib/yard/tags/directives.rb

@@ -479,6 +479,7 @@ module YARD
             writer.source = object.source
             writer.group = object.group
             writer.parameters = [['value', nil]]
+            writer.docstring = object.base_docstring
             handler.register_file_info(writer)
           end
           attrs[clean_name][:write] = writer

data/lib/yard/tags/library.rb

@@ -231,7 +231,6 @@ module YARD
         meth = meth.to_s
         send_name = "parse_tag" + (meth.empty? ? "" : "_" + meth)
         if @factory.respond_to?(send_name)
-          arity = @factory.method(send_name).arity
           @factory.send(send_name, tag_name, text)
         else
           raise NoMethodError, "Factory #{@factory.class_name} does not implement factory method :#{meth}."
@@ -405,6 +404,8 @@ module YARD
       # Note that a +@param+ tag need not be defined for the options
       # hash itself, though it is useful to do so for completeness.
       #
+      # @note For keyword parameters, use +@param+, not +@option+.
+      #
       # @example
       #   # @param [Hash] opts the options to create a message with.
       #   # @option opts [String] :subject The subject
@@ -424,22 +425,23 @@ module YARD
       # @example
       #   # @overload set(key, value)
       #   #   Sets a value on key
-      #   #   @param [Symbol] key describe key param
-      #   #   @param [Object] value describe value param
+      #   #   @param key [Symbol] describe key param
+      #   #   @param value [Object] describe value param
       #   # @overload set(value)
       #   #   Sets a value on the default key +:foo+
-      #   #   @param [Object] value describe value param
+      #   #   @param value [Object] describe value param
       #   def set(*args) end
       # @yard.signature method_signature(parameters)
       #   Indented docstring for overload method
       define_tag "Overloads",          :overload,    OverloadTag
 
-      # Documents a single method parameter with a given name, type
+      # Documents a single method parameter (either regular or keyword) with a given name, type
       # and optional description.
       #
       # @example
-      #   # @param [String] the URL of the page to download
-      #   def load_page(url) end
+      #   # @param url [String] the URL of the page to download
+      #   # @param directory [String] the name of the directory to save to
+      #   def load_page(url, directory: 'pages') end
       define_tag "Parameters",         :param,       :with_types_and_name
 
       # Declares that the _logical_ visibility of an object is private.

data/lib/yard/tags/overload_tag.rb

@@ -56,7 +56,10 @@ module YARD
           # FIXME refactor this code to not make use of the Handlers::Base class (tokval_list should be moved)
           toks = YARD::Parser::Ruby::Legacy::TokenList.new(args)
           args = YARD::Handlers::Ruby::Legacy::Base.new(nil, nil).send(:tokval_list, toks, :all)
-          args.map! {|a| k, v = *a.split('=', 2); [k.strip.to_s, (v ? v.strip : nil)] } if args
+          args = args.map do |a|
+            k, v = *a.split(/:|=/, 2)
+            [k.strip.to_s + (a[k.size, 1] == ':' ? ':' : ''), (v ? v.strip : nil)]
+          end if args
           @name = meth.to_sym
           @parameters = args
         end

data/lib/yard/templates/helpers/html_helper.rb

@@ -462,7 +462,7 @@ module YARD
         elsif !type.empty?
           type = link ? h(type) : format_types([type], false)
         end
-        type = "(#{type}) " unless type.empty?
+        type = "#{type} " unless type.empty?
         type
       end
 
@@ -479,7 +479,8 @@ module YARD
         meth = convert_method_to_overload(meth)
 
         type = signature_types(meth, link)
-        scope = meth.scope == :class ? "+" : "-"
+        type = "⇒ #{type}" if type && !type.empty?
+        scope = meth.scope == :class ? "." : "#"
         name = full_attr_name ? meth.name : meth.name.to_s.gsub(/^(\w+)=$/, '\1')
         blk = format_block(meth)
         args = !full_attr_name && meth.writer? ? "" : format_args(meth)
@@ -494,7 +495,7 @@ module YARD
           extras << meth.visibility if meth.visibility != :public
           extras_text = ' <span class="extras">(' + extras.join(", ") + ')</span>' unless extras.empty?
         end
-        title = "%s %s<strong>%s</strong>%s %s" % [scope, type, h(name), args, blk]
+        title = "%s<strong>%s</strong>%s %s %s" % [scope, h(name), args, blk, type]
         if link
           if meth.is_a?(YARD::CodeObjects::MethodObject)
             link_title = "#{h meth.name(true)} (#{meth.scope} #{meth.type})"

data/lib/yard/templates/template_options.rb

@@ -59,6 +59,9 @@ module YARD
       # @return [String] the title of a given page
       attr_accessor :page_title
 
+      # @return [Boolean] whether the page is the "index"
+      attr_accessor :index
+
       # @example A list of mixin path names (including wildcards)
       #   opts.embed_mixins #=> ['ClassMethods', '*Helper', 'YARD::*']
       # @return [Array<String>] an array of module name wildcards to embed into

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = '0.8.7.6'
+  VERSION = '0.9.0'
 end

data/spec/cli/command_parser_spec.rb

@@ -1,42 +1,42 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe YARD::CLI::CommandParser do
-  describe '#run' do
+  describe "#run" do
     before do
       @cmd = CLI::CommandParser.new
     end
 
-    it "should show help if --help is provided" do
-      command = mock(:command)
-      command.should_receive(:run).with('--help')
+    it "shows help if --help is provided" do
+      command = double(:command)
+      expect(command).to receive(:run).with('--help')
       CLI::CommandParser.commands[:foo] = command
       @cmd.class.default_command = :foo
       @cmd.run *%w( foo --help )
     end
 
-    it "should use default command if first argument is a switch" do
-      command = mock(:command)
-      command.should_receive(:run).with('--a', 'b', 'c')
+    it "uses default command if first argument is a switch" do
+      command = double(:command)
+      expect(command).to receive(:run).with('--a', 'b', 'c')
       CLI::CommandParser.commands[:foo] = command
       @cmd.class.default_command = :foo
       @cmd.run *%w( --a b c )
     end
 
-    it "should use default command if no arguments are provided" do
-      command = mock(:command)
-      command.should_receive(:run)
+    it "uses default command if no arguments are provided" do
+      command = double(:command)
+      expect(command).to receive(:run)
       CLI::CommandParser.commands[:foo] = command
       @cmd.class.default_command = :foo
       @cmd.run
     end
 
-    it "should list commands if command is not found" do
-      @cmd.should_receive(:list_commands)
+    it "lists commands if command is not found" do
+      expect(@cmd).to receive(:list_commands)
       @cmd.run *%w( unknown_command --args )
     end
 
-    it "should list commands if --help is provided as sole argument" do
-      @cmd.should_receive(:list_commands)
+    it "lists commands if --help is provided as sole argument" do
+      expect(@cmd).to receive(:list_commands)
       @cmd.run *%w( --help )
     end
   end

data/spec/cli/command_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + "/../spec_helper"
 require 'optparse'
 
 describe YARD::CLI::Command do
-  describe '#parse_options' do
+  describe "#parse_options" do
     before do
       @options = OptionParser.new
       @saw_foo = false
@@ -14,23 +14,23 @@ describe YARD::CLI::Command do
       args
     end
 
-    it "should skip unrecognized options but continue to next option" do
-      log.should_receive(:warn).with(/Unrecognized.*--list/)
-      log.should_receive(:warn).with(/Unrecognized.*--list2/)
+    it "skips unrecognized options but continue to next option" do
+      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
+      expect(log).to receive(:warn).with(/Unrecognized.*--list2/)
       parse('--list', '--list2', '--foo')
-      @saw_foo.should be_true
+      expect(@saw_foo).to be true
     end
 
-    it "should skip unrecognized options and any extra non-option arg that follows" do
-      log.should_receive(:warn).with(/Unrecognized.*--list/)
+    it "skips unrecognized options and any extra non-option arg that follows" do
+      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
       parse('--list', 'foo', '--foo')
-      @saw_foo.should be_true
+      expect(@saw_foo).to be true
     end
 
-    it "should stop retrying to parse at non-switch argument" do
-      log.should_receive(:warn).with(/Unrecognized.*--list/)
+    it "stops retrying to parse at non-switch argument" do
+      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
       args = parse('--list', 'foo', 'foo', 'foo')
-      args.should == %w(foo foo)
+      expect(args).to eq %w(foo foo)
     end
   end
 end