# frozen_string_literal: true module MediaWiktory::Wikipedia module Modules # Returns all links from the given pages. # # 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 Links # Show links in these namespaces only. # # @param values [Array] Allowed values: "-2", "-1", "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 || ["-2", "-1", "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(plnamespace: value.to_s, replace: false) end # How many links to return. # # @param value [Integer, "max"] # @return [self] def limit(value) merge(pllimit: value.to_s) end # When more results are available, use this to continue. # # @param value [String] # @return [self] def continue(value) merge(plcontinue: value.to_s) end # Only list links to these titles. Useful for checking whether a certain page links to a certain title. # # @param values [Array] # @return [self] def titles(*values) values.inject(self) { |res, val| res._titles(val) } end # @private def _titles(value) merge(pltitles: value.to_s, replace: false) end # The direction in which to list. # # @param value [String] One of "ascending", "descending". # @return [self] def dir(value) _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}" end # @private def _dir(value) defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(pldir: value.to_s) end end end end