Module: RipperTags

Defined in:
lib/ripper-tags.rb,
lib/ripper-tags/parser.rb,
lib/ripper-tags/data_reader.rb,
lib/ripper-tags/vim_formatter.rb,
lib/ripper-tags/json_formatter.rb,
lib/ripper-tags/emacs_formatter.rb,
lib/ripper-tags/default_formatter.rb

Defined Under Namespace

Classes: DataReader, DefaultFormatter, EmacsFormatter, FileFinder, ForgivingOptionParser, JSONFormatter, Parser, VimFormatter, Visitor

Constant Summary collapse

FatalError =
Class.new(RuntimeError)
BrokenPipe =
Class.new(RuntimeError)

Class Method Summary collapse

Class Method Details

.default_optionsObject



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# File 'lib/ripper-tags.rb', line 16

def self.default_options
  OpenStruct.new \
    :format => nil,
    :extra_flags => Set.new,
    :tag_file_name => nil,
    :tag_relative => nil,
    :debug => false,
    :verbose_debug => false,
    :verbose => false,
    :force => false,
    :files => %w[.],
    :recursive => false,
    :exclude => %w[.git],
    :all_files => false,
    :fields => Set.new,
    :excmd => nil,
    :input_file => nil
end

.formatter_for(options) ⇒ Object



194
195
196
197
198
199
200
201
202
203
# File 'lib/ripper-tags.rb', line 194

def self.formatter_for(options)
  options.formatter ||
  case options.format
  when "vim"    then RipperTags::VimFormatter
  when "emacs"  then RipperTags::EmacsFormatter
  when "json"   then RipperTags::JSONFormatter
  when "custom" then RipperTags::DefaultFormatter
  else raise FatalError, "unknown format: #{options.format.inspect}"
  end.new(options)
end

.option_parser(options) ⇒ Object



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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/ripper-tags.rb', line 68

def self.option_parser(options)
  flags_string_to_set = lambda do |string, set|
    flags = string.split("")
    operation = :add
    if flags[0] == "+" || flags[0] == "-"
      operation = :delete if flags.shift == "-"
    else
      set.clear
    end
    flags.each { |f| set.send(operation, f) }
  end

  ForgivingOptionParser.new do |opts|
    opts.banner = "Usage: #{opts.program_name} [options] FILES..."
    opts.version = version

    opts.separator ""

    opts.on("-f", "--tag-file (FILE|-)", "File to write tags to (default: `./tags')",
           '"-" outputs to standard output') do |fname|
      options.tag_file_name = fname
    end
    opts.on("--tag-relative[=OPTIONAL]", "Make file paths relative to the directory of the tag file") do |value|
      options.tag_relative = value != "no"
    end
    opts.on("-L", "--input-file=FILE", "File to read paths to process trom (use `-` for stdin)") do |file|
      options.input_file = file
    end
    opts.on("-R", "--recursive", "Descend recursively into subdirectories") do
      options.recursive = true
    end
    opts.on("--exclude PATTERN", "Exclude a file, directory or pattern") do |pattern|
      if pattern.empty?
        options.exclude.clear
      else
        options.exclude << pattern
      end
    end
    opts.on("--excmd=number", "Use EX number command to locate tags.") do |excmd|
      options.excmd = excmd
    end
    opts.on("-n", "Equivalent to --excmd=number.") do
      options.excmd = "number"
    end
    opts.on("--fields=+n", "Include line number information in the tag") do |flags|
      flags_string_to_set.call(flags, options.fields)
    end
    opts.on("--all-files", "Parse all files in recursive mode (default: parse `*.rb' files)") do
      options.all_files = true
    end

    opts.separator " "

    opts.on("--format (emacs|json|custom)", "Set output format (default: vim)") do |fmt|
      options.format = fmt
    end
    opts.on("-e", "--emacs", "Output Emacs format (default if `--tag-file' is `TAGS')") do
      options.format = "emacs"
    end
    opts.on("--extra=FLAGS", "Specify extra flags for the formatter") do |flags|
      flags_string_to_set.call(flags, options.extra_flags)
    end

    opts.separator ""

    opts.on_tail("-d", "--debug", "Output parse tree") do
      options.debug = true
    end
    opts.on_tail("--debug-verbose", "Output parse tree verbosely") do
      options.verbose_debug = true
    end
    opts.on_tail("-V", "--verbose", "Print additional information on stderr") do
      options.verbose = true
    end
    opts.on_tail("--force", "Skip files with parsing errors") do
      options.force = true
    end
    opts.on_tail("--list-kinds=LANG", "Print tag kinds that this parser supports and exit") do |lang|
      if lang.downcase == "ruby"
        puts(("          c  classes\n          f  methods\n          m  modules\n          F  singleton methods\n          C  constants\n          a  aliases\n        OUT\n        exit\n      else\n        $stderr.puts \"Error: language %p is not supported\" % lang\n        exit 1\n      end\n    end\n    opts.on_tail(\"--options=FILE\", \"Read additional options from file\") do |file|\n      opts.load_options_file(file)\n    end\n    opts.on_tail(\"--ignore-unsupported-options\", \"Don't fail when unsupported options given, just skip them\") do\n      opts.ignore_unsupported_options = true\n    end\n    opts.on_tail(\"-v\", \"--version\", \"Print version information\") do\n      puts opts.ver\n      exit\n    end\n\n    yield(opts, options) if block_given?\n  end\nend\n").gsub(/^ +/, ''))

.process_args(argv, run = method(:run)) ⇒ Object



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/ripper-tags.rb', line 176

def self.process_args(argv, run = method(:run))
  option_parser(default_options) do |optparse, options|
    file_list = optparse.parse(argv)

    if !file_list.empty?
      options.files = file_list
    elsif !(options.recursive || options.input_file)
      raise OptionParser::InvalidOption, "needs either a list of files, `-L`, or `-R' flag"
    end

    options.tag_file_name ||= options.format == 'emacs' ? './TAGS' : './tags'
    options.format ||= File.basename(options.tag_file_name) == 'TAGS' ? 'emacs' : 'vim'
    options.tag_relative = options.format == "emacs" if options.tag_relative.nil?

    return run.call(options)
  end
end

.run(options) ⇒ Object



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/ripper-tags.rb', line 205

def self.run(options)
  reader = RipperTags::DataReader.new(options)
  formatter = formatter_for(options)
  formatter.with_output do |out|
    reader.each_tag do |tag|
      formatter.write(tag, out)
    end
  end
rescue FatalError => err
  $stderr.puts "%s: %s" % [
    File.basename($0),
    err.message
  ]
  exit 1
end

.versionObject



12
# File 'lib/ripper-tags.rb', line 12

def self.version() "0.5.1" end