Module: MarkdownTree

Defined in:
lib/markdown_tree.rb,
lib/markdown_tree/railtie.rb,
lib/markdown_tree/version.rb,
lib/markdown_tree/configuration.rb

Defined Under Namespace

Classes: Configuration, Railtie

Constant Summary collapse

VERSION = 
"0.1.3"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



7
8
9
 
# File 'lib/markdown_tree.rb', line 7

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Yields:



15
16
17
18
 
# File 'lib/markdown_tree/configuration.rb', line 15

def configure
  self.configuration ||= Configuration.new
  yield(configuration)
end

.exclude_list ⇒ Object 



20
21
22
 
# File 'lib/markdown_tree/configuration.rb', line 20

def exclude_list
  configuration.exclude_list
end

.generate_tree(directory = nil) ⇒ Object 



11
12
13
14
15
16
17
 
# File 'lib/markdown_tree.rb', line 11

def generate_tree(directory = nil)
  directory ||= configuration.root_directory || Dir.pwd

  File.open(configuration.output_file, "w") do |file|
    process_directory(directory, file)
  end
end

.output_file ⇒ Object 



28
29
30
 
# File 'lib/markdown_tree/configuration.rb', line 28

def output_file
  configuration.output_file
end

.root_directory ⇒ Object 



24
25
26
 
# File 'lib/markdown_tree/configuration.rb', line 24

def root_directory
  configuration.root_directory
end