Class: Traject::DebugWriter

Inherits:
LineWriter show all
Defined in:
lib/traject/debug_writer.rb

Overview

The Traject::DebugWriter produces a simple, human-readable output format that's also amenable to simple computer processing (e.g., with a simple grep). It's the output format used when you pass the --debug-mode switch to traject on the command line.

Output format is three columns: id, output field, values (multiple values seperated by '|'), and looks something like:

000001580    edition                   [1st ed.]
000001580    format                    Book | Online | Print
000001580    geo                       Great Britain
000001580    id                        000001580
000001580    isbn                      0631126902

Settings

  • 'output_file' -- the name of the file to output to (command line -o shortcut).
  • 'output_stream' -- alternately, the IO stream
  • 'debug_writer.idfield' -- the solr field from which to pull the record ID (default: 'id')
  • 'debug_writer.format' -- How to format the id/solr field/values (default: '%-12s %-25s %s')

By default, with neither output_file nor output_stream provided, writes to stdout, which can be useful for debugging diagnosis.

Example configuration file

require 'traject/debug_writer'

settings do
  provide "writer_class_name", "Traject::DebugWriter"
  provide "output_file", "out.txt"
end

Constant Summary collapse

DEFAULT_FORMAT = 
'%-12s %-25s %s'
DEFAULT_IDFIELD = 
'id'

Instance Attribute Summary

Attributes inherited from LineWriter

#output_file, #settings, #write_mutex

Instance Method Summary collapse

Methods inherited from LineWriter

#_write, #close, #initialize, #open_output_file, #put

Constructor Details

This class inherits a constructor from Traject::LineWriter

Instance Method Details

#serialize(context) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/traject/debug_writer.rb', line 38

def serialize(context)
  idfield = settings["debug_writer.idfield"] || DEFAULT_IDFIELD
  format  = settings['debug_writer.format']  || DEFAULT_FORMAT
  h = context.output_hash
  lines = h.keys.sort.map {|k| format % [h[idfield].first, k, h[k].join(' | ')] }
  lines.push "\n"
  lines.join("\n")
end