doc 0.4.0 → 0.4.1

data/README.markdown

@@ -44,18 +44,18 @@ Successor of [sdoc_all](https://github.com/toy/sdoc_all).
 
 Specify what to document using:
 
-- `source`: path to ruby source
-- `archive`: path to archive with ruby source (bzipped tar, gzipped tar or zip)
-- `version`: ruby version in form X.Y, X.Y.Z or X.Y.Z-pPPP. Source will be downloaded from github.com/ruby/ruby or ruby-lang.org
-- `binary`: command which is asked to run code to automatically determine ruby version. Source will be downloaded as for version specifier
+- `source` — path to ruby source
+- `archive` — path to archive with ruby source (bzipped tar, gzipped tar or zip)
+- `version` — ruby version in form X.Y, X.Y.Z or X.Y.Z-pPPP. Source will be downloaded from github.com/ruby/ruby or ruby-lang.org
+- `binary` — command which is asked to run code to automatically determine ruby version. Source will be downloaded as for version specifier
 
 All those specifiers accepts multiple entries. Default option is `binary`, 'ruby' binary is used if version is not specified.
 
 Other options:
 
-- `format`: can be `:all` to simply document all code, `:separate` to build core documentation and stdlib documentation separately and `:integrate` to integrate all stdlib to core
-- `except`: skip documenting certain parts (like `win32ole` and `tk`)
-- `index`: specify folder containing index.html to replace front page. Good place for cheat sheet or quick ref like one downloaded from [zenspider](http://www.zenspider.com/Languages/Ruby/QuickRef.html).
+- `format` — can be `:all` to simply document all code, `:separate` to build core documentation and stdlib documentation separately and `:integrate` to integrate all stdlib to core
+- `except` — skip documenting certain parts (like `win32ole` and `tk`)
+- `index` — specify folder containing index.html to replace front page. Good place for cheat sheet or quick ref like one downloaded from [zenspider](http://www.zenspider.com/Languages/Ruby/QuickRef.html).
 
 ### rails
 
@@ -83,4 +83,4 @@ Use `:title` to specify title, it must be a proc receiving path and returning ti
 
 ## Copyright
 
-Copyright (c) 2010-2011 Ivan Kuchin. See LICENSE.txt for details.
+Copyright (c) 2010-2012 Ivan Kuchin. See LICENSE.txt for details.

data/doc.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'doc'
-  s.version     = '0.4.0'
+  s.version     = '0.4.1'
   s.summary     = %q{Get all ruby documentation in one place}
   s.description = %Q{Generate `Rakefile` with `docr` and get searchable documentation for ruby, rails, gems, plugins and all other ruby code in one place}
   s.homepage    = "http://github.com/toy/#{s.name}"

data/lib/doc/configurator/gems.rb

@@ -7,7 +7,7 @@ module Doc
         config.check_options!([], [[:only, :except], :versions, :prerelease])
 
         [:only, :except].each do |key|
-          config[key] = Array(config[key]).map(&:to_s) if config[key]
+          config[key] = Array(config[key]).flatten.map(&:to_s) if config[key]
         end
 
         @prerelease = !!config[:prerelease]

data/lib/doc/configurator/ruby/stdlib.rb

@@ -7,24 +7,30 @@ module Doc
     class Ruby
       module Stdlib
         STDLIB_CONFIG_URL = 'http://stdlib-doc.rubyforge.org/svn/trunk/data/gendoc.yaml'
+        STDLIB_CONFIG_NAME = 'stdlib-config.yaml'
+        STDLIB_CONFIG_VENDOR_PATH = FSPath(__FILE__).dirname / '../../../../vendor' / STDLIB_CONFIG_NAME
 
         def stdlib_config(update)
           if update || !read_stdlib_config
             download_stdlib_config
           end
-          read_stdlib_config
+          read_stdlib_config || YAML.load_file(STDLIB_CONFIG_VENDOR_PATH)
         end
 
         def stdlib_config_path
-          sources_dir / 'stdlib-config.yaml'
+          sources_dir / STDLIB_CONFIG_NAME
         end
 
         def read_stdlib_config
-          YAML.load_file stdlib_config_path if stdlib_config_path.readable?
+          YAML.load_file stdlib_config_path if stdlib_config_path.size?
         end
 
         def download_stdlib_config
-          stdlib_config_path.write(Net::HTTP.get(URI.parse(STDLIB_CONFIG_URL)))
+          url = URI.parse(STDLIB_CONFIG_URL)
+          response = Net::HTTP.start(url.host, url.port){ |http| http.get(url.path) }
+          if response.kind_of?(Net::HTTPSuccess)
+            stdlib_config_path.write(response.body)
+          end
         end
       end
     end

data/vendor/stdlib-config.yaml

@@ -0,0 +1,692 @@
+#FIELDS:
+#  - target: >
+#                The name of the target; this directory will be used to hold
+#                docs.
+#  - section: >
+#                'stdlib' for standard library, 'ext' for standard library
+#                extensions (compiled), 'core' for core Ruby classes, 'extra'
+#                for others.
+#  - base: >
+#                Useful only if section is 'extra'.  The base directory of the
+#                package.
+#  - extra_sources: >
+#                List of special files relative to base, that need to be
+#                RDoc'ed in addition to the obvious ones.
+#  - mainpage: >
+#                Feeds to RDoc's '--main' option.  Optional.
+#  - desciption: >
+#                Description of the package for overview page.
+  
+
+targets:
+
+  - target: abbrev
+    section: stdlib
+    description: |
+      Calculates the set of unique abbreviations for a given set of strings.
+
+
+  - target: base64
+    section: stdlib
+    description: |
+      Methods for base64-encoding and -decoding strings.
+
+
+  - target: benchmark
+    section: stdlib
+    description: |
+      Contains routines for benchmarking code.
+
+
+  - target:  cgi
+    section: stdlib
+    mainpage: cgi.rb
+    description: |
+      CGI library, including methods for query parsing, HTML generation and
+      session handling.
+
+
+  - target: complex
+    section: stdlib
+    description: |
+      Implements a complex number type, Complex.
+
+
+  - target: csv
+    section: stdlib
+    description: |
+      Read and write CSV (comma separated values) data.
+
+
+  - target: date
+    section: stdlib
+    score: 7
+    description: |
+      Implements the Date class.
+
+
+  - target: delegate
+    section: stdlib
+    description: |
+      Simplifies delegation to methods of other classes.
+
+
+  - target: drb
+    section: stdlib
+    mainpage: drb/drb.rb
+    score: 7
+    description: |
+      Distributed Ruby.  Talk to objects across a network.
+
+
+  - target: English
+    section: stdlib
+    description: |
+      "English-language long names for Ruby's special variables."
+
+
+  - target: erb
+    section: stdlib
+    description: |
+      "Templating system whereby you embed Ruby code in text/HTML/..."
+
+
+  - target: fileutils
+    section: stdlib
+    description: |
+      Utility module for copying, moving, renaming files, etc.
+
+
+  - target: finalize
+    section: stdlib
+    description: |
+
+
+  - target: find
+    section: stdlib
+    description: |
+      Recursively descend directories.
+
+
+  - target: forwardable
+    section: stdlib
+    description: |
+      Method-level delegation.
+
+
+  - target: ftools
+    section: stdlib
+    description: |
+      Similar to, but older than, fileutils.
+
+
+  - target: generator
+    section: stdlib
+    description: |
+      Converts an internal iterator to an external iterator.
+
+
+  - target: getoptlong
+    section: stdlib
+    description: |
+      A common library for parsing command-line options.  See optparse for a stronger
+      Ruby solution.
+
+
+  - target: gserver
+    section: stdlib
+    description: |
+      Generic server.
+
+
+  - target: importenv
+    section: stdlib
+    description: |
+      Imports environment variables as global variables.
+
+
+  - target: ipaddr
+    section: stdlib
+    description: |
+      Manipulate IP addresses.
+
+
+  - target: jcode
+    section: stdlib
+    description: |
+      Handle Japanese strings.
+
+
+  - target: logger
+    section: stdlib
+    description: |
+      Simple logging mechanism.
+
+
+  - target: mailread
+    section: stdlib
+    description: |
+
+
+  - target: mathn
+    section: stdlib
+    description: |
+      Make all numeric classes work well together.
+
+
+  - target: matrix
+    section: stdlib
+    description: |
+      Defines the Matrix and Vector classes.
+
+
+  - target: mkmf
+    section: stdlib
+    description: |
+      Generate Makefiles for Ruby extensions.
+
+
+  - target: monitor
+    section: stdlib
+    description: |
+      Add monitor function to an arbitrary object.
+
+
+  - target: mutex_m
+    section: stdlib
+    description: |
+
+
+  - target: net/ftp
+    section: stdlib
+    description: |
+      FTP library for accessing remote files.
+
+
+  - target: net/http
+    section: stdlib
+    description: |
+      HTTP library for accessing web pages.
+
+
+  - target: net/imap
+    section: stdlib
+    description: |
+      IMAP library for accessing email on a server.
+
+
+  - target: net/pop
+    section: stdlib
+    description: |
+      POP library for accessing email on a server.
+
+
+  - target: net/smtp
+    section: stdlib
+    description: |
+      SMTP library for sending email.
+
+
+  - target: net/telnet
+    section: stdlib
+    description: |
+      Telnet library for executing commands remotely.
+
+
+  - target: observer
+    section: stdlib
+    description: |
+      Implements the observer pattern; objects can be notified of changes to
+      other objects.
+
+
+  - target: open-uri
+    section: stdlib
+    description: |
+      Allows file-like access to URIs like "ftp://server/filename".
+
+
+  - target: open3
+    section: stdlib
+    description: |
+      Run external commands and have access to stdin, stdout, and stderr.
+
+
+  - target: optparse
+    section: stdlib
+    score: 6
+    description: |
+      A more advanced command-line options parsing library than getoptlong.
+
+
+  - target: ostruct
+    section: stdlib
+    description: |
+      Open structs.  You can add attributes dynamically.
+
+
+  - target: parsedate
+    section: stdlib
+    description: |
+      A module for extracting date information from a String.
+
+
+  - target: pathname
+    section: stdlib
+    description: |
+      Object-oriented pathname.
+
+
+  - target: ping
+    section: stdlib
+    description: |
+      Simple 'ping' implementation.
+
+
+  - target: pp
+    section: stdlib
+    description: |
+      Implements Kernel.pp so you can pretty-print any object.
+
+
+  - target: prettyprint
+    section: stdlib
+    description: |
+      Implements a pretty-printing algorithm.  See 'pp'.
+
+
+  - target: profile
+    section: stdlib
+    description: |
+      Runtime profiler.
+
+
+  - target: profiler
+    section: stdlib
+    description: |
+      Runtime profiling library.
+
+
+  - target: pstore
+    section: stdlib
+    description: |
+      Simple object-oriented database using Marshal.
+
+
+  - target: racc/parser
+    section: stdlib
+    description: |
+
+
+  - target: rational
+    section: stdlib
+    description: |
+      Implements a rational number type, Rational.
+
+
+  - target: rdoc
+    section: stdlib
+    extra_sources: rdoc/README
+    mainpage: rdoc/README
+    description: |
+      "Ruby's API documentation generator."
+
+
+  - target: readbytes
+    section: stdlib
+    description: |
+      Implements IO#readbytes.
+
+
+  - target: resolv-replace
+    section: stdlib
+    description: |
+
+
+  - target: resolv
+    section: stdlib
+    description: |
+      Find IP address from hostname, or vice versa, and more.
+
+
+  - target: rexml
+    section: stdlib
+    mainpage: rexml/rexml.rb
+    description: |
+      Pure-Ruby XML parser and emitter.
+
+
+  - target: rinda
+    section: stdlib
+    mainpage: rinda/rinda.rb
+    description: |
+      A Ruby implementation of the Linda distibuted computing paradigm.
+
+
+  - target: rss
+    section: stdlib
+    mainpage: rss/rss.rb
+    description: |
+      RSS (Rich Site Syndicator) parser and emitter.
+
+
+  - target: runit
+    section: stdlib
+    mainpage: runit/testcase.rb
+    description: |
+      Older unit testing framework.  Taken over by test/unit.
+
+
+  - target: scanf
+    section: stdlib
+    description: |
+      "Analogous to C's scanf.  Reads formatted data."
+
+
+  - target: set
+    section: stdlib
+    description: |
+      Implements the Set data type.
+
+
+  - target: shell
+    section: stdlib
+    description: |
+      Enables shell-like activities in plain Ruby.
+
+
+  - target: singleton
+    section: stdlib
+    description: |
+      Implements the singleton design pattern, whereby a certain class has only one
+      instance.
+
+
+  - target: soap
+    section: stdlib
+    mainpage: soap/soap.rb
+    description: |
+      Implements the SOAP protocol.
+
+
+  - target: sync
+    section: stdlib
+    description: |
+      Phase lock with counter.
+
+
+  - target: tempfile
+    section: stdlib
+    description: |
+      Create and use a temporary file.
+
+
+  - target: test/unit
+    section: stdlib
+    mainpage: test/unit.rb
+    description: |
+      "Ruby's standard unit testing framework."
+
+
+  - target: thread
+    section: stdlib
+    description: |
+      Support for threads, including Mutex, ConditionVariable, and Queue.
+
+
+  - target: thwait
+    section: stdlib
+    description: |
+      Thread synchronization class.
+
+
+  - target: time
+    section: stdlib
+    description: |
+      Extends built-in Time class to support various standard time formats.
+
+
+  - target: timeout
+    section: stdlib
+    description: |
+      Ensures some code completes within a certain time, or throws exception.
+
+
+  - target: tmpdir
+    section: stdlib
+    description: |
+      Retrieve temporary directory path.
+
+
+  - target: tracer
+    section: stdlib
+    description: |
+      Trace program execution.
+
+
+  - target: tsort
+    section: stdlib
+    description: |
+      Topological sorting for strongly connected components.
+
+
+  - target: un
+    section: stdlib
+    description: |
+      Utility module for file operations in command-line scripts.
+
+
+  - target: uri
+    section: stdlib
+    description: |
+      Universal Resource Identifier implementation.
+
+
+  - target: weakref
+    section: stdlib
+    description: |
+      Implements weak references.
+
+
+  - target: webrick
+    section: stdlib
+    description: |
+      A servlet container and self-contained web server.
+
+
+  - target: wsdl
+    section: stdlib
+    mainpage: wsdl/wsdl.rb
+    description: |
+      Web Services Description Language.
+
+
+  - target: xmlrpc
+    section: stdlib
+    extra_sources: xmlrpc/README.txt
+    mainpage: xmlrpc/README.txt
+    description: |
+      XML RPC (remote procedure call) client and server implementations.
+
+
+  - target: xsd
+    section: stdlib
+    mainpage: xsd/xmlparser.rb
+    description: |
+       XML Schema Definition.
+
+
+  - target: yaml
+    section: stdlib
+    description: |
+      Data serialization format designed for ease of human use.
+
+
+####
+#### 'ext' targets
+####
+
+
+  - target: bigdecimal
+    section: ext
+    description: |
+      Arbitrary-precision arithmetic.
+
+
+  - target: curses
+    section: ext
+    description: |
+      Interface to the "curses" character-based interface library.
+
+
+  - target: dbm
+    section: ext
+    description: |
+      Read and write 'db' files.
+
+
+  - target: digest
+    section: ext
+    description: |
+      MD5 and SHA1 digest implementations.
+
+
+  - target: dl
+    section: ext
+    description: |
+      "Interface to the Dynamic Loader, for creating extensions."
+
+
+  - target: enumerator
+    section: ext
+    mainpage: Enumerable
+    description: |
+      Flexible enumeration capabilities.
+
+
+  - target: etc
+    section: ext
+    mainpage: Etc
+    description: |
+      Access to UNIX users and groups information.
+
+
+  - target: fcntl
+    section: ext
+    mainpage: Fcntl
+    description: |
+      Provides constant definitions for IO#fcntl.
+
+
+  - target: gdbm
+    section: ext
+    description: |
+      Read and write GNU 'db' files.
+
+
+  - target: iconv
+    section: ext
+    description: |
+
+
+  - target: io/wait
+    section: ext
+    description: |
+
+
+  - target: nkf
+    section: ext
+    description: |
+
+
+  - target: openssl
+    section: ext
+    description: |
+      Secure socket layer, including HTTP, FTP, and Telnet implementations.
+
+
+  - target: pty
+    section: ext
+    description: |
+      Executes commands as if their standard I/O is connected to ttys.
+
+
+  - target: racc
+    section: ext
+    description: |
+      "LALR(1) parser generator for Ruby."
+
+
+  - target: readline
+    section: ext
+    description: |
+      Command-line editing and history.
+
+
+  - target: sdbm
+    section: ext
+    description: |
+      Yet another 'db' file interface.
+
+
+  - target: socket
+    section: ext
+    description: |
+      Implements several socket classes for UDP, TCP, UNIX, SOCKS, as well as
+      a TCPServer class.
+
+
+  - target: stringio
+    section: ext
+    description: |
+      Implements StringIO, which allows IO-like operations on a String-like
+      object.
+
+
+  - target: strscan
+    section: ext
+    description: |
+      A fast string scanner.
+
+
+  - target: syck
+    section: ext
+    description: |
+      Fast YAML implementation.
+
+
+  - target: syslog
+    section: ext
+    description: |
+      Wrapper for UNIX Syslog system calls.
+
+
+  - target: tcltklib
+    section: ext
+    description: |
+
+
+  - target: tk
+    section: ext
+    exclude: sample
+    description: |
+
+
+  - target: Win32API
+    section: ext
+    description: |
+      Interface to Windows registry.
+
+
+  - target: win32ole
+    section: ext
+    description: |
+      Interface to Win32 OLE automation.
+
+
+  - target: zlib
+    section: ext
+    description: |
+      Interface to UNIX zlib (gzip streams).
+
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: doc
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Ivan Kuchin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-22 00:00:00 Z
+date: 2012-12-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sdoc
@@ -126,6 +126,7 @@ files:
 - lib/doc/root_config.rb
 - lib/doc/root_merger.rb
 - lib/doc/tasks.rb
+- vendor/stdlib-config.yaml
 homepage: http://github.com/toy/doc
 licenses: 
 - MIT
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: doc
-rubygems_version: 1.8.13
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Get all ruby documentation in one place