yard 0.8.2.1 → 0.8.3

data/lib/yard/cli/stats.rb

@@ -64,30 +64,30 @@ module YARD
         else
           total = (@total - @undocumented).to_f / @total.to_f * 100
         end
-        puts("% 3.2f%% documented" % total)
+        log.puts("% 3.2f%% documented" % total)
       end
 
       # Prints list of undocumented objects
       def print_undocumented_objects
         return if !@undoc_list || @undoc_list.empty?
-        puts
-        puts "Undocumented Objects:"
+        log.puts
+        log.puts "Undocumented Objects:"
 
         objects = @undoc_list.sort_by {|o| o.file }
         max = objects.sort_by {|o| o.path.length }.last.path.length
         if @compact
           objects.each do |object|
-            puts("%-#{max}s     (%s)" % [object.path,
+            log.puts("%-#{max}s     (%s)" % [object.path,
               [object.file, object.line].compact.join(":")])
           end
         else
           last_file = nil
           objects.each do |object|
             if object.file != last_file
-              puts
-              puts "(in file: #{object.file})"
+              log.puts
+              log.puts "(in file: #{object.file})"
             end
-            puts object.path
+            log.puts object.path
             last_file = object.file
           end
         end
@@ -148,7 +148,7 @@ module YARD
         else
           data = "%5s" % data
         end
-        puts("%-12s %s" % [name + ":", data])
+        log.puts("%-12s %s" % [name + ":", data])
       end
 
       private

data/lib/yard/cli/yardoc.rb

@@ -138,10 +138,7 @@ module YARD
     #
     # @since 0.2.1
     # @see Verifier
-    class Yardoc < Command
-      # The configuration filename to load extra options from
-      DEFAULT_YARDOPTS_FILE = ".yardopts"
-
+    class Yardoc < YardoptsCommand
       # @return [Hash] the hash of options passed to the template.
       # @see Templates::Engine#render
       attr_reader :options
@@ -158,12 +155,6 @@ module YARD
       #   parse only changed files.
       attr_accessor :use_cache
 
-      # @return [Boolean] whether to parse options from .yardopts
-      attr_accessor :use_yardopts_file
-
-      # @return [Boolean] whether to parse options from .document
-      attr_accessor :use_document_file
-
       # @return [Boolean] whether objects should be serialized to .yardoc db
       attr_accessor :save_yardoc
 
@@ -174,10 +165,6 @@ module YARD
       # @since 0.5.5
       attr_accessor :list
 
-      # The options file name (defaults to {DEFAULT_YARDOPTS_FILE})
-      # @return [String] the filename to load extra options from
-      attr_accessor :options_file
-
       # Keep track of which visibilities are to be shown
       # @return [Array<Symbol>] a list of visibilities
       # @since 0.5.6
@@ -216,10 +203,7 @@ module YARD
         @files = []
         @hidden_tags = []
         @use_cache = false
-        @use_yardopts_file = true
-        @use_document_file = true
         @generate = true
-        @options_file = DEFAULT_YARDOPTS_FILE
         @statistics = true
         @list = false
         @save_yardoc = true
@@ -279,12 +263,7 @@ module YARD
       # @return [Boolean] whether or not arguments are valid
       # @since 0.5.6
       def parse_arguments(*args)
-        parse_yardopts_options(*args)
-
-        # Parse files and then command line arguments
-        optparse(*support_rdoc_document_file!) if use_document_file
-        optparse(*yardopts) if use_yardopts_file
-        optparse(*args)
+        super(*args)
 
         # Last minute modifications
         self.files = ['{lib,app}/**/*.rb', 'ext/**/*.c'] if self.files.empty?
@@ -298,6 +277,8 @@ module YARD
         add_visibility_verifier
         add_api_verifier
 
+        apply_locale
+
         # US-ASCII is invalid encoding for onefile
         if defined?(::Encoding) && options.onefile
           if ::Encoding.default_internal == ::Encoding::US_ASCII
@@ -322,15 +303,6 @@ module YARD
         Registry.all(:root, :module, :class)
       end
 
-      # Parses the .yardopts file for default yard options
-      # @return [Array<String>] an array of options parsed from .yardopts
-      def yardopts
-        return [] unless use_yardopts_file
-        File.read_binary(options_file).shell_split
-      rescue Errno::ENOENT
-        []
-      end
-
       private
 
       # Generates output for objects
@@ -403,34 +375,10 @@ module YARD
         Registry.load_all
         run_verifier(Registry.all).
           sort_by {|item| [item.file || '', item.line || 0] }.each do |item|
-          puts "#{item.file}:#{item.line}: #{item.path}"
+          log.puts "#{item.file}:#{item.line}: #{item.path}"
         end
       end
 
-      # Parses out the yardopts/document options
-      def parse_yardopts_options(*args)
-        opts = OptionParser.new
-        opts.base.long.clear # HACK: why are --help and --version defined?
-        yardopts_options(opts)
-        begin
-          opts.parse(args)
-        rescue OptionParser::ParseError => err
-          idx = args.index(err.args.first)
-          args = args[(idx+1)..-1]
-          args.shift while args.first && args.first[0,1] != '-'
-          retry
-        end
-      end
-
-      # Reads a .document file in the directory to get source file globs
-      # @return [Array<String>] an array of files parsed from .document
-      def support_rdoc_document_file!
-        return [] unless use_document_file
-        File.read(".document").gsub(/^[ \t]*#.+/m, '').split(/\s+/)
-      rescue Errno::ENOENT
-        []
-      end
-
       # Adds a set of extra documentation files to be processed
       # @param [Array<String>] files the set of documentation files
       def add_extra_files(*files)
@@ -489,6 +437,15 @@ module YARD
         options.verifier.add_expressions(expr)
       end
 
+      # Applies the specified locale to collected objects
+      # @return [void]
+      # @since 0.8.3
+      def apply_locale
+        options.files.each do |file|
+          file.locale = options.locale
+        end
+      end
+
       # (see Templates::Helpers::BaseHelper#run_verifier)
       def run_verifier(list)
         options.verifier ? options.verifier.run(list) : list
@@ -569,25 +526,6 @@ module YARD
         end
       end
 
-      # Adds --[no-]yardopts / --[no-]document
-      def yardopts_options(opts)
-        opts.on('--[no-]yardopts [FILE]',
-                "If arguments should be read from FILE",
-                "  (defaults to yes, FILE defaults to .yardopts)") do |use_yardopts|
-          if use_yardopts.is_a?(String)
-            self.options_file = use_yardopts
-            self.use_yardopts_file = true
-          else
-            self.use_yardopts_file = (use_yardopts != false)
-          end
-        end
-
-        opts.on('--[no-]document', "If arguments should be read from .document file. ",
-                                   "  (defaults to yes)") do |use_document|
-          self.use_document_file = use_document
-        end
-      end
-
       # Adds output options
       def output_options(opts)
         opts.separator ""
@@ -735,6 +673,18 @@ module YARD
         opts.on('--no-stats', 'Don\'t print statistics') do
           self.statistics = false
         end
+
+        opts.on('--locale LOCALE',
+                'The locale for generated documentation.',
+                '  (defaults to en)') do |locale|
+          options.locale = locale
+        end
+
+        opts.on('--po-dir DIR',
+                'The directory that has .po files.',
+                '  (defaults to #{YARD::Registry.po_dir})') do |dir|
+          YARD::Registry.po_dir = dir
+        end
       end
 
       # Adds tag options
@@ -767,8 +717,12 @@ module YARD
           self.hidden_tags |= [tag.to_sym]
         end
 
-        opts.on('--transitive-tag TAG', 'Adds a transitive tag') do |tag|
-          Tags::Library.transitive_tags += [tag.to_sym]
+        opts.on('--transitive-tag TAG', 'Marks a tag as transitive') do |tag|
+          Tags::Library.transitive_tags |= [tag.to_sym]
+        end
+
+        opts.on('--non-transitive-tag TAG', 'Marks a tag as not transitive') do |tag|
+          Tags::Library.transitive_tags -= [tag.to_sym]
         end
       end
     end

data/lib/yard/cli/yardopts_command.rb

@@ -0,0 +1,109 @@
+require 'optparse'
+
+module YARD
+  module CLI
+    # Abstract base class for command that reads .yardopts file
+    #
+    # @abstract
+    # @since 0.8.3
+    class YardoptsCommand < Command
+      # The configuration filename to load extra options from
+      DEFAULT_YARDOPTS_FILE = ".yardopts"
+
+      # @return [Boolean] whether to parse options from .yardopts
+      attr_accessor :use_yardopts_file
+
+      # @return [Boolean] whether to parse options from .document
+      attr_accessor :use_document_file
+
+      # The options file name (defaults to {DEFAULT_YARDOPTS_FILE})
+      # @return [String] the filename to load extra options from
+      attr_accessor :options_file
+
+      # Creates a new command that reads .yardopts
+      def initialize
+        super
+        @options_file = DEFAULT_YARDOPTS_FILE
+        @use_yardopts_file = true
+        @use_document_file = true
+      end
+
+      # Parses commandline arguments
+      # @param [Array<String>] args the list of arguments
+      # @return [Boolean] whether or not arguments are valid
+      # @since 0.5.6
+      def parse_arguments(*args)
+        parse_yardopts_options(*args)
+
+        # Parse files and then command line arguments
+        parse_rdoc_document_file
+        parse_yardopts
+        optparse(*args)
+      end
+
+      protected
+
+      # Adds --[no-]yardopts / --[no-]document
+      def yardopts_options(opts)
+        opts.on('--[no-]yardopts [FILE]',
+                "If arguments should be read from FILE",
+                "  (defaults to yes, FILE defaults to .yardopts)") do |use_yardopts|
+          if use_yardopts.is_a?(String)
+            self.options_file = use_yardopts
+            self.use_yardopts_file = true
+          else
+            self.use_yardopts_file = (use_yardopts != false)
+          end
+        end
+
+        opts.on('--[no-]document', "If arguments should be read from .document file. ",
+                                   "  (defaults to yes)") do |use_document|
+          self.use_document_file = use_document
+        end
+      end
+
+      private
+
+      # Parses the .yardopts file for default yard options
+      # @return [Array<String>] an array of options parsed from .yardopts
+      def yardopts(file = options_file)
+        return [] unless use_yardopts_file
+        File.read_binary(file).shell_split
+      rescue Errno::ENOENT
+        []
+      end
+
+      # Parses out the yardopts/document options
+      def parse_yardopts_options(*args)
+        opts = OptionParser.new
+        opts.base.long.clear # HACK: why are --help and --version defined?
+        yardopts_options(opts)
+        begin
+          opts.parse(args)
+        rescue OptionParser::ParseError => err
+          idx = args.index(err.args.first)
+          args = args[(idx+1)..-1]
+          args.shift while args.first && args.first[0,1] != '-'
+          retry
+        end
+      end
+
+      def parse_rdoc_document_file(file = '.document')
+        optparse(*support_rdoc_document_file!(file)) if use_document_file
+      end
+
+      def parse_yardopts(file = options_file)
+        optparse(*yardopts(file)) if use_yardopts_file
+      end
+
+      # Reads a .document file in the directory to get source file globs
+      # @return [Array<String>] an array of files parsed from .document
+      def support_rdoc_document_file!(file = '.document')
+        return [] unless use_document_file
+        File.read(file).gsub(/^[ \t]*#.+/m, '').split(/\s+/)
+      rescue Errno::ENOENT
+        []
+      end
+    end
+  end
+end

data/lib/yard/cli/yri.rb

@@ -72,8 +72,8 @@ module YARD
       # @return [void]
       # @since 0.5.6
       def print_usage
-        puts "Usage: yri [options] <Path to object>"
-        puts "See yri --help for more options."
+        log.puts "Usage: yri [options] <Path to object>"
+        log.puts "See yri --help for more options."
       end
 
       # Caches the .yardoc file where an object can be found in the {CACHE_FILE}

data/lib/yard/code_objects/base.rb

@@ -170,7 +170,9 @@ module YARD
           if name.to_s[0,2] == NSEP
             name = name.to_s[2..-1]
             namespace = Registry.root
-          elsif name =~ /(?:#{NSEPQ})([^:]+)$/
+          end
+
+          if name =~ /(?:#{NSEPQ})([^:]+)$/
             return new(Proxy.new(namespace, $`), $1, *args, &block)
           end
 

data/lib/yard/code_objects/extra_file_object.rb

@@ -5,9 +5,10 @@ module YARD::CodeObjects
   # compatible with most CodeObject interfaces.
   class ExtraFileObject
     attr_accessor :filename
-    attr_accessor :attributes
+    attr_writer :attributes
     attr_accessor :name
-    attr_accessor :contents
+    # @since 0.8.3
+    attr_reader :locale
 
     # Creates a new extra file object.
     # @param [String] filename the location on disk of the file
@@ -17,15 +18,41 @@ module YARD::CodeObjects
       self.filename = filename
       self.name = File.basename(filename).gsub(/\.[^.]+$/, '')
       self.attributes = SymbolHash.new(false)
-      parse_contents(contents || File.read(@filename))
+      @original_contents = contents
+      @parsed = false
+      @locale = nil
+      ensure_parsed
     end
 
     alias path name
 
+    def attributes
+      ensure_parsed
+      @attributes
+    end
+
     def title
       attributes[:title] || name
     end
 
+    def contents
+      ensure_parsed
+      @contents
+    end
+
+    def contents=(contents)
+      @original_contents = contents
+      @parsed = false
+    end
+
+    # @param [String] locale the locale name to be translated.
+    # @return [void]
+    # @since 0.8.3
+    def locale=(locale)
+      @locale = locale
+      @parsed = false
+    end
+
     def inspect
       "#<yardoc #{type} #{filename} attrs=#{attributes.inspect}>"
     end
@@ -43,10 +70,17 @@ module YARD::CodeObjects
 
     private
 
+    def ensure_parsed
+      return if @parsed
+      @parsed = true
+      @contents = parse_contents(@original_contents || File.read(@filename))
+    end
+
     # @param [String] data the file contents
     def parse_contents(data)
       retried = false
       cut_index = 0
+      data = translate(data)
       data = data.split("\n")
       data.each_with_index do |line, index|
         case line
@@ -65,7 +99,7 @@ module YARD::CodeObjects
         end
       end
       data = data[cut_index..-1] if cut_index > 0
-      self.contents = data.join("\n")
+      contents = data.join("\n")
 
       if contents.respond_to?(:force_encoding) && attributes[:encoding]
         begin
@@ -74,16 +108,21 @@ module YARD::CodeObjects
           log.warn "Invalid encoding `#{attributes[:encoding]}' in #{filename}"
         end
       end
+      contents
     rescue ArgumentError => e
       if retried && e.message =~ /invalid byte sequence/
         # This should never happen.
         log.warn "Could not read #{filename}, #{e.message}. You probably want to set `--charset`."
-        self.contents = ''
-        return
+        return ''
       end
       data.force_encoding('binary') if data.respond_to?(:force_encoding)
       retried = true
       retry
     end
+
+    def translate(data)
+      text = YARD::I18n::Text.new(data, :have_header => true)
+      text.translate(YARD::Registry.locale(locale))
+    end
   end
 end