Class: YARD::Server::Commands::SearchCommand
- Inherits:
-
LibraryCommand
- Object
- Base
- LibraryCommand
- YARD::Server::Commands::SearchCommand
- Includes:
- 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
Instance Attribute Summary (collapse)
-
- (Object) query
Returns the value of attribute query.
-
- (Object) results
Returns the value of attribute results.
Attributes included from Templates::Helpers::BaseHelper
Attributes inherited from LibraryCommand
incremental, library, options, serializer, single_library
Attributes inherited from Base
adapter, body, caching, command_options, headers, path, request, status
Instance Method Summary (collapse)
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
Methods inherited from LibraryCommand
Methods inherited from Base
#cache, #call, #initialize, #not_found, #redirect, #render
Constructor Details
This class inherits a constructor from YARD::Server::Commands::LibraryCommand
Instance Attribute Details
- (Object) query
Returns the value of attribute query
10 11 12 |
# File 'lib/yard/server/commands/search_command.rb', line 10 def query @query end |
- (Object) results
Returns the value of attribute results
10 11 12 |
# File 'lib/yard/server/commands/search_command.rb', line 10 def results @results end |
Instance Method Details
- (Object) run
12 13 14 15 16 17 18 19 20 21 |
# File 'lib/yard/server/commands/search_command.rb', line 12 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(serializer.serialized_path(found)) end search_for_object request.xhr? ? serve_xhr : serve_normal end |
- (Object) visible_results
23 24 25 |
# File 'lib/yard/server/commands/search_command.rb', line 23 def visible_results results[0, 10] end |