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
Basic Command and Adapter Options (collapse)
-
- (Adapter) adapter
inherited
from Base
The server adapter.
-
- (Boolean) caching
inherited
from Base
Whether to cache.
-
- (Hash) command_options
inherited
from Base
The options passed to the command's constructor.
Attributes Set Per Request (collapse)
-
- (String) body
inherited
from Base
The response body.
-
- (Hash{String => String}) headers
inherited
from Base
Response headers.
-
- (String) path
inherited
from Base
The path after the command base URI.
-
- (Request) request
inherited
from Base
Request object.
-
- (Numeric) status
inherited
from Base
Status code.
Instance Attribute Summary (collapse)
-
- (Boolean) incremental
inherited
from LibraryCommand
Whether to reparse data.
-
- (LibraryVersion) library
inherited
from LibraryCommand
The object containing library information.
-
- (LibraryOptions) options
inherited
from LibraryCommand
Default options for the library.
- - (Object) query
- - (Object) results
-
- (Serializers::Base) serializer
inherited
from LibraryCommand
The serializer used to perform file linking.
-
- (Boolean) single_library
inherited
from LibraryCommand
Whether router should route for multiple libraries.
Attributes included from Templates::Helpers::BaseHelper
Instance Method Summary (collapse)
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
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
- (String) body Originally defined in class Base
Returns the response body. Defaults to empty string.
- (Boolean) caching Originally defined in class Base
Returns whether to cache
- (Hash) command_options Originally defined in class Base
Returns the options passed to the command’s constructor
- (Boolean) incremental Originally defined in class LibraryCommand
Returns whether to reparse data
- (LibraryVersion) library Originally defined in class LibraryCommand
Returns the object containing library information
- (LibraryOptions) options Originally defined in class LibraryCommand
Returns default options for the library
- (Object) query
11 12 13 |
# File 'lib/yard/server/commands/search_command.rb', line 11 def query @query end |
- (Request) request Originally defined in class Base
Returns request object
- (Object) results
11 12 13 |
# File 'lib/yard/server/commands/search_command.rb', line 11 def results @results end |
- (Serializers::Base) serializer Originally defined in class LibraryCommand
Returns the serializer used to perform file linking
- (Boolean) single_library Originally defined in class LibraryCommand
Returns whether router should route for multiple libraries
- (Numeric) status Originally defined in class Base
Returns status code. Defaults to 200 per request
Instance Method Details
- (Object) run
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("/#{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 |
- (Object) visible_results
24 25 26 |
# File 'lib/yard/server/commands/search_command.rb', line 24 def visible_results results[0, 10] end |