yard 0.5.3 → 0.5.4

data/lib/yard/handlers/ruby/constant_handler.rb

@@ -2,7 +2,7 @@ class YARD::Handlers::Ruby::ConstantHandler < YARD::Handlers::Ruby::Base
   namespace_only
   handles :assign
   
-  def process
+  process do
     if statement[1].call? && statement[1][0][0] == s(:const, "Struct") && 
         statement[1][2] == s(:ident, "new")
       process_structclass(statement)

data/lib/yard/handlers/ruby/exception_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::ExceptionHandler < YARD::Handlers::Ruby::Base
   handles method_call(:raise)
   
-  def process
+  process do
     return unless owner.is_a?(MethodObject) # Only methods yield
     return if [:command_call, :call].include? statement.type
     return if owner.has_tag?(:raise)

data/lib/yard/handlers/ruby/legacy/alias_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::Legacy::AliasHandler < YARD::Handlers::Ruby::Legacy::Base
   handles /\Aalias(_method)?(\s|\()/
   
-  def process
+  process do
     if TkALIAS === statement.tokens.first 
       tokens = statement.tokens[2..-1].to_s.split(/\s+/)
       names = [tokens[0], tokens[1]].map {|t| t.gsub(/^:/, '') }

data/lib/yard/handlers/ruby/legacy/attribute_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::Legacy::AttributeHandler < YARD::Handlers::Ruby::Legacy::Base
   handles /\Aattr(?:_(?:reader|writer|accessor))?(?:\s|\()/
   
-  def process
+  process do
     begin
       attr_type   = statement.tokens.first.text.to_sym
       symbols     = tokval_list statement.tokens[2..-1], :attr, TkTRUE, TkFALSE

data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb

@@ -0,0 +1,8 @@
+class YARD::Handlers::Ruby::Legacy::ClassConditionHandler < YARD::Handlers::Ruby::Legacy::Base
+  namespace_only
+  handles TkIF, TkELSIF, TkELSE, TkUNLESS
+  
+  process do
+    parse_block
+  end
+end

data/lib/yard/handlers/ruby/legacy/class_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::Legacy::ClassHandler < YARD::Handlers::Ruby::Legacy::Base
   handles TkCLASS
   
-  def process
+  process do
     if statement.tokens.to_s =~ /^class\s+(#{NAMESPACEMATCH})\s*(?:<\s*(.+)|\Z)/m
       classname = $1
       superclass = parse_superclass($2)

data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb

@@ -2,7 +2,7 @@ class YARD::Handlers::Ruby::Legacy::ClassVariableHandler < YARD::Handlers::Ruby:
   HANDLER_MATCH = /\A@@\w+\s*=\s*/m
   handles HANDLER_MATCH
   
-  def process
+  process do
     # Don't document @@cvars if they're set in second class objects (methods) because
     # they're not "static" when executed from a method
     return unless owner.is_a? NamespaceObject

data/lib/yard/handlers/ruby/legacy/constant_handler.rb

@@ -2,7 +2,7 @@ class YARD::Handlers::Ruby::Legacy::ConstantHandler < YARD::Handlers::Ruby::Lega
   HANDLER_MATCH = /\A[A-Z]\w*\s*=[^=]\s*/m
   handles HANDLER_MATCH
   
-  def process
+  process do
     # Don't document CONSTANTS if they're set in second class objects (methods) because
     # they're not "static" when executed from a method
     return unless owner.is_a? NamespaceObject

data/lib/yard/handlers/ruby/legacy/exception_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::Legacy::ExceptionHandler < YARD::Handlers::Ruby::Legacy::Base
   handles /\Araise(\s|\()/
   
-  def process
+  process do
     return unless owner.is_a?(MethodObject) # Only methods yield
     return if owner.has_tag?(:raise)
 

data/lib/yard/handlers/ruby/legacy/method_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::Legacy::MethodHandler < YARD::Handlers::Ruby::Legacy::Base
   handles TkDEF
     
-  def process
+  process do
     nobj = namespace
     mscope = scope
 

data/lib/yard/handlers/ruby/legacy/mixin_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::Legacy::MixinHandler < YARD::Handlers::Ruby::Legacy::Base
   handles /\Ainclude(\s|\()/
   
-  def process
+  process do
     statement.tokens[1..-1].to_s.split(/\s*,\s*/).each do |mixin|
       process_mixin(mixin.strip)
     end

data/lib/yard/handlers/ruby/legacy/module_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::Legacy::ModuleHandler < YARD::Handlers::Ruby::Legacy::Base
   handles TkMODULE
   
-  def process
+  process do
     modname = statement.tokens.to_s[/^module\s+(#{NAMESPACEMATCH})/, 1]
     mod = register ModuleObject.new(namespace, modname)
     parse_block(:namespace => mod)

data/lib/yard/handlers/ruby/legacy/process_handler.rb

@@ -0,0 +1,12 @@
+class YARD::Handlers::Ruby::Legacy::ProcessHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles /\Aprocess(?:\(?|\s)/
+  namespace_only
+  
+  process do
+    return unless namespace.is_a?(ClassObject) && namespace.superclass.to_s =~ /^YARD::Handlers/
+    register MethodObject.new(namespace, :process) do |o| 
+      o.signature = "def process"
+      o.parameters = []
+    end
+  end
+end

data/lib/yard/handlers/ruby/legacy/visibility_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::Legacy::VisibilityHandler < YARD::Handlers::Ruby::Legacy::Base
   handles /\A(protected|private|public)(\s|\(|$)/
   
-  def process
+  process do
     vis = statement.tokens.first.text
     if statement.tokens.size == 1
       self.visibility = vis

data/lib/yard/handlers/ruby/legacy/yield_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::Legacy::YieldHandler < YARD::Handlers::Ruby::Legacy::Base
   handles TkYIELD
   
-  def process
+  process do
     return unless owner.is_a?(MethodObject) # Only methods yield
     return if owner.has_tag? :yield         # Don't override yield tags
     return if owner.has_tag? :yieldparam    # Same thing.

data/lib/yard/handlers/ruby/method_condition_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::MethodConditionHandler < YARD::Handlers::Ruby::Base
   handles :if_mod, :unless_mod
   
-  def process
+  process do
     parse_block(statement.then_block, owner: owner)
   end
 end

data/lib/yard/handlers/ruby/method_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
   handles :def, :defs
   
-  def process
+  process do
     nobj = namespace
     mscope = scope
     if statement.type == :defs

data/lib/yard/handlers/ruby/mixin_handler.rb

@@ -2,7 +2,7 @@ class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base
   namespace_only
   handles method_call(:include)
   
-  def process
+  process do
     statement.parameters(false).each {|mixin| process_mixin(mixin) }
   end
 

data/lib/yard/handlers/ruby/module_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::ModuleHandler < YARD::Handlers::Ruby::Base
   handles :module
   
-  def process
+  process do
     modname = statement[0].source
     mod = register ModuleObject.new(namespace, modname)
     parse_block(statement[1], :namespace => mod)

data/lib/yard/handlers/ruby/process_handler.rb

@@ -0,0 +1,12 @@
+class YARD::Handlers::Ruby::ProcessHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:process)
+  namespace_only
+  
+  process do
+    return unless namespace.is_a?(ClassObject) && namespace.superclass.to_s =~ /^YARD::Handlers/
+    register MethodObject.new(namespace, :process) do |o| 
+      o.signature = "def process"
+      o.parameters = []
+    end
+  end
+end

data/lib/yard/handlers/ruby/visibility_handler.rb

@@ -3,7 +3,7 @@ class YARD::Handlers::Ruby::VisibilityHandler < YARD::Handlers::Ruby::Base
   handles method_call(:protected)
   handles method_call(:public)
   
-  def process
+  process do
     return if (ident = statement.jump(:ident)) == statement
     case statement.type
     when :var_ref

data/lib/yard/handlers/ruby/yield_handler.rb

@@ -1,7 +1,7 @@
 class YARD::Handlers::Ruby::YieldHandler < YARD::Handlers::Ruby::Base
   handles :yield, :yield0
   
-  def process
+  process do
     return unless owner.is_a?(MethodObject) # Only methods yield
     return if owner.has_tag? :yield         # Don't override yield tags
     return if owner.has_tag? :yieldparam    # Same thing.

data/lib/yard/parser/ruby/legacy/ruby_lex.rb

@@ -83,7 +83,7 @@ module YARD
       class TkUnknownChar < Token
         def initialize(line_no, char_no, id)
           super(line_no, char_no)
-          @name = char_no.chr
+          @name = char_no > 255 ? '?' : char_no.chr
         end
         attr :name
       end

data/lib/yard/parser/ruby/legacy/statement.rb

@@ -29,9 +29,15 @@ module YARD
       end
       alias show inspect
       
+      # @return [Fixnum] the first line of Ruby source
       def line
         tokens.first.line_no
       end
+      
+      # @return [Range<Fixnum>] the first to last lines of Ruby source
+      def line_range
+        tokens.first.line_no..tokens.last.line_no
+      end
 
       private
 

data/lib/yard/parser/ruby/legacy/statement_list.rb

@@ -111,7 +111,7 @@ module YARD
       #
       # @param [RubyToken::Token] tk the token to process
       def process_token(tk)
-        # p tk.text, @state, @level, @current_block, "<br/>"
+        # p tk.class, tk.text, @state, @level, @current_block, "<br/>"
         case @state
         when :first_statement
           return if process_initial_comment(tk)
@@ -196,9 +196,15 @@ module YARD
         # Since, of course, the convention is to have "# text"
         # and not "#text", which I deem ugly (you heard it here first)
         @comments ||= []
-        @comments << tk.text.gsub(/^#+\s{0,1}/, '')
+        if tk.text =~ /\A=begin/
+          lines = tk.text.count("\n")
+          @comments += tk.text.gsub(/\A=begin.*\r?\n|\r?\n=end.*\r?\n?\Z/, '').split(/\r?\n/)
+          @comments_last_line = tk.line_no + lines
+        else
+          @comments << tk.text.gsub(/^#+\s{0,1}/, '')
+          @comments_last_line = tk.line_no
+        end
         @comments.pop if @comments.size == 1 && @comments.first =~ /^\s*$/
-        @comments_last_line = tk.line_no
         true
       end
 

data/lib/yard/parser/ruby/ruby_parser.rb

@@ -317,6 +317,22 @@ module YARD
           @comments_last_column = column
         end
         
+        def on_embdoc_beg(text)
+          visit_ns_token(:embdoc_beg, text)
+          @embdoc = ""
+        end
+        
+        def on_embdoc(text)
+          visit_ns_token(:embdoc, text)
+          @embdoc << text
+        end
+        
+        def on_embdoc_end(text)
+          visit_ns_token(:embdoc_end, text)
+          @comments[lineno] = @embdoc
+          @embdoc = nil
+        end
+        
         def on_parse_error(msg)
           raise ParserSyntaxError, "syntax error in `#{file}`:(#{lineno},#{column}): #{msg}"
         end

data/lib/yard/tags/default_factory.rb

@@ -51,12 +51,8 @@ module YARD
         Tag.new(tag_name, text, types, name)
       end
       
-      def parse_tag_with_raw_text(tag_name, text, raw_text)
-        Tag.new(tag_name, raw_text)
-      end
-      
-      def parse_tag_with_raw_title_and_text(tag_name, text, raw_text)
-        title, desc = *extract_title_and_desc_from_raw_text(raw_text)
+      def parse_tag_with_title_and_text(tag_name, text)
+        title, desc = *extract_title_and_desc_from_text(text)
         Tag.new(tag_name, desc, nil, title)
       end
       
@@ -87,7 +83,7 @@ module YARD
       # @return [Array] an array holding the name as the first element and the 
       #                 value as the second element
       def extract_name_from_text(text)
-        text.strip.split(" ", 2)
+        text.strip.split(/\s+/, 2)
       end
       
       ##
@@ -102,14 +98,14 @@ module YARD
         [name, types, (range ? text[(range.end+1)..-1].strip : text)]
       end
       
-      def extract_title_and_desc_from_raw_text(raw_text)
+      def extract_title_and_desc_from_text(text)
         title, desc = nil, nil
-        if raw_text =~ /\A[ \t]\n/
-          desc = raw_text
+        if text =~ /\A[ \t]\n/
+          desc = text
         else
-          raw_text = raw_text.split(/\r?\n/)
-          title = raw_text.shift.squeeze(' ').strip
-          desc = raw_text.join("\n")
+          text = text.split(/\r?\n/)
+          title = text.shift.squeeze(' ').strip
+          desc = text.join("\n")
         end
         [title, desc]
       end

data/lib/yard/tags/library.rb

@@ -90,14 +90,14 @@ module YARD
         def define_tag(label, tag, meth = "")
           if meth.is_a?(Class) && Tag > meth
             class_eval <<-eof, __FILE__, __LINE__
-              def #{tag}_tag(text, raw_text) 
-                #{meth}.new(#{tag.inspect}, text, raw_text) 
+              def #{tag}_tag(text) 
+                #{meth}.new(#{tag.inspect}, text) 
               end
             eof
           else
             class_eval <<-eof, __FILE__, __LINE__
-              def #{tag}_tag(text, raw_text)
-                send_to_factory(#{tag.inspect}, #{meth.inspect}, text, raw_text)
+              def #{tag}_tag(text)
+                send_to_factory(#{tag.inspect}, #{meth.inspect}, text)
               end
             eof
           end
@@ -110,12 +110,12 @@ module YARD
       
       private
       
-      def send_to_factory(tag_name, meth, text, raw_text)
+      def send_to_factory(tag_name, meth, text)
         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, *(arity == 3 ? [raw_text] : [])
+          @factory.send(send_name, tag_name, text)
         else
           raise NoMethodError, "Factory #{@factory.class_name} does not implement factory method :#{meth}."
         end
@@ -145,7 +145,7 @@ module YARD
       define_tag "API Visibility",    :api
       define_tag "Note",              :note
       define_tag "Todo Item",         :todo
-      define_tag "Example",           :example,     :with_raw_title_and_text
+      define_tag "Example",           :example,     :with_title_and_text
       define_tag "Options Hash",      :option,      :with_options
       define_tag "Overloads",         :overload,    OverloadTag
       define_tag "Private",           :private

data/lib/yard/tags/overload_tag.rb

@@ -3,9 +3,9 @@ module YARD
     class OverloadTag < Tag
       attr_reader :signature, :parameters, :docstring
       
-      def initialize(tag_name, text, raw_text)
+      def initialize(tag_name, text)
         super(tag_name, nil)
-        parse_tag(raw_text)
+        parse_tag(text)
         parse_signature
       end
       
@@ -38,8 +38,8 @@ module YARD
 
       private
       
-      def parse_tag(raw_text)
-        @signature, text = *raw_text.split(/\r?\n/, 2)
+      def parse_tag(text)
+        @signature, text = *text.split(/\r?\n/, 2)
         @signature.strip!
         text ||= ""
         numspaces = text[/\A(\s*)/, 1].length

data/lib/yard/templates/erb_cache.rb

@@ -0,0 +1,18 @@
+module YARD
+  module Templates
+    module ErbCache
+      def self.method_for(filename)
+        @methods ||= {}
+        return @methods[filename] if @methods[filename]
+        @methods[filename] = name = "_erb_cache_#{@methods.size}"
+        module_eval "def #{name}; #{yield.src.gsub(/\A#coding:.*$/, '')}; end", filename
+        name
+      end
+
+      def self.clear!
+        return unless @methods
+        @methods.clear
+      end
+    end
+  end
+end

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

@@ -23,6 +23,25 @@ module YARD
       def urlencode(text)
         CGI.escape(text.to_s)
       end
+      
+      # Returns the current character set. The default value can be overridden
+      # by setting the +LANG+ environment variable or by overriding this
+      # method. In Ruby 1.9 you can also modify this value by setting
+      # +Encoding.default_external+.
+      # 
+      # @return [String] the current character set
+      def charset
+        return 'utf-8' unless RUBY19 || lang = ENV['LANG']
+        if RUBY19
+          lang = Encoding.default_external.name.downcase
+        else
+          lang = lang.downcase.split('.').last
+        end
+        case lang
+        when "ascii-8bit", "us-ascii", "ascii-7bit"; 'iso-8859-1'
+        else; lang
+        end
+      end
 
       # Turns text into HTML using +markup+ style formatting.
       # 
@@ -65,7 +84,7 @@ module YARD
       
       # @return [String] HTMLified text as a single line (paragraphs removed)
       def htmlify_line(*args)
-        htmlify(*args).gsub(/<\/?p>/, '')
+        "<div class='inline'>" + htmlify(*args) + "</div>"
       end
       
       # Fixes RDoc behaviour with ++ only supporting alphanumeric text.
@@ -76,7 +95,7 @@ module YARD
           type_text, pre_text, no_match = $1, $`, $&
           pre_match = pre_text.scan(%r(</?(?:pre|tt|code).*?>))
           if pre_match.last.nil? || pre_match.last.include?('/')
-            '<tt>' + type_text + '</tt>'
+            '<tt>' + h(type_text) + '</tt>'
           else
             no_match
           end
@@ -287,7 +306,7 @@ module YARD
         
         type = signature_types(meth, link)
         scope = meth.scope == :class ? "+" : "-"
-        name = full_attr_name ? meth.name : meth.name.to_s.gsub(/=$/, '')
+        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)
         extras = []
@@ -316,10 +335,10 @@ module YARD
       
       def html_syntax_highlight(source, type = :ruby)
         return "" unless source
-        return source if options[:no_highlight]
+        return h(source) if options[:no_highlight]
         
         # handle !!!LANG prefix to send to html_syntax_highlight_LANG
-        if source =~ /\A[ \t]*!!!(\w+)[ \t]*\r?\n/
+        if source =~ /\A[ \t]*!!!([\w.+-]+)[ \t]*\r?\n/
           type, source = $1, $'
           source = $'
         end