horseman 0.0.2 → 0.0.3

data/vendor/ruby/1.9.1/gems/rdoc-3.12/lib/rdoc/code_object.rb

@@ -0,0 +1,305 @@
+##
+# Base class for the RDoc code tree.
+#
+# We contain the common stuff for contexts (which are containers) and other
+# elements (methods, attributes and so on)
+#
+# Here's the tree of the CodeObject subclasses:
+#
+# * RDoc::Context
+#   * RDoc::TopLevel
+#   * RDoc::ClassModule
+#     * RDoc::AnonClass (never used so far)
+#     * RDoc::NormalClass
+#     * RDoc::NormalModule
+#     * RDoc::SingleClass
+# * RDoc::MethodAttr
+#   * RDoc::Attr
+#   * RDoc::AnyMethod
+#     * RDoc::GhostMethod
+#     * RDoc::MetaMethod
+# * RDoc::Alias
+# * RDoc::Constant
+# * RDoc::Require
+# * RDoc::Include
+
+class RDoc::CodeObject
+
+  include RDoc::Text
+
+  ##
+  # Our comment
+
+  attr_reader :comment
+
+  ##
+  # Do we document our children?
+
+  attr_reader :document_children
+
+  ##
+  # Do we document ourselves?
+
+  attr_reader :document_self
+
+  ##
+  # Are we done documenting (ie, did we come across a :enddoc:)?
+
+  attr_reader :done_documenting
+
+  ##
+  # Which file this code object was defined in
+
+  attr_reader :file
+
+  ##
+  # Force documentation of this CodeObject
+
+  attr_reader :force_documentation
+
+  ##
+  # Line in #file where this CodeObject was defined
+
+  attr_accessor :line
+
+  ##
+  # Hash of arbitrary metadata for this CodeObject
+
+  attr_reader :metadata
+
+  ##
+  # Offset in #file where this CodeObject was defined
+  #--
+  # TODO character or byte?
+
+  attr_accessor :offset
+
+  ##
+  # Our parent CodeObject
+
+  attr_accessor :parent
+
+  ##
+  # Did we ever receive a +:nodoc:+ directive?
+
+  attr_reader :received_nodoc
+
+  ##
+  # Which section are we in
+
+  attr_accessor :section
+
+  ##
+  # We are the model of the code, but we know that at some point we will be
+  # worked on by viewers. By implementing the Viewable protocol, viewers can
+  # associated themselves with these objects.
+
+  attr_accessor :viewer
+
+  ##
+  # Creates a new CodeObject that will document itself and its children
+
+  def initialize
+    @metadata  = {}
+    @comment   = ''
+    @parent    = nil
+    @file      = nil
+    @full_name = nil
+
+    @document_children   = true
+    @document_self       = true
+    @done_documenting    = false
+    @force_documentation = false
+    @received_nodoc      = false
+    @ignored             = false
+  end
+
+  ##
+  # Replaces our comment with +comment+, unless it is empty.
+
+  def comment=(comment)
+    @comment = case comment
+               when NilClass               then ''
+               when RDoc::Markup::Document then comment
+               when RDoc::Comment          then comment.normalize
+               else
+                 if comment and not comment.empty? then
+                   normalize_comment comment
+                 else
+                   # TODO is this sufficient?
+                   # HACK correct fix is to have #initialize create @comment
+                   #      with the correct encoding
+                   if String === @comment and
+                      Object.const_defined? :Encoding and @comment.empty? then
+                     @comment.force_encoding comment.encoding
+                   end
+                   @comment
+                 end
+               end
+  end
+
+  ##
+  # Should this CodeObject be shown in documentation?
+
+  def display?
+    @document_self and not @ignored
+  end
+
+  ##
+  # Enables or disables documentation of this CodeObject's children unless it
+  # has been turned off by :enddoc:
+
+  def document_children=(document_children)
+    @document_children = document_children unless @done_documenting
+  end
+
+  ##
+  # Enables or disables documentation of this CodeObject unless it has been
+  # turned off by :enddoc:.  If the argument is +nil+ it means the
+  # documentation is turned off by +:nodoc:+.
+
+  def document_self=(document_self)
+    return if @done_documenting
+
+    @document_self = document_self
+    @received_nodoc = true if document_self.nil?
+  end
+
+  ##
+  # Does this object have a comment with content or is #received_nodoc true?
+
+  def documented?
+    @received_nodoc or !@comment.empty?
+  end
+
+  ##
+  # Turns documentation on/off, and turns on/off #document_self
+  # and #document_children.
+  #
+  # Once documentation has been turned off (by +:enddoc:+),
+  # the object will refuse to turn #document_self or
+  # #document_children on, so +:doc:+ and +:start_doc:+ directives
+  # will have no effect in the current file.
+
+  def done_documenting=(value)
+    @done_documenting = value
+    @document_self = !value
+    @document_children = @document_self
+  end
+
+  ##
+  # Yields each parent of this CodeObject.  See also
+  # RDoc::ClassModule#each_ancestor
+
+  def each_parent
+    code_object = self
+
+    while code_object = code_object.parent do
+      yield code_object
+    end
+
+    self
+  end
+
+  ##
+  # File name where this CodeObject was found.
+  #
+  # See also RDoc::Context#in_files
+
+  def file_name
+    return unless @file
+
+    @file.absolute_name
+  end
+
+  ##
+  # Force the documentation of this object unless documentation
+  # has been turned off by :endoc:
+  #--
+  # HACK untested, was assigning to an ivar
+
+  def force_documentation=(value)
+    @force_documentation = value unless @done_documenting
+  end
+
+  ##
+  # Sets the full_name overriding any computed full name.
+  #
+  # Set to +nil+ to clear RDoc's cached value
+
+  def full_name= full_name
+    @full_name = full_name
+  end
+
+  ##
+  # Use this to ignore a CodeObject and all its children until found again
+  # (#record_location is called).  An ignored item will not be shown in
+  # documentation.
+  #
+  # See github issue #55
+  #
+  # The ignored status is temporary in order to allow implementation details
+  # to be hidden.  At the end of processing a file RDoc allows all classes
+  # and modules to add new documentation to previously created classes.
+  #
+  # If a class was ignored (via stopdoc) then reopened later with additional
+  # documentation it should be shown.  If a class was ignored and never
+  # reopened it should not be shown.  The ignore flag allows this to occur.
+
+  def ignore
+    @ignored = true
+
+    stop_doc
+  end
+
+  ##
+  # Has this class been ignored?
+
+  def ignored?
+    @ignored
+  end
+
+  ##
+  # File name of our parent
+
+  def parent_file_name
+    @parent ? @parent.base_name : '(unknown)'
+  end
+
+  ##
+  # Name of our parent
+
+  def parent_name
+    @parent ? @parent.full_name : '(unknown)'
+  end
+
+  ##
+  # Records the RDoc::TopLevel (file) where this code object was defined
+
+  def record_location top_level
+    @ignored = false
+    @file = top_level
+  end
+
+  ##
+  # Enable capture of documentation unless documentation has been
+  # turned off by :endoc:
+
+  def start_doc
+    return if @done_documenting
+
+    @document_self = true
+    @document_children = true
+    @ignored = false
+  end
+
+  ##
+  # Disable capture of documentation
+
+  def stop_doc
+    @document_self = false
+    @document_children = false
+  end
+
+end
+

data/vendor/ruby/1.9.1/gems/rdoc-3.12/lib/rdoc/code_objects.rb

@@ -0,0 +1,5 @@
+# This file was used to load all the RDoc::CodeObject subclasses at once.  Now
+# autoload handles this.
+
+require 'rdoc'
+

data/vendor/ruby/1.9.1/gems/rdoc-3.12/lib/rdoc/comment.rb

@@ -0,0 +1,225 @@
+##
+# A comment holds the text comment for a RDoc::CodeObject and provides a
+# unified way of cleaning it up and parsing it into an RDoc::Markup::Document.
+#
+# Each comment may have a different markup format set by #format=.  By default
+# 'rdoc' is used.  The :markup: directive tells RDoc which format to use.
+#
+# See RDoc::Markup@Other+directives for instructions on adding an alternate
+# format.
+
+class RDoc::Comment
+
+  include RDoc::Text
+
+  ##
+  # The format of this comment.  Defaults to RDoc::Markup
+
+  attr_reader :format
+
+  ##
+  # The RDoc::TopLevel this comment was found in
+
+  attr_accessor :location
+
+  ##
+  # The text for this comment
+
+  attr_reader :text
+
+  ##
+  # Overrides the content returned by #parse.  Use when there is no #text
+  # source for this comment
+
+  attr_writer   :document
+
+  ##
+  # Creates a new comment with +text+ that is found in the RDoc::TopLevel
+  # +location+.
+
+  def initialize text = nil, location = nil
+    @location = location
+    @text     = text
+
+    @document   = nil
+    @format     = 'rdoc'
+    @normalized = false
+  end
+
+  ##
+  #--
+  # TODO deep copy @document
+
+  def initialize_copy copy # :nodoc:
+    @text = copy.text.dup
+  end
+
+  def == other # :nodoc:
+    self.class === other and
+      other.text == @text and other.location == @location
+  end
+
+  ##
+  # Look for a 'call-seq' in the comment to override the normal parameter
+  # handling.  The :call-seq: is indented from the baseline.  All lines of the
+  # same indentation level and prefix are consumed.
+  #
+  # For example, all of the following will be used as the :call-seq:
+  #
+  #   # :call-seq:
+  #   #   ARGF.readlines(sep=$/)     -> array
+  #   #   ARGF.readlines(limit)      -> array
+  #   #   ARGF.readlines(sep, limit) -> array
+  #   #
+  #   #   ARGF.to_a(sep=$/)     -> array
+  #   #   ARGF.to_a(limit)      -> array
+  #   #   ARGF.to_a(sep, limit) -> array
+
+  def extract_call_seq method
+    # we must handle situations like the above followed by an unindented first
+    # comment.  The difficulty is to make sure not to match lines starting
+    # with ARGF at the same indent, but that are after the first description
+    # paragraph.
+    if @text =~ /^\s*:?call-seq:(.*?(?:\S).*?)^\s*$/m then
+      all_start, all_stop = $~.offset(0)
+      seq_start, seq_stop = $~.offset(1)
+
+      # we get the following lines that start with the leading word at the
+      # same indent, even if they have blank lines before
+      if $1 =~ /(^\s*\n)+^(\s*\w+)/m then
+        leading = $2 # ' *    ARGF' in the example above
+        re = %r%
+          \A(
+             (^\s*\n)+
+             (^#{Regexp.escape leading}.*?\n)+
+            )+
+          ^\s*$
+        %xm
+
+        if @text[seq_stop..-1] =~ re then
+          all_stop = seq_stop + $~.offset(0).last
+          seq_stop = seq_stop + $~.offset(1).last
+        end
+      end
+
+      seq = @text[seq_start..seq_stop]
+      seq.gsub!(/^\s*(\S|\n)/m, '\1')
+      @text.slice! all_start...all_stop
+
+      method.call_seq = seq.chomp
+
+    elsif @text.sub!(/^\s*:?call-seq:(.*?)(^\s*$|\z)/m, '') then
+      seq = $1
+      seq.gsub!(/^\s*/, '')
+      method.call_seq = seq
+    end
+    #elsif @text.sub!(/\A\/\*\s*call-seq:(.*?)\*\/\Z/, '') then
+    #  method.call_seq = $1.strip
+    #end
+
+    method
+  end
+
+  ##
+  # A comment is empty if its text String is empty.
+
+  def empty?
+    @text.empty?
+  end
+
+  ##
+  # HACK dubious
+
+  def force_encoding encoding
+    @text.force_encoding encoding
+  end
+
+  ##
+  # Sets the format of this comment and resets any parsed document
+
+  def format= format
+    @format = format
+    @document = nil
+  end
+
+  def inspect # :nodoc:
+    "#<%s:%x %s %p>" % [self.class, object_id, @location.absolute_name, @text]
+  end
+
+  ##
+  # Normalizes the text.  See RDoc::Text#normalize_comment for details
+
+  def normalize
+    return self unless @text
+    return self if @normalized # TODO eliminate duplicate normalization
+
+    @text = normalize_comment @text
+
+    @normalized = true
+
+    self
+  end
+
+  ##
+  # Was this text normalized?
+
+  def normalized? # :nodoc:
+    @normalized
+  end
+
+  ##
+  # Parses the comment into an RDoc::Markup::Document.  The parsed document is
+  # cached until the text is changed.
+
+  def parse
+    return @document if @document
+
+    @document = super @text, @format
+    @document.file = @location
+    @document
+  end
+
+  ##
+  # Removes private sections from this comment.  Private sections are flush to
+  # the comment marker and start with <tt>--</tt> and end with <tt>++</tt>.
+  # For C-style comments, a private marker may not start at the opening of the
+  # comment.
+  #
+  #   /*
+  #    *--
+  #    * private
+  #    *++
+  #    * public
+  #    */
+
+  def remove_private
+    # Workaround for gsub encoding for Ruby 1.9.2 and earlier
+    empty = ''
+    empty.force_encoding @text.encoding if Object.const_defined? :Encoding
+
+    @text = @text.gsub(%r%^\s*([#*]?)--.*?^\s*(\1)\+\+\n?%m, empty)
+    @text = @text.sub(%r%^\s*[#*]?--.*%m, '')
+  end
+
+  ##
+  # Replaces this comment's text with +text+ and resets the parsed document.
+  #
+  # An error is raised if the comment contains a document but no text.
+
+  def text= text
+    raise RDoc::Error, 'replacing document-only comment is not allowed' if
+      @text.nil? and @document
+
+    @document = nil
+    @text = text
+  end
+
+  ##
+  # Returns true if this comment is in TomDoc format.
+
+  def tomdoc?
+    @format == 'tomdoc'
+  end
+
+end
+

data/vendor/ruby/1.9.1/gems/rdoc-3.12/lib/rdoc/constant.rb

@@ -0,0 +1,84 @@
+##
+# A constant
+
+class RDoc::Constant < RDoc::CodeObject
+
+  ##
+  # If this constant is an alias for a module or class,
+  # this is the RDoc::ClassModule it is an alias for.
+  # +nil+ otherwise.
+
+  attr_accessor :is_alias_for
+
+  ##
+  # The constant's name
+
+  attr_accessor :name
+
+  ##
+  # The constant's value
+
+  attr_accessor :value
+
+  ##
+  # Creates a new constant with +name+, +value+ and +comment+
+
+  def initialize(name, value, comment)
+    super()
+    @name = name
+    @value = value
+    @is_alias_for = nil
+    self.comment = comment
+  end
+
+  ##
+  # Constants are ordered by name
+
+  def <=> other
+    return unless self.class === other
+
+    [parent_name, name] <=> [other.parent_name, other.name]
+  end
+
+  ##
+  # Constants are equal when their #parent and #name is the same
+
+  def == other
+    self.class == other.class and
+      @parent == other.parent and
+      @name == other.name
+  end
+
+  ##
+  # A constant is documented if it has a comment, or is an alias
+  # for a documented class or module.
+
+  def documented?
+    super or is_alias_for && is_alias_for.documented?
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x %s::%s>" % [
+      self.class, object_id,
+      parent_name, @name,
+    ]
+  end
+
+  ##
+  # Path to this constant
+
+  def path
+    "#{@parent.path}##{@name}"
+  end
+
+  def to_s # :nodoc:
+    parent_name = parent ? parent.full_name : '(unknown)'
+    if is_alias_for
+      "constant #{parent_name}::#@name -> #{is_alias_for}"
+    else
+      "constant #{parent_name}::#@name"
+    end
+  end
+
+end
+