horseman 0.0.2 → 0.0.3

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

@@ -0,0 +1,162 @@
+##
+# Collection of methods for writing parsers against RDoc::RubyLex and
+# RDoc::RubyToken
+
+module RDoc::Parser::RubyTools
+
+  include RDoc::RubyToken
+
+  ##
+  # Adds a token listener +obj+, but you should probably use token_listener
+
+  def add_token_listener(obj)
+    @token_listeners ||= []
+    @token_listeners << obj
+  end
+
+  ##
+  # Fetches the next token from the scanner
+
+  def get_tk
+    tk = nil
+
+    if @tokens.empty? then
+      tk = @scanner.token
+      @read.push @scanner.get_readed
+      puts "get_tk1 => #{tk.inspect}" if $TOKEN_DEBUG
+    else
+      @read.push @unget_read.shift
+      tk = @tokens.shift
+      puts "get_tk2 => #{tk.inspect}" if $TOKEN_DEBUG
+    end
+
+    tk = nil if TkEND_OF_SCRIPT === tk
+
+    if TkSYMBEG === tk then
+      set_token_position tk.line_no, tk.char_no
+
+      case tk1 = get_tk
+      when TkId, TkOp, TkSTRING, TkDSTRING, TkSTAR, TkAMPER then
+        if tk1.respond_to?(:name) then
+          tk = Token(TkSYMBOL).set_text(":" + tk1.name)
+        else
+          tk = Token(TkSYMBOL).set_text(":" + tk1.text)
+        end
+
+        # remove the identifier we just read (we're about to replace it with a
+        # symbol)
+        @token_listeners.each do |obj|
+          obj.pop_token
+        end if @token_listeners
+      else
+        tk = tk1
+      end
+    end
+
+    # inform any listeners of our shiny new token
+    @token_listeners.each do |obj|
+      obj.add_token(tk)
+    end if @token_listeners
+
+    tk
+  end
+
+  ##
+  # Reads and returns all tokens up to one of +tokens+.  Leaves the matched
+  # token in the token list.
+
+  def get_tk_until(*tokens)
+    read = []
+
+    loop do
+      tk = get_tk
+      case tk when *tokens then unget_tk tk; break end
+      read << tk
+    end
+
+    read
+  end
+
+  ##
+  # Retrieves a String representation of the read tokens
+
+  def get_tkread
+    read = @read.join("")
+    @read = []
+    read
+  end
+
+  ##
+  # Peek equivalent for get_tkread
+
+  def peek_read
+    @read.join('')
+  end
+
+  ##
+  # Peek at the next token, but don't remove it from the stream
+
+  def peek_tk
+    unget_tk(tk = get_tk)
+    tk
+  end
+
+  ##
+  # Removes the token listener +obj+
+
+  def remove_token_listener(obj)
+    @token_listeners.delete(obj)
+  end
+
+  ##
+  # Resets the tools
+
+  def reset
+    @read       = []
+    @tokens     = []
+    @unget_read = []
+    @nest = 0
+  end
+
+  ##
+  # Skips whitespace tokens including newlines if +skip_nl+ is true
+
+  def skip_tkspace(skip_nl = true) # HACK dup
+    tokens = []
+
+    while TkSPACE === (tk = get_tk) or (skip_nl and TkNL === tk) do
+      tokens.push tk
+    end
+
+    unget_tk tk
+    tokens
+  end
+
+  ##
+  # Has +obj+ listen to tokens
+
+  def token_listener(obj)
+    add_token_listener obj
+    yield
+  ensure
+    remove_token_listener obj
+  end
+
+  ##
+  # Returns +tk+ to the scanner
+
+  def unget_tk(tk)
+    @tokens.unshift tk
+    @unget_read.unshift @read.pop
+
+    # Remove this token from any listeners
+    @token_listeners.each do |obj|
+      obj.pop_token
+    end if @token_listeners
+
+    nil
+  end
+
+end
+
+

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

@@ -0,0 +1,61 @@
+##
+# Parse a non-source file. We basically take the whole thing as one big
+# comment.
+
+class RDoc::Parser::Simple < RDoc::Parser
+
+  include RDoc::Parser::Text
+
+  parse_files_matching(//)
+
+  attr_reader :content # :nodoc:
+
+  ##
+  # Prepare to parse a plain file
+
+  def initialize(top_level, file_name, content, options, stats)
+    super
+
+    preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
+
+    preprocess.handle @content, @top_level
+  end
+
+  ##
+  # Extract the file contents and attach them to the TopLevel as a comment
+
+  def scan
+    comment = remove_coding_comment @content
+    comment = remove_private_comment comment
+
+    comment = RDoc::Comment.new comment, @top_level
+
+    @top_level.comment = comment
+    @top_level
+  end
+
+  ##
+  # Removes the encoding magic comment from +text+
+
+  def remove_coding_comment text
+    text.sub(/\A# .*coding[=:].*$/, '')
+  end
+
+  ##
+  # Removes private comments.
+  #
+  # Unlike RDoc::Comment#remove_private this implementation only looks for two
+  # dashes at the beginning of the line.  Three or more dashes are considered
+  # to be a rule and ignored.
+
+  def remove_private_comment comment
+    # Workaround for gsub encoding for Ruby 1.9.2 and earlier
+    empty = ''
+    empty.force_encoding comment.encoding if Object.const_defined? :Encoding
+
+    comment = comment.gsub(%r%^--\n.*?^\+\+\n?%m, empty)
+    comment.sub(%r%^--\n.*%m, empty)
+  end
+
+end
+

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

@@ -0,0 +1,11 @@
+##
+# Indicates this parser is text and doesn't contain code constructs.
+#
+# Include this module in a RDoc::Parser subclass to make it show up as a file,
+# not as part of a class or module.
+#--
+# This is not named File to avoid overriding ::File
+
+module RDoc::Parser::Text
+end
+

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

@@ -0,0 +1,242 @@
+##
+# A parser is simple a class that subclasses RDoc::Parser and implements #scan
+# to fill in an RDoc::TopLevel with parsed data.
+#
+# The initialize method takes an RDoc::TopLevel to fill with parsed content,
+# the name of the file to be parsed, the content of the file, an RDoc::Options
+# object and an RDoc::Stats object to inform the user of parsed items.  The
+# scan method is then called to parse the file and must return the
+# RDoc::TopLevel object.  By calling super these items will be set for you.
+#
+# In order to be used by RDoc the parser needs to register the file extensions
+# it can parse.  Use ::parse_files_matching to register extensions.
+#
+#   require 'rdoc'
+#
+#   class RDoc::Parser::Xyz < RDoc::Parser
+#     parse_files_matching /\.xyz$/
+#
+#     def initialize top_level, file_name, content, options, stats
+#       super
+#
+#       # extra initialization if needed
+#     end
+#
+#     def scan
+#       # parse file and fill in @top_level
+#     end
+#   end
+
+class RDoc::Parser
+
+  @parsers = []
+
+  class << self
+
+    ##
+    # An Array of arrays that maps file extension (or name) regular
+    # expressions to parser classes that will parse matching filenames.
+    #
+    # Use parse_files_matching to register a parser's file extensions.
+
+    attr_reader :parsers
+
+  end
+
+  ##
+  # Alias an extension to another extension. After this call, files ending
+  # "new_ext" will be parsed using the same parser as "old_ext"
+
+  def self.alias_extension(old_ext, new_ext)
+    old_ext = old_ext.sub(/^\.(.*)/, '\1')
+    new_ext = new_ext.sub(/^\.(.*)/, '\1')
+
+    parser = can_parse "xxx.#{old_ext}"
+    return false unless parser
+
+    RDoc::Parser.parsers.unshift [/\.#{new_ext}$/, parser]
+
+    true
+  end
+
+  ##
+  # Determines if the file is a "binary" file which basically means it has
+  # content that an RDoc parser shouldn't try to consume.
+
+  def self.binary?(file)
+    return false if file =~ /\.(rdoc|txt)$/
+
+    s = File.read(file, 1024) or return false
+
+    have_encoding = s.respond_to? :encoding
+
+    if have_encoding then
+      return false if s.encoding != Encoding::ASCII_8BIT and s.valid_encoding?
+    end
+
+    return true if s[0, 2] == Marshal.dump('')[0, 2] or s.index("\x00")
+
+    if have_encoding then
+      s.force_encoding Encoding.default_external
+
+      not s.valid_encoding?
+    else
+      if 0.respond_to? :fdiv then
+        s.count("\x00-\x7F", "^ -~\t\r\n").fdiv(s.size) > 0.3
+      else # HACK 1.8.6
+        (s.count("\x00-\x7F", "^ -~\t\r\n").to_f / s.size) > 0.3
+      end
+    end
+  end
+
+  ##
+  # Processes common directives for CodeObjects for the C and Ruby parsers.
+  #
+  # Applies +directive+'s +value+ to +code_object+, if appropriate
+
+  def self.process_directive code_object, directive, value
+    warn "RDoc::Parser::process_directive is deprecated and wil be removed in RDoc 4.  Use RDoc::Markup::PreProcess#handle_directive instead" if $-w
+
+    case directive
+    when 'nodoc' then
+      code_object.document_self = nil # notify nodoc
+      code_object.document_children = value.downcase != 'all'
+    when 'doc' then
+      code_object.document_self = true
+      code_object.force_documentation = true
+    when 'yield', 'yields' then
+      # remove parameter &block
+      code_object.params.sub!(/,?\s*&\w+/, '') if code_object.params
+
+      code_object.block_params = value
+    when 'arg', 'args' then
+      code_object.params = value
+    end
+  end
+
+  ##
+  # Checks if +file+ is a zip file in disguise.  Signatures from
+  # http://www.garykessler.net/library/file_sigs.html
+
+  def self.zip? file
+    zip_signature = File.read file, 4
+
+    zip_signature == "PK\x03\x04" or
+      zip_signature == "PK\x05\x06" or
+      zip_signature == "PK\x07\x08"
+  end
+
+  ##
+  # Return a parser that can handle a particular extension
+
+  def self.can_parse(file_name)
+    parser = RDoc::Parser.parsers.find { |regexp,| regexp =~ file_name }.last
+
+    # HACK Selenium hides a jar file using a .txt extension
+    return if parser == RDoc::Parser::Simple and zip? file_name
+
+    # The default parser must not parse binary files
+    ext_name = File.extname file_name
+    return parser if ext_name.empty?
+    return if parser == RDoc::Parser::Simple and ext_name !~ /txt|rdoc/
+
+    parser
+  end
+
+  ##
+  # Finds and instantiates the correct parser for the given +file_name+ and
+  # +content+.
+
+  def self.for top_level, file_name, content, options, stats
+    return if binary? file_name
+
+    parser = use_markup content
+
+    unless parser then
+      # If no extension, look for shebang
+      if file_name !~ /\.\w+$/ && content =~ %r{\A#!(.+)} then
+        shebang = $1
+        case shebang
+        when %r{env\s+ruby}, %r{/ruby}
+          file_name = "dummy.rb"
+        end
+      end
+
+      parser = can_parse file_name
+    end
+
+    return unless parser
+
+    parser.new top_level, file_name, content, options, stats
+  end
+
+  ##
+  # Record which file types this parser can understand.
+  #
+  # It is ok to call this multiple times.
+
+  def self.parse_files_matching(regexp)
+    RDoc::Parser.parsers.unshift [regexp, self]
+  end
+
+  ##
+  # If there is a <tt>markup: parser_name</tt> comment at the front of the
+  # file, use it to determine the parser.  For example:
+  #
+  #   # markup: rdoc
+  #   # Class comment can go here
+  #
+  #   class C
+  #   end
+  #
+  # The comment should appear as the first line of the +content+.
+  #
+  # If the content contains a shebang or editor modeline the comment may
+  # appear on the second or third line.
+  #
+  # Any comment style may be used to hide the markup comment.
+
+  def self.use_markup content
+    markup = content.lines.first(3).grep(/markup:\s+(\w+)/) { $1 }.first
+
+    return unless markup
+
+    return RDoc::Parser::Ruby if markup == 'tomdoc'
+
+    markup = Regexp.escape markup
+
+    RDoc::Parser.parsers.find do |_, parser|
+      /^#{markup}$/i =~ parser.name.sub(/.*:/, '')
+    end.last
+  end
+
+  ##
+  # Creates a new Parser storing +top_level+, +file_name+, +content+,
+  # +options+ and +stats+ in instance variables.  In +@preprocess+ an
+  # RDoc::Markup::PreProcess object is created which allows processing of
+  # directives.
+
+  def initialize top_level, file_name, content, options, stats
+    @top_level = top_level
+    @top_level.parser = self.class
+
+    @file_name = file_name
+    @content = content
+    @options = options
+    @stats = stats
+
+    @preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
+    @preprocess.options = @options
+  end
+
+  autoload :RubyTools, 'rdoc/parser/ruby_tools'
+  autoload :Text,      'rdoc/parser/text'
+
+end
+
+# simple must come first in order to show up last in the parsers list
+require 'rdoc/parser/simple'
+require 'rdoc/parser/rd'
+require 'rdoc/parser/ruby'
+require 'rdoc/parser/c'
+