Class: YARD::Server::Commands::SearchCommand

Inherits:
LibraryCommand show all
Includes:
DocServerHelper, Templates::Helpers::BaseHelper, Templates::Helpers::ModuleHelper
Defined in:
lib/yard/server/commands/search_command.rb

Overview

Performs a search over the objects inside of a library and returns the results as HTML or plaintext

Since:

  • 0.6.0

Instance Attribute Summary collapse

Attributes included from Templates::Helpers::BaseHelper

#object, #owner, #serializer

Instance Method Summary collapse

Methods included from DocServerHelper

#abs_url, #base_path, #router, #url_for_file, #url_for_frameset, #url_for_index, #url_for_list, #url_for_main

Methods included from Templates::Helpers::ModuleHelper

#prune_method_listing

Methods included from Templates::Helpers::BaseHelper

#format_object_title, #format_object_type, #format_source, #format_types, #globals, #h, #link_file, #link_include_file, #link_include_object, #link_object, #link_url, #linkify, #run_verifier

Constructor Details

This class inherits a constructor from YARD::Server::Commands::LibraryCommand

Instance Attribute Details

#queryObject

Since:

  • 0.6.0


11
12
13
# File 'lib/yard/server/commands/search_command.rb', line 11

def query
  @query
end

#resultsObject

Since:

  • 0.6.0


11
12
13
# File 'lib/yard/server/commands/search_command.rb', line 11

def results
  @results
end

Instance Method Details

#runObject

Since:

  • 0.6.0


13
14
15
16
17
18
19
20
21
22
# File 'lib/yard/server/commands/search_command.rb', line 13

def run
  Registry.load_all
  self.query = request.query['q']
  redirect(abs_url(adapter.router.docs_prefix, single_library ? library : '')) if query.nil? || query =~ /\A\s*\Z/
  if found = Registry.at(query)
    redirect(url_for(found))
  end
  search_for_object
  request.xhr? ? serve_xhr : serve_normal
end

#visible_resultsObject

Since:

  • 0.6.0


24
25
26
# File 'lib/yard/server/commands/search_command.rb', line 24

def visible_results
  results[0, 10]
end