rdoc-generator-mdoc 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc966f0f203abe863af4e82f195c61412bd84417
-  data.tar.gz: 294a5f8c1f826fc2d8cc899ff6db5d99ae764319
+  metadata.gz: 65e13352de700980bfa375a2aa5984af7dd3e029
+  data.tar.gz: 129c79792e882b1fda01d38832cd6277f4a7735b
 SHA512:
-  metadata.gz: 60ce89d4a4490ac922b11da2cf4575dd20a576e2f6c87a5c641247ed6bab0db41e1eae45c36797ab4ddc347994fcf4f4b9bfe4c35a45782cf4fb92cd5b38cb20
-  data.tar.gz: 488e50382e04531abc0f4823d37a12b992de29d53015d90ad730279e1b9577ebfe30a09ea3a980e87756a6b7df5275c2df59d147cfce8f9828160f61b45c69b4
+  metadata.gz: 2f4b84fbbfd8ad2cc7e881172383d84c9932b69cf56bdda57d7b70a3c300313ddceda4bca81a25fab04d98d49580e63b8ee601f38011e52da4e2aff38f08d7bf
+  data.tar.gz: 0052a203799ac1574663875d7c7123c826918445538a06ddd5fefe699e51889691250f66aa29d58dd9c5e1bbfdd0d6fc949ccfc351e27e213c2d6a198662db33

data/lib/rdoc/generator/mdoc.rb

@@ -1,6 +1,5 @@
 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"
@@ -27,8 +26,10 @@ class RDoc::Generator::Mdoc
   # 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}"))
+    @mandb_section = sanitize_mandb_section(
+      options.mandb_section || "3-rdoc",
+    )
+    @output_directory = File.expand_path(File.join(options.op_dir, "man#{mandb_section.split('-').first}"))
     FileUtils.mkdir_p output_directory
   end
 
@@ -36,7 +37,7 @@ class RDoc::Generator::Mdoc
   # Generate man pages.
   #
   # Every class, module and method gets their own man page in the
-  # "man/manSECTION_PREFIX" subdirectory of the output directory.
+  # "manSECTION_PREFIX" subdirectory of the output directory.
   def generate
     generate_class_and_module_pages
     generate_method_pages
@@ -81,7 +82,18 @@ class RDoc::Generator::Mdoc
   end
 
   def file_name(object)
-    File.join(output_directory, "#{object.full_name}.#{mandb_section}")
+    File.join(
+      output_directory,
+      "#{sanitize_file_name(object.full_name)}.#{mandb_section}",
+    )
+  end
+
+  def sanitize_file_name(string)
+    string.gsub("/", "\\")
+  end
+
+  def sanitize_mandb_section(string)
+    string.gsub(".", "-")
   end
 
   def render_template(template, assigns)

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

@@ -25,7 +25,7 @@ class RDoc::Generator::Mdoc
     private
 
     def comment
-      @comment ||= Comment.new(rdoc_attribute.comment.text)
+      @comment ||= Comment.new(rdoc_attribute.comment)
     end
 
     attr_reader :rdoc_attribute

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

@@ -4,7 +4,9 @@ require "rdoc/generator/mdoc/module"
 class RDoc::Generator::Mdoc
   class Class < Module
     def superclass
-      if rdoc_class.superclass.is_a? String
+      if rdoc_class.superclass.nil?
+        UnknownClass.new("Object")
+      elsif rdoc_class.superclass.is_a? String
         UnknownClass.new(rdoc_class.superclass)
       else
         self.class.new(rdoc_class.superclass, mandb_section)

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

@@ -3,8 +3,17 @@ require "rdoc/generator/mdoc/formatter"
 
 class RDoc::Generator::Mdoc
   class Comment
-    def initialize(markup)
-      @markup = markup
+    def initialize(comment)
+      case comment
+      when RDoc::Markup::Document
+        @rdoc_document = comment
+      when RDoc::Comment
+        @markup = comment.text
+      when String
+        @markup = comment
+      else
+        raise "Can't handle input of class: #{comment.class}"
+      end
     end
 
     def first_paragraph

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

@@ -27,7 +27,7 @@ class RDoc::Generator::Mdoc
     attr_reader :rdoc_constant
 
     def comment
-      @comment ||= Comment.new(rdoc_constant.comment.text)
+      @comment ||= Comment.new(rdoc_constant.comment)
     end
   end
 end

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

@@ -21,13 +21,13 @@ class RDoc::Generator::Mdoc
     # > Typical syntax is shown in the first content macro displayed below,
     # > ‘.Ad’.
     def escape(string)
-      string.gsub(%r|[+\-/*%<>=&`'"]|, '\\\&\0')
+      string.to_s.gsub(%r|[+\-/*%<>=&`'"]|, '\\\&\0')
     end
 
     ##
     # Returns a new string enclosed in double quotes.
     def quote(string)
-      string.gsub(/^|$/, '"')
+      string.to_s.gsub(/^|$/, '"')
     end
   end
 end

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

@@ -24,7 +24,7 @@ class RDoc::Generator::Mdoc
     end
 
     def parameters
-      rdoc_method.params.gsub(/[\(\)]/, '').split(", ")
+      rdoc_method.params.to_s.gsub(/[\(\)]/, '').split(", ")
     end
 
     def short_description
@@ -66,7 +66,7 @@ class RDoc::Generator::Mdoc
 
     def source
       @source ||= rdoc_method.token_stream &&
-        strip_source_file_path(rdoc_method.tokens_to_s)
+        strip_source_file_path(extract_source(rdoc_method.token_stream))
     end
 
     def alias?
@@ -109,7 +109,7 @@ class RDoc::Generator::Mdoc
     end
 
     def comment
-      @comment ||= Comment.new(rdoc_method.comment.text)
+      @comment ||= Comment.new(rdoc_method.comment)
     end
 
     def extract_invocation_examples(call_seq)
@@ -125,5 +125,9 @@ class RDoc::Generator::Mdoc
     def strip_source_file_path(source)
       source.lines[1..-1].join
     end
+
+    def extract_source(token_stream)
+      token_stream.compact.map { |t| t.text }.join('')
+    end
   end
 end

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

@@ -54,21 +54,27 @@ class RDoc::Generator::Mdoc
             rdoc_constants,
             rdoc_attributes,
             mandb_section,
+            self,
           )
         end
     end
 
+    def methods_by_type(section)
+      rdoc_module.methods_by_type(section)
+    end
+
     private
 
     def comment
-      @comment ||= Comment.new(markup)
+      @comment ||= if rdoc_module.comment_location.is_a? RDoc::Markup::Document
+        Comment.new(rdoc_module.comment_location)
+      else
+        Comment.new(extract_markup(rdoc_module.comment_location))
+      end
     end
 
-    def markup
-      rdoc_module.
-        comment_location.
-        map { |rdoc_comment, _| rdoc_comment.text }.
-        join("\n")
+    def extract_markup(comment_location)
+      comment_location.map { |rdoc_comment, _| rdoc_comment.text }.join("\n")
     end
 
     def decorate_rdoc_mixins(rdoc_mixins)

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

@@ -9,11 +9,18 @@ class RDoc::Generator::Mdoc
       [:class, :instance]
     end
 
-    def initialize(rdoc_section, rdoc_constants, rdoc_attributes, mandb_section)
+    def initialize(
+      rdoc_section,
+      rdoc_constants,
+      rdoc_attributes,
+      mandb_section,
+      parent
+    )
       @rdoc_section = rdoc_section
       @rdoc_constants = rdoc_constants
       @rdoc_attributes = rdoc_attributes
       @mandb_section = mandb_section
+      @parent = parent
     end
 
     def titled?
@@ -51,12 +58,13 @@ class RDoc::Generator::Mdoc
     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)
+          rdoc_methods.select do |rdoc_method|
+            rdoc_method.is_a? RDoc::AnyMethod
+          end.map do |rdoc_method|
+            Method.new(rdoc_method, mandb_section, visibility)
           end
         end
     end
@@ -64,14 +72,14 @@ class RDoc::Generator::Mdoc
     private
 
     attr_reader :rdoc_section, :rdoc_constants, :rdoc_attributes,
-      :mandb_section
-
-    def markup
-      rdoc_section.comments.map(&:normalize).map(&:text).join
-    end
+      :mandb_section, :parent
 
     def comment
-      @comment ||= Comment.new(markup)
+      @comment ||= if rdoc_section.comments.is_a? RDoc::Markup::Document
+        Comment.new(rdoc_section.comments)
+      else
+        Comment.new(rdoc_section.comments.map(&:normalize).map(&:text).join)
+      end
     end
   end
 end

data/rdoc-generator-mdoc.gemspec

@@ -1,10 +1,6 @@
-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.version = "0.0.3"
   spec.authors = ["Calle Erlandsson", "Mike Burns"]
   spec.email = ["calle@thoughtbot.com", "hello@thoughtbot.com"]
   spec.summary = "An mdoc(7) generator for RDoc"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-generator-mdoc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Calle Erlandsson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-07 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,6 @@ files:
 - 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

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

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