markdown_ruby_documentation 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da10c03a7f12fb025a7db239f90eb3f64048b539
-  data.tar.gz: 78ee42c083c248f85c70acd89b45943fb501d103
+  metadata.gz: 89c92e0b3d12b3f80da67905864c6f5b7a31cd79
+  data.tar.gz: 15c908a0de16d99f4baf8b03d4f66f58416bb242
 SHA512:
-  metadata.gz: 9f63f39ef70eec9ad9c8c26e0b5a39800fe8e44ea74dd0b13eb960b10d843767d5acdbe8338d4b5ad25ef48a942cf8fa44cdcd99990fb85284f3e6aab009060e
-  data.tar.gz: 494a8f0a5d00dc2e27b3624e398afc09c9467d3a04ef7bf1fb08b8b4dc7e1c52332b9fa0c7536f8596cd680d8eda07c4932a8ca3087bab7037566f62e7af87ec
+  metadata.gz: 5bc675cf2689ed27296c5c22fa8224590a1ae71beee02ae189461985a57d6a353ee52b50b211bd72747cc5a88803633141bebf67c3bf7cc0f6f31b3901e36718
+  data.tar.gz: 8de69ad32561270e855092dbf111066c9c7de1deffad0f548b642d43ba59d494ad885b84b4e3238c8c2521d6697f42feb0bc5707fa84587bc007d956eb6e47c4

data/README.md

@@ -77,6 +77,14 @@ Creates a url to the method location on GitHub based on the current sha or it de
 ##### `git_hub_file_url(file_path || Class)`
 Creates a url to the file on GitHub based on the current sha or it defaults to master.
 
+##### `link_to_markdown` or `link_to`(klass_or_path, title: String)
+@param [Class, String, Pathname] klass_or_path
+  1. String or Class representing a method reference
+  2. Pathname representing the full path of the file location a method is defined
+@param [String] title is the link display value
+@return [String, Symbol] Creates link to a given generated markdown file or returns :non_project_location message.
+  1. "[title](path/to/markdown/file.md#method-name)"
+  2. :non_project_location
 
 ##### Example method reference inputs
 

data/lib/markdown_ruby_documentation.rb

@@ -11,6 +11,7 @@ require "markdown_ruby_documentation/git_hub_link"
 require "markdown_ruby_documentation/git_hub_project"
 require "markdown_ruby_documentation/reject_blank_methods"
 require "markdown_ruby_documentation/method_linker"
+require "markdown_ruby_documentation/relative_link_converter"
 require "markdown_ruby_documentation/method"
 require "markdown_ruby_documentation/method/instance_method"
 require "markdown_ruby_documentation/method/class_method"

data/lib/markdown_ruby_documentation/generate.rb

@@ -115,6 +115,7 @@ module MarkdownRubyDocumentation
       def string_pipeline
         [
           MethodLinker.new(section_key: section_key, root_path: "./"),
+          RelativeLinkConverter.new(subject: subject),
         ]
       end
 

data/lib/markdown_ruby_documentation/method_linker.rb

@@ -4,7 +4,6 @@ module MarkdownRubyDocumentation
     attr_reader :text, :section_key, :root_path
 
     def initialize(section_key:, root_path:)
-
       @section_key = section_key
       @root_path   = root_path
     end

data/lib/markdown_ruby_documentation/relative_link_converter.rb

@@ -0,0 +1,43 @@
+module MarkdownRubyDocumentation
+  class RelativeLinkConverter
+    attr_reader :text, :root_path, :subject
+
+    def initialize(subject:)
+      @root_path = root_path
+      @subject   = subject
+    end
+
+    def call(text=nil)
+      @text = text
+      generate
+    end
+
+    def generate
+      text.scan(/\[.*\]\((.*)\)/).each do |r|
+        link = r.first
+        if link.include?(path.to_s)
+          @text = text.gsub(link, create_relative_link(link))
+        end
+      end
+      text
+    end
+
+    def path
+      @path ||= begin
+        method = MarkdownRubyDocumentation::Method.create(subject.name, null_method: true, context: Kernel)
+        parts  = method.context_name.to_s.split("::").reject(&:blank?)
+        path   = parts.map { |p| p.underscore }.join("/")
+        path   = "#{path}.md#{method.type_symbol}#{method.name}"
+        MarkdownRubyDocumentation::GitHubLink::FileUrl.new(file_path: File.join(MarkdownRubyDocumentation::Generate.output_object.relative_dir, path)).to_s
+      end
+    end
+
+    def create_relative_link(link)
+      if link.include?("#")
+        "#" + link.split("#").last
+      else
+        link
+      end
+    end
+  end
+end

data/lib/markdown_ruby_documentation/template_parser.rb

@@ -251,7 +251,7 @@ module MarkdownRubyDocumentation
       # @return [String, Symbol] Creates link to a given generated markdown file or returns :non_project_location message.
       #   1. "[title](path/to/markdown/file.md#method-name)"
       #   2. :non_project_location
-      def link_to_markdown(klass_or_path, title:, _ruby_class: ruby_class)
+      def link_to_markdown(klass_or_path, _ruby_class: ruby_class, title: default_title(klass_or_path, _ruby_class))
         if klass_or_path.is_a?(String) || klass_or_path.is_a?(Class) || klass_or_path.is_a?(Module)
           link_to_markdown_method_reference(method_reference: klass_or_path, title: title, ruby_class: _ruby_class)
         elsif klass_or_path.is_a?(Pathname)
@@ -261,6 +261,17 @@ module MarkdownRubyDocumentation
         end
       end
 
+      alias_method :link_to, :link_to_markdown
+
+      def default_title(klass_or_path, _ruby_class)
+        method = MarkdownRubyDocumentation::Method.create(klass_or_path, null_method: true, context: _ruby_class)
+        if method.name
+          method.name
+        else
+          method.context_name.to_s.demodulize
+        end.to_s.titleize
+      end
+
       def link_to_markdown_method_reference(method_reference:, title:, ruby_class:)
         method = MarkdownRubyDocumentation::Method.create(method_reference, null_method: true, context: ruby_class)
         parts  = method.context_name.to_s.split("::").reject(&:blank?)

data/lib/markdown_ruby_documentation/version.rb

@@ -1,3 +1,3 @@
 module MarkdownRubyDocumentation
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_ruby_documentation
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Dustin Zeisler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -128,6 +128,7 @@ files:
 - lib/markdown_ruby_documentation/method/null_method.rb
 - lib/markdown_ruby_documentation/method_linker.rb
 - lib/markdown_ruby_documentation/reject_blank_methods.rb
+- lib/markdown_ruby_documentation/relative_link_converter.rb
 - lib/markdown_ruby_documentation/summary.rb
 - lib/markdown_ruby_documentation/template_parser.rb
 - lib/markdown_ruby_documentation/template_parser/any_args.rb