Module: GitHub::Markup

Extended by:
Markup
Included in:
Markup
Defined in:
lib/github-markup.rb,
lib/github/markup.rb,
lib/github/markup/rdoc.rb,
lib/github/markup/markdown.rb,
lib/github/markup/implementation.rb,
lib/github/markup/gem_implementation.rb,
lib/github/markup/command_implementation.rb

Defined Under Namespace

Classes: CommandError, CommandImplementation, GemImplementation, Implementation, Markdown, RDoc

Constant Summary collapse

VERSION = 
'1.7.0'
Version = 
VERSION
@@markups = 
{}

Instance Method Summary collapse

Instance Method Details

#can_render?(filename, content, symlink = false) ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/github/markup.rb', line 83

def can_render?(filename, content, symlink = false)
  !!renderer(filename, content, symlink)
end

#command(symbol, command, regexp, languages, name, &block) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/github/markup.rb', line 75

def command(symbol, command, regexp, languages, name, &block)
  if File.exist?(file = File.dirname(__FILE__) + "/commands/#{command}")
    command = file
  end

  markup_impl(symbol, CommandImplementation.new(regexp, languages, command, name, &block))
end

#language(filename, content, symlink = false) ⇒ Object 



94
95
96
97
98
99
 
# File 'lib/github/markup.rb', line 94

def language(filename, content, symlink = false)
  if defined?(::Linguist)
    blob = Linguist::Blob.new(filename, content, symlink: symlink)
    return Linguist.detect(blob, allow_empty: true)
  end
end

#markup(symbol, gem_name, regexp, languages, opts = {}, &block) ⇒ Object 



64
65
66
 
# File 'lib/github/markup.rb', line 64

def markup(symbol, gem_name, regexp, languages, opts = {}, &block)
  markup_impl(symbol, GemImplementation.new(regexp, languages, gem_name, &block))
end

#markup_impl(symbol, impl) ⇒ Object 



68
69
70
71
72
73
 
# File 'lib/github/markup.rb', line 68

def markup_impl(symbol, impl)
  if markups.has_key?(symbol)
    raise ArgumentError, "The '#{symbol}' symbol is already defined."
  end
  markups[symbol] = impl
end

#markup_impls ⇒ Object 



33
34
35
 
# File 'lib/github/markup.rb', line 33

def markup_impls
  markups.values
end

#markups ⇒ Object 



29
30
31
 
# File 'lib/github/markup.rb', line 29

def markups
  @@markups
end

#preload! ⇒ Object 



37
38
39
40
41
 
# File 'lib/github/markup.rb', line 37

def preload!
  markup_impls.each do |markup|
    markup.load
  end
end

#render(filename, content = nil, symlink = nil) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/github/markup.rb', line 43

def render(filename, content = nil, symlink = nil)
  content ||= File.read(filename)
  symlink = (File.symlink?(filename) rescue false) if symlink.nil?

  if impl = renderer(filename, content, symlink)
    impl.render(filename, content)
  else
    content
  end
end

#render_s(symbol, content) ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'lib/github/markup.rb', line 54

def render_s(symbol, content)
  if content.nil?
    raise ArgumentError, 'Can not render a nil.'
  elsif markups.has_key?(symbol)
    markups[symbol].render(nil, content)
  else
    content
  end
end

#renderer(filename, content, symlink = false) ⇒ Object 



87
88
89
90
91
92
 
# File 'lib/github/markup.rb', line 87

def renderer(filename, content, symlink = false)
  language = language(filename, content, symlink)
  markup_impls.find { |impl|
    impl.match?(filename, language)
  }
end