yard 0.7.5 → 0.8.0

data/lib/yard/rake/yardoc_task.rb

@@ -31,7 +31,7 @@ module YARD
       # @return [Proc] a proc to call after running the task
       attr_accessor :after
 
-      # @return [Verifier, Proc] an optional {Verifier} to run against all objects 
+      # @return [Verifier, Proc] an optional {Verifier} to run against all objects
       #   being generated. Any object that the verifier returns false for will be
       #   excluded from documentation. This attribute can also be a lambda.
       # @see Verifier

data/lib/yard/registry.rb

@@ -70,6 +70,7 @@ module YARD
       # @return [String] the yardoc filename
       # @see DEFAULT_YARDOC_FILE
       attr_accessor :yardoc_file
+      undef yardoc_file, yardoc_file=
       def yardoc_file=(v) Thread.current[:__yard_yardoc_file__] = v end
       def yardoc_file
         Thread.current[:__yard_yardoc_file__] ||= DEFAULT_YARDOC_FILE
@@ -207,16 +208,15 @@ module YARD
       # @return [Array<CodeObjects::Base>] the list of objects found
       # @see CodeObjects::Base#type
       def all(*types)
-        thread_local_store.values.select do |obj|
-          if types.empty?
-            obj != root
-          else
-            obj != root &&
-              types.any? do |type|
-                type.is_a?(Symbol) ? obj.type == type : obj.is_a?(type)
-              end
+        if types.empty?
+          thread_local_store.values.select {|obj| obj != root }
+        else
+          list = []
+          types.each do |type|
+            list += thread_local_store.values_for_type(type)
           end
-        end + (types.include?(:root) ? [root] : [])
+          list
+        end
       end
 
       # Returns the paths of all of the objects in the registry.
@@ -284,7 +284,17 @@ module YARD
         else
           while namespace
             if namespace.is_a?(CodeObjects::NamespaceObject)
-              nss = inheritance ? namespace.inheritance_tree(true) : [namespace]
+              if inheritance
+                nss = namespace.inheritance_tree(true)
+                if namespace.respond_to?(:superclass)
+                  if namespace.superclass != P('BasicObject')
+                    nss |= [P('Object')]
+                  end
+                  nss |= [P('BasicObject')]
+                end
+              else
+                nss = [namespace]
+              end
               nss.each do |ns|
                 next if ns.is_a?(CodeObjects::Proxy)
                 found = partial_resolve(ns, name)
@@ -321,6 +331,7 @@ module YARD
       # @return [Boolean, nil] if this value is set to nil, the storage
       #   adapter will decide how to store the data.
       attr_accessor :single_object_db
+      undef single_object_db, single_object_db=
       def single_object_db=(v) Thread.current[:__yard_single_db__] = v end
       def single_object_db; Thread.current[:__yard_single_db__] end
 

data/lib/yard/registry_store.rb

@@ -13,6 +13,7 @@ module YARD
       @checksums = {}
       @store = {}
       @proxy_types = {}
+      @object_types = {:root => [:root]}
       @notfound = {}
       @loaded_objects = 0
       @available_objects = 0
@@ -48,9 +49,14 @@ module YARD
     # @return [CodeObjects::Base] returns +value+
     def put(key, value)
       if key == ''
+        @object_types[:root] = [:root]
         @store[:root] = value
       else
         @notfound.delete(key.to_sym)
+        (@object_types[value.type] ||= []) << key.to_s
+        if @store[key.to_sym]
+          @object_types[@store[key.to_sym].type].delete(key.to_s)
+        end
         @store[key.to_sym] = value
       end
     end
@@ -58,6 +64,9 @@ module YARD
     alias [] get
     alias []= put
 
+    # Deletes an object at a given path
+    # @param [#to_sym] key the key to delete
+    # @return [void]
     def delete(key) @store.delete(key.to_sym) end
 
     # Gets all path names from the store. Loads the entire database
@@ -76,6 +85,24 @@ module YARD
     # @return [Array<CodeObjects::Base>] all the code objects
     def values(reload = false) load_all if reload; @store.values end
 
+    # @param [Symbol] type the type to look for
+    # @return [Array<String>] a list of object paths with a given
+    #   {CodeObjects::Base#type}
+    # @since 0.8.0
+    def paths_for_type(type, reload = false)
+      load_all if reload
+      @object_types[type] || []
+    end
+
+    # @param [Symbol] type the type to look for
+    # @return [Array<CodeObjects::Base>] a list of objects with a given
+    #   {CodeObjects::Base#type}
+    # @since 0.8.0
+    def values_for_type(type, reload = false)
+      load_all if reload
+      paths_for_type(type).map {|t| @store[t.to_sym] }
+    end
+
     # @return [CodeObjects::RootObject] the root object
     def root; @store[:root] end
 
@@ -85,6 +112,7 @@ module YARD
       @file = file
       @store = {}
       @proxy_types = {}
+      @object_types = {}
       @notfound = {}
       @serializer = Serializers::YardocSerializer.new(@file)
       load_yardoc
@@ -147,6 +175,7 @@ module YARD
         end
       end
       write_proxy_types
+      write_object_types
       write_checksums
       true
     end
@@ -186,6 +215,10 @@ module YARD
       @serializer.checksums_path
     end
 
+    def object_types_path
+      @serializer.object_types_path
+    end
+
     def load_yardoc
       return false unless @file
       if File.directory?(@file) # new format
@@ -194,6 +227,7 @@ module YARD
         load_proxy_types
         load_checksums
         load_root
+        load_object_types
         true
       elsif File.file?(@file) # old format
         load_yardoc_old
@@ -214,6 +248,16 @@ module YARD
       @proxy_types = Marshal.load(File.read_binary(proxy_types_path))
     end
 
+    def load_object_types
+      if File.file?(object_types_path)
+        @object_types = Marshal.load(File.read_binary(object_types_path))
+      else # migrate db without object_types
+        values.each do |object|
+          (@object_types[object.type] ||= []) << object.path
+        end
+      end
+    end
+
     def load_checksums
       return unless File.file?(checksums_path)
       lines = File.readlines(checksums_path).map do |line|
@@ -243,6 +287,10 @@ module YARD
       File.open!(proxy_types_path, 'wb') {|f| f.write(Marshal.dump(@proxy_types)) }
     end
 
+    def write_object_types
+      File.open!(object_types_path, 'wb') {|f| f.write(Marshal.dump(@object_types)) }
+    end
+
     def write_checksums
       File.open!(checksums_path, 'w') do |f|
         @checksums.each {|k, v| f.puts("#{k} #{v}") }

data/lib/yard/serializers/file_system_serializer.rb

@@ -34,7 +34,7 @@ module YARD
       #
       # @return [String] the written data (for chaining)
       def serialize(object, data)
-        path = File.join(basepath, *serialized_path(object))
+        path = File.join(basepath, serialized_path(object))
         log.debug "Serializing to #{path}"
         File.open!(path, "wb") {|f| f.write data }
       end
@@ -59,25 +59,7 @@ module YARD
           end
         end
 
-        # Don't change the filenames, it just makes it more complicated
-        # to figure out the original name.
-        #fspath.map! do |p|
-        #  p.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
-        #end
-
-        # Remove special chars from filenames.
-        # Windows disallows \ / : * ? " < > | but we will just remove any
-        # non alphanumeric (plus period, underscore and dash).
-        fspath.map! do |p|
-          p.gsub(/[^\w\.-]/) do |x|
-            encoded = '_'
-
-            x.each_byte { |b| encoded << ("%X" % b) }
-            encoded
-          end
-        end
-
-        File.join(fspath)
+        File.join(encode_path_components(*fspath))
       end
 
       # Checks the disk for an object and returns whether it was serialized.
@@ -87,6 +69,22 @@ module YARD
       def exists?(object)
         File.exist?(File.join(basepath, serialized_path(object)))
       end
+
+      private
+
+      # Remove special chars from filenames.
+      # Windows disallows \ / : * ? " < > | but we will just remove any
+      # non alphanumeric (plus period, underscore and dash).
+      def encode_path_components(*components)
+        components.map! do |p|
+          p.gsub(/[^\w\.-]/) do |x|
+            encoded = '_'
+
+            x.each_byte { |b| encoded << ("%X" % b) }
+            encoded
+          end
+        end
+      end
     end
   end
 end

data/lib/yard/serializers/yardoc_serializer.rb

@@ -34,6 +34,7 @@ module YARD
       def objects_path; File.join(basepath, 'objects') end
       def proxy_types_path; File.join(basepath, 'proxy_types') end
       def checksums_path; File.join(basepath, 'checksums') end
+      def object_types_path; File.join(basepath, 'object_types') end
 
       def serialized_path(object)
         path = case object

data/lib/yard/server/adapter.rb

@@ -2,7 +2,7 @@ module YARD
   module Server
 
     # Short circuits a request by raising an error. This exception is caught
-    # by {Commands::Base#call} to immedaitely end a request and return a response.
+    # by {Commands::Base#call} to immediately end a request and return a response.
     class FinishRequest < RuntimeError; end
 
     # Raises an error if a resource is not found. This exception is caught by
@@ -97,4 +97,4 @@ module YARD
       end
     end
   end
-end
+end

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

@@ -83,7 +83,7 @@ module YARD
         # @note This command should not be overridden by subclasses. Implement
         #   the callback method {#run} instead.
         # @param [Adapter Dependent] request the request object
-        # @return [Array(Number,Hash,Array<String>)] a Rack-style response
+        # @return [Array(Numeric,Hash,Array<String>)] a Rack-style response
         #   of status, headers, and body wrapped in an array.
         def call(request)
           self.request = request

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

@@ -3,8 +3,20 @@ module YARD
     module Commands
       # Displays documentation for a specific object identified by the path
       class DisplayObjectCommand < LibraryCommand
+        include DocServerHelper
+
         def run
-          return index if path.empty?
+          if path.empty?
+            if options.readme
+              url = url_for_file(options.readme)
+              self.status, self.headers, self.body = *router.send(:route, url)
+              cache(body.first)
+              return
+            else
+              self.path = 'index'
+            end
+          end
+          return index if path == 'index'
 
           if object = Registry.at(object_path)
             options.update(:type => :layout)
@@ -17,14 +29,9 @@ module YARD
         def index
           Registry.load_all
 
-          title = options[:title]
-          unless title
-            title = "Documentation for #{library.name} #{library.version ? '(' + library.version + ')' : ''}"
-          end
           options.update(
             :object => '_index.html',
             :objects => Registry.all(:module, :class),
-            :title => title,
             :type => :layout
           )
           render

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

@@ -3,28 +3,11 @@ module YARD
     module Commands
       # Displays an object wrapped in frames
       class FramesCommand < DisplayObjectCommand
-        include DocServerHelper
-
         def run
-          main_url = request.path.gsub(/^(.+)?\/frames(?:\/(#{path}))?$/, '\1/\2')
-          if path =~ %r{^file/}
-            page_title = "File: #{$'}"
-          elsif !path.empty?
-            page_title = "Object: #{object_path}"
-          elsif options[:files] && options[:files].size > 0
-            page_title = "File: #{File.basename(options[:files].first.path)}"
-            main_url = url_for_file(options[:files].first)
-          elsif !path || path.empty?
-            page_title = "Documentation for #{library.name} #{library.version ? '(' + library.version + ')' : ''}"
-          end
-
-          options.update(
-            :page_title => page_title,
-            :main_url => main_url,
-            :template => :doc_server,
-            :type => :frames
-          )
-          render
+          options.update(:frames => true, :type => :fulldoc)
+          tpl = fulldoc_template
+          tpl.generate_frameset
+          cache(tpl.contents)
         end
       end
     end

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

@@ -3,6 +3,25 @@ require 'thread'
 module YARD
   module Server
     module Commands
+      class LibraryOptions < CLI::YardocOptions
+        def adapter; @command.adapter end
+        def library; @command.library end
+        def single_library; @command.single_library end
+        def serializer; @command.serializer end
+        default_attr :serialize, false
+
+        attr_accessor :command
+        attr_accessor :frames
+
+        def each(&block)
+          super(&block)
+          yield(:adapter, adapter)
+          yield(:library, library)
+          yield(:single_library, single_library)
+          yield(:serializer, serializer)
+        end
+      end
+
       # This is the base command for all commands that deal directly with libraries.
       # Some commands do not, but most (like {DisplayObjectCommand}) do. If your
       # command deals with libraries directly, subclass this class instead.
@@ -13,7 +32,7 @@ module YARD
         # @return [LibraryVersion] the object containing library information
         attr_accessor :library
 
-        # @return [Hash{Symbol => Object}] default options for the library
+        # @return [LibraryOptions] default options for the library
         attr_accessor :options
 
         # @return [Serializers::Base] the serializer used to perform file linking
@@ -35,24 +54,33 @@ module YARD
         end
 
         def call(request)
+          save_default_template_info
           self.request = request
-          self.options = SymbolHash.new(false).update(
-            :serialize => false,
-            :serializer => serializer,
-            :library => library,
-            :adapter => adapter,
-            :single_library => single_library,
-            :markup => :rdoc,
-            :format => :html
-          )
+          self.options = LibraryOptions.new
+          self.options.reset_defaults
+          self.options.command = self
           setup_library
+          self.options.title = "Documentation for #{library.name} " +
+            (library.version ? '(' + library.version + ')' : '')
           super
         rescue LibraryNotPreparedError
           not_prepared
+        ensure
+          restore_template_info
         end
 
         private
 
+        def save_default_template_info
+          @old_template_paths = Templates::Engine.template_paths.dup
+          @old_extra_includes = Templates::Template.extra_includes.dup
+        end
+
+        def restore_template_info
+          Templates::Engine.template_paths = @old_template_paths
+          Templates::Template.extra_includes = @old_extra_includes
+        end
+
         def setup_library
           library.prepare! if request.xhr? && request.query['process']
           load_yardoc
@@ -83,16 +111,34 @@ module YARD
             return
           end
           Registry.clear
+          Templates::ErbCache.clear!
           Registry.load_yardoc(library.yardoc_file)
           Thread.current[:__yard_last_yardoc__] = library.yardoc_file
         end
 
         def not_prepared
           self.caching = false
-          options.update(:path => request.path, :template => :doc_server, :type => :processing)
+          options.update(:template => :doc_server, :type => :processing)
           [202, {'Content-Type' => 'text/html'}, [render]]
         end
 
+        # Hack to load a custom fulldoc template object that does
+        # not do any rendering/generation. We need this to access the
+        # generate_*_list methods.
+        def fulldoc_template
+          tplopts = [options.template, :fulldoc, options.format]
+          tplclass = Templates::Engine.template(*tplopts)
+          obj = Object.new.extend(tplclass)
+          class << obj; def init; end end
+          obj.class = tplclass
+          obj.send(:initialize, options)
+          class << obj
+            attr_reader :contents
+            def asset(file, contents) @contents = contents end
+          end
+          obj
+        end
+
         # @private
         @@last_yardoc = nil
       end