deg-yard 0.8.7.1

data/lib/yard/tags/overload_tag.rb

@@ -0,0 +1,66 @@
+module YARD
+  module Tags
+    class OverloadTag < Tag
+      attr_reader :signature, :parameters, :docstring
+
+      def initialize(tag_name, text)
+        super(tag_name, nil)
+        parse_tag(text)
+        parse_signature
+      end
+
+      def tag(name) docstring.tag(name) end
+      def tags(name = nil) docstring.tags(name) end
+      def has_tag?(name) docstring.has_tag?(name) end
+
+      def object=(value)
+        super(value)
+        docstring.object = value
+        docstring.tags.each {|tag| tag.object = value }
+      end
+
+      def name(prefix = false)
+        return @name unless prefix
+        object.scope == :class ? @name.to_s : "#{object.send(:sep)}#{@name}"
+      end
+
+      def method_missing(*args, &block)
+        object.send(*args, &block)
+      end
+
+      def type
+        object.type
+      end
+
+      def is_a?(other)
+        object.is_a?(other) || self.class >= other.class || false
+      end
+      alias kind_of? is_a?
+
+      private
+
+      def parse_tag(text)
+        @signature, text = *text.split(/\r?\n/, 2)
+        @signature.strip!
+        text ||= ""
+        numspaces = text[/\A(\s*)/, 1].length
+        text.gsub!(/^[ \t]{#{numspaces}}/, '')
+        text.strip!
+        @docstring = Docstring.new(text, nil)
+      end
+
+      def parse_signature
+        if signature =~ /^(?:def\s)?\s*(#{CodeObjects::METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
+          meth, args = $1, $2
+          meth.gsub!(/\s+/,'')
+          # FIXME refactor this code to not make use of the Handlers::Base class (tokval_list should be moved)
+          toks = YARD::Parser::Ruby::Legacy::TokenList.new(args)
+          args = YARD::Handlers::Ruby::Legacy::Base.new(nil, nil).send(:tokval_list, toks, :all)
+          args.map! {|a| k, v = *a.split('=', 2); [k.strip.to_s, (v ? v.strip : nil)] } if args
+          @name = meth.to_sym
+          @parameters = args
+        end
+      end
+    end
+  end
+end

data/lib/yard/tags/ref_tag.rb

@@ -0,0 +1,7 @@
+module YARD
+  module Tags
+    module RefTag
+      attr_accessor :owner
+    end
+  end
+end

data/lib/yard/tags/ref_tag_list.rb

@@ -0,0 +1,27 @@
+module YARD
+  module Tags
+    class RefTagList
+      attr_accessor :owner, :tag_name, :name
+
+      def initialize(tag_name, owner, name = nil)
+        @owner = CodeObjects::Proxy === owner ? owner : P(owner)
+        @tag_name = tag_name.to_s
+        @name = name
+      end
+
+      def tags
+        if owner.is_a?(CodeObjects::Base)
+          o = owner.tags(tag_name)
+          o = o.select {|t| t.name.to_s == name.to_s } if name
+          o.each do |t|
+            t.extend(RefTag)
+            t.owner = owner
+          end
+          o
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/yard/tags/tag.rb

@@ -0,0 +1,57 @@
+module YARD
+  module Tags
+    # Represents a metadata tag value (+@tag+). Tags can have any combination of
+    # {#types}, {#name} and {#text}, or none of the above.
+    #
+    # @example Programmatic tag creation
+    #   # The following docstring syntax:
+    #   #   @param [String, nil] arg an argument
+    #   #
+    #   # is equivalent to:
+    #   Tag.new(:param, 'an argument', ['String', 'nil'], 'arg')
+    class Tag
+      # @return [String] the name of the tag
+      attr_accessor :tag_name
+
+      # @return [String] the tag text associated with the tag
+      # @return [nil] if no tag text is supplied
+      attr_accessor :text
+
+      # @return [Array<String>] a list of types associated with the tag
+      # @return [nil] if no types are associated with the tag
+      attr_accessor :types
+
+      # @return [String] a name associated with the tag
+      attr_accessor :name
+
+      # @return [CodeObjects::Base] the associated object
+      attr_accessor :object
+
+      # Creates a new tag object with a tag name and text. Optionally, formally declared types
+      # and a key name can be specified.
+      #
+      # Types are mainly for meta tags that rely on type information, such as +param+, +return+, etc.
+      #
+      # Key names are for tags that declare meta data for a specific key or name, such as +param+,
+      # +raise+, etc.
+      #
+      # @param [#to_s] tag_name        the tag name to create the tag for
+      # @param [String] text           the descriptive text for this tag
+      # @param [Array<String>] types   optional type list of formally declared types
+      #                                for the tag
+      # @param [String] name           optional key name which the tag refers to
+      def initialize(tag_name, text, types = nil, name = nil)
+        @tag_name, @text, @name, @types = tag_name.to_s, text, name, (types ? [types].flatten.compact : nil)
+      end
+
+      # Convenience method to access the first type specified. This should mainly
+      # be used for tags that only specify one type.
+      #
+      # @return [String] the first of the list of specified types
+      # @see #types
+      def type
+        types.first
+      end
+    end
+  end
+end

data/lib/yard/tags/tag_format_error.rb

@@ -0,0 +1,6 @@
+module YARD
+  module Tags
+    class TagFormatError < Exception
+    end
+  end
+end

data/lib/yard/templates/engine.rb

@@ -0,0 +1,185 @@
+require 'ostruct'
+
+module YARD
+  module Templates
+    # This module manages all creation, handling and rendering of {Template}
+    # objects.
+    #
+    # * To create a template object at a path, use {template}.
+    # * To render a template, call {render}.
+    # * To register a template path in the lookup paths, call {register_template_path}.
+    module Engine
+      class << self
+        # @return [Array<String>] the list of registered template paths
+        attr_accessor :template_paths
+
+        # Registers a new template path in {template_paths}
+        #
+        # @param [String] path a new template path
+        # @return [void]
+        def register_template_path(path)
+          template_paths.push path
+        end
+
+        # Creates a template module representing the path. Searches on disk
+        # for the first directory named +path+ (joined by '/') within the
+        # template paths and builds a template module for. All other matching
+        # directories in other template paths will be included in the
+        # generated module as mixins (for overriding).
+        #
+        # @param [Array<String, Symbol>] path a list of path components
+        # @raise [ArgumentError] if the path does not exist within one of the
+        #   {template_paths} on disk.
+        # @return [Template] the module representing the template
+        def template(*path)
+          from_template = nil
+          from_template = path.shift if path.first.is_a?(Template)
+          path = path.join('/')
+          full_paths = find_template_paths(from_template, path)
+
+          path = File.cleanpath(path).gsub('../', '')
+          raise ArgumentError, "No such template for #{path}" if full_paths.empty?
+          mod = template!(path, full_paths)
+
+          mod
+        end
+
+        # Forces creation of a template at +path+ within a +full_path+.
+        #
+        # @param [String] path the path name of the template
+        # @param [Array<String>] full_paths the full path on disk of the template
+        # @return [Template] the template module representing the +path+
+        def template!(path, full_paths = nil)
+          full_paths ||= [path]
+          full_paths = [full_paths] unless full_paths.is_a?(Array)
+          name = template_module_name(full_paths.first)
+          begin; return const_get(name); rescue NameError; end
+
+          mod = const_set(name, Module.new)
+          mod.send(:include, Template)
+          mod.send(:initialize, path, full_paths)
+          mod
+        end
+
+        # Renders a template on a {CodeObjects::Base code object} using
+        # a set of default (overridable) options. Either the +:object+
+        # or +:type+ keys must be provided.
+        #
+        # If a +:serializer+ key is provided and +:serialize+ is not set to
+        # false, the rendered contents will be serialized through the {Serializers::Base}
+        # object. See {with_serializer}.
+        #
+        # @example Renders an object with html formatting
+        #   Engine.render(:format => :html, :object => obj)
+        # @example Renders without an object
+        #   Engine.render(:type => :fulldoc, :otheropts => somevalue)
+        # @param [Hash] options the options hash
+        # @option options [Symbol] :format (:text) the default format
+        # @option options [Symbol] :type (nil) the :object's type.
+        # @option options [Symbol] :template (:default) the default template
+        # @return [String] the rendered template
+        def render(options = {})
+          options = set_default_options(options)
+          mod = template(options.template, options.type, options.format)
+
+          if options.serializer && options.serialize != false
+            with_serializer(options.object, options.serializer) { mod.run(options) }
+          else
+            mod.run(options)
+          end
+        end
+
+        # Passes a set of objects to the +:fulldoc+ template for full documentation generation.
+        # This is called by {CLI::Yardoc} to most commonly perform HTML
+        # documentation generation.
+        #
+        # @param [Array<CodeObjects::Base>] objects a list of {CodeObjects::Base}
+        #   objects to pass to the template
+        # @param [Hash] options (see {render})
+        # @return [void]
+        def generate(objects, options = {})
+          options = set_default_options(options)
+          options.objects = objects
+          options.object = Registry.root
+          template(options.template, :fulldoc, options.format).run(options)
+        end
+
+        # Serializes the results of a block with a +serializer+ object.
+        #
+        # @param [CodeObjects::Base] object the code object to serialize
+        # @param [Serializers::Base] serializer the serializer object
+        # @yield a block whose result will be serialize
+        # @yieldreturn [String] the contents to serialize
+        # @see Serializers::Base
+        def with_serializer(object, serializer, &block)
+          output = nil
+          filename = serializer.serialized_path(object)
+          if serializer.respond_to?(:basepath)
+            filename = File.join(serializer.basepath, filename)
+          end
+          log.capture("Generating #{filename}", nil) do
+            serializer.before_serialize if serializer
+            output = yield
+            if serializer
+              serializer.serialize(object, output)
+              serializer.after_serialize(output)
+            end
+          end
+          output
+        end
+
+        private
+
+        # Sets default options on the options hash
+        #
+        # @param [Hash] options the options hash
+        # @option options [Symbol] :format (:text) the default format
+        # @option options [Symbol] :type (nil) the :object's type, if provided
+        # @option options [Symbol] :template (:default) the default template
+        # @return [void]
+        def set_default_options(options = {})
+          if options.is_a?(Hash)
+            options = TemplateOptions.new.tap do |o|
+              o.reset_defaults
+              o.update(options)
+            end
+          end
+          options.type ||= options.object.type if options.object
+          options
+        end
+
+        # Searches through the registered {template_paths} and returns
+        # all full directories that have the +path+ within them on disk.
+        #
+        # @param [Template] from_template if provided, allows a relative
+        #   path to be specified from this template's full path.
+        # @param [String] path the path component to search for in the
+        #   {template_paths}
+        # @return [Array<String>] a list of full paths that are existing
+        #   candidates for a template module
+        def find_template_paths(from_template, path)
+          paths = template_paths.dup
+          paths = from_template.full_paths + paths if from_template
+
+          paths.inject([]) do |acc, tp|
+            full_path = File.cleanpath(File.join(tp, path))
+            acc.unshift(full_path) if File.directory?(full_path)
+            acc
+          end.uniq
+        end
+
+        # The name of the module that represents a +path+
+        #
+        # @param [String] path the path to generate a module name for
+        # @return [String] the module name
+        def template_module_name(path)
+          'Template_' + path.to_s.gsub(/[^a-z0-9]/i, '_')
+        end
+      end
+
+      self.template_paths = []
+    end
+
+    Engine.register_template_path(File.join(YARD::ROOT, '..', 'templates'))
+  end
+end

data/lib/yard/templates/erb_cache.rb

@@ -0,0 +1,22 @@
+module YARD
+  module Templates
+    # @since 0.5.4
+    module ErbCache
+      def self.method_for(filename, &block)
+        @methods ||= {}
+        return @methods[filename] if @methods[filename]
+        @methods[filename] = name = "_erb_cache_#{@methods.size}"
+        erb = yield.src
+        encoding = erb[/\A(#coding[:=].*\r?\n)/, 1] || ''
+        module_eval "#{encoding}def #{name}; #{erb}; end", filename
+
+        name
+      end
+
+      def self.clear!
+        return unless @methods
+        @methods.clear
+      end
+    end
+  end
+end

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

@@ -0,0 +1,212 @@
+module YARD::Templates::Helpers
+  # The base helper module included in all templates.
+  module BaseHelper
+    attr_accessor :object, :serializer
+
+    # @return [CodeObjects::Base] the object representing the current generated
+    #   page. Might not be the current {#object} when inside sub-templates.
+    attr_reader :owner
+    undef owner
+    def owner; @owner || object.namespace end
+
+    # @group Managing Global Template State
+
+    # An object that keeps track of global state throughout the entire template
+    # rendering process (including any sub-templates).
+    #
+    # @return [OpenStruct] a struct object that stores state
+    # @since 0.6.0
+    def globals; options.globals end
+
+    # @group Running the Verifier
+
+    # Runs a list of objects against the {Verifier} object passed into the
+    # template and returns the subset of verified objects.
+    #
+    # @param [Array<CodeObjects::Base>] list a list of code objects
+    # @return [Array<CodeObjects::Base>] a list of code objects that match
+    #   the verifier. If no verifier is supplied, all objects are returned.
+    def run_verifier(list)
+      options.verifier ? options.verifier.run(list) : list
+    end
+
+    # @group Escaping Text
+
+    # Escapes text. This is used a lot by the HtmlHelper and there should
+    # be some helper to "clean up" text for whatever, this is it.
+    def h(text)
+      text
+    end
+
+    # @group Linking Objects and URLs
+
+    # Links objects or URLs. This method will delegate to the correct +link_+
+    # method depending on the arguments passed in.
+    #
+    # @example Linking a URL
+    #   linkify('http://example.com')
+    # @example Including docstring contents of an object
+    #   linkify('include:YARD::Docstring')
+    # @example Linking to an extra file
+    #   linkify('file:README')
+    # @example Linking an object by path
+    #   linkify('YARD::Docstring')
+    def linkify(*args)
+      if args.first.is_a?(String)
+        case args.first
+        when %r{://}, /^mailto:/
+          link_url(args[0], args[1], {:target => '_parent'}.merge(args[2]||{}))
+        when /^include:file:(\S+)/
+          file = $1
+          relpath = File.relative_path(Dir.pwd, File.expand_path(file))
+          if relpath =~ /^\.\./
+            log.warn "Cannot include file from path `#{file}'"
+            ""
+          elsif File.file?(file)
+            link_include_file(file)
+          else
+            log.warn "Cannot find file at `#{file}' for inclusion"
+            ""
+          end
+        when /^include:(\S+)/
+          path = $1
+          if obj = YARD::Registry.resolve(object.namespace, path)
+            link_include_object(obj)
+          else
+            log.warn "Cannot find object at `#{path}' for inclusion"
+            ""
+          end
+        when /^render:(\S+)/
+          path = $1
+          if obj = YARD::Registry.resolve(object, path)
+            opts = options.dup
+            opts.delete(:serializer)
+            obj.format(opts)
+          else
+            ''
+          end
+        when /^file:(\S+?)(?:#(\S+))?$/
+          link_file($1, args[1] ? args[1] : nil, $2)
+        else
+          link_object(*args)
+        end
+      else
+        link_object(*args)
+      end
+    end
+
+    # Includes an object's docstring into output.
+    # @since 0.6.0
+    # @param [CodeObjects::Base] obj the object to include
+    # @return [String] the object's docstring (no tags)
+    def link_include_object(obj)
+      obj.docstring
+    end
+
+    # Include a file as a docstring in output
+    # @since 0.7.0
+    # @param [String] file the filename to include
+    # @return [String] the file's contents
+    def link_include_file(file)
+      File.read(file)
+    end
+
+    # Links to an object with an optional title
+    #
+    # @param [CodeObjects::Base] obj the object to link to
+    # @param [String] title the title to use for the link
+    # @return [String] the linked object
+    def link_object(obj, title = nil)
+      return title if title
+
+      case obj
+      when YARD::CodeObjects::Base, YARD::CodeObjects::Proxy
+        obj.title
+      when String, Symbol
+        P(obj).title
+      else
+        obj
+      end
+    end
+
+    # Links to a URL
+    #
+    # @param [String] url the URL to link to
+    # @param [String] title the optional title to display the link as
+    # @param [Hash] params optional parameters for the link
+    # @return [String] the linked URL
+    def link_url(url, title = nil, params = nil)
+      url
+    end
+
+    # Links to an extra file
+    #
+    # @param [String] filename the filename to link to
+    # @param [String] title the title of the link
+    # @param [String] anchor optional anchor
+    # @return [String] the link to the file
+    # @since 0.5.5
+    def link_file(filename, title = nil, anchor = nil)
+      return filename.filename if CodeObjects::ExtraFileObject === filename
+      filename
+    end
+
+    # @group Formatting Object Attributes
+
+    # Formats a list of return types for output and links each type.
+    #
+    # @example Formatting types
+    #   format_types(['String', 'Array']) #=> "(String, Array)"
+    # @example Formatting types without surrounding brackets
+    #   format_types(['String', 'Array'], false) #=> "String, Array"
+    # @param [Array<String>] list a list of types
+    # @param [Boolean] brackets whether to surround the types in brackets
+    # @return [String] the formatted list of Ruby types
+    def format_types(list, brackets = true)
+      list.nil? || list.empty? ? "" : (brackets ? "(#{list.join(", ")})" : list.join(", "))
+    end
+
+    # @example Formatted type of an exception class
+    #   o = ClassObject.new(:root, :MyError)
+    #   o.superclass = P('RuntimeError')
+    #   format_object_type(o) # => "Exception"
+    # @example Formatted type of a method
+    #   o = MethodObject.new(:root, :to_s)
+    #   format_object_type(o) # => "Method"
+    # @param [CodeObjects::Base] object the object to retrieve the type for
+    # @return [String] the human-readable formatted {CodeObjects::Base#type #type}
+    #   for the object
+    def format_object_type(object)
+      case object
+      when YARD::CodeObjects::ClassObject
+        object.is_exception? ? "Exception" : "Class"
+      else
+        object.type.to_s.capitalize
+      end
+    end
+
+    # @example
+    #   s = format_object_title ModuleObject.new(:root, :MyModuleName)
+    #   s # => "Module: MyModuleName"
+    # @param [CodeObjects::Base] object the object to retrieve a title for
+    # @return [String] the page title name for a given object
+    def format_object_title(object)
+      case object
+      when YARD::CodeObjects::RootObject
+        "Top Level Namespace"
+      else
+        format_object_type(object) + ": " + object.title
+      end
+    end
+
+    # Indents and formats source code
+    #
+    # @param [String] value the input source code
+    # @return [String] formatted source code
+    def format_source(value)
+      sp = value.split("\n").last[/^(\s+)/, 1]
+      num = sp ? sp.size : 0
+      value.gsub(/^\s{#{num}}/, '')
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module YARD
+  module Templates::Helpers
+    # Helpers for various object types
+    module FilterHelper
+      # @return [Boolean] whether an object is a method
+      def is_method?(object)
+        object.type == :method
+      end
+
+      # @return [Boolean] whether an object is a namespace
+      def is_namespace?(object)
+        object.is_a?(CodeObjects::NamespaceObject)
+      end
+
+      # @return [Boolean] whether an object is a class
+      def is_class?(object)
+        object.is_a?(CodeObjects::ClassObject)
+      end
+
+      # @return [Boolean] whether an object is a module
+      def is_module?(object)
+        object.is_a?(CodeObjects::ModuleObject)
+      end
+    end
+  end
+end