Class: DataDoc::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/data_doc/cli.rb

Overview

Manages command-line options and arguments.

Class Method Summary collapse

Class Method Details

.execute(stdout, arguments = []) ⇒ Object

Parses the command line and calls the main object.

stdout

IO to redirect output for testing.

arguments

contents of command line



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/data_doc/cli.rb', line 17

def self.execute(stdout, arguments=[])

  doc = DataDoc::Document.new
  filename = nil

  OptionParser.new do |opts|
    opts.banner = "      \#{DataDoc::DESCRIPTION}\n\n      Usage: \#{File.basename($0)} [options] filename\n\n      Options are:\n    BANNER\n    \n    opts.separator \"\"\n    opts.separator \"Specific options:\"\n\n    opts.on(\"-c\", \"--connection FILENAME\", \n            \"Override document connection settings with FILENAME\") do |conn_filename|\n      begin\n        doc.connection = conn_filename\n      rescue Exception => e\n        stdout.puts \"ERROR with connection file (\#{e.message})\"\n        return 1\n      end\n    end\n    \n    opts.on(\"-r\", \"--read-only\", \"Use data already in database rather than document data\") do |r|\n      doc.read_only = r\n    end\n    \n    opts.on(\"-d\", \"--data-only\", \"Use document data but do not change database schema\") do |d|\n      doc.data_only = d\n    end\n\n    opts.on(\"-o\", \"--output FILENAME\", \n            \"Put generated output in FILENAME\") do |f|  \n      filename = f\n    end\n            \n    type_list = DataDoc::Document::OUTPUT_TYPES.join(', ')\n    opts.on(\"-f\", \"--format TYPE\", DataDoc::Document::OUTPUT_TYPES, \"Select type of output from \#{type_list} (default: \#{doc.format})\") do |format|\n      doc.format = format\n    end\n    \n    opts.on(\"-p\", \"--prince PATH\", \n            \"Path for prince pdf generator\") do |p|  \n      doc.prince = p\n    end        \n\n    opts.on(\"-v\", \"--[no-]verbose\", \"Run verbosely\") do |v|\n      doc.verbose = v\n    end\n\n    opts.separator \"\"\n    opts.separator \"Common options:\"\n\n    opts.on_tail(\"-h\", \"--help\", \"Show this message\") do\n      stdout.puts opts\n      return 0\n    end\n\n    opts.on_tail(\"--version\", \"Show version\") do\n      stdout.puts DataDoc::VERSION\n      return 0\n    end        \n    \n    opts.parse!(arguments)\n    \n    if arguments.length != 1 \n      stdout.puts \"ERROR missing input file\"\n      return 1\n    end\n            \n  end\n\n  begin\n    content = File.open(arguments.first, \"r\")\n  rescue Exception => e\n    stdout.puts \"ERROR opening content file (\#{e.message})\"\n    return 1\n  end\n        \n  result = doc.generate(content)\n  unless filename.nil?\n    begin\n      File.open(filename, 'w+') do |f|\n        f.write(result)\n      end\n    rescue Exception => e\n      stdout.puts \"ERROR with output file (\#{e.message})\"\n      return 1\n    end\n  else\n    stdout.write(result)\n  end\n  0      \nend\n".gsub(/^          /,'')