Module: Gorgyrella

Defined in:
lib/gorgyrella/parser.rb,
lib/gorgyrella.rb,
lib/gorgyrella/builder.rb,
lib/gorgyrella/composer.rb,
lib/gorgyrella/gorgyrella.rb,
lib/gorgyrella/formatters/coderay.rb,
lib/gorgyrella/formatters/pygments.rb,
lib/gorgyrella/formatters/ultraviolet.rb

Overview

line 1 “lib/gorgyrella/parser.rl”

Defined Under Namespace

Modules: Formatters Classes: Builder, Composer, Parser

Constant Summary collapse

VERSION =

:stopdoc:

'0.0.2'
LIBPATH = 
::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
PATH = 
::File.dirname(LIBPATH) + ::File::SEPARATOR

Class Method Summary collapse

Class Method Details

.libpath(*args) ⇒ Object

Returns the library path for the module. If any arguments are given, they will be joined to the end of the libray path using File.join.



18
19
20
 
# File 'lib/gorgyrella.rb', line 18

def self.libpath( *args )
  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
end

.path(*args) ⇒ Object

Returns the lpath for the module. If any arguments are given, they will be joined to the end of the path using File.join.



26
27
28
 
# File 'lib/gorgyrella.rb', line 26

def self.path( *args )
  args.empty? ? PATH : ::File.join(PATH, args.flatten)
end

.process(filename) ⇒ Object 



2
3
4
 
# File 'lib/gorgyrella/gorgyrella.rb', line 2

def self.process(filename)
  Composer.new.process(filename)
end

.render_section(filename, section = "1", format = nil, language = nil, formatter = 'Pygments') ⇒ Object 



6
7
8
 
# File 'lib/gorgyrella/gorgyrella.rb', line 6

def self.render_section(filename, section = "1", format = nil, language = nil, formatter = 'Pygments')
  Composer.new(formatter).render_include(filename, section, format, language)
end

.require_all_libs_relative_to(fname, dir = nil) ⇒ Object

Utility method used to require all files ending in .rb that lie in the directory below this file that has the same name as the filename passed in. Optionally, a specific directory name can be passed in such that the filename does not have to be equivalent to the directory.



35
36
37
38
39
40
41
 
# File 'lib/gorgyrella.rb', line 35

def self.require_all_libs_relative_to( fname, dir = nil )
  dir ||= ::File.basename(fname, '.*')
  search_me = ::File.expand_path(
      ::File.join(::File.dirname(fname), dir, '**', '*.rb'))

  Dir.glob(search_me).sort.each {|rb| require rb}
end

.version ⇒ Object

Returns the version string for the library.



10
11
12
 
# File 'lib/gorgyrella.rb', line 10

def self.version
  VERSION
end