voloko-sdoc 0.1.7 → 0.1.9

data/rdoc/lib/rdoc/task.rb

@@ -1,276 +0,0 @@
-# Copyright (c) 2003, 2004 Jim Weirich, 2009 Eric Hodel
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require 'rubygems'
-begin
-  gem 'rdoc'
-rescue Gem::LoadError
-end
-
-begin
-  gem 'rake'
-rescue Gem::LoadError
-end
-
-require 'rdoc'
-require 'rake'
-require 'rake/tasklib'
-
-##
-# Create a documentation task that will generate the RDoc files for a project.
-#
-# The RDoc::Task will create the following targets:
-#
-# [<b><em>rdoc</em></b>]
-#   Main task for this RDoc task.
-#
-# [<b>:clobber_<em>rdoc</em></b>]
-#   Delete all the rdoc files.  This target is automatically added to the main
-#   clobber target.
-#
-# [<b>:re<em>rdoc</em></b>]
-#   Rebuild the rdoc files from scratch, even if they are not out of date.
-#
-# Simple Example:
-#
-#   RDoc::Task.new do |rd|
-#     rd.main = "README.rdoc"
-#     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
-#   end
-#
-# The +rd+ object passed to the block is an RDoc::Task object. See the
-# attributes list for the RDoc::Task class for available customization options.
-#
-# == Specifying different task names
-#
-# You may wish to give the task a different name, such as if you are
-# generating two sets of documentation.  For instance, if you want to have a
-# development set of documentation including private methods:
-#
-#   RDoc::Task.new :rdoc_dev do |rd|
-#     rd.main = "README.doc"
-#     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
-#     rd.options << "--all"
-#   end
-#
-# The tasks would then be named :<em>rdoc_dev</em>,
-# :clobber_<em>rdoc_dev</em>, and :re<em>rdoc_dev</em>.
-#
-# If you wish to have completely different task names, then pass a Hash as
-# first argument. With the <tt>:rdoc</tt>, <tt>:clobber_rdoc</tt> and
-# <tt>:rerdoc</tt> options, you can customize the task names to your liking.
-#
-# For example:
-#
-#   RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
-#                  :rerdoc => "rdoc:force")
-#
-# This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc_clean</tt> and
-# <tt>:rdoc:force</tt>.
-
-class RDoc::Task < Rake::TaskLib
-
-  ##
-  # Name of the main, top level task.  (default is :rdoc)
-
-  attr_accessor :name
-
-  ##
-  # Name of directory to receive the html output files. (default is "html")
-
-  attr_accessor :rdoc_dir
-
-  ##
-  # Title of RDoc documentation. (defaults to rdoc's default)
-
-  attr_accessor :title
-
-  ##
-  # Name of file to be used as the main, top level file of the RDoc. (default
-  # is none)
-
-  attr_accessor :main
-
-  ##
-  # Name of template to be used by rdoc. (defaults to rdoc's default)
-
-  attr_accessor :template
-
-  ##
-  # List of files to be included in the rdoc generation. (default is [])
-
-  attr_accessor :rdoc_files
-
-  ##
-  # Additional list of options to be passed rdoc.  (default is [])
-
-  attr_accessor :options
-
-  ##
-  # Whether to run the rdoc process as an external shell (default is false)
-
-  attr_accessor :external
-
-  ##
-  # Create an RDoc task with the given name. See the RDoc::Task class overview
-  # for documentation.
-
-  def initialize(name = :rdoc)  # :yield: self
-    if name.is_a? Hash then
-      invalid_options = name.keys.map { |k| k.to_sym } -
-        [:rdoc, :clobber_rdoc, :rerdoc]
-
-      unless invalid_options.empty? then
-        raise ArgumentError, "invalid options: #{invalid_options.join(", ")}"
-      end
-    end
-
-    @name = name
-    @rdoc_files = Rake::FileList.new
-    @rdoc_dir = 'html'
-    @main = nil
-    @title = nil
-    @template = nil
-    @external = false
-    @options = []
-    yield self if block_given?
-    define
-  end
-
-  ##
-  # Create the tasks defined by this task lib.
-
-  def define
-    if rdoc_task_name != "rdoc" then
-      desc "Build the RDoc HTML Files"
-    else
-      desc "Build the #{rdoc_task_name} HTML Files"
-    end
-    task rdoc_task_name
-
-    desc "Force a rebuild of the RDoc files"
-    task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
-
-    desc "Remove RDoc products"
-    task clobber_task_name do
-      rm_r rdoc_dir rescue nil
-    end
-
-    task :clobber => [clobber_task_name]
-
-    directory @rdoc_dir
-    task rdoc_task_name => [rdoc_target]
-    file rdoc_target => @rdoc_files + [Rake.application.rakefile] do
-      rm_r @rdoc_dir rescue nil
-      @before_running_rdoc.call if @before_running_rdoc
-      args = option_list + @rdoc_files
-
-      if @external then
-        argstring = args.join(' ')
-        sh %{ruby -Ivendor vendor/rd #{argstring}}
-      else
-        if Rake.application.options.trace then
-          $stderr.puts "rdoc #{args.join ' '}"
-        end
-        require 'rdoc/rdoc'
-        RDoc::RDoc.new.document(args)
-      end
-    end
-
-    self
-  end
-
-  def option_list
-    result = @options.dup
-    result << "-o" << @rdoc_dir
-    result << "--main" << quote(main) if main
-    result << "--title" << quote(title) if title
-    result << "-T" << quote(template) if template
-    result
-  end
-
-  def quote(str)
-    if @external
-      "'#{str}'"
-    else
-      str
-    end
-  end
-
-  def option_string
-    option_list.join(' ')
-  end
-
-  ##
-  # The block passed to this method will be called just before running the
-  # RDoc generator. It is allowed to modify RDoc::Task attributes inside the
-  # block.
-
-  def before_running_rdoc(&block)
-    @before_running_rdoc = block
-  end
-
-  private
-
-  def rdoc_target
-    "#{rdoc_dir}/index.html"
-  end
-
-  def rdoc_task_name
-    case name
-    when Hash
-      (name[:rdoc] || "rdoc").to_s
-    else
-      name.to_s
-    end
-  end
-
-  def clobber_task_name
-    case name
-    when Hash
-      (name[:clobber_rdoc] || "clobber_rdoc").to_s
-    else
-      "clobber_#{name}"
-    end
-  end
-
-  def rerdoc_task_name
-    case name
-    when Hash
-      (name[:rerdoc] || "rerdoc").to_s
-    else
-      "re#{name}"
-    end
-  end
-
-end
-
-# :stopdoc:
-module Rake
-
-  ##
-  # For backwards compatibility
-
-  RDocTask = RDoc::Task
-
-end
-# :startdoc:
-

data/rdoc/lib/rdoc/tokenstream.rb

@@ -1,33 +0,0 @@
-module RDoc; end
-
-##
-# A TokenStream is a list of tokens, gathered during the parse of some entity
-# (say a method). Entities populate these streams by being registered with the
-# lexer. Any class can collect tokens by including TokenStream. From the
-# outside, you use such an object by calling the start_collecting_tokens
-# method, followed by calls to add_token and pop_token.
-
-module RDoc::TokenStream
-
-  def token_stream
-    @token_stream
-  end
-
-  def start_collecting_tokens
-    @token_stream = []
-  end
-
-  def add_token(tk)
-    @token_stream << tk
-  end
-
-  def add_tokens(tks)
-    tks.each  {|tk| add_token(tk)}
-  end
-
-  def pop_token
-    @token_stream.pop
-  end
-
-end
-

data/rdoc/lib/rdoc/top_level.rb

@@ -1,242 +0,0 @@
-require 'thread'
-require 'rdoc/context'
-
-##
-# A TopLevel context is a representation of the contents of a single file
-
-class RDoc::TopLevel < RDoc::Context
-
-  ##
-  # This TopLevel's File::Stat struct
-
-  attr_accessor :file_stat
-
-  ##
-  # Relative name of this file
-
-  attr_accessor :relative_name
-
-  ##
-  # Absolute name of this file
-
-  attr_accessor :absolute_name
-
-  attr_accessor :diagram
-
-  ##
-  # The parser that processed this file
-
-  attr_accessor :parser
-
-  ##
-  # Returns all classes and modules discovered by RDoc
-
-  def self.all_classes_and_modules
-    classes_hash.values + modules_hash.values
-  end
-
-  ##
-  # Returns all classes discovered by RDoc
-
-  def self.classes
-    classes_hash.values
-  end
-
-  ##
-  # Hash of all classes known to RDoc
-
-  def self.classes_hash
-    @all_classes
-  end
-
-  ##
-  # All TopLevels known to RDoc
-
-  def self.files
-    @all_files.values
-  end
-
-  ##
-  # Hash of all files known to RDoc
-
-  def self.files_hash
-    @all_files
-  end
-
-  ##
-  # Finds the class with +name+ in all discovered classes
-
-  def self.find_class_named(name)
-    @lock.synchronize do
-      classes_hash.values.find do |c|
-        c.find_class_named name
-      end
-    end
-  end
-
-  ##
-  # Finds the file with +name+ in all discovered files
-
-  def self.find_file_named(name)
-    @lock.synchronize do
-      @all_files[name]
-    end
-  end
-
-  ##
-  # Finds the module with +name+ in all discovered modules
-
-  def self.find_module_named(name)
-    @lock.synchronize do
-      modules_hash.values.find do |c|
-        c.find_module_named name
-      end
-    end
-  end
-
-  @lock = Mutex.new
-
-  ##
-  # Lock for global class, module and file stores
-
-  def self.lock
-    @lock
-  end
-
-  ##
-  # Returns all modules discovered by RDoc
-
-  def self.modules
-    modules_hash.values
-  end
-
-  ##
-  # Hash of all modules known to RDoc
-
-  def self.modules_hash
-    @all_modules
-  end
-
-  ##
-  # Empties RDoc of stored class, module and file information
-
-  def self.reset
-    @lock.synchronize do
-      @all_classes = {}
-      @all_modules = {}
-      @all_files   = {}
-    end
-  end
-
-  reset
-
-  ##
-  # Creates a new TopLevel for +file_name+
-
-  def initialize(file_name)
-    super()
-    @name = nil
-    @relative_name = file_name
-    @absolute_name = file_name
-    @file_stat     = File.stat(file_name) rescue nil # HACK for testing
-    @diagram       = nil
-    @parser        = nil
-
-    RDoc::TopLevel.lock.synchronize do
-      RDoc::TopLevel.files_hash[file_name] = self
-    end
-  end
-
-  ##
-  # Adds +method+ to Object instead of RDoc::TopLevel
-
-  def add_method(method)
-    object = self.class.find_class_named 'Object'
-    object = add_class RDoc::NormalClass, 'Object' unless object
-
-    object.add_method method
-  end
-
-  ##
-  # Base name of this file
-
-  def base_name
-    File.basename @absolute_name
-  end
-
-  ##
-  # Find class or module named +symbol+ in all discovered classes and
-  # modules
-
-  def find_class_or_module_named(symbol)
-    RDoc::TopLevel.classes_hash.each_value do |c|
-      return c if c.full_name == symbol
-    end
-
-    RDoc::TopLevel.modules_hash.each_value do |m|
-      return m if m.full_name == symbol
-    end
-
-    nil
-  end
-
-  ##
-  # Finds a class or module named +symbol+
-
-  def find_local_symbol(symbol)
-    find_class_or_module_named(symbol) || super
-  end
-
-  ##
-  # Finds a module or class with +name+
-
-  def find_module_named(name)
-    find_class_or_module_named(name) || find_enclosing_module_named(name)
-  end
-
-  ##
-  # The name of this file
-
-  def full_name
-    @relative_name
-  end
-
-  ##
-  # URL for this with a +prefix+
-
-  def http_url(prefix)
-    path = [prefix, @relative_name.tr('.', '_')]
-
-    File.join(*path.compact) + '.html'
-  end
-
-  def inspect # :nodoc:
-    "#<%s:0x%x %p modules: %p classes: %p>" % [
-      self.class, object_id,
-      base_name,
-      @modules.map { |n,m| m },
-      @classes.map { |n,c| c }
-    ]
-  end
-
-  ##
-  # Date this file was last modified, if known
-
-  def last_modified
-    @file_stat ? file_stat.mtime.to_s : 'Unknown'
-  end
-
-  ##
-  # Base name of this file
-
-  alias name base_name
-
-  ##
-  # Path to this file
-
-  def path
-    http_url RDoc::RDoc.current.generator.file_dir
-  end
-
-end
-