Class: MarkdownRubyDocumentation::GitHubLink::MethodUrl

Inherits:
Object
  • Object
show all
Defined in:
lib/markdown_ruby_documentation/git_hub_link.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(subject:, method_object:, base_url: GitHubProject.url, root: GitHubProject.root_path) ⇒ MethodUrl

Returns a new instance of MethodUrl.



61
62
63
64
65
66
 
# File 'lib/markdown_ruby_documentation/git_hub_link.rb', line 61

def initialize(subject:, method_object:, base_url: GitHubProject.url, root: GitHubProject.root_path)
  @subject       = subject
  @base_url      = base_url
  @root          = root
  @method_object = method_object
end

Instance Attribute Details

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



59
60
61
 
# File 'lib/markdown_ruby_documentation/git_hub_link.rb', line 59

def base_url
  @base_url
end

#method_object ⇒ Object (readonly)

Returns the value of attribute method_object.



59
60
61
 
# File 'lib/markdown_ruby_documentation/git_hub_link.rb', line 59

def method_object
  @method_object
end

#root ⇒ Object (readonly)

Returns the value of attribute root.



59
60
61
 
# File 'lib/markdown_ruby_documentation/git_hub_link.rb', line 59

def root
  @root
end

#subject ⇒ Object (readonly)

Returns the value of attribute subject.



59
60
61
 
# File 'lib/markdown_ruby_documentation/git_hub_link.rb', line 59

def subject
  @subject
end

Instance Method Details

#to_s ⇒ Object 



68
69
70
71
 
# File 'lib/markdown_ruby_documentation/git_hub_link.rb', line 68

def to_s
  file, lineno = method_object.source_location
  FileUrl.new(file_path: file, base_url: base_url, root: root).link(file, lineno)
end