# frozen_string_literal: true module MediaWiktory::Wikipedia module Modules # Find all pages that transclude 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 Transcludedin # Which properties to get: # # @param values [Array] Allowed values: "pageid" (Page ID of each page), "title" (Title of each page), "redirect" (Flag if the page is a redirect). # @return [self] def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end # @private def _prop(value) defined?(super) && super || ["pageid", "title", "redirect"].include?(value.to_s) && merge(tiprop: value.to_s, replace: false) end # Only include pages in these namespaces. # # @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(tinamespace: value.to_s, replace: false) end # Show only items that meet these criteria: # # @param values [Array] Allowed values: "redirect" (Only show redirects), "!redirect" (Only show non-redirects). # @return [self] def show(*values) values.inject(self) { |res, val| res._show(val) or fail ArgumentError, "Unknown value for show: #{val}" } end # @private def _show(value) defined?(super) && super || ["redirect", "!redirect"].include?(value.to_s) && merge(tishow: value.to_s, replace: false) end # How many to return. # # @param value [Integer, "max"] # @return [self] def limit(value) merge(tilimit: value.to_s) end # When more results are available, use this to continue. # # @param value [String] # @return [self] def continue(value) merge(ticontinue: value.to_s) end end end end