yard 0.8.6 → 0.8.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc6d95eac959d222f86cce2a94f0b06616aa93fa
-  data.tar.gz: de628de21267d778d571fd25ba5aa1665395c5ef
+  metadata.gz: 423812ba8b57f788358b8e8a063406734ffcd8aa
+  data.tar.gz: 3847cd78486e1964b9a6c71bc3a791e82331a763
 SHA512:
-  metadata.gz: f368b1eb2d0664d79ea633671dbd100252e6e10a382b39ae400be373264ef5569816706eff9cbd899d1bcbb09bc44394be36c7d642c751a156a0253fe2741560
-  data.tar.gz: 5c3db2fd3f06553727943a76375d48f70645aaba16828a051cc1ac5835ab96ea9987dea80f25c373e61d880d240c12aeb3d509c1e7d13e23172dc1d576eaec10
+  metadata.gz: 8f9ac29d7ed76bc7100931b4403c655d78fc2078102fb0c3d44fc972a4f2bcf31302ebd1676927b7322b980621a5274a8a1682ba7235f4ee7cf2d24c561250bc
+  data.tar.gz: b450ef97c370faaa21934a7b9c2af03b32a4f692db7a2246efb39204fd039f89a07bcda58a533bcdcfe301b5904a2c598fcd315f5b0f1cfdb6aa57e04e2f2fb0

data/README.md

@@ -7,8 +7,8 @@
 **Contributors**: See Contributors section below    
 **Copyright**:    2007-2013    
 **License**:      MIT License    
-**Latest Version**: 0.8.6    
-**Release Date**: April 13th 2013    
+**Latest Version**: 0.8.6.1    
+**Release Date**: April 14th 2013    
 
 ## Synopsis
 
@@ -283,6 +283,11 @@ More options can be seen by typing `yard graph --help`, but here is an example:
 
 ## Changelog
 
+- **April.14.13**: 0.8.6.1 release
+    - Fixed broken links in File menu on default HTML template
+    - Added --layout switch to `yard display` to wrap output in layout template.
+    - See {file:docs/WhatsNew.md} for more information on added features.
+
 - **April.13.13**: 0.8.6 release
     - Various fixes and improved Ruby 2.x compatibility support
     - Added support for `asciidoc` markup type

data/docs/WhatsNew.md

@@ -20,7 +20,8 @@
 16. **Added `-B/--bind` to bind to a port in yard server** (0.8.4)
 17. **Added `asciidoc` markup type support** (0.8.6)
 18. **Added `yard markups` command to list available markup types** (0.8.6)
-18. **Added `yard display` command to display formatted objects** (0.8.6)
+19. **Added `yard display` command to display formatted objects** (0.8.6)
+20. **Added `--layout` to `yard display` command** (0.8.6.1)
 
 ## Directives (new behavioural tag syntax) (0.8.0)
 
@@ -319,7 +320,8 @@ provider library, pass the `-M PROVIDER_NAME` option.
 ## Added `yard display` command to display formatted objects (0.8.6)
 
 <p class="note">This feature requires the .yardoc registry to have already been
-  generated. To generate the registry, run <code>yard doc -n</code>.</p>
+  generated. To generate the registry, run <code>yard doc -n</code>.
+</p>
 
 You can now display a single object (or a list of objects) in the YARD registry
 using the `yard display OBJECT ...` command. For example, to display the
@@ -336,6 +338,25 @@ web browser:
 Custom templating options from `yard doc` can also be used, see
 `yard display --help` for more options.
 
+## Added `--layout` to `yard display` command (0.8.6.1)
+
+The `yard display` command now accepts `--layout` to wrap content in a layout
+template. Currently the `layout` and `onefile` layout templates are supported,
+though any template can be used. If no parameter is specified, the layout will
+default to the `layout` template. Example usage:
+
+    $ yard display --layout onefile -f html YARD::CodeObjects > codeobjects.html
+
+The above generates a `codeobjects.html` file that is self-contained with
+CSS stylesheets and JavaScript code. This is similar to calling
+`yard doc --one-file` with only the YARD::CodeObjects object in the registry.
+
+Note that even though this uses the onefile template, the README file will not
+be auto-included the way it is with the `yard doc` command. To include the
+README text at the top of the onefile template, pass the --readme switch:
+
+    $ yard display --layout onefile -f html --readme README.md OBJECT > out.html
+
 # What's New in 0.7.x?
 
 1. **Macro support and detection of DSL methods** (0.7.0)

data/lib/yard/cli/display.rb

@@ -8,6 +8,8 @@ module YARD
       def initialize(*args)
         super
         options.format = :text # default for this command
+        @layout = nil
+        @objects = []
       end
 
       # Runs the commandline utility, parsing arguments and displaying an object
@@ -17,9 +19,25 @@ module YARD
       # @return [void]
       def run(*args)
         return unless parse_arguments(*args)
-        @objects.each do |obj|
-          log.puts obj.format(options)
-        end
+        log.puts wrap_layout(format_objects)
+      end
+
+      # @return [String] the output data for all formatted objects
+      def format_objects
+        @objects.inject([]) do |arr, obj|
+          arr.push obj.format(options)
+        end.join("\n")
+      end
+
+      def wrap_layout(contents)
+        return contents unless @layout
+        opts = options.merge(
+          :contents => contents,
+          :object => @objects.first,
+          :objects => @objects
+        )
+        args = [options.template, @layout, options.format]
+        Templates::Engine.template(*args).run(opts)
       end
 
       # Parses commandline options.
@@ -38,6 +56,13 @@ module YARD
         return false if @objects.any? {|o| o.nil? }
         verify_markup_options
       end
+
+      def output_options(opts)
+        super(opts)
+        opts.on('-l', '--layout [LAYOUT]', 'Wraps output in layout template (good for HTML)') do |layout|
+          @layout = layout || 'layout'
+        end
+      end
     end
   end
 end

data/lib/yard/docstring.rb

@@ -71,8 +71,8 @@ module YARD
     #   docstring. May be nil.
     # @param [String] raw_data the complete docstring, including all
     #   original formatting and any unparsed tags/directives.
-    # @param [CodeObjects::Base, nil] A reference object used for the base set
-    #   of documentation / tag information.
+    # @param [CodeObjects::Base, nil] ref_object a reference object used for
+    #   the base set of documentation / tag information.
     def self.new!(text, tags = [], object = nil, raw_data = nil, ref_object = nil)
       docstring = allocate
       docstring.replace(text, false)

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

@@ -97,10 +97,10 @@ module YARD::Templates::Helpers
 
     # Includes an object's docstring into output.
     # @since 0.6.0
-    # @param [CodeObjects::Base] object the object to include
+    # @param [CodeObjects::Base] obj the object to include
     # @return [String] the object's docstring (no tags)
-    def link_include_object(object)
-      object.docstring
+    def link_include_object(obj)
+      obj.docstring
     end
 
     # Include a file as a docstring in output
@@ -113,19 +113,19 @@ module YARD::Templates::Helpers
 
     # Links to an object with an optional title
     #
-    # @param [CodeObjects::Base] object the object to link to
+    # @param [CodeObjects::Base] obj the object to link to
     # @param [String] title the title to use for the link
     # @return [String] the linked object
-    def link_object(object, title = nil)
+    def link_object(obj, title = nil)
       return title if title
 
-      case object
+      case obj
       when YARD::CodeObjects::Base, YARD::CodeObjects::Proxy
-        object.title
+        obj.title
       when String, Symbol
-        P(object).title
+        P(obj).title
       else
-        object
+        obj
       end
     end
 

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

@@ -250,11 +250,11 @@ module YARD
       end
 
       # (see BaseHelper#link_object)
-      def link_object(obj, otitle = nil, anchor = nil, relative = true)
-        return otitle if obj.nil?
+      def link_object(obj, title = nil, anchor = nil, relative = true)
+        return title if obj.nil?
         obj = Registry.resolve(object, obj, true, true) if obj.is_a?(String)
-        if otitle
-          title = otitle.to_s
+        if title
+          title = title.to_s
         elsif object.is_a?(CodeObjects::Base)
           # Check if we're linking to a class method in the current
           # object. If we are, create a title in the format of

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = "0.8.6"
+  VERSION = "0.8.6.1"
 end

data/spec/cli/display_spec.rb

@@ -1,13 +1,30 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe YARD::CLI::Display do
-  it "displays an object" do
+  before do
     Registry.stub(:load)
-    foo = CodeObjects::ClassObject.new(:root, :Foo)
-    foo.docstring = 'Foo bar'
-    output = foo.format
+    @object = CodeObjects::ClassObject.new(:root, :Foo)
+    @object.docstring = 'Foo bar'
+  end
 
+  it "displays an object" do
     YARD::CLI::Display.run('-f', 'text', 'Foo')
-    log.io.string.strip.should eq(output.strip)
+    log.io.string.strip.should eq(@object.format.strip)
+  end
+
+  it "wraps output with -l (defaulting to layout)" do
+    YARD::CLI::Display.run('-l', '-f', 'html', 'Foo')
+    formatted_output = @object.format(:format => :html).strip
+    actual_output = log.io.string.strip
+    actual_output.should_not eq(formatted_output)
+    actual_output.should include(formatted_output)
+  end
+
+  it "wraps output with --layout onefile" do
+    YARD::CLI::Display.run('--layout', 'onefile', '-f', 'html', 'Foo')
+    formatted_output = @object.format(:format => :html).strip
+    actual_output = log.io.string.strip
+    actual_output.should_not eq(formatted_output)
+    actual_output.should include(formatted_output)
   end
 end

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

@@ -1,5 +1,5 @@
 <% n = 1 %>
 <% @items.each do |item| %>
-  <li class="r<%= n %>"><%= link_file item %></li>
+  <li class="r<%= n %>"><span class="object_link"><%= link_file item %></a></li>
   <% n = n == 2 ? 1 : 2 %>
 <% end %>

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

@@ -39,9 +39,6 @@ end
 # contents of all the javascript and css and output the entire contents without
 # depending on any additional files
 def serialize_onefile
-  layout = Object.new.extend(T('layout'))
-  options.css_data = layout.stylesheets.map {|sheet| file(sheet,true) }.join("\n")
-  options.js_data = layout.javascripts.map {|script| file(script,true) }.join("")
   Templates::Engine.with_serializer('index.html', options.serializer) do
     T('onefile').run(options)
   end

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

@@ -14,9 +14,27 @@ def all_objects
   @objects.map {|obj| obj.format(options) }.join("\n")
 end
 
+def layout
+  fulldoc = Object.new.extend(T('fulldoc'))
+  layout = Object.new.extend(T('layout'))
+  @css_data = layout.stylesheets.map {|sheet| read_asset(sheet) }.join("\n")
+  @js_data = layout.javascripts.map {|script| read_asset(script) }.join("")
+
+  erb(:layout)
+end
+
+def read_asset(file)
+  return unless file = T('fulldoc').find_file(file)
+  data = File.read(file)
+  superfile = self.class.find_nth_file('fulldoc', 2)
+  data.gsub!('{{{__super__}}}', superfile ? IO.read(superfile) : "")
+  data
+end
+
 private
 
 def parse_top_comments_from_file
+  return unless @readme
   return @readme.contents unless @readme.filename =~ /\.rb$/
   data = ""
   tokens = TokenList.new(@readme.contents)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.6.1
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-13 00:00:00.000000000 Z
+date: 2013-04-15 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.