Contents

# frozen_string_literal: true

module Reality::Describers::Wikidata::Impl
  module Modules
    # Lock or unlock a Flow topic.
    #
    # The "submodule" (MediaWiki API term) is included in action after setting some param, providing
    # additional tweaking for this param. Example (for {Reality::Describers::Wikidata::Impl::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 LockTopic

      # State to put topic in, either lock or unlock.
      #
      # @param value [String] One of "lock", "unlock", "close", "reopen".
      # @return [self]
      def moderationState(value)
        _moderationState(value) or fail ArgumentError, "Unknown value for moderationState: #{value}"
      end

      # @private
      def _moderationState(value)
        defined?(super) && super || ["lock", "unlock", "close", "reopen"].include?(value.to_s) && merge(cotmoderationState: value.to_s)
      end

      # Reason for locking or unlocking the topic. Note, the on-wiki Flow client uses "Marked as resolved" here, and puts optional additional information in the summary.
      #
      # @param value [String]
      # @return [self]
      def reason(value)
        merge(cotreason: value.to_s)
      end

      # A "csrf" token retrieved from action=query&meta=tokens
      #
      # @param value [String]
      # @return [self]
      def token(value)
        merge(token: value.to_s)
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
reality-0.1.0.alpha3	lib/reality/describers/wikidata/modules/lock-topic.rb
reality-0.1.0.alpha2	lib/reality/describers/wikidata/modules/lock-topic.rb
reality-0.1.0.alpha	lib/reality/describers/wikidata/modules/lock-topic.rb