rdoc-generator-mdoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc966f0f203abe863af4e82f195c61412bd84417
+  data.tar.gz: 294a5f8c1f826fc2d8cc899ff6db5d99ae764319
+SHA512:
+  metadata.gz: 60ce89d4a4490ac922b11da2cf4575dd20a576e2f6c87a5c641247ed6bab0db41e1eae45c36797ab4ddc347994fcf4f4b9bfe4c35a45782cf4fb92cd5b38cb20
+  data.tar.gz: 488e50382e04531abc0f4823d37a12b992de29d53015d90ad730279e1b9577ebfe30a09ea3a980e87756a6b7df5275c2df59d147cfce8f9828160f61b45c69b4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Calle Erlandsson & thoughtbot, Inc.
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,48 @@
+rdoc-generator-mdoc
+===================
+
+An mdoc(7) generator for [RDoc](https://github.com/rdoc/rdoc).
+
+Usage
+-----
+
+### In Your Ruby Source Code
+
+Add `rdoc-generator-mdoc` to your `Gemfile`:
+
+    gem "rdoc-generator-mdoc"
+
+Specify `mdoc` as the formatter using the `-f` option when calling
+`RDoc::RDoc#new`:
+
+    require "rdoc/generator/mdoc"
+
+    RDoc::RDoc.new.document "-f mdoc"
+
+By default, the mdoc generator will put the generated man pages in section
+`3-rdoc`. If you want the man pages to be put in a different section, specify
+the section using the `--section` option:
+
+    RDoc::RDoc.new.document "-f mdoc --section 3-my-section"
+
+For more information on using the `RDoc::RDoc` class see [the official RDoc
+documentation](http://docs.seattlerb.org/rdoc/).
+
+### Using the `rdoc` executable
+
+Specify `mdoc` as the formatter using the `-f` option:
+
+    $ rdoc -f mdoc
+
+By default, the mdoc generator will put the generated man pages in section
+`3-rdoc`. If you want the man pages to be put in a different section, specify
+the section using the `--section` option:
+
+    $ rdoc -f mdoc --section 3-my-section
+
+Copyright
+---------
+
+Copyright (c) 2014 Calle Erlandsson & thoughtbot, Inc.
+
+Lead by Calle Erlandsson & thoughtbot, Inc.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rdoc/discover.rb

@@ -0,0 +1,5 @@
+begin
+  gem "rdoc", "~> 4"
+  require "rdoc/generator/mdoc"
+rescue Gem::LoadError
+end

data/lib/rdoc/generator/mdoc.rb

@@ -0,0 +1,106 @@
+require "erb"
+require "rdoc"
+require "rdoc/generator/mdoc/version"
+require "rdoc/generator/mdoc/class"
+require "rdoc/generator/mdoc/module"
+require "rdoc/generator/mdoc/render_context"
+
+class RDoc::Options
+  attr_accessor :mandb_section
+end
+
+##
+# An mdoc(7) generator for RDoc.
+#
+# This generator will create man pages in mdoc(7) format for classes, modules
+# and methods parsed by RDoc.
+class RDoc::Generator::Mdoc
+  RDoc::RDoc.add_generator self
+
+  def self.setup_options(options)
+    options.option_parser.on("--section SECTION", String) do |mandb_section|
+      options.mandb_section = mandb_section
+    end
+  end
+
+  ##
+  # Create an instance usign the provided RDoc::Store and RDoc::Options.
+  def initialize(store, options)
+    @store = store
+    @mandb_section = options.mandb_section || "3-rdoc"
+    @output_directory = File.expand_path(File.join(options.op_dir, "man", "man#{mandb_section.split('-').first}"))
+    FileUtils.mkdir_p output_directory
+  end
+
+  ##
+  # Generate man pages.
+  #
+  # Every class, module and method gets their own man page in the
+  # "man/manSECTION_PREFIX" subdirectory of the output directory.
+  def generate
+    generate_class_and_module_pages
+    generate_method_pages
+  end
+
+  private
+
+  attr_reader :store, :output_directory, :mandb_section
+
+  def generate_class_and_module_pages
+    (classes + modules).each do |object|
+      generate_page(file_name(object), "module", module: object)
+    end
+  end
+
+  def generate_method_pages
+    methods.each do |method|
+      generate_page(file_name(method), "method", method: method)
+    end
+  end
+
+  def classes
+    @classes ||= decorate_displayed(store.all_classes, Class)
+  end
+
+  def modules
+    @modules ||= decorate_displayed(store.all_modules, Module)
+  end
+
+  def methods
+    @methods ||= (classes + modules).flat_map(&:methods)
+  end
+
+  def decorate_displayed(objects, decoration_class)
+    objects.select(&:display?).map do |object|
+      decoration_class.new(object, mandb_section)
+    end
+  end
+
+  def generate_page(file_name, template_name, assigns)
+    File.write(file_name, render_template(template(template_name), assigns))
+  end
+
+  def file_name(object)
+    File.join(output_directory, "#{object.full_name}.#{mandb_section}")
+  end
+
+  def render_template(template, assigns)
+    ERB.new(template).result(binding_with_assigns(assigns)).squeeze("\n")
+  end
+
+  def template(name)
+    @templates ||= {}
+    @templates[name] ||= File.read(template_path(name))
+  end
+
+  def template_path(name)
+    File.expand_path(
+      File.join("..", "..", "..", "..", "templates", "#{name}.mdoc.erb"),
+      __FILE__,
+    )
+  end
+
+  def binding_with_assigns(assigns)
+    RenderContext.new(assigns).binding
+  end
+end

data/lib/rdoc/generator/mdoc/attribute.rb

@@ -0,0 +1,33 @@
+require "rdoc/generator/mdoc/comment"
+
+class RDoc::Generator::Mdoc
+  class Attribute
+    def initialize(rdoc_attribute)
+      @rdoc_attribute = rdoc_attribute
+    end
+
+    def name
+      rdoc_attribute.name
+    end
+
+    def rw
+      rdoc_attribute.rw
+    end
+
+    def described?
+      !description.empty?
+    end
+
+    def description
+      comment.mdoc_formatted_content
+    end
+
+    private
+
+    def comment
+      @comment ||= Comment.new(rdoc_attribute.comment.text)
+    end
+
+    attr_reader :rdoc_attribute
+  end
+end

data/lib/rdoc/generator/mdoc/class.rb

@@ -0,0 +1,20 @@
+require "rdoc/generator/mdoc/unknown_class"
+require "rdoc/generator/mdoc/module"
+
+class RDoc::Generator::Mdoc
+  class Class < Module
+    def superclass
+      if rdoc_class.superclass.is_a? String
+        UnknownClass.new(rdoc_class.superclass)
+      else
+        self.class.new(rdoc_class.superclass, mandb_section)
+      end
+    end
+
+    private
+
+    def rdoc_class
+      rdoc_module
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/comment.rb

@@ -0,0 +1,38 @@
+require "rdoc"
+require "rdoc/generator/mdoc/formatter"
+
+class RDoc::Generator::Mdoc
+  class Comment
+    def initialize(markup)
+      @markup = markup
+    end
+
+    def first_paragraph
+      paragraph = rdoc_document.parts.find do |part|
+        part.is_a? RDoc::Markup::Paragraph
+      end
+
+      if paragraph
+        paragraph.text
+      else
+        ""
+      end
+    end
+
+    def mdoc_formatted_content
+      rdoc_document.accept formatter
+    end
+
+    private
+
+    attr_reader :markup
+
+    def rdoc_document
+      @rdoc_document ||= RDoc::Markup.parse(markup)
+    end
+
+    def formatter
+      Formatter.new
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/constant.rb

@@ -0,0 +1,33 @@
+require "rdoc/generator/mdoc/comment"
+
+class RDoc::Generator::Mdoc
+  class Constant
+    def initialize(rdoc_constant)
+      @rdoc_constant = rdoc_constant
+    end
+
+    def name
+      rdoc_constant.name
+    end
+
+    def value
+      rdoc_constant.value
+    end
+
+    def description
+      comment.mdoc_formatted_content
+    end
+
+    def described?
+      !description.empty?
+    end
+
+    private
+
+    attr_reader :rdoc_constant
+
+    def comment
+      @comment ||= Comment.new(rdoc_constant.comment.text)
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/formatter.rb

@@ -0,0 +1,170 @@
+require "rdoc"
+require "rdoc/generator/mdoc/helpers"
+
+class RDoc::Generator::Mdoc
+  ##
+  # Format an RDoc::Document into mdoc.
+  class Formatter < RDoc::Markup::Formatter
+    include Helpers
+
+    ##
+    # Instantiate a mdoc formatter that escapes special mdoc characters.
+    def initialize(options=nil, markup = nil)
+      super
+      init_attribute_manager_tags
+    end
+
+    ##
+    # Initialize the formatter with an empty array of parts and lists.
+    def start_accepting
+      @parts = []
+      @list_types = []
+    end
+
+    ##
+    # Compile the parts together.
+    def end_accepting
+      handle_leading_punctuation parts.join.squeeze("\n")
+    end
+
+    ##
+    # Turn a heading into a subsection header.
+    def accept_heading(heading)
+      parts << ".Ss #{heading.text}\n"
+    end
+
+    ##
+    # Output a paragraph macro for the escaped paragraph.
+    def accept_paragraph(paragraph)
+      parts << handle_inline_attributes(paragraph.text)
+      parts << "\n.Pp\n"
+    end
+
+    ##
+    # Turn a large quoted section into a block display.
+    def accept_block_quote(block_quote)
+      parts << ".Bd -offset indent\n"
+      block_quote.parts.each { |part| part.accept self }
+      parts << "\n.Ed\n.Pp\n"
+    end
+
+    ##
+    # Output paragraph macros for blank lines.
+    def accept_blank_line(blank_line)
+      parts << "\n.Pp\n"
+    end
+
+    ##
+    # Open an enumerated, dictionary, or bulleted list.
+    #
+    # The list must be closed using #accept_list_start.
+    def accept_list_start(list)
+      list_types.push(list.type)
+
+      case current_list_type
+      when :NUMBER, :LALPHA, :UALPHA
+        parts << ".Bl -enum\n"
+      when :LABEL, :NOTE
+        parts << ".Bl -hang -offset -indent\n"
+      else
+        parts << ".Bl -bullet\n"
+      end
+    end
+
+    ##
+    # Close a list.
+    #
+    # This works for all list types.
+    def accept_list_end(list)
+      list_types.pop
+      parts << ".El\n"
+    end
+
+    ##
+    # Open a list item.
+    #
+    # If the list has a label, that label is the list item. Otherwise, the
+    # list item has no content.
+    #
+    # Also see #accept_list_item_end.
+    def accept_list_item_start(list_item)
+      case current_list_type
+      when :LABEL, :NOTE
+        labels =  Array(list_item.label).join(", ")
+        parts << ".It #{labels}\n"
+      else
+        parts << ".It\n"
+      end
+    end
+
+    ##
+    # Finish a list item.
+    #
+    # This works for all list types.
+    def accept_list_item_end(list_item)
+    end
+
+    ##
+    # Format code as an indented block.
+    def accept_verbatim(verbatim)
+      parts << ".Bd -literal -offset indent\n"
+      parts << verbatim.text
+      parts << "\n.Ed\n.Pp\n"
+    end
+
+    ##
+    # Format a horizontal ruler.
+    #
+    # This is a no-op.
+    def accept_rule(rule)
+    end
+
+    ##
+    # Pass through all raw parts unparsed, separated by newlines.
+    def accept_raw(raw)
+      parts << raw.parts.join("\n")
+    end
+
+    private
+
+    attr_accessor :parts, :list_types
+
+    def init_attribute_manager_tags
+      add_tag :BOLD, "\n.Sy ", "\n"
+      add_tag :EM, "\n.Em ", "\n"
+      add_tag :TT, "\n.Li ", "\n"
+    end
+
+    def handle_inline_attributes(text)
+      flow = attribute_manager.flow(text.dup)
+      convert_flow flow
+    end
+
+    def attribute_manager
+      @am
+    end
+
+    def current_list_type
+      list_types.last
+    end
+
+    def convert_string(string)
+      escape(string.strip)
+    end
+
+    ##
+    # Return a string with all new-lines immediately followed by one of:
+    #
+    #   .,:;()[]?!
+    #
+    # immediately followed by whitespace or the end of line replaced with a
+    # space, the matched character and a space.
+    #
+    # This is to prevent lines to start with `.` and to avoid whitespace
+    # between the last word of a sentence and the following punctuation
+    # character.
+    def handle_leading_punctuation(string) # :doc:
+      string.gsub(/\n([.,:;()\[\]?!])(\s|$)/, " \\1\n")
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/helpers.rb

@@ -0,0 +1,33 @@
+class RDoc::Generator::Mdoc
+  ##
+  # A module of helpers when outputting mdoc formatted text
+  module Helpers
+    ##
+    # Returns a new string where characters that mdoc percieve as special have
+    # been escaped.
+    #
+    # This is in line with the advice given in +mdoc.samples(7)+:
+    #
+    # > To remove the special meaning from a punctuation character escape it
+    # > with ‘\&’. Troff is limited as a macro language, and has difficulty
+    # > when pre‐ sented with a string containing a member of the mathematical,
+    # > logical or quotation set:
+    # >
+    # > {+,-,/,*,%,<,>,<=,>=,=,==,&,`,',"}
+    # >
+    # > The problem is that troff may assume it is supposed to actually perform
+    # > the operation or evaluation suggested by the characters. To prevent
+    # > the accidental evaluation of these characters, escape them with ‘\&’.
+    # > Typical syntax is shown in the first content macro displayed below,
+    # > ‘.Ad’.
+    def escape(string)
+      string.gsub(%r|[+\-/*%<>=&`'"]|, '\\\&\0')
+    end
+
+    ##
+    # Returns a new string enclosed in double quotes.
+    def quote(string)
+      string.gsub(/^|$/, '"')
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/method.rb

@@ -0,0 +1,129 @@
+require "active_support/core_ext/string/filters"
+require "rdoc/generator/mdoc/comment"
+
+class RDoc::Generator::Mdoc
+  class Method
+    attr_reader :visibility, :mandb_section
+
+    def initialize(rdoc_method, mandb_section, visibility = nil)
+      @rdoc_method = rdoc_method
+      @mandb_section = mandb_section
+      @visibility = visibility.to_s
+    end
+
+    def name
+      rdoc_method.name
+    end
+
+    def full_name
+      @full_name ||= if class_method?
+        replace_last_double_colon_with_dot(rdoc_method.full_name)
+      else
+        rdoc_method.full_name
+      end
+    end
+
+    def parameters
+      rdoc_method.params.gsub(/[\(\)]/, '').split(", ")
+    end
+
+    def short_description
+      comment.first_paragraph.truncate(50)
+    end
+
+    def described?
+      !description.empty?
+    end
+
+    def description
+      comment.mdoc_formatted_content
+    end
+
+    def has_invocation_examples?
+      !invocation_examples.empty?
+    end
+
+    def invocation_examples
+      @invocation_examples ||= if rdoc_method.call_seq.nil?
+        []
+      else
+        extract_invocation_examples(rdoc_method.call_seq)
+      end
+    end
+
+    def calls_super?
+      !superclass_method.nil?
+    end
+
+    def superclass_method
+      @superclass_method ||= rdoc_method.superclass_method &&
+        self.class.new(rdoc_method.superclass_method, mandb_section)
+    end
+
+    def has_source?
+      !source.nil?
+    end
+
+    def source
+      @source ||= rdoc_method.token_stream &&
+        strip_source_file_path(rdoc_method.tokens_to_s)
+    end
+
+    def alias?
+      !aliased_method.nil?
+    end
+
+    def aliased_method
+      @aliased_method ||= rdoc_method.is_alias_for &&
+        self.class.new(rdoc_method.is_alias_for, mandb_section)
+    end
+
+    def aliased?
+      !aliases.empty?
+    end
+
+    def aliases
+      @aliases ||= rdoc_method.aliases.map do |_alias|
+        self.class.new(_alias, mandb_section)
+      end
+    end
+
+    def reference
+      "#{full_name} #{mandb_section}"
+    end
+
+    def object
+      @object ||= Module.new(rdoc_method.parent, mandb_section)
+    end
+
+    private
+
+    attr_reader :rdoc_method
+
+    def class_method?
+      rdoc_method.singleton
+    end
+
+    def replace_last_double_colon_with_dot(string)
+      string.sub(/(.*)::(.*)/, "\\1.\\2")
+    end
+
+    def comment
+      @comment ||= Comment.new(rdoc_method.comment.text)
+    end
+
+    def extract_invocation_examples(call_seq)
+      call_seq.split("\n").map do |invocation_example|
+        strip_receiver(invocation_example)
+      end
+    end
+
+    def strip_receiver(invocation_example)
+      invocation_example.gsub(/^\w+\./, '')
+    end
+
+    def strip_source_file_path(source)
+      source.lines[1..-1].join
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/module.rb

@@ -0,0 +1,86 @@
+require "active_support/core_ext/string/filters"
+require "rdoc/generator/mdoc/comment"
+require "rdoc/generator/mdoc/section"
+require "rdoc/generator/mdoc/unknown_module"
+
+class RDoc::Generator::Mdoc
+  class Module
+    attr_reader :mandb_section
+
+    def initialize(rdoc_module, mandb_section)
+      @rdoc_module = rdoc_module
+      @mandb_section = mandb_section
+    end
+
+    def full_name
+      rdoc_module.full_name
+    end
+
+    def reference
+      "#{full_name} #{mandb_section}"
+    end
+
+    def short_description
+      comment.first_paragraph.truncate(50)
+    end
+
+    def described?
+      !description.empty?
+    end
+
+    def description
+      comment.mdoc_formatted_content
+    end
+
+    def extended_modules
+      @extended_modules ||= decorate_rdoc_mixins(rdoc_module.extends)
+    end
+
+    def included_modules
+      @included_modules ||= decorate_rdoc_mixins(rdoc_module.includes)
+    end
+
+    def methods
+      sections.flat_map(&:methods)
+    end
+
+    def sections
+      @sections ||=
+        rdoc_module.
+        each_section.
+        map do |rdoc_section, rdoc_constants, rdoc_attributes|
+          Section.new(
+            rdoc_section,
+            rdoc_constants,
+            rdoc_attributes,
+            mandb_section,
+          )
+        end
+    end
+
+    private
+
+    def comment
+      @comment ||= Comment.new(markup)
+    end
+
+    def markup
+      rdoc_module.
+        comment_location.
+        map { |rdoc_comment, _| rdoc_comment.text }.
+        join("\n")
+    end
+
+    def decorate_rdoc_mixins(rdoc_mixins)
+      rdoc_mixins.map(&:module).map do |rdoc_module|
+        if rdoc_module.is_a? String
+          UnknownModule.new(rdoc_module)
+        else
+          self.class.new(rdoc_module, mandb_section)
+        end
+      end
+    end
+
+    attr_reader :rdoc_module
+  end
+end

data/lib/rdoc/generator/mdoc/render_context.rb

@@ -0,0 +1,17 @@
+require "rdoc/generator/mdoc/helpers"
+
+class RDoc::Generator::Mdoc
+  class RenderContext
+    include Helpers
+
+    def initialize(assigns)
+      assigns.each do |name, value|
+        instance_variable_set("@#{name}", value)
+      end
+    end
+
+    def binding
+      super
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/section.rb

@@ -0,0 +1,77 @@
+require "rdoc/generator/mdoc/constant"
+require "rdoc/generator/mdoc/comment"
+require "rdoc/generator/mdoc/attribute"
+require "rdoc/generator/mdoc/method"
+
+class RDoc::Generator::Mdoc
+  class Section
+    def self.method_types
+      [:class, :instance]
+    end
+
+    def initialize(rdoc_section, rdoc_constants, rdoc_attributes, mandb_section)
+      @rdoc_section = rdoc_section
+      @rdoc_constants = rdoc_constants
+      @rdoc_attributes = rdoc_attributes
+      @mandb_section = mandb_section
+    end
+
+    def titled?
+      !title.nil?
+    end
+
+    def title
+      rdoc_section.title
+    end
+
+    def described?
+      !description.empty?
+    end
+
+    def description
+      comment.mdoc_formatted_content
+    end
+
+    def constants
+      @constants ||= rdoc_constants.map do |rdoc_constant|
+        Constant.new(rdoc_constant)
+      end
+    end
+
+    def attributes
+      @attributes ||= rdoc_attributes.map do |rdoc_attribute|
+        Attribute.new(rdoc_attribute)
+      end
+    end
+
+    def methods
+      self.class.method_types.flat_map { |type| methods_of_type(type) }
+    end
+
+    def methods_of_type(type)
+      @methods_of_type ||= {}
+      @methods_of_type[type] ||=
+        rdoc_section.
+        parent.
+        methods_by_type(rdoc_section)[type.to_s].
+        flat_map do |visibility, rdoc_methods|
+          rdoc_methods.map do
+            |rdoc_method| Method.new(rdoc_method, mandb_section, visibility)
+          end
+        end
+    end
+
+    private
+
+    attr_reader :rdoc_section, :rdoc_constants, :rdoc_attributes,
+      :mandb_section
+
+    def markup
+      rdoc_section.comments.map(&:normalize).map(&:text).join
+    end
+
+    def comment
+      @comment ||= Comment.new(markup)
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/unknown_class.rb

@@ -0,0 +1,11 @@
+class RDoc::Generator::Mdoc
+  class UnknownClass
+    def initialize(full_name)
+      @full_name = full_name
+    end
+
+    def reference
+      @full_name
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/unknown_module.rb

@@ -0,0 +1,11 @@
+class RDoc::Generator::Mdoc
+  class UnknownModule
+    def initialize(full_name)
+      @full_name = full_name
+    end
+
+    def reference
+      @full_name
+    end
+  end
+end

data/lib/rdoc/generator/mdoc/version.rb

@@ -0,0 +1,7 @@
+module RDoc
+  module Generator
+    class Mdoc
+      VERSION = "0.0.1"
+    end
+  end
+end

data/rdoc-generator-mdoc.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rdoc/generator/mdoc/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rdoc-generator-mdoc"
+  spec.version = RDoc::Generator::Mdoc::VERSION
+  spec.authors = ["Calle Erlandsson", "Mike Burns"]
+  spec.email = ["calle@thoughtbot.com", "hello@thoughtbot.com"]
+  spec.summary = "An mdoc(7) generator for RDoc"
+  spec.homepage = "https://github.com/thoughtbot/rdoc-generator-mdoc"
+  spec.license = "MIT"
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "rdoc", "~> 4"
+  spec.add_dependency "activesupport", "~> 4"
+end

data/templates/method.mdoc.erb

@@ -0,0 +1,48 @@
+.Dd <%= Time.now.strftime "%B %-d, %Y" %>
+.Dt <%= @method.full_name.upcase %> <%= @method.mandb_section %>
+.Os
+.Sh NAME
+.Nm <%= @method.full_name %>
+.Nd <%= @method.short_description %>
+<% if @method.has_invocation_examples? %>
+.Sh SYNPOSIS
+.Bd -literal
+<%= @method.invocation_examples.join("\n") %>
+.Ed
+.Pp
+<% end %>
+.Sh DESCRIPTION
+<% if @method.described? %>
+<%= @method.description %>
+<% else %>
+Not documented.
+.Pp
+<% end %>
+<% if @method.calls_super? %>
+.Ss Calls superclass method
+.Xr <%= escape @method.superclass_method.reference %>
+.Pp
+<% end %>
+<% if @method.alias? %>
+.Ss Alias for
+.Xr <%= escape @method.aliased_method.reference %>
+.Pp
+<% end %>
+<% if @method.aliased? %>
+.Ss Also aliased as
+.Bl -bullet -compact
+<% @method.aliases.each do |_alias| %>
+.It
+.Xr <%= escape _alias.reference %>
+<% end %>
+.El
+<% end %>
+<% if @method.has_source? %>
+.Sh SOURCE
+.Bd -literal
+<%= @method.source %>
+.Ed
+.Pp
+<% end %>
+.Sh SEE ALSO
+.Xr <%= @method.object.reference %>

data/templates/module.mdoc.erb

@@ -0,0 +1,114 @@
+.Dd <%= Time.now.strftime "%B %-d, %Y" %>
+.Dt <%= @module.full_name.upcase %> <%= @module.mandb_section %>
+.Os
+.Sh NAME
+.Nm <%= @module.full_name %>
+.Nd <%= @module.short_description %>
+.Sh DESCRIPTION
+<% if @module.described? %>
+<%= @module.description %>
+<% else %>
+Not documented.
+.Pp
+<% end %>
+<% if @module.respond_to?(:superclass) %>
+.Ss Superclass
+.Xr <%= escape @module.superclass.reference %> .
+.Pp
+<% end %>
+<% unless @module.extended_modules.empty? %>
+.Ss Extended Modules
+.Bl -bullet -compact
+<% @module.extended_modules.each do |_module| %>
+.It
+.Xr <%= escape _module.reference %>
+<% end %>
+.El
+<% end %>
+<% unless @module.included_modules.empty? %>
+.Ss Included Modules
+.Bl -bullet -compact
+<% @module.included_modules.each do |_module| %>
+.It
+.Xr <%= escape _module.reference %>
+<% end %>
+.El
+<% end %>
+<% @module.sections.each do |section| %>
+<% if section.titled? %>
+.Sh <%= section.title.upcase %>
+<% end %>
+<% if section.described? %>
+<%= section.description %>
+<% end %>
+<% unless section.constants.empty? %>
+.Ss Constants
+.Bl -tag
+<% section.constants.each do |constant| %>
+.It Dv <%= constant.name %> Li = <%= escape constant.value %>
+<% if constant.described? %>
+<%= constant.description %>
+<% else %>
+Not documented.
+.Pp
+<% end %>
+<% end %>
+.El
+<% end %>
+<% unless section.attributes.empty? %>
+.Ss Attributes
+.Bl -tag
+<% section.attributes.each do |attribute| %>
+.It Va <%= attribute.name %> Pq <%= attribute.rw %>
+<% if attribute.described? %>
+<%= attribute.description %>
+<% else %>
+Not documented.
+.Pp
+<% end %>
+<% end %>
+.El
+<% end %>
+<% section.class.method_types.each do |type| %>
+<% unless section.methods_of_type(type).empty? %>
+.Ss <%= type.capitalize %> Methods
+.Bl -tag
+<% section.methods_of_type(type).each do |method| %>
+.It Fn "<%= escape method.visibility %> <%= escape method.name %>" <%=
+method.parameters.map { |p| quote(escape(p)) }.join(" ") %>
+<% if method.has_invocation_examples? %>
+.Bd -literal
+<%= method.invocation_examples.join("\n") %>
+.Ed
+.Pp
+<% end %>
+<% if method.described? %>
+<%= method.description %>
+<% else %>
+Not documented.
+.Pp
+<% end %>
+<% if method.calls_super? %>
+Calls superclass method
+.Xr <%= escape method.superclass_method.reference %> .
+.Pp
+<% end %>
+<% if method.alias? %>
+Alias for
+.Xr <%= escape method.aliased_method.reference %> .
+.Pp
+<% end %>
+<% if method.aliased? %>
+Also aliased as:
+.Bl -bullet -compact
+<% method.aliases.each do |_alias| %>
+.It
+.Xr <%= escape _alias.reference %>
+<% end %>
+.El
+<% end %>
+<% end %>
+.El
+<% end %>
+<% end %>
+<% end %>

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: rdoc-generator-mdoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Calle Erlandsson
+- Mike Burns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: 
+email:
+- calle@thoughtbot.com
+- hello@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/mdoc.rb
+- lib/rdoc/generator/mdoc/attribute.rb
+- lib/rdoc/generator/mdoc/class.rb
+- lib/rdoc/generator/mdoc/comment.rb
+- lib/rdoc/generator/mdoc/constant.rb
+- lib/rdoc/generator/mdoc/formatter.rb
+- lib/rdoc/generator/mdoc/helpers.rb
+- lib/rdoc/generator/mdoc/method.rb
+- lib/rdoc/generator/mdoc/module.rb
+- lib/rdoc/generator/mdoc/render_context.rb
+- lib/rdoc/generator/mdoc/section.rb
+- lib/rdoc/generator/mdoc/unknown_class.rb
+- lib/rdoc/generator/mdoc/unknown_module.rb
+- lib/rdoc/generator/mdoc/version.rb
+- rdoc-generator-mdoc.gemspec
+- templates/method.mdoc.erb
+- templates/module.mdoc.erb
+homepage: https://github.com/thoughtbot/rdoc-generator-mdoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An mdoc(7) generator for RDoc
+test_files: []
+has_rdoc: