yard 0.8.2.1 → 0.8.3

data/lib/yard/core_ext/file.rb

@@ -22,7 +22,7 @@ class File
       break if from[0] != to[0]
       from.shift; to.shift
     end
-    fname = from.pop
+    from.pop
     join(*(from.map { RELATIVE_PARENTDIR } + to))
   end
 

data/lib/yard/docstring.rb

@@ -173,7 +173,9 @@ module YARD
         end
       end
       @summary = self[0..idx]
-      @summary += '.' unless @summary.empty?
+      if !@summary.empty? && @summary !~ /\A\s*\{include:.+\}\s*\Z/
+        @summary += '.'
+      end
       @summary
     end
 
@@ -191,6 +193,13 @@ module YARD
           unless tag.docstring.blank?
             tag_text += "\n" + tag.docstring.all.gsub(/\r?\n/, "\n  ")
           end
+        when Tags::OptionTag
+          tag_text = "@#{tag.tag_name} #{tag.name}"
+          tag_text += ' [' + tag.pair.types.join(', ') + ']' if tag.pair.types
+          tag_text += ' ' + tag.pair.name.to_s if tag.pair.name
+          tag_text += "\n " if tag.name && tag.text
+          tag_text += ' (' + tag.pair.defaults.join(', ') + ')' if tag.pair.defaults
+          tag_text += " " + tag.pair.text.strip.gsub(/\n/, "\n  ") if tag.pair.text
         else
           tag_text = '@' + tag.tag_name
           tag_text += ' [' + tag.types.join(', ') + ']' if tag.types

data/lib/yard/i18n/locale.rb

@@ -1,6 +1,3 @@
-require "gettext/tools/poparser"
-require "gettext/runtime/mofile"
-
 module YARD
   module I18n
     # +Locale+ is a unit of translation. It has {#name} and a set of
@@ -28,9 +25,20 @@ module YARD
       #   {#name}.po.
       # @return [Boolean] +true+ if PO file exists, +false+ otherwise.
       def load(locale_directory)
+        return false if @name.nil?
+
         po_file = File.join(locale_directory, "#{@name}.po")
         return false unless File.exist?(po_file)
 
+        begin
+          require "gettext/tools/poparser"
+          require "gettext/runtime/mofile"
+        rescue LoadError
+          log.warn "Need gettext gem for i18n feature:"
+          log.warn "  gem install gettext"
+          return false
+        end
+
         parser = GetText::PoParser.new
         parser.report_warning = false
         data = GetText::MoFile.new

data/lib/yard/i18n/message.rb

@@ -11,7 +11,7 @@ module YARD
       attr_reader :id
 
       # @return [Set] the set of locations. Location is an array of 
-      # path and line number where the message is appered.
+      # path and line number where the message is appeared.
       attr_reader :locations
 
       # @return [Set] the set of comments for the messages.

data/lib/yard/logging.rb

@@ -22,7 +22,8 @@ module YARD
     # @return [Boolean] whether progress indicators should be shown when
     #   logging CLIs (by default this is off).
     def show_progress
-      return false if RUBY18 # threading is too ineffective for progress support
+      return false if YARD.ruby18? # threading is too ineffective for progress support
+      return false if YARD.windows? # windows has poor ANSI support
       return false unless io.tty? # no TTY support on IO
       return false if level > WARN # no progress in verbose/debug modes
       @show_progress
@@ -86,7 +87,7 @@ module YARD
       if defined?(::Encoding)
         icon = PROGRESS_INDICATORS[@progress_indicator] + " "
       end
-      self << "\e[2K\e[?25l\e[1m#{icon}#{msg}\e[0m\r"
+      print("\e[2K\e[?25l\e[1m#{icon}#{msg}\e[0m\r")
       @mutex.synchronize do
         @progress_msg = msg
         @progress_indicator += 1
@@ -105,19 +106,32 @@ module YARD
     # @since 0.8.2
     def clear_progress
       return unless show_progress
-      self << "\e[?25h\e[2K"
+      print_no_newline("\e[?25h\e[2K")
       @progress_msg = nil
     end
 
-    # Displays an unformatted line to the logger output stream. Similar to
-    # the +#<<+ method, but adds a newline.
+    # Displays an unformatted line to the logger output stream, adding
+    # a newline.
     # @param [String] msg the message to display
     # @return [void]
     # @since 0.8.2
-    def puts(msg)
-      self << "#{msg}\n"
+    def puts(msg = '')
+      print("#{msg}\n")
     end
 
+    alias_method :print_no_newline, :<<
+    private :print_no_newline
+
+    # Displays an unformatted line to the logger output stream.
+    # @param [String] msg the message to display
+    # @return [void]
+    # @since 0.8.2
+    def print(msg = '')
+      clear_line
+      print_no_newline(msg)
+    end
+    alias_method :<<, :print
+
     # Prints the backtrace +exc+ to the logger as error data.
     #
     # @param [Array<String>] exc the backtrace list
@@ -156,6 +170,17 @@ module YARD
 
     private
 
+    # Override this internal Logger method to clear line
+    def add(*args)
+      clear_line
+      super(*args)
+    end
+
+    def clear_line
+      return unless @progress_msg
+      print_no_newline("\e[2K\r")
+    end
+
     # Log format (from Logger implementation). Used by Logger internally
     def format_log(sev, time, prog, msg)
       "[#{sev.downcase}]: #{msg}\n"

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

@@ -498,7 +498,7 @@ module YARD
 
           hash_flag = $1 == '##' ? true : false
 
-          if append_comment && @comments_last_column == column
+          if append_comment && @comments_last_column && @comments_last_column == column
             @comments.delete(lineno - 1)
             @comments_flags[lineno] = @comments_flags[lineno - 1]
             @comments_flags.delete(lineno - 1)
@@ -515,6 +515,7 @@ module YARD
 
         def on_embdoc_beg(text)
           visit_ns_token(:embdoc_beg, text)
+          @embdoc_start = charno-text.length
           @embdoc = ""
         end
 
@@ -525,7 +526,10 @@ module YARD
 
         def on_embdoc_end(text)
           visit_ns_token(:embdoc_end, text)
+          @comments_last_column = nil
           @comments[lineno] = @embdoc
+          @comments_range[lineno] = @embdoc_start...charno
+          @embdoc_start = nil
           @embdoc = nil
         end
 
@@ -535,8 +539,9 @@ module YARD
 
         def insert_comments
           root.traverse do |node|
-            next if node.type == :list || node.parent.type != :list
-            (node.line - 2).upto(node.line) do |line|
+            next if node.type == :comment || node.type == :list || node.parent.type != :list
+            # check upwards from line before node; check node's line at the end
+            ((node.line-1).downto(node.line-2).to_a + [node.line]).each  do |line|
               comment = @comments[line]
               if comment && !comment.empty?
                 add_comment(line, node)

data/lib/yard/parser/source_parser.rb

@@ -100,7 +100,7 @@ module YARD
           end
           files = [paths].flatten.
             map {|p| File.directory?(p) ? "#{p}/**/*.{rb,c}" : p }.
-            map {|p| p.include?("*") ? Dir[p] : p }.flatten.
+            map {|p| p.include?("*") ? Dir[p].sort_by {|f| f.length } : p }.flatten.
             reject {|p| !File.file?(p) || excluded.any? {|re| p =~ re } }
 
           log.enter_level(level) do
@@ -360,7 +360,6 @@ module YARD
         # @return [void]
         def parse_in_order(*files)
           global_state = OpenStruct.new
-          files = files.sort_by {|x| x.length if x }
 
           before_parse_list_callbacks.each do |cb|
             return if cb.call(files, global_state) == false

data/lib/yard/rake/yardoc_task.rb

@@ -64,9 +64,8 @@ module YARD
         task(name) do
           before.call if before.is_a?(Proc)
           yardoc = YARD::CLI::Yardoc.new
-          yardoc.parse_arguments *(options + files)
           yardoc.options[:verifier] = verifier if verifier
-          yardoc.run
+          yardoc.run *(options + files)
           after.call if after.is_a?(Proc)
         end
       end

data/lib/yard/registry.rb

@@ -31,6 +31,7 @@ module YARD
   module Registry
     DEFAULT_YARDOC_FILE = ".yardoc"
     LOCAL_YARDOC_INDEX = File.expand_path('~/.yard/gem_index')
+    DEFAULT_PO_DIR = "po"
 
     extend Enumerable
 
@@ -96,7 +97,7 @@ module YARD
       # @raise [ArgumentError] if files is not a String or Array
       def load(files = [], reparse = false)
         if files.is_a?(Array)
-          if File.exists?(yardoc_file) && !reparse
+          if File.exist?(yardoc_file) && !reparse
             load_yardoc
           else
             size = thread_local_store.keys.size
@@ -239,6 +240,13 @@ module YARD
       # @return [CodeObjects::RootObject] the root object in the namespace
       def root; thread_local_store[:root] end
 
+      # @param [String] name the locale name.
+      # @return [I18n::Locale] the locale object for +name+.
+      # @since 0.8.3
+      def locale(name)
+        thread_local_store.locale(name)
+      end
+
       # Attempts to find an object by name starting at +namespace+, performing
       # a lookup similar to Ruby's method of resolving a constant in a namespace.
       #
@@ -347,6 +355,17 @@ module YARD
         thread_local_store.proxy_types
       end
 
+      # @group I18n features
+
+      # Gets/sets the directory that has LANG.po files
+      # @return [String] the directory that has .po files
+      attr_accessor :po_dir
+      undef po_dir, po_dir=
+      def po_dir=(dir) Thread.current[:__yard_po_dir__] = dir end
+      def po_dir
+        Thread.current[:__yard_po_dir__] ||= DEFAULT_PO_DIR
+      end
+
       # @group Legacy Methods
 
       # The registry singleton instance.

data/lib/yard/registry_store.rb

@@ -19,6 +19,7 @@ module YARD
       @notfound = {}
       @loaded_objects = 0
       @available_objects = 0
+      @locales = {}
       @store[:root] = CodeObjects::RootObject.allocate
       @store[:root].send(:initialize, nil, :root)
     end
@@ -108,6 +109,13 @@ module YARD
     # @return [CodeObjects::RootObject] the root object
     def root; @store[:root] end
 
+    # @param [String] name the locale name.
+    # @return [I18n::Locale] the locale object for +name+.
+    # @since 0.8.3
+    def locale(name)
+      @locales[name] ||= load_locale(name)
+    end
+
     # @param [String, nil] file the name of the yardoc db to load
     # @return [Boolean] whether the database was loaded
     def load(file = nil)
@@ -283,6 +291,12 @@ module YARD
       end
     end
 
+    def load_locale(name)
+      locale = I18n::Locale.new(name)
+      locale.load(Registry.po_dir)
+      locale
+    end
+
     def all_disk_objects
       Dir.glob(File.join(objects_path, '**/*')).select {|f| File.file?(f) }
     end
@@ -302,4 +316,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/rubygems/backports/gem.rb

@@ -1,8 +1,9 @@
 module Gem
-  ##
-  # Returns the Gem::SourceIndex of specifications that are in the Gem.path
-
-  def self.source_index
-    @@source_index ||= SourceIndex.from_installed_gems
+  class << self
+    undef source_index if method_defined?(:source_index)
+    # Returns the Gem::SourceIndex of specifications that are in the Gem.path
+    def source_index
+      @@source_index ||= SourceIndex.from_installed_gems
+    end
   end
 end

data/lib/yard/rubygems/backports/source_index.rb

@@ -18,6 +18,15 @@ require 'rubygems/specification'
 #        YAMLized source index objects to load properly.
 
 class Gem::SourceIndex
+  # Undef old methods
+  alias old_initialize initialize
+  undef old_initialize
+  %w(all_gems prerelease_gems load_gems_in latest_specs prerelease_specs
+      released_specs add_spec add_specs remove_spec each specification
+      index_signature gem_signature size length find_name search released_gems
+      refresh! outdated == dump gems spec_dirs spec_dirs=).each do |meth|
+    undef_method(meth) if method_defined?(meth)
+  end
 
   include Enumerable
 
@@ -29,6 +38,14 @@ class Gem::SourceIndex
   attr_accessor :spec_dirs
 
   class << self
+    # Undef old methods
+    %w(from_installed_gems installed_spec_directories
+        from_gems_in load_specification).each do |meth|
+      if instance_methods(true).find {|m| m.to_s == meth }
+        undef_method(meth)
+      end
+    end
+
     ##
     # Factory method to construct a source index instance for a given
     # path.

data/lib/yard/rubygems/doc_manager.rb

@@ -3,7 +3,7 @@ require 'rubygems/doc_manager'
 
 class Gem::DocManager
   def self.load_yardoc
-    require File.dirname(__FILE__) + '/../../yard'
+    require File.expand_path(File.join(File.dirname(__FILE__), *%w(.. .. yard)))
   end
 
   def run_yardoc(*args)

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

@@ -13,22 +13,29 @@ module YARD
         # extra path, use {YARD::Server.register_static_path} rather than
         # modifying this constant directly. Also note that files in the
         # document root will always take precedence over these paths.
-        STATIC_PATHS = [
-          File.join(YARD::TEMPLATE_ROOT, 'default', 'fulldoc', 'html'),
-          File.join(File.dirname(__FILE__), '..', 'templates', 'default', 'fulldoc', 'html')
-        ]
+        STATIC_PATHS = []
 
         def run
+          assets_template = Templates::Engine.template(:default, :fulldoc, :html)
           path = File.cleanpath(request.path).gsub(%r{^(../)+}, '')
+
+          file = nil
           ([adapter.document_root] + STATIC_PATHS.reverse).compact.each do |path_prefix|
             file = File.join(path_prefix, path)
-            if File.exist?(file)
-              ext = "." + (request.path[/\.(\w+)$/, 1] || "html")
-              headers['Content-Type'] = mime_type(ext, DefaultMimeTypes)
-              self.body = File.read(file)
-              return
-            end
+            break if File.exist?(file)
+            file = nil
           end
+
+          # Search in default/fulldoc/html template if nothing in static asset paths
+          file ||= assets_template.find_file(path)
+
+          if file
+            ext = "." + (request.path[/\.(\w+)$/, 1] || "html")
+            headers['Content-Type'] = mime_type(ext, DefaultMimeTypes)
+            self.body = File.read(file)
+            return
+          end
+
           favicon?
           self.status = 404
         end

data/lib/yard/server/library_version.rb

@@ -162,7 +162,7 @@ module YARD
       def prepare!
         return if yardoc_file
         meth = "load_yardoc_from_#{source}"
-        send(meth) if respond_to?(meth)
+        send(meth) if respond_to?(meth, true)
       end
 
       # @return [Gem::Specification] a gemspec object for a given library. Used
@@ -220,7 +220,7 @@ module YARD
 
       def load_source_path
         meth = "source_path_for_#{source}"
-        send(meth) if respond_to?(meth)
+        send(meth) if respond_to?(meth, true)
       end
     end
   end

data/lib/yard/server/rack_adapter.rb

@@ -69,12 +69,12 @@ module YARD
 
       def print_start_message(server)
         opts = server.default_options.merge(server.options)
-        puts ">> YARD #{YARD::VERSION} documentation server at http://#{opts[:Host]}:#{opts[:Port]}"
+        log.puts ">> YARD #{YARD::VERSION} documentation server at http://#{opts[:Host]}:#{opts[:Port]}"
 
         # Only happens for Mongrel
         return unless server.server.to_s == "Rack::Handler::Mongrel"
-        puts ">> #{server.server.class_name} web server (running on Rack)"
-        puts ">> Listening on #{opts[:Host]}:#{opts[:Port]}, CTRL+C to stop"
+        log.puts ">> #{server.server.class_name} web server (running on Rack)"
+        log.puts ">> Listening on #{opts[:Host]}:#{opts[:Port]}, CTRL+C to stop"
       end
     end
   end

data/lib/yard/server/templates/default/layout/html/setup.rb

@@ -1,5 +1,5 @@
 def javascripts
-  super + %w(js/autocomplete.js js/live.js)
+  super + %w(js/autocomplete.js)
 end
 
 def stylesheets