Class: RDoc::Generator::JsonIndex

Inherits:
Object
  • Object
show all
Includes:
Text
Defined in:
lib/rdoc/generator/json_index.rb

Overview

The JsonIndex generator is designed to complement an HTML generator and produces a JSON search index. This generator is derived from sdoc by Vladimir Kolesnikov and contains verbatim code written by him.

This generator is designed to be used with a regular HTML generator:

class RDoc::Generator::Darkfish
  def initialize options
    # ...
    @base_dir = Pathname.pwd.expand_path

    @json_index = RDoc::Generator::JsonIndex.new self, options
  end

  def generate
    # ...
    @json_index.generate
  end
end

Index Format

The index is output as a JSON file assigned to the global variable search_data. The structure is:

var search_data = {
  "index": {
    "searchIndex":
      ["a", "b", ...],
    "longSearchIndex":
      ["a", "a::b", ...],
    "info": [
      ["A", "A", "A.html", "", ""],
      ["B", "A::B", "A::B.html", "", ""],
      ...
    ]
  }
}

The same item is described across the searchIndex, longSearchIndex and info fields. The searchIndex field contains the item’s short name, the longSearchIndex field contains the full_name (when appropriate) and the info field contains the item’s name, full_name, path, parameters and a snippet of the item’s comment.

LICENSE

Copyright © 2009 Vladimir Kolesnikov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Constant Summary collapse

SEARCH_INDEX_FILE =

Where the search index lives in the generated output

File.join 'js', 'search_index.js'

Constants included from Text

Text::MARKUP_FORMAT, Text::SPACE_SEPARATED_LETTER_CLASS, Text::TO_HTML_CHARACTERS

Instance Attribute Summary collapse

Attributes included from Text

#language

Instance Method Summary collapse

Methods included from Text

encode_fallback, #expand_tabs, #flush_left, #markup, #normalize_comment, #parse, #snippet, #strip_hashes, #strip_newlines, #strip_stars, #to_html, #wrap

Constructor Details

#initialize(parent_generator, options) ⇒ JsonIndex

Creates a new generator. options are the same options passed to the parent generator.



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/rdoc/generator/json_index.rb', line 92

def initialize(parent_generator, options)
  @parent_generator = parent_generator
  @store            = parent_generator.store
  @options          = options

  @template_dir = File.expand_path '../template/json_index', __FILE__
  @base_dir = @parent_generator.base_dir

  @classes = nil
  @files   = nil
  @index   = nil
end

Instance Attribute Details

#index ⇒ Object (readonly)

:nodoc:



86
87
88
 
# File 'lib/rdoc/generator/json_index.rb', line 86

def index
  @index
end

Instance Method Details

#build_index ⇒ Object

Builds the JSON index as a Hash.



108
109
110
111
112
113
114
115
116
 
# File 'lib/rdoc/generator/json_index.rb', line 108

def build_index
  reset @store.all_files.sort, @store.all_classes_and_modules.sort

  index_classes
  index_methods
  index_pages

  { :index => @index }
end

#debug_msg(*msg) ⇒ Object

Output progress information if debugging is enabled



121
122
123
124
 
# File 'lib/rdoc/generator/json_index.rb', line 121

def debug_msg *msg
  return unless $DEBUG_RDOC
  $stderr.puts(*msg)
end

#generate ⇒ Object

Writes the JSON index to disk



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
 
# File 'lib/rdoc/generator/json_index.rb', line 129

def generate
  debug_msg "Generating JSON index"

  debug_msg "  writing search index to %s" % SEARCH_INDEX_FILE
  data = build_index

  return if @options.dry_run

  out_dir = @base_dir + @options.op_dir
  index_file = out_dir + SEARCH_INDEX_FILE

  FileUtils.mkdir_p index_file.dirname, :verbose => $DEBUG_RDOC

  index_file.open 'w', 0644 do |io|
    io.set_encoding Encoding::UTF_8
    io.write 'var search_data = '

    JSON.dump data, io, 0
  end
  unless ENV['SOURCE_DATE_EPOCH'].nil?
    index_file.utime index_file.atime, Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime
  end

  Dir.chdir @template_dir do
    Dir['**/*.js'].each do |source|
      dest = File.join out_dir, source

      FileUtils.install source, dest, :mode => 0644, :preserve => true, :verbose => $DEBUG_RDOC
    end
  end
end

#generate_gzipped ⇒ Object

Compress the search_index.js file using gzip



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/rdoc/generator/json_index.rb', line 164

def generate_gzipped
  return if @options.dry_run or not defined?(Zlib)

  debug_msg "Compressing generated JSON index"
  out_dir = @base_dir + @options.op_dir

  search_index_file = out_dir + SEARCH_INDEX_FILE
  outfile           = out_dir + "#{search_index_file}.gz"

  debug_msg "Reading the JSON index file from %s" % search_index_file
  search_index = search_index_file.read(mode: 'r:utf-8')

  debug_msg "Writing gzipped search index to %s" % outfile

  Zlib::GzipWriter.open(outfile) do |gz|
    gz.mtime = File.mtime(search_index_file)
    gz.orig_name = search_index_file.basename.to_s
    gz.write search_index
    gz.close
  end

  # GZip the rest of the js files
  Dir.chdir @template_dir do
    Dir['**/*.js'].each do |source|
      dest = out_dir + source
      outfile = out_dir + "#{dest}.gz"

      debug_msg "Reading the original js file from %s" % dest
      data = dest.read

      debug_msg "Writing gzipped file to %s" % outfile

      Zlib::GzipWriter.open(outfile) do |gz|
        gz.mtime = File.mtime(dest)
        gz.orig_name = dest.basename.to_s
        gz.write data
        gz.close
      end
    end
  end
end

#index_classes ⇒ Object

Adds classes and modules to the index



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/rdoc/generator/json_index.rb', line 209

def index_classes
  debug_msg "  generating class search index"

  documented = @classes.uniq.select do |klass|
    klass.document_self_or_methods
  end

  documented.each do |klass|
    debug_msg "    #{klass.full_name}"
    record = klass.search_record
    @index[:searchIndex]     << search_string(record.shift)
    @index[:longSearchIndex] << search_string(record.shift)
    @index[:info]            << record
  end
end

#index_methods ⇒ Object

Adds methods to the index



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/rdoc/generator/json_index.rb', line 228

def index_methods
  debug_msg "  generating method search index"

  list = @classes.uniq.flat_map do |klass|
    klass.method_list
  end.sort_by do |method|
    [method.name, method.parent.full_name]
  end

  list.each do |method|
    debug_msg "    #{method.full_name}"
    record = method.search_record
    @index[:searchIndex]     << "#{search_string record.shift}()"
    @index[:longSearchIndex] << "#{search_string record.shift}()"
    @index[:info]            << record
  end
end

#index_pages ⇒ Object

Adds pages to the index



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/rdoc/generator/json_index.rb', line 249

def index_pages
  debug_msg "  generating pages search index"

  pages = @files.select do |file|
    file.text?
  end

  pages.each do |page|
    debug_msg "    #{page.page_name}"
    record = page.search_record
    @index[:searchIndex]     << search_string(record.shift)
    @index[:longSearchIndex] << ''
    record.shift
    @index[:info]            << record
  end
end

#reset(files, classes) ⇒ Object

:nodoc:



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/rdoc/generator/json_index.rb', line 266

def reset(files, classes) # :nodoc:
  @files   = files
  @classes = classes

  @index = {
    :searchIndex => [],
    :longSearchIndex => [],
    :info => []
  }
end

#search_string(string) ⇒ Object

Removes whitespace and downcases string



280
281
282
 
# File 'lib/rdoc/generator/json_index.rb', line 280

def search_string(string)
  string.downcase.gsub(/\s/, '')
end