Module: GitHub::Markup

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

Defined Under Namespace

Classes: RDoc

Constant Summary collapse

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

Instance Method Summary collapse

Instance Method Details

#add_markup(regexp, &block) ⇒ Object 



55
56
57
 
# File 'lib/github/markup.rb', line 55

def add_markup(regexp, &block)
  @@markups[regexp] = block
end

#can_render?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/github/markup.rb', line 59

def can_render?(filename)
  !!renderer(filename)
end

#command(command, regexp, &block) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/github/markup.rb', line 30

def command(command, regexp, &block)
  command = command.to_s

  if File.exists?(file = File.dirname(__FILE__) + "/commands/#{command}")
    command = file
  end

  add_markup(regexp) do |content|
    rendered = execute(command, content)
    rendered = rendered.to_s.empty? ? content : rendered

    if block && block.arity == 2
      # If the block takes two arguments, pass new content and old
      # content.
      block.call(rendered, content)
    elsif block
      # One argument is just the new content.
      block.call(rendered)
    else
      # No block? No problem!
      rendered
    end
  end
end

#execute(command, target) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/github/markup.rb', line 81

def execute(command, target)
  out = ''
  Open3.popen3(command) do |stdin, stdout, _|
    stdin.puts target
    stdin.close
    out = stdout.read
  end
  out.gsub("\r", '')
rescue Errno::EPIPE
  ""
end

#markup(file, pattern, &block) ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/github/markup.rb', line 22

def markup(file, pattern, &block)
  require file.to_s
  add_markup(pattern, &block)
  true
rescue LoadError
  false
end

#render(filename, content = nil) ⇒ Object 



12
13
14
15
16
17
18
19
20
 
# File 'lib/github/markup.rb', line 12

def render(filename, content = nil)
  content ||= File.read(filename)

  if proc = renderer(filename)
    proc[content]
  else
    content
  end
end

#renderer(filename) ⇒ Object 



63
64
65
66
67
68
69
70
 
# File 'lib/github/markup.rb', line 63

def renderer(filename)
  @@markups.each do |key, value|
    if Regexp.compile("\\.(#{key})$") =~ filename
      return value
    end
  end
  nil
end

#renderer_name(filename) ⇒ Object 



72
73
74
75
76
77
78
79
 
# File 'lib/github/markup.rb', line 72

def renderer_name(filename)
  @@markups.each do |key, value|
    if Regexp.compile("\\.(#{key})$") =~ filename
      return key
    end
  end
  nil
end