# frozen_string_literal: true module MediaWiktory::Wikipedia module Modules # Perform a prefix search for page titles. _Generator module: for fetching pages corresponding to request._ # # The "submodule" (MediaWiki API term) is included in action after setting some param, providing # additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and # its submodules): # # ```ruby # api.query # returns Actions::Query # .prop(:revisions) # adds prop=revisions to action URL, and includes Modules::Revisions into action # .limit(10) # method of Modules::Revisions, adds rvlimit=10 to URL # ``` # # All submodule's parameters are documented as its public methods, see below. # module GPrefixsearch # Search string. # # @param value [String] # @return [self] def search(value) merge(gpssearch: value.to_s) end # Namespaces to search. # # @param values [Array] Allowed values: "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303". # @return [self] def namespace(*values) values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" } end # @private def _namespace(value) defined?(super) && super || ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303"].include?(value.to_s) && merge(gpsnamespace: value.to_s, replace: false) end # Maximum number of results to return. # # @param value [Integer, "max"] # @return [self] def limit(value) merge(gpslimit: value.to_s) end # When more results are available, use this to continue. # # @param value [Integer] # @return [self] def offset(value) merge(gpsoffset: value.to_s) end # Search profile to use. # # @param value [String] One of "strict" (Strict profile with few punctuation characters removed but diacritics and stress marks are kept), "normal" (Few punctuation characters, some diacritics and stopwords removed), "fuzzy" (Similar to normal with typo correction (two typos supported)), "fast-fuzzy" (Experimental fuzzy profile (may be removed at any time)), "classic" (Classic prefix, few punctuation characters and some diacritics removed). # @return [self] def profile(value) _profile(value) or fail ArgumentError, "Unknown value for profile: #{value}" end # @private def _profile(value) defined?(super) && super || ["strict", "normal", "fuzzy", "fast-fuzzy", "classic"].include?(value.to_s) && merge(gpsprofile: value.to_s) end end end end