Module: InteractorsMindmap

Defined in:
lib/interactors_mindmap.rb,
lib/interactors_mindmap/cli.rb,
lib/interactors_mindmap/version.rb,
lib/interactors_mindmap/tree_node.rb,
lib/interactors_mindmap/doc_files_generator.rb,
lib/interactors_mindmap/interactors_names_parser.rb

Overview

InteractorsMindmap module

Defined Under Namespace

Classes: Cli, DocFilesGenerator, InteractorsNamesParser, TreeNode

Constant Summary collapse

INTERACTORS_FILES_PATH = 
"**/app/interactors/**/*.rb"
NO_INTERACTORS_FOUND_MESSAGE = 
"No interactors found!"
MD_FILE_GENERATED_MESSAGE = 
"Interactors .md file successfully generated!"
HTML_FILE_GENERATED_MESSAGE = 
"Interactors .html file successfully generated!"
VERSION = 
"0.4.0"

Class Method Summary collapse

Class Method Details

.generate_docs(interactors_files_path = INTERACTORS_FILES_PATH) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/interactors_mindmap.rb', line 16

def self.generate_docs(interactors_files_path = INTERACTORS_FILES_PATH)
  interactor_names = interactor_names_from_files_on_path(interactors_files_path)

  if interactor_names.one?
    puts NO_INTERACTORS_FOUND_MESSAGE
    return
  end
  generate_md_file(interactor_names)
  generate_html_file(interactor_names)
end

.generate_html_file(interactor_names) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/interactors_mindmap.rb', line 42

def self.generate_html_file(interactor_names)
  if interactor_names.one?
    puts NO_INTERACTORS_FOUND_MESSAGE
    return
  end

  InteractorsMindmap::DocFilesGenerator.generate_html_file(interactor_names:)

  puts HTML_FILE_GENERATED_MESSAGE
end

.generate_md_file(interactor_names) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/interactors_mindmap.rb', line 31

def self.generate_md_file(interactor_names)
  if interactor_names.one?
    puts NO_INTERACTORS_FOUND_MESSAGE
    return
  end

  InteractorsMindmap::DocFilesGenerator.generate_md_file(interactor_names:)

  puts MD_FILE_GENERATED_MESSAGE
end

.interactor_names_from_files_on_path(interactors_files_path = INTERACTORS_FILES_PATH) ⇒ Object 



27
28
29
 
# File 'lib/interactors_mindmap.rb', line 27

def self.interactor_names_from_files_on_path(interactors_files_path = INTERACTORS_FILES_PATH)
  InteractorsMindmap::InteractorsNamesParser.perform(files_path: interactors_files_path)
end