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

Inherits:

LibraryCommand

• Object
• Base
• LibraryCommand
• YARD::Server::Commands::SearchCommand

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

Basic Command and Adapter Options

• #adapter ⇒ Adapter inherited from Base

  The server adapter.

• #caching ⇒ Boolean inherited from Base

  Whether to cache.

• #command_options ⇒ Hash inherited from Base

  The options passed to the command's constructor.

Attributes Set Per Request

• #body ⇒ String inherited from Base

  The response body.

• #headers ⇒ Hash{String => String} inherited from Base

  Response headers.

• #path ⇒ String inherited from Base

  The path after the command base URI.

• #request ⇒ Request inherited from Base

  Request object.

• #status ⇒ Numeric inherited from Base

  Status code.

Instance Attribute Summary

• #incremental ⇒ Boolean inherited from LibraryCommand

  Whether to reparse data.

• #library ⇒ LibraryVersion inherited from LibraryCommand

  The object containing library information.

• #options ⇒ LibraryOptions inherited from LibraryCommand

  Default options for the library.

• #query ⇒ Object
• #results ⇒ Object
• #serializer ⇒ Serializers::Base inherited from LibraryCommand

  The serializer used to perform file linking.

• #single_library ⇒ Boolean inherited from LibraryCommand

  Whether router should route for multiple libraries.

Attributes included from Templates::Helpers::BaseHelper

#object, #owner, #serializer

Instance Method Summary

• #run ⇒ Object
• #visible_results ⇒ Object

Methods included from DocServerHelper

#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

#adapter ⇒ Adapter Originally defined in class Base

Returns the server adapter

Returns:

• (Adapter) —

  the server adapter

Since:

• 0.6.0

#body ⇒ String Originally defined in class Base

Returns the response body. Defaults to empty string.

Returns:

• (String) —

  the response body. Defaults to empty string.

Since:

• 0.6.0

#caching ⇒ Boolean Originally defined in class Base

Returns whether to cache

Returns:

• (Boolean) —

  whether to cache

Since:

• 0.6.0

#command_options ⇒ Hash Originally defined in class Base

Returns the options passed to the command's constructor

Returns:

• (Hash) —

  the options passed to the command's constructor

Since:

• 0.6.0

#headers ⇒ Hash{String => String} Originally defined in class Base

Returns response headers

Returns:

• (Hash{String => String}) —

  response headers

Since:

• 0.6.0

#incremental ⇒ Boolean Originally defined in class LibraryCommand

Returns whether to reparse data

Returns:

• (Boolean) —

  whether to reparse data

Since:

• 0.6.0

#library ⇒ LibraryVersion Originally defined in class LibraryCommand

Returns the object containing library information

Returns:

• (LibraryVersion) —

  the object containing library information

Since:

• 0.6.0

#options ⇒ LibraryOptions Originally defined in class LibraryCommand

Returns default options for the library

Returns:

• (LibraryOptions) —

  default options for the library

Since:

• 0.6.0

#path ⇒ String Originally defined in class Base

Returns the path after the command base URI

Returns:

• (String) —

  the path after the command base URI

Since:

• 0.6.0

#query ⇒ Object

Since:

• 0.6.0

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

def query
  @query
end

#request ⇒ Request Originally defined in class Base

Returns request object

Returns:

• (Request) —

  request object

Since:

• 0.6.0

#results ⇒ Object

Since:

• 0.6.0

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

def results
  @results
end

#serializer ⇒ Serializers::Base Originally defined in class LibraryCommand

Returns the serializer used to perform file linking

Returns:

• (Serializers::Base) —

  the serializer used to perform file linking

Since:

• 0.6.0

#single_library ⇒ Boolean Originally defined in class LibraryCommand

Returns whether router should route for multiple libraries

Returns:

• (Boolean) —

  whether router should route for multiple libraries

Since:

• 0.6.0

#status ⇒ Numeric Originally defined in class Base

Returns status code. Defaults to 200 per request

Returns:

• (Numeric) —

  status code. Defaults to 200 per request

Since:

• 0.6.0

Instance Method Details

#run ⇒ Object

Since:

• 0.6.0

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

def run
  Registry.load_all
  self.query = request.query['q']
  redirect("/#{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_results ⇒ Object

Since:

• 0.6.0

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

def visible_results
  results[0, 10]
end