rdoc-shomen 0.1.1

data/.ruby

@@ -0,0 +1,62 @@
+---
+source:
+- meta
+authors:
+- name: trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2011'
+  license: BSD-2-Clause
+requirements:
+- name: shomen-model
+- name: citron
+  groups:
+  - test
+  development: true
+- name: detroit
+  groups:
+  - build
+  development: true
+dependencies: []
+alternatives: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/rdoc-shomen.git
+  scm: git
+  name: upstream
+resources:
+- uri: http://rubyworks.github.com/rdoc-shomen
+  name: home
+  type: home
+- uri: http://rubydoc.info/gems/rdoc-shoment
+  name: docs
+  type: doc
+- uri: http://github.com/rubyworks/rdoc-shomen
+  name: code
+  type: code
+- uri: http://github.com/rubyworks/rdoc-shomen/issues
+  name: bugs
+  type: bugs
+- uri: http://groups.google.com/groups/rubyworks-mailinglist
+  name: mail
+  type: mail
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2010-07-01'
+summary: RDoc Generator for Shomen Documentation Format
+title: RDoc Shomen
+version: 0.1.1
+name: rdoc-shomen
+description: ! 'RDoc-Shomen is an RDoc generator plugin that can be used to generate
+  Shomen
+
+  documentation. This is an alternative to the shomen command line tool which
+
+  use the `.rdoc` cache to generate a shomen document. In contrast the rdoc-shomen
+
+  generator operates as a traditional rdoc plugin.'
+organization: rubyworks
+date: '2012-04-16'

data/Confile.rb

@@ -0,0 +1,5 @@
+
+config :rubytest do |run|
+  run.files < 'test/case_*.rb'
+end
+

data/HISTORY.rdoc

@@ -0,0 +1,20 @@
+= RELEASE HISTORY
+
+== 0.1.1 | 2012-04-20
+
+This release simple uses the new shomen-model gem,
+instead of the previous shomen gem.
+
+Changes:
+
+* Use shomen-model instead of shomen.
+
+
+== 0.1.0 | 2012-04-18
+
+This is the first release of rdoc-shomen.
+
+Changes:
+
+* Happy first release day!
+

data/LICENSE.txt

@@ -0,0 +1,30 @@
+RDoc Shomen - Shomen Generator for RDoc
+
+Copyright (c) 2011 Rubyworks. All rights reserved. 
+
+Licensed (spdx) BSD-2-Clause
+
+Redistribution and use in source and binary forms,
+with or without modification, are permitted provided that the following
+conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(http://github.com/rubyworks/rdoc-shomen)
+

data/README.rdoc

@@ -0,0 +1,42 @@
+= Shomen RDoc Generator
+
+{Homepage}[http://rubyworks.github.com/rdoc-shomen] /
+{Report Issue}[http://github.com/rubyworks/rdoc-shomen/issues] /
+{Source Code}[http://github.com/rubyworks/rdoc-shomen] /
+{Mailing List}[http://google.groups.com/groups/rubyworks-mailinglist]
+
+{<img src="https://secure.travis-ci.org/rubyworks/rdoc-shomen.png" />}[http://travis-ci.org/rubyworks/rdoc-shomen]
+
+
+== Description
+
+This is the old-school Shomen generator for RDoc.
+
+
+== Instruction
+
+Use the shomen generator like any other RDoc generator.
+
+  $ rdoc -f shomen -m README.rdoc lib [A-Z]*.*
+
+The shomen document will be saved to the output directory (default `doc`)
+as wither `doc.json` or as `<name>-<version>.json` if project metadata is
+discoverable.
+
+The generator supports a couple of special options:
+
+* `--yaml` option will save the file to YAML format instead of JSON.
+* `--source` will include full source code in script entries.
+
+The `--source` option is not recommended for documentation that will
+be served online as it will make the documation file rather large.
+
+
+== Copyrights
+
+Copyright (c) 2011 Rubyworks. All rights reserved.
+
+RDoc Shomen is distributable in accordance with the *BSD-2-Clause* license.
+
+See LICENSE.txt file for details.
+

data/lib/rdoc/discover.rb

@@ -0,0 +1,35 @@
+begin
+  require "rubygems"
+rescue LoadError
+end
+
+begin
+  gem 'rdoc', '~> 3'
+  #gem 'shomen'
+  require_relative 'generator/shomen'
+rescue Gem::LoadError => error
+  puts error
+rescue LoadError => error
+  puts error
+end
+
+
+
+
+
+#puts "RDoc discovered Shomen!" if $DEBUG
+
+# If using Gems put her on the $LOAD_PATH
+#begin
+#  require "rubygems"
+#  gem "rdoc", ">= 2.5"
+#  gem "shomen"
+#end
+
+#require 'shomen/rdoc/option_fix'
+
+#RDoc.generator_option('shomen') do
+#  require 'shomen/rdoc/generator'
+#  RDoc::Generator::Shomen
+#end
+

data/lib/rdoc/generator/shomen.rb

@@ -0,0 +1,667 @@
+require 'fileutils'
+require 'pathname'
+require 'yaml'
+require 'json'
+
+require 'shomen-model'
+
+require 'rdoc/rdoc'
+require 'rdoc/generator'
+require 'rdoc/generator/markup'
+require 'rdoc/generator/shomen_extensions'
+
+# Shomen Adaptor for RDoc utilizes the rdoc tool to parse ruby source code
+# to build a Shomen documenation file.
+#
+# RDoc is almost entirely a free-form documentation system, so it is not
+# possible for Shomen to fully harness all the details it can support from
+# the RDoc documentation, such as method argument descriptions.
+#
+class RDoc::Generator::Shomen
+
+  #
+  DESCRIPTION = 'Shomen documentation format'
+
+  # Register shomen generator with RDoc.
+  RDoc::RDoc.add_generator(self)
+
+  #include RDocShomen::Metadata
+
+  # Standard generator factory method.
+  #
+  # options - Generator options.
+  #
+  # Returns new RDoc::Generator::Shomen instance.
+  def self.for(options)
+    new(options)
+  end
+
+  # User options from the command line.
+  attr :options
+
+  #
+  def self.setup_options(options)
+    options.source = false
+    options.yaml   = false
+
+    opt = options.option_parser
+
+    opt.separator nil
+    opt.separator "Shomen generator options:"
+    opt.separator nil
+    opt.on("--yaml", "Generate YAML document instead of JSON.") do |value|
+      options.yaml = true
+    end
+    opt.separator nil
+    opt.on("--source", "Include full source code for scripts.") do |value|
+      options.github = true
+    end
+  end
+
+  # List of all classes and modules.
+  #def all_classes_and_modules
+  #  @all_classes_and_modules ||= RDoc::TopLevel.all_classes_and_modules
+  #end
+
+  # In the world of the RDoc Generators #classes is the same
+  # as #all_classes_and_modules. Well, except that its sorted 
+  # too. For classes sans modules, see #types.
+  #
+  def classes
+    @classes ||= RDoc::TopLevel.all_classes_and_modules.sort
+  end
+
+  # Only toplevel classes and modules.
+  def classes_toplevel
+    @classes_toplevel ||= classes.select {|klass| !(RDoc::ClassModule === klass.parent) }
+  end
+
+  #
+  def files
+    @files ||= (
+      @files_rdoc.select{ |f| f.parser != RDoc::Parser::Simple }
+    )
+  end
+
+  # List of toplevel files. RDoc supplies this via the #generate method.
+  def files_toplevel
+    @files_toplevel ||= (
+      @files_rdoc.select{ |f| f.parser == RDoc::Parser::Simple }
+    )
+  end
+
+  #
+  def files_hash
+    @files ||= RDoc::TopLevel.files_hash
+  end
+
+  # List of all methods in all classes and modules.
+  def methods_all
+    @methods_all ||= classes.map{ |m| m.method_list }.flatten.sort
+  end
+
+  # List of all attributes in all classes and modules.
+  def attributes_all
+    @attributes_all ||= classes.map{ |m| m.attributes }.flatten.sort
+  end
+
+  #
+  def constants_all
+    @constants_all ||= classes.map{ |c| c.constants }.flatten
+  end
+
+  ## TODO: What's this then?
+  ##def json_creatable?
+  ##  RDoc::TopLevel.json_creatable?
+  ##end
+
+  # RDoc needs this to function.
+  def class_dir ; nil ; end
+
+  # RDoc needs this to function.
+  def file_dir  ; nil ; end
+
+  # TODO: Rename ?
+  def shomen
+    @table || {}
+  end
+
+  # Build the initial indices and output objects based on an array of
+  # top level objects containing the extracted information.
+  #
+  # files - Files to document.
+  #
+  # Returns nothing.
+  def generate(files)
+    @files_rdoc = files.sort
+
+    @table = {}
+
+    generate_metadata
+    generate_constants
+    generate_classes
+    #generate_attributes
+    generate_methods
+    generate_documents
+    generate_scripts   # must be last b/c it depends on the others
+
+    # TODO: method accessor fields need to be handled
+
+    # THINK: Internal referencing model, YAML and JSYNC ?
+    #ref_table = reference_table(@table)
+
+    if options.yaml
+      out = @table.to_yaml
+    else
+      out = JSON.generate(@table)
+    end
+
+    if options.op_dir == '-'
+      puts out
+    else
+      File.open(output_file, 'w') do |f|
+        f << out
+      end unless $dryrun
+    end
+
+  #rescue StandardError => err
+  #  debug_msg "%s: %s\n  %s" % [ err.class.name, err.message, err.backtrace.join("\n  ") ]
+  #  raise err
+  end
+
+  #
+  def output_file
+    name = project_metadata['name']
+    vers = project_metadata['version']
+
+    if name && vers
+      "#{name}-#{vers}.json"
+    else
+     'doc.json'
+    end
+  end
+
+protected
+
+  # Initialize new generator.
+  #
+  # options - Generator options.
+  #
+  # Returns new RDoc::Generator::Shomen instance.
+  def initialize(options)
+    @options = options
+    #@options.diagram = false  # why?
+
+    @path_base   = Pathname.pwd.expand_path
+
+    # TODO: This is probably not needed any more.
+    @path_output = Pathname.new(@options.op_dir).expand_path(@path_base)
+  end
+
+  # Current pathname.
+  attr :path_base
+
+  # The output path.
+  attr :path_output
+
+  #
+  def path_output_relative(path=nil)
+    if path
+      path.to_s.sub(path_base.to_s+'/', '')
+    else
+      @path_output_relative ||= path_output.to_s.sub(path_base.to_s+'/', '')
+    end
+  end
+
+  #
+  def project_metadata
+    @project_metadata ||= Shomen::Metadata.new
+  end
+
+  #
+  def generate_metadata
+    @table['(metadata)'] = project_metadata.to_h
+  end
+
+  # Add constants to table.
+  def generate_constants
+    debug_msg "Generating constant documentation:"
+    constants_all.each do |rdoc|
+      model = Shomen::Model::Constant.new
+
+      model.path      = rdoc.parent.full_name + '::' + rdoc.name
+      model.name      = rdoc.name
+      model.namespace = rdoc.parent.full_name
+      model.comment   = comment(rdoc.comment)
+      model.format    = 'rdoc'
+      model.value     = rdoc.value
+      model.files     = ["/#{rdoc.file.full_name}"]
+
+      @table[model.path] = model.to_h
+    end
+  end
+
+  # Add classes (and modules) to table.
+  def generate_classes
+    debug_msg "Generating class/module documentation:"
+
+    classes.each do |rdoc_class|
+      debug_msg "%s (%s)" % [ rdoc_class.full_name, rdoc_class.path ]
+
+      if rdoc_class.type=='class'
+        model = Shomen::Model::Class.new
+      else
+        model = Shomen::Model::Module.new
+      end
+
+      model.path             = rdoc_class.full_name
+      model.name             = rdoc_class.name
+      model.namespace        = rdoc_class.full_name.split('::')[0...-1].join('::')
+      model.includes         = rdoc_class.includes.map{ |x| x.name }  # FIXME: How to "lookup" full name?
+      model.extensions       = []                                     # TODO:  How to get extensions?
+      model.comment          = comment(rdoc_class.comment)
+      model.format           = 'rdoc'
+      model.constants        = rdoc_class.constants.map{ |x| complete_name(x.name, rdoc_class.full_name) }
+      model.modules          = rdoc_class.modules.map{ |x| complete_name(x.name, rdoc_class.full_name) }
+      model.classes          = rdoc_class.classes.map{ |x| complete_name(x.name, rdoc_class.full_name) }
+      model.methods          = rdoc_class.method_list.map{ |m| method_name(m) }.uniq
+      model.accessors        = rdoc_class.attributes.map{ |a| method_name(a) }.uniq  #+ ":#{a.rw}" }.uniq
+      model.files            = rdoc_class.in_files.map{ |x| "/#{x.full_name}" }
+
+      if rdoc_class.type == 'class'
+        # HACK: No idea why RDoc is returning some weird superclass:
+        #   <RDoc::NormalClass:0xd924d4 class Object < BasicObject includes: []
+        #     attributes: [] methods: [#<RDoc::AnyMethod:0xd92b8c Object#fileutils
+        #     (public)>] aliases: []>
+        # Maybe it has something to do with #fileutils?
+        model.superclass = (
+          case rdoc_class.superclass
+          when nil
+          when String
+            rdoc_class.superclass
+          else
+            rdoc_class.superclass.full_name
+          end
+        )
+      end
+
+      @table[model.path] = model.to_h
+    end
+  end
+
+  # TODO: How to get literal interface separate from call-sequnces?
+
+  # Transform RDoc methods to Shomen model and add to table.
+  def generate_methods
+    debug_msg "Generating method documentation:"
+
+    list = methods_all + attributes_all
+
+    list.each do |rdoc_method|
+      #debug_msg "%s" % [rdoc_method.full_name]
+
+      #full_name  = method_name(m)
+      #'prettyname'   => m.pretty_name,
+      #'type'         => m.type, # class or instance
+
+      model = Shomen::Model::Method.new
+
+      model.path        = method_name(rdoc_method)
+      model.name        = rdoc_method.name
+      model.namespace   = rdoc_method.parent_name
+      model.comment     = comment(rdoc_method.comment)
+      model.format      = 'rdoc'
+      model.aliases     = rdoc_method.aliases.map{ |a| method_name(a) }
+      model.alias_for   = method_name(rdoc_method.is_alias_for)
+      model.singleton   = rdoc_method.singleton
+
+      model.declarations << rdoc_method.type.to_s #singleton ? 'class' : 'instance'
+      model.declarations << rdoc_method.visibility.to_s
+
+      model.interfaces = []
+      if rdoc_method.call_seq
+        rdoc_method.call_seq.split("\n").each do |cs|
+          cs = cs.to_s.strip
+          model.interfaces << parse_interface(cs) unless cs == ''
+        end
+      end
+      model.interfaces << parse_interface("#{rdoc_method.name}#{rdoc_method.params}")
+
+      model.returns    = []  # RDoc doesn't support specifying return values
+      model.file       = '/'+rdoc_method.source_code_location.first
+      model.line       = rdoc_method.source_code_location.last.to_i
+      model.source     = rdoc_method.source_code_raw
+
+      if rdoc_method.respond_to?(:c_function)
+        model.language = rdoc_method.c_function ? 'c' : 'ruby'
+      else
+        model.language = 'ruby'
+      end
+
+      @table[model.path] = model.to_h
+    end
+  end
+
+#--
+=begin
+  #
+  def generate_attributes
+#$stderr.puts "HERE!"
+#$stderr.puts attributes_all.inspect
+#exit
+    debug_msg "Generating attributes documentation:"
+    attributes_all.each do |rdoc_attribute|
+      debug_msg "%s" % [rdoc_attribute.full_name]
+
+      adapter = Shomen::RDoc::MethodAdapter.new(rdoc_attribute)
+      data    = Shomen::Model::Method.new(adapter).to_h
+
+      @table[data['path']] = data
+
+      #code       = m.source_code_raw
+      #file, line = m.source_code_location
+
+      #full_name = method_name(m)
+
+      #'prettyname'   => m.pretty_name,
+      #'type'         => m.type, # class or instance
+
+      #model_class = m.singleton ? Shomen::Model::Function : Shomen::Model::Method
+      #model_class = Shomen::Model::Attribute
+
+      #@table[full_name] = model_class.new(
+      #  'path'         => full_name,
+      #  'name'         => m.name,
+      #  'namespace'    => m.parent_name,
+      #  'comment'      => comment(m.comment),
+      #  'access'       => m.visibility.to_s,
+      #  'rw'           => m.rw,  # TODO: better name ?
+      #  'singleton'    => m.singleton,
+      #  'aliases'      => m.aliases.map{ |a| method_name(a) },
+      #  'alias_for'    => method_name(m.is_alias_for),
+      #  'image'        => m.params,
+      #  'arguments'    => [],
+      #  'parameters'   => [],
+      #  'block'        => m.block_params, # TODO: what is block?
+      #  'interface'    => m.arglists,
+      #  'returns'      => [],
+      #  'file'         => file,
+      #  'line'         => line,
+      #  'source'       => code
+      #).to_h
+    end
+  end
+=end
+#++
+
+  # Parse method interface.
+  #
+  # TODO: remove any trailing comment too
+  def parse_interface(interface)
+    args, block = [], {}
+
+    interface, returns = interface.split(/[=-]\>/)
+    interface = interface.strip
+    if i = interface.index(/\)\s*\{/)
+      block['image'] = interface[i+1..-1].strip
+      interface = interface[0..i].strip
+    end
+
+    arguments = interface.strip.sub(/^.*?\(/,'').chomp(')')
+    arguments = arguments.split(/\s*\,\s*/)
+    arguments.each do |a|
+      if a.start_with?('&')
+        block['name'] = a
+      else
+        n,v = a.split('=')
+        args << (v ? {'name'=>n,'default'=>v} : {'name'=>n})
+      end
+    end
+
+    result = {}
+    result['signature'] = interface
+    result['arguments'] = args
+    result['block']     = block unless block.empty?
+    result['returns']   = returns.strip if returns
+    return result
+  end
+  private :parse_interface
+
+  # Generate entries for information files, e.g. `README.rdoc`.
+  def generate_documents
+    files_toplevel.each do |rdoc_document|
+      absolute_path = File.join(path_base, rdoc_document.full_name)
+
+      model = Shomen::Model::Document.new
+
+      model.path     = rdoc_document.full_name
+      model.name     = File.basename(absolute_path)
+      model.created  = File.mtime(absolute_path)
+      model.modified = File.mtime(absolute_path)
+      model.text     = File.read(absolute_path) #comment(file.comment)
+      model.format   = mime_type(absolute_path)
+
+      @table['/'+model.path] = model.to_h
+    end
+  end
+
+  # TODO: Add loadpath and make file path relative to it?
+
+  # Generate script entries.
+  def generate_scripts
+    #debug_msg "Generating file documentation in #{path_output_relative}:"
+    #templatefile = self.path_template + 'file.rhtml'
+
+    files.each do |rdoc_file|
+      debug_msg "%s" % [rdoc_file.full_name]
+
+      absolute_path = File.join(path_base, rdoc_file.full_name)
+      #rel_prefix  = self.path_output.relative_path_from(outfile.dirname)
+
+      model = Shomen::Model::Script.new
+
+      model.path      = rdoc_file.full_name
+      model.name      = File.basename(rdoc_file.full_name)
+      model.created   = File.ctime(absolute_path)
+      model.modified  = File.mtime(absolute_path)
+
+      if options.source
+        model.source   = File.read(absolute_path) #comment(file.comment)
+        model.language = mime_type(absolute_path)
+      end
+
+      webcvs = options.webcvs || project_metadata['webcvs']
+      if webcvs
+        model.uri      = File.join(webcvs, model.path)  # TODO: use open-uri ?
+        model.language = mime_type(absolute_path)
+      end
+
+      #model.header   =
+      #model.footer   =
+      model.requires  = rdoc_file.requires.map{ |r| r.name }
+      model.constants = rdoc_file.constants.map{ |c| c.full_name }
+
+      # note that this utilizes the table we are building
+      # so it needs to be the last thing done.
+      @table.each do |k, h|
+        case h['!']
+        when 'module'
+          model.modules ||= []
+          model.modules << k if h['files'].include?(rdoc_file.full_name)
+        when 'class'
+          model.classes ||= []
+          model.classes << k if h['files'].include?(rdoc_file.full_name)
+        when 'method'
+          model.methods ||= []
+          model.methods << k if h['file'] == rdoc_file.full_name
+        when 'class-method'
+          model.class_methods ||= []
+          model.class_methods << k if h['file'] == rdoc_file.full_name
+        end
+      end
+
+      @table['/'+model.path] = model.to_h
+    end
+  end
+
+  # Returns String of fully qualified name.
+  def complete_name(name, namespace)
+    if name !~ /^#{namespace}/
+      "#{namespace}::#{name}"
+    else
+      name
+    end
+  end
+
+  #
+  def collect_methods(class_module, singleton=false)
+    list = []
+    class_module.method_list.each do |m|
+      next if singleton ^ m.singleton
+      list << method_name(m)
+    end
+    list.uniq
+  end
+
+  #
+  def collect_attributes(class_module, singleton=false)
+    list = []
+    class_module.attributes.each do |a|
+      next if singleton ^ a.singleton
+      #p a.rw
+      #case a.rw
+      #when :write, 'W'
+      #  list << "#{method_name(a)}="
+      #else
+        list << method_name(a)
+      #end
+    end
+    list.uniq
+  end
+
+  #
+  def method_name(method)
+    return nil if method.nil?
+    if method.singleton
+      i = method.full_name.rindex('::')     
+      method.full_name[0...i] + '.' + method.full_name[i+2..-1]
+    else
+      method.full_name
+    end
+  end
+
+  #
+  def mime_type(path)
+    case File.extname(path)
+    when '.rb', '.rbx' then 'text/ruby'
+    when '.c' then 'text/c-source'
+    when '.rdoc' then 'text/rdoc'
+    when '.md', '.markdown' then 'text/markdown'
+    else 'text/plain'
+    end
+  end
+
+  # Output progress information if rdoc debugging is enabled
+
+  def debug_msg(msg)
+    return unless $DEBUG_RDOC
+    case msg[-1,1]
+      when '.' then tab = "= "
+      when ':' then tab = "== "
+      else          tab = "* "
+    end
+    $stderr.puts(tab + msg)
+  end
+
+  #
+  def comment(rdoc_comment)
+    case rdoc_comment
+    when String
+      "" # something is wrong if this is a string
+    else
+      rdoc_comment.text
+    end
+  end
+
+end
+
+
+
+#--
+=begin
+  #
+  # N O T  U S E D
+  #
+
+  # Sort based on how often the top level namespace occurs, and then on the
+  # name of the module -- this works for projects that put their stuff into
+  # a namespace, of course, but doesn't hurt if they don't.
+  def sort_salient(classes)
+    nscounts = classes.inject({}) do |counthash, klass|
+      top_level = klass.full_name.gsub( /::.*/, '' )
+      counthash[top_level] ||= 0
+      counthash[top_level] += 1
+      counthash
+    endfiles_toplevel
+    classes.sort_by{ |klass|
+      top_level = klass.full_name.gsub( /::.*/, '' )
+      [nscounts[top_level] * -1, klass.full_name]
+    }.select{ |klass|
+      klass.document_self
+    }
+  end
+=end
+
+=begin
+  # Loop through table and convert all named references into bonofied object
+  # references.
+  def reference_table(table)
+    debug_msg "== Generating Reference Table"
+    new_table = {}
+    table.each do |key, entry|
+      debug_msg "%s" % [key]
+      data = entry.dup
+      new_table[key] = data
+      case data['!']
+      when 'script'
+        data["constants"]  = ref_list(data["constants"])
+        data["modules"]    = ref_list(data["modules"])
+        data["classes"]    = ref_list(data["classes"])
+        data["functions"]  = ref_list(data["functions"])
+        data["methods"]    = ref_list(data["methods"])
+      when 'file'
+      when 'constant'
+        data["namespace"]  = ref_item(data["namespace"])
+      when 'module', 'class'
+        data["namespace"]  = ref_item(data["namespace"])
+        data["includes"]   = ref_list(data["includes"])
+        #data["extended"]  = ref_list(data["extended"])
+        data["constants"]  = ref_list(data["constants"])
+        data["modules"]    = ref_list(data["modules"])
+        data["classes"]    = ref_list(data["classes"])
+        data["functions"]  = ref_list(data["functions"])
+        data["methods"]    = ref_list(data["methods"])
+        data["files"]      = ref_list(data["files"])
+        data["superclass"] = ref_item(data["superclass"]) if data.key?("superclass")
+      when 'method', 'function'
+        data["namespace"]  = ref_item(data["namespace"])
+        data["file"]       = ref_item(data["file"])
+      end
+    end
+    new_table
+  end
+
+  # Given a key, return the matching table item. If not found return the key.
+  def ref_item(key)
+    @table[key] || key
+  end
+
+  # Given a list of keys, return the matching table items.
+  def ref_list(keys)
+    #keys.map{ |k| @table[k] || k }
+    keys.map{ |k| @table[k] || nil }.compact
+  end
+
+=end
+#++
+

data/lib/rdoc/generator/shomen_extensions.rb

@@ -0,0 +1,154 @@
+class RDoc::Options
+  # true/false to include full source
+  attr_accessor :source
+  # true/false to use YAML instead of JSON
+  attr_accessor :yaml
+end
+
+class RDoc::TopLevel
+  #
+  def to_h
+    {
+       :path     => path,
+       :name     => base_name,
+       :fullname => full_name,
+       :rootname => absolute_name,
+       :modified => last_modified,
+       :diagram  => diagram
+    }
+  end
+
+  #
+  #def to_json
+  #  to_h.to_json
+  #end
+end
+
+
+class RDoc::ClassModule
+  #
+  def with_documentation?
+    document_self_or_methods || classes_and_modules.any?{ |c| c.with_documentation? }
+  end
+
+  #
+  def document_self_or_methods
+    document_self || method_list.any?{ |m| m.document_self }
+  end
+
+#  #
+#  def to_h
+#    {
+#      :name       => name,
+#      :fullname   => full_name,
+#      :type       => type,
+#      :path       => path,
+#      :superclass => module? ? nil : superclass
+#    }
+#  end
+#
+#  def to_json
+#    to_h.to_json
+#  end
+end
+
+
+module RDoc::SourceCodeAccess
+
+  #
+  def source_code_raw
+    return '' unless @token_stream
+    src = ""
+    @token_stream.each do |t|
+      next unless t
+      src << t.text
+    end
+    #add_line_numbers(src)
+    src
+  end
+
+  #
+  def source_code_location
+    src = source_code_raw
+    if md = /File (.*?), line (\d+)/.match(src)
+      file = md[1]
+      line = md[2]
+    else
+      file = "(unknown)"
+      line = 0
+    end
+    return file, line
+  end
+
+end
+
+
+class RDoc::AnyMethod
+  include RDoc::SourceCodeAccess
+
+#  # NOTE: dont_rename_initialize isn't used
+#  def to_h
+#    {
+#      :name         => name,
+#      :fullname     => full_name,
+#      :prettyname   => pretty_name,
+#      :path         => path,
+#      :type         => type,
+#      :visibility   => visibility,
+#      :blockparams  => block_params,
+#      :singleton    => singleton,
+#      :text         => text,
+#      :aliases      => aliases,
+#      :aliasfor     => is_alias_for,
+#      :aref         => aref,
+#      :parms        => params,
+#      :callseq      => call_seq
+#      #:paramseq     => param_seq,
+#    }
+#  end
+
+#  #
+#  def to_json
+#    to_h.to_json
+#  end
+end
+
+class RDoc::Attr
+  include RDoc::SourceCodeAccess
+end
+
+=begin
+
+# DEPRECATE ASAP
+require "rdoc/parser/c"
+# New RDoc somehow misses class comemnts.
+# copyied this function from "2.2.2" 
+if ['2.4.2', '2.4.3'].include? RDoc::VERSION
+  class RDoc::Parser::C
+    def find_class_comment(class_name, class_meth)
+      comment = nil
+      if @content =~ %r{((?>/\*.*?\*/\s+))
+                     (static\s+)?void\s+Init_#{class_name}\s*(?:_\(\s*)?\(\s*(?:void\s*)\)}xmi then
+        comment = $1
+      elsif @content =~ %r{Document-(?:class|module):\s#{class_name}\s*?(?:<\s+[:,\w]+)?\n((?>.*?\*/))}m
+        comment = $1
+      else
+        if @content =~ /rb_define_(class|module)/m then
+          class_name = class_name.split("::").last
+          comments = []
+          @content.split(/(\/\*.*?\*\/)\s*?\n/m).each_with_index do |chunk, index|
+            comments[index] = chunk
+            if chunk =~ /rb_define_(class|module).*?"(#{class_name})"/m then
+              comment = comments[index-1]
+              break
+            end
+          end
+        end
+      end
+      class_meth.comment = mangle_comment(comment) if comment
+    end
+  end
+end
+
+=end
+

data/test/case_specification.rb

@@ -0,0 +1,20 @@
+require 'citron'
+require 'brass'
+require 'json'
+
+testcase "Document conforms to specificaiton" do
+
+  # IMPORTANT! For now we need to hand create this document.
+  FIXTURE_DOCUMENT = 'test/fixture/doc/doc.json'
+
+  def initialize(*a,&b)
+    super(*a,&b)
+
+    @doc = JSON.load(File.new(FIXTURE_DOCUMENT))
+  end
+
+  test "(metadata)" do
+    assert @doc['(metadata)']
+  end
+
+end

data/test/fixture/doc/doc.json

@@ -0,0 +1 @@
+{"(metadata)":{"source":["meta"],"authors":[{"name":"trans","email":"transfire@gmail.com"}],"copyrights":[],"requirements":[{"name":"rdoc","version":"3+"},{"name":"qed","groups":["test"],"development":true},{"name":"ae","groups":["test"],"development":true},{"name":"detroit","groups":["build"],"development":true},{"name":"reap","groups":["build"],"development":true}],"dependencies":[],"alternatives":[],"conflicts":[],"repositories":[{"uri":"git://github.com/rubyworks/rdoc-shomen.git","scm":"git","name":"upstream"}],"resources":{"home":"http://rubyworks.github.com/rdoc-shomen","docs":"http://rubydoc.info/gems/rdoc-shoment","code":"http://github.com/rubyworks/rdoc-shomen","bugs":"http://github.com/rubyworks/rdoc-shomen/issues","mail":"http://groups.google.com/groups/rubyworks-mailinglist"},"extra":{},"load_path":["lib"],"revision":0,"created":"2010-07-01","summary":"RDoc Generator for Shomen Documentation Format","title":"RDoc Shomen","version":"0.1.0","name":"rdoc-shomen","description":"RDoc-Shomen is an RDoc generator plugin that can be used to generate Shomen\ndocumentation. This is an alternative to the shomen command line tool which\nuse the `.rdoc` cache to generate a shomen document. In contrast the rdoc-shomen\ngenerator operates as a traditional rdoc plugin.","organization":"rubyworks","date":"2012-03-31","path":"(metadata)","markup":"rdoc"},"RDoc::Generator::Shomen::DESCRIPTION":{"!":"constant","path":"RDoc::Generator::Shomen::DESCRIPTION","name":"DESCRIPTION","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","value":"'Shomen documentation format'","files":["/lib/rdoc/generator/shomen.rb"]},"RDoc":{"!":"module","path":"RDoc","name":"RDoc","namespace":"","includes":[],"extensions":[],"comment":"","format":"rdoc","constants":[],"modules":["RDoc::SourceCodeAccess","RDoc::Generator"],"classes":["RDoc::Options","RDoc::TopLevel","RDoc::ClassModule","RDoc::AnyMethod","RDoc::Attr"],"methods":[],"accessors":[],"files":[]},"RDoc::AnyMethod":{"!":"class","path":"RDoc::AnyMethod","name":"AnyMethod","namespace":"RDoc","includes":["RDoc::SourceCodeAccess"],"extensions":[],"comment":"#<RDoc::Comment:0x00000002e56120>","format":"rdoc","constants":[],"modules":[],"classes":[],"methods":[],"accessors":[],"files":["/lib/rdoc/generator/shomen_extensions.rb"],"superclass":"Object"},"RDoc::Attr":{"!":"class","path":"RDoc::Attr","name":"Attr","namespace":"RDoc","includes":["RDoc::SourceCodeAccess"],"extensions":[],"comment":"#<RDoc::Comment:0x00000002dd7898>","format":"rdoc","constants":[],"modules":[],"classes":[],"methods":[],"accessors":[],"files":["/lib/rdoc/generator/shomen_extensions.rb"],"superclass":"Object"},"RDoc::ClassModule":{"!":"class","path":"RDoc::ClassModule","name":"ClassModule","namespace":"RDoc","includes":[],"extensions":[],"comment":"#<RDoc::Comment:0x00000002fb7168>","format":"rdoc","constants":[],"modules":[],"classes":[],"methods":["RDoc::ClassModule#with_documentation?","RDoc::ClassModule#document_self_or_methods"],"accessors":[],"files":["/lib/rdoc/generator/shomen_extensions.rb"],"superclass":"Object"},"RDoc::Generator":{"!":"module","path":"RDoc::Generator","name":"Generator","namespace":"RDoc","includes":[],"extensions":[],"comment":"","format":"rdoc","constants":[],"modules":[],"classes":["RDoc::Generator::Shomen"],"methods":[],"accessors":[],"files":[]},"RDoc::Generator::Shomen":{"!":"class","path":"RDoc::Generator::Shomen","name":"Shomen","namespace":"RDoc::Generator","includes":[],"extensions":[],"comment":"#<RDoc::Comment:0x00000002a01d40>","format":"rdoc","constants":["RDoc::Generator::Shomen::DESCRIPTION"],"modules":[],"classes":[],"methods":["RDoc::Generator::Shomen.for","RDoc::Generator::Shomen.setup_options","RDoc::Generator::Shomen#classes","RDoc::Generator::Shomen#classes_toplevel","RDoc::Generator::Shomen#files","RDoc::Generator::Shomen#files_toplevel","RDoc::Generator::Shomen#files_hash","RDoc::Generator::Shomen#methods_all","RDoc::Generator::Shomen#attributes_all","RDoc::Generator::Shomen#constants_all","RDoc::Generator::Shomen#class_dir","RDoc::Generator::Shomen#file_dir","RDoc::Generator::Shomen#shomen","RDoc::Generator::Shomen#generate","RDoc::Generator::Shomen#output_file","RDoc::Generator::Shomen.new","RDoc::Generator::Shomen#path_output_relative","RDoc::Generator::Shomen#project_metadata","RDoc::Generator::Shomen#generate_metadata","RDoc::Generator::Shomen#generate_constants","RDoc::Generator::Shomen#generate_classes","RDoc::Generator::Shomen#generate_methods","RDoc::Generator::Shomen#generate_documents","RDoc::Generator::Shomen#generate_scripts","RDoc::Generator::Shomen#complete_name","RDoc::Generator::Shomen#collect_methods","RDoc::Generator::Shomen#collect_attributes","RDoc::Generator::Shomen#method_name","RDoc::Generator::Shomen#mime_type","RDoc::Generator::Shomen#debug_msg"],"accessors":["RDoc::Generator::Shomen#options","RDoc::Generator::Shomen#path_base","RDoc::Generator::Shomen#path_output"],"files":["/lib/rdoc/generator/shomen.rb"],"superclass":"Object"},"RDoc::Options":{"!":"class","path":"RDoc::Options","name":"Options","namespace":"RDoc","includes":[],"extensions":[],"comment":"#<RDoc::Comment:0x000000030d3600>","format":"rdoc","constants":[],"modules":[],"classes":[],"methods":[],"accessors":["RDoc::Options#source","RDoc::Options#yaml"],"files":["/lib/rdoc/generator/shomen_extensions.rb"],"superclass":"Object"},"RDoc::SourceCodeAccess":{"!":"module","path":"RDoc::SourceCodeAccess","name":"SourceCodeAccess","namespace":"RDoc","includes":[],"extensions":[],"comment":"#<RDoc::Comment:0x00000002f26a78>","format":"rdoc","constants":[],"modules":[],"classes":[],"methods":["RDoc::SourceCodeAccess#source_code_raw","RDoc::SourceCodeAccess#source_code_location"],"accessors":[],"files":["/lib/rdoc/generator/shomen_extensions.rb"]},"RDoc::TopLevel":{"!":"class","path":"RDoc::TopLevel","name":"TopLevel","namespace":"RDoc","includes":[],"extensions":[],"comment":"#<RDoc::Comment:0x00000003066c30>","format":"rdoc","constants":[],"modules":[],"classes":[],"methods":["RDoc::TopLevel#to_h"],"accessors":[],"files":["/lib/rdoc/generator/shomen_extensions.rb"],"superclass":"Object"},"RDoc::Generator::Shomen.for":{"!":"method","declarations":["class","public"],"path":"RDoc::Generator::Shomen.for","name":"for","namespace":"RDoc::Generator::Shomen","comment":"Standard generator factory method.\n\noptions - Generator options.\n\nReturns new RDoc::Generator::Shomen instance.","format":"rdoc","aliases":[],"alias_for":null,"singleton":true,"interfaces":[{"signature":"for(options)","arguments":[{"name":"options"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":36,"source":"# File lib/rdoc/generator/shomen.rb, line 36\n  def self.for(options)\n    new(options)\n  end","language":"ruby"},"RDoc::Generator::Shomen.new":{"!":"method","declarations":["class","public"],"path":"RDoc::Generator::Shomen.new","name":"new","namespace":"RDoc::Generator::Shomen","comment":"Initialize new generator.\n\noptions - Generator options.\n\nReturns new RDoc::Generator::Shomen instance.","format":"rdoc","aliases":[],"alias_for":null,"singleton":true,"interfaces":[{"signature":"new(options)","arguments":[{"name":"options"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":192,"source":"# File lib/rdoc/generator/shomen.rb, line 192\n  def initialize(options)\n    @options = options\n    #@options.diagram = false  # why?\n\n    @path_base   = Pathname.pwd.expand_path\n\n    # TODO: This is probably not needed any more.\n    @path_output = Pathname.new(@options.op_dir).expand_path(@path_base)\n  end","language":"ruby"},"RDoc::Generator::Shomen.setup_options":{"!":"method","declarations":["class","public"],"path":"RDoc::Generator::Shomen.setup_options","name":"setup_options","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":true,"interfaces":[{"signature":"setup_options(options)","arguments":[{"name":"options"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":44,"source":"# File lib/rdoc/generator/shomen.rb, line 44\n  def self.setup_options(options)\n    options.source = false\n    options.yaml   = false\n\n    opt = options.option_parser\n\n    opt.separator nil\n    opt.separator \"Shomen generator options:\"\n    opt.separator nil\n    opt.on(\"--yaml\", \"Generate YAML document instead of JSON.\") do |value|\n      options.yaml = true\n    end\n    opt.separator nil\n    opt.on(\"--source\", \"Include full source code for scripts.\") do |value|\n      options.github = true\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#attributes_all":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#attributes_all","name":"attributes_all","namespace":"RDoc::Generator::Shomen","comment":"List of all attributes in all classes and modules.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"attributes_all()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":105,"source":"# File lib/rdoc/generator/shomen.rb, line 105\n  def attributes_all\n    @attributes_all ||= classes.map{ |m| m.attributes }.flatten.sort\n  end","language":"ruby"},"RDoc::Generator::Shomen#class_dir":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#class_dir","name":"class_dir","namespace":"RDoc::Generator::Shomen","comment":"RDoc needs this to function.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"class_dir()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":120,"source":"# File lib/rdoc/generator/shomen.rb, line 120\n  def class_dir ; nil ; end","language":"ruby"},"RDoc::Generator::Shomen#classes":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#classes","name":"classes","namespace":"RDoc::Generator::Shomen","comment":"In the world of the RDoc Generators #classes is the same\nas #all_classes_and_modules. Well, except that its sorted \ntoo. For classes sans modules, see #types.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"classes()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":71,"source":"# File lib/rdoc/generator/shomen.rb, line 71\n  def classes\n    @classes ||= RDoc::TopLevel.all_classes_and_modules.sort\n  end","language":"ruby"},"RDoc::Generator::Shomen#classes_toplevel":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#classes_toplevel","name":"classes_toplevel","namespace":"RDoc::Generator::Shomen","comment":"Only toplevel classes and modules.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"classes_toplevel()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":76,"source":"# File lib/rdoc/generator/shomen.rb, line 76\n  def classes_toplevel\n    @classes_toplevel ||= classes.select {|klass| !(RDoc::ClassModule === klass.parent) }\n  end","language":"ruby"},"RDoc::Generator::Shomen#collect_attributes":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#collect_attributes","name":"collect_attributes","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"collect_attributes(class_module, singleton=false)","arguments":[{"name":"class_module"},{"name":"singleton","default":"false"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":532,"source":"# File lib/rdoc/generator/shomen.rb, line 532\n  def collect_attributes(class_module, singleton=false)\n    list = []\n    class_module.attributes.each do |a|\n      next if singleton ^ a.singleton\n      #p a.rw\n      #case a.rw\n      #when :write, 'W'\n      #  list << \"#{method_name(a)}=\"\n      #else\n        list << method_name(a)\n      #end\n    end\n    list.uniq\n  end","language":"ruby"},"RDoc::Generator::Shomen#collect_methods":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#collect_methods","name":"collect_methods","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"collect_methods(class_module, singleton=false)","arguments":[{"name":"class_module"},{"name":"singleton","default":"false"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":522,"source":"# File lib/rdoc/generator/shomen.rb, line 522\n  def collect_methods(class_module, singleton=false)\n    list = []\n    class_module.method_list.each do |m|\n      next if singleton ^ m.singleton\n      list << method_name(m)\n    end\n    list.uniq\n  end","language":"ruby"},"RDoc::Generator::Shomen#complete_name":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#complete_name","name":"complete_name","namespace":"RDoc::Generator::Shomen","comment":"Returns String of fully qualified name.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"complete_name(name, namespace)","arguments":[{"name":"name"},{"name":"namespace"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":513,"source":"# File lib/rdoc/generator/shomen.rb, line 513\n  def complete_name(name, namespace)\n    if name !~ %r^#{namespace}/\n      \"#{namespace}::#{name}\"\n    else\n      name\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#constants_all":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#constants_all","name":"constants_all","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"constants_all()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":110,"source":"# File lib/rdoc/generator/shomen.rb, line 110\n  def constants_all\n    @constants_all ||= classes.map{ |c| c.constants }.flatten\n  end","language":"ruby"},"RDoc::Generator::Shomen#debug_msg":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#debug_msg","name":"debug_msg","namespace":"RDoc::Generator::Shomen","comment":"Output progress information if rdoc debugging is enabled","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"debug_msg(msg)","arguments":[{"name":"msg"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":571,"source":"# File lib/rdoc/generator/shomen.rb, line 571\n  def debug_msg(msg)\n    return unless $DEBUG_RDOC\n    case msg[-1,1]\n      when '.' then tab = \"= \"\n      when ':' then tab = \"== \"\n      else          tab = \"* \"\n    end\n    $stderr.puts(tab + msg)\n  end","language":"ruby"},"RDoc::ClassModule#document_self_or_methods":{"!":"method","declarations":["instance","public"],"path":"RDoc::ClassModule#document_self_or_methods","name":"document_self_or_methods","namespace":"RDoc::ClassModule","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"document_self_or_methods()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen_extensions.rb","line":35,"source":"# File lib/rdoc/generator/shomen_extensions.rb, line 35\n  def document_self_or_methods\n    document_self || method_list.any?{ |m| m.document_self }\n  end","language":"ruby"},"RDoc::Generator::Shomen#file_dir":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#file_dir","name":"file_dir","namespace":"RDoc::Generator::Shomen","comment":"RDoc needs this to function.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"file_dir()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":123,"source":"# File lib/rdoc/generator/shomen.rb, line 123\n  def file_dir  ; nil ; end","language":"ruby"},"RDoc::Generator::Shomen#files":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#files","name":"files","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"files()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":81,"source":"# File lib/rdoc/generator/shomen.rb, line 81\n  def files\n    @files ||= (\n      @files_rdoc.select{ |f| f.parser != RDoc::Parser::Simple }\n    )\n  end","language":"ruby"},"RDoc::Generator::Shomen#files_hash":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#files_hash","name":"files_hash","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"files_hash()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":95,"source":"# File lib/rdoc/generator/shomen.rb, line 95\n  def files_hash\n    @files ||= RDoc::TopLevel.files_hash\n  end","language":"ruby"},"RDoc::Generator::Shomen#files_toplevel":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#files_toplevel","name":"files_toplevel","namespace":"RDoc::Generator::Shomen","comment":"List of toplevel files. RDoc supplies this via the #generate method.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"files_toplevel()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":88,"source":"# File lib/rdoc/generator/shomen.rb, line 88\n  def files_toplevel\n    @files_toplevel ||= (\n      @files_rdoc.select{ |f| f.parser == RDoc::Parser::Simple }\n    )\n  end","language":"ruby"},"RDoc::Generator::Shomen#generate":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#generate","name":"generate","namespace":"RDoc::Generator::Shomen","comment":"Build the initial indices and output objects based on an array of\ntop level objects containing the extracted information.\n\nfiles - Files to document.\n\nReturns nothing.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"generate(files)","arguments":[{"name":"files"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":136,"source":"# File lib/rdoc/generator/shomen.rb, line 136\n  def generate(files)\n    @files_rdoc = files.sort\n\n    @table = {}\n\n    generate_metadata\n    generate_constants\n    generate_classes\n    #generate_attributes\n    generate_methods\n    generate_documents\n    generate_scripts   # must be last b/c it depends on the others\n\n    # TODO: method accessor fields need to be handled\n\n    # THINK: Internal referencing model, YAML and JSYNC ?\n    #ref_table = reference_table(@table)\n\n    if options.yaml\n      out = @table.to_yaml\n    else\n      out = JSON.generate(@table)\n    end\n\n    if options.op_dir == '-'\n      puts out\n    else\n      File.open(output_file, 'w') do |f|\n        f << out\n      end unless $dryrun\n    end\n\n  #rescue StandardError => err\n  #  debug_msg \"%s: %s\\n  %s\" % [ err.class.name, err.message, err.backtrace.join(\"\\n  \") ]\n  #  raise err\n  end","language":"ruby"},"RDoc::Generator::Shomen#generate_classes":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#generate_classes","name":"generate_classes","namespace":"RDoc::Generator::Shomen","comment":"Add classes (and modules) to table.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"generate_classes()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":246,"source":"# File lib/rdoc/generator/shomen.rb, line 246\n  def generate_classes\n    debug_msg \"Generating class/module documentation:\"\n\n    classes.each do |rdoc_class|\n      debug_msg \"%s (%s)\" % [ rdoc_class.full_name, rdoc_class.path ]\n\n      if rdoc_class.type=='class'\n        model = Shomen::Model::Class.new\n      else\n        model = Shomen::Model::Module.new\n      end\n\n      model.path             = rdoc_class.full_name\n      model.name             = rdoc_class.name\n      model.namespace        = rdoc_class.full_name.split('::')[0...-1].join('::')\n      model.includes         = rdoc_class.includes.map{ |x| x.name }  # FIXME: How to \"lookup\" full name?\n      model.extensions       = []                                     # TODO:  How to get extensions?\n      model.comment          = rdoc_class.comment.to_s #text\n      model.format           = 'rdoc'\n      model.constants        = rdoc_class.constants.map{ |x| complete_name(x.name, rdoc_class.full_name) }\n      model.modules          = rdoc_class.modules.map{ |x| complete_name(x.name, rdoc_class.full_name) }\n      model.classes          = rdoc_class.classes.map{ |x| complete_name(x.name, rdoc_class.full_name) }\n      model.methods          = rdoc_class.method_list.map{ |m| method_name(m) }.uniq\n      model.accessors        = rdoc_class.attributes.map{ |a| method_name(a) }.uniq  #+ \":#{a.rw}\" }.uniq\n      model.files            = rdoc_class.in_files.map{ |x| \"/#{x.full_name}\" }\n\n      if rdoc_class.type == 'class'\n        # HACK: No idea why RDoc is returning some weird superclass:\n        #   <RDoc::NormalClass:0xd924d4 class Object < BasicObject includes: []\n        #     attributes: [] methods: [#<RDoc::AnyMethod:0xd92b8c Object#fileutils\n        #     (public)>] aliases: []>\n        # Maybe it has something to do with #fileutils?\n        model.superclass = (\n          case rdoc_class.superclass\n          when nil\n          when String\n            rdoc_class.superclass\n          else\n            rdoc_class.superclass.full_name\n          end\n        )\n      end\n\n      @table[model.path] = model.to_h\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#generate_constants":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#generate_constants","name":"generate_constants","namespace":"RDoc::Generator::Shomen","comment":"Add constants to table.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"generate_constants()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":228,"source":"# File lib/rdoc/generator/shomen.rb, line 228\n  def generate_constants\n    debug_msg \"Generating constant documentation:\"\n    constants_all.each do |rdoc|\n      model = Shomen::Model::Constant.new\n\n      model.path      = rdoc.parent.full_name + '::' + rdoc.name\n      model.name      = rdoc.name\n      model.namespace = rdoc.parent.full_name\n      model.comment   = rdoc.comment.text\n      model.format    = 'rdoc'\n      model.value     = rdoc.value\n      model.files     = [\"/#{rdoc.file.full_name}\"]\n\n      @table[model.path] = model.to_h\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#generate_documents":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#generate_documents","name":"generate_documents","namespace":"RDoc::Generator::Shomen","comment":"Generate entries for information files, e.g. `README.rdoc`.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"generate_documents()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":432,"source":"# File lib/rdoc/generator/shomen.rb, line 432\n  def generate_documents\n    files_toplevel.each do |rdoc_document|\n      absolute_path = File.join(path_base, rdoc_document.full_name)\n\n      model = Shomen::Model::Document.new\n\n      model.path     = rdoc_document.full_name\n      model.name     = File.basename(absolute_path)\n      model.created  = File.mtime(absolute_path)\n      model.modified = File.mtime(absolute_path)\n      model.text     = File.read(absolute_path) #file.comment\n      model.format   = mime_type(absolute_path)\n\n      @table['/'+model.path] = model.to_h\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#generate_metadata":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#generate_metadata","name":"generate_metadata","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"generate_metadata()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":223,"source":"# File lib/rdoc/generator/shomen.rb, line 223\n  def generate_metadata\n    @table['(metadata)'] = project_metadata.to_h\n  end","language":"ruby"},"RDoc::Generator::Shomen#generate_methods":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#generate_methods","name":"generate_methods","namespace":"RDoc::Generator::Shomen","comment":"Transform RDoc methods to Shomen model and add to table.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"generate_methods()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":296,"source":"# File lib/rdoc/generator/shomen.rb, line 296\n  def generate_methods\n    debug_msg \"Generating method documentation:\"\n\n    list = methods_all + attributes_all\n\n    list.each do |rdoc_method|\n      #debug_msg \"%s\" % [rdoc_method.full_name]\n\n      #full_name  = method_name(m)\n      #'prettyname'   => m.pretty_name,\n      #'type'         => m.type, # class or instance\n\n      model = Shomen::Model::Method.new\n\n      model.path        = method_name(rdoc_method)\n      model.name        = rdoc_method.name\n      model.namespace   = rdoc_method.parent_name\n      model.comment     = rdoc_method.comment.text\n      model.format      = 'rdoc'\n      model.aliases     = rdoc_method.aliases.map{ |a| method_name(a) }\n      model.alias_for   = method_name(rdoc_method.is_alias_for)\n      model.singleton   = rdoc_method.singleton\n\n      model.declarations << rdoc_method.type.to_s #singleton ? 'class' : 'instance'\n      model.declarations << rdoc_method.visibility.to_s\n\n      model.interfaces = []\n      if rdoc_method.call_seq\n        rdoc_method.call_seq.split(\"\\n\").each do |cs|\n          cs = cs.to_s.strip\n          model.interfaces << parse_interface(cs) unless cs == ''\n        end\n      end\n      model.interfaces << parse_interface(\"#{rdoc_method.name}#{rdoc_method.params}\")\n\n      model.returns    = []  # RDoc doesn't support specifying return values\n      model.file       = '/'+rdoc_method.source_code_location.first\n      model.line       = rdoc_method.source_code_location.last.to_i\n      model.source     = rdoc_method.source_code_raw\n\n      if rdoc_method.respond_to?(:c_function)\n        model.language = rdoc_method.c_function ? 'c' : 'ruby'\n      else\n        model.language = 'ruby'\n      end\n\n      @table[model.path] = model.to_h\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#generate_scripts":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#generate_scripts","name":"generate_scripts","namespace":"RDoc::Generator::Shomen","comment":"Generate script entries.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"generate_scripts()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":452,"source":"# File lib/rdoc/generator/shomen.rb, line 452\n  def generate_scripts\n    #debug_msg \"Generating file documentation in #{path_output_relative}:\"\n    #templatefile = self.path_template + 'file.rhtml'\n\n    files.each do |rdoc_file|\n      debug_msg \"%s\" % [rdoc_file.full_name]\n\n      absolute_path = File.join(path_base, rdoc_file.full_name)\n      #rel_prefix  = self.path_output.relative_path_from(outfile.dirname)\n\n      model = Shomen::Model::Script.new\n\n      model.path      = rdoc_file.full_name\n      model.name      = File.basename(rdoc_file.full_name)\n      model.created   = File.ctime(absolute_path)\n      model.modified  = File.mtime(absolute_path)\n\n      # http://github.com/rubyworks/qed/blob/master/ lib/qed.rb\n\n      # TODO: Add option to rdoc command line tool instead of using ENV.\n\n      if ENV['source']\n        model.source   = File.read(absolute_path) #file.comment\n        model.language = mime_type(absolute_path)\n      end\n\n      webcvs = options.webcvs || project_metadata['webcvs']\n      if webcvs\n        model.uri      = File.join(webcvs, model.path)  # TODO: use open-uri ?\n        model.language = mime_type(absolute_path)\n      end\n\n      #model.header   =\n      #model.footer   =\n      model.requires  = rdoc_file.requires.map{ |r| r.name }\n      model.constants = rdoc_file.constants.map{ |c| c.full_name }\n\n      # note that this utilizes the table we are building\n      # so it needs to be the last thing done.\n      @table.each do |k, h|\n        case h['!']\n        when 'module'\n          model.modules ||= []\n          model.modules << k if h['files'].include?(rdoc_file.full_name)\n        when 'class'\n          model.classes ||= []\n          model.classes << k if h['files'].include?(rdoc_file.full_name)\n        when 'method'\n          model.methods ||= []\n          model.methods << k if h['file'] == rdoc_file.full_name\n        when 'class-method'\n          model.class_methods ||= []\n          model.class_methods << k if h['file'] == rdoc_file.full_name\n        end\n      end\n\n      @table['/'+model.path] = model.to_h\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#method_name":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#method_name","name":"method_name","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"method_name(method)","arguments":[{"name":"method"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":548,"source":"# File lib/rdoc/generator/shomen.rb, line 548\n  def method_name(method)\n    return nil if method.nil?\n    if method.singleton\n      i = method.full_name.rindex('::')     \n      method.full_name[0...i] + '.' + method.full_name[i+2..-1]\n    else\n      method.full_name\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#methods_all":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#methods_all","name":"methods_all","namespace":"RDoc::Generator::Shomen","comment":"List of all methods in all classes and modules.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"methods_all()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":100,"source":"# File lib/rdoc/generator/shomen.rb, line 100\n  def methods_all\n    @methods_all ||= classes.map{ |m| m.method_list }.flatten.sort\n  end","language":"ruby"},"RDoc::Generator::Shomen#mime_type":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#mime_type","name":"mime_type","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"mime_type(path)","arguments":[{"name":"path"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":559,"source":"# File lib/rdoc/generator/shomen.rb, line 559\n  def mime_type(path)\n    case File.extname(path)\n    when '.rb', '.rbx' then 'text/ruby'\n    when '.c' then 'text/c-source'\n    when '.rdoc' then 'text/rdoc'\n    when '.md', '.markdown' then 'text/markdown'\n    else 'text/plain'\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#output_file":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#output_file","name":"output_file","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"output_file()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":174,"source":"# File lib/rdoc/generator/shomen.rb, line 174\n  def output_file\n    name = project_metadata['name']\n    vers = project_metadata['version']\n\n    if name && vers\n      \"#{name}-#{vers}.json\"\n    else\n     'doc.json'\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#path_output_relative":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#path_output_relative","name":"path_output_relative","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"path_output_relative(path=nil)","arguments":[{"name":"path","default":"nil"}]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":209,"source":"# File lib/rdoc/generator/shomen.rb, line 209\n  def path_output_relative(path=nil)\n    if path\n      path.to_s.sub(path_base.to_s+'/', '')\n    else\n      @path_output_relative ||= path_output.to_s.sub(path_base.to_s+'/', '')\n    end\n  end","language":"ruby"},"RDoc::Generator::Shomen#project_metadata":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#project_metadata","name":"project_metadata","namespace":"RDoc::Generator::Shomen","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"project_metadata()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":218,"source":"# File lib/rdoc/generator/shomen.rb, line 218\n  def project_metadata\n    @project_metadata ||= Shomen::Metadata.new\n  end","language":"ruby"},"RDoc::Generator::Shomen#shomen":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#shomen","name":"shomen","namespace":"RDoc::Generator::Shomen","comment":"TODO: Rename ?","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"shomen()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen.rb","line":126,"source":"# File lib/rdoc/generator/shomen.rb, line 126\n  def shomen\n    @table || {}\n  end","language":"ruby"},"RDoc::SourceCodeAccess#source_code_location":{"!":"method","declarations":["instance","public"],"path":"RDoc::SourceCodeAccess#source_code_location","name":"source_code_location","namespace":"RDoc::SourceCodeAccess","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"source_code_location()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen_extensions.rb","line":71,"source":"# File lib/rdoc/generator/shomen_extensions.rb, line 71\n  def source_code_location\n    src = source_code_raw\n    if md = %rFile (.*?), line (\\d+)/.match(src)\n      file = md[1]\n      line = md[2]\n    else\n      file = \"(unknown)\"\n      line = 0\n    end\n    return file, line\n  end","language":"ruby"},"RDoc::SourceCodeAccess#source_code_raw":{"!":"method","declarations":["instance","public"],"path":"RDoc::SourceCodeAccess#source_code_raw","name":"source_code_raw","namespace":"RDoc::SourceCodeAccess","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"source_code_raw()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen_extensions.rb","line":59,"source":"# File lib/rdoc/generator/shomen_extensions.rb, line 59\n  def source_code_raw\n    return '' unless @token_stream\n    src = \"\"\n    @token_stream.each do |t|\n      next unless t\n      src << t.text\n    end\n    #add_line_numbers(src)\n    src\n  end","language":"ruby"},"RDoc::TopLevel#to_h":{"!":"method","declarations":["instance","public"],"path":"RDoc::TopLevel#to_h","name":"to_h","namespace":"RDoc::TopLevel","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"to_h()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen_extensions.rb","line":10,"source":"# File lib/rdoc/generator/shomen_extensions.rb, line 10\n  def to_h\n    {\n       :path     => path,\n       :name     => base_name,\n       :fullname => full_name,\n       :rootname => absolute_name,\n       :modified => last_modified,\n       :diagram  => diagram\n    }\n  end","language":"ruby"},"RDoc::ClassModule#with_documentation?":{"!":"method","declarations":["instance","public"],"path":"RDoc::ClassModule#with_documentation?","name":"with_documentation?","namespace":"RDoc::ClassModule","comment":"","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"with_documentation?()","arguments":[]}],"returns":[],"file":"/lib/rdoc/generator/shomen_extensions.rb","line":30,"source":"# File lib/rdoc/generator/shomen_extensions.rb, line 30\n  def with_documentation?\n    document_self_or_methods || classes_and_modules.any?{ |c| c.with_documentation? }\n  end","language":"ruby"},"RDoc::Generator::Shomen#options":{"!":"method","declarations":["instance","public"],"path":"RDoc::Generator::Shomen#options","name":"options","namespace":"RDoc::Generator::Shomen","comment":"User options from the command line.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"options","arguments":[{"name":"options"}]}],"returns":[],"file":"/(unknown)","line":0,"source":"","language":"ruby"},"RDoc::Generator::Shomen#path_base":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#path_base","name":"path_base","namespace":"RDoc::Generator::Shomen","comment":"Current pathname.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"path_base","arguments":[{"name":"path_base"}]}],"returns":[],"file":"/(unknown)","line":0,"source":"","language":"ruby"},"RDoc::Generator::Shomen#path_output":{"!":"method","declarations":["instance","protected"],"path":"RDoc::Generator::Shomen#path_output","name":"path_output","namespace":"RDoc::Generator::Shomen","comment":"The output path.","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"path_output","arguments":[{"name":"path_output"}]}],"returns":[],"file":"/(unknown)","line":0,"source":"","language":"ruby"},"RDoc::Options#source":{"!":"method","declarations":["instance","public"],"path":"RDoc::Options#source","name":"source","namespace":"RDoc::Options","comment":"true/false to include full source","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"source","arguments":[{"name":"source"}]}],"returns":[],"file":"/(unknown)","line":0,"source":"","language":"ruby"},"RDoc::Options#yaml":{"!":"method","declarations":["instance","public"],"path":"RDoc::Options#yaml","name":"yaml","namespace":"RDoc::Options","comment":"true/false to use YAML instead of JSON","format":"rdoc","aliases":[],"alias_for":null,"singleton":false,"interfaces":[{"signature":"yaml","arguments":[{"name":"yaml"}]}],"returns":[],"file":"/(unknown)","line":0,"source":"","language":"ruby"},"/lib/rdoc/discover.rb":{"!":"script","path":"lib/rdoc/discover.rb","name":"discover.rb","created":"2012-03-31 09:43:25 -0400","modified":"2012-03-31 09:43:25 -0400","requires":["rubygems"],"constants":[],"modules":[],"classes":[],"methods":[]},"/lib/rdoc/generator/shomen.rb":{"!":"script","path":"lib/rdoc/generator/shomen.rb","name":"shomen.rb","created":"2012-03-31 11:17:02 -0400","modified":"2012-03-31 11:17:02 -0400","requires":["fileutils","pathname","yaml","json","rdoc/rdoc","rdoc/generator","rdoc/generator/markup","shomen/metadata","shomen/model","rdoc/generator/shomen_extensions"],"constants":[],"modules":[],"classes":[],"methods":[]},"/lib/rdoc/generator/shomen_extensions.rb":{"!":"script","path":"lib/rdoc/generator/shomen_extensions.rb","name":"shomen_extensions.rb","created":"2012-03-31 10:50:09 -0400","modified":"2012-03-31 10:50:09 -0400","requires":[],"constants":[],"modules":[],"classes":[],"methods":[]}}

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rdoc-shomen
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shomen-model
+  requirement: &22833980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22833980
+- !ruby/object:Gem::Dependency
+  name: citron
+  requirement: &22833060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22833060
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &22831420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22831420
+description: ! 'RDoc-Shomen is an RDoc generator plugin that can be used to generate
+  Shomen
+
+  documentation. This is an alternative to the shomen command line tool which
+
+  use the `.rdoc` cache to generate a shomen document. In contrast the rdoc-shomen
+
+  generator operates as a traditional rdoc plugin.'
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- HISTORY.rdoc
+- README.rdoc
+files:
+- .ruby
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/shomen.rb
+- lib/rdoc/generator/shomen_extensions.rb
+- test/case_specification.rb
+- test/fixture/doc/doc.json
+- HISTORY.rdoc
+- LICENSE.txt
+- README.rdoc
+- Confile.rb
+homepage: http://rubyworks.github.com/rdoc-shomen
+licenses:
+- BSD-2-Clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: RDoc Generator for Shomen Documentation Format
+test_files: []