yard 0.9.5 → 0.9.6

data/lib/yard/serializers/file_system_serializer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Serializers
     # Implements a serializer that reads from and writes to the filesystem.
@@ -28,7 +29,7 @@ module YARD
         super
         @name_map = nil
         @basepath = (options[:basepath] || 'doc').to_s
-        @extension = (options.has_key?(:extension) ? options[:extension] : 'html').to_s
+        @extension = (options.key?(:extension) ? options[:extension] : 'html').to_s
       end
 
       # Serializes object with data to its serialized path (prefixed by the +#basepath+).
@@ -53,7 +54,7 @@ module YARD
           fspath = ['file.' + object.name + (extension.empty? ? '' : ".#{extension}")]
         else
           objname = object != YARD::Registry.root ? mapped_name(object) : "top-level-namespace"
-          objname += '_' + object.scope.to_s[0,1] if object.is_a?(CodeObjects::MethodObject)
+          objname += '_' + object.scope.to_s[0, 1] if object.is_a?(CodeObjects::MethodObject)
           fspath = [objname + (extension.empty? ? '' : ".#{extension}")]
           if object.namespace && object.namespace.path != ""
             fspath.unshift(*object.namespace.path.split(CodeObjects::NSEP))
@@ -99,9 +100,9 @@ module YARD
 
       # @return [String] the filesystem mapped name of a given object.
       def mapped_name(object)
-        build_filename_map if !@name_map
+        build_filename_map unless @name_map
         map = @name_map[object.path.downcase]
-        return map && map[object.name] ? map[object.name] : object.name.to_s
+        map && map[object.name] ? map[object.name] : object.name.to_s
       end
 
       # Remove special chars from filenames.
@@ -110,9 +111,9 @@ module YARD
       def encode_path_components(*components)
         components.map! do |p|
           p.gsub(/[^\w\.-]/) do |x|
-            encoded = '_'
+            encoded = String.new('_')
 
-            x.each_byte { |b| encoded << ("%X" % b) }
+            x.each_byte {|b| encoded << ("%X" % b) }
             encoded
           end
         end

data/lib/yard/serializers/process_serializer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Serializers
     # Serializes an object to a process (like less)
@@ -15,10 +16,9 @@ module YARD
 
       # Overrides serialize behaviour and writes data to standard input
       # of the associated command
-      def serialize(object, data)
+      def serialize(_object, data)
         IO.popen(@cmd, 'w') {|io| io.write(data) }
       end
     end
   end
 end
-

data/lib/yard/serializers/stdout_serializer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Serializers
     # A serializer that writes data to standard output.
@@ -11,7 +12,7 @@ module YARD
       end
 
       # Overrides serialize behaviour to write data to standard output
-      def serialize(object, data)
+      def serialize(_object, data)
         print(@wrap ? word_wrap(data, @wrap) : data)
       end
 
@@ -20,13 +21,14 @@ module YARD
       # Wraps text to a specific column length
       #
       # @param [String] text the text to wrap
-      # @param [Fixnum] length the column length to wrap to
+      # @param [Fixnum] _length the column length to wrap to
       # @return [String] the wrapped text
-      def word_wrap(text, length = 80)
+      def word_wrap(text, _length = 80)
         # See ruby-talk/10655 / Ernest Ellingson
-        text.gsub(/\t/,"     ").gsub(/.{1,50}(?:\s|\Z)/){($& +
-          5.chr).gsub(/\n\005/,"\n").gsub(/\005/,"\n")}
+        text.gsub(/\t/, "     ").gsub(/.{1,50}(?:\s|\Z)/) do
+          ($& + 5.chr).gsub(/\n\005/, "\n").gsub(/\005/, "\n")
+        end
       end
     end
   end
-end
+end

data/lib/yard/serializers/yardoc_serializer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   # Stubs marshal dumps and acts a delegate class for an object by path
   #
@@ -5,7 +6,7 @@ module YARD
   class StubProxy
     instance_methods.each {|m| undef_method(m) unless m.to_s =~ /^__|^object_id$/ }
 
-    def _dump(depth) @path end
+    def _dump(_depth) @path end
     def self._load(str) new(str) end
     def hash; @path.hash end
 
@@ -20,9 +21,11 @@ module YARD
       @object ||= Registry.at(@path)
       @object.send(meth, *args, &block)
     rescue NoMethodError => e
-      e.backtrace.delete_if {|l| l[0, __FILE__.size] == __FILE__ }
+      e.backtrace.delete_if {|l| l[0, FILELEN] == __FILE__ }
       raise
     end
+
+    FILELEN = __FILE__.size
   end
 
   module Serializers
@@ -48,7 +51,7 @@ module YARD
       # times.
       #
       # @see #locked_for_writing?
-      def lock_for_writing(&block)
+      def lock_for_writing
         File.open!(processing_path, 'w') {}
         yield
       ensure
@@ -61,27 +64,29 @@ module YARD
       end
 
       def serialized_path(object)
-        path = case object
-        when String, Symbol
-          object = object.to_s
-          if object =~ /#/
-            object += '_i'
-          elsif object =~ /\./
-            object += '_c'
+        path =
+          case object
+          when String, Symbol
+            object = object.to_s
+            if object =~ /#/
+              object += '_i'
+            elsif object =~ /\./
+              object += '_c'
+            end
+            object.split(/::|\.|#/).map do |p|
+              p.gsub(/[^\w\.-]/) do |x|
+                encoded = '_'
+
+                x.each_byte {|b| encoded << ("%X" % b) }
+                encoded
+              end
+            end.join('/') + '.' + extension
+          when YARD::CodeObjects::RootObject
+            'root.dat'
+          else
+            super(object)
           end
-          object.split(/::|\.|#/).map do |p|
-            p.gsub(/[^\w\.-]/) do |x|
-              encoded = '_'
 
-              x.each_byte { |b| encoded << ("%X" % b) }
-              encoded
-            end
-          end.join('/') + '.' + extension
-        when YARD::CodeObjects::RootObject
-          'root.dat'
-        else
-          super(object)
-        end
         File.join('objects', path)
       end
 
@@ -113,13 +118,13 @@ module YARD
 
       def internal_dump(object, first_object = false)
         if !first_object && object.is_a?(CodeObjects::Base) &&
-            !(Tags::OverloadTag === object)
+           !(Tags::OverloadTag === object)
           return StubProxy.new(object.path)
         end
 
         if object.is_a?(Hash) || object.is_a?(Array) ||
-            object.is_a?(CodeObjects::Base) ||
-            object.instance_variables.size > 0
+           object.is_a?(CodeObjects::Base) ||
+           !object.instance_variables.empty?
           object = object.dup
         end
 
@@ -144,4 +149,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Server
     # Registers a static path to be used in static asset lookup.
@@ -9,4 +10,4 @@ module YARD
       static_paths.push(path) unless static_paths.include?(path)
     end
   end
-end
+end

data/lib/yard/server/adapter.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 module YARD
   module Server
-
     # Short circuits a request by raising an error. This exception is caught
     # by {Commands::Base#call} to immediately end a request and return a response.
     class FinishRequest < RuntimeError; end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 
 module YARD
@@ -91,9 +92,11 @@ module YARD
           self.headers = {'Content-Type' => 'text/html'}
           self.body = ''
           self.status = 200
+          add_cache_control
           begin
             run
           rescue FinishRequest
+            nil # noop
           rescue NotFoundError => e
             self.body = e.message if e.message != e.class.to_s
             not_found
@@ -178,8 +181,9 @@ module YARD
           self.status = 404
           return unless body.empty?
           self.body = "Not found: #{request.path}"
-          self.headers['Content-Type'] = 'text/plain'
-          self.headers['X-Cascade'] = 'pass'
+          headers['Content-Type'] = 'text/plain'
+          headers['X-Cascade'] = 'pass'
+          headers.delete('Cache-Control')
         end
 
         # Sets the headers and status code for a redirection to a given URL
@@ -190,6 +194,15 @@ module YARD
           self.status = 302
           raise FinishRequest
         end
+
+        private
+
+        # Add a conservative cache control policy to reduce load on
+        # requests served with "?1234567890" style timestamp query strings.
+        def add_cache_control
+          return if request.query_string.to_i == 0
+          headers['Cache-Control'] = 'private, max-age=300'
+        end
       end
     end
   end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Server
     module Commands
@@ -8,9 +9,8 @@ module YARD
         attr_accessor :index
 
         def run
-          ppath = library.source_path
           filename = File.cleanpath(File.join(library.source_path, path))
-          raise NotFoundError if !File.file?(filename)
+          raise NotFoundError unless File.file?(filename)
           if filename =~ /\.(jpe?g|gif|png|bmp)$/i
             headers['Content-Type'] = StaticFileCommand::DefaultMimeTypes[$1.downcase] || 'text/html'
             render File.read_binary(filename)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Server
     module Commands
@@ -11,10 +12,11 @@ module YARD
               filename = options.readme.filename
               opts = adapter.options.merge(
                 :index => true, :library => library,
-                :path => filename.sub(%r{^#{library.source_path.to_s}/}, ''))
+                :path => filename.sub(%r{^#{library.source_path.to_s}/}, '')
+              )
               self.status, self.headers, self.body =
                 *DisplayFileCommand.new(opts).call(request)
-              cache(self.body)
+              cache(body)
               return
             else
               self.path = 'index'
@@ -22,7 +24,8 @@ module YARD
           end
           return index if path == 'index'
 
-          if object = Registry.at(object_path)
+          object = Registry.at(object_path)
+          if object
             options.update(:type => :layout)
             render(object)
           else

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Server
     module Commands

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'thread'
 
 module YARD
@@ -29,6 +30,13 @@ module YARD
       #
       # @abstract
       class LibraryCommand < Base
+        begin
+          Process.fork { exit 0 }
+          CAN_FORK = true
+        rescue Exception # rubocop:disable Lint/RescueException
+          CAN_FORK = false
+        end
+
         # @return [LibraryVersion] the object containing library information
         attr_accessor :library
 
@@ -44,6 +52,10 @@ module YARD
         # @return [Boolean] whether to reparse data
         attr_accessor :incremental
 
+        # @return [Boolean] whether or not this adapter calls +fork+ when serving
+        #   library requests. Defaults to false.
+        attr_accessor :use_fork
+
         # Needed to synchronize threads in {#setup_yardopts}
         # @private
         @@library_chdir_lock = Mutex.new
@@ -54,22 +66,49 @@ module YARD
         end
 
         def call(request)
-          save_default_template_info
+          if can_fork?
+            call_with_fork(request) { super }
+          else
+            begin
+              save_default_template_info
+              call_without_fork(request) { super }
+            ensure
+              restore_template_info
+            end
+          end
+        end
+
+        private
+
+        def call_without_fork(request)
           self.request = request
           self.options = LibraryOptions.new
-          self.options.reset_defaults
-          self.options.command = self
+          options.reset_defaults
+          options.command = self
           setup_library
-          self.options.title = "Documentation for #{library.name} " +
-            (library.version ? '(' + library.version + ')' : '')
-          super
+          options.title = "Documentation for #{library.name} " +
+                          (library.version ? '(' + library.version + ')' : '')
+          yield
         rescue LibraryNotPreparedError
           not_prepared
-        ensure
-          restore_template_info
         end
 
-        private
+        def call_with_fork(request, &block)
+          reader, writer = IO.pipe
+
+          fork do
+            log.debug "[pid=#{Process.pid}] fork serving: #{request.path}"
+            reader.close
+            writer.print(Marshal.dump(call_without_fork(request, &block)))
+          end
+
+          writer.close
+          Marshal.load(reader.read)
+        end
+
+        def can_fork?
+          CAN_FORK && use_fork
+        end
 
         def save_default_template_info
           @old_template_paths = Templates::Engine.template_paths.dup
@@ -133,18 +172,15 @@ module YARD
           tplopts = [options.template, :fulldoc, options.format]
           tplclass = Templates::Engine.template(*tplopts)
           obj = Object.new.extend(tplclass)
-          class << obj; def init; end end
+          class << obj; define_method(:init) {} end
           obj.class = tplclass
           obj.send(:initialize, options)
           class << obj
             attr_reader :contents
-            def asset(file, contents) @contents = contents end
+            define_method(:asset) {|_, contents| @contents = contents }
           end
           obj
         end
-
-        # @private
-        @@last_yardoc = nil
       end
     end
   end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Server
     module Commands
@@ -16,12 +17,12 @@ module YARD
           return unless path.empty?
 
           self.options = LibraryIndexOptions.new
-          self.options.adapter = adapter
-          self.options.libraries = adapter.libraries
-          self.options.reset_defaults
+          options.adapter = adapter
+          options.libraries = adapter.libraries
+          options.reset_defaults
           render
         end
       end
     end
   end
-end
+end